enhance environment safety and stabilize reruns

Author: toddtarsi

packages/selenium-ide/package.json

@@ -111,7 +111,7 @@
     "@seleniumhq/code-export-python-pytest": "^4.0.0-alpha.4",
     "@seleniumhq/code-export-ruby-rspec": "^4.0.0-alpha.3",
     "@seleniumhq/get-driver": "^4.0.0-alpha.3",
-    "@seleniumhq/side-api": "^4.0.0-alpha.39",
+    "@seleniumhq/side-api": "^4.0.0-alpha.40",
     "@seleniumhq/side-model": "^4.0.0-alpha.5",
     "@seleniumhq/side-runtime": "^4.0.0-alpha.33",
     "dnd-core": "^16.0.1",

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

@@ -2,7 +2,7 @@ import api from 'browser/api'
 import { contextBridge } from 'electron'
 import preload from './preload'
 
-export default preload(api, () => {
+export const cb = () => new Promise<void>((resolve) => {
   /**
    * Binds our API on initialization
    */
@@ -11,5 +11,8 @@ export default preload(api, () => {
      * Expose it in the main context
      */
     contextBridge.exposeInMainWorld('sideAPI', window.sideAPI)
+    resolve()
   })
-})
+});
+
+export default preload(api, cb)

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

@@ -17,16 +17,15 @@
 import type { Api } from '@seleniumhq/side-api'
 import { BrowserApiMutators } from 'browser/api'
 import mutators from 'browser/api/mutator'
-import { noop } from 'lodash/fp'
 
 export type NestedPartial<API> = {
   [K in keyof API]?: API[K] extends Record<string, unknown>
     ? NestedPartial<API[K]>
     : API[K]
 }
 
-export default (api: Api, cb = noop) =>
-  (
+export default (api: Api, ...cbs: (() => void)[]) =>
+  async (
     apiSubset: NestedPartial<Api> & {
       mutators: NestedPartial<BrowserApiMutators>
     } = {
@@ -35,5 +34,14 @@ export default (api: Api, cb = noop) =>
     },
   ) => {
     window.sideAPI = apiSubset as Api & { mutators: BrowserApiMutators }
-    cb()
+    if (cbs?.length) {
+      for (const cb of cbs) {
+        await cb()
+      }
+    }
+
+    return cbs.reduce((acc, cb) => () => {
+        acc()
+        cb()
+    })
   }

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

@@ -17,38 +17,44 @@
 import { RecorderPreprocessor } from '@seleniumhq/side-api'
 import api from 'browser/api'
 import apiMutators from 'browser/api/mutator'
-import preload from 'browser/helpers/preload-electron'
+import preload from 'browser/helpers/preload'
+import {cb as ElectronCallback} from 'browser/helpers/preload-electron'
 import { webFrame } from 'electron'
 import Recorder from './preload/recorder'
 
 const recorderProcessors: RecorderPreprocessor[] = []
-preload({
-  plugins: {
-    addRecorderPreprocessor: (fn) => {
-      recorderProcessors.push(fn)
+async function main() {
+  const preloads = await api.plugins.getPreloads()
+  for (const preload of preloads) {
+    eval(preload)
+  }
+  window.addEventListener('DOMContentLoaded', async () => {
+    webFrame.executeJavaScript(`
+      Object.defineProperty(navigator, 'webdriver', {
+        get () {
+          return true
+        } 
+      })
+    `)
+    setTimeout(async () => {
+      console.debug('Initializing the recorder')
+      const recorder = new Recorder(window, recorderProcessors)
+      recorder.attach()
+    }, 500)
+  })
+}
+
+preload(api, ElectronCallback, main)(
+  {
+    plugins: {
+      addRecorderPreprocessor: (fn) => {
+        recorderProcessors.push(fn)
+      },
+    },
+    recorder: api.recorder,
+    mutators: {
+      plugins: {},
+      recorder: apiMutators.recorder,
     },
   },
-  recorder: api.recorder,
-  mutators: {
-    plugins: {},
-    recorder: apiMutators.recorder,
-  },
-})
-window.addEventListener('DOMContentLoaded', async () => {
-  const plugins = await api.plugins.listPreloadPaths()
-  for (const plugin of plugins) {
-    __non_webpack_require__(plugin)
-  }
-  webFrame.executeJavaScript(`
-    Object.defineProperty(navigator, 'webdriver', {
-      get () {
-        return true
-      } 
-    })
-  `)
-  setTimeout(async () => {
-    console.debug('Initializing the recorder')
-    const recorder = new Recorder(window, recorderProcessors)
-    recorder.attach()
-  }, 500)
-})
+)

packages/selenium-ide/src/main/session/controllers/Driver/bidi.ts

@@ -29,11 +29,12 @@ export const createBidiAPIBindings = async (
     console.log('Playback javascript exception', entry)
   })
 
-  const scriptManager = await getScriptManager(null as any, driver as any)
+  const handle = await driver.getWindowHandle() as any
+  const scriptManager = await getScriptManager(handle, driver as any)
   await scriptManager.addPreloadScript(
     playbackWindowBidiPreload as any,
     [],
-    null
+    false
   )
   const pluginPreloads = await session.plugins.listPreloadPaths()
   pluginPreloads.forEach(async (preloadPath) => {

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

@@ -138,9 +138,10 @@ export default class PlaybackController extends BaseController {
     const browserInfo = this.session.store.get('browserInfo')
     const allowMultiplePlaybacks =
       (await this.isParallel()) && this.testQueue.length
-    const makeNewPlayback = !this.playbacks.length || allowMultiplePlaybacks  
+    const makeNewPlayback = !this.playbacks.length || allowMultiplePlaybacks
+    let playback: Playback
     if (makeNewPlayback) {
-      const playback = new Playback({
+      playback = new Playback({
         baseUrl: this.session.projects.project.url,
         executor: await this.session.driver.build({
           browser: browserInfo.browser,
@@ -171,28 +172,24 @@ export default class PlaybackController extends BaseController {
       } else {
         await playback.executor.driver.switchTo().newWindow('window')
       }
-      const state = await this.session.state.get()
-      const currentCommand = getActiveCommand(state)
-      const url =
-        currentCommand.command === 'open'
-          ? new URL(currentCommand.target as string, state.project.url).href
-          : state.project.url
-      playback.executor.doOpen(url)
-      return playback
+    } else {
+      playback = this.playbacks[0]
+      await this.claimPlaybackWindow(playback)
     }
-    return this.playbacks[0]
+    return playback
   }
 
   async claimPlaybackWindow(playback: Playback) {
     const executor = playback.executor
     const driver = executor.driver
-    const handle = await driver.getWindowHandle()
-    const existingWindow = await this.session.windows.getPlaybackWindowByHandle(
-      handle
-    )
-    if (existingWindow && existingWindow.isVisible()) {
-      return
-    }
+    try {
+      const handle = await driver.getWindowHandle()
+      const existingWindow =
+        await this.session.windows.getPlaybackWindowByHandle(handle)
+      if (existingWindow && existingWindow.isVisible()) {
+        return
+      }
+    } catch (windowDoesNotExist) {}
     let success = false
     const UUID = randomUUID()
     const window = await this.session.windows.openPlaybackWindow({
@@ -220,6 +217,13 @@ export default class PlaybackController extends BaseController {
     if (!success) {
       throw new Error('Failed to switch to playback window')
     }
+    const state = await this.session.state.get()
+    const currentCommand = getActiveCommand(state)
+    const url =
+      currentCommand.command === 'open'
+        ? new URL(currentCommand.target as string, state.project.url).href
+        : state.project.url
+    playback.executor.doOpen(url)
   }
 
   async play(testID: string, playRange = PlaybackController.defaultPlayRange) {

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

@@ -1,6 +1,7 @@
 import { PluginShape } from '@seleniumhq/side-api'
 import { correctPluginPaths, loadPlugins } from '@seleniumhq/side-runtime'
 import { ipcMain } from 'electron'
+import { readFile } from 'fs/promises'
 import BaseController from '../Base'
 import path from 'node:path'
 
@@ -18,25 +19,45 @@ export default class PluginsController extends BaseController {
     const systemPlugins = this.session.store.get('plugins')
     const projectPath = this.session.projects.filepath as string
     const activeProject = await this.session.projects.getActive()
-    return systemPlugins
-      .concat(correctPluginPaths(projectPath, activeProject.plugins))
+    return systemPlugins.concat(
+      correctPluginPaths(projectPath, activeProject.plugins)
+    )
+  }
+
+  async getPreloads() {
+    const preloadPaths = (await this.listPreloadPaths())
+      .map((preloadPath) => {
+        try {
+          const path = __non_webpack_require__.resolve(preloadPath) as string
+          return path
+        } catch (e) {
+          return null
+        }
+      })
+      .filter(Boolean) as string[]
+    
+    return Promise.all(
+      preloadPaths.map((preloadPath) => readFile(preloadPath, 'utf-8'))
+    )
   }
 
   async listPreloadPaths() {
-    const list = await this.list();
+    const list = await this.list()
     return list.map((pluginPath) => {
       const actualPluginPath = __non_webpack_require__.resolve(pluginPath)
-      const preloadPath = path.join(actualPluginPath, '..', 'preload', 'index.js')
+      const preloadPath = path.join(
+        actualPluginPath,
+        '..',
+        'preload',
+        'index.js'
+      )
       return preloadPath
     })
   }
 
   async onProjectLoaded() {
     const pluginPaths = await this.list()
-    const plugins = await loadPlugins(
-      pluginPaths,
-      __non_webpack_require__
-    )
+    const plugins = await loadPlugins(pluginPaths, __non_webpack_require__)
     plugins.forEach((plugin, index) => {
       const pluginPath = pluginPaths[index]
       return this.load(pluginPath, plugin)

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

@@ -60,7 +60,7 @@ const windowLoaderFactoryMap: WindowLoaderFactoryMap = Object.fromEntries(
               devTools: !isAutomated,
               ...(windowConfig?.webPreferences ?? {}),
               preload: hasPreload ? preloadPath : undefined,
-              sandbox: hasPreload ? false : undefined,
+              sandbox: true,
             },
             ...options,
           })
@@ -288,7 +288,7 @@ export default class WindowsController extends BaseController {
 
   async removePlaybackWIndow(window: Electron.BrowserWindow) {
     this.playbackWindows.splice(this.playbackWindows.indexOf(window), 1)
-    if (this.playbackWindows.length === 0) {
+    if (this.playbackWindows.length === 1) {
       if (this.session.state.state.status === 'recording') {
         await this.session.api.recorder.stop()
       }

packages/side-api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seleniumhq/side-api",
-  "version": "4.0.0-alpha.39",
+  "version": "4.0.0-alpha.40",
   "private": false,
   "description": "Selenium IDE API command shapes and such",
   "author": "Todd Tarsi <[email protected]>",

packages/side-api/src/commands/plugins/getPreloads.ts

@@ -0,0 +1,4 @@
+/**
+ * Get the active plugin preload scripts
+ */
+export type Shape = () => Promise<string[]>