making preload plugin scripts work again

Author: toddtarsi

packages/selenium-ide/package.json

@@ -106,7 +106,7 @@
     "@seleniumhq/code-export-ruby-rspec": "^4.0.0-alpha.1",
     "side-code-export": "^4.0.0-alpha.11",
     "@seleniumhq/get-driver": "^4.0.0-alpha.1",
-    "@seleniumhq/side-api": "^4.0.0-alpha.33",
+    "@seleniumhq/side-api": "^4.0.0-alpha.34",
     "@seleniumhq/side-model": "^4.0.0-alpha.4",
     "@seleniumhq/side-runtime": "^4.0.0-alpha.31",
     "dnd-core": "^16.0.1",

packages/selenium-ide/src/browser/api/index.ts

@@ -11,6 +11,7 @@ const api: Api = processApi((path: string) => {
   return Handler()(path)
 })
 
+export {BrowserApiMutators} from './mutator'
 export { Api } from '@seleniumhq/side-api'
 
 export default api

packages/selenium-ide/src/browser/api/mutator.ts

@@ -1,16 +1,18 @@
 import { processApi } from '@seleniumhq/side-api'
 import { ApiHoist as Api } from '@seleniumhq/side-api'
 
+type FunctionKeys<T extends Record<string, {mutator?: Function}>> = {
+  [K in keyof T as T[K]['mutator'] extends Function ? K : never]: T[K]['mutator'];
+};
+
 /**
  * This Converts the chrome API type to something usable
  * from the front end
  */
-export type BrowserApiMutatorMapper = {
-  [Namespace in keyof Api]: {
-    [Handler in keyof Api[Namespace]]: Api[Namespace][Handler]['mutator']
-  }
+export type BrowserApiMutators = {
+  [Namespace in keyof Api]: FunctionKeys<Api[Namespace]>
 }
 
-export default processApi<BrowserApiMutatorMapper>(
+export default processApi<BrowserApiMutators>(
   (_, handler) => handler.mutator
 )

packages/selenium-ide/src/browser/helpers/preload.ts

@@ -1,13 +1,67 @@
-import { contextBridge } from 'electron'
-import api from 'browser/api'
-import apiMutators from 'browser/api/mutator'
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+import { PluginPreloadOutputShape } from '@seleniumhq/side-api'
+import api, { Api, BrowserApiMutators } from 'browser/api'
+import mutators from 'browser/api/mutator'
+import { contextBridge, ipcRenderer } from 'electron'
 
-/**
- * Binds our API on initialization
- */
-process.once('loaded', async () => {
-  /**
-   * Expose it in the main context
-   */
-  contextBridge.exposeInMainWorld('sideAPI', { ...api, mutators: apiMutators })
-})
+export default (
+  apiSubset: Partial<Api> & { mutators: Partial<BrowserApiMutators> } = {
+    ...api,
+    mutators,
+  }
+) =>
+  new Promise<(PluginPreloadOutputShape | null)[]>((resolve) => {
+    const loadPluginFromPath = ([pluginPath, preloadPath]: [
+      string,
+      string
+    ]): PluginPreloadOutputShape | null => {
+      try {
+        const pluginPreload = __non_webpack_require__(preloadPath)
+        const pluginHandler =
+          typeof pluginPreload === 'function'
+            ? pluginPreload
+            : pluginPreload.default
+        return pluginHandler((...args: any[]) =>
+          ipcRenderer.send(`message-${pluginPath}`, ...args)
+        )
+      } catch (e) {
+        console.error(e)
+        return null
+      }
+    }
+
+    window.sideAPI = apiSubset as Api & { mutators: BrowserApiMutators }
+
+    /**
+     * Binds our API on initialization
+     */
+    process.once('loaded', async () => {
+      /**
+       * Expose it in the main context
+       */
+      contextBridge.exposeInMainWorld('sideAPI', window.sideAPI)
+      const pluginPaths = await api.plugins.list()
+      const preloadPaths = await api.plugins.listPreloadPaths()
+      const richPlugins: [string, string][] = pluginPaths.map((p, i) => [
+        p,
+        preloadPaths[i],
+      ])
+      const plugins = richPlugins.map(loadPluginFromPath)
+      resolve(plugins)
+    })
+  })

packages/selenium-ide/src/browser/windows/Chromedriver/preload.ts

@@ -1 +1,3 @@
-import '../../helpers/preload'
+import preload from '../../helpers/preload'
+
+preload()

packages/selenium-ide/src/browser/windows/Logger/preload.ts

@@ -1 +1,3 @@
-import '../../helpers/preload'
+import preload from '../../helpers/preload'
+
+preload()

packages/selenium-ide/src/browser/windows/PlaybackWindow/preload.ts

@@ -14,52 +14,34 @@
 // KIND, either express or implied.  See the License for the
 // specific language governing permissions and limitations
 // under the License.
+import { PluginPreloadOutputShape } from '@seleniumhq/side-api'
 import api from 'browser/api'
 import apiMutators from 'browser/api/mutator'
-import { contextBridge, ipcRenderer, webFrame } from 'electron'
-import { identity } from 'lodash/fp'
+import preload from 'browser/helpers/preload'
+import { webFrame } from 'electron'
 import Recorder from './preload/recorder'
 
-const pluginFromPath = ([pluginPath, preloadPath]: [string, string]) => {
-  try {
-    const pluginPreload = __non_webpack_require__(preloadPath)
-    const pluginHandler =
-      typeof pluginPreload === 'function'
-        ? pluginPreload
-        : pluginPreload.default
-    return pluginHandler((...args: any[]) =>
-      ipcRenderer.send(`message-${pluginPath}`, ...args)
-    )
-  } catch (e) {
-    console.error(e)
-    return null
-  }
-}
 
-/**
- * Expose it in the main context
- */
-window.addEventListener('DOMContentLoaded', async () => {
-  webFrame.executeJavaScript(`
-    Object.defineProperty(navigator, 'webdriver', {
-      get () {
-        return true
-      } 
-    })
-  `)
-  window.sideAPI = {
+(async () => {
+  const plugins = await preload({
     recorder: api.recorder,
-    // @ts-expect-error
     mutators: { recorder: apiMutators.recorder },
-  }
-  const pluginPaths = await api.plugins.list()
-  const preloadPaths = await api.plugins.listPreloadPaths()
-  const richPlugins: [string, string][] = pluginPaths.map((p, i) => [p, preloadPaths[i]])
-  const plugins = richPlugins.map(pluginFromPath).filter(identity)
+  })
+  window.addEventListener('DOMContentLoaded', async () => {
+    webFrame.executeJavaScript(`
+      Object.defineProperty(navigator, 'webdriver', {
+        get () {
+          return true
+        } 
+      })
+    `)
+    setTimeout(async () => {
+      console.debug('Initializing the recorder')
+      new Recorder(window, plugins.filter(Boolean) as PluginPreloadOutputShape[])
+    }, 500)
+  })
+})();
 
-  contextBridge.exposeInMainWorld('sideAPI', window.sideAPI)
-  setTimeout(async () => {
-    console.debug('Initializing the recorder')
-    new Recorder(window, plugins)
-  }, 500)
-})
+/**
+ * Expose it in the main context
+ */

packages/selenium-ide/src/browser/windows/ProjectEditor/preload.ts

@@ -1 +1,3 @@
-import '../../helpers/preload'
+import preload from '../../helpers/preload'
+
+preload()

packages/selenium-ide/src/browser/windows/Splash/preload.ts

@@ -1 +1,3 @@
-import '../../helpers/preload'
+import preload from '../../helpers/preload'
+
+preload()

packages/selenium-ide/src/main/session/controllers/Windows/index.ts

@@ -61,6 +61,7 @@ const windowLoaderFactoryMap: WindowLoaderFactoryMap = Object.fromEntries(
               devTools: !isAutomated,
               ...(windowConfig?.webPreferences ?? {}),
               preload: hasPreload ? preloadPath : undefined,
+              sandbox: hasPreload ? false : undefined,
             },
             ...options,
           })
@@ -198,11 +199,19 @@ export default class WindowsController extends BaseController {
       webPreferences: {
         // This should be the default preload, which just adds the sideAPI to the window
         preload: join(__dirname, `project-editor-preload-bundle.js`),
+        sandbox: false,
         ...(opts?.webPreferences ?? {}),
       },
+      show: false,
     })
     this.windows[name] = window
     await window.loadURL(`file://${filepath}`)
+    await this.useWindowState(
+      window,
+      'windowSize' + name,
+      'windowPosition' + name
+    )
+    window.show()
     return true
   }
 
@@ -290,7 +299,11 @@ export default class WindowsController extends BaseController {
     if (isMac) {
       window.setWindowButtonVisibility(false)
     }
-    await this.useWindowState(window, 'windowSizePlayback', 'windowPositionPlayback')
+    await this.useWindowState(
+      window,
+      'windowSizePlayback',
+      'windowPositionPlayback'
+    )
     window.show()
   }
 
@@ -305,14 +318,14 @@ export default class WindowsController extends BaseController {
   ) {
     const size = storage.get(sizeKey) as number[]
     const position = storage.get(positionKey) as number[]
-    if (size.length) window.setSize(size[0], size[1], true)
+    if (size?.length) window.setSize(size[0], size[1], true)
 
     const screenElectron = electron.screen.getPrimaryDisplay()
 
     const sWidth = screenElectron.bounds.width
     const sHeight = screenElectron.bounds.height
 
-    if (position.length) {
+    if (position?.length) {
       const adjustedX = position[0] < 0 ? 50 : position[0]
       const adjustedY = position[1] < 0 ? 50 : position[1]
       window.setPosition(adjustedX, adjustedY)
@@ -347,7 +360,7 @@ export default class WindowsController extends BaseController {
     await this.initializePlaybackWindow()
     await this.close('splash')
 
-    await this.open(projectEditorWindowName, {show: false})
+    await this.open(projectEditorWindowName, { show: false })
     const projectWindow = await this.get(projectEditorWindowName)
     this.useWindowState(projectWindow, 'windowSize', 'windowPosition')