@percy/webdriver-utils 1.27.5-beta.0 → 1.27.5-beta.1

package/dist/driver.js

@@ -71,4 +71,29 @@ export default class Driver {
     const response = JSON.parse((await request(baseUrl, options)).body);
     return response.value;
   }
+  async findElementBoundingBox(using, value) {
+    if (using === 'xpath') {
+      return await this.findElementXpath(value);
+    } else if (using === 'css selector') {
+      return await this.findElementSelector(value);
+    }
+  }
+  async findElementXpath(xpath) {
+    xpath = xpath.replace(/'/g, '"');
+    const command = {
+      script: `return document.evaluate('${xpath}', document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue.getBoundingClientRect();`,
+      args: []
+    };
+    const response = await this.executeScript(command);
+    return response.value;
+  }
+  async findElementSelector(selector) {
+    selector = selector.replace('\\', '\\\\');
+    const command = {
+      script: `return document.querySelector('${selector}').getBoundingClientRect();`,
+      args: []
+    };
+    const response = await this.executeScript(command);
+    return response.value;
+  }
 }

package/dist/providers/genericProvider.js

@@ -21,6 +21,14 @@ export default class GenericProvider {
     this.debugUrl = null;
     this.header = 0;
     this.footer = 0;
+    this.statusBarHeight = 0;
+    this.pageXShiftFactor = 0;
+    this.pageYShiftFactor = 0;
+    this.currentTag = null;
+    this.removeElementShiftFactor = 50000;
+    this.initialScrollFactor = {
+      value: [0, 0]
+    };
   }
   addDefaultOptions() {
     this.options.freezeAnimation = this.options.freezeAnimatedImage || this.options.freezeAnimation || false;
@@ -45,6 +53,22 @@ export default class GenericProvider {
       if (i) this.environmentInfo.add(i);
     }
   }
+  async getInitialPosition() {
+    if (this.currentTag.osName === 'iOS') {
+      this.initialScrollFactor = await this.driver.executeScript({
+        script: 'return [parseInt(window.scrollX), parseInt(window.scrollY)];',
+        args: []
+      });
+    }
+  }
+  async scrollToInitialPosition(x, y) {
+    if (this.currentTag.osName === 'iOS') {
+      await this.driver.executeScript({
+        script: `window.scrollTo(${x}, ${y})`,
+        args: []
+      });
+    }
+  }
   async screenshot(name, {
     ignoreRegionXpaths = [],
     ignoreRegionSelectors = [],
@@ -63,6 +87,8 @@ export default class GenericProvider {
     log.debug(`[${name}] : Tag ${JSON.stringify(tag)}`);
     const tiles = await this.getTiles(this.header, this.footer, fullscreen);
     log.debug(`[${name}] : Tiles ${JSON.stringify(tiles)}`);
+    this.currentTag = tag;
+    this.statusBarHeight = tiles.tiles[0].statusBarHeight;
     const ignoreRegions = await this.findRegions(ignoreRegionXpaths, ignoreRegionSelectors, ignoreRegionElements, customIgnoreRegions);
     const considerRegions = await this.findRegions(considerRegionXpaths, considerRegionSelectors, considerRegionElements, customConsiderRegions);
     await this.setDebugUrl();
@@ -144,29 +170,62 @@ export default class GenericProvider {
   async setDebugUrl() {
     this.debugUrl = 'https://localhost/v1';
   }
+  async doTransformations() {
+    const hideScrollbarStyle = `
+    /* Hide scrollbar for Chrome, Safari and Opera */
+    ::-webkit-scrollbar {
+      display: none !important;
+    }
+
+    /* Hide scrollbar for IE, Edge and Firefox */
+    body, html {
+      -ms-overflow-style: none !important;  /* IE and Edge */
+      scrollbar-width: none !important;  /* Firefox */
+    }`.replace(/\n/g, '');
+    const jsScript = `
+    const e = document.createElement('style');
+    e.setAttribute('class', 'poa-injected');
+    e.innerHTML = '${hideScrollbarStyle}'
+    document.head.appendChild(e);`;
+    await this.driver.executeScript({
+      script: jsScript,
+      args: []
+    });
+  }
+  async undoTransformations(data) {
+    const jsScript = `
+      const n = document.querySelectorAll('${data}');
+      n.forEach((e) => {e.remove()});`;
+    await this.driver.executeScript({
+      script: jsScript,
+      args: []
+    });
+  }
   async findRegions(xpaths, selectors, elements, customLocations) {
-    const xpathRegions = await this.getSeleniumRegionsBy('xpath', xpaths);
-    const selectorRegions = await this.getSeleniumRegionsBy('css selector', selectors);
-    const elementRegions = await this.getSeleniumRegionsByElement(elements);
-    const customRegions = await this.getSeleniumRegionsByLocation(customLocations);
-    return [...xpathRegions, ...selectorRegions, ...elementRegions, ...customRegions];
+    let isRegionPassed = [xpaths, selectors, elements, customLocations].some(regions => regions.length > 0);
+    if (isRegionPassed) {
+      await this.doTransformations();
+      const xpathRegions = await this.getSeleniumRegionsBy('xpath', xpaths);
+      const selectorRegions = await this.getSeleniumRegionsBy('css selector', selectors);
+      const elementRegions = await this.getSeleniumRegionsByElement(elements);
+      const customRegions = await this.getSeleniumRegionsByLocation(customLocations);
+      await this.undoTransformations('.poa-injected');
+      return [...xpathRegions, ...selectorRegions, ...elementRegions, ...customRegions];
+    } else {
+      return [];
+    }
   }
-  async getRegionObject(selector, elementId) {
-    const scaleFactor = parseInt(await this.metaData.devicePixelRatio());
-    const rect = await this.driver.rect(elementId);
-    const location = {
-      x: rect.x,
-      y: rect.y
-    };
-    const size = {
-      height: rect.height,
-      width: rect.width
-    };
+  async getRegionObjectFromBoundingBox(selector, element) {
+    const scaleFactor = await this.metaData.devicePixelRatio();
+    let headerAdjustment = 0;
+    if (this.currentTag.osName === 'iOS') {
+      headerAdjustment = this.statusBarHeight;
+    }
     const coOrdinates = {
-      top: Math.floor(location.y * scaleFactor),
-      bottom: Math.ceil((location.y + size.height) * scaleFactor),
-      left: Math.floor(location.x * scaleFactor),
-      right: Math.ceil((location.x + size.width) * scaleFactor)
+      top: Math.floor(element.y * scaleFactor) + Math.floor(headerAdjustment),
+      bottom: Math.ceil((element.y + element.height) * scaleFactor) + Math.ceil(headerAdjustment),
+      left: Math.floor(element.x * scaleFactor),
+      right: Math.ceil((element.x + element.width) * scaleFactor)
     };
     const jsonObject = {
       selector,
@@ -178,9 +237,9 @@ export default class GenericProvider {
     const regionsArray = [];
     for (const idx in elements) {
       try {
-        const element = await this.driver.findElement(findBy, elements[idx]);
+        const boundingBoxRegion = await this.driver.findElementBoundingBox(findBy, elements[idx]);
         const selector = `${findBy}: ${elements[idx]}`;
-        const region = await this.getRegionObject(selector, element[Object.keys(element)[0]]);
+        const region = await this.getRegionObjectFromBoundingBox(selector, boundingBoxRegion);
         regionsArray.push(region);
       } catch (e) {
         log.warn(`Selenium Element with ${findBy}: ${elements[idx]} not found. Ignoring this ${findBy}.`);
@@ -189,8 +248,57 @@ export default class GenericProvider {
     }
     return regionsArray;
   }
+  async updatePageShiftFactor(location, scaleFactor) {
+    const scrollFactors = await this.driver.executeScript({
+      script: 'return [parseInt(window.scrollX), parseInt(window.scrollY)];',
+      args: []
+    });
+    if (this.currentTag.osName === 'iOS' || this.currentTag.osName === 'OS X' && parseInt(this.currentTag.browserVersion) > 13 && this.currentTag.browserName.toLowerCase() === 'safari') {
+      this.pageYShiftFactor = this.statusBarHeight;
+    } else {
+      this.pageYShiftFactor = this.statusBarHeight - scrollFactors.value[1] * scaleFactor;
+    }
+    this.pageXShiftFactor = this.currentTag.osName === 'iOS' ? 0 : -(scrollFactors.value[0] * scaleFactor);
+    if (this.currentTag.osName === 'iOS') {
+      if (scrollFactors.value[0] !== this.initialScrollFactor.value[0] || scrollFactors.value[1] !== this.initialScrollFactor.value[1]) {
+        this.pageXShiftFactor = -1 * this.removeElementShiftFactor;
+        this.pageYShiftFactor = -1 * this.removeElementShiftFactor;
+      } else if (location.y === 0) {
+        this.pageYShiftFactor += -(scrollFactors.value[1] * scaleFactor);
+      }
+    }
+  }
+  async getRegionObject(selector, elementId) {
+    const scaleFactor = await this.metaData.devicePixelRatio();
+    const rect = await this.driver.rect(elementId);
+    const location = {
+      x: rect.x,
+      y: rect.y
+    };
+    const size = {
+      height: rect.height,
+      width: rect.width
+    };
+    // Update pageShiftFactor Element is not visible in viewport
+    // In case of iOS if the element is not visible in viewport it gives 0 for x-y coordinate.
+    // In case of iOS if the element is partially visible it gives negative x-y coordinate.
+    // Subtracting ScrollY/ScrollX ensures if the element is visible in viewport or not.
+    await this.updatePageShiftFactor(location, scaleFactor);
+    const coOrdinates = {
+      top: Math.floor(location.y * scaleFactor) + Math.floor(this.pageYShiftFactor),
+      bottom: Math.ceil((location.y + size.height) * scaleFactor) + Math.ceil(this.pageYShiftFactor),
+      left: Math.floor(location.x * scaleFactor) + Math.floor(this.pageXShiftFactor),
+      right: Math.ceil((location.x + size.width) * scaleFactor) + Math.ceil(this.pageXShiftFactor)
+    };
+    const jsonObject = {
+      selector,
+      coOrdinates
+    };
+    return jsonObject;
+  }
   async getSeleniumRegionsByElement(elements) {
     const regionsArray = [];
+    await this.getInitialPosition();
     for (let index = 0; index < elements.length; index++) {
       try {
         const selector = `element: ${index}`;
@@ -201,6 +309,7 @@ export default class GenericProvider {
         log.debug(e.toString());
       }
     }
+    await this.scrollToInitialPosition(this.initialScrollFactor.value[0], this.initialScrollFactor.value[1]);
     return regionsArray;
   }
   async getSeleniumRegionsByLocation(customLocations) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/webdriver-utils",
-  "version": "1.27.5-beta.0",
+  "version": "1.27.5-beta.1",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "latest"
+    "tag": "beta"
   },
   "engines": {
     "node": ">=14"
@@ -29,8 +29,8 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@percy/config": "1.27.5-beta.0",
-    "@percy/sdk-utils": "1.27.5-beta.0"
+    "@percy/config": "1.27.5-beta.1",
+    "@percy/sdk-utils": "1.27.5-beta.1"
   },
-  "gitHead": "5fed59aa21112e7854a414306504ce7243df7365"
+  "gitHead": "f5924b050d0c04f8ac63d610af291b32f51565f8"
 }