@applitools/spec-driver-selenium 1.3.2 → 1.3.5

package/dist/spec-driver.js

@@ -30,7 +30,7 @@ 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.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;
+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.waitForSelector = 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
@@ -39,9 +39,9 @@ function extractElementId(element) {
     return isElement(element) ? element.getId() : element['shadow-6066-11e4-a52e-4f735466cecf'];
 }
 function transformShadowRoot(driver, shadowRoot) {
-    return isElement(shadowRoot)
-        ? shadowRoot
-        : new Selenium.WebElement(driver, shadowRoot['shadow-6066-11e4-a52e-4f735466cecf']);
+    return utils.types.has(shadowRoot, 'shadow-6066-11e4-a52e-4f735466cecf')
+        ? new Selenium.WebElement(driver, shadowRoot['shadow-6066-11e4-a52e-4f735466cecf'])
+        : shadowRoot;
 }
 // #endregion
 // #region UTILITY
@@ -68,6 +68,7 @@ function transformDriver(driver) {
     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');
+    driver.getExecutor().defineCommand('setOrientation', 'POST', '/session/:sessionId/orientation/');
     if (process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION === '3') {
         driver.getExecutor().defineCommand('switchToParentFrame', 'POST', '/session/:sessionId/frame/parent');
     }
@@ -150,6 +151,17 @@ async function findElements(driver, selector, parent) {
     return root.findElements(selector);
 }
 exports.findElements = findElements;
+async function waitForSelector(driver, selector, _parent, options) {
+    var _a;
+    if (((_a = options === null || options === void 0 ? void 0 : options.state) !== null && _a !== void 0 ? _a : 'exists') === 'exist') {
+        return driver.wait(Selenium.until.elementLocated(selector), options === null || options === void 0 ? void 0 : options.timeout);
+    }
+    else if ((options === null || options === void 0 ? void 0 : options.state) === 'visible') {
+        const element = await findElement(driver, selector);
+        return driver.wait(Selenium.until.elementIsVisible(element), options === null || options === void 0 ? void 0 : options.timeout);
+    }
+}
+exports.waitForSelector = waitForSelector;
 async function getWindowSize(driver) {
     try {
         const rect = await driver.manage().window().getRect();
@@ -290,16 +302,32 @@ exports.waitUntilDisplayed = waitUntilDisplayed;
 // #region MOBILE COMMANDS
 async function getBarsHeight(driver) {
     const { Command } = require('selenium-webdriver/lib/command');
+    const orientation = await getOrientation(driver);
+    // when calling getSystemBars when orientation is landscape it seems that appium is buggy and returns the wrong dimensions
+    // therefore, we set the orientation to portrait to get the correct systemBars dimensions and we flip back to landscape
+    if (orientation.toLowerCase() === 'landscape') {
+        await setOrientation(driver, 'portrait');
+    }
     const getSystemBarsCommand = new Command('getSystemBars');
     const { statusBar, navigationBar } = process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION === '3'
         ? await driver.schedule(getSystemBarsCommand)
         : await driver.execute(getSystemBarsCommand);
+    if (orientation.toLowerCase() === 'landscape') {
+        await setOrientation(driver, 'landscape');
+    }
     return {
         statusBarHeight: statusBar.visible ? statusBar.height : 0,
         navigationBarHeight: navigationBar.visible ? navigationBar.height : 0,
     };
 }
 exports.getBarsHeight = getBarsHeight;
+async function setOrientation(driver, orientation) {
+    const { Command } = require('selenium-webdriver/lib/command');
+    const setOrientationCommand = new Command('setOrientation').setParameters({ orientation });
+    process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION === '3'
+        ? await driver.schedule(setOrientationCommand)
+        : await driver.execute(setOrientationCommand);
+}
 async function getOrientation(driver) {
     const { Command } = require('selenium-webdriver/lib/command');
     const getOrientationCommand = new Command('getOrientation');
@@ -373,6 +401,9 @@ async function build(env) {
     if (appium && browser === 'chrome') {
         desiredCapabilities['appium:chromeOptions'] = { w3c: false };
     }
+    if (browser === 'chrome' && process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION === '3') {
+        desiredCapabilities['goog:chromeOptions'] = { w3c: false };
+    }
     const builder = new Selenium.Builder().withCapabilities(desiredCapabilities);
     if (url && !attach)
         builder.usingServer(url.href);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/spec-driver-selenium",
-  "version": "1.3.2",
+  "version": "1.3.5",
   "keywords": [
     "selenium",
     "selenium-webdriver",
@@ -41,14 +41,13 @@
     "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 chromedriver:setup",
-    "chromedriver:setup": "chromedriver --port=4444 --url-base=/wd/hub &",
+    "setup": "yarn docker:setup",
     "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'",
+    "gh:publish": "gh workflow run publish-spec-selenium.yml --ref $(git rev-parse --abbrev-ref HEAD)",
     "preversion": "bongo preversion",
     "version": "bongo version",
     "postversion": "bongo postversion --skip-release-notification"
@@ -59,20 +58,19 @@
     }
   },
   "dependencies": {
-    "@applitools/types": "1.0.23",
-    "@applitools/utils": "1.2.11"
+    "@applitools/types": "1.3.0",
+    "@applitools/utils": "1.2.13"
   },
   "devDependencies": {
-    "@applitools/api-extractor": "^1.2.6",
+    "@applitools/api-extractor": "^1.2.7",
+    "@applitools/bongo": "2.0.1",
     "@applitools/scripts": "1.1.0",
-    "@applitools/sdk-release-kit": "0.13.10",
-    "@applitools/test-utils": "1.0.10",
+    "@applitools/test-utils": "1.3.0",
     "@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",

package/types/index.d.ts

@@ -13,6 +13,7 @@ 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 waitForSelector(driver: Driver, selector: Selector, _parent?: Element, options?: import('@applitools/types').WaitOptions): Promise<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>>;

package/CHANGELOG.md

@@ -1,42 +0,0 @@
-# Change Log
-
-## Unreleased
-
-
-## 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)
-- updated to @applitools/utils@1.2.4 (from 1.2.3)
-
-## 1.1.1 - 2021/10/20
-
-- install prettier
-
-## 1.1.0 - 2021/10/12
-
-- change default selenium version
-
-## 1.0.2 - 2021/10/12
-
-- handle non-w3c appium driver
-
-## 1.0.1 - 2021/10/12
-
-- spec driver implementation for selenium framework