feat: runtime.sendNativeMessage

Author: samuelmaddock

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

@@ -42,17 +42,25 @@ export class NativeMessagingHost {
   private connectionId: string
   private connected: boolean = false
   private pending?: any[]
+  private keepAlive: boolean
+  private resolveResponse?: (message: any) => void
+
+  ready?: Promise<void>
 
   constructor(
     extensionId: string,
     sender: ExtensionSender,
     connectionId: string,
     application: string,
+    keepAlive: boolean = true,
   ) {
+    this.keepAlive = keepAlive
     this.sender = sender
-    this.sender.ipc.on(`crx-native-msg-${connectionId}`, this.receiveExtensionMessage)
+    if (keepAlive) {
+      this.sender.ipc.on(`crx-native-msg-${connectionId}`, this.receiveExtensionMessage)
+    }
     this.connectionId = connectionId
-    this.launch(application, extensionId)
+    this.ready = this.launch(application, extensionId)
   }
 
   destroy() {
@@ -62,8 +70,10 @@ export class NativeMessagingHost {
       this.process.kill()
       this.process = undefined
     }
-    this.sender.ipc.off(`crx-native-msg-${this.connectionId}`, this.receiveExtensionMessage)
-    this.sender.send(`crx-native-msg-${this.connectionId}-disconnect`)
+    if (this.keepAlive) {
+      this.sender.ipc.off(`crx-native-msg-${this.connectionId}`, this.receiveExtensionMessage)
+      this.sender.send(`crx-native-msg-${this.connectionId}-disconnect`)
+    }
   }
 
   private async launch(application: string, extensionId: string) {
@@ -127,6 +137,17 @@ export class NativeMessagingHost {
     const length = data.readUInt32LE(0)
     const message = JSON.parse(data.subarray(4, 4 + length).toString())
     d('receive: %s', message)
-    this.sender.send(`crx-native-msg-${this.connectionId}`, message)
+    if (this.keepAlive) {
+      this.sender.send(`crx-native-msg-${this.connectionId}`, message)
+    } else {
+      this.resolveResponse?.(message)
+    }
+  }
+
+  sendAndReceive(message: any) {
+    this.send(message)
+    return new Promise((resolve) => {
+      this.resolveResponse = resolve
+    })
   }
 }

packages/electron-chrome-extensions/src/browser/api/runtime.ts

@@ -14,6 +14,7 @@ export class RuntimeAPI extends EventEmitter {
     handle('runtime.connectNative', this.connectNative, { permission: 'nativeMessaging' })
     handle('runtime.disconnectNative', this.disconnectNative, { permission: 'nativeMessaging' })
     handle('runtime.openOptionsPage', this.openOptionsPage)
+    handle('runtime.sendNativeMessage', this.sendNativeMessage, { permission: 'nativeMessaging' })
   }
 
   private connectNative = async (
@@ -35,6 +36,19 @@ export class RuntimeAPI extends EventEmitter {
     this.hostMap[connectionId] = undefined
   }
 
+  private sendNativeMessage = async (event: ExtensionEvent, application: string, message: any) => {
+    const connectionId = crypto.randomUUID()
+    const host = new NativeMessagingHost(
+      event.extension.id,
+      event.sender!,
+      connectionId,
+      application,
+      false,
+    )
+    await host.ready
+    return await host.sendAndReceive(message)
+  }
+
   private openOptionsPage = async ({ extension }: ExtensionEvent) => {
     // TODO: options page shouldn't appear in Tabs API
     // https://developer.chrome.com/extensions/options#tabs-api

packages/electron-chrome-extensions/src/renderer/index.ts

@@ -517,6 +517,7 @@ export const injectExtensionAPIs = () => {
               return port
             },
             openOptionsPage: invokeExtension('runtime.openOptionsPage'),
+            sendNativeMessage: invokeExtension('runtime.sendNativeMessage'),
           }
         },
       },