Fix the review comments.

Author: yogeshmahajan-1903

web/migrations/versions/4aa49c5d8eb1_.py

@@ -1,5 +1,13 @@
-
-"""empty message
+##########################################################################
+#
+# pgAdmin 4 - PostgreSQL Tools
+#
+# Copyright (C) 2013 - 2025, The pgAdmin Development Team
+# This software is released under the PostgreSQL Licence
+#
+##########################################################################
+"""Add ability to save the workspace/tools data to
+restore on abrupt restart/refresh of application #3319
 
 Revision ID: 4aa49c5d8eb1
 Revises: 1f0eddc8fc79
@@ -18,7 +26,7 @@
 
 def upgrade():
     op.create_table(
-        'pgadmin_state_data',
+        'application_state',
         sa.Column('uid', sa.Integer(), nullable=False),
         sa.Column('id', sa.Integer()),
         sa.Column('connection_info', sa.JSON()),

web/pgadmin/authenticate/__init__.py

@@ -274,6 +274,9 @@ def authenticate(self):
         """Authenticate through all the sources."""
         status = False
         msg = None
+        username = self.form.data['email']
+        users = User.query.filter_by(username=username).all()
+
         for src in self.auth_sources:
             source = get_auth_sources(src)
             self.set_source(source)
@@ -282,6 +285,8 @@ def authenticate(self):
                 source.get_source_name())
 
             status, msg = source.authenticate(self.form)
+            print(status)
+            print(msg)
 
             if status:
                 self.set_current_source(source.get_source_name())
@@ -292,6 +297,16 @@ def authenticate(self):
                 current_app.logger.debug(
                     "Authentication initiated via source: %s is failed." %
                     source.get_source_name())
+                current_user = User.query.filter_by(username=username,
+                                                    auth_source=src).first()
+                # get list with auth source src
+                # iterate over it and find if user present with that
+                if len(users) > 0 and current_user:
+                    print('User may be coming first time so continue with all possible')
+                    break
+                elif len(users) > 0:
+                    print('User already present with other aut source break it')
+                    break
 
         return status, msg
 

web/pgadmin/browser/static/js/browser.js

@@ -16,9 +16,7 @@ import getApiInstance, {parseApiError} from '../../../static/js/api_instance';
 import usePreferences, { setupPreferenceBroadcast } from '../../../preferences/static/js/store';
 import checkNodeVisibility from '../../../static/js/check_node_visibility';
 import * as showQueryTool from '../../../tools/sqleditor/static/js/show_query_tool';
-import {relaunchPsqlTool} from '../../../tools/psql/static/js/show_psql_tool';
-import {relaunchErdTool} from '../../../tools/erd/static/js/show_erd_tool';
-import { relaunchSchemaDiff } from '../../../tools/schema_diff/static/js/showSchemaDiffTool';
+import {getRandomInt} from 'sources/utils';
 
 define('pgadmin.browser', [
   'sources/gettext', 'sources/url_for', 'sources/pgadmin',
@@ -211,7 +209,7 @@ define('pgadmin.browser', [
       this.set_master_password('');
       this.check_version_update();
       const prefStore = usePreferences.getState();
-      let save_the_workspace = prefStore.getPreferencesForModule('misc').save_the_workspace;
+      let save_the_workspace = prefStore.getPreferencesForModule('misc').save_app_state;
       if(save_the_workspace){
         this.restore_pgadmin_state();
       }
@@ -300,41 +298,44 @@ define('pgadmin.browser', [
       });
     },
 
-    restore_pgadmin_state: async function () {
+    restore_pgadmin_state: function () {
       getApiInstance().get(
-        url_for('settings.get_pgadmin_state')
+        url_for('settings.get_application_state')
       ).then((res)=> {
         if(res.data.success && res.data.data.result.length > 0){
-          //let oldIds = []
-          _.each(res.data.data.result, function(tool_data){
-            if (tool_data.tool_name == 'sqleditor'){
-              showQueryTool.relaunchSqlTool(tool_data);
-            }else if(tool_data.tool_name == 'psql'){
-              relaunchPsqlTool(tool_data);
-            }else if(tool_data.tool_name == 'ERD'){
-              relaunchErdTool(tool_data);
-            }else if(tool_data.tool_name == 'schema_diff'){
-              relaunchSchemaDiff(tool_data);
+          _.each(res.data.data.result, function(tool_state){
+            let tool_name = tool_state.tool_name;
+            let tool_data = tool_state.tool_data;
+            let sql_id = `${tool_name}-${getRandomInt(1, 9999999)}`;
+
+            if (tool_name == 'sqleditor'){
+              localStorage.setItem(sql_id, tool_data);
+              showQueryTool.relaunchSqlTool(tool_state, sql_id);
+            }else if(tool_name == 'psql'){
+              pgAdmin.Tools.Psql.openPsqlTool(null, null, tool_state);
+            }else if(tool_name == 'ERD'){
+              localStorage.setItem(sql_id, tool_data);
+              pgAdmin.Tools.ERD.showErdTool(null, null, false, sql_id, tool_state);
+            }else if(tool_name == 'schema_diff'){
+              localStorage.setItem(sql_id, tool_data);
+              pgAdmin.Tools.SchemaDiff.launchSchemaDiff(sql_id);
             }
           });
 
-          // call clear query data for which query tool has been launched.
+          // call clear application state data.
           try {
-            getApiInstance().delete(url_for('settings.delete_pgadmin_state'), {
+            getApiInstance().delete(url_for('settings.delete_application_state'), {
             });
           } catch (error) {
             console.error(error);
             pgAdmin.Browser.notifier.error(gettext('Failed to remove query data.') + parseApiError(error));
           }
-
         }
       }).catch(function(error) {
         pgAdmin.Browser.notifier.pgRespErrorNotify(error);
       });
-      
     },
 
-
     bind_beforeunload: function() {
       window.addEventListener('beforeunload', function(e) {
         /* Can open you in new tab */

web/pgadmin/misc/__init__.py

@@ -125,15 +125,15 @@ def register_preferences(self):
         )
 
         self.preference.register(
-            'user_interface', 'save_the_workspace',
-            gettext("Save the workspaces and data?"),
+            'user_interface', 'save_app_state',
+            gettext("Save the application state?"),
             'boolean', True,
             category_label=PREF_LABEL_USER_INTERFACE,
             help_str=gettext(
-                'Turning on this setting will save the information about the'
-                ' tools that are opened and data within it. Data will be '
-                'restored in case of abrupt shutdown/refresh of the '
-                'application'
+                'If set to True, pgAdmin will save the state of opened tools'
+                ' (such as Query Tool, PSQL, Schema Diff, and ERD), including'
+                ' any unsaved data. This data will be automatically restored'
+                ' in the event of an unexpected shutdown or browser refresh.'
             )
         )
 

web/pgadmin/model/__init__.py

@@ -392,9 +392,9 @@ class QueryHistoryModel(db.Model):
     last_updated_flag = db.Column(db.String(), nullable=False)
 
 
-class PgadminStateData(db.Model):
-    """Define the history SQL table."""
-    __tablename__ = 'pgadmin_state_data'
+class ApplicationState(db.Model):
+    """Define the application state SQL table."""
+    __tablename__ = 'application_state'
     uid = db.Column(db.Integer(), db.ForeignKey(USER_ID), nullable=False,
                     primary_key=True)
     id = db.Column(db.Integer(),nullable=False,primary_key=True)

web/pgadmin/settings/__init__.py

@@ -21,7 +21,7 @@
     success_return, internal_server_error
 from pgadmin.utils.menu import MenuItem
 
-from pgadmin.model import db, Setting, PgadminStateData
+from pgadmin.model import db, Setting, ApplicationState
 from pgadmin.utils.constants import MIMETYPE_APP_JS
 from .utils import get_dialog_type, get_file_type_setting
 from cryptography.fernet import Fernet
@@ -54,8 +54,9 @@ def get_exposed_url_endpoints(self):
             'settings.reset_tree_state',
             'settings.save_file_format_setting',
             'settings.get_file_format_setting',
-            'settings.save_pgadmin_state',
-            'settings.delete_pgadmin_state'
+            'settings.save_application_state',
+            'settings.get_application_state',
+            'settings.delete_application_state'
         ]
 
 
@@ -262,11 +263,11 @@ def get_file_format_setting():
 
 
 @blueprint.route(
-    '/save_pgadmin_state',
-    methods=["POST"], endpoint='save_pgadmin_state'
+    '/save_application_state',
+    methods=["POST"], endpoint='save_application_state'
 )
 @pga_login_required
-def save_pgadmin_state_data():
+def save_application_state():
     """
     Args:
         sid: server id
@@ -279,7 +280,7 @@ def save_pgadmin_state_data():
     connection_info = data['connection_info'] \
         if 'connection_info' in data else None
     try:
-        data_entry = PgadminStateData(
+        data_entry = ApplicationState(
             uid=current_user.id, id=id,connection_info=connection_info,
             tool_name=data['tool_name'], tool_data=tool_data)
 
@@ -298,15 +299,15 @@ def save_pgadmin_state_data():
 
 
 @blueprint.route(
-    '/get_pgadmin_state',
-    methods=["GET"], endpoint='get_pgadmin_state'
+    '/get_application_state',
+    methods=["GET"], endpoint='get_application_state'
 )
 @pga_login_required
-def get_pgadmin_state():
+def get_application_state():
     fernet = Fernet(current_app.config['SECRET_KEY'].encode())
     result = db.session \
-        .query(PgadminStateData) \
-        .filter(PgadminStateData.uid == current_user.id) \
+        .query(ApplicationState) \
+        .filter(ApplicationState.uid == current_user.id) \
         .all()
 
     res = []
@@ -326,10 +327,10 @@ def get_pgadmin_state():
 
 
 @blueprint.route(
-    '/delete_pgadmin_state/',
-    methods=["DELETE"], endpoint='delete_pgadmin_state')
+    '/delete_application_state/',
+    methods=["DELETE"], endpoint='delete_application_state')
 @pga_login_required
-def delete_pgadmin_state_data():
+def delete_application_state():
     trans_id = None
     if request.data:
         data = json.loads(request.data)
@@ -341,14 +342,14 @@ def delete_tool_data(trans_id):
     try:
         if trans_id:
             results = db.session \
-                .query(PgadminStateData) \
-                .filter(PgadminStateData.uid == current_user.id,
-                        PgadminStateData.id == trans_id) \
+                .query(ApplicationState) \
+                .filter(ApplicationState.uid == current_user.id,
+                        ApplicationState.id == trans_id) \
                 .all()
         else:
             results = db.session \
-                .query(PgadminStateData) \
-                .filter(PgadminStateData.uid == current_user.id) \
+                .query(ApplicationState) \
+                .filter(ApplicationState.uid == current_user.id) \
                 .all()
         for result in results:
             db.session.delete(result)
@@ -364,6 +365,6 @@ def delete_tool_data(trans_id):
         return make_json_response(
             data={
                 'status': False,
-                'msg': 'str(e)',
+                'msg': str(e),
             }
         )

web/pgadmin/settings/static/ApplicationStateProvider.jsx

@@ -0,0 +1,44 @@
+/////////////////////////////////////////////////////////////
+//
+// pgAdmin 4 - PostgreSQL Tools
+//
+// Copyright (C) 2013 - 2025, The pgAdmin Development Team
+// This software is released under the PostgreSQL Licence
+//
+//////////////////////////////////////////////////////////////
+import React, { useContext, useMemo } from 'react';
+import PropTypes from 'prop-types';
+import getApiInstance from '../../static/js/api_instance';
+import url_for from 'sources/url_for';
+
+const ApplicationStateContext = React.createContext();
+
+export const useApplicationState = ()=>useContext(ApplicationStateContext);
+
+export function retrieveDataFromLocalStorgae(sqlId){
+  let sqlValue = JSON.parse(localStorage.getItem(sqlId));
+  localStorage.removeItem(sqlId);   
+  return sqlValue;
+}
+
+export function ApplicationStateProvider({children}){
+  const saveToolData = (data) =>{
+    getApiInstance().post(
+      url_for('settings.save_application_state'),
+      JSON.stringify(data),
+    ).catch((error)=>{console.error(error);});
+  };
+
+  const value = useMemo(()=>({
+    saveToolData,
+  }), []);
+
+  return <ApplicationStateContext.Provider value={value}>
+    {children}
+  </ApplicationStateContext.Provider>;
+
+}
+
+ApplicationStateProvider.propTypes = {
+  children: PropTypes.object
+};

web/pgadmin/static/js/PgAdminProvider.jsx

@@ -9,9 +9,6 @@
 
 import React from 'react';
 import PropTypes from 'prop-types';
-import EventBus from './helpers/EventBus';
-import getApiInstance from './api_instance';
-import url_for from 'sources/url_for';
 
 const PgAdminContext = React.createContext();
 
@@ -21,19 +18,7 @@ export function usePgAdmin() {
 }
 
 export function PgAdminProvider({children, value}) {
-
-  const eventBus = React.useRef(new EventBus());
-
-  React.useEffect(()=>{
-    eventBus.current.registerListener('SAVE_TOOL_DATA', (data) => {
-      getApiInstance().post(
-        url_for('settings.save_pgadmin_state'),
-        JSON.stringify(data),
-      ).catch((error)=>{console.error(error);});
-    });
-  }, []);
-
-  return <PgAdminContext.Provider value={{pgAdminProviderEventBus: eventBus.current, ...value}}>
+  return <PgAdminContext.Provider value={value}>
     {children}
   </PgAdminContext.Provider>;
 }

web/pgadmin/static/js/ToolView.jsx

@@ -59,19 +59,18 @@ export default function ToolView({dockerObj}) {
         // Handler here will return which layout instance the tool should go in
         // case of workspace layout.
         let handler = pgAdmin.Browser.getDockerHandler?.(panelId, dockerObj);
-        const dergisterRemove = handler.docker.eventBus.registerListener(LAYOUT_EVENTS.REMOVE, (closePanelId)=>{
+        const deregisterRemove = handler.docker.eventBus.registerListener(LAYOUT_EVENTS.REMOVE, (closePanelId)=>{
           if(panelId == closePanelId){
             let api = getApiInstance();
             api.delete(
-              url_for('settings.delete_pgadmin_state'), {data:{'panelId': panelId}}
-            ).then(()=> { /* Sona qube */}).catch(function(error) {
+              url_for('settings.delete_application_state'), {data:{'panelId': panelId}}
+            ).then(()=> { /* Sonar Qube */}).catch(function(error) {
               pgAdmin.Browser.notifier.pgRespErrorNotify(error);
             });
-            dergisterRemove();
+            deregisterRemove();
           }
         });
 
-
         handler.focus();
         handler.docker.openTab({
           id: panelId,