@percy/webdriver-utils 1.27.5-alpha.0 → 1.27.6-alpha.0

package/dist/driver.js

@@ -1,6 +1,5 @@
 import utils from '@percy/sdk-utils';
 import Cache from './util/cache.js';
-import httpsAgent from './util/utils.js';
 const {
   request
 } = utils;
@@ -11,14 +10,20 @@ export default class Driver {
     this.executorUrl = executorUrl.includes('@') ? `https://${executorUrl.split('@')[1]}` : executorUrl;
     this.passedCapabilities = passedCapabilities;
   }
+  static requestPostOptions(command) {
+    return {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json;charset=utf-8'
+      },
+      body: JSON.stringify(command)
+    };
+  }
   async getCapabilites() {
     return await Cache.withCache(Cache.caps, this.sessionId, async () => {
       try {
-        const options = {
-          agent: httpsAgent()
-        };
         const baseUrl = `${this.executorUrl}/session/${this.sessionId}`;
-        const caps = JSON.parse((await request(baseUrl, options)).body);
+        const caps = JSON.parse((await request(baseUrl)).body);
         return caps.value;
       } catch (err) {
         log.warn(`Falling back to legacy protocol, Error: ${err.message}`);
@@ -27,11 +32,8 @@ export default class Driver {
     });
   }
   async getWindowSize() {
-    const options = {
-      agent: httpsAgent()
-    };
     const baseUrl = `${this.executorUrl}/session/${this.sessionId}/window/current/size`;
-    const windowSize = JSON.parse((await request(baseUrl, options)).body);
+    const windowSize = JSON.parse((await request(baseUrl)).body);
     return windowSize;
   }
 
@@ -45,46 +47,26 @@ export default class Driver {
     if (!command.script.includes('browserstack_executor')) {
       command.script = `/* percy_automate_script */ \n ${command.script}`;
     }
-    const options = {
-      method: 'POST',
-      headers: {
-        'Content-Type': 'application/json;charset=utf-8'
-      },
-      agent: httpsAgent(),
-      body: JSON.stringify(command)
-    };
+    const options = Driver.requestPostOptions(command);
     const baseUrl = `${this.executorUrl}/session/${this.sessionId}/execute/sync`;
     const response = JSON.parse((await request(baseUrl, options)).body);
     return response;
   }
   async takeScreenshot() {
-    const options = {
-      agent: httpsAgent()
-    };
     const baseUrl = `${this.executorUrl}/session/${this.sessionId}/screenshot`;
-    const screenShot = JSON.parse((await request(baseUrl, options)).body);
+    const screenShot = JSON.parse((await request(baseUrl)).body);
     return screenShot.value;
   }
   async rect(elementId) {
-    const options = {
-      agent: httpsAgent()
-    };
     const baseUrl = `${this.executorUrl}/session/${this.sessionId}/element/${elementId}/rect`;
-    const response = JSON.parse((await request(baseUrl, options)).body);
+    const response = JSON.parse((await request(baseUrl)).body);
     return response.value;
   }
   async findElement(using, value) {
-    const options = {
-      method: 'POST',
-      headers: {
-        'Content-Type': 'application/json;charset=utf-8'
-      },
-      agent: httpsAgent(),
-      body: JSON.stringify({
-        using,
-        value
-      })
-    };
+    const options = Driver.requestPostOptions({
+      using,
+      value
+    });
     const baseUrl = `${this.executorUrl}/session/${this.sessionId}/element`;
     const response = JSON.parse((await request(baseUrl, options)).body);
     return response.value;

package/dist/index.js

@@ -23,6 +23,7 @@ export default class WebdriverUtils {
       const comparisonData = await automate.screenshot(snapshotName, options);
       comparisonData.metadata.cliScreenshotStartTime = startTime;
       comparisonData.metadata.cliScreenshotEndTime = Date.now();
+      log.debug(`[${snapshotName}] : Comparison Data: ${JSON.stringify(comparisonData)}`);
       return comparisonData;
     } catch (e) {
       log.error(`[${snapshotName}] : Error - ${e.message}`);

package/dist/metadata/desktopMetaData.js

@@ -49,7 +49,7 @@ export default class DesktopMetaData {
   async screenResolution() {
     return await Cache.withCache(Cache.resolution, this.driver.sessionId, async () => {
       const data = await this.driver.executeScript({
-        script: 'return [(window.screen.width * window.devicePixelRatio).toString(), (window.screen.height * window.devicePixelRatio).toString()];',
+        script: 'return [parseInt(window.screen.width * window.devicePixelRatio).toString(), parseInt(window.screen.height * window.devicePixelRatio).toString()];',
         args: []
       });
       const screenInfo = data.value;

package/dist/providers/automateProvider.js

@@ -47,8 +47,7 @@ export default class AutomateProvider extends GenericProvider {
       error = e;
       throw e;
     } finally {
-      var _response, _response$body;
-      await this.percyScreenshotEnd(name, (_response = response) === null || _response === void 0 ? void 0 : (_response$body = _response.body) === null || _response$body === void 0 ? void 0 : _response$body.link, `${error}`);
+      await this.percyScreenshotEnd(name, error);
     }
     return response;
   }
@@ -61,23 +60,38 @@ export default class AutomateProvider extends GenericProvider {
           percyBuildUrl: this.buildInfo.url,
           state: 'begin'
         });
+        // Selenium Hub, set status error Code to 13 if an error is thrown
+        // Handling error with Selenium dialect is != W3C
+        if ((result === null || result === void 0 ? void 0 : result.status) === 13) throw new Error((result === null || result === void 0 ? void 0 : result.value) || 'Got invalid error response');
         this._markedPercy = result.success;
         return result;
       } catch (e) {
+        var _e$response, _JSON$parse, _e$response2;
         log.debug(`[${name}] : Could not mark Automate session as percy`);
         log.error(`[${name}] : error: ${e.toString()}`);
-        return null;
+        /**
+         * - Handling Error when dialect is W3C
+         * ERROR response format from SeleniumHUB `{
+         * sessionId: ...,
+         * status: 13,
+         * value: { error: '', message: ''}
+         * }
+         */
+        const errResponse = (e === null || e === void 0 ? void 0 : (_e$response = e.response) === null || _e$response === void 0 ? void 0 : _e$response.body) && ((_JSON$parse = JSON.parse(e === null || e === void 0 ? void 0 : (_e$response2 = e.response) === null || _e$response2 === void 0 ? void 0 : _e$response2.body)) === null || _JSON$parse === void 0 ? void 0 : _JSON$parse.value) || {};
+        const errMessage = (errResponse === null || errResponse === void 0 ? void 0 : errResponse.message) || (errResponse === null || errResponse === void 0 ? void 0 : errResponse.error) || (e === null || e === void 0 ? void 0 : e.message) || (e === null || e === void 0 ? void 0 : e.error) || (e === null || e === void 0 ? void 0 : e.value) || e.toString();
+        throw new Error(errMessage);
       }
     });
   }
-  async percyScreenshotEnd(name, percyScreenshotUrl, statusMessage = null) {
+  async percyScreenshotEnd(name, error) {
     return await TimeIt.run('percyScreenshotEnd', async () => {
       try {
+        var _this$buildInfo;
         await this.browserstackExecutor('percyScreenshot', {
           name,
-          percyScreenshotUrl,
-          status: percyScreenshotUrl ? 'success' : 'failure',
-          statusMessage,
+          percyScreenshotUrl: (_this$buildInfo = this.buildInfo) === null || _this$buildInfo === void 0 ? void 0 : _this$buildInfo.url,
+          status: error ? 'failure' : 'success',
+          statusMessage: error ? `${error}` : '',
           state: 'end'
         });
       } catch (e) {
@@ -168,10 +182,6 @@ export default class AutomateProvider extends GenericProvider {
     } = await this.metaData.windowSize();
     const resolution = await this.metaData.screenResolution();
     const orientation = (_ref = this.metaData.orientation() || automateCaps.deviceOrientation) === null || _ref === void 0 ? void 0 : _ref.toLowerCase();
-
-    // for android window size only constitutes of browser viewport, hence adding nav / status / url bar heights
-    [this.header, this.footer] = await this.getHeaderFooter(deviceName, osVersion, browserName);
-    height = this.metaData.device() && (osName === null || osName === void 0 ? void 0 : osName.toLowerCase()) === 'android' ? height + this.header + this.footer : height;
     return {
       name: deviceName,
       osName,

package/dist/providers/capabilityManager.js

@@ -0,0 +1,5 @@
+export default class CapabilitiesManager {
+  constructor(capabilities) {
+    this.capabilities = capabilities;
+  }
+}

package/dist/providers/genericProvider.js

@@ -2,12 +2,6 @@ import utils from '@percy/sdk-utils';
 import MetaDataResolver from '../metadata/metaDataResolver.js';
 import Tile from '../util/tile.js';
 import Driver from '../driver.js';
-import Cache from '../util/cache.js';
-import httpsAgent from '../util/utils.js';
-const {
-  request
-} = utils;
-const DEVICES_CONFIG_URL = 'https://storage.googleapis.com/percy-utils/devices.json';
 const log = utils.logger('webdriver-utils:genericProvider');
 export default class GenericProvider {
   clientInfo = new Set();
@@ -133,9 +127,6 @@ export default class GenericProvider {
     } = await this.metaData.windowSize();
     const resolution = await this.metaData.screenResolution();
     const orientation = this.metaData.orientation();
-    [this.header, this.footer] = await this.getHeaderFooter();
-    // for android window size only constitutes of browser viewport, hence adding nav / status / url bar heights
-    height = this.metaData.osName() === 'android' ? height + this.header + this.footer : height;
     return {
       name: this.metaData.deviceName(),
       osName: this.metaData.osName(),
@@ -239,12 +230,4 @@ export default class GenericProvider {
     }
     return elementsArray;
   }
-  async getHeaderFooter(deviceName, osVersion, browserName) {
-    // passing 0 as key, since across different pages and tests, this config will remain same
-    const devicesConfig = await Cache.withCache(Cache.devicesConfig, 0, async () => {
-      return (await request(DEVICES_CONFIG_URL, httpsAgent())).body;
-    });
-    let deviceKey = `${deviceName}-${osVersion}`;
-    return devicesConfig[deviceKey] ? devicesConfig[deviceKey][browserName] ? [devicesConfig[deviceKey][browserName].header, devicesConfig[deviceKey][browserName].footer] : [0, 0] : [0, 0];
-  }
 }

package/dist/util/capabilityValidator.js

@@ -0,0 +1,72 @@
+import fs from 'fs';
+import path from 'path';
+import { colors } from '@percy/logger/utils';
+import semver from 'semver';
+export default class CapabilitiesValidator {
+  constructor(automateCapabilities, sessionCapabilities) {
+    this.automateCapabilities = automateCapabilities;
+    this.sessionCapabilities = sessionCapabilities;
+  }
+  WARN_LOG_LEVEL = 'WARN';
+  ERROR_LOG_LEVEL = 'ERROR';
+  log(message, errorLevel = this.ERROR_LOG_LEVEL) {
+    if (errorLevel === this.WARN_LOG_LEVEL) {
+      console.warn(colors.yellow(message));
+    } else if (errorLevel === this.ERROR_LOG_LEVEL) {
+      console.error(colors.red(message));
+    }
+  }
+  existsInArray(array, value) {
+    if (!array || array.length === 0) return false;
+    return array.some(element => {
+      return element === value;
+    });
+  }
+  validateBrowserOSVersions() {
+    var _this$sessionCapabili, _this$sessionCapabili2;
+    const cwd = process.cwd();
+    const excludeBrowserData = JSON.parse(fs.readFileSync(path.join(cwd, 'packages/webdriver-utils/src/util/exclude_browsers.json')));
+    let {
+      os,
+      osVersion,
+      browserName,
+      browserVersion,
+      deviceName
+    } = this.automateCapabilities;
+    const platform = (_this$sessionCapabili = this.sessionCapabilities) === null || _this$sessionCapabili === void 0 ? void 0 : (_this$sessionCapabili2 = _this$sessionCapabili.platformName) === null || _this$sessionCapabili2 === void 0 ? void 0 : _this$sessionCapabili2.toLowerCase();
+    if (!os || !osVersion || !browserName || !browserVersion) {
+      this.log('OS/Browser Combination is not supported on Percy');
+      throw new Error('OS/Browser Combination is not supported on Percy');
+    }
+    const isMobile = ['ios', 'android'].includes(platform);
+    if (isMobile && !deviceName) {
+      this.log('Device capabilities are incorrect or not supported on Percy');
+      throw new Error('Device capabilities are incorrect or not supported on Percy');
+    }
+    if (excludeBrowserData !== null && excludeBrowserData !== void 0 && excludeBrowserData.os[os]) {
+      const osData = excludeBrowserData === null || excludeBrowserData === void 0 ? void 0 : excludeBrowserData.os[os];
+      if (osData !== null && osData !== void 0 && osData.os_versions) {
+        if (this.existsInArray(osData.os_versions, osVersion)) {
+          this.log(`${os} ${osVersion} is not supported on Percy`);
+          throw new Error(`${os} ${osVersion} is not supported on Percy`);
+        }
+      }
+      if (osData !== null && osData !== void 0 && osData.browsers) {
+        const browserData = osData === null || osData === void 0 ? void 0 : osData.browsers[browserName.toLowerCase()];
+        if (browserData && browserData.min_version === 'all') {
+          this.log(`${browserName} is not supported on Percy`);
+          throw new Error(`${browserName} is not supported on Percy`);
+        } else if (browserData && parseInt(browserVersion, 10) < parseInt(browserData.min_version, 10)) {
+          this.log(`${browserName}: ${browserVersion} is not supported on Percy`);
+          throw new Error(`${browserName}: ${browserVersion} is not supported on Percy`);
+        }
+      }
+      if (osData !== null && osData !== void 0 && osData.device_names) {
+        if (this.existsInArray(osData === null || osData === void 0 ? void 0 : osData.device_names, deviceName)) {
+          this.log(`${deviceName} is not supported on Percy`);
+          throw new Error(`${deviceName} is not supported in Percy`);
+        }
+      }
+    }
+  }
+}

package/dist/util/constants.js

@@ -0,0 +1,7 @@
+export const SELENIUM_TO_API_OS_MAPPING = {
+  MAC: 'OS X',
+  WIN8: 'Windows',
+  XP: 'Windows',
+  WINDOWS: 'Windows',
+  ANY: 'OS X'
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/webdriver-utils",
-  "version": "1.27.5-alpha.0",
+  "version": "1.27.6-alpha.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -29,8 +29,8 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@percy/config": "1.27.5-alpha.0",
-    "@percy/sdk-utils": "1.27.5-alpha.0"
+    "@percy/config": "1.27.6-alpha.0",
+    "@percy/sdk-utils": "1.27.6-alpha.0"
   },
-  "gitHead": "8ecc32db25f708a01192b8454d0fdf9c051f48a0"
+  "gitHead": "415a083dc13e9453990b042a41d6676f6618df0c"
 }

package/dist/util/utils.js

@@ -1,8 +0,0 @@
-import https from 'https';
-export function httpsAgent() {
-  return new https.Agent({
-    minVersion: 'TLSv1.2',
-    maxVersion: 'TLSv1.2'
-  });
-}
-export default httpsAgent;