feat: Add the Handle, HandleOnce, and RemoveHandler events to IpcMain

Author: DYH1319

src/ElectronNET.API/API/IpcMain.cs

@@ -154,5 +154,48 @@ public void Send(BrowserView browserView, string channel, params object[] data)
         {
             BridgeConnector.Socket.Emit("sendToIpcRendererBrowserView", browserView.Id, channel, data);
         }
+
+        /// <summary>
+        /// Adds a handler for an invokeable IPC. This handler will be called
+        /// whenever a renderer calls ipcRenderer.invoke(channel, ...args).
+        /// </summary>
+        /// <param name="channel">Channelname.</param>
+        /// <param name="listener">Callback Method.</param>
+        public void Handle(string channel, Func<object, object> listener)
+        {
+            BridgeConnector.Socket.Emit("registerHandleIpcMainChannel", channel);
+            BridgeConnector.Socket.On<JsonElement>(channel, (args) =>
+            {
+                var arg = FormatArguments(args);
+                var result = listener(arg);
+                BridgeConnector.Socket.Emit(channel + "Handle", result);
+            });
+        }
+
+        /// <summary>
+        /// Handles a single invokeable IPC message, then removes the listener.
+        /// See ipcMain.handle(channel, listener).
+        /// </summary>
+        /// <param name="channel">Channelname.</param>
+        /// <param name="listener">Callback Method.</param>
+        public void HandleOnce(string channel, Func<object, object> listener)
+        {
+            BridgeConnector.Socket.Emit("registerHandleOnceIpcMainChannel", channel);
+            BridgeConnector.Socket.Once<JsonElement>(channel, (args) =>
+            {
+                var arg = FormatArguments(args);
+                var result = listener(arg);
+                BridgeConnector.Socket.Emit(channel + "HandleOnce", result);
+            });
+        }
+
+        /// <summary>
+        /// Removes any handler for channel, if present.
+        /// </summary>
+        /// <param name="channel">Channelname.</param>
+        public void RemoveHandler(string channel)
+        {
+            BridgeConnector.Socket.Emit("removeHandlerIpcMainChannel", channel);
+        }
     }
 }

src/ElectronNET.Host/api/ipc.js

@@ -55,6 +55,34 @@ export = (socket: Socket) => {
         }
     });
 
+    socket.on('registerHandleIpcMainChannel', (channel) => {
+        ipcMain.handle(channel, (event, args) => {
+            return new Promise((resolve, _reject) => {
+                socket.removeAllListeners(channel + 'Handle');
+                socket.on(channel + 'Handle', (result) => {
+                    resolve(result);
+                });
+                electronSocket.emit(channel, [event.preventDefault(), args]);
+            });
+        });
+    });
+
+    socket.on('registerHandleOnceIpcMainChannel', (channel) => {
+        ipcMain.handleOnce(channel, (event, args) => {
+            return new Promise((resolve, _reject) => {
+                socket.removeAllListeners(channel + 'HandleOnce');
+                socket.once(channel + 'HandleOnce', (result) => {
+                    resolve(result);
+                });
+                electronSocket.emit(channel, [event.preventDefault(), args]);
+            });
+        });
+    });
+
+    socket.on('removeHandlerIpcMainChannel', (channel) => {
+        ipcMain.removeHandler(channel);
+    });
+
     // Integration helpers: programmatically click menu items from renderer tests
     ipcMain.on('integration-click-application-menu', (event, id: string) => {
         try {