Ensure proper error message shown if any error occurs while restoring psql tool.

Author: yogeshmahajan-1903

docs/en_US/preferences.rst

@@ -329,7 +329,7 @@ Use the fields on the *User Interface* panel to set the user interface related p
   format. If the application is closed unexpectedly, the tab is accidentally closed,
   or the page is refreshed, the saved state will be automatically restored for
   each respective tool. **Note:** Saving the application state will not preserve data for tool tabs opened in
-  separate browser tabs when running in server mode.
+  separate browser tabs when running in server mode.Any tool referring ad-hoc server connection will not be restored.
 
 * Use the *Themes* drop-down listbox to select the theme for pgAdmin. You'll also get a preview just below the
   drop down. You can also submit your own themes,

web/pgadmin/static/js/ToolErrorView.jsx

@@ -5,6 +5,7 @@ import { LAYOUT_EVENTS } from './helpers/Layout';
 import { styled } from '@mui/material/styles';
 import { FormHelperText, Box } from '@mui/material';
 import HTMLReactParse from 'html-react-parser';
+import { deleteToolData } from '../../settings/static/ApplicationStateProvider';
 
 const StyledBox = styled(Box)(({theme}) => ({
   color: theme.palette.text.primary,
@@ -15,11 +16,14 @@ const StyledBox = styled(Box)(({theme}) => ({
   height: '100%',
 }));
 
-export default function ToolErrorView({error, panelId, panelDocker}){
-
+export default function ToolErrorView({error, panelId, panelDocker, toolDataId}){
   panelDocker.eventBus.registerListener(LAYOUT_EVENTS.CLOSING, (id)=>{
     if(panelId == id) {
       panelDocker.close(panelId, true);
+      if(toolDataId){
+        let transId = toolDataId.replace('-','_');
+        deleteToolData(transId, transId);
+      }
     }
   });
 
@@ -33,4 +37,5 @@ ToolErrorView.propTypes = {
   error: PropTypes.string,
   panelId: PropTypes.string,
   panelDocker: PropTypes.object,
+  toolDataId: PropTypes.string
 };

web/pgadmin/tools/erd/static/js/erd_tool/components/ERDTool.jsx

@@ -348,10 +348,10 @@ export default class ERDTool extends React.Component {
     });
 
     let done = await this.initConnection();
-    if(!done) return;
+    if(!done && !this.props.params.sql_id) return;
 
     done = await this.loadPrequisiteData();
-    if(!done) return;
+    if(!done && !this.props.params.sql_id) return;
 
 
     if(this.props.params.sql_id){
@@ -361,7 +361,7 @@ export default class ERDTool extends React.Component {
         this.diagram.clearSelection();
         this.registerModelEvents();
         this.setState({dirty: true});
-        this.eventBus.fireEvent(ERD_EVENTS.DIRTY, true, this.serializeFile());
+        this.eventBus.fireEvent(ERD_EVENTS.DIRTY, true, sqlValue);
       }
     }
     else if(this.props.params.gen) {
@@ -597,6 +597,7 @@ export default class ERDTool extends React.Component {
         current_file: fileName,
         dirty: false,
       });
+      this.eventBus.fireEvent(ERD_EVENTS.DIRTY, true, res.data);
       this.eventBus.fireEvent(ERD_EVENTS.DIRTY, false);
       this.setTitle(fileName);
       this.diagram.deserialize(res.data);

web/pgadmin/tools/psql/__init__.py

@@ -101,9 +101,10 @@ def panel(trans_id):
     s = Server.query.filter_by(id=int(params['sid'])).first()
     if s:
         data = _get_database_role(params['sid'], params['did'])
-        params['db'] = underscore_escape(data['db_name']) \
-            if 'db_name' in data else 'postgres'
-        params['role'] = underscore_escape(data['role'])
+        if data:
+            params['db'] = underscore_escape(data['db_name']) \
+                if 'db_name' in data else 'postgres'
+            params['role'] = underscore_escape(data['role'])
         set_env_variables(is_win=_platform == 'win32')
         return render_template("psql/index.html",
                                params=json.dumps(params))
@@ -303,7 +304,9 @@ def read_and_forward_pty_output(sid, data):
     # Check user is authenticated and PSQL is enabled in config.
     if current_user.is_authenticated and config.ENABLE_PSQL:
         connection_data = []
+        connection_successful = False
         try:
+            print('In first try')
             db = ''
             if data['db']:
                 db = underscore_unescape(data['db'])
@@ -326,33 +329,36 @@ def read_and_forward_pty_output(sid, data):
                 return
             connection_data = get_connection_str(psql_utility, db,
                                                  manager)
+            connection_successful = True
         except Exception as e:
             # If any error raised during the start the PSQL emit error to UI.
             # request.sid: This sid is socket id.
-            sio.emit(
-                'conn_error',
-                {
-                    'error': 'Error while running psql command: {0}'.format(e),
-                }, namespace='/pty', room=request.sid)
+            error_msg = 'Error while running psql command: {0}'.format(e)
+            if str(e) == 'Server is not connected.':
+                error_msg = 'Error while opening psql tool: {0}'.format(e)
 
-        try:
-            if str(data['sid']) not in app.config['sid_soid_mapping']:
-                # request.sid: refer request.sid as socket id.
-                app.config['sid_soid_mapping'][str(data['sid'])] = list()
-                app.config['sid_soid_mapping'][str(data['sid'])].append(
-                    request.sid)
-            else:
-                app.config['sid_soid_mapping'][str(data['sid'])].append(
-                    request.sid)
+            sio.emit( 'conn_error', {'error': error_msg},
+                      namespace='/pty', room=request.sid)
 
-            sio.start_background_task(read_and_forward_pty_output,
-                                      request.sid, data)
-        except Exception as e:
-            sio.emit(
-                'conn_error',
-                {
-                    'error': 'Error while running psql command: {0}'.format(e),
-                }, namespace='/pty', room=request.sid)
+        if connection_successful:
+            try:
+                if str(data['sid']) not in app.config['sid_soid_mapping']:
+                    # request.sid: refer request.sid as socket id.
+                    app.config['sid_soid_mapping'][str(data['sid'])] = list()
+                    app.config['sid_soid_mapping'][str(data['sid'])].append(
+                        request.sid)
+                else:
+                    app.config['sid_soid_mapping'][str(data['sid'])].append(
+                        request.sid)
+
+                sio.start_background_task(read_and_forward_pty_output,
+                                          request.sid, data)
+            except Exception as e:
+                sio.emit(
+                    'conn_error',
+                    {
+                        'error': 'Error while running psql command: {0}'.format(e),
+                    }, namespace='/pty', room=request.sid)
     else:
         # Show error if user is not authenticated.
         sio.emit('conn_not_allow', {'sid': request.sid}, namespace='/pty',
@@ -378,12 +384,6 @@ def _get_connection(sid, data):
             status, msg = conn.connect()
         if not status:
             app.logger.error(msg)
-            sio.emit(sio.emit(
-                'conn_error',
-                {
-                    'error': 'Error while running psql command: {0}'
-                             ''.format('Server connection not present.'),
-                }, namespace='/pty', room=request.sid))
             raise RuntimeError('Server is not connected.')
 
         return conn, manager

web/pgadmin/tools/psql/static/js/PsqlModule.js

@@ -122,7 +122,7 @@ export default class Psql {
         },
         database: {
           _id: connectionInfo.did,
-          label: connectionInfo.db
+          _label: connectionInfo.db
         },
         schema: {
           _id: connectionInfo.scid || null,
@@ -161,7 +161,7 @@ export default class Psql {
     const transId = getRandomInt(1, 9999999);
     // Set psql tab title as per prefrences setting.
     let title_data = {
-      'database': parentData.database ? _.unescape(parentData.database.label) : 'postgres' ,
+      'database': parentData.database ? _.unescape(parentData.database._label) : 'postgres' ,
       'username': parentData.server.user.name,
       'server': parentData.server.label,
       'type': 'psql_tool',

web/pgadmin/tools/sqleditor/static/js/SQLEditorModule.js

@@ -254,6 +254,7 @@ export default class SQLEditor {
                   error={params.error}
                   panelId={`${BROWSER_PANELS.QUERY_TOOL}_${params.trans_id}`}
                   panelDocker={panelDocker}
+                  toolDataId={params.toolDataId}
                 /> :
                 <QueryToolComponent params={params} 
                   pgWindow={pgWindow}