refactor: improve native menu links

apps/electron/src/main.js

@@ -0,0 +1,285 @@
+const { app, BrowserWindow, Menu, globalShortcut, Tray, dialog, ipcMain, shell, Notification } = require('electron');
+const path = require('path');
+
+const { getApplicationMenu } = require('./menu/applicationMenu.js');
+const { getTrayMenu } = require('./menu/trayMenu.js');
+
+const electronConfig = require('./electron.config.js');
+const {
+  env,
+  isProduction,
+  isWindows,
+  nodePath,
+  getClientUrl,
+  trayIcon,
+  appIcon,
+  getServerUrl,
+} = require('./external.js');
+
+if (!isProduction) {
+  console.log(`Electron running in ${env} environment`);
+  console.log(`Ontime server at ${nodePath}`);
+  process.traceProcessWarnings = true;
+}
+
+/** Flag holds server loading state */
+let loaded = 'Ontime running';
+
+/**
+ * Flag whether user has requested a quit
+ * Used to coordinate window closes without exit
+ */
+let isQuitting = false;
+
+// initialise
+let win;
+let splash;
+let tray = null;
+
+/**
+ * Coordinates the node process startup
+ * @returns {number} server port - the port at which the backend has been started at
+ */
+async function startBackend() {
+  // in dev mode, we expect both UI and server to be running
+  if (!isProduction) {
+    return;
+  }
+
+  const ontimeServer = require(nodePath);
+  const { initAssets, startServer, startIntegrations } = ontimeServer;
+
+  await initAssets();
+
+  const result = await startServer(escalateError);
+  loaded = result.message;
+
+  await startIntegrations();
+
+  return result.serverPort;
+}
+
+/**
+ * @description utility function to create a notification
+ * @param {string} title - Notification title
+ * @param {string} body - Notification body
+ */
+function showNotification(title, body) {
+  new Notification({
+    title,
+    body,
+    silent: true,
+  }).show();
+}
+
+/**
+ * Terminate node service and close electron app
+ */
+function appShutdown() {
+  // terminate node service
+  (async () => {
+    const ontimeServer = require(nodePath);
+    const { shutdown } = ontimeServer;
+    await shutdown(electronConfig.appIni.shutdownCode);
+  })();
+
+  isQuitting = true;
+  tray.destroy();
+  win.destroy();
+  app.quit();
+}
+
+/**
+ * Sets Ontime window in focus
+ */
+function bringToFront() {
+  win.show();
+  win.focus();
+}
+
+/**
+ * Coordinates the shutdown process
+ */
+function askToQuit() {
+  bringToFront();
+  win.send('user-request-shutdown');
+}
+
+/**
+ * Allows processes to escalate errors to be shown in electron
+ * @param {string} error
+ */
+function escalateError(error) {
+  dialog.showErrorBox('An unrecoverable error occurred', error);
+}
+
+// Ensure there isn't another instance of the app running already
+const lock = app.requestSingleInstanceLock();
+if (!lock) {
+  dialog.showErrorBox('Multiple instances', 'An instance of the App is already running.');
+  app.quit();
+} else {
+  app.on('second-instance', () => {
+    // Someone tried to run a second instance, we should focus our window.
+    if (win) {
+      if (win.isMinimized()) {
+        win.restore();
+      }
+      bringToFront();
+    }
+  });
+}
+
+/**
+ * Coordinates creation of electron windows (splash and main)
+ */
+function createWindow() {
+  splash = new BrowserWindow({
+    width: 333,
+    height: 333,
+    transparent: true,
+    icon: appIcon,
+    resizable: false,
+    frame: false,
+    alwaysOnTop: true,
+    focusable: false,
+    skipTaskbar: true,
+  });
+  splash.setIgnoreMouseEvents(true);
+  const splashPath = path.join('file://', __dirname, '/splash/splash.html');
+  splash.loadURL(splashPath);
+
+  win = new BrowserWindow({
+    width: 1920,
+    height: 1000,
+    minWidth: 525,
+    minHeight: 405,
+    backgroundColor: '#101010', // $gray-1350
+    icon: appIcon,
+    show: false,
+    textAreasAreResizable: false,
+    enableWebSQL: false,
+    darkTheme: true,
+    webPreferences: {
+      preload: path.join(__dirname, './preload.js'),
+      nodeIntegration: true,
+      contextIsolation: false,
+    },
+  });
+
+  win.setMenu(null);
+}
+
+app.disableHardwareAcceleration();
+app.whenReady().then(() => {
+  // Set app title in windows
+  if (isWindows) {
+    app.setAppUserModelId(app.name);
+  }
+
+  createWindow();
+  startBackend()
+    .then((port) => {
+      const clientUrl = getClientUrl(port);
+      const serverUrl = getServerUrl(port);
+      const menu = getApplicationMenu(
+        askToQuit,
+        clientUrl,
+        serverUrl,
+        (path) => {
+          win.loadURL(`${clientUrl}/${path}`);
+        },
+        (url) => win.webContents.downloadURL(url),
+      );
+      Menu.setApplicationMenu(menu);
+
+      win
+        .loadURL(`${clientUrl}/editor`)
+        .then(() => {
+          win.webContents.setBackgroundThrottling(false);
+
+          win.show();
+          win.focus();
+
+          splash.destroy();
+
+          if (typeof loaded === 'string') {
+            tray.setToolTip(loaded);
+          } else {
+            tray.setToolTip('Initialising error: please restart Ontime');
+          }
+        })
+        .catch((error) => {
+          console.log('ERROR: Ontime failed to reach server', error);
+        });
+    })
+    .catch((error) => {
+      console.log('ERROR: Ontime failed to start', error);
+    });
+
+  /**
+   * recreate window if no others open
+   */
+  app.on('activate', () => {
+    win.show();
+  });
+
+  /**
+   * Hide on close
+   */
+  win.on('close', function (event) {
+    event.preventDefault();
+    if (!isQuitting) {
+      showNotification('Window Closed', 'App running in background');
+      win.hide();
+    }
+  });
+
+  // create tray and set its context menu
+  tray = new Tray(trayIcon);
+  const trayContextMenu = getTrayMenu(bringToFront, askToQuit);
+  tray.setContextMenu(trayContextMenu);
+});
+
+/**
+ * Unregister shortcuts before quitting
+ */
+app.once('will-quit', () => {
+  globalShortcut.unregisterAll();
+});
+
+// Ask for main window reload
+// Test message
+ipcMain.on('reload', () => {
+  win?.reload();
+});
+
+// Terminate
+ipcMain.on('shutdown', () => {
+  console.log('Electron got IPC shutdown');
+  appShutdown();
+});
+
+/**
+ * Handles requests to set window properties
+ */
+ipcMain.on('set-window', (_event, arg) => {
+  switch (arg) {
+    case 'show-dev':
+      win.webContents.openDevTools({ mode: 'detach' });
+      break;
+    default:
+      console.log('Electron unhandled window request', arg);
+  }
+});
+
+/**
+ * Handles requests to open external links
+ */
+ipcMain.on('send-to-link', (_event, arg) => {
+  try {
+    shell.openExternal(arg);
+  } catch (_error) {
+    /** unhandled error */
+  }
+});