@appium/base-driver 10.5.2 → 10.7.0

package/lib/protocol/validators.ts

@@ -1,5 +1,3 @@
-import _ from 'lodash';
-
 export const validators = {
   setUrl: (url: any) => {
     // either an `xyz://`, `about:`, or `data:` scheme is allowed
@@ -15,5 +13,5 @@ export const validators = {
 };
 
 function isNumber(o: any): o is number {
-  return _.isNumber(o) || !_.isNaN(parseInt(o, 10)) || !_.isNaN(parseFloat(o));
+  return typeof o === 'number' || !Number.isNaN(parseInt(o, 10)) || !Number.isNaN(parseFloat(o));
 }

package/lib/test-pages/env.ts

@@ -0,0 +1,9 @@
+/** Environment variable that opts into deprecated built-in test pages on the Appium server. */
+export const LEGACY_TEST_PAGES_ENV = 'APPIUM_ENABLE_LEGACY_TEST_PAGES';
+
+const TRUTHY = new Set(['1', 'true', 'yes']);
+
+/** @returns Whether built-in legacy test pages should be mounted on the Appium server. */
+export function isLegacyTestPagesEnabled(): boolean {
+  return TRUTHY.has(String(process.env[LEGACY_TEST_PAGES_ENV] ?? '').toLowerCase());
+}

package/lib/{express/static.ts → test-pages/handlers.ts}

@@ -1,13 +1,10 @@
 import path from 'node:path';
-import {log} from './logger';
-import _ from 'lodash';
+import {log} from '../express/logger';
 import {fs} from '@appium/support';
-import B from 'bluebird';
+import {sleep} from 'asyncbox';
 import type {Request, Response} from 'express';
-
-export const STATIC_DIR = _.isNull(path.resolve(__dirname).match(/build[/\\]lib[/\\]express$/))
-  ? path.resolve(__dirname, '..', '..', 'static')
-  : path.resolve(__dirname, '..', '..', '..', 'static');
+import {compileLodashTemplate} from './template';
+import {TEST_FIXTURES_DIR} from './static-dir';
 
 type TemplateParams = Record<string, unknown>;
 
@@ -34,15 +31,8 @@ export async function welcome(req: Request, res: Response): Promise<void> {
   res.send(template(params));
 }
 
-async function guineaPigTemplate(
-  req: Request,
-  res: Response,
-  page: string
-): Promise<void> {
-  const delay = parseInt(
-    String(req.params.delay ?? (req.query?.delay ?? 0)),
-    10
-  );
+async function guineaPigTemplate(req: Request, res: Response, page: string): Promise<void> {
+  const delay = parseInt(String(req.params.delay ?? req.query?.delay ?? 0), 10);
   const throwError = String(req.params.throwError ?? req.query?.throwError ?? '');
   const params: TemplateParams = {
     throwError,
@@ -56,7 +46,7 @@ async function guineaPigTemplate(
   log.debug(`Sending guinea pig response with params: ${JSON.stringify(params)}`);
   if (delay) {
     log.debug(`Waiting ${delay}ms before responding`);
-    await B.delay(delay);
+    await sleep(delay);
   }
   res.set('content-type', 'text/html');
   res.cookie('guineacookie1', 'i am a cookie value', {path: '/'});
@@ -69,9 +59,7 @@ async function guineaPigTemplate(
   res.send(template(params));
 }
 
-async function getTemplate(
-  templateName: string
-): Promise<(params: TemplateParams) => string> {
-  const content = await fs.readFile(path.resolve(STATIC_DIR, 'test', templateName));
-  return _.template(content.toString()) as (params: TemplateParams) => string;
+async function getTemplate(templateName: string): Promise<(params: TemplateParams) => string> {
+  const content = await fs.readFile(path.resolve(TEST_FIXTURES_DIR, 'test', templateName));
+  return compileLodashTemplate(content.toString());
 }

package/lib/test-pages/index.ts

@@ -0,0 +1,34 @@
+import path from 'node:path';
+import express from 'express';
+import type {Express} from 'express';
+import favicon from 'serve-favicon';
+import {guineaPig, guineaPigScrollable, guineaPigAppBanner, welcome} from './handlers';
+import {produceError, produceCrash} from './crash';
+import {TEST_FIXTURES_DIR} from './static-dir';
+
+export interface RegisterTestPagesOpts {
+  basePath: string;
+}
+
+/**
+ * Mount deprecated built-in test pages and crash routes on an Express app.
+ *
+ * @deprecated Built-in test pages on the Appium server are deprecated and will be removed in
+ * Appium 4. Driver CI should hard-copy needed fixtures and run a local test HTTP server.
+ * @internal
+ */
+export function registerTestPages(app: Express, {basePath}: RegisterTestPagesOpts): void {
+  app.use(favicon(path.resolve(TEST_FIXTURES_DIR, 'favicon.ico')));
+  app.use(express.static(TEST_FIXTURES_DIR));
+
+  app.use(`${basePath}/produce_error`, produceError);
+  app.use(`${basePath}/crash`, produceCrash);
+
+  app.all('/welcome', welcome);
+  app.all('/test/guinea-pig', guineaPig);
+  app.all('/test/guinea-pig-scrollable', guineaPigScrollable);
+  app.all('/test/guinea-pig-app-banner', guineaPigAppBanner);
+}
+
+export {TEST_FIXTURES_DIR} from './static-dir';
+export {isLegacyTestPagesEnabled} from './env';

package/lib/test-pages/static-dir.ts

@@ -0,0 +1,19 @@
+import path from 'node:path';
+
+/**
+ * Absolute path to bundled legacy test fixture static files.
+ *
+ * @deprecated Removed in Appium 4. Test fixture files will live in the appium/test-fixtures
+ * repository. Do not depend on this path in driver CI — hard-copy needed files locally.
+ */
+export const TEST_FIXTURES_DIR = resolveTestFixturesDir();
+
+function resolveTestFixturesDir(): string {
+  const fromDir = __dirname;
+  const parts = path.resolve(fromDir).split(path.sep);
+  const baseDriverIndex = parts.indexOf('base-driver');
+  if (baseDriverIndex < 0) {
+    throw new Error(`Could not find the module root folder in the path: ${fromDir}`);
+  }
+  return path.join(parts.slice(0, baseDriverIndex + 1).join(path.sep), 'test-fixtures', 'static');
+}

package/lib/test-pages/template.ts

@@ -0,0 +1,17 @@
+/** Compile a lodash-style template string (`<%= expression %>`) into a render function. */
+export function compileLodashTemplate(
+  template: string,
+): (params: Record<string, unknown>) => string {
+  const parts: string[] = [];
+  let lastIndex = 0;
+  const re = /<%=\s*([\s\S]+?)\s*%>/g;
+  let match;
+  while ((match = re.exec(template)) !== null) {
+    parts.push(JSON.stringify(template.slice(lastIndex, match.index)));
+    parts.push(`String(${match[1]})`);
+    lastIndex = match.index + match[0].length;
+  }
+  parts.push(JSON.stringify(template.slice(lastIndex)));
+  const fn = new Function('obj', `with (obj) { return ${parts.join(' + ')}; }`);
+  return (params) => fn(params) as string;
+}

package/lib/utils.ts

@@ -0,0 +1,65 @@
+import {util} from '@appium/support';
+
+/**
+ * Deep-merge plain objects into a clone of `target`. Skips null/undefined sources.
+ * Non-plain values on a key replace the previous value (same as lodash merge for objects).
+ */
+export function mergePlainObjects<T extends Record<string, unknown>>(
+  target: T,
+  ...sources: Array<Partial<T> | undefined>
+): T {
+  const result = structuredClone(target);
+  for (const source of sources) {
+    if (source == null) {
+      continue;
+    }
+    for (const [key, value] of Object.entries(source)) {
+      const existing = result[key as keyof T];
+      if (util.isPlainObject(existing) && util.isPlainObject(value)) {
+        result[key as keyof T] = mergePlainObjects(
+          existing as Record<string, unknown>,
+          value as Record<string, unknown>,
+        ) as T[keyof T];
+      } else if (value !== undefined) {
+        result[key as keyof T] = value as T[keyof T];
+      }
+    }
+  }
+  return result;
+}
+
+/** Return a shallow copy of `obj` without `key`. Non-objects are returned unchanged. */
+export function omit<T extends Record<string, unknown>>(obj: T, key: string): T {
+  if (!util.isPlainObject(obj)) {
+    return obj;
+  }
+  return Object.fromEntries(Object.entries(obj).filter(([k]) => k !== key)) as T;
+}
+
+/** Return a shallow copy of `obj` without any of `keys`. */
+export function omitKeys<T extends Record<string, unknown>>(obj: T, keys: readonly string[]): T {
+  if (!util.isPlainObject(obj) || keys.length === 0) {
+    return obj;
+  }
+  const keysToOmit = new Set(keys);
+  return Object.fromEntries(Object.entries(obj).filter(([k]) => !keysToOmit.has(k))) as T;
+}
+
+/** Return a shallow copy of `obj` containing only listed keys. */
+export function pick<T extends Record<string, unknown>>(
+  obj: T,
+  keys: readonly string[],
+): Partial<T> {
+  const keysToPick = new Set(keys);
+  return Object.fromEntries(Object.entries(obj).filter(([k]) => keysToPick.has(k))) as Partial<T>;
+}
+
+/** Return a shallow copy of `obj` whose entries pass `predicate`. */
+export function pickBy<T extends Record<string, unknown>>(
+  obj: T,
+  predicate: (value: T[keyof T], key: keyof T) => boolean,
+): Partial<T> {
+  return Object.fromEntries(
+    Object.entries(obj).filter(([key, value]) => predicate(value as T[keyof T], key as keyof T)),
+  ) as Partial<T>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/base-driver",
-  "version": "10.5.2",
+  "version": "10.7.0",
   "description": "Base driver class for Appium drivers",
   "keywords": [
     "automation",
@@ -31,7 +31,7 @@
     "index.js",
     "index.d.ts",
     "lib",
-    "static",
+    "test-fixtures",
     "build",
     "tsconfig.json",
     "!build/tsconfig.tsbuildinfo",
@@ -45,24 +45,21 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@appium/support": "7.2.2",
-    "@appium/types": "1.4.0",
-    "@colors/colors": "1.6.0",
+    "@appium/support": "7.2.4",
+    "@appium/types": "1.5.1",
     "async-lock": "1.4.1",
-    "asyncbox": "6.2.0",
-    "axios": "1.16.0",
-    "bluebird": "3.7.2",
+    "asyncbox": "6.3.0",
+    "axios": "1.17.0",
     "body-parser": "2.2.2",
     "express": "5.2.1",
     "fastest-levenshtein": "1.0.16",
     "http-status-codes": "2.3.0",
-    "lodash": "4.18.1",
-    "lru-cache": "11.3.5",
+    "lru-cache": "11.5.1",
     "method-override": "3.0.0",
-    "morgan": "1.10.1",
+    "morgan": "1.11.0",
     "path-to-regexp": "8.4.2",
     "serve-favicon": "2.5.1",
-    "type-fest": "5.6.0"
+    "type-fest": "5.7.0"
   },
   "optionalDependencies": {
     "spdy": "4.0.2"
@@ -74,7 +71,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f5369c65a8dfe5f9a590c31d38b12b33e6e58fde",
+  "gitHead": "213efd0fa400bdd0156b00ad2c45f8ef005a01ca",
   "tsd": {
     "directory": "test/types"
   }

package/tsconfig.json

@@ -7,6 +7,7 @@
     }
   },
   "compilerOptions": {
+    "strict": true,
     "outDir": "build",
     "paths": {
       "@appium/support": ["../support"],

package/build/lib/express/crash.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"crash.d.ts","sourceRoot":"","sources":["../../../lib/express/crash.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,wBAAgB,YAAY,IAAI,KAAK,CAEpC;AAED;;GAEG;AACH,wBAAgB,YAAY,IAAI,KAAK,CAEpC"}

package/build/lib/express/crash.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"crash.js","sourceRoot":"","sources":["../../../lib/express/crash.ts"],"names":[],"mappings":";;AAKA,oCAEC;AAKD,oCAEC;AAdD,0CAAmC;AAEnC;;GAEG;AACH,SAAgB,YAAY;IAC1B,MAAM,IAAI,iBAAM,CAAC,mBAAmB,CAAC,oCAAoC,CAAC,CAAC;AAC7E,CAAC;AAED;;GAEG;AACH,SAAgB,YAAY;IAC1B,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;AACpD,CAAC"}

package/build/lib/express/static.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"static.d.ts","sourceRoot":"","sources":["../../../lib/express/static.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAC,OAAO,EAAE,QAAQ,EAAC,MAAM,SAAS,CAAC;AAE/C,eAAO,MAAM,UAAU,QAEgC,CAAC;AAIxD,8CAA8C;AAC9C,wBAAsB,SAAS,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAE1E;AAED,yDAAyD;AACzD,wBAAsB,mBAAmB,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAEpF;AAED,yDAAyD;AACzD,wBAAsB,kBAAkB,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAEnF;AAED,sCAAsC;AACtC,wBAAsB,OAAO,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAKxE"}

package/build/lib/express/static.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"static.js","sourceRoot":"","sources":["../../../lib/express/static.ts"],"names":[],"mappings":";;;;;;AAcA,8BAEC;AAGD,kDAEC;AAGD,gDAEC;AAGD,0BAKC;AAlCD,0DAA6B;AAC7B,qCAA6B;AAC7B,oDAAuB;AACvB,6CAAmC;AACnC,wDAAyB;AAGZ,QAAA,UAAU,GAAG,gBAAC,CAAC,MAAM,CAAC,mBAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAC7F,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC;IAC/C,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;AAIxD,8CAA8C;AACvC,KAAK,UAAU,SAAS,CAAC,GAAY,EAAE,GAAa;IACzD,MAAM,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,iBAAiB,CAAC,CAAC;AACvD,CAAC;AAED,yDAAyD;AAClD,KAAK,UAAU,mBAAmB,CAAC,GAAY,EAAE,GAAa;IACnE,MAAM,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,4BAA4B,CAAC,CAAC;AAClE,CAAC;AAED,yDAAyD;AAClD,KAAK,UAAU,kBAAkB,CAAC,GAAY,EAAE,GAAa;IAClE,MAAM,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,4BAA4B,CAAC,CAAC;AAClE,CAAC;AAED,sCAAsC;AAC/B,KAAK,UAAU,OAAO,CAAC,GAAY,EAAE,GAAa;IACvD,MAAM,MAAM,GAAmB,EAAC,OAAO,EAAE,eAAe,EAAC,CAAC;IAC1D,YAAG,CAAC,KAAK,CAAC,yCAAyC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC7E,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,cAAc,CAAC,CAAC;IACnD,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AAC7B,CAAC;AAED,KAAK,UAAU,iBAAiB,CAC9B,GAAY,EACZ,GAAa,EACb,IAAY;IAEZ,MAAM,KAAK,GAAG,QAAQ,CACpB,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,EACnD,EAAE,CACH,CAAC;IACF,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,IAAI,GAAG,CAAC,KAAK,EAAE,UAAU,IAAI,EAAE,CAAC,CAAC;IAChF,MAAM,MAAM,GAAmB;QAC7B,UAAU;QACV,UAAU,EAAE,IAAI,IAAI,EAAE;QACtB,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC;QACpC,OAAO,EAAE,MAAM;KAChB,CAAC;IACF,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM,IAAI,GAAG,CAAC,IAAI,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,IAAI,UAAU,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;QAChG,MAAM,CAAC,OAAO,GAAG,MAAM,CAAE,GAAG,CAAC,IAA4B,CAAC,QAAQ,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;IACxF,CAAC;IACD,YAAG,CAAC,KAAK,CAAC,4CAA4C,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAChF,IAAI,KAAK,EAAE,CAAC;QACV,YAAG,CAAC,KAAK,CAAC,WAAW,KAAK,sBAAsB,CAAC,CAAC;QAClD,MAAM,kBAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IACD,GAAG,CAAC,GAAG,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;IACrC,GAAG,CAAC,MAAM,CAAC,eAAe,EAAE,qBAAqB,EAAE,EAAC,IAAI,EAAE,GAAG,EAAC,CAAC,CAAC;IAChE,GAAG,CAAC,MAAM,CAAC,eAAe,EAAE,SAAS,EAAE,EAAC,IAAI,EAAE,GAAG,EAAC,CAAC,CAAC;IACpD,GAAG,CAAC,MAAM,CAAC,eAAe,EAAE,kBAAkB,EAAE;QAC9C,MAAM,EAAE,iBAAiB;QACzB,IAAI,EAAE,GAAG;KACV,CAAC,CAAC;IACH,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,CAAC;IACzC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AAC7B,CAAC;AAED,KAAK,UAAU,WAAW,CACxB,YAAoB;IAEpB,MAAM,OAAO,GAAG,MAAM,YAAE,CAAC,QAAQ,CAAC,mBAAI,CAAC,OAAO,CAAC,kBAAU,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;IAClF,OAAO,gBAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAuC,CAAC;AAC9E,CAAC"}