@wdio/visual-service 9.1.4 → 9.1.6

package/CHANGELOG.md

@@ -1,5 +1,51 @@
 # @wdio/visual-service
 
+## 9.1.6
+
+### Patch Changes
+
+- 0a19d78: Fix `clearRuntimeFolder` clearing the actual and diff folders after each spec/feature execution instead of once before all workers start. This caused only the last spec's visual data to be present in the output when running multiple specs.
+
+  # Committers: 1
+
+  - Wim Selles ([@wswebcreation](https://github.com/wswebcreation))
+
+- ed0bea6: Fix `EISDIR` error when using `resolveSnapshotPath` with the visual service. The service now uses `dirname()` of the resolved path as the baseline folder, preventing it from creating a directory at a path that `expect-webdriverio`'s snapshot service expects to be a file. Fixes #984.
+
+  # Committers: 1
+
+  - Wim Selles ([@wswebcreation](https://github.com/wswebcreation))
+
+- cbf1d22: Fix incomplete `wdio-ics:options` type augmentation on `WebdriverIO.Capabilities`. The global type declaration now uses the `WdioIcsOptions` interface directly, ensuring all supported properties (`logName`, `name`) are available to TypeScript users in both standalone and multiremote configurations. Fixes #732.
+
+  # Committers: 1
+
+  - Wim Selles ([@wswebcreation](https://github.com/wswebcreation))
+
+- Updated dependencies [0a19d78]
+- Updated dependencies [ce74703]
+  - @wdio/image-comparison-core@1.1.4
+
+## 9.1.5
+
+### Patch Changes
+
+- 6ed0469: ## Fix: support `appium:options` nested capability format and `avd` fallback (#1118)
+
+  Appium caps need to be prefixed with `appium:`, but this can feel redundant when you have a lot of caps. So you can also put them inside the `appium:options`-object. This was not supported by the visual module and was reported in #1118. It is now supported.
+
+  The following capabilities are now correctly read from both `appium:`-prefixed top-level format and the nested `appium:options` format:
+
+  - `deviceName`
+  - `nativeWebScreenshot`
+  - `avd` (new, see below)
+
+  Second issue that is fixed is that for Android the `deviceName` could be left away and the `avd` could be provided. This is now also supported where `deviceName` takes priority over `avd` if both are provided.
+
+  # Committers: 1
+
+  - Wim Selles ([@wswebcreation](https://github.com/wswebcreation))
+
 ## 9.1.4
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import type { WicElement } from '@wdio/image-comparison-core';
 import WdioImageComparisonService from './service.js';
-import VisualLauncher from './storybook/launcher.js';
-import type { Output, Result, VisualServiceOptions, WdioCheckFullPageMethodOptions, WdioSaveFullPageMethodOptions, WdioSaveElementMethodOptions, WdioSaveScreenMethodOptions, WdioCheckElementMethodOptions, WdioCheckScreenMethodOptions } from './types.js';
+import VisualLauncher from './launcher.js';
+import type { Output, Result, VisualServiceOptions, WdioIcsOptions, WdioCheckFullPageMethodOptions, WdioSaveFullPageMethodOptions, WdioSaveElementMethodOptions, WdioSaveScreenMethodOptions, WdioCheckElementMethodOptions, WdioCheckScreenMethodOptions } from './types.js';
 import type { WaitForStorybookComponentToBeLoaded } from './storybook/Types.js';
 declare global {
     namespace WebdriverIO {
@@ -50,9 +50,7 @@ declare global {
         interface Element {
         }
         interface Capabilities {
-            'wdio-ics:options'?: {
-                logName?: string;
-            };
+            'wdio-ics:options'?: WdioIcsOptions;
         }
     }
     namespace ExpectWebdriverIO {

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAA;AAC7D,OAAO,0BAA0B,MAAM,cAAc,CAAA;AACrD,OAAO,cAAc,MAAM,yBAAyB,CAAA;AACpD,OAAO,KAAK,EACR,MAAM,EACN,MAAM,EACN,oBAAoB,EACpB,8BAA8B,EAC9B,6BAA6B,EAC7B,4BAA4B,EAC5B,2BAA2B,EAC3B,6BAA6B,EAC7B,4BAA4B,EAC/B,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,mCAAmC,EAAE,MAAM,sBAAsB,CAAA;AAE/E,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,WAAW,CAAC;QAClB,UAAU,WAAW;YACjB;;eAEG;YACH,WAAW,CACP,OAAO,EAAE,UAAU,EACnB,GAAG,EAAE,MAAM,EACX,kBAAkB,CAAC,EAAE,4BAA4B,GAClD,OAAO,CAAC,MAAM,CAAC,CAAC;YAEnB;;eAEG;YACH,UAAU,CACN,GAAG,EAAE,MAAM,EACX,iBAAiB,CAAC,EAAE,2BAA2B,GAChD,OAAO,CAAC,MAAM,CAAC,CAAC;YAEnB;;eAEG;YACH,kBAAkB,CACd,GAAG,EAAE,MAAM,EACX,yBAAyB,CAAC,EAAE,6BAA6B,GAC1D,OAAO,CAAC,MAAM,CAAC,CAAC;YAEnB;;eAEG;YACH,gBAAgB,CACZ,GAAG,EAAE,MAAM,EACX,mBAAmB,CAAC,EAAE,6BAA6B,GACpD,OAAO,CAAC,MAAM,CAAC,CAAC;YAEnB;;eAEG;YACH,YAAY,CACR,OAAO,EAAE,UAAU,EACnB,GAAG,EAAE,MAAM,EACX,mBAAmB,CAAC,EAAE,6BAA6B,GACpD,OAAO,CAAC,MAAM,CAAC,CAAC;YAEnB;;eAEG;YACH,WAAW,CACP,GAAG,EAAE,MAAM,EACX,kBAAkB,CAAC,EAAE,4BAA4B,GAClD,OAAO,CAAC,MAAM,CAAC,CAAC;YAEnB;;eAEG;YACH,mBAAmB,CACf,GAAG,EAAE,MAAM,EACX,oBAAoB,CAAC,EAAE,8BAA8B,GACtD,OAAO,CAAC,MAAM,CAAC,CAAC;YAEnB;;eAEG;YACH,iBAAiB,CACb,GAAG,EAAE,MAAM,EACX,oBAAoB,CAAC,EAAE,8BAA8B,GACtD,OAAO,CAAC,MAAM,CAAC,CAAC;YAEnB;;eAEG;YACH,mCAAmC,CAC/B,OAAO,EAAE,mCAAmC,GAC7C,OAAO,CAAC,IAAI,CAAC,CAAC;SACpB;QACD,UAAU,OAAQ,SAAQ,WAAW;SAAG;QACxC,UAAU,kBAAmB,SAAQ,WAAW;SAAG;QACnD,UAAU,OAAO;SAAG;QACpB,UAAU,YAAY;YAClB,kBAAkB,CAAC,EAAC;gBAChB,OAAO,CAAC,EAAE,MAAM,CAAC;aACpB,CAAA;SACJ;KACJ;IAED,UAAU,iBAAiB,CAAC;QAGxB,UAAU,QAAQ,CAAC,CAAC,EAAE,CAAC;YACnB;;;;;eAKG;YACH,qBAAqB,CACjB,GAAG,EAAE,MAAM,EACX,cAAc,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC,cAAc,CAAC,MAAM,CAAC,EAClE,OAAO,CAAC,EAAE,4BAA4B,GACvC,OAAO,CAAC,CAAC,CAAC,CAAA;YACb,qBAAqB,CACjB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,4BAA4B,GACvC,OAAO,CAAC,CAAC,CAAC,CAAA;YACb;;;;;eAKG;YACH,uBAAuB,CACnB,GAAG,EAAE,MAAM,EACX,cAAc,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC,cAAc,CAAC,MAAM,CAAC,EAClE,OAAO,CAAC,EAAE,8BAA8B,GACzC,OAAO,CAAC,CAAC,CAAC,CAAA;YACb,uBAAuB,CACnB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,8BAA8B,GACzC,OAAO,CAAC,CAAC,CAAC,CAAA;YACb;;;;;eAKG;YACH,sBAAsB,CAClB,GAAG,EAAE,MAAM,EACX,cAAc,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC,cAAc,CAAC,MAAM,CAAC,EAClE,OAAO,CAAC,EAAE,6BAA6B,GACxC,OAAO,CAAC,CAAC,CAAC,CAAA;YACb,sBAAsB,CAClB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,6BAA6B,GACxC,OAAO,CAAC,CAAC,CAAC,CAAA;YACb;;;;;eAKG;YACH,2BAA2B,CACvB,GAAG,EAAE,MAAM,EACX,cAAc,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC,cAAc,CAAC,MAAM,CAAC,EAClE,OAAO,CAAC,EAAE,8BAA8B,GACzC,OAAO,CAAC,CAAC,CAAC,CAAA;YACb,2BAA2B,CACvB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,8BAA8B,GACzC,OAAO,CAAC,CAAC,CAAC,CAAA;SAChB;KACJ;CACJ;AACD,YAAY,EACR,oBAAoB,EACpB,6BAA6B,EAC7B,4BAA4B,EAC5B,8BAA8B,EAC9B,4BAA4B,EAC5B,2BAA2B,EAC3B,6BAA6B,EAChC,CAAA;AAED,eAAe,0BAA0B,CAAA;AACzC,eAAO,MAAM,QAAQ,uBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAA;AAC7D,OAAO,0BAA0B,MAAM,cAAc,CAAA;AACrD,OAAO,cAAc,MAAM,eAAe,CAAA;AAC1C,OAAO,KAAK,EACR,MAAM,EACN,MAAM,EACN,oBAAoB,EACpB,cAAc,EACd,8BAA8B,EAC9B,6BAA6B,EAC7B,4BAA4B,EAC5B,2BAA2B,EAC3B,6BAA6B,EAC7B,4BAA4B,EAC/B,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,mCAAmC,EAAE,MAAM,sBAAsB,CAAA;AAE/E,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,WAAW,CAAC;QAClB,UAAU,WAAW;YACjB;;eAEG;YACH,WAAW,CACP,OAAO,EAAE,UAAU,EACnB,GAAG,EAAE,MAAM,EACX,kBAAkB,CAAC,EAAE,4BAA4B,GAClD,OAAO,CAAC,MAAM,CAAC,CAAC;YAEnB;;eAEG;YACH,UAAU,CACN,GAAG,EAAE,MAAM,EACX,iBAAiB,CAAC,EAAE,2BAA2B,GAChD,OAAO,CAAC,MAAM,CAAC,CAAC;YAEnB;;eAEG;YACH,kBAAkB,CACd,GAAG,EAAE,MAAM,EACX,yBAAyB,CAAC,EAAE,6BAA6B,GAC1D,OAAO,CAAC,MAAM,CAAC,CAAC;YAEnB;;eAEG;YACH,gBAAgB,CACZ,GAAG,EAAE,MAAM,EACX,mBAAmB,CAAC,EAAE,6BAA6B,GACpD,OAAO,CAAC,MAAM,CAAC,CAAC;YAEnB;;eAEG;YACH,YAAY,CACR,OAAO,EAAE,UAAU,EACnB,GAAG,EAAE,MAAM,EACX,mBAAmB,CAAC,EAAE,6BAA6B,GACpD,OAAO,CAAC,MAAM,CAAC,CAAC;YAEnB;;eAEG;YACH,WAAW,CACP,GAAG,EAAE,MAAM,EACX,kBAAkB,CAAC,EAAE,4BAA4B,GAClD,OAAO,CAAC,MAAM,CAAC,CAAC;YAEnB;;eAEG;YACH,mBAAmB,CACf,GAAG,EAAE,MAAM,EACX,oBAAoB,CAAC,EAAE,8BAA8B,GACtD,OAAO,CAAC,MAAM,CAAC,CAAC;YAEnB;;eAEG;YACH,iBAAiB,CACb,GAAG,EAAE,MAAM,EACX,oBAAoB,CAAC,EAAE,8BAA8B,GACtD,OAAO,CAAC,MAAM,CAAC,CAAC;YAEnB;;eAEG;YACH,mCAAmC,CAC/B,OAAO,EAAE,mCAAmC,GAC7C,OAAO,CAAC,IAAI,CAAC,CAAC;SACpB;QACD,UAAU,OAAQ,SAAQ,WAAW;SAAG;QACxC,UAAU,kBAAmB,SAAQ,WAAW;SAAG;QACnD,UAAU,OAAO;SAAG;QACpB,UAAU,YAAY;YAClB,kBAAkB,CAAC,EAAE,cAAc,CAAC;SACvC;KACJ;IAED,UAAU,iBAAiB,CAAC;QAGxB,UAAU,QAAQ,CAAC,CAAC,EAAE,CAAC;YACnB;;;;;eAKG;YACH,qBAAqB,CACjB,GAAG,EAAE,MAAM,EACX,cAAc,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC,cAAc,CAAC,MAAM,CAAC,EAClE,OAAO,CAAC,EAAE,4BAA4B,GACvC,OAAO,CAAC,CAAC,CAAC,CAAA;YACb,qBAAqB,CACjB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,4BAA4B,GACvC,OAAO,CAAC,CAAC,CAAC,CAAA;YACb;;;;;eAKG;YACH,uBAAuB,CACnB,GAAG,EAAE,MAAM,EACX,cAAc,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC,cAAc,CAAC,MAAM,CAAC,EAClE,OAAO,CAAC,EAAE,8BAA8B,GACzC,OAAO,CAAC,CAAC,CAAC,CAAA;YACb,uBAAuB,CACnB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,8BAA8B,GACzC,OAAO,CAAC,CAAC,CAAC,CAAA;YACb;;;;;eAKG;YACH,sBAAsB,CAClB,GAAG,EAAE,MAAM,EACX,cAAc,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC,cAAc,CAAC,MAAM,CAAC,EAClE,OAAO,CAAC,EAAE,6BAA6B,GACxC,OAAO,CAAC,CAAC,CAAC,CAAA;YACb,sBAAsB,CAClB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,6BAA6B,GACxC,OAAO,CAAC,CAAC,CAAC,CAAA;YACb;;;;;eAKG;YACH,2BAA2B,CACvB,GAAG,EAAE,MAAM,EACX,cAAc,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC,cAAc,CAAC,MAAM,CAAC,EAClE,OAAO,CAAC,EAAE,8BAA8B,GACzC,OAAO,CAAC,CAAC,CAAC,CAAA;YACb,2BAA2B,CACvB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,8BAA8B,GACzC,OAAO,CAAC,CAAC,CAAC,CAAA;SAChB;KACJ;CACJ;AACD,YAAY,EACR,oBAAoB,EACpB,6BAA6B,EAC7B,4BAA4B,EAC5B,8BAA8B,EAC9B,4BAA4B,EAC5B,2BAA2B,EAC3B,6BAA6B,EAChC,CAAA;AAED,eAAe,0BAA0B,CAAA;AACzC,eAAO,MAAM,QAAQ,uBAAiB,CAAA"}

package/dist/index.js

@@ -1,4 +1,4 @@
 import WdioImageComparisonService from './service.js';
-import VisualLauncher from './storybook/launcher.js';
+import VisualLauncher from './launcher.js';
 export default WdioImageComparisonService;
 export const launcher = VisualLauncher;

package/dist/launcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAA;AAIvD,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,SAAS;;gBAGrC,OAAO,EAAE,YAAY;IAK3B,SAAS,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,sBAAsB;IAQvF,UAAU;CASnB"}

package/dist/launcher.js

@@ -0,0 +1,22 @@
+import { BaseClass } from '@wdio/image-comparison-core';
+import { prepareStorybook, cleanupStorybook } from './storybook/hooks.js';
+import generateVisualReport from './reporter.js';
+export default class VisualLauncher extends BaseClass {
+    #options;
+    constructor(options) {
+        super(options);
+        this.#options = options;
+    }
+    async onPrepare(config, capabilities) {
+        if (this.#options.clearRuntimeFolder) {
+            this._clearRuntimeFolders();
+        }
+        await prepareStorybook(config, capabilities, this.#options, this.folders);
+    }
+    async onComplete() {
+        cleanupStorybook();
+        if (this.#options.createJsonReportFiles) {
+            new generateVisualReport({ directoryPath: this.folders.actualFolder }).generate();
+        }
+    }
+}

package/dist/service.js

@@ -91,7 +91,7 @@ export default class WdioImageComparisonService extends BaseClass {
          * We also check `this.#config` because for standalone usage of the service, the config is not available
          */
         if (this.#config && typeof this.#config.resolveSnapshotPath === 'function' && this.#currentFile && isDefaultBaselineFolder) {
-            return this.#config.resolveSnapshotPath(this.#currentFile, '.png');
+            return dirname(this.#config.resolveSnapshotPath(this.#currentFile, '.png'));
         }
         return baselineFolder;
     }

package/dist/storybook/hooks.d.ts

@@ -0,0 +1,5 @@
+import type { Capabilities } from '@wdio/types';
+import type { ClassOptions, Folders } from '@wdio/image-comparison-core';
+export declare function prepareStorybook(config: WebdriverIO.Config, capabilities: Capabilities.TestrunnerCapabilities, options: ClassOptions, folders: Folders): Promise<void>;
+export declare function cleanupStorybook(): void;
+//# sourceMappingURL=hooks.d.ts.map

package/dist/storybook/hooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../src/storybook/hooks.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,YAAY,EAA6B,OAAO,EAAE,MAAM,6BAA6B,CAAA;AAcnG,wBAAsB,gBAAgB,CAClC,MAAM,EAAE,WAAW,CAAC,MAAM,EAC1B,YAAY,EAAE,YAAY,CAAC,sBAAsB,EACjD,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,OAAO,GACjB,OAAO,CAAC,IAAI,CAAC,CAsFf;AAED,wBAAgB,gBAAgB,IAAI,IAAI,CAiBvC"}

package/dist/storybook/hooks.js

@@ -0,0 +1,100 @@
+import { rmdirSync } from 'node:fs';
+import logger from '@wdio/logger';
+import { SevereServiceError } from 'webdriverio';
+import { createStorybookCapabilities, createTestFiles, getArgvValue, isCucumberFramework, isStorybookMode, parseSkipStories, scanStorybook, } from './utils.js';
+import { CLIP_SELECTOR, NUM_SHARDS, V6_CLIP_SELECTOR } from '../constants.js';
+const log = logger('@wdio/visual-service');
+export async function prepareStorybook(config, capabilities, options, folders) {
+    const isStorybook = isStorybookMode();
+    const framework = config.framework;
+    const isCucumber = isCucumberFramework(framework);
+    if (isCucumber && isStorybook) {
+        throw new SevereServiceError('\n\nRunning Storybook in combination with the cucumber framework adapter is not supported.\nOnly Jasmine and Mocha are supported.\n\n');
+    }
+    if (!isStorybook) {
+        return;
+    }
+    log.info('Running `@wdio/visual-service` in Storybook mode.');
+    const { storiesJson, storybookUrl, tempDir } = await scanStorybook(config, options);
+    process.env.VISUAL_STORYBOOK_TEMP_SPEC_FOLDER = tempDir;
+    process.env.VISUAL_STORYBOOK_URL = storybookUrl;
+    if (typeof capabilities === 'object' && !Array.isArray(capabilities)) {
+        throw new SevereServiceError('\n\nRunning Storybook in combination with Multiremote is not supported.\nRemove your `capabilities` property from your config or assign an empty array to it like `capabilities: [],`.\n\n');
+    }
+    capabilities.length = 0;
+    log.info('Clearing the current capabilities.');
+    const compareOptions = {
+        blockOutSideBar: options.blockOutSideBar,
+        blockOutStatusBar: options.blockOutStatusBar,
+        blockOutToolBar: options.blockOutToolBar,
+        ignoreAlpha: options.ignoreAlpha,
+        ignoreAntialiasing: options.ignoreAntialiasing,
+        ignoreColors: options.ignoreColors,
+        ignoreLess: options.ignoreLess,
+        ignoreNothing: options.ignoreNothing,
+        rawMisMatchPercentage: options.rawMisMatchPercentage,
+        returnAllCompareData: options.returnAllCompareData,
+        saveAboveTolerance: options.saveAboveTolerance,
+        scaleImagesToSameSize: options.scaleImagesToSameSize,
+    };
+    // --version
+    const versionOption = options?.storybook?.version;
+    const versionArgv = getArgvValue('--version', value => Math.floor(parseFloat(value)));
+    const version = versionOption ?? versionArgv ?? 7;
+    // --numShards
+    const maxInstances = config?.maxInstances ?? 1;
+    const numShardsOption = options?.storybook?.numShards;
+    const numShardsArgv = getArgvValue('--numShards', value => parseInt(value, 10));
+    const numShards = Math.min(numShardsOption || numShardsArgv || NUM_SHARDS, maxInstances);
+    // --clip
+    const clipOption = options?.storybook?.clip;
+    const clipArgv = getArgvValue('--clip', value => value !== 'false');
+    const clip = clipOption ?? clipArgv ?? true;
+    // --clipSelector
+    const clipSelectorOption = options?.storybook?.clipSelector;
+    const clipSelectorArgv = getArgvValue('--clipSelector', value => value);
+    const clipSelector = (clipSelectorOption ?? clipSelectorArgv) ?? (version === 6 ? V6_CLIP_SELECTOR : CLIP_SELECTOR);
+    process.env.VISUAL_STORYBOOK_CLIP_SELECTOR = clipSelector;
+    // --skipStories
+    const skipStoriesOption = options?.storybook?.skipStories;
+    const skipStoriesArgv = getArgvValue('--skipStories', value => value);
+    const skipStories = skipStoriesOption ?? skipStoriesArgv ?? [];
+    const parsedSkipStories = parseSkipStories(skipStories);
+    // --additionalSearchParams
+    const additionalSearchParamsOption = options?.storybook?.additionalSearchParams;
+    const additionalSearchParamsArgv = getArgvValue('--additionalSearchParams', value => new URLSearchParams(value));
+    const additionalSearchParams = additionalSearchParamsOption ?? additionalSearchParamsArgv ?? new URLSearchParams();
+    const getStoriesBaselinePath = options?.storybook?.getStoriesBaselinePath;
+    createTestFiles({
+        additionalSearchParams,
+        clip,
+        clipSelector,
+        compareOptions,
+        directoryPath: tempDir,
+        folders,
+        framework,
+        getStoriesBaselinePath,
+        numShards,
+        skipStories: parsedSkipStories,
+        storiesJson,
+        storybookUrl,
+    });
+    createStorybookCapabilities(capabilities);
+}
+export function cleanupStorybook() {
+    const tempDir = process.env.VISUAL_STORYBOOK_TEMP_SPEC_FOLDER;
+    if (!tempDir) {
+        return;
+    }
+    log.info(`Cleaning up temporary folder for storybook specs: ${tempDir}`);
+    try {
+        rmdirSync(tempDir, { recursive: true });
+        log.info(`Temporary folder for storybook specs has been removed: ${tempDir}`);
+    }
+    catch (err) {
+        log.error(`Failed to remove temporary folder for storybook specs: ${tempDir} due to: ${err.message}`);
+    }
+    delete process.env.VISUAL_STORYBOOK_TEMP_SPEC_FOLDER;
+    delete process.env.VISUAL_STORYBOOK_URL;
+    delete process.env.VISUAL_STORYBOOK_CLIP_SELECTOR;
+}

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AACrF,OAAO,KAAK,EACR,wBAAwB,EACxB,sBAAsB,EACtB,sBAAsB,EAIzB,MAAM,YAAY,CAAA;AAEnB;;;;;GAKG;AAEH,wBAAgB,UAAU,CACtB,aAAa,EAAE,sBAAsB,EACrC,OAAO,EAAE,OAAO,EAChB,eAAe,EAAE,MAAM,GACxB,OAAO,CAMT;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,MAAM,EAAE,iBAAiB,SAAI,GAAG;IAChF,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;AAuFD;;GAEG;AACH,wBAAgB,YAAY,CAAC,YAAY,EAAE,WAAW,CAAC,YAAY,GAAG,GAAG,GAAG,SAAS,CAMpF;AAmCD;;GAEG;AACH,wBAAsB,eAAe,CAAC,EAClC,eAAe,EACf,uBAAuB,EACvB,eAAe,EAClB,EAAE,sBAAsB,GAAG,OAAO,CAAC,YAAY,CAAC,CAoEhD;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAE,IAAI,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAGtG;AAOD,wBAAgB,gBAAgB,CAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,EACvD;IAAE,YAAY,EAAE,WAAW,CAAC,YAAY,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,GAC9D,OAAO,CAuBT;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAC7B,EACI,WAAW,EACX,kBAAkB,EAAE,EAChB,SAAS,EACT,MAAM,EACN,KAAK,GACR,EACD,YAAY,EAAE,EACV,OAAO,EACP,WAAW,EACX,cAAc,EACd,UAAU,EACV,SAAS,EACT,KAAK,EACL,QAAQ,EACR,YAAY,EACZ,eAAe,GAClB,EACD,GAAG,GACN,EAAE,wBAAwB,GAAG,WAAW,CAuB5C"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AACrF,OAAO,KAAK,EACR,wBAAwB,EACxB,sBAAsB,EACtB,sBAAsB,EAIzB,MAAM,YAAY,CAAA;AAEnB;;;;;GAKG;AAEH,wBAAgB,UAAU,CACtB,aAAa,EAAE,sBAAsB,EACrC,OAAO,EAAE,OAAO,EAChB,eAAe,EAAE,MAAM,GACxB,OAAO,CAMT;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,MAAM,EAAE,iBAAiB,SAAI,GAAG;IAChF,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;AAuFD;;GAEG;AACH,wBAAgB,YAAY,CAAC,YAAY,EAAE,WAAW,CAAC,YAAY,GAAG,GAAG,GAAG,SAAS,CAMpF;AA+CD;;GAEG;AACH,wBAAsB,eAAe,CAAC,EAClC,eAAe,EACf,uBAAuB,EACvB,eAAe,EAClB,EAAE,sBAAsB,GAAG,OAAO,CAAC,YAAY,CAAC,CAoEhD;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAE,IAAI,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAGtG;AAOD,wBAAgB,gBAAgB,CAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,EACvD;IAAE,YAAY,EAAE,WAAW,CAAC,YAAY,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,GAC9D,OAAO,CAuBT;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAC7B,EACI,WAAW,EACX,kBAAkB,EAAE,EAChB,SAAS,EACT,MAAM,EACN,KAAK,GACR,EACD,YAAY,EAAE,EACV,OAAO,EACP,WAAW,EACX,cAAc,EACd,UAAU,EACV,SAAS,EACT,KAAK,EACL,QAAQ,EACR,YAAY,EACZ,eAAe,GAClB,EACD,GAAG,GACN,EAAE,wBAAwB,GAAG,WAAW,CAuB5C"}

package/dist/utils.js

@@ -115,6 +115,14 @@ export function getLtOptions(capabilities) {
     const key = Object.keys(capabilities).find((k) => k.toLowerCase() === 'lt:options');
     return key ? capabilities[key] : undefined;
 }
+/**
+ * Get a requested Appium capability value by checking both the `appium:`-prefixed
+ * top-level format and the nested `appium:options` format.
+ */
+function getRequestedAppiumCapability(requestedCapabilities, capName) {
+    return requestedCapabilities[`appium:${capName}`]
+        ?? requestedCapabilities['appium:options']?.[capName];
+}
 /**
  * Get the device name
  */
@@ -140,7 +148,8 @@ function getDeviceName(browserInstance) {
     if (isLambdaTest && ltOptions && capName in ltOptions) {
         deviceName = ltOptions[capName];
     }
-    const { 'appium:deviceName': requestedDeviceName } = requestedCapabilities;
+    const requestedDeviceName = (getRequestedAppiumCapability(requestedCapabilities, 'deviceName')
+        || getRequestedAppiumCapability(requestedCapabilities, 'avd'));
     return (deviceName !== NOT_KNOWN ? deviceName : requestedDeviceName || returnedDeviceName || NOT_KNOWN).toLowerCase();
 }
 /**
@@ -179,7 +188,7 @@ export async function getInstanceData({ browserInstance, initialDeviceRectangles
     const ltOptions = getLtOptions(requestedCapabilities);
     // @TODO: Figure this one out in the future when we know more about the Appium capabilities from LT
     // 20241216: LT doesn't have the option to take a ChromeDriver screenshot, so if it's Android it's always native
-    const nativeWebScreenshot = isAndroid && ltOptions || !!(requestedCapabilities['appium:nativeWebScreenshot']);
+    const nativeWebScreenshot = isAndroid && ltOptions || !!getRequestedAppiumCapability(requestedCapabilities, 'nativeWebScreenshot');
     const platformVersion = (rawPlatformVersion === undefined || rawPlatformVersion === '') ? NOT_KNOWN : rawPlatformVersion.toLowerCase();
     const { devicePixelRatio: mobileDevicePixelRatio, deviceRectangles, } = await getMobileInstanceData({ browserInstance, initialDeviceRectangles, isNativeContext, nativeWebScreenshot });
     devicePixelRatio = isMobile ? mobileDevicePixelRatio : devicePixelRatio;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@wdio/visual-service",
   "author": "Wim Selles - wswebcreation",
   "description": "Image comparison / visual regression testing for WebdriverIO",
-  "version": "9.1.4",
+  "version": "9.1.6",
   "license": "MIT",
   "homepage": "https://webdriver.io/docs/visual-testing",
   "repository": {
@@ -24,7 +24,7 @@
     "@wdio/logger": "^9.18.0",
     "@wdio/types": "^9.20.0",
     "expect-webdriverio": "^5.6.1",
-    "@wdio/image-comparison-core": "1.1.3"
+    "@wdio/image-comparison-core": "1.1.4"
   },
   "scripts": {
     "build": "run-s clean build:*",

package/dist/storybook/launcher.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../../src/storybook/launcher.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,YAAY,EAA8B,MAAM,6BAA6B,CAAA;AAC3F,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAA;AAevD,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,SAAS;;gBAGrC,OAAO,EAAE,YAAY;IAK3B,SAAS,CAAE,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,sBAAsB;IA+FxF,UAAU;CAuBnB"}

package/dist/storybook/launcher.js

@@ -1,122 +0,0 @@
-import { rmdirSync } from 'node:fs';
-import logger from '@wdio/logger';
-import { SevereServiceError } from 'webdriverio';
-import { BaseClass } from '@wdio/image-comparison-core';
-import { createStorybookCapabilities, createTestFiles, getArgvValue, isCucumberFramework, isStorybookMode, parseSkipStories, scanStorybook, } from './utils.js';
-import { CLIP_SELECTOR, NUM_SHARDS, V6_CLIP_SELECTOR } from '../constants.js';
-import generateVisualReport from '../reporter.js';
-const log = logger('@wdio/visual-service');
-export default class VisualLauncher extends BaseClass {
-    #options;
-    constructor(options) {
-        super(options);
-        this.#options = options;
-    }
-    async onPrepare(config, capabilities) {
-        const isStorybook = isStorybookMode();
-        const framework = config.framework;
-        const isCucumber = isCucumberFramework(framework);
-        if (isCucumber && isStorybook) {
-            throw new SevereServiceError('\n\nRunning Storybook in combination with the cucumber framework adapter is not supported.\nOnly Jasmine and Mocha are supported.\n\n');
-        }
-        else if (isStorybook) {
-            log.info('Running `@wdio/visual-service` in Storybook mode.');
-            const { storiesJson, storybookUrl, tempDir } = await scanStorybook(config, this.#options);
-            // Set an environment variable so it can be used in the onComplete hook
-            process.env.VISUAL_STORYBOOK_TEMP_SPEC_FOLDER = tempDir;
-            // Add the storybook URL to the environment variables
-            process.env.VISUAL_STORYBOOK_URL = storybookUrl;
-            // Check the capabilities
-            // Multiremote capabilities are not supported
-            if (typeof capabilities === 'object' && !Array.isArray(capabilities)) {
-                throw new SevereServiceError('\n\nRunning Storybook in combination with Multiremote is not supported.\nRemove your `capabilities` property from your config or assign an empty array to it like `capabilities: [],`.\n\n');
-            }
-            // Clear the capabilities
-            capabilities.length = 0;
-            log.info('Clearing the current capabilities.');
-            // Get compare options from config
-            const compareOptions = {
-                blockOutSideBar: this.#options.blockOutSideBar,
-                blockOutStatusBar: this.#options.blockOutStatusBar,
-                blockOutToolBar: this.#options.blockOutToolBar,
-                ignoreAlpha: this.#options.ignoreAlpha,
-                ignoreAntialiasing: this.#options.ignoreAntialiasing,
-                ignoreColors: this.#options.ignoreColors,
-                ignoreLess: this.#options.ignoreLess,
-                ignoreNothing: this.#options.ignoreNothing,
-                rawMisMatchPercentage: this.#options.rawMisMatchPercentage,
-                returnAllCompareData: this.#options.returnAllCompareData,
-                saveAboveTolerance: this.#options.saveAboveTolerance,
-                scaleImagesToSameSize: this.#options.scaleImagesToSameSize,
-            };
-            // Determine some run options
-            // --version
-            const versionOption = this.#options?.storybook?.version;
-            const versionArgv = getArgvValue('--version', value => Math.floor(parseFloat(value)));
-            const version = versionOption ?? versionArgv ?? 7;
-            // --numShards
-            const maxInstances = config?.maxInstances ?? 1;
-            const numShardsOption = this.#options?.storybook?.numShards;
-            const numShardsArgv = getArgvValue('--numShards', value => parseInt(value, 10));
-            const numShards = Math.min(numShardsOption || numShardsArgv || NUM_SHARDS, maxInstances);
-            // --clip
-            const clipOption = this.#options?.storybook?.clip;
-            const clipArgv = getArgvValue('--clip', value => value !== 'false');
-            const clip = clipOption ?? clipArgv ?? true;
-            // --clipSelector
-            const clipSelectorOption = this.#options?.storybook?.clipSelector;
-            const clipSelectorArgv = getArgvValue('--clipSelector', value => value);
-            // V6 has '#root' as the root element, V7 has '#storybook-root'
-            const clipSelector = (clipSelectorOption ?? clipSelectorArgv) ?? (version === 6 ? V6_CLIP_SELECTOR : CLIP_SELECTOR);
-            // Add the clip selector to the environment variables
-            process.env.VISUAL_STORYBOOK_CLIP_SELECTOR = clipSelector;
-            // --skipStories
-            const skipStoriesOption = this.#options?.storybook?.skipStories;
-            const skipStoriesArgv = getArgvValue('--skipStories', value => value);
-            const skipStories = skipStoriesOption ?? skipStoriesArgv ?? [];
-            const parsedSkipStories = parseSkipStories(skipStories);
-            // --additionalSearchParams
-            const additionalSearchParamsOption = this.#options?.storybook?.additionalSearchParams;
-            const additionalSearchParamsArgv = getArgvValue('--additionalSearchParams', value => new URLSearchParams(value));
-            const additionalSearchParams = additionalSearchParamsOption ?? additionalSearchParamsArgv ?? new URLSearchParams();
-            const getStoriesBaselinePath = this.#options?.storybook?.getStoriesBaselinePath;
-            // Create the test files
-            createTestFiles({
-                additionalSearchParams,
-                clip,
-                clipSelector,
-                compareOptions,
-                directoryPath: tempDir,
-                folders: this.folders,
-                framework,
-                getStoriesBaselinePath,
-                numShards,
-                skipStories: parsedSkipStories,
-                storiesJson,
-                storybookUrl,
-            });
-            // Create the capabilities
-            createStorybookCapabilities(capabilities);
-        }
-    }
-    async onComplete() {
-        const tempDir = process.env.VISUAL_STORYBOOK_TEMP_SPEC_FOLDER;
-        if (tempDir) {
-            log.info(`Cleaning up temporary folder for storybook specs: ${tempDir}`);
-            try {
-                rmdirSync(tempDir, { recursive: true });
-                log.info(`Temporary folder for storybook specs has been removed: ${tempDir}`);
-            }
-            catch (err) {
-                log.error(`Failed to remove temporary folder for storybook specs: ${tempDir} due to: ${err.message}`);
-            }
-            // Remove the environment variables
-            delete process.env.VISUAL_STORYBOOK_TEMP_SPEC_FOLDER;
-            delete process.env.VISUAL_STORYBOOK_URL;
-            delete process.env.VISUAL_STORYBOOK_CLIP_SELECTOR;
-        }
-        if (this.#options.createJsonReportFiles) {
-            new generateVisualReport({ directoryPath: this.folders.actualFolder }).generate();
-        }
-    }
-}