feat(app-shell-odd): Use sd-notify

.github/workflows/app-test-build-deploy.yaml

@@ -114,7 +114,7 @@ jobs:
         run: npm install -g npm@6
       - name: check make version
         run: make --version
-      - name: 'install libudev'
+      - name: 'install libudev and libsystemd'
         if: startsWith(matrix.os, 'ubuntu')
         run: sudo apt-get update && sudo apt-get install libudev-dev
       - name: 'set complex environment variables'
@@ -205,7 +205,7 @@ jobs:
         run: make --version
       - name: 'install libudev'
         if: startsWith(matrix.os, 'ubuntu')
-        run: sudo apt-get update && sudo apt-get install libudev-dev
+        run: sudo apt-get update && sudo apt-get install libudev-dev libsystemd-dev
       - name: 'set complex environment variables'
         id: 'set-vars'
         uses: actions/[email protected]

app-shell-odd/package.json

@@ -60,5 +60,8 @@
     "uuid": "3.2.1",
     "winston": "3.1.0",
     "yargs-parser": "13.1.2"
+  },
+  "optionalDependencies": {
+    "sd-notify": "2.8.0"
   }
 }

app-shell-odd/src/main.ts

@@ -7,10 +7,12 @@ import { registerRobotLogs } from './robot-logs'
 import { registerUpdate, updateLatestVersion } from './update'
 import { registerRobotSystemUpdate } from './system-update'
 import { getConfig, getStore, getOverrides, registerConfig } from './config'
+import sdNotify from './systemd'
 
 import type { BrowserWindow } from 'electron'
 import type { Dispatch, Logger } from './types'
 
+sdNotify.sendStatus('starting app')
 const config = getConfig()
 const log = createLogger('main')
 
@@ -42,6 +44,7 @@ app.once('window-all-closed', () => {
 
 function startUp(): void {
   log.info('Starting App')
+  sdNotify.sendStatus('loading app')
   process.on('uncaughtException', error => log.error('Uncaught: ', { error }))
   process.on('unhandledRejection', reason =>
     log.error('Uncaught Promise rejection: ', { reason })
@@ -80,6 +83,11 @@ function startUp(): void {
   })
 
   log.silly('Global references', { mainWindow, rendererLogger })
+
+  ipcMain.once('dispatch', () => {
+    sdNotify.sendStatus('started')
+    sdNotify.ready()
+  })
 }
 
 function createRendererLogger(): Logger {

app-shell-odd/src/systemd.ts

@@ -0,0 +1,36 @@
+import { platform } from 'process'
+// Provide systemd when possible and a default mocked instance, used only during
+// dev workflows, when not.
+
+interface SDNotify {
+  ready: () => void
+  sendStatus: (text: string) => void
+}
+
+const provideExports = (): SDNotify => {
+  try {
+    // This has to be a require because import is async when used functionally,
+    // and to catch import errors you have to use it functionally, so it can't be
+    // at top level, and we're doing this to put stuff in exports, so let's
+    // refactor this whenever we turn on top-level async
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const systemdNotify = require('sd-notify')
+    return { ready: systemdNotify.ready, sendStatus: systemdNotify.sendStatus }
+  } catch (err) {
+    if (platform === 'linux') {
+      console.error(
+        'Could not import systemd on linux, where it should be present. This is most likely because libsystemd bindings are not available, which hopefully means this is a dev setup.'
+      )
+    }
+    return {
+      ready: () => console.log('would send sd-notify ready'),
+      sendStatus: (text: string) =>
+        console.log(`would send sd-notify status ${text}`),
+    }
+  }
+}
+
+// Finally, we want this to work just like the actual sd-notify imports, so a default
+// export it is
+// eslint-disable-next-line import/no-default-export
+export default provideExports()

app-shell-odd/typings/sd-notify.d.ts

@@ -0,0 +1,12 @@
+declare module 'sd-notify' {
+  function ready(): void
+  function sendStatus(text: string): void
+  function startWatchdogMode(interval: number): void
+  function stopWatchdogMode(): void
+  export = {
+    ready,
+    sendStatus,
+    startWatchdogMode,
+    stopWatchdogMode,
+  }
+}

yarn.lock

@@ -5434,7 +5434,7 @@ binary-extensions@^2.0.0:
   resolved "https://registry.yarnpkg.com/binary-extensions/-/binary-extensions-2.2.0.tgz#75f502eeaf9ffde42fc98829645be4ea76bd9e2d"
   integrity sha512-jDctJ/IVQbZoJykoeHbhXpOlNBqGNcwXJKJog42E5HDPUwQTSdjCHdihjj0DlnheQ7blbT6dHOafNAiS8ooQKA==
 
-bindings@^1.5.0:
+bindings@1.5.0, bindings@^1.5.0:
   version "1.5.0"
   resolved "https://registry.yarnpkg.com/bindings/-/bindings-1.5.0.tgz#10353c9e945334bc0511a6d90b38fbc7c9c504df"
   integrity sha512-p2q/t/mhvuOj/UeLlV6566GD/guowlr0hHxClI0W9m7MWYkL1F0hLo+0Aexs9HSPCtR1SXQ0TD3MMKrXZajbiQ==
@@ -18737,6 +18737,13 @@ scrollbar-width@^3.1.1:
   resolved "https://registry.yarnpkg.com/scrollbar-width/-/scrollbar-width-3.1.1.tgz#c62e63efa5934dac37b43da34f7550caca8444a2"
   integrity sha1-xi5j76WTTaw3tD2jT3VQysqERKI=
 
+[email protected]:
+  version "2.8.0"
+  resolved "https://registry.yarnpkg.com/sd-notify/-/sd-notify-2.8.0.tgz#a8e4477efac8426084e235d5d6a89f2af75571fd"
+  integrity sha512-e+D1v0Y6UzmqXcPlaTkHk1QMdqk36mF/jIYv5gwry/N2Tb8/UNnpfG6ktGLpeBOR6TCC5hPKgqA+0hTl9sm2tA==
+  dependencies:
+    bindings "1.5.0"
+
 seek-bzip@^1.0.5:
   version "1.0.6"
   resolved "https://registry.yarnpkg.com/seek-bzip/-/seek-bzip-1.0.6.tgz#35c4171f55a680916b52a07859ecf3b5857f21c4"