@appium/base-driver 8.3.0 → 8.4.1

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.0",
+  "version": "8.4.1",
   "description": "Base driver class for Appium drivers",
   "keywords": [
     "automation",
@@ -32,36 +32,43 @@
     "lib",
     "static",
     "test/basedriver",
-    "!test/basedriver/fixtures",
+    "!test/e2e/fixtures",
     "build",
-    "!build/test/basedriver/fixtures"
+    "!build/test/e2e/fixtures"
   ],
   "scripts": {
-    "dev": "gulp dev --no-notif",
-    "build": "gulp transpile",
-    "test": "gulp unit-test:run",
-    "test:e2e": "gulp e2e-test:run"
+    "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": "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",
+    "test:e2e": "mocha --require ../../test/setup-babel.js --timeout 20s --slow 10s \"./test/e2e/**/*.spec.js\"",
+    "test:unit": "mocha --require ../../test/setup-babel.js \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/support": "^2.56.0",
-    "@babel/runtime": "7.17.8",
+    "@appium/support": "file:../support",
+    "@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",
@@ -70,5 +77,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f5cce0f29d31699decea63ed94c4506f7af469df"
+  "types": "./build/lib/index.d.ts",
+  "gitHead": "ec6a90a797d2dadb407922426be16efaec9def07"
 }

package/test/basedriver/README.md

@@ -0,0 +1,5 @@
+# Driver Test Helpers
+
+This directory contains modules which expose test suites that an external driver can use to test against the base implementation.  They are published in the `@appium/base-driver` package.
+
+Drivers wanting to leverage these suites will want to add `@appium/base-driver` to their `devDependencies`.

package/test/basedriver/driver-e2e-tests.js

@@ -2,7 +2,7 @@ import _ from 'lodash';
 import { BaseDriver, server, routeConfiguringFunction, DeviceSettings } from '../../lib';
 import axios from 'axios';
 import B from 'bluebird';
-import {TEST_HOST, getTestPort, createAppiumURL, METHODS} from '../helpers';
+import { TEST_HOST, getTestPort, createAppiumURL, METHODS } from '../helpers';
 import { PREFIXED_APPIUM_OPTS_CAP } from '../../lib/basedriver/capabilities';
 const {POST, DELETE} = METHODS;
 

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 () {