@appium/base-driver 8.3.1 → 8.4.2

package/lib/protocol/protocol.js

@@ -16,8 +16,6 @@ const CREATE_SESSION_COMMAND = 'createSession';
 const DELETE_SESSION_COMMAND = 'deleteSession';
 const GET_STATUS_COMMAND = 'getStatus';
 
-class Protocol {}
-
 function determineProtocol (createSessionArgs) {
   return _.some(createSessionArgs, isW3cCaps) ? PROTOCOLS.W3C : PROTOCOLS.MJSONWP;
 }
@@ -456,7 +454,7 @@ async function doJwpProxy (driver, req, res) {
 
 
 export {
-  Protocol, routeConfiguringFunction, isSessionCommand,
+  routeConfiguringFunction, isSessionCommand,
   driverShouldDoJwpProxy, determineProtocol, CREATE_SESSION_COMMAND,
   DELETE_SESSION_COMMAND, GET_STATUS_COMMAND,
 };

package/lib/protocol/routes.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import _ from 'lodash';
 import { util } from '@appium/support';
 import { PROTOCOLS, DEFAULT_BASE_PATH } from '../constants';
@@ -14,6 +16,7 @@ const SET_ALERT_TEXT_PAYLOAD_PARAMS = {
 // define the routes, mapping of HTTP methods to particular driver commands,
 // and any parameters that are expected in a request
 // parameters can be `required` or `optional`
+/** @type {import('@appium/types').MethodMap} */
 const METHOD_MAP = {
   '/status': {
     GET: {command: 'getStatus'}
@@ -240,6 +243,12 @@ const METHOD_MAP = {
   '/session/:sessionId/element/:elementId/shadow': {
     GET: {command: 'elementShadowRoot'}
   },
+  '/session/:sessionId/shadow/:shadowId/element': {
+    POST: {command: 'findElementFromShadowRoot', payloadParams: {required: ['using', 'value']}}
+  },
+  '/session/:sessionId/shadow/:shadowId/elements': {
+    POST: {command: 'findElementsFromShadowRoot', payloadParams: {required: ['using', 'value']}}
+  },
   '/session/:sessionId/element/:elementId/css/:propertyName': {
     GET: {command: 'getCssProperty'}
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/base-driver",
-  "version": "8.3.1",
+  "version": "8.4.2",
   "description": "Base driver class for Appium drivers",
   "keywords": [
     "automation",
@@ -37,10 +37,10 @@
     "!build/test/e2e/fixtures"
   ],
   "scripts": {
-    "build": "npm run build:sources && npm run build:test",
-    "build:sources": "babel lib --root-mode=upward --out-dir=build/lib",
+    "build": "npm run build:distfiles && npm run build:test",
+    "build:distfiles": "babel lib --root-mode=upward --out-dir=build/lib",
     "build:test": "babel test --root-mode=upward --out-dir=build/test --copy-files",
-    "dev": "npm run build -- --watch",
+    "dev": "run-p \"build:distfiles -- --watch\" \"build:test -- --watch\"",
     "fix": "npm run lint -- --fix",
     "lint": "eslint -c ../../.eslintrc --ignore-path ../../.eslintignore .",
     "test": "npm run test:unit",
@@ -48,25 +48,27 @@
     "test:unit": "mocha --require ../../test/setup-babel.js \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/support": "^2.56.1",
-    "@babel/runtime": "7.17.8",
+    "@appium/support": "^2.57.1",
+    "@babel/runtime": "7.17.9",
     "@colors/colors": "1.5.0",
     "async-lock": "1.3.1",
     "asyncbox": "2.9.2",
     "axios": "0.26.1",
     "bluebird": "3.7.2",
-    "body-parser": "1.19.2",
+    "body-parser": "1.20.0",
     "es6-error": "4.1.1",
     "express": "4.17.3",
     "http-status-codes": "2.2.0",
     "lodash": "4.17.21",
-    "lru-cache": "7.7.1",
+    "lru-cache": "7.8.1",
     "method-override": "3.0.0",
     "morgan": "1.10.0",
     "serve-favicon": "2.5.0",
     "source-map-support": "0.5.21",
-    "validate.js": "0.13.1",
-    "ws": "7.5.7"
+    "validate.js": "0.13.1"
+  },
+  "devDependencies": {
+    "ws": "8.5.0"
   },
   "engines": {
     "node": ">=12",
@@ -75,5 +77,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6d35def9ed754121fee691cdaf7b30e3a7ac3e8b"
+  "types": "./build/lib/index.d.ts",
+  "gitHead": "319f7289e7019efaeac1271936b2d991041a02c2"
 }

package/test/basedriver/driver-tests.js

@@ -10,6 +10,35 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
   // to display the driver under test in report
   const className = DriverClass.name || '(unknown driver)';
 
+  describe('static property', function () {
+    describe('baseVersion', function () {
+      it('should exist', function () {
+        DriverClass.baseVersion.should.exist;
+      });
+    });
+  });
+
+  describe('Log prefix', function () {
+
+    it('should setup log prefix', async function () {
+      const d = new DriverClass();
+      const previousPrefix = d.log.prefix;
+      await d.createSession({
+        alwaysMatch: Object.assign({}, defaultCaps, {
+          platformName: 'Fake',
+          'appium:deviceName': 'Commodore 64',
+        }),
+        firstMatch: [{}],
+      });
+      try {
+        previousPrefix.should.not.eql(d.log.prefix);
+      } finally {
+        await d.deleteSession();
+        previousPrefix.should.eql(d.log.prefix);
+      }
+    });
+
+  });
 
   describe(`BaseDriver (as ${className})`, function () {
     let d, w3cCaps;
@@ -183,8 +212,8 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
         throw new Error('multipass');
       }.bind(d);
 
-      afterEach(function () {
-        d.clearNewCommandTimeout();
+      afterEach(async function () {
+        await d.clearNewCommandTimeout();
       });
 
       it('should queue commands and.executeCommand/respond in the order received', async function () {

package/index.d.ts

@@ -1,386 +0,0 @@
-declare class BaseDriver {
-    // class variables
-    static baseVersion: string;
-    static newMethodMap?: MethodMap;
-
-    constructor(opts?: {}, shouldValidateCaps?: boolean);
-
-    // fields
-    sessionId: string;
-    opts: DriverOpts;
-    initialOpts: DriverOpts;
-    caps?: {};
-    originalCaps?: {};
-    helpers: DriverHelpers;
-    basePath: string;
-    relaxedSecurityEnabled: boolean;
-    allowInsecure: string[];
-    denyInsecure: string[];
-    newCommandTimeoutMs: number;
-    implicitWaitMs: number;
-    locatorStrategies: string[];
-    webLocatorStrategies: string[];
-    settings: DeviceSettings;
-    protocol?: string;
-    supportedLogTypes: { [type: string]: LogType };
-
-    // getters/setters
-    get driverData(): {};
-    get isCommandsQueueEnabled(): boolean;
-    get eventHistory(): {};
-    get desiredCapConstraints(): Constraints;
-
-    set desiredCapConstraints(constraints: Constraints);
-
-    // non-command methods
-    onUnexpectedShutdown(handler: () => any): void;
-    logEvent(eventName: string): void;
-    getStatus(): Promise<{}>;
-    sessionExists(sessionId: string): boolean;
-    logExtraCaps(caps: {}): void;
-    validateDesiredCaps(caps: {}): boolean;
-    isFeatureEnabled(name: string): boolean;
-    ensureFeatureEnabled(name: string): void;
-    executeCommand(cmd: string, ...args: any[]): Promise<any>;
-    startUnexpectedShutdown(err?: Error): Promise<void>;
-    validateLocatorStrategy(strategy: string, webContext?: boolean): void;
-    proxyActive(): boolean;
-    getProxyAvoidList(): [string, RegExp][];
-    canProxy(): boolean;
-    proxyRouteIsAvoided(sessionId: string, method: string, url: string): boolean;
-    addManagedDriver(driver: BaseDriver): void;
-    getManagedDrivers(): BaseDriver[];
-    clearNewCommandTimeout(): Promise<void>;
-    startNewCommandTimeout(): Promise<void>;
-    implicitWaitForCondition(condition: () => Promise<any>): Promise<unknown>;
-
-    // Commands
-    findElOrEls(strategy: string, selector: string, mult: boolean, context: string): Promise<Element | Element[]>;
-    newCommandTimeout(ms: number): Promise<void>;
-    getLogTypes(): Promise<string[]>;
-    getLog(logType: string): Promise<{}[]>;
-
-    // WebDriver
-    createSession(jwpCaps: {}, jwpReqCaps: {}, w3cCaps: {}): Promise<[string, {}]>;
-    deleteSession(): Promise<void>;
-    getSessions(): Promise<{ id: string; capabilities: {} }[]>;
-    getSession(): Promise<{}>;
-    getTimeouts(): Promise<Record<string, number>>;
-    timeouts(type: string, ms: number, script: number, pageLoad: number, implicit: number): Promise<void>;
-    setUrl?(url: string): Promise<void>;
-    getUrl?(): Promise<string>;
-    back?(): Promise<void>;
-    forward?(): Promise<void>;
-    refresh?(): Promise<void>;
-    title?(): Promise<string>;
-    getWindowHandle?(): Promise<string>;
-    closeWindow?(): Promise<string[]>;
-    setWindow?(handle: string): Promise<void>;
-    getWindowHandles?(): Promise<string[]>;
-    setFrame?(id: null | number | string): Promise<void>;
-    getWindowRect?(): Promise<Rect>;
-    setWindowRect?(x: number, y: number, width: number, height: number): Promise<Rect>;
-    maximizeWindow?(): Promise<Rect>;
-    minimizeWindow?(): Promise<Rect>;
-    fullScreenWindow?(): Promise<Rect>;
-    active?(): Promise<Element>;
-    findElement(strategy: string, selector: string): Promise<Element>;
-    findElements(strategy: string, selector: string): Promise<Element[]>;
-    findElementFromElement(strategy: string, selector: string, elementId: string): Promise<Element>;
-    findElementsFromElement(strategy: string, selector: string, elementId: string): Promise<Element[]>;
-    elementSelected?(elementId: string): Promise<boolean>;
-    getAttribute?(name: string, elementId: string): Promise<string | null>;
-    getProperty?(name: string, elementId: string): Promise<string | null>;
-    getCssProperty?(name: string, elementId: string): Promise<string>;
-    getText?(elementId: string): Promise<string>;
-    getName?(elementId: string): Promise<string>;
-    getElementRect?(elementId: string): Promise<Rect>;
-    elementEnabled?(elementId: string): Promise<boolean>;
-    elementDisplayed?(elementId: string): Promise<boolean>;
-    click?(elementId: string): Promise<void>;
-    clear?(elementId: string): Promise<void>;
-    setValue?(text: string, elementId: string): Promise<void>;
-    getPageSource?(): Promise<string>;
-    execute?(script: string, args: unknown[]): Promise<unknown>;
-    executeAsync?(script: string, args: unknown[]): Promise<unknown>;
-    getCookies?(): Promise<Cookie[]>;
-    getCookie?(name: string): Promise<Cookie>;
-    setCookie?(cookie: Cookie): Promise<void>;
-    deleteCookie?(name: string): Promise<void>;
-    deleteCookies?(): Promise<void>;
-    performActions?(actions: Actions[]): Promise<void>;
-    releaseActions?(): Promise<void>;
-    postDismissAlert?(): Promise<void>;
-    postAcceptAlert?(): Promise<void>;
-    getAlertText?(): Promise<string | null>;
-    setAlertText?(text: string): Promise<void>;
-    getScreenshot?(): Promise<string>;
-    getElementScreenshot?(elementId: string): Promise<string>;
-
-    // Appium W3C WebDriver Extension
-    mobileShake?(): Promise<void>;
-    getDeviceTime?(format?: string): Promise<string>;
-    lock?(seconds?: number): Promise<void>;
-    unlock?(): Promise<void>;
-    isLocked?(): Promise<boolean>;
-    startRecordingScreen?(options?: ScreenRecordOptions): Promise<void>;
-    stopRecordingScreen?(options?: ScreenRecordOptions): Promise<string>;
-    getPerformanceDataTypes?(): Promise<string[]>;
-    getPerformanceData?(packageName: string, dataType: string, dataReadTimeout?: number): Promise<string[]>;
-    pressKeyCode?(keycode: number, metastate?: number, flags?: number): Promise<void>;
-    longPressKeyCode?(keycode: number, metastate?: number, flags?: number): Promise<void>;
-    fingerprint?(fingerprintId: number): Promise<void>;
-    sendSMS?(phoneNumber: string, message: string): Promise<void>;
-    gsmCall?(phoneNumber: string, action: string): Promise<void>;
-    gsmSignal?(signalStrength: string): Promise<void>;
-    gsmVoice?(state: string): Promise<void>;
-    powerCapacity?(percent: number): Promise<void>;
-    powerAC?(state: string): Promise<void>;
-    networkSpeed?(netspeed: string): Promise<void>;
-    keyevent?(keycode: string, metastate?: string): Promise<void>;
-    mobileRotation?(x: number, y: number, radius: number, rotation: number, touchCount: number, duration: string, elementId?: string): Promise<void>;
-    getCurrentActivity?(): Promise<string>;
-    getCurrentPackage?(): Promise<string>;
-    installApp?(appPath: string, options?: unknown): Promise<void>;
-    activateApp?(appId: string, options?: unknown): Promise<void>;
-    removeApp?(appId: string, options?: unknown): Promise<void>;
-    terminateApp?(appId: string, options?: unknown): Promise<void>;
-    isAppInstalled?(appId: string): Promise<boolean>;
-    queryAppState?(appId: string): Promise<number>;
-    hideKeyboard?(strategy?: string, key?: string, keyCode?: string, keyName?: string): Promise<void>;
-    isKeyboardShown?(): Promise<boolean>;
-    pushFile?(path: string, data: string): Promise<void>;
-    pullFile?(path: string): Promise<string>;
-    pullFolder?(path: string): Promise<string>;
-    toggleFlightMode?(): Promise<void>;
-    toggleData?(): Promise<void>;
-    toggleWiFi?(): Promise<void>;
-    toggleLocationServices?(): Promise<void>;
-    openNotifications?(): Promise<void>;
-    startActivity?(appPackage: string, appActivity: string, appWaitPackage?: string, appWaitActivity?: string, intentAction?: string, intentCategory?: string, intentFlags?: string, optionalIntentArguments?: string, dontStopAppOnReset?: boolean): Promise<void>;
-    getSystemBars?(): Promise<unknown[]>;
-    getDisplayDensity?(): Promise<number>;
-    touchId?(match: boolean): Promise<void>;
-    toggleEnrollTouchId?(enabled: boolean): Promise<void>;
-    launchApp?(): Promise<void>;
-    closeApp?(): Promise<void>;
-    reset(): Promise<void>;
-    background?(seconds: null | number): Promise<void>;
-    endCoverage?(intent: string, path: string): Promise<void>;
-    getStrings?(language?: string, stringFile?: string): Promise<Record<string, unknown>>;
-    setValueImmediate?(value: string, elementId: string): Promise<void>;
-    replaceValue?(value: string, elementId: string): Promise<void>;
-    updateSettings(newSettings: Record<string, unknown>): Promise<void>;
-    getSettings(): Promise<Record<string, unknown>>;
-    receiveAsyncResponse?(response: unknown): Promise<void>;
-    getLogEvents(type?: string | string[]): {};
-    logCustomEvent(vendor: string, event: string): void;
-    setClipboard?(content: string, contentType?: string, label?: string): Promise<void>;
-    getClipboard?(contentType?: string): Promise<string>;
-
-    // JSONWP
-    asyncScriptTimeout?(ms: number): Promise<void>;
-    implicitWait(ms: number): Promise<void>;
-    getWindowSize?(): Promise<Size>;
-    getLocation?(elementId: string): Promise<Position>;
-    getLocationInView?(elementId: string): Promise<Position>;
-    getSize?(elementId: string): Promise<Size>;
-    equalsElement?(elementId: string, otherElementId: string): Promise<boolean>;
-    submit?(elementId: string): Promise<void>;
-    keys?(value: string[]): Promise<void>;
-    availableIMEEngines?(): Promise<string[]>;
-    getActiveIMEEngine?(): Promise<string>;
-    isIMEActivated?(): Promise<boolean>;
-    deactivateIMEEngine?(): Promise<void>;
-    activateIMEEngine?(engine: string): Promise<void>;
-    getOrientation?(): Promise<string>;
-    setOrientation?(orientation: string): Promise<void>;
-    moveTo?(element?: null | string, xOffset?: number, yOffset?: number): Promise<void>;
-    buttonDown?(button?: number): Promise<void>;
-    buttonUp?(button?: number): Promise<void>;
-    clickCurrent?(button?: number): Promise<void>;
-    doubleClick?(): Promise<void>;
-    touchDown?(x: number, y: number): Promise<void>;
-    touchUp?(x: number, y: number): Promise<void>;
-    touchMove?(x: number, y: number): Promise<void>;
-    touchLongClick?(elementId: string): Promise<void>;
-    flick?(element?: string, xSpeed?: number, ySpeed?: number, xOffset?: number, yOffset?: number, speed?: number): Promise<void>;
-    getGeoLocation?(): Promise<Location>;
-    setGeoLocation?(location: Partial<Location>): Promise<void>;
-
-    // MJSONWIRE
-    getCurrentContext?(): Promise<string | null>;
-    setContext?(name: string): Promise<void>;
-    getContexts?(): Promise<string[]>;
-    getPageIndex?(elementId: string): Promise<string>;
-    getNetworkConnection?(): Promise<number>;
-    setNetworkConnection?(type: number): Promise<void>;
-    performTouch?(actions: unknown): Promise<void>;
-    performMultiAction?(actions: unknown, elementId: string): Promise<void>;
-    getRotation?(): Promise<Rotation>;
-    setRotation?(x: number, y: number, z: number): Promise<void>;
-
-    // Chromium DevTools
-    executeCdp?(cmd: string, params: unknown): Promise<unknown>;
-
-    // Web Authentication
-    addVirtualAuthenticator?(protocol: string, transport: string, hasResidentKey?: boolean, hasUserVerification?: boolean, isUserConsenting?: boolean, isUserVerified?: boolean): Promise<void>;
-    removeVirtualAuthenticator?(): Promise<void>;
-    addAuthCredential?(credentialId: string, isResidentCredential: boolean, rpId: string, privateKey: string, userHandle?: string, signCount?: number): Promise<void>;
-    getAuthCredential?(): Promise<Credential[]>;
-    removeAllAuthCredentials?(): Promise<void>;
-    removeAuthCredential?(): Promise<void>;
-    setUserAuthVerified?(isUserVerified: boolean): Promise<void>;
-}
-
-declare type MethodMap = {
-    [path: string]: {
-        [method: string]: {
-            command?: string;
-            neverProxy?: boolean;
-            payloadParams?: {
-                wrap?: string;
-                unwrap?: string;
-                required?: string[] | string[][];
-                optional?: string[] | string[][];
-                validate?: (obj: any, protocol: string) => any;
-                makeArgs?: (obj: any) => any;
-            };
-        };
-    };
-};
-
-declare type Constraints = {
-    [key: string]: {
-        presence?: boolean;
-        isString?: boolean;
-        isNumber?: boolean;
-        isBoolean?: boolean;
-        isObject?: boolean;
-        isArray?: boolean;
-        deprecated?: boolean;
-        inclusion?: any[];
-    };
-};
-
-declare type DriverOpts = {
-    tmpDir: string;
-    [key: string]: any;
-};
-
-declare type Element = {
-    'element-6066-11e4-a52e-4f735466cecf': string;
-};
-
-declare interface DriverHelpers {
-    configureApp: (app: string, supportedAppExtensions: string[]) => Promise<string>;
-    isPackageOrBundle: (app: string) => boolean;
-    duplicateKeys: <T>(input: T, firstKey: string, secondKey: string) => T;
-    parseCapsArray: (cap: string | string[]) => string[];
-}
-
-declare type SettingsUpdater = (
-  prop: string,
-  newValue: {},
-  curValue: {},
-) => Promise<void>;
-
-declare class DeviceSettings {
-    constructor(defaultSettings: {}, onSettingsUpdate: SettingsUpdater);
-    update(newSettings: {}): Promise<void>;
-    getSettings(): Record<string, unknown>;;
-}
-
-declare type LogType = {
-    description: string;
-    getter: (driver: BaseDriver) => Promise<{}[]>;
-};
-
-// WebDriver
-
-declare type Rect = {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-};
-
-declare type Cookie = {
-    name: string;
-    value: string;
-    path?: string;
-    domain?: string;
-    secure?: boolean;
-    httpOnly?: boolean;
-    expiry?: number;
-    sameSite?: 'Lax' | 'Strict';
-};
-
-declare type Actions = {
-    type?: string;
-    actions: Action[];
-    parameters?: {
-        pointerType?: string;
-    };
-};
-
-declare type Action = {
-    duration?: number;
-    type: string;
-    value?: string;
-    x?: number;
-    y?: number;
-    button?: number;
-    origin?: string;
-};
-
-// Appium W3C WebDriver Extension
-
-declare type ScreenRecordOptions = {
-    remotePath?: string;
-    username?: string;
-    password?: string;
-    method?: string;
-    forceRestart?: boolean;
-    timeLimit?: string;
-    videoType?: string;
-    videoQuality?: string;
-    videoFps?: string;
-    videoScale?: string;
-    bitRate?: string;
-    videoSize?: string;
-    bugReport?: string;
-};
-
-// JSONWP
-
-declare type Size = Pick<Rect, 'width' | 'height'>;
-
-declare type Position = Pick<Rect, 'x' | 'y'>;
-
-declare type Location = {
-    latitude: number;
-    longitude: number;
-    altitude: number;
-};
-
-declare type Rotation = {
-    x: number;
-    y: number;
-    z: number;
-};
-
-// Web Authentication
-
-declare type Credential = {
-    credentialId: string;
-    isResidentCredential: boolean;
-    rpId: string;
-    privateKey: string;
-    userHandle?: string;
-    signCount: number;
-    largeBlob?: string;
-};
-
-export { BaseDriver, DriverHelpers, DriverOpts, Element, LogType, MethodMap, Constraints, SettingsUpdater, DeviceSettings, Rect, Cookie, Actions, Action, ScreenRecordOptions, Size, Position, Location, Rotation, Credential };
-export default BaseDriver;