@percy/webdriver-utils 1.27.6-beta.0 → 1.27.6

package/dist/providers/automateProvider.js

@@ -100,16 +100,17 @@ export default class AutomateProvider extends GenericProvider {
       }
     });
   }
-  async getTiles(headerHeight, footerHeight, fullscreen) {
-    var _responseValue$metada;
+  async getTiles(fullscreen) {
+    var _this$options;
     if (!this.driver) throw new Error('Driver is null, please initialize driver with createDriver().');
     log.debug('Starting actual screenshotting phase');
     const dpr = await this.metaData.devicePixelRatio();
+    const screenshotType = (_this$options = this.options) !== null && _this$options !== void 0 && _this$options.fullPage ? 'fullpage' : 'singlepage';
     const response = await TimeIt.run('percyScreenshot:screenshot', async () => {
       return await this.browserstackExecutor('percyScreenshot', {
         state: 'screenshot',
         percyBuildId: this.buildInfo.id,
-        screenshotType: 'singlepage',
+        screenshotType: screenshotType,
         scaleFactor: dpr,
         options: this.options
       });
@@ -121,20 +122,19 @@ export default class AutomateProvider extends GenericProvider {
     const tiles = [];
     const tileResponse = JSON.parse(responseValue.result);
     log.debug('Tiles captured successfully');
-    const windowHeight = (responseValue === null || responseValue === void 0 ? void 0 : (_responseValue$metada = responseValue.metadata) === null || _responseValue$metada === void 0 ? void 0 : _responseValue$metada.window_height) || 0;
-    for (let tileData of tileResponse.sha) {
+    for (let tileData of tileResponse.tiles) {
       tiles.push(new Tile({
-        statusBarHeight: tileResponse.header_height || 0,
-        navBarHeight: tileResponse.footer_height || 0,
-        headerHeight,
-        footerHeight,
+        statusBarHeight: tileData.status_bar || 0,
+        navBarHeight: tileData.nav_bar || 0,
+        headerHeight: tileData.header_height || 0,
+        footerHeight: tileData.footer_height || 0,
         fullscreen,
-        sha: tileData.split('-')[0] // drop build id
+        sha: tileData.sha.split('-')[0] // drop build id
       }));
     }
 
     const metadata = {
-      windowHeight: Math.ceil(windowHeight * dpr)
+      screenshotType: screenshotType
     };
     return {
       tiles: tiles,

package/dist/providers/genericProvider.js

@@ -26,9 +26,7 @@ export default class GenericProvider {
     this.pageYShiftFactor = 0;
     this.currentTag = null;
     this.removeElementShiftFactor = 50000;
-    this.initialScrollFactor = {
-      value: [0, 0]
-    };
+    this.initialScrollLocation = null;
   }
   addDefaultOptions() {
     this.options.freezeAnimation = this.options.freezeAnimatedImage || this.options.freezeAnimation || false;
@@ -53,21 +51,28 @@ 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: []
-      });
-    }
+  isIOS() {
+    var _this$currentTag;
+    return ((_this$currentTag = this.currentTag) === null || _this$currentTag === void 0 ? void 0 : _this$currentTag.osName) === 'iOS';
+  }
+  async getScrollDetails() {
+    return 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 getInitialScrollLocation() {
+    if (this.initialScrollLocation) {
+      return this.initialScrollLocation;
     }
+    this.initialScrollLocation = await this.getScrollDetails();
+    return this.initialScrollLocation;
+  }
+  async scrollToPosition(x, y) {
+    await this.driver.executeScript({
+      script: `window.scrollTo(${x}, ${y})`,
+      args: []
+    });
   }
   async screenshot(name, {
     ignoreRegionXpaths = [],
@@ -85,7 +90,7 @@ export default class GenericProvider {
     log.debug('Fetching comparisong tag ...');
     const tag = await this.getTag();
     log.debug(`[${name}] : Tag ${JSON.stringify(tag)}`);
-    const tiles = await this.getTiles(this.header, this.footer, fullscreen);
+    const tiles = await this.getTiles(fullscreen);
     log.debug(`[${name}] : Tiles ${JSON.stringify(tiles)}`);
     this.currentTag = tag;
     this.statusBarHeight = tiles.tiles[0].statusBarHeight;
@@ -125,7 +130,7 @@ export default class GenericProvider {
     });
     ;
   }
-  async getTiles(headerHeight, footerHeight, fullscreen) {
+  async getTiles(fullscreen) {
     if (!this.driver) throw new Error('Driver is null, please initialize driver with createDriver().');
     const base64content = await this.driver.takeScreenshot();
     log.debug('Tiles captured successfully');
@@ -134,8 +139,8 @@ export default class GenericProvider {
         content: base64content,
         statusBarHeight: 0,
         navBarHeight: 0,
-        headerHeight,
-        footerHeight,
+        headerHeight: this.header,
+        footerHeight: this.footer,
         fullscreen
       })],
       // TODO: Add Generic support sha for contextual diff for non-automate
@@ -171,6 +176,7 @@ export default class GenericProvider {
     this.debugUrl = 'https://localhost/v1';
   }
   async doTransformations() {
+    var _this$options;
     const hideScrollbarStyle = `
     /* Hide scrollbar for Chrome, Safari and Opera */
     ::-webkit-scrollbar {
@@ -191,6 +197,9 @@ export default class GenericProvider {
       script: jsScript,
       args: []
     });
+    if ((_this$options = this.options) !== null && _this$options !== void 0 && _this$options.fullPage || this.isIOS()) {
+      await this.getInitialScrollLocation();
+    }
   }
   async undoTransformations(data) {
     const jsScript = `
@@ -216,16 +225,23 @@ export default class GenericProvider {
     }
   }
   async getRegionObjectFromBoundingBox(selector, element) {
+    var _this$options2;
     const scaleFactor = await this.metaData.devicePixelRatio();
+    let scrollX = 0,
+      scrollY = 0;
+    if ((_this$options2 = this.options) !== null && _this$options2 !== void 0 && _this$options2.fullPage) {
+      scrollX = this.initialScrollLocation.value[0];
+      scrollY = this.initialScrollLocation.value[1];
+    }
     let headerAdjustment = 0;
-    if (this.currentTag.osName === 'iOS') {
+    if (this.isIOS()) {
       headerAdjustment = this.statusBarHeight;
     }
     const coOrdinates = {
-      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)
+      top: Math.floor((element.y + scrollY) * scaleFactor) + Math.floor(headerAdjustment),
+      bottom: Math.ceil((element.y + element.height + scrollY) * scaleFactor) + Math.ceil(headerAdjustment),
+      left: Math.floor((element.x + scrollX) * scaleFactor),
+      right: Math.ceil((element.x + element.width + scrollX) * scaleFactor)
     };
     const jsonObject = {
       selector,
@@ -248,19 +264,16 @@ 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') {
+  async updatePageShiftFactor(location, scaleFactor, scrollFactors) {
+    var _this$options3;
+    if (this.isIOS() || 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 = this.isIOS() ? 0 : -(scrollFactors.value[0] * scaleFactor);
+    if (this.isIOS() && !((_this$options3 = this.options) !== null && _this$options3 !== void 0 && _this$options3.fullPage)) {
+      if (scrollFactors.value[0] !== this.initialScrollLocation.value[0] || scrollFactors.value[1] !== this.initialScrollLocation.value[1]) {
         this.pageXShiftFactor = -1 * this.removeElementShiftFactor;
         this.pageYShiftFactor = -1 * this.removeElementShiftFactor;
       } else if (location.y === 0) {
@@ -269,6 +282,7 @@ export default class GenericProvider {
     }
   }
   async getRegionObject(selector, elementId) {
+    var _this$options4;
     const scaleFactor = await this.metaData.devicePixelRatio();
     const rect = await this.driver.rect(elementId);
     const location = {
@@ -279,16 +293,24 @@ export default class GenericProvider {
       height: rect.height,
       width: rect.width
     };
+    let scrollX = 0,
+      scrollY = 0;
+    const scrollFactors = await this.getScrollDetails();
+    if ((_this$options4 = this.options) !== null && _this$options4 !== void 0 && _this$options4.fullPage) {
+      scrollX = scrollFactors.value[0];
+      scrollY = scrollFactors.value[1];
+    }
+
     // 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);
+    await this.updatePageShiftFactor(location, scaleFactor, scrollFactors);
     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)
+      top: Math.floor((location.y + scrollY) * scaleFactor) + Math.floor(this.pageYShiftFactor),
+      bottom: Math.ceil((location.y + size.height + scrollY) * scaleFactor) + Math.ceil(this.pageYShiftFactor),
+      left: Math.floor((location.x + scrollX) * scaleFactor) + Math.floor(this.pageXShiftFactor),
+      right: Math.ceil((location.x + size.width + scrollX) * scaleFactor) + Math.ceil(this.pageXShiftFactor)
     };
     const jsonObject = {
       selector,
@@ -298,7 +320,6 @@ export default class GenericProvider {
   }
   async getSeleniumRegionsByElement(elements) {
     const regionsArray = [];
-    await this.getInitialPosition();
     for (let index = 0; index < elements.length; index++) {
       try {
         const selector = `element: ${index}`;
@@ -309,7 +330,9 @@ export default class GenericProvider {
         log.debug(e.toString());
       }
     }
-    await this.scrollToInitialPosition(this.initialScrollFactor.value[0], this.initialScrollFactor.value[1]);
+    if (this.isIOS()) {
+      await this.scrollToPosition(this.initialScrollLocation.value[0], this.initialScrollLocation.value[1]);
+    }
     return regionsArray;
   }
   async getSeleniumRegionsByLocation(customLocations) {

package/package.json

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