webdriver 5.21.0 → 5.23.0

package/build/index.js

@@ -17,8 +17,6 @@ var _utils = require("@wdio/utils");
 
 var _config = require("@wdio/config");
 
-var _request = _interopRequireDefault(require("./request"));
-
 var _constants = require("./constants");
 
 var _utils2 = require("./utils");
@@ -48,7 +46,7 @@ class WebDriver {
     const environmentPrototype = (0, _utils2.getEnvironmentVars)(environment);
     const protocolCommands = (0, _utils2.getPrototype)(environment);
 
-    const prototype = _objectSpread({}, protocolCommands, {}, environmentPrototype, {}, userPrototype);
+    const prototype = _objectSpread(_objectSpread(_objectSpread({}, protocolCommands), environmentPrototype), userPrototype);
 
     const monad = (0, _utils.webdriverMonad)(params, modifier, prototype);
     return monad(sessionId, customCommandWrapper);
@@ -68,25 +66,20 @@ class WebDriver {
     const environmentPrototype = (0, _utils2.getEnvironmentVars)(options);
     const protocolCommands = (0, _utils2.getPrototype)(options);
 
-    const prototype = _objectSpread({}, protocolCommands, {}, environmentPrototype, {}, userPrototype);
+    const prototype = _objectSpread(_objectSpread(_objectSpread({}, protocolCommands), environmentPrototype), userPrototype);
 
     const monad = (0, _utils.webdriverMonad)(options, modifier, prototype);
     return monad(options.sessionId, commandWrapper);
   }
 
   static async reloadSession(instance) {
-    const {
-      w3cCaps,
-      jsonwpCaps
-    } = instance.options.requestedCapabilities;
-    const sessionRequest = new _request.default('POST', '/session', {
-      capabilities: w3cCaps,
-      desiredCapabilities: jsonwpCaps
+    const params = _objectSpread(_objectSpread({}, instance.options), {}, {
+      capabilities: instance.requestedCapabilities
     });
-    const response = await sessionRequest.makeRequest(instance.options);
-    const newSessionId = response.sessionId || response.value && response.value.sessionId;
-    instance.sessionId = newSessionId;
-    return newSessionId;
+
+    const sessionId = await (0, _utils2.startWebDriverSession)(params);
+    instance.sessionId = sessionId;
+    return sessionId;
   }
 
   static get WebDriver() {

package/build/request.js

@@ -75,7 +75,7 @@ class WebDriverRequest extends _events.default {
   _createOptions(options, sessionId) {
     const requestOptions = {
       agent: options.agent || agents[options.protocol],
-      headers: _objectSpread({}, DEFAULT_HEADERS, {}, typeof options.headers === 'object' ? options.headers : {}),
+      headers: _objectSpread(_objectSpread({}, DEFAULT_HEADERS), typeof options.headers === 'object' ? options.headers : {}),
       qs: typeof options.queryParams === 'object' ? options.queryParams : {},
       timeout: options.connectionRetryTimeout
     };
@@ -83,7 +83,7 @@ class WebDriverRequest extends _events.default {
     if (this.body && (Object.keys(this.body).length || this.method === 'POST')) {
       const contentLength = Buffer.byteLength(JSON.stringify(this.body), 'utf8');
       requestOptions.body = this.body;
-      requestOptions.headers = _objectSpread({}, requestOptions.headers, {}, {
+      requestOptions.headers = _objectSpread(_objectSpread({}, requestOptions.headers), {
         'Content-Length': contentLength
       });
     }

package/build/utils.js

@@ -46,10 +46,7 @@ async function startWebDriverSession(params) {
   }
 
   const sessionId = response.value.sessionId || response.sessionId;
-  params.requestedCapabilities = {
-    w3cCaps,
-    jsonwpCaps
-  };
+  params.requestedCapabilities = params.capabilities;
   params.capabilities = response.value.capabilities || response.value;
   return sessionId;
 }
@@ -117,7 +114,7 @@ function getErrorFromResponseBody(body) {
     return new Error(body);
   }
 
-  if (typeof body !== 'object' || !body.value) {
+  if (typeof body !== 'object' || !body.value && !body.error) {
     return new Error('unknown error');
   }
 
@@ -126,11 +123,12 @@ function getErrorFromResponseBody(body) {
 
 class CustomRequestError extends Error {
   constructor(body) {
-    super(body.value.message || body.value.class || 'unknown error');
+    const errorObj = body.value || body;
+    super(errorObj.message || errorObj.class || 'unknown error');
 
-    if (body.value.error) {
-      this.name = body.value.error;
-    } else if (body.value.message && body.value.message.includes('stale element reference')) {
+    if (errorObj.error) {
+      this.name = errorObj.error;
+    } else if (errorObj.message && errorObj.message.includes('stale element reference')) {
       this.name = 'stale element reference';
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webdriver",
-  "version": "5.21.0",
+  "version": "5.23.0",
   "description": "A Node.js bindings implementation for the W3C WebDriver and Mobile JSONWire Protocol",
   "author": "Christian Bromann <christian@saucelabs.com>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/webdriver",
@@ -30,15 +30,13 @@
     "url": "https://github.com/webdriverio/webdriverio/issues"
   },
   "dependencies": {
-    "@wdio/config": "5.18.4",
+    "@types/request": "^2.48.4",
+    "@wdio/config": "5.22.4",
     "@wdio/logger": "5.16.10",
-    "@wdio/protocols": "5.19.0",
-    "@wdio/utils": "5.18.6",
+    "@wdio/protocols": "5.22.1",
+    "@wdio/utils": "5.23.0",
     "lodash.merge": "^4.6.1",
     "request": "^2.83.0"
   },
-  "devDependencies": {
-    "@types/request": "^2.48.4"
-  },
-  "gitHead": "ab9345349a58d41f36c504b9925353ab793b696f"
+  "gitHead": "a9b8098ad18074e05a72c0458a7845a41a40aa93"
 }

package/webdriver.d.ts

@@ -364,6 +364,7 @@ declare namespace WebDriver {
             [name: string]: string;
         },
         capabilities?: DesiredCapabilities;
+        requestedCapabilities?: DesiredCapabilities;
         logLevel?: WebDriverLogTypes;
         logOutput?: string | NodeJS.WritableStream
         connectionRetryTimeout?: number;
@@ -401,13 +402,8 @@ declare namespace WebDriver {
     ): Promise<Client>;
 
     interface ClientOptions {
-        capabilities: DesiredCapabilities;
         isW3C: boolean;
         isChrome: boolean;
-        isAndroid: boolean;
-        isMobile: boolean;
-        isIOS: boolean;
-        sessionId: string;
     }
 
     // object with no match
@@ -459,9 +455,28 @@ declare namespace WebDriver {
         mjpegScalingFactor?: number,
     }
 
+    interface BaseClient {
+        // id of WebDriver session
+        sessionId: string;
+        // assigned capabilities by the browser driver / WebDriver server
+        capabilities: DesiredCapabilities;
+        // original requested capabilities
+        requestedCapabilities: DesiredCapabilities;
+
+        /**
+         * browser flags
+         */
+        // true if session runs on a mobile device
+        isMobile: boolean;
+        // true if mobile session runs on iOS
+        isIOS: boolean;
+        // true if mobile session runs on Android
+        isAndroid: boolean;
+    }
+
     // generated typings
         // webdriver types
-    interface Client {
+    interface Client extends BaseClient {
 
         /**
          * [webdriver]
@@ -580,7 +595,7 @@ declare namespace WebDriver {
          * The Switch To Frame command is used to select the current top-level browsing context or a child browsing context of the current browsing context to use as the current browsing context for subsequent commands.
          * https://w3c.github.io/webdriver/#dfn-switch-to-frame
          */
-        switchToFrame(id: (number|string|object|null)): void;
+        switchToFrame(id: (number|object|null)): void;
 
         /**
          * [webdriver]
@@ -857,7 +872,7 @@ declare namespace WebDriver {
     }
 
     // appium types
-    interface Client {
+    interface Client extends BaseClient {
 
         /**
          * [appium]
@@ -1295,7 +1310,7 @@ declare namespace WebDriver {
     }
 
     // jsonwp types
-    interface Client {
+    interface Client extends BaseClient {
 
         /**
          * [jsonwp]
@@ -1964,7 +1979,7 @@ declare namespace WebDriver {
     }
 
     // mjsonwp types
-    interface Client {
+    interface Client extends BaseClient {
 
         /**
          * [mjsonwp]
@@ -2031,7 +2046,7 @@ declare namespace WebDriver {
     }
 
     // chromium types
-    interface Client {
+    interface Client extends BaseClient {
 
         /**
          * [chromium]
@@ -2203,7 +2218,7 @@ declare namespace WebDriver {
     }
 
     // saucelabs types
-    interface Client {
+    interface Client extends BaseClient {
 
         /**
          * [saucelabs]
@@ -2249,7 +2264,7 @@ declare namespace WebDriver {
     }
 
     // selenium types
-    interface Client {
+    interface Client extends BaseClient {
 
         /**
          * [selenium]
@@ -2288,11 +2303,11 @@ declare namespace WebDriver {
     }
 
 
-    interface ClientAsync extends AsyncClient { }
+    interface ClientAsync extends AsyncClient, BaseClient { }
 }
 
 type AsyncClient = {
-    [K in keyof WebDriver.Client]:
+    [K in keyof Pick<WebDriver.Client, Exclude<keyof WebDriver.Client, keyof WebDriver.BaseClient>>]:
     (...args: Parameters<WebDriver.Client[K]>) => Promise<ReturnType<WebDriver.Client[K]>>;
 }