Enable notifications on Windows.

hydraulic-software · Dec 30, 2022 · 6034296 · 6034296
1 parent a958665
commit 6034296
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 92 deletions.
diff --git a/app/src/lib/find-toast-activator-clsid.ts b/app/src/lib/find-toast-activator-clsid.ts
diff --git a/app/src/main-process/main.ts b/app/src/main-process/main.ts
@@ -103,10 +103,12 @@ if (__DARWIN__) {
   possibleProtocols.add('github-windows')
 }
 
-// On Windows, in order to get notifications properly working for dev builds,
-// we'll want to set the right App User Model ID from production builds.
+// We have to inform Electron of our package ID (== "app user model ID") as otherwise notifications won't work correctly.
+// Package/AUMIDs can be discovered with the Get-StartApps powershell cmdlet. When packaged as MSIX using Conveyor the
+// package ID is the name of the app combined with a text-encoded hash of the X.509 signing certificate subject name.
+// It is therefore stable as long as the package is always signed with the same identity (doesn't have to be the same key).
 if (__WIN32__) {
-  app.setAppUserModelId('com.squirrel.GitHubDesktop.GitHubDesktop')
+  app.setAppUserModelId('GithubDesktop_49jahnq5qzr1m!GithubDesktop')
 }
 
 app.on('window-all-closed', () => {
@@ -131,7 +133,6 @@ if (__WIN32__ && process.argv.length > 1) {
 
 // TODO(low): Support the CLI launcher.
 
-// TODO(low): Fix notifications by adding appx manifest data: https://learn.microsoft.com/en-us/windows/apps/design/shell/tiles-and-notifications/send-local-toast-desktop-cpp-wrl#packaged
 initializeDesktopNotifications()
 
 function handleAppURL(url: string) {

diff --git a/app/src/main-process/menu/build-default-menu.ts b/app/src/main-process/menu/build-default-menu.ts
@@ -570,7 +570,7 @@ export function buildDefaultMenu({
     )
   }
 
-  if (__RELEASE_CHANNEL__ === 'development' || __RELEASE_CHANNEL__ === 'test') {
+  if (true || __RELEASE_CHANNEL__ === 'development' || __RELEASE_CHANNEL__ === 'test') {
     helpItems.push({
       label: 'Show notification',
       click: emit('test-show-notification'),

diff --git a/app/src/main-process/notifications.ts b/app/src/main-process/notifications.ts
@@ -1,11 +1,6 @@
-import {
-  initializeNotifications,
-  onNotificationEvent,
-  terminateNotifications,
-} from 'desktop-notifications'
-import { BrowserWindow } from 'electron'
-import { findToastActivatorClsid } from '../lib/find-toast-activator-clsid'
-import { DesktopAliveEvent } from '../lib/stores/alive-store'
+import {initializeNotifications, onNotificationEvent, terminateNotifications,} from 'desktop-notifications'
+import {BrowserWindow} from 'electron'
+import {DesktopAliveEvent} from '../lib/stores/alive-store'
 import * as ipcWebContents from './ipc-webcontents'
 
 let windowsToastActivatorClsid: string | undefined = undefined
@@ -21,22 +16,8 @@ export function initializeDesktopNotifications() {
     return
   }
 
-  if (windowsToastActivatorClsid !== undefined) {
-    return
-  }
-
-  windowsToastActivatorClsid = findToastActivatorClsid()
-
-  if (windowsToastActivatorClsid === undefined) {
-    log.error(
-      'Toast activator CLSID not found in any of the shortcuts. Falling back to known CLSIDs.'
-    )
-
-    // This is generated by Squirrel.Windows here:
-    // https://github.com/Squirrel/Squirrel.Windows/blob/7396fa50ccebf97e28c79ef519c07cb9eee121be/src/Squirrel/UpdateManager.ApplyReleases.cs#L258
-    windowsToastActivatorClsid = '{27D44D0C-A542-5B90-BCDB-AC3126048BA2}'
-  }
-
+  // This CLSID is originally a hash of a string calculated by Squirrel, but we can just continue using it post Conveyorization.
+  windowsToastActivatorClsid = '{27D44D0C-A542-5B90-BCDB-AC3126048BA2}'
   log.info(`Using toast activator CLSID ${windowsToastActivatorClsid}`)
   initializeNotifications({ toastActivatorClsid: windowsToastActivatorClsid })
 }

diff --git a/app/src/ui/app.tsx b/app/src/ui/app.tsx
@@ -398,13 +398,6 @@ export class App extends React.Component<IAppProps, IAppState> {
   }
 
   private testShowNotification() {
-    if (
-      __RELEASE_CHANNEL__ !== 'development' &&
-      __RELEASE_CHANNEL__ !== 'test'
-    ) {
-      return
-    }
-
     showNotification({
       title: 'Test notification',
       body: 'Click here! This is a test notification',

diff --git a/conveyor.conf b/conveyor.conf
@@ -93,8 +93,28 @@ app {
     }
   }
 
+  windows {
+    // Register a COM object that will be invoked by Windows when the user interacts with a "toast" notification for things like
+    // pull requests being opened, etc. See https://learn.microsoft.com/en-us/windows/apps/design/shell/tiles-and-notifications/send-local-toast-desktop-cpp-wrl#packaged
+    manifests.msix.extensions-xml = """
+        <!--Register COM CLSID LocalServer32 registry key-->
+        <com:Extension Category="windows.comServer">
+          <com:ComServer>
+            <com:ExeServer Executable="GitHubDesktop.exe" DisplayName="Toast activator">
+              <com:Class Id="27D44D0C-A542-5B90-BCDB-AC3126048BA2" DisplayName="Toast activator"/>
+            </com:ExeServer>
+          </com:ComServer>
+        </com:Extension>
+
+        <!--Specify which CLSID to activate when toast clicked-->
+        <desktop:Extension Category="windows.toastNotificationActivation">
+          <desktop:ToastNotificationActivation ToastActivatorCLSID="27D44D0C-A542-5B90-BCDB-AC3126048BA2" />
+        </desktop:Extension>
+    """
+  }
+
   // To do:
   // - There is a CLI tool. It could be exposed by default on Windows.
 }
 
-conveyor.compatibility-level = 5
+conveyor.compatibility-level = 6