refactor: Port web-frame-init to TypeScript (#16934)

* refactor: Port web-frame-init to TypeScript

* refactor: Use ipcRendererInternal

filenames.gni

@@ -71,8 +71,8 @@ filenames = {
     "lib/renderer/ipc-renderer-internal.ts",
     "lib/renderer/remote.ts",
     "lib/renderer/security-warnings.ts",
-    "lib/renderer/web-frame-init.js",
     "lib/renderer/window-setup.ts",
+    "lib/renderer/web-frame-init.ts",
     "lib/renderer/web-view/guest-view-internal.js",
     "lib/renderer/web-view/web-view-attributes.js",
     "lib/renderer/web-view/web-view-constants.js",

lib/renderer/init.js

@@ -28,8 +28,8 @@ v8Util.setHiddenValue(global, 'ipc-internal', new EventEmitter())
 
 // Use electron module after everything is ready.
 const { ipcRendererInternal } = require('@electron/internal/renderer/ipc-renderer-internal')
-
+const { webFrameInit } = require('@electron/internal/renderer/web-frame-init')
-require('@electron/internal/renderer/web-frame-init')()
+webFrameInit()
 
 // Process command line arguments.
 const { hasSwitch, getSwitchValue } = process.atomBinding('command_line')

lib/renderer/web-frame-init.js

@@ -1,24 +0,0 @@
-'use strict'
-
-const { webFrame } = require('electron')
-const { ipcRendererInternal } = require('@electron/internal/renderer/ipc-renderer-internal')
-const errorUtils = require('@electron/internal/common/error-utils')
-
-module.exports = () => {
-  // Call webFrame method
-  ipcRendererInternal.on('ELECTRON_INTERNAL_RENDERER_WEB_FRAME_METHOD', (event, method, args) => {
-    webFrame[method](...args)
-  })
-
-  ipcRendererInternal.on('ELECTRON_INTERNAL_RENDERER_ASYNC_WEB_FRAME_METHOD', (event, requestId, method, args) => {
-    new Promise(resolve =>
-      webFrame[method](...args, resolve)
-    ).then(result => {
-      return [null, result]
-    }, error => {
-      return [errorUtils.serialize(error)]
-    }).then(responseArgs => {
-      event.sender.send(`ELECTRON_INTERNAL_BROWSER_ASYNC_WEB_FRAME_RESPONSE_${requestId}`, ...responseArgs)
-    })
-  })
-}

lib/renderer/web-frame-init.ts

@@ -0,0 +1,38 @@
+import { webFrame, WebFrame } from 'electron'
+import { ipcRendererInternal } from '@electron/internal/renderer/ipc-renderer-internal'
+import * as errorUtils from '@electron/internal/common/error-utils'
+
+// All keys of WebFrame that extend Function
+type WebFrameMethod = {
+  [K in keyof WebFrame]:
+    WebFrame[K] extends Function ? K : never
+}
+
+export const webFrameInit = () => {
+  // Call webFrame method
+  ipcRendererInternal.on('ELECTRON_INTERNAL_RENDERER_WEB_FRAME_METHOD', (
+    _event: Electron.Event, method: keyof WebFrameMethod, args: any[]
+  ) => {
+    // The TypeScript compiler cannot handle the sheer number of
+    // call signatures here and simply gives up. Incorrect invocations
+    // will be caught by "keyof WebFrameMethod" though.
+    (webFrame[method] as any)(...args)
+  })
+
+  ipcRendererInternal.on('ELECTRON_INTERNAL_RENDERER_ASYNC_WEB_FRAME_METHOD', (
+    event: Electron.Event, requestId: number, method: keyof WebFrameMethod, args: any[]
+  ) => {
+    new Promise(resolve =>
+      // The TypeScript compiler cannot handle the sheer number of
+      // call signatures here and simply gives up. Incorrect invocations
+      // will be caught by "keyof WebFrameMethod" though.
+      (webFrame[method] as any)(...args, resolve)
+    ).then(result => {
+      return [null, result]
+    }, error => {
+      return [errorUtils.serialize(error)]
+    }).then(responseArgs => {
+      event.sender.send(`ELECTRON_INTERNAL_BROWSER_ASYNC_WEB_FRAME_RESPONSE_${requestId}`, ...responseArgs)
+    })
+  })
+}

lib/sandboxed_renderer/init.js

@@ -61,7 +61,8 @@ ipcNative.onExit = function () {
   process.emit('exit')
 }
 
-require('@electron/internal/renderer/web-frame-init')()
+const { webFrameInit } = require('@electron/internal/renderer/web-frame-init')
+webFrameInit()
 
 // Pass different process object to the preload script(which should not have
 // access to things like `process.atomBinding`).