fix(percy): restore Percy capture on WebdriverIO (v8) (SDK-7756)

[rounak610]

What is this about?

Ports the v9 Percy fixes (#210 + #228) to the v8 line. Percy captured nothing on WebdriverIO — both the screenshot and the snapshot paths were dead — and this restores both, matching v9.

Two silent bugs (same as v9):

1. Screenshot / Automate path (percyScreenshot). @percy/selenium-webdriver 2.2.6 added an unguarded top-level require('selenium-webdriver'), which it ships only as a devDependency — so in a WebdriverIO project it throws MODULE_NOT_FOUND, our tryRequire swallowed it, and every Percy call became a no-op logging Unsupported driver for percy. v8's floating ^2.0.3 had locked to the broken 2.2.6 in the lockfile. Bumped to ^2.2.8 (Percy's fix) so it resolves to the loadable 2.2.8.
2. Web snapshot path. snapshot was wired to @percy/selenium-webdriver, which drives the browser with Selenium-only APIs (executeScript(script), By, switchTo()) a WebdriverIO browser does not have — it never worked at any version. Rerouted to @percy/webdriverio (the WebdriverIO-native port), added as ^3.3.4. (3.3.3 shipped without its _iframe_shim.js file and failed to load; Percy fixed it in 3.3.4.)

Also: all Percy entry points now run through a runPercy wrapper that logs Percy's errors instead of throwing them into the user's test; PERCY_RAISE_ERROR=true restores throwing. README documents the percy / percyCaptureMode options.

PercySDK.ts is the same implementation shipped in v9 #210. No proto/gRPC changes.

Related Jira task/s

• SDK-7756 (v8 & Node follow-up)
• SDK-7711 (original — v9)

Release (mandatory for every PR — required for the ready-for-review label)

Version bump: (required — tick exactly one)

• minor (backwards-compatible feature)
• patch (bug fix or other small change)

Release notes type: (optional)

• New Feature
• Bug Fix
• Other Improvement

Release notes (customer-facing): (optional but encouraged)

• Fixed Percy visual testing on WebdriverIO: screenshots (Percy on Automate) and web snapshots are captured again. No config or code changes needed.

Release notes (internal): (required — engineer-facing; what actually changed / why)

• Rerouted web snapshot from @percy/selenium-webdriver to @percy/webdriverio (added ^3.3.4); the selenium SDK uses Selenium-only browser APIs WDIO lacks, so snapshots never worked.
• Bumped @percy/selenium-webdriver ^2.0.3 → ^2.2.8; the lockfile had locked to the broken 2.2.6 (unguarded require('selenium-webdriver') → MODULE_NOT_FOUND in WDIO), silently disabling the Automate percyScreenshot path.
• Added a runPercy wrapper so Percy errors are logged not thrown (PERCY_RAISE_ERROR=true to fail). Ports v9 fix(percy): restore Percy capture on WebdriverIO (screenshot + snapshot) #210 + fix(percy): float @percy/webdriverio to ^3.3.4 (SDK-7711) #228.

Checklist

• Ready to review
• Has it been tested locally?

PR Validations

Run Tests: Comment RUN_TESTS to trigger sanity tests.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited), Workspace UI (inherited)

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 7c1c6b5e-b5e8-4694-8d6b-6a3db28dcad1

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

---

_{Comment @coderabbitai help to get the list of available commands.}

[rounak610]

RUN_TESTS

[rounak610]

🔴 Blocking findings — fix required

[Graceful Degradation] packages/browserstack-service/src/Percy/PercySDK.ts · webSnapshot — webSnapshot falls back to percySnapshot (the pre-fix, documented-non-functional-for-WDIO capture path) if @percy/webdriverio fails to load, with only a debug-level log marking the cause. See the full review for detail and a suggested fix.

Change map (generated deterministically from the diff)

graph LR
  subgraph nwdio_service["wdio-service"]
    npackages_browserstack_service_src_Percy_PercySDK_ts["PercySDK.ts<br/>~78 lines"]
    n_changeset_pr_231_md["pr-231.md<br/>~18 lines"]
    npackages_browserstack_service_README_md["README.md<br/>~18 lines"]
    npackages_browserstack_service_package_json["package.json<br/>~3 lines"]
  end

Loading

↻ This verdict comment is the review anchor — it's updated in place on each run (the gate posts its status separately).

— SDK PR Review Agent