@wdio/visual-service 3.0.1 → 3.0.2

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @wdio/visual-service
 
+## 3.0.2
+
+### Patch Changes
+
+- 14b6ae6: Support BS real device names
+  Fix hide/remove elements
+
 ## 3.0.1
 
 ### Patch Changes

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACR,OAAO,EACP,YAAY,EACZ,wBAAwB,EACxB,uBAAuB,EACvB,0BAA0B,EAC1B,yBAAyB,EACzB,yBAAyB,EACzB,wBAAwB,EAC3B,MAAM,4BAA4B,CAAA;AAOnC;;;;;GAKG;AACH,KAAK,sBAAsB,GACrB,yBAAyB,GACzB,0BAA0B,GAC1B,wBAAwB,GACxB,wBAAwB,GACxB,yBAAyB,GACzB,uBAAuB,CAAC;AAE9B,wBAAgB,UAAU,CACtB,aAAa,EAAE,sBAAsB,EACrC,OAAO,EAAE,OAAO,EAChB,eAAe,EAAE,MAAM,GACxB,OAAO,CAMT;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,iBAAiB,SAAI,GAAG;IAC1E,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACjB,CAKA;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,gBAAgB,EAAE;IAAC,MAAM,EAAC,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAC,GAAG,MAAM,CAOhH;AAkFD;;GAEG;AACH,wBAAsB,eAAe,CAAC,cAAc,EAAE,WAAW,CAAC,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,CA+DhG;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAE,IAAI,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAGtG;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAClC,MAAM,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB,GAC7D,OAAO,CAQT"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACR,OAAO,EACP,YAAY,EACZ,wBAAwB,EACxB,uBAAuB,EACvB,0BAA0B,EAC1B,yBAAyB,EACzB,yBAAyB,EACzB,wBAAwB,EAC3B,MAAM,4BAA4B,CAAA;AAQnC;;;;;GAKG;AACH,KAAK,sBAAsB,GACrB,yBAAyB,GACzB,0BAA0B,GAC1B,wBAAwB,GACxB,wBAAwB,GACxB,yBAAyB,GACzB,uBAAuB,CAAC;AAE9B,wBAAgB,UAAU,CACtB,aAAa,EAAE,sBAAsB,EACrC,OAAO,EAAE,OAAO,EAChB,eAAe,EAAE,MAAM,GACxB,OAAO,CAMT;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,iBAAiB,SAAI,GAAG;IAC1E,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACjB,CAKA;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,gBAAgB,EAAE;IAAC,MAAM,EAAC,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAC,GAAG,MAAM,CAOhH;AA4GD;;GAEG;AACH,wBAAsB,eAAe,CAAC,cAAc,EAAE,WAAW,CAAC,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,CA4DhG;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAE,IAAI,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAGtG;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAClC,MAAM,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB,GAC7D,OAAO,CAQT"}

package/dist/utils.js

@@ -1,4 +1,5 @@
 import { IOS_OFFSETS } from 'webdriver-image-comparison';
+import { NOT_KNOWN } from 'webdriver-image-comparison/dist/helpers/constants.js';
 export function getFolders(methodOptions, folders, currentTestPath) {
     return {
         actualFolder: methodOptions.actualFolder ?? folders.actualFolder,
@@ -86,6 +87,28 @@ async function getMobileInstanceData({ currentBrowser, isAndroid, isMobile }) {
         deviceScreenSize,
     };
 }
+/**
+ * Get the device name
+ */
+function getDeviceName(currentBrowser) {
+    const { capabilities: { 
+    // We use a few `@ts-ignore` here because this is returned by the driver
+    // and not recognized by the types because they are not requested
+    // @ts-ignore
+    deviceName: returnedDeviceName = NOT_KNOWN, }, requestedCapabilities } = currentBrowser;
+    let deviceName = NOT_KNOWN;
+    // First check if it's a BrowserStack session, they don't:
+    // - return the "requested" deviceName in the session capabilities
+    // - don't use the `appium:deviceName` capability
+    const isBrowserStack = 'bstack:options' in requestedCapabilities;
+    const bsOptions = requestedCapabilities['bstack:options'];
+    const capName = 'deviceName';
+    if (isBrowserStack && bsOptions && capName in bsOptions) {
+        deviceName = bsOptions[capName];
+    }
+    const { 'appium:deviceName': requestedDeviceName } = requestedCapabilities;
+    return (deviceName !== NOT_KNOWN ? deviceName : requestedDeviceName || returnedDeviceName || NOT_KNOWN).toLowerCase();
+}
 /**
  * Get the instance data
  */
@@ -112,14 +135,11 @@ export async function getInstanceData(currentBrowser) {
     // @ts-ignore
     app: rawApp = NOT_KNOWN, 
     // @ts-ignore
-    deviceName: rawDeviceName = NOT_KNOWN, 
-    // @ts-ignore
     platformVersion: rawPlatformVersion = NOT_KNOWN, } = currentCapabilities;
-    const { 'appium:deviceName': requestedDeviceName } = requestedCapabilities;
     const appName = rawApp !== NOT_KNOWN
         ? rawApp.replace(/\\/g, '/').split('/').pop().replace(/[^a-zA-Z0-9]/g, '_')
         : NOT_KNOWN;
-    const deviceName = (requestedDeviceName || rawDeviceName || '').toLowerCase();
+    const deviceName = getDeviceName(currentBrowser);
     const nativeWebScreenshot = !!(requestedCapabilities['appium:nativeWebScreenshot']);
     const platformVersion = (rawPlatformVersion === undefined || rawPlatformVersion === '') ? NOT_KNOWN : rawPlatformVersion.toLowerCase();
     const { devicePixelRatio: mobileDevicePixelRatio, devicePlatformRect, deviceScreenSize, } = await getMobileInstanceData({ currentBrowser, isAndroid, isMobile });

package/package.json

@@ -2,7 +2,7 @@
   "name": "@wdio/visual-service",
   "author": "Wim Selles - wswebcreation",
   "description": "Image comparison / visual regression testing for WebdriverIO",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "license": "MIT",
   "homepage": "https://webdriver.io/docs/visual-testing",
   "repository": {