@wdio/visual-service 2.0.0 → 3.0.1

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @wdio/visual-service
 
+## 3.0.1
+
+### Patch Changes
+
+- c8fdcd3: Fix to override visibility/display value
+- Updated dependencies [c8fdcd3]
+  - webdriver-image-comparison@4.0.2
+
+## 3.0.0
+
+### Major Changes
+
+- fd74a35: (feat): set default baseline folder next to test file
+
+### Patch Changes
+
+- e93a878: fix default snapshot path to be overwritten through method/service options
+- Updated dependencies [fd74a35]
+  - webdriver-image-comparison@4.0.1
+
 ## 2.0.0
 
 ### Major Changes

package/dist/service.d.ts

@@ -1,11 +1,13 @@
+import type { Frameworks } from '@wdio/types';
 import type { ClassOptions } from 'webdriver-image-comparison';
 import { BaseClass } from 'webdriver-image-comparison';
 export default class WdioImageComparisonService extends BaseClass {
     #private;
     private _browser?;
     private _isNativeContext;
-    constructor(options: ClassOptions);
+    constructor(options: ClassOptions, _: WebdriverIO.Capabilities, config: WebdriverIO.Config);
     before(capabilities: WebdriverIO.Capabilities, _specs: string[], browser: WebdriverIO.Browser | WebdriverIO.MultiRemoteBrowser): Promise<void>;
+    beforeTest(test: Frameworks.Test): void;
     afterCommand(commandName: string, _args: string[], result: number | string, error: any): void;
 }
 //# sourceMappingURL=service.d.ts.map

package/dist/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AAC9D,OAAO,EACH,SAAS,EASZ,MAAM,4BAA4B,CAAA;AAqBnC,MAAM,CAAC,OAAO,OAAO,0BAA2B,SAAQ,SAAS;;IAC7D,OAAO,CAAC,QAAQ,CAAC,CAAsD;IACvE,OAAO,CAAC,gBAAgB,CAAqB;gBAEjC,OAAO,EAAE,YAAY;IAI3B,MAAM,CACR,YAAY,EAAE,WAAW,CAAC,YAAY,EACtC,MAAM,EAAE,MAAM,EAAE,EAChB,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB;IAuBjE,YAAY,CAAE,WAAW,EAAC,MAAM,EAAE,KAAK,EAAC,MAAM,EAAE,EAAE,MAAM,EAAC,MAAM,GAAC,MAAM,EAAE,KAAK,EAAC,GAAG;CA2GpF"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAgB,UAAU,EAAE,MAAM,aAAa,CAAA;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AAC9D,OAAO,EACH,SAAS,EAUZ,MAAM,4BAA4B,CAAA;AAqBnC,MAAM,CAAC,OAAO,OAAO,0BAA2B,SAAQ,SAAS;;IAI7D,OAAO,CAAC,QAAQ,CAAC,CAAsD;IACvE,OAAO,CAAC,gBAAgB,CAAqB;gBAEjC,OAAO,EAAE,YAAY,EAAE,CAAC,EAAE,WAAW,CAAC,YAAY,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM;IAMpF,MAAM,CACR,YAAY,EAAE,WAAW,CAAC,YAAY,EACtC,MAAM,EAAE,MAAM,EAAE,EAChB,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB;IAuBjE,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI;IAKhC,YAAY,CAAE,WAAW,EAAC,MAAM,EAAE,KAAK,EAAC,MAAM,EAAE,EAAE,MAAM,EAAC,MAAM,GAAC,MAAM,EAAE,KAAK,EAAC,GAAG;CA6HpF"}

package/dist/service.js

@@ -1,6 +1,7 @@
 import logger from '@wdio/logger';
 import { expect } from '@wdio/globals';
-import { BaseClass, checkElement, checkFullPageScreen, checkScreen, saveElement, saveFullPageScreen, saveScreen, saveTabbablePage, checkTabbablePage, } from 'webdriver-image-comparison';
+import { dirname, normalize, resolve } from 'node:path';
+import { BaseClass, checkElement, checkFullPageScreen, checkScreen, saveElement, saveFullPageScreen, saveScreen, saveTabbablePage, checkTabbablePage, FOLDERS, } from 'webdriver-image-comparison';
 import { determineNativeContext, getFolders, getInstanceData } from './utils.js';
 import { toMatchScreenSnapshot, toMatchFullPageSnapshot, toMatchElementSnapshot, toMatchTabbablePageSnapshot } from './matcher.js';
 const log = logger('@wdio/visual-service');
@@ -14,10 +15,14 @@ const pageCommands = {
     checkTabbablePage,
 };
 export default class WdioImageComparisonService extends BaseClass {
+    #config;
+    #currentFile;
+    #currentFilePath;
     _browser;
     _isNativeContext;
-    constructor(options) {
+    constructor(options, _, config) {
         super(options);
+        this.#config = config;
         this._isNativeContext = undefined;
     }
     async before(capabilities, _specs, browser) {
@@ -40,12 +45,31 @@ export default class WdioImageComparisonService extends BaseClass {
             toMatchTabbablePageSnapshot,
         });
     }
+    beforeTest(test) {
+        this.#currentFile = test.file;
+        this.#currentFilePath = resolve(dirname(test.file), FOLDERS.DEFAULT.BASE);
+    }
     afterCommand(commandName, _args, result, error) {
         // This is for the cases where in the E2E tests we switch to a WEBVIEW or back to NATIVE_APP context
         if (commandName === 'getContext' && error === undefined && typeof result === 'string') {
             this._isNativeContext = result.includes('NATIVE');
         }
     }
+    #getBaselineFolder() {
+        const isDefaultBaselineFolder = normalize(FOLDERS.DEFAULT.BASE) === this.folders.baselineFolder;
+        const baselineFolder = (isDefaultBaselineFolder ? this.#currentFilePath : this.folders.baselineFolder);
+        /**
+         * support `resolveSnapshotPath` WebdriverIO option
+         * @ref https://webdriver.io/docs/configuration#resolvesnapshotpath
+         *
+         * We only use this option if the baselineFolder is the default one, otherwise the
+         * service option for setting the baselineFolder should be used
+         */
+        if (typeof this.#config.resolveSnapshotPath === 'function' && this.#currentFile && isDefaultBaselineFolder) {
+            return this.#config.resolveSnapshotPath(this.#currentFile, '.png');
+        }
+        return baselineFolder;
+    }
     async #extendMultiremoteBrowser(capabilities) {
         const browser = this._browser;
         const browserNames = Object.keys(capabilities);
@@ -89,7 +113,7 @@ export default class WdioImageComparisonService extends BaseClass {
                     },
                     getElementRect: this.getElementRect.bind(currentBrowser),
                     screenShot: this.takeScreenshot.bind(currentBrowser),
-                }, instanceData, getFolders(elementOptions, self.folders), element, tag, {
+                }, instanceData, getFolders(elementOptions, self.folders, self.#getBaselineFolder()), element, tag, {
                     wic: self.defaultOptions,
                     method: elementOptions,
                 }, self._isNativeContext);
@@ -104,7 +128,7 @@ export default class WdioImageComparisonService extends BaseClass {
                     },
                     getElementRect: this.getElementRect.bind(currentBrowser),
                     screenShot: this.takeScreenshot.bind(currentBrowser),
-                }, instanceData, getFolders(pageOptions, self.folders), tag, {
+                }, instanceData, getFolders(pageOptions, self.folders, self.#getBaselineFolder()), tag, {
                     wic: self.defaultOptions,
                     method: pageOptions,
                 }, self._isNativeContext);

package/dist/utils.d.ts

@@ -6,7 +6,7 @@ import type { Folders, InstanceData, CheckScreenMethodOptions, SaveScreenMethodO
  * Otherwise, use the values set during instantiation
  */
 type getFolderMethodOptions = CheckElementMethodOptions | CheckFullPageMethodOptions | CheckScreenMethodOptions | SaveElementMethodOptions | SaveFullPageMethodOptions | SaveScreenMethodOptions;
-export declare function getFolders(methodOptions: getFolderMethodOptions, folders: Folders): Folders;
+export declare function getFolders(methodOptions: getFolderMethodOptions, folders: Folders, currentTestPath: string): Folders;
 /**
  * Get the size of a screenshot in pixels without the device pixel ratio
  */

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;AAC9B,wBAAgB,UAAU,CACtB,aAAa,EAAE,sBAAsB,EACrC,OAAO,EAAE,OAAO,GACjB,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;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"}

package/dist/utils.js

@@ -1,8 +1,8 @@
 import { IOS_OFFSETS } from 'webdriver-image-comparison';
-export function getFolders(methodOptions, folders) {
+export function getFolders(methodOptions, folders, currentTestPath) {
     return {
         actualFolder: methodOptions.actualFolder ?? folders.actualFolder,
-        baselineFolder: methodOptions.baselineFolder ?? folders.baselineFolder,
+        baselineFolder: methodOptions.baselineFolder ?? currentTestPath,
         diffFolder: methodOptions.diffFolder ?? folders.diffFolder,
     };
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@wdio/visual-service",
   "author": "Wim Selles - wswebcreation",
   "description": "Image comparison / visual regression testing for WebdriverIO",
-  "version": "2.0.0",
+  "version": "3.0.1",
   "license": "MIT",
   "homepage": "https://webdriver.io/docs/visual-testing",
   "repository": {
@@ -22,7 +22,7 @@
   "dependencies": {
     "@wdio/logger": "^8.24.12",
     "@wdio/types": "^8.26.2",
-    "webdriver-image-comparison": "^4.0.0"
+    "webdriver-image-comparison": "^4.0.2"
   },
   "scripts": {
     "build": "run-s clean build:*",