@applitools/spec-driver-selenium 1.2.0 → 1.3.3

package/CHANGELOG.md

@@ -3,6 +3,27 @@
 ## Unreleased
 
 
+## 1.3.3 - 2022/1/12
+
+- add support of selenium 4 `ShadowRoot` objects
+
+## 1.3.2 - 2022/1/12
+
+- no changes
+
+## 1.3.1 - 2022/1/12
+
+- use chromedriver instead of selenium docker container for testing
+- fix tests for selenium 3
+- fix `getCapabilities` for selenium 3
+- updated to @applitools/types@1.0.23 (from 1.0.20)
+- updated to @applitools/utils@1.2.11 (from 1.2.4)
+
+## 1.3.0 - 2021/11/17
+
+- implement `getCapabilities` and `getBarsHeight` instead of `getDriverInfo`
+- updated to @applitools/types@1.0.20 (from 1.0.19)
+
 ## 1.2.0 - 2021/11/10
 
 - updated to @applitools/types@1.0.19 (from 1.0.15)

package/dist/spec-driver.js

@@ -30,12 +30,18 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.build = exports.performAction = exports.getElementText = exports.getElementAttribute = exports.getElementRegion = exports.getOrientation = exports.waitUntilDisplayed = exports.scrollIntoView = exports.type = exports.hover = exports.click = exports.takeScreenshot = exports.visit = exports.getUrl = exports.getTitle = exports.getDriverInfo = exports.getCookies = exports.setWindowSize = exports.getWindowSize = exports.findElements = exports.findElement = exports.childContext = exports.parentContext = exports.mainContext = exports.executeScript = exports.isEqualElements = exports.isStaleElementError = exports.transformSelector = exports.transformDriver = exports.isSelector = exports.isElement = exports.isDriver = void 0;
+exports.build = exports.performAction = exports.getElementText = exports.getElementAttribute = exports.getElementRegion = exports.getOrientation = exports.getBarsHeight = exports.waitUntilDisplayed = exports.scrollIntoView = exports.type = exports.hover = exports.click = exports.takeScreenshot = exports.visit = exports.getUrl = exports.getTitle = exports.getCapabilities = exports.getDriverInfo = exports.getCookies = exports.setWindowSize = exports.getWindowSize = exports.findElements = exports.findElement = exports.childContext = exports.parentContext = exports.mainContext = exports.executeScript = exports.isEqualElements = exports.isStaleElementError = exports.transformSelector = exports.transformDriver = exports.isSelector = exports.isElement = exports.isDriver = void 0;
+const Selenium = __importStar(require("selenium-webdriver"));
 const utils = __importStar(require("@applitools/utils"));
 // #region HELPERS
 const byHash = ['className', 'css', 'id', 'js', 'linkText', 'name', 'partialLinkText', 'tagName', 'xpath'];
 function extractElementId(element) {
-    return element.getId();
+    return isElement(element) ? element.getId() : element['shadow-6066-11e4-a52e-4f735466cecf'];
+}
+function transformShadowRoot(driver, shadowRoot) {
+    return utils.types.has(shadowRoot, 'shadow-6066-11e4-a52e-4f735466cecf')
+        ? new Selenium.WebElement(driver, shadowRoot['shadow-6066-11e4-a52e-4f735466cecf'])
+        : shadowRoot;
 }
 // #endregion
 // #region UTILITY
@@ -57,6 +63,9 @@ function transformDriver(driver) {
     driver.getExecutor().defineCommand('getSessionDetails', 'GET', '/session/:sessionId');
     driver.getExecutor().defineCommand('getOrientation', 'GET', '/session/:sessionId/orientation');
     driver.getExecutor().defineCommand('getSystemBars', 'GET', '/session/:sessionId/appium/device/system_bars');
+    driver.getExecutor().defineCommand('getWindowSize', 'GET', '/session/:sessionId/window/current/size');
+    driver.getExecutor().defineCommand('setWindowSize', 'POST', '/session/:sessionId/window/current/size');
+    driver.getExecutor().defineCommand('setWindowPosition', 'POST', '/session/:sessionId/window/current/position');
     driver.getExecutor().defineCommand('performTouch', 'POST', '/session/:sessionId/touch/perform');
     driver.getExecutor().defineCommand('executeCdp', 'POST', '/session/:sessionId/chromium/send_command_and_get_result');
     if (process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION === '3') {
@@ -125,7 +134,7 @@ async function childContext(driver, element) {
 exports.childContext = childContext;
 async function findElement(driver, selector, parent) {
     try {
-        const root = parent !== null && parent !== void 0 ? parent : driver;
+        const root = parent ? transformShadowRoot(driver, parent) : driver;
         return await root.findElement(selector);
     }
     catch (err) {
@@ -137,36 +146,41 @@ async function findElement(driver, selector, parent) {
 }
 exports.findElement = findElement;
 async function findElements(driver, selector, parent) {
-    const root = parent !== null && parent !== void 0 ? parent : driver;
+    const root = parent ? transformShadowRoot(driver, parent) : driver;
     return root.findElements(selector);
 }
 exports.findElements = findElements;
 async function getWindowSize(driver) {
     try {
-        const window = driver.manage().window();
-        if (utils.types.isFunction(window.getSize)) {
-            return await window.getSize();
-        }
-        else {
-            const rect = await window.getRect();
-            return { width: rect.width, height: rect.height };
-        }
+        const rect = await driver.manage().window().getRect();
+        return { width: rect.width, height: rect.height };
     }
-    catch (err) {
-        // workaround for Appium
-        const cmd = require('selenium-webdriver/lib/command');
-        return driver.execute(new cmd.Command(cmd.Name.GET_WINDOW_SIZE).setParameter('windowHandle', 'current'));
+    catch (_a) {
+        const { Command } = require('selenium-webdriver/lib/command');
+        const getWindowSizeCommand = new Command('getWindowSize');
+        const size = driver.manage().window().getSize
+            ? await driver.manage().window().getSize()
+            : await driver.execute(getWindowSizeCommand);
+        return { width: size.width, height: size.height };
     }
 }
 exports.getWindowSize = getWindowSize;
 async function setWindowSize(driver, size) {
-    const window = driver.manage().window();
-    if (utils.types.isFunction(window.setRect)) {
-        await window.setRect({ x: 0, y: 0, width: size.width, height: size.height });
+    try {
+        await driver.manage().window().setRect({ x: 0, y: 0, width: size.width, height: size.height });
     }
-    else {
-        await window.setPosition(0, 0);
-        await window.setSize(size.width, size.height);
+    catch (_a) {
+        const { Command } = require('selenium-webdriver/lib/command');
+        const setWindowPositionCommand = new Command('setWindowPosition').setParameters({ x: 0, y: 0 });
+        if (driver.manage().window().setPosition)
+            await driver.manage().window().setPosition(0, 0);
+        else
+            await driver.execute(setWindowPositionCommand);
+        const setWindowSizeCommand = new Command('setWindowSize').setParameters(Object.assign({}, size));
+        if (driver.manage().window().setSize)
+            await driver.manage().window().setSize(size.width, size.height);
+        else
+            await driver.execute(setWindowSizeCommand);
     }
 }
 exports.setWindowSize = setWindowSize;
@@ -180,7 +194,9 @@ async function getCookies(driver, context) {
     }
     else {
         const { Command } = require('selenium-webdriver/lib/command');
-        const executeCdpCommand = new Command('executeCdp').setParameters({ cmd: 'Network.getAllCookies', params: {} });
+        const executeCdpCommand = new Command('executeCdp')
+            .setParameter('cmd', 'Network.getAllCookies')
+            .setParameter('params', {});
         const response = process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION === '3'
             ? await driver.schedule(executeCdpCommand)
             : await driver.execute(executeCdpCommand);
@@ -200,56 +216,24 @@ async function getCookies(driver, context) {
 }
 exports.getCookies = getCookies;
 async function getDriverInfo(driver) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
     const session = await driver.getSession();
-    const capabilities = await driver.getCapabilities();
-    const desiredCapabilities = (_a = capabilities.get('desired')) !== null && _a !== void 0 ? _a : {};
-    const platformName = (_c = (_b = capabilities.get('platformName')) !== null && _b !== void 0 ? _b : capabilities.get('platform')) !== null && _c !== void 0 ? _c : desiredCapabilities.platformName;
-    const isMobile = ['android', 'ios'].includes(platformName === null || platformName === void 0 ? void 0 : platformName.toLowerCase());
-    const info = {
-        sessionId: session.getId(),
-        isMobile,
-        isNative: isMobile && !capabilities.get('browserName'),
-        deviceName: (_d = desiredCapabilities.deviceName) !== null && _d !== void 0 ? _d : capabilities.get('deviceName'),
-        platformName,
-        platformVersion: capabilities.get('platformVersion'),
-        browserName: (_e = capabilities.get('browserName')) !== null && _e !== void 0 ? _e : desiredCapabilities === null || desiredCapabilities === void 0 ? void 0 : desiredCapabilities.browserName,
-        browserVersion: (_f = capabilities.get('browserVersion')) !== null && _f !== void 0 ? _f : capabilities.get('version'),
-    };
-    if (info.isNative) {
+    return { sessionId: session.getId() };
+}
+exports.getDriverInfo = getDriverInfo;
+async function getCapabilities(driver) {
+    try {
         const { Command } = require('selenium-webdriver/lib/command');
-        let details;
-        if (capabilities.has('viewportRect') && capabilities.has('pixelRatio') && capabilities.has('statBarHeight')) {
-            details = {
-                viewportRect: capabilities.get('viewportRect'),
-                pixelRatio: capabilities.get('pixelRatio'),
-                statBarHeight: capabilities.get('statBarHeight'),
-            };
-        }
-        else {
-            const getSessionDetailsCommand = new Command('getSessionDetails');
-            details =
-                process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION === '3'
-                    ? await driver.schedule(getSessionDetailsCommand)
-                    : await driver.execute(getSessionDetailsCommand);
-        }
-        info.pixelRatio = details.pixelRatio;
-        try {
-            const getSystemBarsCommand = new Command('getSystemBars');
-            const { statusBar, navigationBar } = process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION === '3'
-                ? await driver.schedule(getSystemBarsCommand)
-                : await driver.execute(getSystemBarsCommand);
-            info.statusBarHeight = statusBar.visible ? statusBar.height : 0;
-            info.navigationBarHeight = navigationBar.visible ? navigationBar.height : 0;
-        }
-        catch (err) {
-            info.statusBarHeight = (_j = (_g = details.statBarHeight) !== null && _g !== void 0 ? _g : (_h = details.viewportRect) === null || _h === void 0 ? void 0 : _h.top) !== null && _j !== void 0 ? _j : 0;
-            info.navigationBarHeight = 0;
-        }
+        const getSessionDetailsCommand = new Command('getSessionDetails');
+        return process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION === '3'
+            ? await driver.schedule(getSessionDetailsCommand)
+            : await driver.execute(getSessionDetailsCommand);
+    }
+    catch (_a) {
+        const capabilities = await driver.getCapabilities();
+        return Array.from(capabilities.keys()).reduce((obj, key) => Object.assign(obj, { key: capabilities.get(key) }), {});
     }
-    return info;
 }
-exports.getDriverInfo = getDriverInfo;
+exports.getCapabilities = getCapabilities;
 async function getTitle(driver) {
     return driver.getTitle();
 }
@@ -298,13 +282,24 @@ async function scrollIntoView(driver, element, align = false) {
 }
 exports.scrollIntoView = scrollIntoView;
 async function waitUntilDisplayed(driver, selector, timeout) {
-    const { until } = require('selenium-webdriver');
     const element = await findElement(driver, selector);
-    await driver.wait(until.elementIsVisible(element), timeout);
+    await driver.wait(Selenium.until.elementIsVisible(element), timeout);
 }
 exports.waitUntilDisplayed = waitUntilDisplayed;
 // #endregion
 // #region MOBILE COMMANDS
+async function getBarsHeight(driver) {
+    const { Command } = require('selenium-webdriver/lib/command');
+    const getSystemBarsCommand = new Command('getSystemBars');
+    const { statusBar, navigationBar } = process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION === '3'
+        ? await driver.schedule(getSystemBarsCommand)
+        : await driver.execute(getSystemBarsCommand);
+    return {
+        statusBarHeight: statusBar.visible ? statusBar.height : 0,
+        navigationBarHeight: navigationBar.visible ? navigationBar.height : 0,
+    };
+}
+exports.getBarsHeight = getBarsHeight;
 async function getOrientation(driver) {
     const { Command } = require('selenium-webdriver/lib/command');
     const getOrientationCommand = new Command('getOrientation');
@@ -357,7 +352,6 @@ const browserOptionsNames = {
 };
 async function build(env) {
     var _a;
-    const { Builder } = require('selenium-webdriver');
     const parseEnv = require('@applitools/test-utils/src/parse-env');
     const { browser, capabilities, url, attach, proxy, configurable = true, appium = false, args = [], headless, } = parseEnv(Object.assign(Object.assign({}, env), { legacy: (_a = env.legacy) !== null && _a !== void 0 ? _a : process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION === '3' }));
     const desiredCapabilities = Object.assign({}, capabilities);
@@ -379,7 +373,7 @@ async function build(env) {
     if (appium && browser === 'chrome') {
         desiredCapabilities['appium:chromeOptions'] = { w3c: false };
     }
-    const builder = new Builder().withCapabilities(desiredCapabilities);
+    const builder = new Selenium.Builder().withCapabilities(desiredCapabilities);
     if (url && !attach)
         builder.usingServer(url.href);
     if (proxy) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/spec-driver-selenium",
-  "version": "1.2.0",
+  "version": "1.3.3",
   "keywords": [
     "selenium",
     "selenium-webdriver",
@@ -41,9 +41,11 @@
     "lint": "eslint '**/*.ts'",
     "build": "ttsc",
     "test": "mocha ./test/**/*.spec.ts --no-timeouts -r ts-node/register -r @applitools/test-utils/mocha-hooks/docker",
-    "setup": "yarn docker:setup",
+    "setup": "yarn chromedriver:setup",
+    "chromedriver:setup": "chromedriver --port=4444 --url-base=/wd/hub &",
     "docker:setup": "node ../scripts/scripts/generate-docker-compose-config.js && docker-compose up -d",
     "docker:teardown": "docker-compose down",
+    "upgrade:framework": "if [ ! -z $APPLITOOLS_SELENIUM_MAJOR_VERSION ]; then packagejson=`cat package.json`; yarn upgrade --no-lockfile selenium-webdriver@$APPLITOOLS_SELENIUM_MAJOR_VERSION; echo \"$packagejson\" > package.json; fi",
     "deps": "bongo deps",
     "gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='spec-selenium spec-selenium@3' -f links='types utils test-utils'",
     "gh:publish": "gh workflow run publish.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='spec-selenium'",
@@ -57,19 +59,20 @@
     }
   },
   "dependencies": {
-    "@applitools/types": "1.0.19",
-    "@applitools/utils": "1.2.4"
+    "@applitools/types": "1.0.23",
+    "@applitools/utils": "1.2.11"
   },
   "devDependencies": {
-    "@applitools/api-extractor": "^1.2.2",
-    "@applitools/scripts": "1.0.1",
-    "@applitools/sdk-release-kit": "0.13.4",
-    "@applitools/test-utils": "1.0.9",
+    "@applitools/api-extractor": "^1.2.6",
+    "@applitools/scripts": "1.1.0",
+    "@applitools/sdk-release-kit": "0.13.10",
+    "@applitools/test-utils": "1.0.10",
     "@types/mocha": "^9.0.0",
     "@types/node": "^16.10.2",
     "@types/selenium-webdriver": "^4.0.15",
     "@typescript-eslint/eslint-plugin": "^4.15.1",
     "@typescript-eslint/parser": "^4.15.1",
+    "chromedriver": "^96",
     "eslint": "^7.9.0",
     "eslint-config-prettier": "^7.2.0",
     "eslint-plugin-mocha-no-only": "^1.1.1",
@@ -78,10 +81,10 @@
     "husky": "^4.3.7",
     "mocha": "^9.1.2",
     "prettier": "^2.4.1",
-    "selenium-webdriver": "^4.0.0",
+    "selenium-webdriver": "^4.1.1",
     "ts-node": "^10.2.1",
     "ttypescript": "^1.5.12",
-    "typescript": "^4.5.1-rc"
+    "typescript": "^4.5.4"
   },
   "peerDependencies": {
     "selenium-webdriver": ">=3.6.0"

package/types/index.d.ts

@@ -11,12 +11,13 @@ export function executeScript(driver: Driver, script: string | ((arg: any) => an
 export function mainContext(driver: Driver): Promise<Driver>;
 export function parentContext(driver: Driver): Promise<Driver>;
 export function childContext(driver: Driver, element: Element): Promise<Driver>;
-export function findElement(driver: Driver, selector: Selector, parent: Element): Promise<Element>;
-export function findElements(driver: Driver, selector: Selector, parent: Element): Promise<Array<Element>>;
+export function findElement(driver: Driver, selector: Selector, parent?: Element): Promise<Element>;
+export function findElements(driver: Driver, selector: Selector, parent?: Element): Promise<Array<Element>>;
 export function getWindowSize(driver: Driver): Promise<import('@applitools/types').Size>;
 export function setWindowSize(driver: Driver, size: import('@applitools/types').Size): Promise<void>;
-export function getCookies(driver: Driver, context: boolean): Promise<Array<import('@applitools/types').Cookie>>;
+export function getCookies(driver: Driver, context?: boolean): Promise<Array<import('@applitools/types').Cookie>>;
 export function getDriverInfo(driver: Driver): Promise<import('@applitools/types').DriverInfo>;
+export function getCapabilities(driver: Driver): Promise<Record<string, any>>;
 export function getTitle(driver: Driver): Promise<string>;
 export function getUrl(driver: Driver): Promise<string>;
 export function visit(driver: Driver, url: string): Promise<void>;
@@ -26,6 +27,7 @@ export function hover(driver: Driver, element: Element | Selector): Promise<void
 export function type(driver: Driver, element: Element | Selector, keys: string): Promise<void>;
 export function scrollIntoView(driver: Driver, element: Element | Selector, align: boolean): Promise<void>;
 export function waitUntilDisplayed(driver: Driver, selector: Selector, timeout: number): Promise<void>;
+export function getBarsHeight(driver: Driver): Promise<{ statusBarHeight: number; navigationBarHeight: number; }>;
 export function getOrientation(driver: Driver): Promise<"portrait" | "landscape">;
 export function getElementRegion(_driver: Driver, element: Element): Promise<import('@applitools/types').Region>;
 export function getElementAttribute(_driver: Driver, element: Element, attr: string): Promise<string>;