@percy/webdriver-utils 1.27.0-beta.1 → 1.27.0

package/dist/index.js

@@ -31,12 +31,16 @@ export default class WebdriverUtils {
   }
   async automateScreenshot() {
     try {
+      const startTime = Date.now();
       this.log.info(`[${this.snapshotName}] : Starting automate screenshot ...`);
       const automate = ProviderResolver.resolve(this.sessionId, this.commandExecutorUrl, this.capabilities, this.sessionCapabilites, this.clientInfo, this.environmentInfo, this.options, this.buildInfo);
       this.log.debug(`[${this.snapshotName}] : Resolved provider ...`);
       await automate.createDriver();
       this.log.debug(`[${this.snapshotName}] : Created driver ...`);
-      return await automate.screenshot(this.snapshotName, this.options);
+      const comparisonData = await automate.screenshot(this.snapshotName, this.options);
+      comparisonData.metadata.cliScreenshotStartTime = startTime;
+      comparisonData.metadata.cliScreenshotEndTime = Date.now();
+      return comparisonData;
     } catch (e) {
       this.log.error(`[${this.snapshotName}] : Error - ${e.message}`);
       this.log.error(`[${this.snapshotName}] : Error Log - ${e.toString()}`);

package/dist/providers/automateProvider.js

@@ -89,14 +89,16 @@ export default class AutomateProvider extends GenericProvider {
     });
   }
   async getTiles(headerHeight, footerHeight, fullscreen) {
+    var _responseValue$metada;
     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 response = await TimeIt.run('percyScreenshot:screenshot', async () => {
       return await this.browserstackExecutor('percyScreenshot', {
         state: 'screenshot',
         percyBuildId: this.buildInfo.id,
         screenshotType: 'singlepage',
-        scaleFactor: await this.metaData.devicePixelRatio(),
+        scaleFactor: dpr,
         options: this.options
       });
     });
@@ -107,10 +109,11 @@ 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) {
       tiles.push(new Tile({
-        statusBarHeight: 0,
-        navBarHeight: 0,
+        statusBarHeight: tileResponse.header_height || 0,
+        navBarHeight: tileResponse.footer_height || 0,
         headerHeight,
         footerHeight,
         fullscreen,
@@ -118,9 +121,13 @@ export default class AutomateProvider extends GenericProvider {
       }));
     }
 
+    const metadata = {
+      windowHeight: Math.ceil(windowHeight * dpr)
+    };
     return {
       tiles: tiles,
-      domInfoSha: tileResponse.dom_sha
+      domInfoSha: tileResponse.dom_sha,
+      metadata: metadata
     };
   }
   async browserstackExecutor(action, args) {

package/dist/providers/genericProvider.js

@@ -132,7 +132,8 @@ export default class GenericProvider {
       },
       environmentInfo: [...this.environmentInfo].join('; '),
       clientInfo: [...this.clientInfo].join(' '),
-      domInfoSha: tiles.domInfoSha
+      domInfoSha: tiles.domInfoSha,
+      metadata: tiles.metadata || null
     };
   }
 
@@ -141,6 +142,14 @@ export default class GenericProvider {
     // execute script and return dom content
     return 'dummyValue';
   }
+  async getWindowHeight() {
+    // execute script and return window height
+    return await this.driver.executeScript({
+      script: 'return window.innerHeight',
+      args: []
+    });
+    ;
+  }
   async getTiles(headerHeight, footerHeight, fullscreen) {
     if (!this.driver) throw new Error('Driver is null, please initialize driver with createDriver().');
     const base64content = await this.driver.takeScreenshot();
@@ -155,7 +164,10 @@ export default class GenericProvider {
         fullscreen
       })],
       // TODO: Add Generic support sha for contextual diff for non-automate
-      domInfoSha: await this.getDomContent()
+      domInfoSha: await this.getDomContent(),
+      metadata: {
+        windowHeight: await this.getWindowHeight()
+      }
     };
   }
   async getTag() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/webdriver-utils",
-  "version": "1.27.0-beta.1",
+  "version": "1.27.0",
   "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.0-beta.1",
-    "@percy/sdk-utils": "1.27.0-beta.1"
+    "@percy/config": "1.27.0",
+    "@percy/sdk-utils": "1.27.0"
   },
-  "gitHead": "40cdf9c38613ccaf5e3707cd2cd2d2778ffbd5dd"
+  "gitHead": "3b92a894d4cf6dcdedccf42b86aaf61f331535c6"
 }