@appium/base-driver 8.5.3 → 8.5.4

package/lib/protocol/validators.js

@@ -1,10 +1,10 @@
 import _ from 'lodash';
 
-function isNumber (o) {
+function isNumber(o) {
   return _.isNumber(o) || !_.isNaN(parseInt(o, 10)) || !_.isNaN(parseFloat(o));
 }
 
-function msValidator (ms) {
+function msValidator(ms) {
   if (!_.isNumber(ms) || ms < 0) {
     throw new Error('Wait ms must be a number equal to 0 or greater');
   }
@@ -24,7 +24,7 @@ const validators = {
     msValidator(ms);
   },
   clickCurrent: (button) => {
-    if (!(isNumber(button) || _.isUndefined(button)) || (button < 0 || button > 2)) {
+    if (!(isNumber(button) || _.isUndefined(button)) || button < 0 || button > 2) {
       throw new Error('Click button must be 0, 1, or 2');
     }
   },
@@ -32,7 +32,7 @@ const validators = {
     if (!isNumber(type) || [0, 1, 2, 4, 6].indexOf(type) === -1) {
       throw new Error('Network type must be one of 0, 1, 2, 4, 6');
     }
-  }
+  },
 };
 
-export { validators };
+export {validators};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/base-driver",
-  "version": "8.5.3",
+  "version": "8.5.4",
   "description": "Base driver class for Appium drivers",
   "keywords": [
     "automation",
@@ -43,13 +43,14 @@
     "dev": "run-p \"build:distfiles -- --watch\" \"build:test -- --watch\"",
     "fix": "npm run lint -- --fix",
     "lint": "eslint -c ../../.eslintrc --ignore-path ../../.eslintignore .",
+    "prepare": "npm run build",
     "test": "npm run test:unit",
     "test:e2e": "mocha --timeout 20s --slow 10s \"./test/e2e/**/*.spec.js\"",
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/support": "^2.58.0",
-    "@babel/runtime": "7.17.9",
+    "@appium/support": "^2.59.0",
+    "@babel/runtime": "7.18.3",
     "@colors/colors": "1.5.0",
     "async-lock": "1.3.1",
     "asyncbox": "2.9.2",
@@ -60,7 +61,7 @@
     "express": "4.18.1",
     "http-status-codes": "2.2.0",
     "lodash": "4.17.21",
-    "lru-cache": "7.8.1",
+    "lru-cache": "7.10.1",
     "method-override": "3.0.0",
     "morgan": "1.10.0",
     "serve-favicon": "2.5.0",
@@ -68,12 +69,12 @@
     "validate.js": "0.13.1"
   },
   "engines": {
-    "node": ">=12",
+    "node": ">=14",
     "npm": ">=6"
   },
   "publishConfig": {
     "access": "public"
   },
   "types": "./build/lib/index.d.ts",
-  "gitHead": "5482c921bc187ed8807922c00bd2355585f4971a"
+  "gitHead": "5c7af8ee73078018e4ec52fccf19fe3f77249d72"
 }

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

@@ -1,12 +1,12 @@
 import _ from 'lodash';
-import { BaseDriver, server, routeConfiguringFunction, DeviceSettings } from '../../lib';
+import {BaseDriver, server, routeConfiguringFunction, DeviceSettings} from '../../lib';
 import axios from 'axios';
 import B from 'bluebird';
-import { TEST_HOST, getTestPort, createAppiumURL, METHODS } from '../helpers';
-import { PREFIXED_APPIUM_OPTS_CAP } from '../../lib/basedriver/capabilities';
+import {TEST_HOST, getTestPort, createAppiumURL, METHODS} from '../helpers';
+import {PREFIXED_APPIUM_OPTS_CAP} from '../../lib/basedriver/capabilities';
 const {POST, DELETE} = METHODS;
 
-function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
+function baseDriverE2ETests(DriverClass, defaultCaps = {}) {
   let address = defaultCaps['appium:address'] ?? TEST_HOST;
   let port = defaultCaps['appium:port'];
   const className = DriverClass.name || '(unknown driver)';
@@ -14,9 +14,9 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
   describe(`BaseDriver E2E (as ${className})`, function () {
     let baseServer, d;
     /**
-       * This URL creates a new session
-       * @type {string}
-       **/
+     * This URL creates a new session
+     * @type {string}
+     **/
     let newSessionURL;
 
     /**
@@ -33,13 +33,13 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
     let createSessionURL;
 
     before(async function () {
-      port = port ?? await getTestPort();
+      port = port ?? (await getTestPort());
       defaultCaps = {...defaultCaps, 'appium:port': port};
       d = new DriverClass({port, address});
       baseServer = await server({
         routeConfiguringFunction: routeConfiguringFunction(d),
         port,
-        hostname: TEST_HOST
+        hostname: TEST_HOST,
       });
       createAppiumTestURL = createAppiumURL(address, port);
       newSessionURL = createAppiumTestURL('', 'session');
@@ -50,26 +50,32 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
       await baseServer.close();
     });
 
-    async function startSession (caps) {
-      return (await axios({
-        url: newSessionURL,
-        method: POST,
-        data: {capabilities: {alwaysMatch: caps, firstMatch: [{}]}},
-      })).data.value;
+    async function startSession(caps) {
+      return (
+        await axios({
+          url: newSessionURL,
+          method: POST,
+          data: {capabilities: {alwaysMatch: caps, firstMatch: [{}]}},
+        })
+      ).data.value;
     }
 
-    async function endSession (id) {
-      return (await axios({
-        url: createSessionURL(id),
-        method: DELETE,
-        validateStatus: null,
-      })).data.value;
+    async function endSession(id) {
+      return (
+        await axios({
+          url: createSessionURL(id),
+          method: DELETE,
+          validateStatus: null,
+        })
+      ).data.value;
     }
 
-    async function getSession (id) {
-      return (await axios({
-        url: createSessionURL(id),
-      })).data.value;
+    async function getSession(id) {
+      return (
+        await axios({
+          url: createSessionURL(id),
+        })
+      ).data.value;
     }
 
     describe('session handling', function () {
@@ -77,16 +83,20 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
         const sessionIds = [];
         let times = 0;
         do {
-          const {sessionId} = (await axios({
-            url: newSessionURL,
-            headers: {
-              'X-Idempotency-Key': '123456',
-            },
-            method: POST,
-            data: {capabilities: {alwaysMatch: defaultCaps, firstMatch: [{}]}},
-            simple: false,
-            resolveWithFullResponse: true
-          })).data.value;
+          const {sessionId} = (
+            await axios({
+              url: newSessionURL,
+              headers: {
+                'X-Idempotency-Key': '123456',
+              },
+              method: POST,
+              data: {
+                capabilities: {alwaysMatch: defaultCaps, firstMatch: [{}]},
+              },
+              simple: false,
+              resolveWithFullResponse: true,
+            })
+          ).data.value;
 
           sessionIds.push(sessionId);
           times++;
@@ -105,14 +115,18 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
         const reqs = [];
         let times = 0;
         do {
-          reqs.push(axios({
-            url: newSessionURL,
-            headers: {
-              'X-Idempotency-Key': '12345',
-            },
-            method: POST,
-            data: {capabilities: {alwaysMatch: defaultCaps, firstMatch: [{}]}},
-          }));
+          reqs.push(
+            axios({
+              url: newSessionURL,
+              headers: {
+                'X-Idempotency-Key': '12345',
+              },
+              method: POST,
+              data: {
+                capabilities: {alwaysMatch: defaultCaps, firstMatch: [{}]},
+              },
+            })
+          );
           times++;
         } while (times < 2);
         const sessionIds = (await B.all(reqs)).map((x) => x.data.value.sessionId);
@@ -149,13 +163,12 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
       });
     });
 
-    it.skip('should throw NYI for commands not implemented', async function () {
-    });
+    it.skip('should throw NYI for commands not implemented', async function () {});
 
     describe('command timeouts', function () {
       let originalFindElement, originalFindElements;
 
-      async function startTimeoutSession (timeout) {
+      async function startTimeoutSession(timeout) {
         const caps = _.cloneDeep(defaultCaps);
         caps['appium:newCommandTimeout'] = timeout;
         return await startSession(caps);
@@ -179,7 +192,6 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
         d.findElements = originalFindElements;
       });
 
-
       it('should set a default commandTimeout', async function () {
         let newSession = await startTimeoutSession();
         d.newCommandTimeoutMs.should.be.above(0);
@@ -210,11 +222,13 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
       it('should not timeout with commandTimeout of false', async function () {
         let newSession = await startTimeoutSession(0.1);
         let start = Date.now();
-        const {value} = (await axios({
-          url: createAppiumTestURL(d.sessionId, 'elements'),
-          method: POST,
-          data: {using: 'name', value: 'foo'},
-        })).data;
+        const {value} = (
+          await axios({
+            url: createAppiumTestURL(d.sessionId, 'elements'),
+            method: POST,
+            data: {using: 'name', value: 'foo'},
+          })
+        ).data;
         (Date.now() - start).should.be.above(150);
         value.should.eql(['foo']);
         await endSession(newSession.sessionId);
@@ -230,9 +244,11 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
           data: {using: 'name', value: 'foo'},
         });
         await B.delay(400);
-        const {value} = (await axios({
-          url: createSessionURL(d.sessionId),
-        })).data;
+        const {value} = (
+          await axios({
+            url: createSessionURL(d.sessionId),
+          })
+        ).data;
         value.platformName.should.equal(defaultCaps.platformName);
         const resp = await endSession(newSession.sessionId);
         should.equal(resp, null);
@@ -251,10 +267,12 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
           data: {using: 'name', value: 'foo'},
         });
         await B.delay(400);
-        const {value} = (await axios({
-          url: sessionURL,
-          validateStatus: null,
-        })).data;
+        const {value} = (
+          await axios({
+            url: sessionURL,
+            validateStatus: null,
+          })
+        ).data;
         value.error.should.equal('invalid session id');
         should.equal(d.sessionId, null);
         const resp = await endSession(newSession.sessionId);
@@ -269,7 +287,6 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
         await endSession(newSession.sessionId);
         should.not.exist(d.noCommandTimer);
       });
-
     });
 
     describe('settings api', function () {
@@ -283,8 +300,7 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
         await d.settings.update({ignoreUnimportantViews: true}).should.not.be.rejected;
       });
       it('should reject for invalid update object', async function () {
-        await d.settings.update('invalid json').should.eventually
-                .be.rejectedWith('JSON');
+        await d.settings.update('invalid json').should.eventually.be.rejectedWith('JSON');
       });
     });
 
@@ -302,7 +318,15 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
           // make sure that the request gets to the server before our shutdown
           await B.delay(100);
           const shutdownEventPromise = new B((resolve, reject) => {
-            setTimeout(() => reject(new Error('onUnexpectedShutdown event is expected to be fired within 5 seconds timeout')), 5000);
+            setTimeout(
+              () =>
+                reject(
+                  new Error(
+                    'onUnexpectedShutdown event is expected to be fired within 5 seconds timeout'
+                  )
+                ),
+              5000
+            );
             d.onUnexpectedShutdown(resolve);
           });
           d.startUnexpectedShutdown(new Error('Crashytimes'));
@@ -323,9 +347,11 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
         await endSession(session.sessionId);
       });
       it('should add start session timings', async function () {
-        const caps = Object.assign({}, defaultCaps, {'appium:eventTimings': true});
+        const caps = Object.assign({}, defaultCaps, {
+          'appium:eventTimings': true,
+        });
         const session = await startSession(caps);
-        const res = (await getSession(session.sessionId));
+        const res = await getSession(session.sessionId);
         should.exist(res.events);
         should.exist(res.events.newSessionRequested);
         should.exist(res.events.newSessionStarted);
@@ -346,7 +372,7 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
             [PREFIXED_APPIUM_OPTS_CAP]: {
               platformVersion: '11.4',
               'appium:deviceName': 'iPhone 11',
-            }
+            },
           });
           d.opts.platformVersion.should.eql('11.4');
           d.opts.deviceName.should.eql('iPhone 11');

package/test/basedriver/driver-tests.js

@@ -1,12 +1,11 @@
 import _ from 'lodash';
 import B from 'bluebird';
-import { DeviceSettings } from '../../lib';
-import { createSandbox } from 'sinon';
-
+import {DeviceSettings} from '../../lib';
+import {createSandbox} from 'sinon';
 
 // wrap these tests in a function so we can export the tests and re-use them
 // for actual driver implementations
-function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
+function baseDriverUnitTests(DriverClass, defaultCaps = {}) {
   // to display the driver under test in report
   const className = DriverClass.name || '(unknown driver)';
 
@@ -19,7 +18,6 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
   });
 
   describe('Log prefix', function () {
-
     it('should setup log prefix', async function () {
       const d = new DriverClass();
       const previousPrefix = d.log.prefix;
@@ -37,7 +35,6 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
         previousPrefix.should.eql(d.log.prefix);
       }
     });
-
   });
 
   describe(`BaseDriver (as ${className})`, function () {
@@ -79,7 +76,9 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
 
     it('should not be able to start two sessions without closing the first', async function () {
       await d.createSession(null, null, _.cloneDeep(w3cCaps));
-      await d.createSession(null, null, _.cloneDeep(w3cCaps)).should.eventually.be.rejectedWith('session');
+      await d
+        .createSession(null, null, _.cloneDeep(w3cCaps))
+        .should.eventually.be.rejectedWith('session');
     });
 
     it('should be able to delete a session', async function () {
@@ -108,11 +107,11 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
 
       sessions.length.should.equal(1);
       sessions[0].should.include({
-        id: d.sessionId
+        id: d.sessionId,
       });
       sessions[0].capabilities.should.include({
         deviceName: 'Commodore 64',
-        platformName: 'Fake'
+        platformName: 'Fake',
       });
     });
 
@@ -125,7 +124,15 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
       let cmdPromise = d.executeCommand('getStatus');
       await B.delay(10);
       const p = new B((resolve, reject) => {
-        setTimeout(() => reject(new Error('onUnexpectedShutdown event is expected to be fired within 5 seconds timeout')), 5000);
+        setTimeout(
+          () =>
+            reject(
+              new Error(
+                'onUnexpectedShutdown event is expected to be fired within 5 seconds timeout'
+              )
+            ),
+          5000
+        );
         d.onUnexpectedShutdown(resolve);
       });
       d.startUnexpectedShutdown(new Error('We crashed'));
@@ -142,7 +149,15 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
       }.bind(d);
       await d.createSession(null, null, w3cCaps);
       const p = new B((resolve, reject) => {
-        setTimeout(() => reject(new Error('onUnexpectedShutdown event is expected to be fired within 5 seconds timeout')), 5000);
+        setTimeout(
+          () =>
+            reject(
+              new Error(
+                'onUnexpectedShutdown event is expected to be fired within 5 seconds timeout'
+              )
+            ),
+          5000
+        );
         d.onUnexpectedShutdown(resolve);
       });
       d.startUnexpectedShutdown(new Error('We crashed'));
@@ -160,7 +175,15 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
 
       await d.createSession(null, null, _.cloneDeep(w3cCaps));
       const p = new B((resolve, reject) => {
-        setTimeout(() => reject(new Error('onUnexpectedShutdown event is expected to be fired within 5 seconds timeout')), 5000);
+        setTimeout(
+          () =>
+            reject(
+              new Error(
+                'onUnexpectedShutdown event is expected to be fired within 5 seconds timeout'
+              )
+            ),
+          5000
+        );
         d.onUnexpectedShutdown(resolve);
       });
       d.startUnexpectedShutdown(new Error('We crashed'));
@@ -188,7 +211,10 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
 
     describe('protocol detection', function () {
       it('should use W3C if only W3C caps are provided', async function () {
-        await d.createSession(null, null, {alwaysMatch: _.clone(defaultCaps), firstMatch: [{}]});
+        await d.createSession(null, null, {
+          alwaysMatch: _.clone(defaultCaps),
+          firstMatch: [{}],
+        });
         d.protocol.should.equal('W3C');
       });
     });
@@ -328,11 +354,12 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
             platformName: 'Fake',
             'appium:deviceName': 'Commodore 64',
             'appium:fullReset': true,
-            'appium:noReset': true
+            'appium:noReset': true,
           }),
         };
-        await d.createSession(null, null, newCaps).should.eventually.be.rejectedWith(
-            /noReset.+fullReset/);
+        await d
+          .createSession(null, null, newCaps)
+          .should.eventually.be.rejectedWith(/noReset.+fullReset/);
       });
     });
 
@@ -349,7 +376,9 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
           d.proxyActive(sessId).should.be.false;
         });
         it('should throw an error when sessionId is wrong', function () {
-          (() => { d.proxyActive('aaa'); }).should.throw;
+          (() => {
+            d.proxyActive('aaa');
+          }).should.throw;
         });
       });
 
@@ -361,7 +390,9 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
           d.getProxyAvoidList(sessId).should.be.an.instanceof(Array);
         });
         it('should throw an error when sessionId is wrong', function () {
-          (() => { d.getProxyAvoidList('aaa'); }).should.throw;
+          (() => {
+            d.getProxyAvoidList('aaa');
+          }).should.throw;
         });
       });
 
@@ -373,7 +404,9 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
           d.canProxy(sessId).should.be.a('boolean');
         });
         it('should throw an error when sessionId is wrong', function () {
-          (() => { d.canProxy(); }).should.throw;
+          (() => {
+            d.canProxy();
+          }).should.throw;
         });
       });
 
@@ -381,21 +414,38 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
         it('should validate form of avoidance list', function () {
           const avoidStub = sandbox.stub(d, 'getProxyAvoidList');
           avoidStub.returns([['POST', /\/foo/], ['GET']]);
-          (() => { d.proxyRouteIsAvoided(); }).should.throw;
-          avoidStub.returns([['POST', /\/foo/], ['GET', /^foo/, 'bar']]);
-          (() => { d.proxyRouteIsAvoided(); }).should.throw;
+          (() => {
+            d.proxyRouteIsAvoided();
+          }).should.throw;
+          avoidStub.returns([
+            ['POST', /\/foo/],
+            ['GET', /^foo/, 'bar'],
+          ]);
+          (() => {
+            d.proxyRouteIsAvoided();
+          }).should.throw;
           avoidStub.restore();
         });
         it('should reject bad http methods', function () {
           const avoidStub = sandbox.stub(d, 'getProxyAvoidList');
-          avoidStub.returns([['POST', /^foo/], ['BAZETE', /^bar/]]);
-          (() => { d.proxyRouteIsAvoided(); }).should.throw;
+          avoidStub.returns([
+            ['POST', /^foo/],
+            ['BAZETE', /^bar/],
+          ]);
+          (() => {
+            d.proxyRouteIsAvoided();
+          }).should.throw;
           avoidStub.restore();
         });
         it('should reject non-regex routes', function () {
           const avoidStub = sandbox.stub(d, 'getProxyAvoidList');
-          avoidStub.returns([['POST', /^foo/], ['GET', '/bar']]);
-          (() => { d.proxyRouteIsAvoided(); }).should.throw;
+          avoidStub.returns([
+            ['POST', /^foo/],
+            ['GET', '/bar'],
+          ]);
+          (() => {
+            d.proxyRouteIsAvoided();
+          }).should.throw;
           avoidStub.restore();
         });
         it('should return true for routes in the avoid list', function () {
@@ -425,7 +475,10 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
       beforeEach(async function () {
         beforeStartTime = Date.now();
         d.shouldValidateCaps = false;
-        await d.executeCommand('createSession', null, null, {alwaysMatch: {...defaultCaps}, firstMatch: [{}]});
+        await d.executeCommand('createSession', null, null, {
+          alwaysMatch: {...defaultCaps},
+          firstMatch: [{}],
+        });
       });
       describe('#eventHistory', function () {
         it('should have an eventHistory property', function () {
@@ -492,12 +545,16 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
     describe('.reset', function () {
       it('should reset as W3C if the original session was W3C', async function () {
         const caps = {
-          alwaysMatch: Object.assign({}, {
-            'appium:app': 'Fake',
-            'appium:deviceName': 'Fake',
-            'appium:automationName': 'Fake',
-            platformName: 'Fake',
-          }, defaultCaps),
+          alwaysMatch: Object.assign(
+            {},
+            {
+              'appium:app': 'Fake',
+              'appium:deviceName': 'Fake',
+              'appium:automationName': 'Fake',
+              platformName: 'Fake',
+            },
+            defaultCaps
+          ),
           firstMatch: [{}],
         };
         await d.createSession(undefined, undefined, caps);

package/test/basedriver/index.js

@@ -3,4 +3,4 @@
 import baseDriverUnitTests from './driver-tests';
 import baseDriverE2ETests from './driver-e2e-tests';
 
-export { baseDriverUnitTests, baseDriverE2ETests };
+export {baseDriverUnitTests, baseDriverE2ETests};