Skip to content

CHANGELOG.md

Latest commit

 

History

History
1615 lines (1075 loc) · 60.4 KB

CHANGELOG.md

File metadata and controls

1615 lines (1075 loc) · 60.4 KB

@wdio/visual-service

9.2.1

Patch Changes

  • d5afb54: ## #1129 Fix TypeError: element.getBoundingClientRect is not a function when a ChainablePromiseElement is passed to checkElement

    When checkElement (or saveElement) was called with a ChainablePromiseElement, the lazy promise-based element reference that WebdriverIO's $() returns, the element was passed directly as an argument to browser.execute() without being awaited first. browser.execute() serializes its arguments for transfer to the browser context and cannot handle a pending Promise, so it arrived in the browser as a plain empty object {} instead of a WebElement reference. This caused element.getBoundingClientRect is not a function because the browser-side scrollElementIntoView script received {} rather than a DOM element.

    Committers: 1

  • Updated dependencies [d5afb54]

9.2.0

Minor Changes

  • 994f4da: ## #857 Support ignore regions for web screenshots

    Add ignore support to all web screenshot methods (saveScreen/checkScreen, saveElement/checkElement, saveFullPageScreen/checkFullPageScreen) so that specified elements can be blocked out during visual comparison. This brings web parity with the native-app ignore-region support that already existed.

    Changes

    • Ignore regions for full-page screenshots: new determineWebFullPageIgnoreRegions function that calculates ignore-region rectangles for full-page screenshots, including a fullPageCropTopPaddingCSS correction for mobile scroll-and-stitch scenarios where the address-bar shadow padding shifts element positions
    • Consolidated ignoreRegionPadding: moved ignoreRegionPadding into BaseWebScreenshotOptions so it is inherited by all web methods instead of being duplicated per method
    • Fix isAndroidNativeWebScreenshot type: ensure nativeWebScreenshot is always a boolean (was accidentally an object for LambdaTest capabilities), preventing ignore-region DPR scaling failures
    • Fix viewport rounding for mobile: restore Math.round() in injectWebviewOverlay and remove Math.min clamping in getMobileViewPortPosition to prevent 1-pixel crop shifts during full-page stitching
    • Fix scrollElementIntoView for scrolled pages: account for currentPosition (existing scroll offset) when computing the target scroll position, so elements are scrolled into view correctly when the page is already scrolled
    • Dismiss Chrome Start Surface on Android: when Chrome's tab-overview UI blocks the webview overlay, automatically press the Android Back button (up to 4 retries) to restore the active tab before measuring the viewport
    • Add hybrid status bar blockout: on hybrid apps the statusbar was not blocked out which could result in flaky tests regarding battery and reception

    Committers: 1

Patch Changes

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

  • 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

  • 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

  • Updated dependencies [0a19d78]

  • Updated dependencies [ce74703]

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

9.1.4

Patch Changes

  • a3bc7a4: ## #1115 Respect alwaysSaveActualImage: false for checkScreen methods

    When using visual matchers like toMatchScreenSnapshot('tag', 0.9) with alwaysSaveActualImage: false, the actual image was still being saved even when the comparison passed within the threshold.

    The root cause was that the matcher's expected threshold was not being passed to the core comparison logic. The core used saveAboveTolerance (defaulting to 0) to decide whether to save images, while the matcher used the user-provided threshold to determine pass/fail - these were disconnected.

    This fix ensures:

    • When alwaysSaveActualImage: false and saveAboveTolerance is not explicitly set, actual images are never saved (respecting the literal meaning of the option)
    • When saveAboveTolerance is explicitly set (like matchers do internally), actual images are saved only when the mismatch exceeds that threshold

    Committers: 1

  • a3bc7a4: ## Fix: save* methods now always save files regardless of alwaysSaveActualImage setting

    Previously, when alwaysSaveActualImage: false was set in the configuration, save* methods (saveScreen, saveElement, saveFullPageScreen, saveAppScreen, saveAppElement) were not saving files to disk, causing test failures.

    The alwaysSaveActualImage option is intended to control whether actual images are saved during check* methods (comparison operations), not save* methods. Since save* methods are explicitly designed to save screenshots, they should always save files regardless of this setting.

    This fix ensures:

    • save* methods always save files to disk, even when alwaysSaveActualImage: false is set in the config
    • alwaysSaveActualImage: false continues to work correctly for check* methods (as intended for issue #1115)
    • The behavior is now consistent: save* = always save, check* = respect alwaysSaveActualImage setting

    Implementation details:

    • The visual service overrides alwaysSaveActualImage: true when calling save* methods directly from the browser API
    • save* methods respect whatever alwaysSaveActualImage value is passed to them (no special logic needed)
    • check* methods pass through the config value (which may be false), so save* methods respect it when called internally
    • This clean separation ensures save* methods work correctly when called directly while still respecting alwaysSaveActualImage for check* methods

    Committers: 1

  • Updated dependencies [a3bc7a4]

  • Updated dependencies [a3bc7a4]

9.1.3

Patch Changes

  • 2a518ff: # 🐛 Bugfixes

    #1111 Pass matcher threshold to core as saveAboveTolerance

    When using visual matchers like toMatchScreenSnapshot('tag', 0.9) with alwaysSaveActualImage: false, the actual image was still being saved even when the comparison passed within the threshold.

    The root cause was that the matcher's expected threshold was not being passed to the core comparison logic. The core used saveAboveTolerance (defaulting to 0) to decide whether to save images, while the matcher used the user-provided threshold to determine pass/fail - these were disconnected.

    This fix ensures the matcher passes the expected threshold to the core as saveAboveTolerance, so images are only saved when the mismatch actually exceeds the user's acceptable threshold.

    Committers: 1

9.1.2

Patch Changes

  • 0a2b6d0: ## #1111 Respect saveAboveTolerance when deciding to save actual images when alwaysSaveActualImage is false.

    When alwaysSaveActualImage is false, the actual image is no longer written to disk if the mismatch is below the configured tolerance, avoiding extra actuals when the comparison still passes.

    Committers: 1

  • Updated dependencies [0a2b6d0]

9.1.1

Patch Changes

  • 340fbe6: # 🐛 Bugfixes

    #1098 Improve error message when baseline is missing and both flags are false

    When autoSaveBaseline = false and alwaysSaveActualImage = false and a baseline image doesn't exist, the error message now provides clear guidance suggesting users set alwaysSaveActualImage to true if they need the actual image to create a baseline manually.

    Committers: 1

  • e4e5b5c: # 🐛 Bugfixes

    #1085 autoSaveBaseline collides with the new alwaysSaveActualImage flag

    When autoSaveBaseline is true and alwaysSaveActualImage is false, actual images were still saved. This patch should fix that

    Committers: 1

  • ddf68fe: # 🐛 Bugfixes

    #1084 expect(...).toMatch*Snapshot methods do not have Promise return types

    The methods should be typed as promises

    Committers: 1

  • Updated dependencies [340fbe6]

  • Updated dependencies [e4e5b5c]

9.1.0

Minor Changes

  • bde4851: This PR will implement FR #1077 which is asking not to create the actual image on success. This should create a better performance because no files are writing to the system and should make sure that there's not a lot of noise in the actual folder.

    Committers: 1

Patch Changes

9.0.2

Patch Changes

  • 8ff1bc3: # 🐛 BugFix

    #1078: Cursor inside shadow is shown, even with disableBlinkingCursor

    Fix option "disableBlinkingCursor" to also work within shadowdom

    Committers: 1

  • Updated dependencies [8ff1bc3]

9.0.1

Patch Changes

  • 79d2b1d: # 🐛 Bugfixes

    #1073 Normalize Safari desktop screenshots by trimming macOS window corner radius and top window shadow

    Safari desktop screenshots included the macOS window mask at the bottom and a shadow at the top. These artifacts caused incorrect detection of the viewable area for full page screenshots, which resulted in misaligned stitching. The viewable region is now calculated correctly by trimming these areas.

    Committers: 1

  • 782b98a: # 🐛 Bugfixes

    #1000 fix incorrect cropping and stitching of last image for fullpage screenshots on mobile

    The determination of the position of the last image in mobile fullpage webscreenshots was incorrect. This was mostly seen with iOS, but also had some impact on Android. This is now fixed

    Committers: 1

  • 2c109b3: # 🐛 Bugfixes

    #1038 fix incorrect determination of ignore area

    Ignore regions with left: 0 and right:0 lead to an incorrect width which lead to an incorrect ignore area. This is now fixed

    Committers: 1

  • Updated dependencies [79d2b1d]

  • Updated dependencies [782b98a]

  • Updated dependencies [2c109b3]

9.0.0

Major Changes

  • 1326e99: ## 💥 Major Release: New @wdio/image-comparison-core Package

    🏗️ Architectural Refactor

    This release introduces a completely new core architecture with the dedicated @wdio/image-comparison-core package, replacing the generic webdriver-image-comparison module with a WDIO-specific solution.

    What was the problem?

    • The old webdriver-image-comparison package was designed for generic webdriver usage
    • Complex integration between generic and WDIO-specific code
    • Limited test coverage (~58%) making maintenance difficult
    • Mixed responsibilities between core logic and service integration

    What changed?

    ✅ New dedicated core package: @wdio/image-comparison-core - purpose-built for WebdriverIO ✅ Cleaner architecture: Modular design with clear separation of concerns ✅ Enhanced test coverage: Improved from ~58% to ~90% across all metrics ✅ Better maintainability: Organized codebase with comprehensive TypeScript interfaces ✅ WDIO-specific dependencies: Only depends on @wdio/logger, @wdio/types, etc.

    🧪 Testing Improvements

    • 100% branch coverage on critical decision points
    • Comprehensive unit tests for all major functions
    • Optimized mocks for complex scenarios
    • Better test isolation and reliability
    Before/After % Stmts % Branch % Funcs % Lines
    Previous 58.59 91.4 80.71 58.59
    After refactor 90.55 96.38 93.99 90.55

    🔧 Service Integration

    The @wdio/visual-service now imports from the new @wdio/image-comparison-core package while maintaining the same public API and functionality for users.

    📈 Performance & Quality

    • Modular architecture: Easier to maintain and extend
    • Type safety: Comprehensive TypeScript coverage
    • Clean exports: Well-defined public API
    • Internal interfaces: Proper separation of concerns

    🔄 Backward Compatibility

    ✅ No breaking changes for end users ✅ Same public API maintained ✅ Existing configurations continue to work ✅ All existing functionality preserved

    🎯 Future Benefits

    This refactor sets the foundation for:

    • Easier addition of new features
    • Better bug fixing capabilities
    • Enhanced mobile and native app support
    • More reliable MultiRemote functionality

    📦 Dependency Updates

    • Updated most dependencies to their latest versions
    • Improved security with latest package versions
    • Better compatibility with current WebdriverIO ecosystem
    • Enhanced performance through updated dependencies

    Note: This is an architectural improvement that modernizes the codebase while maintaining full backward compatibility. All existing functionality remains unchanged for users.

Patch Changes

  • be4272c: fix: 983 in multiremote, commands are now executed on the requested instances

  • Updated dependencies [74df53b]

  • Updated dependencies [1326e99]

    Committers: 2

8.0.4

Patch Changes

  • d88d8dd: Optimize Mobile and Emulated device support

    🐛 Bugfixes

    #969 Fix layer injection on mobile devices

    On some devices the layer injection, to determine the exact position of the webview, was failing. It exceeded the appium timeout and returned an error like

    [1] [0-0] 2025-05-23T08:04:11.788Z INFO webdriver: COMMAND getUrl()
[1] [0-0] 2025-05-23T08:04:11.789Z INFO webdriver: [GET] https://hub-cloud.browserstack.com/wd/hub/session/xxxxx/url
[1] [0-0] 2025-05-23T08:04:12.036Z INFO webdriver: RESULT about:blank
[1] [0-0] 2025-05-23T08:04:12.038Z INFO webdriver: COMMAND navigateTo("data:text/html;base64,CiAgICAgICAgPG .... LONG LIST OF CHARACTERS=")
[1] [0-0] 2025-05-23T08:04:12.038Z INFO webdriver: [POST] https://hub-cloud.browserstack.com/wd/hub/session/xxxx/url
[1] [0-0] 2025-05-23T08:04:12.038Z INFO webdriver: DATA {
[1] [0-0]   url: 'data:text/html;base64,CiAgICAgICAgPGh0bWw.... LONG LIST OF CHARACTERS='
[1] [0-0] }
[1] [0-0] 2025-05-23T08:05:42.132Z ERROR @wdio/utils:shim: Error: WebDriverError: The operation was aborted due to timeout when running "url" with method "POST" and args "{"url":"data:text/html;base64,CiAgICAgICAgPGh0b.... LONG LIST OF CHARACTERS="}"
[1] [0-0]     at FetchRequest._libRequest (file:///xxxxxxx/node_modules/webdriver/build/node.js:1836:13)
[1] [0-0] 2025-05-23T08:05:42.132Z DEBUG @wdio/utils:shim: Finished to run "before" hook in 91147ms
[1] [0-0]     at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
[1] [0-0]     at async FetchRequest._request (file:///C:/xxxxxx/node_modules/webdriver/build/node.js:1846:20)
[1] [0-0]     at Browser.wrapCommandFn (c:/Projects/xxxxxx/node_modules/@wdio/utils/build/index.js:907:23)
[1] [0-0]     at Browser.url (c:/Projects/xxxxxxx/node_modules/webdriverio/build/node.js:5682:3)
[1] [0-0]     at Browser.wrapCommandFn (c:/Projects/xxxxxx/node_modules/@wdio/utils/build/index.js:907:23)
[1] [0-0]     at async loadBase64Html (file:///C:/Projects/xxxxxx/node_modules/webdriver-image-comparison/dist/helpers/utils.js:377:5)
[1] [0-0]     at async getMobileViewPortPosition (file:///C:/Projects/xxxxxx/node_modules/webdriver-image-comparison/dist/helpers/utils.js:417:9)
[1] [0-0]     at async getMobileInstanceData (file:///C:/Projects/xxxxxx/node_modules/@wdio/visual-service/dist/utils.js:58:28)
[1] [0-0]     at async getInstanceData (file:///C:/Projects/xxxxxxx/node_modules/@wdio/visual-service/dist/utils.js:189:77)
[1] [0-0] 2025-05-23T08:05:42.144Z INFO @wdio/browserstack-service: Update job with sessionId xxxxx

    This was caused by the await url(data:text/html;base64,${base64Html}) that injected the layer. Some browsers couldn't handle the data:text/html;base64.

    We now fixed that with a different injection. It was tested on Android/iOS and on Sims/Emus/Real Devices and it worked

    Improve determining if a device is emulated

    In a previous release we added a function to determine if a device was emulated. This resulted in incorrect screen sizes that were used for the files names for devices. This caused or failing baselines, or new files to be created because the screen sizes were not available We now improved the check and the correct screen sizes are added again to the file names and made sure that the previous generated base line could be used again.

    Committers: 1

  • Updated dependencies [d88d8dd]

8.0.3

Patch Changes

  • 2f9ec42: ## 🐛 Bug-fixes

    #967: Emulated device crops with enableLegacyScreenshotMethod set to true are not correct

    When a screenshot of an emulated device is taken, but the browser was initially started as a "desktop" session, so not with emulated caps, and the enableLegacyScreenshotMethod property is set to true, the DPR of the emulated device is taken. This resulted in incorrect crop. We now store the original dpr and use that for the crop when it's an emulated device and started as a desktop browser session.

    BiDi Fullpage screenshots for emulated device are broken

    The BiDi fullpage screenshot for an emulated device is broken in the driver. We now fallback to the legacy screenshot method for BiDi and emulated devices

    💅 Polish

    • Updated the multiple interfaces to use JS-Doc for better docs
    • When createJsonReportFiles is set to true and there are a lot of differences we kept waiting. We now limited that to check a max of 5M diff-pixels or a diff threshold of 20%. If it's bigger the report will show a full coverage and extra logs are shown in the WDIO logs, something like this
    [0-0] 2025-05-24T06:02:18.887Z INFO @wdio/visual-service:webdriver-image-comparison:pixelDiffProcessing: Processing diff pixels started
[0-0] 2025-05-24T06:02:18.888Z INFO @wdio/visual-service:webdriver-image-comparison:pixelDiffProcessing: Processing 20143900 diff pixels
[0-0] 2025-05-24T06:02:19.770Z INFO @wdio/visual-service:webdriver-image-comparison:pixelDiffProcessing: Total pixels in image: 52,184,160
[0-0] 2025-05-24T06:02:19.770Z INFO @wdio/visual-service:webdriver-image-comparison:pixelDiffProcessing: Number of diff pixels: 20,143,900
[0-0] 2025-05-24T06:02:19.770Z INFO @wdio/visual-service:webdriver-image-comparison:pixelDiffProcessing: Diff percentage: 38.60%
[0-0] 2025-05-24T06:02:19.770Z ERROR @wdio/visual-service:webdriver-image-comparison:pixelDiffProcessing: Too many differences detected! Diff percentage: 38.60%, Diff pixels: 20,143,900
[0-0] 2025-05-24T06:02:19.771Z ERROR @wdio/visual-service:webdriver-image-comparison:pixelDiffProcessing: This likely indicates a major visual difference or an issue with the comparison.
[0-0] 2025-05-24T06:02:19.771Z ERROR @wdio/visual-service:webdriver-image-comparison:pixelDiffProcessing: Consider checking if the baseline image is correct or if there are major UI changes.

    Committers: 1

  • Updated dependencies [2f9ec42]

8.0.2

Patch Changes

  • 9363467: ## 🐛 Bug-fixes

    • #946: Visual Regression Changes in WDIO v9
      • Fixed screen size detection in emulated mode for filenames. Previously used incorrect browser window size.
      • Fixed screenshot behavior when enableLegacyScreenshotMethod: true, now correctly captures emulated screen instead of complete screen.
      • Fixed emulated device handling for Chrome and Edge browsers, now properly sets device metrics based on deviceMetrics or deviceName capabilities.

    Committers: 1

  • Updated dependencies [9363467]

8.0.1

Patch Changes

  • 5c6c6e2: Fix capturing element screenshots with BiDi

    This release fixes #919 where an element screenshot, that was for example from an overlay, dropdown, popover, tooltip, modal, was returning an incorrect screenshot

    Committers: 1

  • Updated dependencies [5c6c6e2]

8.0.0

Major Changes

  • bfe6aca: ## 💥 BREAKING CHANGES

    🧪 Web Screenshot Strategy Now Uses BiDi by Default

    What was the problem?

    Screenshots taken via WebDriver's traditional protocol often lacked precision:

    • Emulated devices didn't reflect true resolutions
    • Device Pixel Ratio (DPR) was often lost
    • Images were cropped or downscaled

    What changed?

    All screenshot-related methods now use the WebDriver BiDi protocol by default (if supported by the browser), enabling:

    ✅ Native support for emulated and high-DPR devices ✅ Better fidelity in screenshot size and clarity ✅ Faster, browser-native screenshots via browsingContext.captureScreenshot

    The following methods now use BiDi:

    • saveScreen / checkScreen
    • saveElement / checkElement
    • saveFullPageScreen / checkFullPageScreen

    What’s the impact?

    ⚠️ Existing baselines may no longer match. Because BiDi screenshots are sharper and match device settings more accurately, even a small difference in resolution or DPR can cause mismatches.

    If you rely on existing baseline images, you'll need to regenerate them to avoid false positives.

    Want to keep using the legacy method?

    You can disable BiDi screenshots globally or per test using the enableLegacyScreenshotMethod flag:

    Globally in wdio.conf.ts:

    import { join } from "node:path";

export const config = {
  services: [
    [
      "visual",
      {
        baselineFolder: join(process.cwd(), "./localBaseline/"),
        debug: true,
        formatImageName: "{tag}-{logName}-{width}x{height}",
        screenshotPath: join(process.cwd(), ".tmp/"),
        enableLegacyScreenshotMethod: true, // 👈 fallback to W3C-based screenshots
      },
    ],
  ],
};

    Or per test:

    it("should compare an element successfully using legacy screenshots", async function () {
  await expect($(".hero__title-logo")).toMatchElementSnapshot(
    "legacyScreenshotLogo",
    { enableLegacyScreenshotMethod: true } // 👈 fallback to W3C-based screenshots
  );
});

    🐛 Bug Fixes

    • ✅ #916: Visual Testing Screenshot Behavior Changed in Emulated Devices

    Committers: 1

Patch Changes

7.0.0

Major Changes

  • 42956e4: ## 💥 BREAKING CHANGES

    🔍 Viewport Screenshot Logic Reworked for Mobile Web & Hybrid Apps

    What was the problem?

    Screenshots for mobile devices were inconsistent due to platform differences. iOS captures the entire device screen (including status and address bars), while Android (using ChromeDriver) only captures the webview, unless the capability "appium:nativeWebScreenshot": true is used.

    What changed?

    We’ve reimplemented the logic to correctly handle both platforms by default. This fix addresses [#747](#747).

    💡 Credit to Benjamin Karran (@ebekebe) for pointing us in the right direction to improve this logic!

    What’s the advantage?

    ✅ More accurate full-page and element screenshots on both Android and iOS. ⚠️ But this change may break your current baselines, especially on Android and iOS.

    🍏 iOS Element Screenshot Strategy Changed

    What was the problem?

    iOS element screenshots were previously cut from full-device screenshots, which could lead to misalignment or off-by-a-few-pixels issues.

    What changed?

    We now use the element screenshot endpoint directly.

    What’s the advantage?

    ✅ More accurate iOS element screenshots. ⚠️ But again, this may affect your existing baselines.

    🖥️ New Full-Page Screenshot Strategy for Desktop Web

    What was the problem?

    The "previous" scroll-and-stitch method simulated user interaction by scrolling the page, waiting, taking a screenshot, and repeating until the entire page was captured. This works well for lazy-loaded content, but it is slow and unstable on other pages.

    What changed?

    We now use WebDriver BiDi’s [[browsingContext.captureScreenshot](https://webdriver.io/docs/api/webdriverBidi#browsingcontextcapturescreenshot)] to capture full-page screenshots in one go. This is the new default strategy for desktop web browsers.

    📌 Mobile platforms (iOS/Android) still use the scroll-and-stitch approach for now.

    What’s the advantage?

    ✅ Execution time reduced by 50%+ ✅ Logic is greatly simplified ✅ More consistent and stable results on static or non-lazy pages 📸 Example

    Still want the old scroll-and-stitch behavior or need fullpage screenshots for pages who have lazy-loading?

    Use the userBasedFullPageScreenshot option to simulate user-like scrolling. This remains the better choice for pages with lazy-loading:

    // wdio.conf.ts
services: [
  [
    "visual",
    {
      userBasedFullPageScreenshot: true,
    },
  ],
];

    Or per test:

    await expect(browser).toMatchFullPageSnapshot("homepage", {
  userBasedFullPageScreenshot: true,
});

    💅 Polish

    ⚠️ Deprecated Root-Level Compare Options

    What was the problem?

    Compare options were allowed at the root level of the service config, making them harder to group or discover.

    What changed?

    You now get a warning if you still use root-level keys. Please move them under the compareOptions property instead.

    Example warning:

    WARN The following root-level compare options are deprecated and should be moved under 'compareOptions':
  - blockOutStatusBar
  - ignoreColors
In the next major version, these options will be removed from the root level.

    📘 See: [compareOptions docs](https://webdriver.io/docs/visual-testing/service-options#compare-options)

    🐛 Bug Fixes

    🔧 Other

    • 🆙 Updated dependencies
    • 🧪 Improved test coverage
    • 📸 Refreshed image baselines

    Committers: 1

Patch Changes

6.4.0

Minor Changes

  • 7f859aa: Add additionalSearchParams to the Storybook Runner API
  • 307fbec: Add getStoriesBaselinePath to Storybook Runner API, enabling custom file paths (e.g. files with a flat hierarchy in the baselines folder)

Patch Changes

  • 3d232d1: Fix compareOptions not passed from config to the storybook runner tests
  • Updated dependencies [7f859aa]
  • Updated dependencies [307fbec]

Committers: 2

6.3.3

Patch Changes

  • 77bc764: Removed unused node-fetch dependency

Committers: 1

6.3.2

Patch Changes

  • 09dbc2d: update deps
  • 09dbc2d: don't check for runner
  • Updated dependencies [09dbc2d]

Committers: 2

6.3.1

Patch Changes

  • 69d25fe: Multiple fixes:

    • update deps
    • fix #728: Missing Type Information in Service Configuration
    • fix #745: The image comparison process stalls when utilizing the checkElement method to compare screenshots of two different elements

  • Updated dependencies [69d25fe]

6.3.0

Minor Changes

  • 2d033e8: Add LambdaTest support
    • #691 Add option to ignore blinking cursors / carets by providing the option disableBlinkingCursor
    • #692 Add support for appium:options

Patch Changes

6.2.5

Patch Changes

  • 4a4adf1: Fix resize dimensions for mobile
  • 4a4adf1: update deps
  • Updated dependencies [4a4adf1]
  • Updated dependencies [4a4adf1]

6.2.4

Patch Changes

  • 36541dd: Fix issue 679

6.2.3

Patch Changes

  • cc2b0fb: Fix issue 656

6.2.2

Patch Changes

  • a34dd5d: Update of deps
  • d751b8c: fix android app determination

6.2.1

Patch Changes

  • 1df5350: # Improve iPhone support

    💅 Polish @wdio/visual-reporter

    • Mobile: support iOS 18 and the iPhone 16 series for the blockouts

    🐛 Bugs fixed @wdio/visual-reporter

    • Mobile: don't use the device blockouts for element screenshot
    • Mobile: when the blockouts had the value {x: 0, y: 0, width: 0, height: 0} then Resemble picked this up as a full blockout. This caused false positives for iOS

  • Updated dependencies [1df5350]

6.2.0

Minor Changes

  • 6e20f06: Upgrade dependencies

6.1.0

Minor Changes

ea08748 Fix 495: module system issue when using with vite and storybook

This fix only allows runner to be the local one, if not, it will throw this error

pnpm test.local.desktop.storybook                                                                                                                                 ─╯
> @wdio/visual-testing-monorepo@ test.local.desktop.storybook /Users/wswebcreation/Git/wdio/visual-testing
> wdio tests/configs/wdio.local.desktop.storybook.conf.ts --storybook --numShards=10 --url=https://govuk-react.github.io/govuk-react/ --skipStories="/.*(loading-box|spinner).*/"
Execution of 0 workers started at 2024-09-22T05:50:20.875Z
SevereServiceError in "onPrepare"
SevereServiceError:
A service failed in the 'onPrepare' hook
SevereServiceError:
Running `@wdio/visual-service` is only supported in `local` mode.
    at VisualLauncher.onPrepare (file:///Users/wswebcreation/Git/wdio/visual-testing/packages/visual-service/dist/storybook/launcher.js:22:19)
    at file:///Users/wswebcreation/Git/wdio/visual-testing/node_modules/.pnpm/@[email protected]/node_modules/@wdio/cli/build/index.js:1209:32
    at Array.map (<anonymous>)
    at runServiceHook (file:///Users/wswebcreation/Git/wdio/visual-testing/node_modules/.pnpm/@[email protected]/node_modules/@wdio/cli/build/index.js:1206:31)
    at Launcher.run (file:///Users/wswebcreation/Git/wdio/visual-testing/node_modules/.pnpm/@[email protected]/node_modules/@wdio/cli/build/index.js:2193:13)
    at async Module.run (file:///Users/wswebcreation/Git/wdio/visual-testing/node_modules/.pnpm/@[email protected]/node_modules/@wdio/cli/build/index.js:3218:16)
Stopping runner...
    at file:///Users/wswebcreation/Git/wdio/visual-testing/node_modules/.pnpm/@[email protected]/node_modules/@wdio/cli/build/index.js:1227:29
    at async Launcher.run (file:///Users/wswebcreation/Git/wdio/visual-testing/node_modules/.pnpm/@[email protected]/node_modules/@wdio/cli/build/index.js:2193:7)
    at async Module.run (file:///Users/wswebcreation/Git/wdio/visual-testing/node_modules/.pnpm/@[email protected]/node_modules/@wdio/cli/build/index.js:3218:16)
HookError [SevereServiceError]:
A service failed in the 'onPrepare' hook
SevereServiceError:
Running `@wdio/visual-service` is only supported in `local` mode.
    at VisualLauncher.onPrepare (file:///Users/wswebcreation/Git/wdio/visual-testing/packages/visual-service/dist/storybook/launcher.js:22:19)
    at file:///Users/wswebcreation/Git/wdio/visual-testing/node_modules/.pnpm/@[email protected]/node_modules/@wdio/cli/build/index.js:1209:32
    at Array.map (<anonymous>)
    at runServiceHook (file:///Users/wswebcreation/Git/wdio/visual-testing/node_modules/.pnpm/@[email protected]/node_modules/@wdio/cli/build/index.js:1206:31)
    at Launcher.run (file:///Users/wswebcreation/Git/wdio/visual-testing/node_modules/.pnpm/@[email protected]/node_modules/@wdio/cli/build/index.js:2193:13)
    at async Module.run (file:///Users/wswebcreation/Git/wdio/visual-testing/node_modules/.pnpm/@[email protected]/node_modules/@wdio/cli/build/index.js:3218:16)
Stopping runner...
    at file:///Users/wswebcreation/Git/wdio/visual-testing/node_modules/.pnpm/@[email protected]/node_modules/@wdio/cli/build/index.js:1227:29
    at async Launcher.run (file:///Users/wswebcreation/Git/wdio/visual-testing/node_modules/.pnpm/@[email protected]/node_modules/@wdio/cli/build/index.js:2193:7)
    at async Module.run (file:///Users/wswebcreation/Git/wdio/visual-testing/node_modules/.pnpm/@[email protected]/node_modules/@wdio/cli/build/index.js:3218:16) {
  origin: 'onPrepare'
}
 ELIFECYCLE  Command failed with exit code 1.

💅 Update dependencies

We've update all dependencies.

Patch Changes

6.0.0

Major Changes

  • 9fdb2d2: feat: work with V9

Patch Changes

5.2.1

Patch Changes

  • cae36ad: Update deps

5.2.0

Minor Changes

  • 0b01b64: ### @wdio/visual-service

    🚀 New Features

    Added Reporting output You now have the option to export the compare results into a JSON report file. By enabling the module option createJsonReportFiles: true, each image that is compared will create a report stored in the actual folder, next to each actual image result.

    The output will look like this:

    {
  "parent": "check methods",
  "test": "should fail comparing with a baseline",
  "tag": "examplePageFail",
  "instanceData": {
    "browser": {
      "name": "chrome-headless-shell",
      "version": "126.0.6478.183"
    },
    "platform": {
      "name": "mac",
      "version": "not-known"
    }
  },
  "commandName": "checkScreen",
  "boundingBoxes": {
    "diffBoundingBoxes": [
      {
        "left": 1088,
        "top": 717,
        "right": 1186,
        "bottom": 730
      }
      //....
    ],
    "ignoredBoxes": [
      {
        "left": 159,
        "top": 652,
        "right": 356,
        "bottom": 703
      }
      //...
    ]
  },
  "fileData": {
    "actualFilePath": "/Users/wswebcreation/Git/wdio/visual-testing/.tmp/actual/desktop_chrome-headless-shellexamplePageFail-local-chrome-latest-1366x768.png",
    "baselineFilePath": "/Users/wswebcreation/Git/wdio/visual-testing/localBaseline/desktop_chrome-headless-shellexamplePageFail-local-chrome-latest-1366x768.png",
    "diffFilePath": "/Users/wswebcreation/Git/wdio/visual-testing/.tmp/diff/desktop_chrome-headless-shell/examplePageFail-local-chrome-latest-1366x768png",
    "fileName": "examplePageFail-local-chrome-latest-1366x768.png",
    "size": {
      "actual": {
        "height": 768,
        "width": 1366
      },
      "baseline": {
        "height": 768,
        "width": 1366
      },
      "diff": {
        "height": 768,
        "width": 1366
      }
    }
  },
  "misMatchPercentage": "12.90",
  "rawMisMatchPercentage": 12.900729014153246
}

    When all tests are executed, a new JSON file with the collection of the comparisons will be generated and can be found in the root of your actual folder. The data is grouped by:

    • describe for Jasmine/Mocha or Feature for CucumberJS
    • it for Jasmine/Mocha or Scenario for CucumberJS

    and then sorted by:

    • commandName, which are the compare method names used to compare the images
    • instanceData, browser first, then device, then platform

    it will look like this

    [
  {
    "description": "check methods",
    "data": [
      {
        "test": "should fail comparing with a baseline",
        "data": [
          {
            "tag": "examplePageFail",
            "instanceData": {},
            "commandName": "checkScreen",
            "framework": "mocha",
            "boundingBoxes": {
              "diffBoundingBoxes": [],
              "ignoredBoxes": []
            },
            "fileData": {},
            "misMatchPercentage": "14.34",
            "rawMisMatchPercentage": 14.335403703025868
          },
          {
            "tag": "exampleElementFail",
            "instanceData": {},
            "commandName": "checkElement",
            "framework": "mocha",
            "boundingBoxes": {
              "diffBoundingBoxes": [],
              "ignoredBoxes": []
            },
            "fileData": {},
            "misMatchPercentage": "1.34",
            "rawMisMatchPercentage": 1.335403703025868
          }
        ]
      }
    ]
  }
]

    The report data will give you the opportunity to build your own visual report without doing all the magic and data collection yourself.

    webdriver-image-comparison

    🚀 New Features

    • Add support to generate single JSON report files

    @wdio/ocr-service

    💅 Polish

    • Refactored the CLI to use @inquirer/prompts instead of inquirer

    Committers: 1

Patch Changes

5.1.1

Patch Changes

  • 26c1a17: This release contains better support for Multiremote tests on the instances and global level, including better Native App support. This is related to issue #418 which is fixed by this release

    💅 Polish

    • cab1219: Update dependencies
    • 2583542 / 8b1f837: add new tests
    • eec29e1 / e2b2d38: update images

    🐛 Bug Fixes

    • 29f6f82 / 1ba9817: fix issue #418

    Committers: 1

  • Updated dependencies [26c1a17]

5.1.0

Minor Changes

  • a0e29f2: Adding storybook interaction testing

    Storybook Interaction Testing

    Storybook Interaction Testing allows you to interact with your component by creating custom scripts with WDIO commands to set a component into a certain state. For example, see the code snippet below:

    import { browser, expect } from "@wdio/globals";

describe("Storybook Interaction", () => {
  it("should create screenshots for the logged in state when it logs out", async () => {
    const componentId = "example-page--logged-in";
    await browser.waitForStorybookComponentToBeLoaded({
      id: componentId,
    });

    await expect($("header")).toMatchElementSnapshot(
      `${componentId}-logged-in-state`
    );
    await $("button=Log out").click();
    await expect($("header")).toMatchElementSnapshot(
      `${componentId}-logged-out-state`
    );
  });

  it("should create screenshots for the logged out state when it logs in", async () => {
    const componentId = "example-page--logged-out";
    await browser.waitForStorybookComponentToBeLoaded({
      id: componentId,
    });

    await expect($("header")).toMatchElementSnapshot(
      `${componentId}-logged-out-state`
    );
    await $("button=Log in").click();
    await expect($("header")).toMatchElementSnapshot(
      `${componentId}-logged-in-state`
    );
  });
});

    Two tests on two different components are executed. Each test first sets a state and then takes a screenshot. You will also notice that a new custom command has been introduced, which can be found here.

    The above spec file can be saved in a folder and added to the command line with the following command:

    npm run test.local.desktop.storybook.localhost -- --spec='tests/specs/storybook-interaction/*.ts'

    The Storybook runner will first automatically scan your Storybook instance and then add your tests to the stories that need to be compared. If you don't want the components that you use for interaction testing to be compared twice, you can add a filter to remove the "default" stories from the scan by providing the --skipStories filter. This would look like this:

    npm run test.local.desktop.storybook.localhost -- --skipStories="/example-page.*/gm" --spec='tests/specs/storybook-interaction/*.ts'

    New Custom Command

    A new custom command called browser.waitForStorybookComponentToBeLoaded({ id: 'componentId' }) will be added to the browser/driver-object that will automatically load the component and wait for it to be done, so you don't need to use the browser.url('url.com') method. It can be used like this

    import { browser, expect } from "@wdio/globals";

describe("Storybook Interaction", () => {
  it("should create screenshots for the logged in state when it logs out", async () => {
    const componentId = "example-page--logged-in";
    await browser.waitForStorybookComponentToBeLoaded({
      id: componentId,
    });

    await expect($("header")).toMatchElementSnapshot(
      `${componentId}-logged-in-state`
    );
    await $("button=Log out").click();
    await expect($("header")).toMatchElementSnapshot(
      `${componentId}-logged-out-state`
    );
  });

  it("should create screenshots for the logged out state when it logs in", async () => {
    const componentId = "example-page--logged-out";
    await browser.waitForStorybookComponentToBeLoaded({
      id: componentId,
    });

    await expect($("header")).toMatchElementSnapshot(
      `${componentId}-logged-out-state`
    );
    await $("button=Log in").click();
    await expect($("header")).toMatchElementSnapshot(
      `${componentId}-logged-in-state`
    );
  });
});

    The options are:

    clipSelector

    • Type: string
    • Mandatory: No
    • Default: #storybook-root > :first-child for Storybook V7 and #root > :first-child:not(script):not(style) for Storybook V6
    • Example:
    await browser.waitForStorybookComponentToBeLoaded({
  clipSelector: "#your-selector",
  id: "componentId",
});

    This is the selector that will be used:

    • to select the element to take the screenshot of
    • for the element to wait to be visible before a screenshot is taken

    id

    • Type: string
    • Mandatory: yes
    • Example:
    await browser.waitForStorybookComponentToBeLoaded({ '#your-selector', id: 'componentId' })

    Use the id of the story that can be found in the URL of the story. For example, the id in this URL http://localhost:6006/?path=/story/example-page--logged-out is example-page--logged-out

    timeout

    • Type: number
    • Mandatory: No
    • Default: 1100 milliseconds
    • Example:
    await browser.waitForStorybookComponentToBeLoaded({
  id: "componentId",
  timeout: 20000,
});

    The max timeout we want to wait for a component to be visible after loading on the page

    url

    • Type: string
    • Mandatory: No
    • Default: http://127.0.0.1:6006
    • Example:
    await browser.waitForStorybookComponentToBeLoaded({
  id: "componentId",
  url: "https://your.url",
});

    The URL where your Storybook instance is hosted.

5.0.1

Patch Changes

  • 169b7c5: fix(webdriver-image-comparison): export WicElement
  • Updated dependencies [169b7c5]

5.0.0

Major Changes

  • 66b9f11: # 💥 Breaking

    This PR replaces Canvas as a dependency with Jimp. This removes the need to use system dependencies and will reduce the number of system dependency errors/issues (node-gyp/canvas and so on). This will, in the end, make the life of our end users way easier due to:

    • less errors
    • less complex test environments

    [!note] Extensive research has been done and we have chosen to "fork" ResembleJS, adjust it by making use of Jimp instead of Canvas and break the browser API because the fork will only be used in a nodejs environment Investigation showed that creating a wrapper would even make it slower, so we went for the breaking change in the API by just replacing Canvas with Jimp

    [!important] There is a performance impact where Canvas is around 70% faster than Jimp. This has been measured without using WebdriverIO and only comparing images. When the "old" implementation with WebdriverIO combined with Canvas or Jimp is compared, we hardly see a performance impact.

    🚀 New Features

    Update the baseline images through the command line by adding the argument --update-visual-baseline. This will

    • automatically copy the actual take screenshot and put it in the baseline folder
    • if there are differences it will let the test pass because the baseline has been updated

    Usage:

    npm run test.local.desktop  --update-visual-baseline

    When running logs info/debug mode you will see the following logs added

    [0-0] ..............
[0-0] #####################################################################################
[0-0]  INFO:
[0-0]  Updated the actual image to
[0-0]  /Users/wswebcreation/Git/wdio/visual-testing/localBaseline/chromel/demo-chrome-1366x768.png
[0-0] #####################################################################################
[0-0] ..........

    💅 Polish

    • remove Vitest fix
    • add app images
    • update the build

Patch Changes

4.1.3

Patch Changes

🐛 Bug Fixes

4.1.2

Patch Changes

  • 7713c13: Fix beforeTest incl types

4.1.1

Patch Changes

  • 4dcfeea: add missing dependency and update deps

4.1.0

Minor Changes

  • c9fab82: change console.log to wdio logger

Patch Changes

4.0.2

Patch Changes

  • f878cab: # 🚀 Feature

    • Add device support for Storybook, it can be used like this
    npx wdio tests/configs/wdio.local.desktop.storybook.conf.ts --storybook --devices="iPhone 14 Pro Max","Pixel 3 XL"

    Committers: 1

  • Updated dependencies [f878cab]

4.0.1

Patch Changes

  • bb4ece7: Fix storybook filtering

4.0.0

Major Changes

  • b717d9a: # 💥 Breaking changes

    • the new element screenshot is producing "smaller" screenshots on certain Android OS versions (not all), but it's more "accurate" so we accept this

    🚀 New Features

    Add StoryBook📖 support

    Automatically scan local/remote storybook instances to create element screenshots of each component by adding

    export const config: WebdriverIO.Config = {
  // ...
  services: ["visual"],
  // ....
};

    to your services and running npx wdio tests/configs/wdio.local.desktop.storybook.conf.ts --storybook through the command line. It will automatically use Chrome. The following options can be provided through the command line

    • --headless, defaults to true

    • --numShards {number}, this will be the amount of parallel instances that will be used to run the stories. This will be limited by the maxInstances in your wdio.conf-file. When running in headless-mode then do not increase the number to more than 20 to prevent flakiness

    • --clip {boolean}, try to take an element instead of a viewport screenshot, defaults to true

    • --clipSelector {string}, this is the selector that will be used to:

      • select the element to take the screenshot of
      • the element to wait for to be visible before a screenshot is taken

      defaults to #storybook-root > :first-child for V7 and #root > :first-child:not(script):not(style) for V6

    • --version, the version of storybook, defaults to 7. This is needed to know if the V6 clipSelector needs to be used.

    • --browsers {edge,chrome,safari,firefox}, defaults to Chrome

    • --skipStories, this can be:

      • a string (example-button--secondary,example-button--small)
      • or a regex ("/.*button.*/gm") to skip certain stories

    You can also provide service options

    export const config: WebdriverIO.Config  = {
    // ...
    services: [
      [
        'visual',
        {
            // Some default options
            baselineFolder: join(process.cwd(), './__snapshots__/'),
            debug: true,
            // The storybook options
            storybook: {
                clip: false,
                clipSelector: ''#some-id,
                numShards: 4,
                skipStories: ['example-button--secondary', 'example-button--small'],
                url: 'https://www.bbc.co.uk/iplayer/storybook/',
                version: 6,
            },
        },
      ],
    ],
    // ....
}

    The baseline images will be stored in the following structure:

    {projectRoot}
|_`__snapshots__`
  |_`{category}`
    |_`{componentName}`
      |_{browserName}
        |_`{{component-id}-element-{browser}-{resolution}-dpr-{dprValue}}.png`

    which will look like this

    image

    [!NOTE] Storybook 6.5 or higher is supported

    💅 Polish

    • hideScrollBars is disabled by default when using the Storybook runner
    • By default, all element screenshots in the browser, except for iOS, will use the native method to take element screenshots. This will make taking an element screenshot more than 5% faster. If it fails it will fall back to the "viewport" screenshot and create a cropped element screenshot.
    • Taking an element screenshot becomes 70% faster due to removing the fixed scroll delay of 500ms and changing the default scrolling behaviour to an instant scroll
    • refactor web element screenshots and update the screenshots
    • added more UTs to increase the coverage

    🐛 Bug Fixes

    • When the element has no height or width, we default to the viewport screen size to prevent not cropping any screenshot. An error like below will be logged in red
    
The element has no width or height. We defaulted to the viewport screen size of width: ${width} and height: ${height}.
    • There were cases where element screenshots were automatically rotated which was not intended

Patch Changes

3.1.0

Minor Changes

  • 43ed502: Add font loading features:
    • add waitForFontsLoaded so the module automatically waits for all fonts to be loaded, enabled by default
    • add enableLayoutTesting so all text will become transparent so
      • font rendering issues won't cause flakiness
      • image comparison can be done on layout

Patch Changes

3.0.2

Patch Changes

  • 14b6ae6: Support BS real device names Fix hide/remove elements

3.0.1

Patch Changes

  • c8fdcd3: Fix to override visibility/display value
  • Updated dependencies [c8fdcd3]

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]

2.0.0

Major Changes

  • ef386b6: # 💥 Breaking changes:

    • resizeDimensions on the element can now only be an object, it has been deprecated for a while

    💅 New Features

    • Next to supporting Web snapshot testing this module now also supports 💥 Native App 💥 snapshot testing. The methods saveElement|checkElement | saveScreen | checkScreen and the matchers toMatchElementSnapshot | toMatchScreenSnapshot are available for Native Apps

    [!NOTE] This module will automatically detect the context (web | webview | native_app) and will handle all complex logic for you

    The methods saveFullPageScreen | checkFullPageScreen | saveTabbablePage|checkTabbablePage will throw an error when they are used in the native context for native mobile apps and will look like this

    $ wdio tests/configs/wdio.local.android.emus.app.conf.ts

Execution of 1 workers started at 2024-01-30T06:18:24.865Z

[0-0] RUNNING in Android - file:///tests/specs/mobile.app.spec.ts
[0-0] Error in "@wdio/visual-service mobile app.should compare a screen successful for 'Pixel_7_Pro_Android_14_API_34' in PORTRAIT-mode"
Error: The method saveFullPageScreen is not supported in native context for native mobile apps!
    at /wdio/visual-testing/packages/webdriver-image-comparison/src/commands/saveFullPageScreen.ts:26:15
    at step (/wdio/visual-testing/packages/webdriver-image-comparison/dist/commands/saveFullPageScreen.js:33:23)
    at Object.next (/wdio/visual-testing/packages/webdriver-image-comparison/dist/commands/saveFullPageScreen.js:14:53)
    at /wdio/visual-testing/packages/webdriver-image-comparison/dist/commands/saveFullPageScreen.js:8:71
    at new Promise (<anonymous>)
    at __awaiter (/wdio/visual-testing/packages/webdriver-image-comparison/dist/commands/saveFullPageScreen.js:4:12)
    at saveFullPageScreen (/wdio/visual-testing/packages/webdriver-image-comparison/dist/commands/saveFullPageScreen.js:47:12)
    at Browser.<anonymous> (file:///wdio/visual-testing/packages/service/dist/service.js:101:24)
[0-0] FAILED in Android - file:///tests/specs/mobile.app.spec.ts

 "spec" Reporter:
------------------------------------------------------------------
[/wdio/visual-testing/apps/app.apk Android #0-0] Running: /wdio/visual-testing/apps/app.apk on Android
[/wdio/visual-testing/apps/app.apk Android #0-0] Session ID: c1101184-e3d5-42b5-a31f-8ebaa211f1a1
[/wdio/visual-testing/apps/app.apk Android #0-0]
[/wdio/visual-testing/apps/app.apk Android #0-0] » /tests/specs/mobile.app.spec.ts
[/wdio/visual-testing/apps/app.apk Android #0-0] @wdio/visual-service mobile app
[/wdio/visual-testing/apps/app.apk Android #0-0]    ✖ should compare a screen successful for 'Pixel_7_Pro_Android_14_API_34' in PORTRAIT-mode
[/wdio/visual-testing/apps/app.apk Android #0-0]
[/wdio/visual-testing/apps/app.apk Android #0-0] 1 failing (1.5s)
[/wdio/visual-testing/apps/app.apk Android #0-0]
[/wdio/visual-testing/apps/app.apk Android #0-0] 1) @wdio/visual-service mobile app should compare a screen successful for 'Pixel_7_Pro_Android_14_API_34' in PORTRAIT-mode
[/wdio/visual-testing/apps/app.apk Android #0-0] The method saveFullPageScreen is not supported in native context for native mobile apps!
[/wdio/visual-testing/apps/app.apk Android #0-0] Error: The method saveFullPageScreen is not supported in native context for native mobile apps!
[/wdio/visual-testing/apps/app.apk Android #0-0]     at /wdio/visual-testing/packages/webdriver-image-comparison/src/commands/saveFullPageScreen.ts:26:15
[/wdio/visual-testing/apps/app.apk Android #0-0]     at step (/wdio/visual-testing/packages/webdriver-image-comparison/dist/commands/saveFullPageScreen.js:33:23)
[/wdio/visual-testing/apps/app.apk Android #0-0]     at Object.next (/wdio/visual-testing/packages/webdriver-image-comparison/dist/commands/saveFullPageScreen.js:14:53)
[/wdio/visual-testing/apps/app.apk Android #0-0]     at /wdio/visual-testing/packages/webdriver-image-comparison/dist/commands/saveFullPageScreen.js:8:71
[/wdio/visual-testing/apps/app.apk Android #0-0]     at new Promise (<anonymous>)
[/wdio/visual-testing/apps/app.apk Android #0-0]     at __awaiter (/wdio/visual-testing/packages/webdriver-image-comparison/dist/commands/saveFullPageScreen.js:4:12)
[/wdio/visual-testing/apps/app.apk Android #0-0]     at saveFullPageScreen (/wdio/visual-testing/packages/webdriver-image-comparison/dist/commands/saveFullPageScreen.js:47:12)
[/wdio/visual-testing/apps/app.apk Android #0-0]     at Browser.<anonymous> (file:///wdio/visual-testing/packages/service/dist/service.js:101:24)


Spec Files:      0 passed, 1 failed, 1 total (100% completed) in 00:00:11

error Command failed with exit code 1.
    • autoSaveBaseline is true by default, so if no baseline images are present it will automatically create a new baseline
    • Mobile screenshots of the complete screen now automatically exclude all native OS elements like the notification bar, home bar, address bar, and so on, the settings blockOutSideBar | blockOutStatusBar |blockOutToolBar are now all defaulted to true

    🐛 Fixed bugs:

    • element screenshots could also get resized dimensions, which would cut out a bigger portion around the element. This was failing when the dimensions got out of the boundaries of the official screenshot. This has now been fixed with:
      • not going outside of the screenshot
      • log extra warnings

Patch Changes

1.0.0

Major Changes

  • 36d3868: Support for WebdriverIO v8

Minor Changes

  • 36d3868: (feat): add visual matcher

Patch Changes