chore: drop lodash usage

fix: `HtmlDriver` prefix in logs

Author: dlenroc

.github/workflows/nodejs.yml

@@ -20,8 +20,6 @@ jobs:
         run: npm ci
       - name: Build
         run: npm run build
-      - name: Install HTML driver
-        run: npx appium driver install --source local "$(pwd)"
       - name: Run Appium server
         run: |
           npx appium server &

npm-shrinkwrap.json

@@ -36,13 +36,13 @@
     "mainClass": "Driver"
   },
   "dependencies": {
-    "@appium/base-driver": "^9.4.4",
+    "@appium/base-driver": "^9.5.0",
     "chrome-remote-interface": "^0.33.0",
     "express": "^4.18.2",
-    "socket.io": "^4.7.2"
+    "socket.io": "^4.7.3"
   },
   "devDependencies": {
-    "@appium/types": "^0.15.0",
+    "@appium/types": "^0.16.0",
     "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-terser": "^0.4.4",
@@ -53,20 +53,18 @@
     "@types/chrome-remote-interface": "^0.31.14",
     "@types/cssesc": "^3.0.2",
     "@types/express": "^4.17.21",
-    "@types/lodash-es": "^4.17.12",
     "@types/mocha": "^10.0.6",
     "chai": "^4.3.10",
     "chai-as-promised": "^7.1.1",
     "chai-like": "^1.1.1",
     "chai-things": "^0.2.0",
     "cssesc": "^3.0.0",
-    "lodash-es": "^4.17.21",
     "mocha": "^10.2.0",
     "playwright-chromium": "^1.40.1",
-    "rollup": "^4.9.1",
+    "rollup": "^4.9.4",
     "rollup-plugin-typescript2": "^0.36.0",
     "scroll-into-view-if-needed": "^3.1.0",
-    "socket.io-client": "^4.7.2",
+    "socket.io-client": "^4.7.3",
     "tsx": "^4.7.0",
     "typescript": "^5.3.3",
     "uuid": "^9.0.1",

package.json

@@ -20,7 +20,7 @@ export default [
     plugins: [
       nodeResolve(),
       typescript(),
-      terser(),
+      terser({ mangle: false }),
     ],
   },
   {

rollup.config.mjs

@@ -1,22 +1,11 @@
-import { cloneDeepWith, has, isElement } from 'lodash-es';
 import { JavaScriptError } from '../errors/JavaScriptError.js';
-import { fromWebDriverElement, toWebDriverElement, WEB_ELEMENT_IDENTIFIER } from '../helpers/Element.js';
+import { fromWebDriver, toWebDriver } from '../helpers/WebDriver.js';
 
 export function execute(script: string, args: unknown[]): unknown {
-  const normalizedArgs = cloneDeepWith(args, (value) => {
-    if (has(value, WEB_ELEMENT_IDENTIFIER)) {
-      return fromWebDriverElement(value[WEB_ELEMENT_IDENTIFIER]);
-    }
-  });
+  args = fromWebDriver(args);
 
   try {
-    let result = new Function(script)(...normalizedArgs);
-
-    return cloneDeepWith(result, (value) => {
-      if (isElement(value)) {
-        return toWebDriverElement(value);
-      }
-    });
+    return toWebDriver(new Function(script)(...args));
   } catch (e) {
     throw JavaScriptError(e instanceof Error ? e.message : JSON.stringify(e));
   }

src/client/commands/execute.ts

@@ -1,24 +1,15 @@
-import { cloneDeepWith, has, isElement } from 'lodash-es';
 import { JavaScriptError } from '../errors/JavaScriptError.js';
-import { fromWebDriverElement, toWebDriverElement, WEB_ELEMENT_IDENTIFIER } from '../helpers/Element.js';
+import { fromWebDriver, toWebDriver } from '../helpers/WebDriver.js';
 
 export async function executeAsync(script: string, args: unknown[]): Promise<unknown> {
-  const normalizedArgs = cloneDeepWith(args, (value) => {
-    if (has(value, WEB_ELEMENT_IDENTIFIER)) {
-      return fromWebDriverElement(value[WEB_ELEMENT_IDENTIFIER]);
-    }
-  });
+  args = fromWebDriver(args);
 
   try {
-    let result = await new Promise<any>((resolve) => {
-      return new Function(script)(...normalizedArgs, resolve);
-    });
-
-    return cloneDeepWith(result, (value) => {
-      if (isElement(value)) {
-        return toWebDriverElement(value);
-      }
-    });
+    return toWebDriver(
+      await new Promise<any>((resolve) => {
+        return new Function(script)(...args, resolve);
+      })
+    );
   } catch (e) {
     throw JavaScriptError(e instanceof Error ? e.message : JSON.stringify(e));
   }

src/client/commands/executeAsync.ts

@@ -16,7 +16,7 @@ export function fromWebDriverElement(id: string | WebDriverElement): HTMLElement
   return element;
 }
 
-export function toWebDriverElement(element: Element): WebDriverElement {
+export function toWebDriverElement(element: Node): WebDriverElement {
   for (const [id, candidate] of Object.entries(ELEMENTS)) {
     if (candidate === element) {
       return { [WEB_ELEMENT_IDENTIFIER]: id };

src/client/helpers/Element.ts

@@ -0,0 +1,34 @@
+import type { Element as WebDriverElement } from '@appium/types';
+import {
+  WEB_ELEMENT_IDENTIFIER,
+  fromWebDriverElement,
+  toWebDriverElement,
+} from './Element';
+
+export function toWebDriver(value: unknown): any {
+  return typeof value === 'object'
+    ? JSON.parse(JSON.stringify(value, toWebDriverReplacer))
+    : value;
+}
+
+export function fromWebDriver(value: unknown): any {
+  return typeof value === 'object'
+    ? JSON.parse(JSON.stringify(value), fromWebDriverReplacer)
+    : value;
+}
+
+function toWebDriverReplacer(_: string, value: unknown): unknown {
+  if (value instanceof Node) {
+    return toWebDriverElement(value);
+  } else {
+    return value;
+  }
+}
+
+function fromWebDriverReplacer(_: string, value: unknown): unknown {
+  if (value && typeof value === 'object' && WEB_ELEMENT_IDENTIFIER in value) {
+    return fromWebDriverElement(value as WebDriverElement);
+  } else {
+    return value;
+  }
+}

src/client/helpers/WebDriver.ts

@@ -3,7 +3,7 @@ import { HOME_PAGE, inline, Mode, MODE, startBrowser } from './_base.js';
 describe('setWindowRect', () => {
   const { driver } = startBrowser({ headless: false });
   const rect = { x: 100, y: 200, width: 800, height: 600 };
-  const newRect = { x: 200, y: 400, width: 1280, height: 720 };
+  const newRect = { x: 150, y: 250, width: 1280, height: 720 };
 
   it('should set window rect', async () => {
     await driver.setWindowRect(rect.x, rect.y, rect.width, rect.height)