Merge remote-tracking branch 'origin/master' into v1

server/main.js

@@ -11,25 +11,30 @@ const {
 } = require('electron');
 const path = require('path');
 const electronConfig = require('./electron.config');
-if (process.env.NODE_ENV === undefined) {
-  process.env.NODE_ENV = 'production';
-}
-const isProduction = process.env.NODE_ENV === 'production';
 
-let loaded = 'Nothing loaded';
-let isQuitting = false;
+const env = process.env.NODE_ENV || 'production';
+const isProduction = env === 'production';
+const isMac = process.platform === 'darwin';
+const isWindows = process.platform === 'win32';
 
+// path to server
 const nodePath = isProduction
   ? path.join('file://', __dirname, '../', 'extraResources', 'src/app.js')
   : path.join('file://', __dirname, 'src/app.js');
 
+// path to icons
+const trayIcon = path.join(__dirname, './assets/background.png');
+const appIcon = path.join(__dirname, './assets/logo.png');
+let loaded = 'Nothing loaded';
+let isQuitting = false;
+
 (async () => {
   try {
     const { startServer, startOSCServer } = await import(nodePath);
     // Start express server
     loaded = await startServer();
 
-    // Start OSC Server (API)
+    // Start OSC Server
     await startOSCServer();
   } catch (error) {
     console.log(error);
@@ -37,10 +42,6 @@ const nodePath = isProduction
   }
 })();
 
-// Load Icons
-const trayIcon = path.join(__dirname, './assets/background.png');
-const appIcon = path.join(__dirname, './assets/logo.png');
-
 /**
  * @description utility function to create a notification
  * @param title
@@ -54,6 +55,26 @@ function showNotification(title, text) {
   }).show();
 }
 
+function appShutdown() {
+  // terminate node service
+  (async () => {
+    const { shutdown } = await import(nodePath);
+    // Shutdown service
+    await shutdown();
+  })();
+
+  isQuitting = true;
+  tray.destroy();
+  win.destroy();
+  app.quit();
+}
+
+function askToQuit() {
+  win.show();
+  win.focus();
+  win.send('user-request-shutdown');
+}
+
 let win;
 let splash;
 let tray = null;
@@ -76,7 +97,6 @@ if (!lock) {
 }
 
 function createWindow() {
-  // create a new `splash`-Window
   splash = new BrowserWindow({
     width: 333,
     height: 333,
@@ -85,7 +105,10 @@ function createWindow() {
     resizable: false,
     frame: false,
     alwaysOnTop: true,
+    focusable: false,
+    skipTaskbar: true,
   });
+  splash.setIgnoreMouseEvents(true);
   splash.loadURL(`file://${__dirname}/electron/splash/splash.html`);
 
   win = new BrowserWindow({
@@ -115,16 +138,10 @@ function createWindow() {
 app.disableHardwareAcceleration();
 app.whenReady().then(() => {
   // Set app title in windows
-  if (process.platform === 'win32') {
+  if (isWindows) {
     app.setAppUserModelId(app.name);
   }
 
-  // allow usual quit in mac
-  if (process.platform === 'darwin') {
-    globalShortcut.register('Command+Q', () => {
-      win.send('user-request-shutdown');
-    });
-  }
   createWindow();
 
   // register global shortcuts
@@ -135,13 +152,6 @@ app.whenReady().then(() => {
     win.focus();
   });
 
-  // recreate window if no others open
-  app.on('activate', () => {
-    if (BrowserWindow.getAllWindows().length === 0) {
-      createWindow();
-    }
-  });
-
   // give the nodejs server some time
   setTimeout(() => {
     // Load page served by node
@@ -165,15 +175,18 @@ app.whenReady().then(() => {
     });
   }, electronConfig.appIni.mainWindowWait);
 
+  // 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();
-      return false;
     }
-    return true;
   });
 
   // create tray
@@ -190,35 +203,184 @@ app.whenReady().then(() => {
     },
     {
       label: 'Shutdown',
-      click: () => {
-        win.destroy();
-        app.quit();
-      },
+      click: () => askToQuit(),
     },
   ];
 
   const trayContextMenu = Menu.buildFromTemplate(trayMenuTemplate);
   tray.setContextMenu(trayContextMenu);
-
-  // on tray click event, show main window
-  tray.on('click', function () {
-    if (!win.isVisible()) {
-      win.show();
-    }
-    win.focus();
-  });
 });
 
+const template = [
+  ...(isMac
+    ? [
+        {
+          label: 'Ontime',
+          submenu: [
+            { role: 'about' },
+            { type: 'separator' },
+            { role: 'hide' },
+            { role: 'hideOthers' },
+            { role: 'unhide' },
+            { type: 'separator' },
+            {
+              label: 'quit',
+              click: () => askToQuit(),
+              accelerator: 'Cmd+Q',
+            },
+          ],
+        },
+      ]
+    : []),
+  {
+    label: 'File',
+    submenu: [isMac ? { role: 'close' } : { role: 'quit' }],
+  },
+  {
+    label: 'Edit',
+    submenu: [
+      { role: 'undo' },
+      { role: 'redo' },
+      { type: 'separator' },
+      { role: 'cut' },
+      { role: 'copy' },
+      { role: 'paste' },
+      ...(isMac
+        ? [
+            { role: 'pasteAndMatchStyle' },
+            { role: 'delete' },
+            { role: 'selectAll' },
+            { type: 'separator' },
+            {
+              label: 'Speech',
+              submenu: [{ role: 'startSpeaking' }, { role: 'stopSpeaking' }],
+            },
+          ]
+        : [{ role: 'delete' }, { type: 'separator' }, { role: 'selectAll' }]),
+    ],
+  },
+  {
+    label: 'Views',
+    submenu: [
+      {
+        label: 'Ontime Views (opens in browser)',
+        submenu: [
+          {
+            label: 'Timer',
+            accelerator: 'CmdOrCtrl+V',
+            click: async () => {
+              await shell.openExternal('http://localhost:4001/timer');
+            },
+          },
+          {
+            label: 'Clock',
+            click: async () => {
+              await shell.openExternal('http://localhost:4001/clock');
+            },
+          },
+          {
+            label: 'Minimal Timer',
+            click: async () => {
+              await shell.openExternal('http://localhost:4001/minimal');
+            },
+          },
+          {
+            label: 'Backstage',
+            click: async () => {
+              await shell.openExternal('http://localhost:4001/backstage');
+            },
+          },
+          {
+            label: 'Public',
+            click: async () => {
+              await shell.openExternal('http://localhost:4001/public');
+            },
+          },
+          {
+            label: 'Lower Thirds',
+            click: async () => {
+              await shell.openExternal('http://localhost:4001/lower');
+            },
+          },
+
+          {
+            label: 'PiP',
+            click: async () => {
+              await shell.openExternal('http://localhost:4001/pip');
+            },
+          },
+          {
+            label: 'Studio Clock',
+            click: async () => {
+              await shell.openExternal('http://localhost:4001/studio');
+            },
+          },
+          {
+            label: 'Countdown',
+            click: async () => {
+              await shell.openExternal('http://localhost:4001/countdown');
+            },
+          },
+          { type: 'separator' },
+          {
+            label: 'Editor',
+            click: async () => {
+              await shell.openExternal('http://localhost:4001/editor');
+            },
+          },
+          {
+            label: 'Cuesheet',
+            click: async () => {
+              await shell.openExternal('http://localhost:4001/cuesheet');
+            },
+          },
+        ],
+      },
+      { type: 'separator' },
+      { role: 'forceReload' },
+      { type: 'separator' },
+      { role: 'resetZoom' },
+      { role: 'zoomIn' },
+      { role: 'zoomOut' },
+    ],
+  },
+  {
+    label: 'Window',
+    submenu: [
+      { role: 'minimize' },
+      { role: 'zoom' },
+      ...(isMac
+        ? [{ type: 'separator' }, { role: 'front' }, { type: 'separator' }, { role: 'window' }]
+        : [{ role: 'close' }]),
+    ],
+  },
+  {
+    role: 'help',
+    submenu: [
+      {
+        label: 'See on github',
+        click: async () => {
+          await shell.openExternal('https://github.com/cpvalente/ontime');
+        },
+      },
+      {
+        label: 'Online documentation',
+        click: async () => {
+          await shell.openExternal('https://cpvalente.gitbook.io/ontime/');
+        },
+      },
+    ],
+  },
+];
+
+const menu = Menu.buildFromTemplate(template);
+Menu.setApplicationMenu(menu);
+
 // unregister shortcuts before quitting
 app.once('will-quit', () => {
   globalShortcut.unregisterAll();
 });
 
-// destroy tray icon before quit
-app.once('before-quit', () => {
-  tray.destroy();
-});
-
 // Get messages from react
 // Test message
 ipcMain.on('test-message', (event, arg) => {
@@ -227,7 +389,7 @@ ipcMain.on('test-message', (event, arg) => {
 
 // Ask for main window reload
 // Test message
-ipcMain.on('reload', (event, arg) => {
+ipcMain.on('reload', () => {
   if (win) {
     win.reload();
   }
@@ -236,18 +398,7 @@ ipcMain.on('reload', (event, arg) => {
 // Terminate
 ipcMain.on('shutdown', () => {
   console.log('Got IPC shutdown');
-
-  // terminate node service
-  (async () => {
-    const { shutdown } = await import(nodePath);
-    // Shutdown service
-    await shutdown();
-  })();
-
-  isQuitting = true;
-  tray.destroy();
-  win.destroy();
-  app.quit();
+  appShutdown();
 });
 
 // Window manipulation

server/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ontime",
-  "version": "1.9.3",
+  "version": "1.9.6",
   "author": "Carlos Valente",
   "description": "Time keeping for live events",
   "repository": "https://github.com/cpvalente/ontime",

server/src/app.js

@@ -163,7 +163,6 @@ export const startServer = async (overrideConfig = null) => {
  * @return {Promise<void>}
  */
 export const shutdown = async () => {
-  console.log('Node service shutdown');
   // shutdown express server
   server.close();
 

server/src/controllers/OscController.js

@@ -3,7 +3,7 @@ import { Server } from 'node-osc';
 let oscServer = null;
 
 /**
- * @description utilty function to shutdown osc server
+ * @description utility function to shut down osc server
  */
 export const shutdownOSCServer = () => {
   if (oscServer != null) oscServer.close();
@@ -23,7 +23,7 @@ export const initiateOSC = (config) => {
     // message should look like /ontime/{path}/{args} where
     // ontime: fixed message for app
     // path: command to be called
-    // args: extra data, only used on some of the API entries (delay, goto)
+    // args: extra data, only used on some API entries (delay, goto)
 
     // split message
     const [, address, path] = msg[0].split('/');
@@ -145,6 +145,12 @@ export const initiateOSC = (config) => {
         break;
       }
 
+      case 'get-playback': {
+        const playback = global.timer.state;
+        global.timer.sendOsc('playback', playback);
+        break;
+      }
+
       default: {
         global.timer.warning('RX', `OSC IN: unhandled message ${path}`);
         break;

server/src/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ontime-server",
   "type": "module",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "dependencies": {
     "body-parser": "^1.20.0",
     "dotenv": "^16.0.1",

server/src/utils/__tests__/parser.tests.js

@@ -1,6 +1,6 @@
 import jest from 'jest-mock';
 import { dbModel } from '../../models/dataModel.js';
-import { isStringEmpty, parseExcel, parseJson, validateEvent } from '../parser.js';
+import { parseExcel, parseJson, validateEvent } from '../parser.js';
 import { makeString, validateDuration } from '../parserUtils.js';
 import { parseAliases, parseUserFields, parseViews } from '../parserFunctions.js';
 
@@ -886,24 +886,3 @@ describe('test validateDuration()', () => {
     });
   });
 });
-
-describe('isStringEmpty() function', () => {
-  describe('returns true with any non empty', () => {
-    const notEmpty = ['test', 'thisalso', '123', '#'];
-    for (const testValue of notEmpty) {
-      it(testValue, () => {
-        const isEmpty = isStringEmpty(testValue);
-        expect(isEmpty).toBe(false);
-      });
-    }
-  });
-  describe('returns true empty string or undefined', () => {
-    const empty = ['', ' ', undefined, null];
-    for (const testValue of empty) {
-      it(`handles ${testValue}`, () => {
-        const isEmpty = isStringEmpty(testValue);
-        expect(isEmpty).toBe(true);
-      });
-    }
-  });
-});

server/src/utils/parser.js

@@ -19,19 +19,6 @@ import { generateId } from './generate_id.js';
 export const EXCEL_MIME = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet';
 export const JSON_MIME = 'application/json';
 
-/**
- * @description Whether a string is considered empty
- * @param value
- * @return {boolean}
- */
-export const isStringEmpty = (value) => {
-  let v = value;
-  if (typeof value === 'string') {
-    v = value.replace(/\s+/g, '');
-  }
-  return v === '' || !v;
-};
-
 /**
  * @description Excel array parser
  * @param {array} excelData - array with excel sheet
@@ -102,9 +89,9 @@ export const parseExcel = async (excelData) => {
         } else if (j === subtitleIndex) {
           event.subtitle = column;
         } else if (j === isPublicIndex) {
-          event.isPublic = isStringEmpty(column);
+          event.isPublic = Boolean(column);
         } else if (j === skipIndex) {
-          event.skip = isStringEmpty(column);
+          event.skip = Boolean(column);
         } else if (j === notesIndex) {
           event.note = column;
         } else if (j === colourIndex) {