feat: add reconnect and connection status (#71)

Author: invisal

src/drivers/MySQLConnection.ts

@@ -68,10 +68,15 @@ function mapHeaderType(column: ColumnDefinition): QueryResultHeader {
 export default class MySQLConnection extends SQLLikeConnection {
   protected connectionConfig: DatabaseConnectionConfig;
   protected connection: Connection | undefined;
+  protected onStateChangedCallback: (state: string) => void;
 
-  constructor(connectionConfig: DatabaseConnectionConfig) {
+  constructor(
+    connectionConfig: DatabaseConnectionConfig,
+    statusChanged: (state: string) => void
+  ) {
     super();
     this.connectionConfig = connectionConfig;
+    this.onStateChangedCallback = statusChanged;
   }
 
   protected async getConnection() {
@@ -81,7 +86,20 @@ export default class MySQLConnection extends SQLLikeConnection {
         dateStrings: true,
         namedPlaceholders: true,
       });
+
+      console.log('connected');
+      this.onStateChangedCallback('Connected');
+
+      this.connection.on('error', () => {
+        if (this.connection) {
+          this.connection.removeAllListeners();
+          this.connection.destroy();
+          this.connection = undefined;
+          this.onStateChangedCallback('Disconnected');
+        }
+      });
     }
+
     return this.connection;
   }
 
@@ -131,7 +149,9 @@ export default class MySQLConnection extends SQLLikeConnection {
   }
 
   async close() {
-    const conn = await this.getConnection();
-    conn.destroy();
+    if (this.connection) {
+      const conn = await this.getConnection();
+      conn.destroy();
+    }
   }
 }

src/drivers/common/MySQLCommonInterface.ts

@@ -200,6 +200,13 @@ export default class MySQLCommonInterface extends SQLCommonInterface {
     return true;
   }
 
+  async getVersion(): Promise<string> {
+    const response = await this.singleExecute<{ 'VERSION()': string }>(
+      'SELECT VERSION();'
+    );
+    return response.rows[0]['VERSION()'];
+  }
+
   async getSchema(): Promise<DatabaseSchemas> {
     const databaseListResponse = await this.singleExecute<MySqlDatabase>(
       qb().table('information_schema.SCHEMATA').select('SCHEMA_NAME').toRawSQL()

src/drivers/common/NotImplementCommonInterface.ts

@@ -13,4 +13,8 @@ export default class NotImplementCommonInterface extends SQLCommonInterface {
   async switchDatabase(): Promise<boolean> {
     throw 'Not implemented';
   }
+
+  async getVersion(): Promise<string> {
+    throw 'Not implemented';
+  }
 }

src/drivers/common/SQLCommonInterface.ts

@@ -1,6 +1,7 @@
 import { DatabaseSchemas, TableDefinitionSchema } from 'types/SqlSchema';
 
 export default abstract class SQLCommonInterface {
+  abstract getVersion(): Promise<string>;
   abstract getSchema(): Promise<DatabaseSchemas>;
   abstract getTableSchema(
     database: string,

src/main/ipc/handleConnection.ts

@@ -3,17 +3,26 @@ import SQLLikeConnection, {
   ConnectionStoreItem,
   DatabaseConnectionConfig,
 } from './../../drivers/SQLLikeConnection';
-import { ipcMain } from 'electron';
+import { BrowserWindow, ipcMain } from 'electron';
 
 export default class ConnectionIpcHandler {
   protected connection: SQLLikeConnection | undefined;
+  protected window?: BrowserWindow;
+
+  attachWindow(window: BrowserWindow) {
+    this.window = window;
+  }
 
   register() {
     ipcMain.handle('connect', async (_, [store]: [ConnectionStoreItem]) => {
       if (store.type === 'mysql') {
-        console.log('create mysql connection');
         this.connection = new MySQLConnection(
-          store.config as unknown as DatabaseConnectionConfig
+          store.config as unknown as DatabaseConnectionConfig,
+          (status) => {
+            if (this.window) {
+              this.window.webContents.send('connection-status-change', status);
+            }
+          }
         );
       }
       return true;

src/main/main.ts

@@ -68,6 +68,7 @@ const createWindow = async () => {
   mainWindow.setMenu(null);
 
   otherIpcHandler.attachWindow(mainWindow);
+  connectionIpcHandler.attachWindow(mainWindow);
 
   mainWindow.loadURL(resolveHtmlPath('index.html'));
 

src/main/preload.ts

@@ -50,6 +50,13 @@ const electronHandler = {
     ipcRenderer.invoke('close');
   },
 
+  listenConnectionStatusChanged: (
+    callback: (event: IpcRendererEvent, status: string) => void
+  ) => {
+    ipcRenderer.removeAllListeners('connection-status-change');
+    return ipcRenderer.on('connection-status-change', callback);
+  },
+
   showMessageBox: (options: MessageBoxSyncOptions): Promise<number> =>
     ipcRenderer.invoke('show-message-box', [options]),
 
@@ -121,7 +128,6 @@ const electronHandler = {
   },
 
   openExternal: (url: string) => ipcRenderer.invoke('open-external', [url]),
-
 };
 
 contextBridge.exposeInMainWorld('electron', electronHandler);

src/renderer/components/StatusBar/hook.ts

@@ -0,0 +1,46 @@
+import { useCallback, useState, useEffect } from 'react';
+
+interface StatusBarConnection {
+  version?: string;
+  status?: string;
+}
+
+const MESSAGE_CHANNEL = 'status-bar-connection';
+
+export function useStatusBar() {
+  const setStatusBarConnectionStatus = useCallback(
+    (data?: StatusBarConnection) => {
+      window.postMessage({
+        type: MESSAGE_CHANNEL,
+        data,
+      });
+    },
+    []
+  );
+
+  return { setStatusBarConnectionStatus };
+}
+
+export function useStatusBarData() {
+  const [connectionStatus, setConnectionStatus] = useState<
+    StatusBarConnection | undefined
+  >();
+
+  useEffect(() => {
+    const receiveMessage = (
+      e: MessageEvent<{ type: string; data?: StatusBarConnection }>
+    ) => {
+      if (e.data?.type === MESSAGE_CHANNEL) {
+        setConnectionStatus((prev) => {
+          if (e.data?.data) return { ...prev, ...e.data?.data };
+          return undefined;
+        });
+      }
+    };
+
+    window.addEventListener('message', receiveMessage);
+    return () => window.removeEventListener('message', receiveMessage);
+  }, [setConnectionStatus]);
+
+  return { connectionStatus };
+}

src/renderer/components/StatusBar/index.tsx

@@ -4,6 +4,7 @@ import pkg from './../../../../package.json';
 import Button from '../Button';
 import Stack from '../Stack';
 import ButtonGroup from '../ButtonGroup';
+import { useStatusBarData } from './hook';
 
 function StatusBarAutoUpdate() {
   const [autoUpdateMessage, setAutoUpdateMessage] = useState('');
@@ -93,10 +94,30 @@ function StatusBarAutoUpdate() {
 }
 
 export default function StatusBar() {
+  const { connectionStatus } = useStatusBarData();
+
   return (
     <div className={styles.statusBarContainer}>
       <ul>
         <li>QueryMaster v{pkg.version}</li>
+        {!!connectionStatus?.version && (
+          <li>MySQL {connectionStatus?.version}</li>
+        )}
+        {!!connectionStatus?.status && (
+          <li>
+            <span
+              style={{
+                color:
+                  connectionStatus.status === 'Connected'
+                    ? '#27ae60'
+                    : '#e74c3c',
+              }}
+            >
+              ⬤
+            </span>
+            &nbsp;&nbsp;{connectionStatus.status}
+          </li>
+        )}
         <li style={{ flexGrow: 1 }}></li>
         <StatusBarAutoUpdate />
       </ul>

src/renderer/components/StatusBar/styles.module.css

@@ -10,6 +10,14 @@
   display: flex;
 }
 
+.statusBarContainer ul li {
+  margin-right: 20px;
+}
+
+.statusBarContainer ul li:last-child {
+  margin-right: 0px;
+}
+
 .popup {
   font-size: 1rem;
   width: 300px;