fix: native messaging on Windows

Author: samuelmaddock

packages/electron-chrome-extensions/script/native-messaging-host/.gitignore

@@ -1,2 +1,3 @@
 crxtesthost
 crxtesthost.blob
+crxtesthost.exe

packages/electron-chrome-extensions/script/native-messaging-host/build.js

@@ -42,28 +42,48 @@ async function createSEA() {
 async function installConfig(extensionIds) {
   console.info(`Installing config…`)
 
-  const name = 'com.crx.test'
-  const config = {
-    name,
+  const hostName = 'com.crx.test'
+  const manifest = {
+    name: hostName,
     description: 'electron-chrome-extensions test',
     path: path.join(outDir, exeName),
     type: 'stdio',
     allowed_origins: extensionIds.map((id) => `chrome-extension://${id}/`),
   }
 
+  const writeManifest = async (manifestPath) => {
+    await fs.mkdir(manifestPath, { recursive: true })
+    const filePath = path.join(manifestPath, `${hostName}.json`)
+    const data = Buffer.from(JSON.stringify(manifest, null, 2))
+    await fs.writeFile(filePath, data)
+    return filePath
+  }
+
   switch (process.platform) {
     case 'darwin': {
-      const configPath = path.join(
+      const manifestDir = path.join(
         os.homedir(),
         'Library',
         'Application Support',
         'Electron',
         'NativeMessagingHosts',
       )
-      await fs.mkdir(configPath, { recursive: true })
-      const filePath = path.join(configPath, `${name}.json`)
-      const data = Buffer.from(JSON.stringify(config, null, 2))
-      await fs.writeFile(filePath, data)
+      await writeManifest(manifestDir)
+      break
+    }
+    case 'win32': {
+      const manifestDir = path.join(
+        os.homedir(),
+        'AppData',
+        'Roaming',
+        'Electron',
+        'NativeMessagingHosts',
+      )
+      const manifestPath = await writeManifest(manifestDir)
+      const registryKey = `HKCU\\Software\\Google\\Chrome\\NativeMessagingHosts\\${hostName}`
+      await exec(`reg add "${registryKey}" /ve /t REG_SZ /d "${manifestPath}" /f`, {
+        stdio: 'inherit',
+      })
       break
     }
     default:

packages/electron-chrome-extensions/spec/chrome-nativeMessaging-spec.ts

@@ -8,7 +8,7 @@ const exec = promisify(cp.exec)
 import { useExtensionBrowser, useServer } from './hooks'
 import { getExtensionId } from './crx-helpers'
 
-// TODO: figure out why CI can't connect to native host
+// TODO: build crxtesthost on Linux (see script/native-messaging-host/build.js)
 if (process.platform !== 'linux') {
   describe('nativeMessaging', () => {
     const server = useServer()
@@ -21,7 +21,8 @@ if (process.platform !== 'linux') {
     before(async () => {
       const extensionId = await getExtensionId('rpc')
       const nativeMessagingPath = path.join(__dirname, '..', 'script', 'native-messaging-host')
-      await exec(`${path.join(nativeMessagingPath, 'build.js')} ${extensionId}`)
+      const buildScript = path.join(nativeMessagingPath, 'build.js')
+      await exec(`node ${buildScript} ${extensionId}`)
     })
 
     describe('sendNativeMessage()', () => {

packages/electron-chrome-extensions/src/browser/api/lib/native-messaging-host.ts

@@ -58,8 +58,8 @@ async function getConfigSearchPaths(application: string) {
     case 'win32': {
       searchPaths = (
         await Promise.allSettled([
-          readRegistryKey('HKLM', '\\Software\\Google\\Chrome\\NativeMessagingHosts', application),
-          readRegistryKey('HKCU', '\\Software\\Google\\Chrome\\NativeMessagingHosts', application),
+          readRegistryKey('HKLM', `Software\\Google\\Chrome\\NativeMessagingHosts\\${application}`),
+          readRegistryKey('HKCU', `Software\\Google\\Chrome\\NativeMessagingHosts\\${application}`),
         ])
       )
         .map((result) => (result.status === 'fulfilled' ? result.value : undefined))
@@ -76,6 +76,7 @@ async function readNativeMessagingHostConfig(
   application: string,
 ): Promise<NativeConfig | undefined> {
   const searchPaths = await getConfigSearchPaths(application)
+  d('searching', searchPaths)
   for (const filePath of searchPaths) {
     try {
       const data = await fs.readFile(filePath)

packages/electron-chrome-extensions/src/browser/api/lib/winreg.ts

@@ -1,12 +1,17 @@
 import { spawn } from 'child_process'
+import debug from 'debug'
+
+const d = debug('electron-chrome-extensions:winreg')
 
 export function readRegistryKey(hive: string, path: string, key?: string) {
   if (process.platform !== 'win32') {
     return Promise.reject('Unsupported platform')
   }
 
   return new Promise<string | null>((resolve, reject) => {
-    const child = spawn('reg', ['query', `${hive}\\${path}`, ...(key ? ['/v', key] : [])])
+    const args = ['query', `${hive}\\${path}`, ...(key ? ['/v', key] : [])]
+    d('reg %s', args.join(' '))
+    const child = spawn('reg', args)
 
     let output = ''
     let error = ''