webdriver 5.19.0 → 5.22.4

package/README.md

@@ -106,3 +106,15 @@ Count of request retries to the Selenium server.
 
 Type: `Number`<br>
 Default: *2*
+
+### transformRequest
+Function intercepting [HTTP request options](https://github.com/request/request#requestoptions-callback) before a WebDriver request is made
+
+Type: `(RequestOptions) => RequestOptions`<br>
+Default: *none*
+
+### transformResponse
+Function intercepting HTTP response objects after a WebDriver response has arrived
+
+Type: `(Response, RequestOptions) => Response`<br>
+Default: *none*

package/build/constants.js

@@ -67,6 +67,8 @@ const DEFAULTS = {
   enableDirectConnect: {
     type: 'boolean',
     default: false
-  }
+  },
+  transformRequest: requestOptions => requestOptions,
+  transformResponse: response => response
 };
 exports.DEFAULTS = DEFAULTS;

package/build/request.js

@@ -62,9 +62,14 @@ class WebDriverRequest extends _events.default {
   }
 
   makeRequest(options, sessionId) {
-    const fullRequestOptions = Object.assign({}, this.defaultOptions, this._createOptions(options, sessionId));
+    let fullRequestOptions = Object.assign({}, this.defaultOptions, this._createOptions(options, sessionId));
+
+    if (typeof options.transformRequest === 'function') {
+      fullRequestOptions = options.transformRequest(fullRequestOptions);
+    }
+
     this.emit('request', fullRequestOptions);
-    return this._request(fullRequestOptions, options.connectionRetryCount);
+    return this._request(fullRequestOptions, options.transformResponse, options.connectionRetryCount);
   }
 
   _createOptions(options, sessionId) {
@@ -100,14 +105,19 @@ class WebDriverRequest extends _events.default {
     return requestOptions;
   }
 
-  _request(fullRequestOptions, totalRetryCount = 0, retryCount = 0) {
+  _request(fullRequestOptions, transformResponse, totalRetryCount = 0, retryCount = 0) {
     log.info(`[${fullRequestOptions.method}] ${fullRequestOptions.uri.href}`);
 
     if (fullRequestOptions.body && Object.keys(fullRequestOptions.body).length) {
       log.info('DATA', fullRequestOptions.body);
     }
 
-    return new Promise((resolve, reject) => (0, _request.default)(fullRequestOptions, (err, response, body) => {
+    return new Promise((resolve, reject) => (0, _request.default)(fullRequestOptions, (err, response) => {
+      if (typeof transformResponse === 'function') {
+        response = transformResponse(response, fullRequestOptions);
+      }
+
+      let body = response && response.body;
       const error = err || (0, _utils.getErrorFromResponseBody)(body);
 
       if (this.isHubCommand) {
@@ -151,7 +161,7 @@ class WebDriverRequest extends _events.default {
       log.warn('Request failed due to', error.message);
       log.info(`Retrying ${retryCount}/${totalRetryCount}`);
 
-      this._request(fullRequestOptions, totalRetryCount, retryCount).then(resolve, reject);
+      this._request(fullRequestOptions, transformResponse, totalRetryCount, retryCount).then(resolve, reject);
     }));
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webdriver",
-  "version": "5.19.0",
+  "version": "5.22.4",
   "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,12 +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/protocols": "5.22.1",
     "@wdio/utils": "5.18.6",
     "lodash.merge": "^4.6.1",
     "request": "^2.83.0"
   },
-  "gitHead": "269db84d04b74322ef6822ad715534709db3f273"
+  "gitHead": "1a093237fe927a5db470f8a839b342df02913804"
 }

package/webdriver.d.ts

@@ -9,6 +9,9 @@
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 /// <reference types="node"/>
 
+declare type HTTPRequestOptions = import('request').CoreOptions;
+declare type HTTPResponse = import('request').Response;
+
 declare namespace WebDriver {
     type PageLoadingStrategy = 'none' | 'eager' | 'normal';
     type ProxyTypes = 'pac' | 'noproxy' | 'autodetect' | 'system' | 'manual';
@@ -370,6 +373,8 @@ declare namespace WebDriver {
         headers?: {
             [name: string]: string;
         };
+        transformRequest?: (requestOptions: HTTPRequestOptions) => HTTPRequestOptions;
+        transformResponse?: (response: HTTPResponse, requestOptions: HTTPRequestOptions) => HTTPResponse;
     }
 
     interface AttachSessionOptions extends Options {
@@ -575,7 +580,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]