@appium/base-driver 8.1.1 → 8.2.2

package/lib/protocol/protocol.js

@@ -239,9 +239,17 @@ function buildHandler (app, method, path, spec, driver, isSessCmd) {
       // this command should never be proxied (which is useful for plugin developers who add
       // commands and generally would not want that command to be proxied instead of handled by the
       // plugin)
+      let didPluginOverrideProxy = false;
       if (isSessCmd && !spec.neverProxy && driverShouldDoJwpProxy(driver, req, spec.command)) {
-        await doJwpProxy(driver, req, res);
-        return;
+        if (!driver.pluginsToHandleCmd ||
+            driver.pluginsToHandleCmd(spec.command, req.params.sessionId).length === 0) {
+          await doJwpProxy(driver, req, res);
+          return;
+        }
+        SESSIONS_CACHE.getLogger(req.params.sessionId, currentProtocol).debug(`Would have proxied ` +
+          `command directly, but a plugin exists which might require its value, so will let ` +
+          `its value be collected internally and made part of plugin chain`);
+        didPluginOverrideProxy = true;
       }
 
       // if a command is not in our method map, it's because we
@@ -283,12 +291,15 @@ function buildHandler (app, method, path, spec, driver, isSessCmd) {
         `${driver.constructor.name}.${spec.command}() with args: ` +
         _.truncate(JSON.stringify(args), {length: MAX_LOG_BODY_LENGTH}));
 
-      if (driver.executeCommand) {
-        driverRes = await driver.executeCommand(spec.command, ...args);
-      } else {
-        driverRes = await driver.execute(spec.command, ...args);
+      if (didPluginOverrideProxy) {
+        // TODO for now we add this information on the args list, but that's mixing purposes here.
+        // We really should add another 'options' parameter to 'executeCommand', but this would be
+        // a breaking change for all drivers so would need to be handled carefully.
+        args.push({reqForProxy: req});
       }
 
+      driverRes = await driver.executeCommand(spec.command, ...args);
+
       // Get the protocol after executeCommand
       currentProtocol = extractProtocol(driver, req.params.sessionId) || currentProtocol;
 
@@ -458,5 +469,5 @@ async function doJwpProxy (driver, req, res) {
 
 export {
   Protocol, routeConfiguringFunction, isSessionCommand,
-  driverShouldDoJwpProxy, determineProtocol
+  driverShouldDoJwpProxy, determineProtocol, CREATE_SESSION_COMMAND, DELETE_SESSION_COMMAND,
 };

package/lib/protocol/routes.js

@@ -575,9 +575,6 @@ const METHOD_MAP = {
   '/session/:sessionId/appium/receive_async_response': {
     POST: {command: 'receiveAsyncResponse', payloadParams: {required: ['response']}}
   },
-  '/session/:sessionId/appium/execute_driver': {
-    POST: {command: 'executeDriverScript', payloadParams: {required: ['script'], optional: ['type', 'timeout']}}
-  },
   '/session/:sessionId/appium/events': {
     POST: {command: 'getLogEvents', payloadParams: {optional: ['type']}}
   },
@@ -614,7 +611,7 @@ const METHOD_MAP = {
   },
   '/session/:sessionId/window/rect': {
     GET: {command: 'getWindowRect'},
-    POST: {command: 'setWindowRect'},
+    POST: {command: 'setWindowRect', payloadParams: {required: ['x', 'y', 'width', 'height']}},
   },
   '/session/:sessionId/window/maximize': {
     POST: {command: 'maximizeWindow'}

package/package.json

@@ -11,7 +11,7 @@
     "firefoxos",
     "testing"
   ],
-  "version": "8.1.1",
+  "version": "8.2.2",
   "author": "https://github.com/appium",
   "license": "Apache-2.0",
   "repository": {
@@ -25,7 +25,6 @@
     "node": ">=12",
     "npm": ">=6"
   },
-  "main": "./build/index.js",
   "directories": {
     "lib": "lib"
   },
@@ -36,17 +35,15 @@
     "static",
     "test/basedriver",
     "!test/basedriver/fixtures",
-    "build/index.js",
-    "build/lib",
-    "build/test/basedriver",
+    "build",
     "!build/test/basedriver/fixtures"
   ],
   "dependencies": {
-    "@appium/support": "^2.54.2",
-    "@babel/runtime": "7.15.4",
+    "@appium/support": "^2.55.2",
+    "@babel/runtime": "7.16.3",
     "async-lock": "1.3.0",
-    "asyncbox": "2.9.1",
-    "axios": "0.21.4",
+    "asyncbox": "2.9.2",
+    "axios": "0.24.0",
     "bluebird": "3.7.2",
     "body-parser": "1.19.0",
     "colors": "1.4.0",
@@ -58,18 +55,13 @@
     "method-override": "3.0.0",
     "morgan": "1.10.0",
     "serve-favicon": "2.5.0",
-    "source-map-support": "0.5.20",
+    "source-map-support": "0.5.21",
     "validate.js": "0.13.1",
-    "webdriverio": "6.12.1",
     "ws": "7.5.5"
   },
-  "devDependencies": {
-    "@appium/eslint-config-appium": "^4.7.2",
-    "@appium/gulp-plugins": "^5.5.3"
-  },
   "publishConfig": {
     "access": "public"
   },
   "homepage": "https://appium.io",
-  "gitHead": "01dd42ee1778509664d422a0c26e7061bae8402e"
+  "gitHead": "280d409df6c02d36b4ffc4d02a95ab3f4649b08c"
 }

package/test/basedriver/capability-specs.js

@@ -1,4 +1,4 @@
-import { default as BaseDriver, errors } from '../..';
+import { default as BaseDriver, errors } from '../../lib';
 import logger from '../../lib/basedriver/logger';
 import sinon from 'sinon';
 

package/test/basedriver/commands/event-specs.js

@@ -1,5 +1,5 @@
 import _ from 'lodash';
-import { BaseDriver } from '../../..';
+import { BaseDriver } from '../../../lib';
 
 
 

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

@@ -1,6 +1,6 @@
 // transpile:mocha
 
-import BaseDriver from '../..';
+import BaseDriver from '../../lib';
 import baseDriverE2ETests from './driver-e2e-tests';
 baseDriverE2ETests(BaseDriver, {
   platformName: 'iOS',

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

@@ -1,52 +1,74 @@
 import _ from 'lodash';
-import { BaseDriver, server, routeConfiguringFunction, DeviceSettings, errors } from '../..';
-import {
-  MJSONWP_ELEMENT_KEY, W3C_ELEMENT_KEY
-} from '../../lib/constants';
+import { BaseDriver, server, routeConfiguringFunction, DeviceSettings } from '../../lib';
 import axios from 'axios';
 import B from 'bluebird';
-import getPort from 'get-port';
+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 = {}) {
-  let address = defaultCaps['appium:address'] ?? '127.0.0.1';
+  let address = defaultCaps['appium:address'] ?? TEST_HOST;
   let port = defaultCaps['appium:port'];
   const className = DriverClass.name || '(unknown driver)';
 
   describe(`BaseDriver E2E (as ${className})`, function () {
     let baseServer, d;
+    /**
+       * This URL creates a new session
+       * @type {string}
+       **/
+    let newSessionURL;
+
+    /**
+     * Creates a URL with base host/port. Supply `session` and `pathname`
+     * @type {_.CurriedFunction2<string,string,string>}
+     */
+    let createAppiumTestURL;
+
+    /**
+     * Creates a URL with the given session ID and a blank pathname;
+     * e.g., `http://foo.bar:123/session/<session-id>`
+     *  @type {_.CurriedFunction1<string,string>}
+     */
+    let createSessionURL;
+
     before(async function () {
-      port = port ?? await getPort();
+      port = port ?? await getTestPort();
       defaultCaps = {...defaultCaps, 'appium:port': port};
       d = new DriverClass({port, address});
       baseServer = await server({
         routeConfiguringFunction: routeConfiguringFunction(d),
-        port
+        port,
+        hostname: TEST_HOST
       });
+      createAppiumTestURL = createAppiumURL(address, port);
+      newSessionURL = createAppiumTestURL('', 'session');
+      createSessionURL = createAppiumTestURL(_, '');
     });
+
     after(async function () {
       await baseServer.close();
     });
 
     async function startSession (caps) {
       return (await axios({
-        url: `http://${address}:${port}/session`,
-        method: 'POST',
+        url: newSessionURL,
+        method: POST,
         data: {capabilities: {alwaysMatch: caps, firstMatch: [{}]}},
       })).data.value;
     }
 
     async function endSession (id) {
       return (await axios({
-        url: `http://${address}:${port}/session/${id}`,
-        method: 'DELETE',
+        url: createSessionURL(id),
+        method: DELETE,
         validateStatus: null,
       })).data.value;
     }
 
     async function getSession (id) {
       return (await axios({
-        url: `http://${address}:${port}/session/${id}`,
+        url: createSessionURL(id),
       })).data.value;
     }
 
@@ -56,11 +78,11 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
         let times = 0;
         do {
           const {sessionId} = (await axios({
-            url: `http://${address}:${port}/session`,
+            url: newSessionURL,
             headers: {
               'X-Idempotency-Key': '123456',
             },
-            method: 'POST',
+            method: POST,
             data: {capabilities: {alwaysMatch: defaultCaps, firstMatch: [{}]}},
             simple: false,
             resolveWithFullResponse: true
@@ -72,8 +94,8 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
         _.uniq(sessionIds).length.should.equal(1);
 
         const {status, data} = await axios({
-          url: `http://${address}:${port}/session/${sessionIds[0]}`,
-          method: 'DELETE',
+          url: createSessionURL(sessionIds[0]),
+          method: DELETE,
         });
         status.should.equal(200);
         should.equal(data.value, null);
@@ -84,11 +106,11 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
         let times = 0;
         do {
           reqs.push(axios({
-            url: `http://${address}:${port}/session`,
+            url: newSessionURL,
             headers: {
               'X-Idempotency-Key': '12345',
             },
-            method: 'POST',
+            method: POST,
             data: {capabilities: {alwaysMatch: defaultCaps, firstMatch: [{}]}},
           }));
           times++;
@@ -97,8 +119,8 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
         _.uniq(sessionIds).length.should.equal(1);
 
         const {status, data} = await axios({
-          url: `http://${address}:${port}/session/${sessionIds[0]}`,
-          method: 'DELETE',
+          url: createSessionURL(sessionIds[0]),
+          method: DELETE,
         });
         status.should.equal(200);
         should.equal(data.value, null);
@@ -106,8 +128,8 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
 
       it('should create session and retrieve a session id, then delete it', async function () {
         let {status, data} = await axios({
-          url: `http://${address}:${port}/session`,
-          method: 'POST',
+          url: newSessionURL,
+          method: POST,
           data: {capabilities: {alwaysMatch: defaultCaps, firstMatch: [{}]}},
         });
 
@@ -117,8 +139,8 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
         data.value.capabilities.deviceName.should.equal(defaultCaps['appium:deviceName']);
 
         ({status, data} = await axios({
-          url: `http://${address}:${port}/session/${d.sessionId}`,
-          method: 'DELETE',
+          url: createSessionURL(d.sessionId),
+          method: DELETE,
         }));
 
         status.should.equal(200);
@@ -132,6 +154,7 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
 
     describe('command timeouts', function () {
       let originalFindElement, originalFindElements;
+
       async function startTimeoutSession (timeout) {
         const caps = _.cloneDeep(defaultCaps);
         caps['appium:newCommandTimeout'] = timeout;
@@ -165,15 +188,17 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
 
       it('should timeout on commands using commandTimeout cap', async function () {
         let newSession = await startTimeoutSession(0.25);
-
+        // XXX: race condition: we must build this URL before ...something happens...
+        // which causes `d.sessionId` to be missing
+        let sessionURL = createSessionURL(d.sessionId);
         await axios({
-          url: `http://${address}:${port}/session/${d.sessionId}/element`,
-          method: 'POST',
+          url: createAppiumTestURL(d.sessionId, 'element'),
+          method: POST,
           data: {using: 'name', value: 'foo'},
         });
         await B.delay(400);
         const {data} = await axios({
-          url: `http://${address}:${port}/session/${d.sessionId}`,
+          url: sessionURL,
           validateStatus: null,
         });
         should.equal(data.value.error, 'invalid session id');
@@ -186,8 +211,8 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
         let newSession = await startTimeoutSession(0.1);
         let start = Date.now();
         const {value} = (await axios({
-          url: `http://${address}:${port}/session/${d.sessionId}/elements`,
-          method: 'POST',
+          url: createAppiumTestURL(d.sessionId, 'elements'),
+          method: POST,
           data: {using: 'name', value: 'foo'},
         })).data;
         (Date.now() - start).should.be.above(150);
@@ -200,13 +225,13 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
         let newSession = await startTimeoutSession(0);
 
         await axios({
-          url: `http://${address}:${port}/session/${d.sessionId}/element`,
-          method: 'POST',
+          url: createAppiumTestURL(d.sessionId, 'element'),
+          method: POST,
           data: {using: 'name', value: 'foo'},
         });
         await B.delay(400);
         const {value} = (await axios({
-          url: `http://${address}:${port}/session/${d.sessionId}`,
+          url: createSessionURL(d.sessionId),
         })).data;
         value.platformName.should.equal(defaultCaps.platformName);
         const resp = await endSession(newSession.sessionId);
@@ -217,14 +242,17 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
 
       it('should not timeout if its just the command taking awhile', async function () {
         let newSession = await startTimeoutSession(0.25);
+        // XXX: race condition: we must build this URL before ...something happens...
+        // which causes `d.sessionId` to be missing
+        let sessionURL = createSessionURL(d.sessionId);
         await axios({
-          url: `http://${address}:${port}/session/${d.sessionId}/element`,
-          method: 'POST',
+          url: createAppiumTestURL(d.sessionId, 'element'),
+          method: POST,
           data: {using: 'name', value: 'foo'},
         });
         await B.delay(400);
         const {value} = (await axios({
-          url: `http://${address}:${port}/session/${d.sessionId}`,
+          url: sessionURL,
           validateStatus: null,
         })).data;
         value.error.should.equal('invalid session id');
@@ -269,7 +297,7 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
             await B.delay(5000);
           }.bind(d);
           const reqPromise = axios({
-            url: `http://${address}:${port}/status`,
+            url: createAppiumTestURL('', 'status'),
             validateStatus: null,
           });
           // make sure that the request gets to the server before our shutdown
@@ -308,181 +336,6 @@ function baseDriverE2ETests (DriverClass, defaultCaps = {}) {
       });
     });
 
-    describe('execute driver script', function () {
-      // mock some methods on BaseDriver that aren't normally there except in
-      // a fully blown driver
-      let originalFindElement, sessionId;
-      before(function () {
-        d.allowInsecure = ['execute_driver_script'];
-        originalFindElement = d.findElement;
-        d.findElement = (function (strategy, selector) {
-          if (strategy === 'accessibility id' && selector === 'amazing') {
-            return {[W3C_ELEMENT_KEY]: 'element-id-1'};
-          }
-
-          throw new errors.NoSuchElementError('not found');
-        }).bind(d);
-      });
-
-      beforeEach(async function () {
-        ({sessionId} = await startSession(defaultCaps));
-      });
-
-      after(function () {
-        d.findElement = originalFindElement;
-      });
-
-      afterEach(async function () {
-        await endSession(sessionId);
-      });
-
-      it('should not work unless the allowInsecure feature flag is set', async function () {
-        d._allowInsecure = d.allowInsecure;
-        try {
-          d.allowInsecure = [];
-          const script = `return 'foo'`;
-          await axios({
-            url: `http://${address}:${port}/session/${sessionId}/appium/execute_driver`,
-            method: 'POST',
-            data: {script, type: 'wd'},
-          }).should.eventually.be.rejected;
-          await endSession(sessionId);
-        } finally {
-          d.allowInsecure = d._allowInsecure;
-        }
-      });
-
-      it('should execute a webdriverio script in the context of session', async function () {
-        const script = `
-          const timeouts = await driver.getTimeouts();
-          const status = await driver.status();
-          return [timeouts, status];
-        `;
-        const {value} = (await axios({
-          url: `http://${address}:${port}/session/${sessionId}/appium/execute_driver`,
-          method: 'POST',
-          data: {script, type: 'webdriverio'},
-        })).data;
-        const expectedTimeouts = {command: 250, implicit: 0};
-        const expectedStatus = {};
-        value.result.should.eql([expectedTimeouts, expectedStatus]);
-      });
-
-      it('should fail with any script type other than webdriverio currently', async function () {
-        const script = `return 'foo'`;
-        await axios({
-          url: `http://${address}:${port}/session/${sessionId}/appium/execute_driver`,
-          method: 'POST',
-          data: {script, type: 'wd'},
-        }).should.eventually.be.rejected;
-      });
-
-      it('should execute a webdriverio script that returns elements correctly', async function () {
-        const script = `
-          return await driver.$("~amazing");
-        `;
-        const {value} = (await axios({
-          url: `http://${address}:${port}/session/${sessionId}/appium/execute_driver`,
-          method: 'POST',
-          data: {script},
-        })).data;
-        value.result.should.eql({
-          [W3C_ELEMENT_KEY]: 'element-id-1',
-          [MJSONWP_ELEMENT_KEY]: 'element-id-1'
-        });
-      });
-
-      it('should execute a webdriverio script that returns elements in deep structure', async function () {
-        const script = `
-          const el = await driver.$("~amazing");
-          return {element: el, elements: [el, el]};
-        `;
-        const {value} = (await axios({
-          url: `http://${address}:${port}/session/${sessionId}/appium/execute_driver`,
-          method: 'POST',
-          data: {script},
-        })).data;
-        const elObj = {
-          [W3C_ELEMENT_KEY]: 'element-id-1',
-          [MJSONWP_ELEMENT_KEY]: 'element-id-1'
-        };
-        value.result.should.eql({element: elObj, elements: [elObj, elObj]});
-      });
-
-      it('should store and return logs to the user', async function () {
-        const script = `
-          console.log("foo");
-          console.log("foo2");
-          console.warn("bar");
-          console.error("baz");
-          return null;
-        `;
-        const {value} = (await axios({
-          url: `http://${address}:${port}/session/${sessionId}/appium/execute_driver`,
-          method: 'POST',
-          data: {script},
-        })).data;
-        value.logs.should.eql({log: ['foo', 'foo2'], warn: ['bar'], error: ['baz']});
-      });
-
-      it('should have appium specific commands available', async function () {
-        const script = `
-          return typeof driver.lock;
-        `;
-        const {value} = (await axios({
-          url: `http://${address}:${port}/session/${sessionId}/appium/execute_driver`,
-          method: 'POST',
-          data: {script},
-        })).data;
-        value.result.should.eql('function');
-      });
-
-      it('should correctly handle errors that happen in a webdriverio script', async function () {
-        const script = `
-          return await driver.$("~notfound");
-        `;
-        const {data} = await axios({
-          url: `http://${address}:${port}/session/${sessionId}/appium/execute_driver`,
-          method: 'POST',
-          validateStatus: null,
-          data: {script},
-        });
-        data.value.result.error.error.should.equal('no such element');
-        data.value.result.error.message.should.equal('not found');
-        data.value.result.error.stacktrace.should.includes('NoSuchElementError:');
-        data.value.result.selector.should.equal('~notfound');
-        data.value.result.sessionId.should.equal(sessionId);
-      });
-
-      it('should correctly handle errors that happen when a script cannot be compiled', async function () {
-        const script = `
-          return {;
-        `;
-        const {data} = await axios({
-          url: `http://${address}:${port}/session/${sessionId}/appium/execute_driver`,
-          method: 'POST',
-          validateStatus: null,
-          data: {script},
-        });
-        data.value.should.have.property('message');
-        data.value.message.should.match(/An unknown server-side error occurred while processing the command. Original error: Could not execute driver script. Original error was: Error: Unexpected token '?;'?/);
-      });
-
-      it('should be able to set a timeout on a driver script', async function () {
-        const script = `
-          await Promise.delay(1000);
-          return true;
-        `;
-        const {value} = (await axios({
-          url: `http://${address}:${port}/session/${sessionId}/appium/execute_driver`,
-          method: 'POST',
-          validateStatus: null,
-          data: {script, timeout: 50},
-        })).data;
-        value.message.should.match(/.+50.+timeout.+/);
-      });
-    });
-
     if (DriverClass === BaseDriver) {
       // only run this test on basedriver, not other drivers which also use these tests, since we
       // don't want them to try and start sessions with these random capabilities that are

package/test/basedriver/driver-specs.js

@@ -1,6 +1,6 @@
 // transpile:mocha
 
-import BaseDriver from '../..';
+import BaseDriver from '../../lib';
 import baseDriverUnitTests from './driver-tests';
 baseDriverUnitTests(BaseDriver, {
   platformName: 'iOS',

package/test/basedriver/driver-tests.js

@@ -1,6 +1,6 @@
 import _ from 'lodash';
 import B from 'bluebird';
-import { DeviceSettings } from '../..';
+import { DeviceSettings } from '../../lib';
 import sinon from 'sinon';
 
 
@@ -335,8 +335,8 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
         it('should have a #canProxy method', function () {
           d.canProxy.should.be.an.instanceof(Function);
         });
-        it('should return false from #canProxy', function () {
-          d.canProxy(sessId).should.be.false;
+        it('should return a boolean from #canProxy', function () {
+          d.canProxy(sessId).should.be.a('boolean');
         });
         it('should throw an error when sessionId is wrong', function () {
           (() => { d.canProxy(); }).should.throw;

package/test/basedriver/helpers-e2e-specs.js

@@ -7,7 +7,7 @@ import finalhandler from 'finalhandler';
 import serveStatic from 'serve-static';
 import contentDisposition from 'content-disposition';
 import B from 'bluebird';
-
+import {TEST_HOST, getTestPort} from '../helpers';
 
 
 function getFixture (file) {
@@ -54,8 +54,13 @@ describe('app download and configuration', function () {
         .should.be.rejectedWith(/did not have extension/);
     });
     describe('should download an app from the web', function () {
-      const port = 8000;
-      const serverUrl = `http://localhost:${port}`;
+      let port;
+      let serverUrl;
+
+      before(async function () {
+        port = await getTestPort(true);
+        serverUrl = `http://${TEST_HOST}:${port}`;
+      });
 
       describe('server not available', function () {
         it('should handle server not available', async function () {
@@ -142,7 +147,7 @@ describe('app download and configuration', function () {
         it('should handle invalid protocol', async function () {
           await configureApp('file://C:/missing/FakeIOSApp.app.zip', '.app')
             .should.eventually.be.rejectedWith(/is not supported/);
-          await configureApp('ftp://localhost:8000/missing/FakeIOSApp.app.zip', '.app')
+          await configureApp(`ftp://${TEST_HOST}:${port}/missing/FakeIOSApp.app.zip`, '.app')
             .should.eventually.be.rejectedWith(/is not supported/);
         });
         it('should handle missing file in Windows path format', async function () {

package/test/basedriver/timeout-specs.js

@@ -1,4 +1,4 @@
-import BaseDriver from '../..';
+import BaseDriver from '../../lib';
 import sinon from 'sinon';