@percy/webdriver-utils 1.31.5 → 1.31.6-beta.5

package/LICENSE

@@ -0,0 +1,18 @@
+Copyright © Perceptual Inc.
+
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge, publish, distribute,
+sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
+OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/metadata/normalizeData.js

@@ -1,3 +1,28 @@
+const OS_VERSION_MAP = {
+  winxp: 'XP',
+  win7: '7',
+  win8: '8',
+  'win8.1': '8.1',
+  win10: '10',
+  win11: '11',
+  win12: '12',
+  mactho: 'Tahoe',
+  macsqa: 'Sequoia',
+  macson: 'Sonoma',
+  macven: 'Ventura',
+  macmty: 'Monterey',
+  macbsr: 'Big Sur',
+  maccat: 'Catalina',
+  macmo: 'Mojave',
+  machs: 'High Sierra',
+  macsie: 'Sierra',
+  macelc: 'El Capitan',
+  macyos: 'Yosemite',
+  macmav: 'Mavericks',
+  macml: 'Mountain Lion',
+  maclion: 'Lion',
+  macsl: 'Snow Leopard'
+};
 export default class NormalizeData {
   osRollUp(os) {
     if (os.toLowerCase().startsWith('win')) {
@@ -11,6 +36,10 @@ export default class NormalizeData {
     }
     return os;
   }
+  osVersionRollUp(osVersion) {
+    const normVersion = osVersion.toLowerCase();
+    return OS_VERSION_MAP[normVersion] || osVersion;
+  }
   browserRollUp(browserName, device) {
     if (device) {
       if (browserName !== null && browserName !== void 0 && browserName.toLowerCase().includes('chrome')) {

package/dist/providers/genericProvider.js

@@ -9,9 +9,11 @@ export default class GenericProvider {
   clientInfoDetails = new Set();
   environmentInfoDetails = new Set();
   constructor(args) {
+    var _this$options;
     Object.assign(this, args);
     this.addClientInfo(this.clientInfo);
     this.addEnvironmentInfo(this.environmentInfo);
+    this.platforms = this.sortPlatforms(((_this$options = this.options) === null || _this$options === void 0 ? void 0 : _this$options.platforms) || []);
     this._markedPercy = false;
     this.metaData = null;
     this.debugUrl = null;
@@ -25,6 +27,22 @@ export default class GenericProvider {
     this.removeElementShiftFactor = 50000;
     this.initialScrollLocation = null;
   }
+
+  // Sort platforms so that entries without browserVersion or with 'latest' come last
+  // As we want to prioritize specific versions first while matching
+  sortPlatforms(platforms) {
+    const isMissingOrLatest = v => {
+      if (!v) return true;
+      const s = String(v).toLowerCase();
+      return s.includes('latest');
+    };
+    return [...platforms].sort((a, b) => {
+      const aFlag = isMissingOrLatest(a === null || a === void 0 ? void 0 : a.browserVersion);
+      const bFlag = isMissingOrLatest(b === null || b === void 0 ? void 0 : b.browserVersion);
+      if (aFlag === bFlag) return 0; // keep original order when both are same group
+      return aFlag ? 1 : -1; // push missing/latest to the end
+    });
+  }
   addDefaultOptions() {
     this.options.freezeAnimation = this.options.freezeAnimatedImage || this.options.freezeAnimation || false;
   }
@@ -122,14 +140,14 @@ export default class GenericProvider {
   async percyScreenshotEnd(name, error) {
     return await TimeIt.run('percyScreenshotEnd', async () => {
       try {
-        var _this$buildInfo, _this$options;
+        var _this$buildInfo, _this$options2;
         await this.browserstackExecutor('percyScreenshot', {
           name,
           percyScreenshotUrl: (_this$buildInfo = this.buildInfo) === null || _this$buildInfo === void 0 ? void 0 : _this$buildInfo.url,
           status: error ? 'failure' : 'success',
           statusMessage: error ? `${error}` : '',
           state: 'end',
-          sync: (_this$options = this.options) === null || _this$options === void 0 ? void 0 : _this$options.sync
+          sync: (_this$options2 = this.options) === null || _this$options2 === void 0 ? void 0 : _this$options2.sync
         });
       } catch (e) {
         log.debug(`[${name}] : Could not execute percyScreenshot command for Automate`);
@@ -231,7 +249,7 @@ export default class GenericProvider {
     this.debugUrl = 'https://localhost/v1';
   }
   async doTransformations() {
-    var _this$options2;
+    var _this$options3;
     const hideScrollbarStyle = `
     /* Hide scrollbar for Chrome, Safari and Opera */
     ::-webkit-scrollbar {
@@ -252,7 +270,7 @@ export default class GenericProvider {
       script: jsScript,
       args: []
     });
-    if ((_this$options2 = this.options) !== null && _this$options2 !== void 0 && _this$options2.fullPage || this.isIOS()) {
+    if ((_this$options3 = this.options) !== null && _this$options3 !== void 0 && _this$options3.fullPage || this.isIOS()) {
       await this.getInitialScrollLocation();
     }
   }
@@ -280,11 +298,11 @@ export default class GenericProvider {
     }
   }
   async getRegionObjectFromBoundingBox(selector, element) {
-    var _this$options3;
+    var _this$options4;
     const scaleFactor = await this.metaData.devicePixelRatio();
     let scrollX = 0,
       scrollY = 0;
-    if ((_this$options3 = this.options) !== null && _this$options3 !== void 0 && _this$options3.fullPage) {
+    if ((_this$options4 = this.options) !== null && _this$options4 !== void 0 && _this$options4.fullPage) {
       scrollX = this.initialScrollLocation.value[0];
       scrollY = this.initialScrollLocation.value[1];
     }
@@ -320,14 +338,14 @@ export default class GenericProvider {
     return regionsArray;
   }
   async updatePageShiftFactor(location, scaleFactor, scrollFactors) {
-    var _this$options4;
+    var _this$options5;
     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.isIOS() ? 0 : -(scrollFactors.value[0] * scaleFactor);
-    if (this.isIOS() && !((_this$options4 = this.options) !== null && _this$options4 !== void 0 && _this$options4.fullPage)) {
+    if (this.isIOS() && !((_this$options5 = this.options) !== null && _this$options5 !== void 0 && _this$options5.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;
@@ -337,7 +355,7 @@ export default class GenericProvider {
     }
   }
   async getRegionObject(selector, elementId) {
-    var _this$options5;
+    var _this$options6;
     const scaleFactor = await this.metaData.devicePixelRatio();
     const rect = await this.driver.rect(elementId);
     const location = {
@@ -351,7 +369,7 @@ export default class GenericProvider {
     let scrollX = 0,
       scrollY = 0;
     const scrollFactors = await this.getScrollDetails();
-    if ((_this$options5 = this.options) !== null && _this$options5 !== void 0 && _this$options5.fullPage) {
+    if ((_this$options6 = this.options) !== null && _this$options6 !== void 0 && _this$options6.fullPage) {
       scrollX = scrollFactors.value[0];
       scrollY = scrollFactors.value[1];
     }
@@ -417,6 +435,42 @@ export default class GenericProvider {
     }
     return elementsArray;
   }
+  resolvePercyBrowserCustomNameFor({
+    osName,
+    osVersion,
+    browserName,
+    browserVersion,
+    deviceName,
+    isMobile
+  }) {
+    if (this.platforms.length === 0) return null;
+    const norm = v => v.toString().toLowerCase(); // normalize
+    const match = (userInput, output) => {
+      if (!userInput) return true;
+      return norm(userInput) === norm(output);
+    };
+    const includes = (a, b) => {
+      const na = norm(a);
+      const nb = norm(b);
+      return na.includes(nb);
+    };
+    for (const platform of this.platforms) {
+      const percyBrowserCustomName = platform.percyBrowserCustomName;
+      const pDevice = platform.deviceName || '';
+      const pOsName = platform.osName || '';
+      const pOsVersion = (platform.osVersion || '').toString();
+      const pBrowserName = platform.browserName || '';
+      const pBrowserVersion = (platform.browserVersion || '').toString();
+      if (match(pOsName, osName) && match(pBrowserName, browserName) && match(pOsVersion, osVersion) && (!pBrowserVersion || pBrowserVersion.toLowerCase() === 'latest' || includes(browserVersion, pBrowserVersion))) {
+        if (isMobile) {
+          if (!match(pDevice, deviceName)) continue;
+          return percyBrowserCustomName;
+        }
+        return percyBrowserCustomName;
+      }
+    }
+    return null;
+  }
   async getTag(tagData) {
     var _automateCaps$os_vers;
     if (!this.automateResults) throw new Error('Comparison tag details not available');
@@ -424,7 +478,7 @@ export default class GenericProvider {
     const normalizeTags = new NormalizeData();
     let deviceName = this.automateResults.deviceName;
     const osName = normalizeTags.osRollUp(automateCaps.os);
-    const osVersion = (_automateCaps$os_vers = automateCaps.os_version) === null || _automateCaps$os_vers === void 0 ? void 0 : _automateCaps$os_vers.split('.')[0];
+    const osVersion = normalizeTags.osVersionRollUp((_automateCaps$os_vers = automateCaps.os_version) === null || _automateCaps$os_vers === void 0 ? void 0 : _automateCaps$os_vers.split('.')[0]);
     const browserName = normalizeTags.browserRollUp(automateCaps.browserName, tagData.device);
     const browserVersion = normalizeTags.browserVersionOrDeviceNameRollup(automateCaps.browserVersion, deviceName, tagData.device);
     if (!tagData.device) {
@@ -439,6 +493,16 @@ export default class GenericProvider {
     };
     const resolution = tagData.resolution;
     const orientation = tagData.orientation || automateCaps.deviceOrientation || 'landscape';
+    log.debug(`Tag Details - Device: ${deviceName}, OS: ${osName}, ` + `OS Version: ${osVersion}, Browser: ${browserName}, ` + `Browser Version: ${browserVersion}, Width: ${width}, ` + `Height: ${height}, Orientation: ${orientation}, ` + `Resolution: ${resolution}`);
+    const percyBrowserCustomName = this.resolvePercyBrowserCustomNameFor({
+      osName,
+      osVersion,
+      browserName,
+      browserVersion,
+      deviceName,
+      isMobile: !!tagData.device
+    });
+    log.debug(`Resolved percyBrowserCustomName: ${percyBrowserCustomName}`);
     return {
       name: deviceName,
       osName,
@@ -448,7 +512,8 @@ export default class GenericProvider {
       orientation,
       browserName,
       browserVersion,
-      resolution
+      resolution,
+      percyBrowserCustomName
     };
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/webdriver-utils",
-  "version": "1.31.5",
+  "version": "1.31.6-beta.5",
   "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.31.5",
-    "@percy/sdk-utils": "1.31.5"
+    "@percy/config": "1.31.6-beta.5",
+    "@percy/sdk-utils": "1.31.6-beta.5"
   },
-  "gitHead": "835297c48a25843d8c719d6b476134c603721d13"
+  "gitHead": "fbcc28ce81ae902a32a5856c46efa0de6ae19300"
 }