@applitools/spec-driver-webdriver 1.0.56 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.1.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/spec-driver-webdriver@1.0.57...js/spec-driver-webdriver@1.1.0) (2024-02-18)
+
+
+### Features
+
+* env var to skip deprected jwp commands ([#2200](https://github.com/applitools/eyes.sdk.javascript1/issues/2200)) ([d9123db](https://github.com/applitools/eyes.sdk.javascript1/commit/d9123dbba85679d1c6999718b90b89debb18ed18))
+
+## [1.0.57](https://github.com/applitools/eyes.sdk.javascript1/compare/js/spec-driver-webdriver@1.0.56...js/spec-driver-webdriver@1.0.57) (2024-02-13)
+
+
+### Bug Fixes
+
+* fixed issue with cdp commands on chromium browsers ([#2180](https://github.com/applitools/eyes.sdk.javascript1/issues/2180)) ([550fc77](https://github.com/applitools/eyes.sdk.javascript1/commit/550fc772d3988aae29e6f4a1a11d2a408072dc38))
+
 ## [1.0.56](https://github.com/applitools/eyes.sdk.javascript1/compare/js/spec-driver-webdriver@1.0.55...js/spec-driver-webdriver@1.0.56) (2024-02-06)
 
 

package/dist/spec-driver.js

@@ -74,16 +74,6 @@ function extractEnvironment(capabilities) {
         isW3C,
     };
 }
-function command(method, url, body) {
-    if (getFrameworkMajorVersion() < 8) {
-        const { default: command } = require('webdriver/build/command');
-        return command(method, url, body);
-    }
-    else {
-        const { command } = require('webdriver');
-        return command(method, url, body);
-    }
-}
 function getFrameworkMajorVersion() {
     const version = require('webdriver/package.json').version;
     return Number.parseInt(version);
@@ -144,89 +134,90 @@ function isStaleElementError(error) {
 exports.isStaleElementError = isStaleElementError;
 function toDriver(driver) {
     var _a, _b, _c;
-    if (!utils.types.has(driver, ['sessionId', 'serverUrl']))
-        return driver;
-    const url = new URL(driver.serverUrl);
-    const environment = extractEnvironment(driver.capabilities);
-    const options = {
-        sessionId: driver.sessionId,
-        protocol: url.protocol ? url.protocol.replace(/:$/, '') : undefined,
-        hostname: url.hostname,
-        port: Number(url.port) || undefined,
-        path: url.pathname,
-        capabilities: driver.capabilities,
-        logLevel: 'silent',
-        ...environment,
-    };
-    if (!options.port) {
-        if (options.protocol === 'http')
-            options.port = 80;
-        if (options.protocol === 'https')
-            options.port = 443;
+    let transformedDriver;
+    if (utils.types.has(driver, ['sessionId', 'serverUrl'])) {
+        const url = new URL(driver.serverUrl);
+        const environment = extractEnvironment(driver.capabilities);
+        const options = {
+            sessionId: driver.sessionId,
+            protocol: url.protocol ? url.protocol.replace(/:$/, '') : undefined,
+            hostname: url.hostname,
+            port: Number(url.port) || undefined,
+            path: url.pathname,
+            capabilities: driver.capabilities,
+            logLevel: 'silent',
+            ...environment,
+        };
+        if (!options.port) {
+            if (options.protocol === 'http')
+                options.port = 80;
+            if (options.protocol === 'https')
+                options.port = 443;
+        }
+        if ((_a = driver.proxy) === null || _a === void 0 ? void 0 : _a.url) {
+            const proxyUrl = new URL(driver.proxy.url);
+            proxyUrl.username = (_b = driver.proxy.username) !== null && _b !== void 0 ? _b : proxyUrl.username;
+            proxyUrl.password = (_c = driver.proxy.password) !== null && _c !== void 0 ? _c : proxyUrl.password;
+            const proxyOptions = { ...(0, url_1.parse)(proxyUrl.href), rejectUnauthorized: false };
+            const httpAgent = (0, http_proxy_agent_1.default)(proxyOptions);
+            const httpsAgent = (0, https_proxy_agent_1.default)(proxyOptions);
+            httpsAgent.callback = utils.general.wrap(httpsAgent.callback.bind(httpsAgent), (fn, request, options, ...rest) => {
+                return fn(request, { ...options, rejectUnauthorized: false }, ...rest);
+            });
+            options.agent = { http: httpAgent, https: httpsAgent };
+        }
+        else {
+            const httpAgent = http_1.default.globalAgent;
+            const httpsAgent = new https_1.default.Agent({ rejectUnauthorized: false });
+            options.agent = { http: httpAgent, https: httpsAgent };
+        }
+        const WebDriver = getWebDriver();
+        transformedDriver = WebDriver.attachToSession(options);
+        transformedDriver.original = driver.original;
     }
-    if ((_a = driver.proxy) === null || _a === void 0 ? void 0 : _a.url) {
-        const proxyUrl = new URL(driver.proxy.url);
-        proxyUrl.username = (_b = driver.proxy.username) !== null && _b !== void 0 ? _b : proxyUrl.username;
-        proxyUrl.password = (_c = driver.proxy.password) !== null && _c !== void 0 ? _c : proxyUrl.password;
-        const proxyOptions = { ...(0, url_1.parse)(proxyUrl.href), rejectUnauthorized: false };
-        const httpAgent = (0, http_proxy_agent_1.default)(proxyOptions);
-        const httpsAgent = (0, https_proxy_agent_1.default)(proxyOptions);
-        httpsAgent.callback = utils.general.wrap(httpsAgent.callback.bind(httpsAgent), (fn, request, options, ...rest) => {
-            return fn(request, { ...options, rejectUnauthorized: false }, ...rest);
+    else {
+        // NOTE: this is needed to a rare case when this function is used not on the SecondaryDriver but on a derivative of the Driver
+        transformedDriver = Object.create(driver, {
+            original: { enumerable: false, get: () => driver },
         });
-        options.agent = { http: httpAgent, https: httpsAgent };
     }
-    else {
-        const httpAgent = http_1.default.globalAgent;
-        const httpsAgent = new https_1.default.Agent({ rejectUnauthorized: false });
-        options.agent = { http: httpAgent, https: httpsAgent };
+    if (utils.types.isFunction(transformedDriver, 'addCommand')) {
+        const command = getFrameworkMajorVersion() < 8 ? require('webdriver/build/command').default : require('webdriver').command;
+        transformedDriver.addCommand('_getWindowSize', command('GET', '/session/:sessionId/window/current/size', {
+            command: '_getWindowSize',
+            description: '',
+            ref: '',
+            parameters: [],
+        }));
+        transformedDriver.addCommand('_setWindowSize', command('POST', '/session/:sessionId/window/current/size', {
+            command: '_setWindowSize',
+            parameters: [
+                { name: 'width', type: 'number', required: true, description: '' },
+                { name: 'height', type: 'number', required: true, description: '' },
+            ],
+            description: '',
+            ref: '',
+        }));
+        transformedDriver.addCommand('setWindowPosition', command('POST', '/session/:sessionId/window/current/position', {
+            command: 'setWindowPosition',
+            parameters: [
+                { name: 'x', type: 'number', required: true, description: '' },
+                { name: 'y', type: 'number', required: true, description: '' },
+            ],
+            description: '',
+            ref: '',
+        }));
+        transformedDriver.addCommand('sendCommandAndGetResult', command('POST', '/session/:sessionId/chromium/send_command_and_get_result', {
+            command: 'sendCommandAndGetResult',
+            parameters: [
+                { name: 'cmd', type: 'string', required: true, description: '' },
+                { name: 'params', type: 'object', required: true, description: '' },
+            ],
+            description: 'Send a command to the DevTools debugger and wait for the result.',
+            ref: '',
+        }));
     }
-    const WebDriver = getWebDriver();
-    const attachedDriver = WebDriver.attachToSession(options, undefined, {
-        _getWindowSize: {
-            value: command('GET', '/session/:sessionId/window/current/size', {
-                command: '_getWindowSize',
-                description: '',
-                ref: '',
-                parameters: [],
-            }),
-        },
-        _setWindowSize: {
-            value: command('POST', '/session/:sessionId/window/current/size', {
-                command: '_setWindowSize',
-                parameters: [
-                    { name: 'width', type: 'number', required: true, description: '' },
-                    { name: 'height', type: 'number', required: true, description: '' },
-                ],
-                description: '',
-                ref: '',
-            }),
-        },
-        setWindowPosition: {
-            value: command('POST', '/session/:sessionId/window/current/position', {
-                command: 'setWindowPosition',
-                parameters: [
-                    { name: 'x', type: 'number', required: true, description: '' },
-                    { name: 'y', type: 'number', required: true, description: '' },
-                ],
-                description: '',
-                ref: '',
-            }),
-        },
-        sendCommandAndGetResult: {
-            value: command('POST', '/session/:sessionId/chromium/send_command_and_get_result', {
-                command: 'sendCommandAndGetResult',
-                parameters: [
-                    { name: 'cmd', type: 'string', required: true, description: '' },
-                    { name: 'params', type: 'object', required: true, description: '' },
-                ],
-                description: 'Send a command to the DevTools debugger and wait for the result.',
-                ref: '',
-            }),
-        },
-    });
-    attachedDriver.original = driver.original;
-    return attachedDriver;
+    return transformedDriver;
 }
 exports.toDriver = toDriver;
 function toElement(element) {
@@ -346,7 +337,9 @@ async function getDriverInfo(driver) {
 exports.getDriverInfo = getDriverInfo;
 async function getCapabilities(driver) {
     var _a;
-    const capabilities = await ((_a = driver.getSession) === null || _a === void 0 ? void 0 : _a.call(driver).catch(() => null));
+    const capabilities = utils.general.getEnvValue('SKIP_DEPRECATED_JWP_COMMANDS', 'boolean')
+        ? null
+        : await ((_a = driver.getSession) === null || _a === void 0 ? void 0 : _a.call(driver).catch(() => null));
     return utils.types.isObject(capabilities) ? capabilities : driver.capabilities;
 }
 exports.getCapabilities = getCapabilities;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/spec-driver-webdriver",
-  "version": "1.0.56",
+  "version": "1.1.0",
   "keywords": [
     "webdriver",
     "chrome devtools protocol",