@percy/webdriver-utils 1.27.1-beta.0 → 1.27.2

package/dist/index.js

@@ -1,9 +1,7 @@
 import ProviderResolver from './providers/providerResolver.js';
 import utils from '@percy/sdk-utils';
-import { camelcase } from '@percy/config/utils';
 export default class WebdriverUtils {
-  log = utils.logger('webdriver-utils:main');
-  constructor({
+  static async automateScreenshot({
     sessionId,
     commandExecutorUrl,
     capabilities,
@@ -14,36 +12,21 @@ export default class WebdriverUtils {
     options = {},
     buildInfo = {}
   }) {
-    this.sessionId = sessionId;
-    this.commandExecutorUrl = commandExecutorUrl;
-    this.capabilities = capabilities;
-    this.sessionCapabilites = sessionCapabilites;
-    this.snapshotName = snapshotName;
-    const camelCasedOptions = {};
-    Object.keys(options).forEach(key => {
-      let newKey = camelcase(key);
-      camelCasedOptions[newKey] = options[key];
-    });
-    this.options = camelCasedOptions;
-    this.clientInfo = clientInfo;
-    this.environmentInfo = environmentInfo;
-    this.buildInfo = buildInfo;
-  }
-  async automateScreenshot() {
+    const log = utils.logger('webdriver-utils: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 ...`);
+      log.info(`[${snapshotName}] : Starting automate screenshot ...`);
+      const automate = ProviderResolver.resolve(sessionId, commandExecutorUrl, capabilities, sessionCapabilites, clientInfo, environmentInfo, options, buildInfo);
+      log.debug(`[${snapshotName}] : Resolved provider ...`);
       await automate.createDriver();
-      this.log.debug(`[${this.snapshotName}] : Created driver ...`);
-      const comparisonData = await automate.screenshot(this.snapshotName, this.options);
+      log.debug(`[${snapshotName}] : Created driver ...`);
+      const comparisonData = await automate.screenshot(snapshotName, 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()}`);
+      log.error(`[${snapshotName}] : Error - ${e.message}`);
+      log.error(`[${snapshotName}] : Error Log - ${e.toString()}`);
     }
   }
 }

package/dist/metadata/metaDataResolver.js

@@ -5,7 +5,7 @@ export default class MetaDataResolver {
     var _capabilities$platfor, _capabilities$device, _capabilities$device$;
     if (!driver) throw new Error('Please pass a Driver object');
     const platform = opts.platformName || opts.platform;
-    if (['ios', 'android'].includes(platform.toLowerCase()) || ['ios', 'android'].includes(capabilities === null || capabilities === void 0 ? void 0 : (_capabilities$platfor = capabilities.platformName) === null || _capabilities$platfor === void 0 ? void 0 : _capabilities$platfor.toLowerCase()) || ['ipad', 'iphone'].includes(capabilities === null || capabilities === void 0 ? void 0 : (_capabilities$device = capabilities.device) === null || _capabilities$device === void 0 ? void 0 : (_capabilities$device$ = _capabilities$device.toString()) === null || _capabilities$device$ === void 0 ? void 0 : _capabilities$device$.toLowerCase())) {
+    if (['ios', 'android'].includes(platform.toLowerCase()) || ['ios', 'android'].includes(capabilities === null || capabilities === void 0 ? void 0 : (_capabilities$platfor = capabilities.platformName) === null || _capabilities$platfor === void 0 ? void 0 : _capabilities$platfor.toLowerCase()) || ['ipad', 'iphone'].includes(capabilities === null || capabilities === void 0 ? void 0 : (_capabilities$device = capabilities.device) === null || _capabilities$device === void 0 ? void 0 : (_capabilities$device$ = _capabilities$device.toString()) === null || _capabilities$device$ === void 0 ? void 0 : _capabilities$device$.toLowerCase()) || (opts === null || opts === void 0 ? void 0 : opts.deviceName) !== undefined) {
       return new MobileMetaData(driver, capabilities);
     } else {
       return new DesktopMetaData(driver, capabilities);

package/dist/providers/automateProvider.js

@@ -3,10 +3,8 @@ import GenericProvider from './genericProvider.js';
 import Cache from '../util/cache.js';
 import Tile from '../util/tile.js';
 import NormalizeData from '../metadata/normalizeData.js';
+import TimeIt from '../util/timing.js';
 const log = utils.logger('webdriver-utils:automateProvider');
-const {
-  TimeIt
-} = utils;
 export default class AutomateProvider extends GenericProvider {
   constructor(sessionId, commandExecutorUrl, capabilities, sessionCapabilites, clientInfo, environmentInfo, options, buildInfo) {
     super(sessionId, commandExecutorUrl, capabilities, sessionCapabilites, clientInfo, environmentInfo, options, buildInfo);

package/dist/util/cache.js

@@ -1,7 +1,4 @@
-import utils from '@percy/sdk-utils';
-const {
-  Undefined
-} = utils;
+import Undefined from '../util/validations.js';
 export default class Cache {
   static cache = {};
 

package/dist/util/timing.js

@@ -0,0 +1,44 @@
+import { Undefined } from './validations.js';
+export default class TimeIt {
+  static data = {};
+  static enabled = process.env.PERCY_METRICS === 'true';
+  static async run(store, func) {
+    if (!this.enabled) return await func();
+    const t1 = Date.now();
+    try {
+      return await func();
+    } finally {
+      if (Undefined(this.data[store])) this.data[store] = [];
+      this.data[store].push(Date.now() - t1);
+    }
+  }
+  static min(store) {
+    return Math.min(...this.data[store]);
+  }
+  static max(store) {
+    return Math.max(...this.data[store]);
+  }
+  static avg(store) {
+    const vals = this.data[store];
+    return vals.reduce((a, b) => a + b, 0) / vals.length;
+  }
+  static summary({
+    includeVals
+  } = {}) {
+    const agg = {};
+    for (const key of Object.keys(this.data)) {
+      agg[key] = {
+        min: this.min(key),
+        max: this.max(key),
+        avg: this.avg(key),
+        count: this.data[key].length
+      };
+      if (includeVals) agg[key].vals = this.data[key];
+    }
+    return agg;
+  }
+  static reset() {
+    this.data = {};
+  }
+}
+;

package/dist/util/validations.js

@@ -0,0 +1,4 @@
+export function Undefined(obj) {
+  return obj === undefined;
+}
+export default Undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/webdriver-utils",
-  "version": "1.27.1-beta.0",
+  "version": "1.27.2",
   "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.1-beta.0",
-    "@percy/sdk-utils": "1.27.1-beta.0"
+    "@percy/config": "1.27.2",
+    "@percy/sdk-utils": "1.27.2"
   },
-  "gitHead": "fc67a213ca35419285cba8a8eb563cf5b4958420"
+  "gitHead": "cb64b0c124a5ee1fcb14b130a1fa8e33d26a7284"
 }