webdriver 7.16.13 → 7.17.0

package/build/request/index.js

@@ -1,198 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RequestLibError = void 0;
-const events_1 = require("events");
-const path_1 = __importDefault(require("path"));
-const factory_1 = require("./factory");
-const logger_1 = __importDefault(require("@wdio/logger"));
-const utils_1 = require("@wdio/utils");
-const utils_2 = require("../utils");
-const pkg = require('../../package.json');
-class RequestLibError extends Error {
-}
-exports.RequestLibError = RequestLibError;
-const DEFAULT_HEADERS = {
-    'Content-Type': 'application/json; charset=utf-8',
-    'Connection': 'keep-alive',
-    'Accept': 'application/json',
-    'User-Agent': 'webdriver/' + pkg.version
-};
-const log = (0, logger_1.default)('webdriver');
-class WebDriverRequest extends events_1.EventEmitter {
-    constructor(method, endpoint, body, isHubCommand = false) {
-        super();
-        this.defaultOptions = {
-            retry: 0,
-            followRedirect: true,
-            responseType: 'json',
-            throwHttpErrors: false
-        };
-        this.body = body;
-        this.method = method;
-        this.endpoint = endpoint;
-        this.isHubCommand = isHubCommand;
-        this.defaultAgents = null;
-        this.requiresSessionId = Boolean(this.endpoint.match(/:sessionId/));
-    }
-    makeRequest(options, sessionId) {
-        let fullRequestOptions = Object.assign({
-            method: this.method
-        }, this.defaultOptions, this._createOptions(options, sessionId));
-        if (typeof options.transformRequest === 'function') {
-            fullRequestOptions = options.transformRequest(fullRequestOptions);
-        }
-        this.emit('request', fullRequestOptions);
-        return this._request(fullRequestOptions, options.transformResponse, options.connectionRetryCount, 0);
-    }
-    _createOptions(options, sessionId, isBrowser = false) {
-        const agent = isBrowser ? undefined : (options.agent || this.defaultAgents);
-        const searchParams = isBrowser ?
-            undefined :
-            (typeof options.queryParams === 'object' ? options.queryParams : {});
-        const requestOptions = {
-            https: {},
-            agent,
-            headers: {
-                ...DEFAULT_HEADERS,
-                ...(typeof options.headers === 'object' ? options.headers : {})
-            },
-            searchParams,
-            timeout: options.connectionRetryTimeout
-        };
-        /**
-         * only apply body property if existing
-         */
-        if (this.body && (Object.keys(this.body).length || this.method === 'POST')) {
-            const contentLength = Buffer.byteLength(JSON.stringify(this.body), 'utf8');
-            requestOptions.json = this.body;
-            requestOptions.headers['Content-Length'] = `${contentLength}`;
-        }
-        /**
-         * if we don't have a session id we set it here, unless we call commands that don't require session ids, for
-         * example /sessions. The call to /sessions is not connected to a session itself and it therefore doesn't
-         * require it
-         */
-        let endpoint = this.endpoint;
-        if (this.requiresSessionId) {
-            if (!sessionId) {
-                throw new Error('A sessionId is required for this command');
-            }
-            endpoint = endpoint.replace(':sessionId', sessionId);
-        }
-        requestOptions.url = factory_1.URLFactory.getInstance(`${options.protocol}://` +
-            `${options.hostname}:${options.port}` +
-            (this.isHubCommand ? this.endpoint : path_1.default.join(options.path || '', endpoint)));
-        /**
-         * send authentication credentials only when creating new session
-         */
-        if (this.endpoint === '/session' && options.user && options.key) {
-            requestOptions.username = options.user;
-            requestOptions.password = options.key;
-        }
-        /**
-         * if the environment variable "STRICT_SSL" is defined as "false", it doesn't require SSL certificates to be valid.
-         * Or the requestOptions has strictSSL for an environment which cannot get the environment variable correctly like on an Electron app.
-         */
-        requestOptions.https.rejectUnauthorized = !(options.strictSSL === false ||
-            process.env.STRICT_SSL === 'false' ||
-            process.env.strict_ssl === 'false');
-        return requestOptions;
-    }
-    async _libRequest(url, options) {
-        throw new Error('This function must be implemented');
-    }
-    async _request(fullRequestOptions, transformResponse, totalRetryCount = 0, retryCount = 0) {
-        log.info(`[${fullRequestOptions.method}] ${fullRequestOptions.url.href}`);
-        if (fullRequestOptions.json && Object.keys(fullRequestOptions.json).length) {
-            log.info('DATA', (0, utils_1.transformCommandLogResult)(fullRequestOptions.json));
-        }
-        const { url, ...requestLibOptions } = fullRequestOptions;
-        let response = await this._libRequest(url, requestLibOptions)
-            // @ts-ignore
-            .catch((err) => {
-            return err;
-        });
-        /**
-         * handle retries for requests
-         * @param {Error} error  error object that causes the retry
-         * @param {String} msg   message that is being shown as warning to user
-         */
-        const retry = (error, msg) => {
-            /**
-             * stop retrying if totalRetryCount was exceeded or there is no reason to
-             * retry, e.g. if sessionId is invalid
-             */
-            if (retryCount >= totalRetryCount || error.message.includes('invalid session id')) {
-                log.error(`Request failed with status ${response.statusCode} due to ${error}`);
-                this.emit('response', { error });
-                throw error;
-            }
-            ++retryCount;
-            this.emit('retry', { error, retryCount });
-            log.warn(msg);
-            log.info(`Retrying ${retryCount}/${totalRetryCount}`);
-            return this._request(fullRequestOptions, transformResponse, totalRetryCount, retryCount);
-        };
-        /**
-         * handle request errors
-         */
-        if (response instanceof Error) {
-            /**
-             * handle timeouts
-             */
-            if (response.code === 'ETIMEDOUT') {
-                const error = (0, utils_2.getTimeoutError)(response, fullRequestOptions);
-                return retry(error, 'Request timed out! Consider increasing the "connectionRetryTimeout" option.');
-            }
-            /**
-             * throw if request error is unknown
-             */
-            throw response;
-        }
-        if (typeof transformResponse === 'function') {
-            response = transformResponse(response, fullRequestOptions);
-        }
-        const error = (0, utils_2.getErrorFromResponseBody)(response.body);
-        /**
-         * retry connection refused errors
-         */
-        if (error.message === 'java.net.ConnectException: Connection refused: connect') {
-            return retry(error, 'Connection to Selenium Standalone server was refused.');
-        }
-        /**
-         * hub commands don't follow standard response formats
-         * and can have empty bodies
-         */
-        if (this.isHubCommand) {
-            /**
-             * if body contains HTML the command was called on a node
-             * directly without using a hub, therefore throw
-             */
-            if (typeof response.body === 'string' && response.body.startsWith('<!DOCTYPE html>')) {
-                return Promise.reject(new Error('Command can only be called to a Selenium Hub'));
-            }
-            return { value: response.body || null };
-        }
-        /**
-         * Resolve only if successful response
-         */
-        if ((0, utils_2.isSuccessfulResponse)(response.statusCode, response.body)) {
-            this.emit('response', { result: response.body });
-            return response.body;
-        }
-        /**
-         *  stop retrying as this will never be successful.
-         *  we will handle this at the elementErrorHandler
-         */
-        if (error.name === 'stale element reference') {
-            log.warn('Request encountered a stale element - terminating request');
-            this.emit('response', { error });
-            throw error;
-        }
-        return retry(error, `Request failed with status ${response.statusCode} due to ${error.message}`);
-    }
-}
-exports.default = WebDriverRequest;

package/build/request/node.d.ts

@@ -1,9 +0,0 @@
-/// <reference types="node" />
-import type { URL } from 'url';
-import { Options } from '@wdio/types';
-import WebDriverRequest from './index';
-export default class NodeJSRequest extends WebDriverRequest {
-    constructor(method: string, endpoint: string, body?: Record<string, unknown>, isHubCommand?: boolean);
-    protected _libRequest(url: URL, opts: Options.RequestLibOptions): Promise<Options.RequestLibResponse>;
-}
-//# sourceMappingURL=node.d.ts.map

package/build/request/node.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../src/request/node.ts"],"names":[],"mappings":";AAIA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AAC9B,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AACrC,OAAO,gBAAqC,MAAM,SAAS,CAAA;AAO3D,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,gBAAgB;gBAC1C,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAE,OAAe;cAK5F,WAAW,CAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,iBAAiB;CAUzE"}

package/build/request/node.js

@@ -1,50 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const http_1 = __importDefault(require("http"));
-const https_1 = __importDefault(require("https"));
-const got = __importStar(require("got"));
-const index_1 = __importStar(require("./index"));
-const agents = {
-    http: new http_1.default.Agent({ keepAlive: true }),
-    https: new https_1.default.Agent({ keepAlive: true })
-};
-class NodeJSRequest extends index_1.default {
-    constructor(method, endpoint, body, isHubCommand = false) {
-        super(method, endpoint, body, isHubCommand);
-        this.defaultAgents = agents;
-    }
-    async _libRequest(url, opts) {
-        try {
-            return (await got.default(url, opts));
-        }
-        catch (err) {
-            if (!(err instanceof Error)) {
-                throw new index_1.RequestLibError(err.message || err);
-            }
-            throw err;
-        }
-    }
-}
-exports.default = NodeJSRequest;

package/build/types.d.ts

@@ -1,36 +0,0 @@
-/// <reference types="node" />
-import { EventEmitter } from 'events';
-import type { Options, Capabilities } from '@wdio/types';
-import type { ProtocolCommands, ProtocolCommandsAsync } from '@wdio/protocols';
-export interface JSONWPCommandError extends Error {
-    code?: string;
-    statusCode?: string;
-    statusMessage?: string;
-}
-export interface SessionFlags {
-    isW3C: boolean;
-    isChrome: boolean;
-    isFirefox: boolean;
-    isAndroid: boolean;
-    isMobile: boolean;
-    isIOS: boolean;
-    isSauce: boolean;
-    isSeleniumStandalone: boolean;
-    isDevTools: boolean;
-}
-export interface BaseClient extends EventEmitter, SessionFlags {
-    sessionId: string;
-    capabilities: Capabilities.DesiredCapabilities | Capabilities.W3CCapabilities;
-    requestedCapabilities: Capabilities.DesiredCapabilities | Capabilities.W3CCapabilities;
-    options: Options.WebDriver;
-}
-export interface Client extends BaseClient, ProtocolCommandsAsync {
-}
-export interface ClientSync extends BaseClient, ProtocolCommands {
-}
-export interface AttachOptions extends Partial<SessionFlags>, Partial<Options.WebDriver> {
-    sessionId: string;
-    capabilities?: Capabilities.DesiredCapabilities | Capabilities.W3CCapabilities;
-    isW3C?: boolean;
-}
-//# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAA;AACrC,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AACxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAA;AAE9E,MAAM,WAAW,kBAAmB,SAAQ,KAAK;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,WAAW,YAAY;IACzB,KAAK,EAAE,OAAO,CAAA;IACd,QAAQ,EAAE,OAAO,CAAA;IACjB,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,EAAE,OAAO,CAAA;IAClB,QAAQ,EAAE,OAAO,CAAA;IACjB,KAAK,EAAE,OAAO,CAAA;IACd,OAAO,EAAE,OAAO,CAAA;IAChB,oBAAoB,EAAE,OAAO,CAAA;IAC7B,UAAU,EAAE,OAAO,CAAA;CACtB;AAED,MAAM,WAAW,UAAW,SAAQ,YAAY,EAAE,YAAY;IAE1D,SAAS,EAAE,MAAM,CAAA;IAEjB,YAAY,EAAE,YAAY,CAAC,mBAAmB,GAAG,YAAY,CAAC,eAAe,CAAA;IAE7E,qBAAqB,EAAE,YAAY,CAAC,mBAAmB,GAAG,YAAY,CAAC,eAAe,CAAA;IAEtF,OAAO,EAAE,OAAO,CAAC,SAAS,CAAA;CAC7B;AAED,MAAM,WAAW,MAAO,SAAQ,UAAU,EAAE,qBAAqB;CAAG;AACpE,MAAM,WAAW,UAAW,SAAQ,UAAU,EAAE,gBAAgB;CAAG;AAEnE,MAAM,WAAW,aAAc,SAAQ,OAAO,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC;IACpF,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,YAAY,CAAC,mBAAmB,GAAG,YAAY,CAAC,eAAe,CAAA;IAC9E,KAAK,CAAC,EAAE,OAAO,CAAA;CAClB"}

package/build/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/utils.d.ts

@@ -1,72 +0,0 @@
-import { Options, Capabilities } from '@wdio/types';
-import { WebDriverResponse } from './request';
-import type { JSONWPCommandError, SessionFlags } from './types';
-/**
- * start browser session with WebDriver protocol
- */
-export declare function startWebDriverSession(params: Options.WebDriver): Promise<{
-    sessionId: string;
-    capabilities: Capabilities.DesiredCapabilities;
-}>;
-/**
- * check if WebDriver requests was successful
- * @param  {Number}  statusCode status code of request
- * @param  {Object}  body       body payload of response
- * @return {Boolean}            true if request was successful
- */
-export declare function isSuccessfulResponse(statusCode?: number, body?: WebDriverResponse): boolean;
-/**
- * creates the base prototype for the webdriver monad
- */
-export declare function getPrototype({ isW3C, isChrome, isFirefox, isMobile, isSauce, isSeleniumStandalone }: Partial<SessionFlags>): Record<string, PropertyDescriptor>;
-/**
- * helper method to determine the error from webdriver response
- * @param  {Object} body body object
- * @return {Object} error
- */
-export declare function getErrorFromResponseBody(body: any): Error;
-export declare class CustomRequestError extends Error {
-    constructor(body: WebDriverResponse);
-}
-/**
- * return all supported flags and return them in a format so we can attach them
- * to the instance protocol
- * @param  {Object} options   driver instance or option object containing these flags
- * @return {Object}           prototype object
- */
-export declare function getEnvironmentVars({ isW3C, isMobile, isIOS, isAndroid, isChrome, isFirefox, isSauce, isSeleniumStandalone }: Partial<SessionFlags>): {
-    isW3C: {
-        value: boolean | undefined;
-    };
-    isMobile: {
-        value: boolean | undefined;
-    };
-    isIOS: {
-        value: boolean | undefined;
-    };
-    isAndroid: {
-        value: boolean | undefined;
-    };
-    isFirefox: {
-        value: boolean | undefined;
-    };
-    isChrome: {
-        value: boolean | undefined;
-    };
-    isSauce: {
-        value: boolean | undefined;
-    };
-    isSeleniumStandalone: {
-        value: boolean | undefined;
-    };
-};
-/**
- * get human readable message from response error
- * @param {Error} err response error
- */
-export declare const getSessionError: (err: JSONWPCommandError, params?: Partial<Options.WebDriver>) => string;
-/**
- * return timeout error with information about the executing command on which the test hangs
- */
-export declare const getTimeoutError: (error: Error, requestOptions: Options.RequestLibOptions) => Error;
-//# sourceMappingURL=utils.d.ts.map

package/build/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAGnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAI7C,OAAO,KAAK,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAW/D;;GAEG;AACH,wBAAsB,qBAAqB,CAAE,MAAM,EAAE,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,YAAY,CAAC,mBAAmB,CAAA;CAAE,CAAC,CAmEtJ;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAE,UAAU,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,iBAAiB,WA4DlF;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,oBAAoB,EAAE,EAAE,OAAO,CAAC,YAAY,CAAC,sCAyC3H;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAE,IAAI,EAAE,GAAG,SAclD;AAGD,qBAAa,kBAAmB,SAAQ,KAAK;gBAC7B,IAAI,EAAE,iBAAiB;CAetC;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,oBAAoB,EAAE,EAAE,OAAO,CAAC,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;EAWlJ;AAED;;;GAGG;AACH,eAAO,MAAM,eAAe,QAAS,kBAAkB,WAAU,QAAQ,iBAAiB,CAAC,WAmD1F,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,eAAe,UAAW,KAAK,kBAAkB,QAAQ,iBAAiB,KAAG,KASzF,CAAA"}