Restoring a heap of functionaltiy:

type events record correctly
side runner does persist session correctly (and lost a buncha code :D)
added commands for requesting good selectors for coordinates
modified base event listeners to be able to send back a response
  so we can ask the browser for stuff easier
corrected step insert positioning
removed sandbox parameter (turned out to be non-essential my b)

Author: toddtarsi

packages/selenium-ide/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seleniumhq/selenium-ide",
-  "version": "4.0.0-alpha.57",
+  "version": "4.0.0-alpha.58",
   "private": true,
   "description": "Selenium IDE electron app",
   "author": "Todd <[email protected]>",
@@ -104,9 +104,8 @@
     "@seleniumhq/code-export-javascript-mocha": "^4.0.0-alpha.2",
     "@seleniumhq/code-export-python-pytest": "^4.0.0-alpha.2",
     "@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.35",
+    "@seleniumhq/side-api": "^4.0.0-alpha.36",
     "@seleniumhq/side-model": "^4.0.0-alpha.4",
     "@seleniumhq/side-runtime": "^4.0.0-alpha.31",
     "dnd-core": "^16.0.1",
@@ -120,6 +119,7 @@
     "react-dnd": "^16.0.1",
     "react-dnd-html5-backend": "^16.0.1",
     "react-dom": "^18.2.0",
+    "side-code-export": "^4.0.0-alpha.11",
     "v8-compile-cache": "^2.3.0"
   },
   "devDependencies": {

packages/selenium-ide/src/browser/api/classes/EventListener.ts

@@ -1,7 +1,6 @@
 import { ipcRenderer } from 'electron'
 import { BaseListener, VariadicArgs } from '@seleniumhq/side-api'
 
-
 const baseListener = <ARGS extends VariadicArgs>(
   path: string
 ): BaseListener<ARGS> => {
@@ -14,7 +13,9 @@ const baseListener = <ARGS extends VariadicArgs>(
     },
     dispatchEvent(...args) {
       console.debug(path, 'dispatching event')
-      listeners.forEach((fn) => fn(...args))
+      const results = listeners.map((fn) => fn(...args))
+      ipcRenderer.send(`${path}.response`, results)
+      return results;
     },
     hasListener(listener) {
       return listeners.includes(listener)

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

@@ -21,7 +21,6 @@ import preload from 'browser/helpers/preload'
 import { webFrame } from 'electron'
 import Recorder from './preload/recorder'
 
-
 (async () => {
   const plugins = await preload({
     recorder: api.recorder,

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

@@ -17,7 +17,7 @@
 
 import { EventListenerParams, LocatorFields } from '@seleniumhq/side-api'
 import scrollIntoViewIfNeeded from 'scroll-into-view-if-needed'
-import {singleton as locatorBuilders} from './locator-builders'
+import { singleton as locatorBuilders } from './locator-builders'
 import TargetSelector from './target-selector'
 
 const init = () => {
@@ -28,6 +28,9 @@ const init = () => {
   window.sideAPI.recorder.onHighlightElement.addListener(
     processHighlightCommand
   )
+  window.sideAPI.recorder.onRequestElementAt.addListener(
+    processElementAtCommand
+  )
   window.addEventListener('beforeunload', () => {
     try {
       window.sideAPI.recorder.onRequestSelectElement.removeListener(
@@ -36,6 +39,9 @@ const init = () => {
       window.sideAPI.recorder.onHighlightElement.removeListener(
         processHighlightCommand
       )
+      window.sideAPI.recorder.onRequestElementAt.removeListener(
+        processElementAtCommand
+      )
     } catch (e) {
       // ignore
     }
@@ -57,6 +63,17 @@ function processSelectionCommand(
   }
 }
 
+function processElementAtCommand(
+  x: number,
+  y: number
+): [string, string][] | void {
+  const element = document.elementFromPoint(x, y)
+  if (element) {
+    const target = locatorBuilders.buildAll(element as HTMLElement)
+    return target
+  }
+}
+
 let targetSelector: TargetSelector | null = null
 function startSelection(field: LocatorFields) {
   targetSelector = new TargetSelector(function (element, win) {
@@ -99,7 +116,6 @@ function processMessage(event: MessageEvent<any>) {
 
 async function processHighlightCommand(locator: string): Promise<void> {
   const element = await locatorBuilders.findElement(locator)
-  console.log('Highlighting element', element)
   await highlight(element)
 }
 

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

@@ -90,6 +90,7 @@ handlers.push([
     }
     this.recordingState.typeLock = 0
   },
+  true,
 ])
 
 handlers.push([
@@ -98,6 +99,7 @@ handlers.push([
   function (this: Recorder, event) {
     this.recordingState.typeTarget = (event.target as HTMLElement) || null
   },
+  true,
 ])
 
 // © Jie-Lin You, SideeX Team
@@ -151,7 +153,6 @@ handlers.push([
   function (this: Recorder, _event) {
     const event = _event as KeyboardEvent
     const target = event.target as HTMLInputElement
-    console.log(event)
     if (target.tagName) {
       let key = event.keyCode
       let tagName = target.tagName.toLowerCase()

packages/selenium-ide/src/main/api/classes/EventListener.ts

@@ -1,16 +1,28 @@
 import { ipcMain, WebContents } from 'electron'
-import { BaseListener, EventMutator, ListenerFn, VariadicArgs } from '@seleniumhq/side-api'
+import {
+  BaseListener,
+  EventMutator,
+  ListenerFn,
+  VariadicArgs,
+} from '@seleniumhq/side-api'
 import { Session } from 'main/types'
 import getCore from '../helpers/getCore'
 import { COLOR_CYAN, vdebuglog } from 'main/util'
 
 const apiDebugLog = vdebuglog('api', COLOR_CYAN)
 
-const baseListener = <ARGS extends VariadicArgs>(
+export type MainListener<
+  ARGS extends VariadicArgs,
+  RESULT extends any
+> = BaseListener<ARGS> & {
+  dispatchEventAsync: (...args: ARGS) => Promise<RESULT[][]>
+}
+
+const baseListener = <ARGS extends VariadicArgs, RESULT extends any>(
   path: string,
   session: Session,
   mutator?: EventMutator<ARGS>
-): BaseListener<ARGS> => {
+): MainListener<ARGS, RESULT> => {
   const listeners: any[] = []
   return {
     addListener(listener) {
@@ -20,12 +32,25 @@ const baseListener = <ARGS extends VariadicArgs>(
     dispatchEvent(...args) {
       apiDebugLog('Dispatch event', path, args)
       if (mutator) {
+        session.api.state.onMutate.dispatchEvent(path, args)
         const newState = mutator(getCore(session), args)
         session.projects.project = newState.project
         session.state.state = newState.state
+      }
+      return listeners.map((fn) => fn(...args))
+    },
+    async dispatchEventAsync(...args) {
+      apiDebugLog('Dispatch event async', path, args)
+      if (mutator) {
         session.api.state.onMutate.dispatchEvent(path, args)
+        const newState = mutator(getCore(session), args)
+        session.projects.project = newState.project
+        session.state.state = newState.state
       }
-      listeners.forEach((fn) => fn(...args))
+      const results: RESULT[][] = await Promise.all(
+        listeners.map((fn) => fn(...args))
+      )
+      return results;
     },
     hasListener(listener) {
       return listeners.includes(listener)
@@ -47,7 +72,7 @@ const wrappedListener = <ARGS extends VariadicArgs>(
   session: Session,
   mutator?: EventMutator<ARGS>
 ) => {
-  const api = baseListener<ARGS>(path, session, mutator)
+  const api = baseListener<ARGS, any>(path, session, mutator)
   const senders: WebContents[] = []
   const senderCounts: number[] = []
   const senderFns: ListenerFn<ARGS>[] = []
@@ -74,14 +99,17 @@ const wrappedListener = <ARGS extends VariadicArgs>(
       senderCounts[index] += 1
       return
     }
-    const senderFn = (...args: ARGS) => {
+    const senderFn = (...args: ARGS) => new Promise((resolve) => {
       try {
+        ipcMain.once(`${path}.response`, (_event, results) => {
+          resolve(results)
+        });
         sender.send(path, ...args)
       } catch (e) {
         // Sender has expired
         removeListener(event)
       }
-    }
+    });
     api.addListener(senderFn)
     senders.push(sender)
     senderCounts.push(1)

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

@@ -1,6 +1,6 @@
-import { Api, processApi } from '@seleniumhq/side-api'
+import { Api, BaseListener, processApi } from '@seleniumhq/side-api'
 import { Session } from 'main/types'
-import EventListener from './classes/EventListener'
+import EventListener, {MainListener} from './classes/EventListener'
 import Handler from './classes/Handler'
 import RawHandler from './classes/RawHandler'
 
@@ -11,7 +11,13 @@ export const overrides = {
   }
 } as const
 
-export type MainApi = Api & {
+export type MainApi = {
+  [NS in keyof Api]: {
+    [K in keyof Api[NS]]: Api[NS][K] extends BaseListener<infer ARGS, infer RESULT>
+      ? MainListener<ARGS, RESULT>
+      : Api[NS][K]  
+  }
+} & {
   recorder: {
     getWinHandleId: Session['recorder']['getWinHandleId']
     getFrameLocation: Session['recorder']['getFrameLocation']

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

@@ -141,6 +141,18 @@ export default class RecorderController extends BaseController {
     )
   }
 
+  async requestElementAt(x: number, y: number) {
+    const results =
+      await this.session.api.recorder.onRequestElementAt.dispatchEventAsync(
+        x,
+        y
+      )
+    const allResults = results.flat().flat().filter(Boolean);
+    if (allResults.length) {
+      return allResults[0]
+    }
+  }
+
   async getWinHandleId(): Promise<string> {
     const session = await this.session.state.get()
     const activeTest = getActiveTest(session)

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

@@ -199,7 +199,6 @@ 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,

packages/side-api/package.json

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