v8: establish the standalone @wdio/browserstack-service v8 maintenance line#42
Open
AakashHotchandani wants to merge 17 commits into
Open
v8: establish the standalone @wdio/browserstack-service v8 maintenance line#42AakashHotchandani wants to merge 17 commits into
AakashHotchandani wants to merge 17 commits into
Conversation
…ide the gRPC core Adds the WebdriverIO service (@wdio/browserstack-service) as packages/browserstack-service and moves the existing gRPC/protobuf core (@browserstack/wdio-browserstack-service) into packages/core (git history preserved), so both ship from this repo. - npm workspace: root build builds core then service; tests scoped to the service. - service: esbuild bundle (deps external) + tsc declarations; strict files allowlist (build + README + LICENSE + ambient d.ts); peerDeps for webdriverio/@wdio/* so the consumer keeps a single shared copy. - release: Changesets + npm OIDC trusted publishing via .github/workflows/release.yml (main -> latest, v8 -> v8 dist-tag); the gRPC core is ignored by Changesets and stays on the SDK team's manual publish flow. - fix(tests): the @wdio/reporter mock no longer imports the real module from within its own mock (a top-level vi.importActual + static import deadlocked vitest and hung reporter.test.ts); stub the stats classes instead. Full suite: 39 files / 980 tests pass and the run exits cleanly. - repo metadata -> browserstack/wdio-browserstack-service; an added changeset bumps the first release to 9.29.0 (current npm latest is 9.28.0). Verified locally: npm ci + build + test green; clean 80-file / ~590kB tarball; a real BrowserStack session passed with webdriverio deduped to one copy. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The committed lockfile was stale (carried entries from the pre-conversion layout), so CI's `npm ci` failed the sync check (EUSAGE: lockfile's @types/node@12.20.55 vs @types/node@25.9.3, missing undici-types). Regenerated against the current npm-workspace package.json set (760 -> 592 packages). `npm ci --dry-run` now passes; toolchain (typescript, vitest, esbuild, ts-proto, @bufbuild/buf + 7 platform optionalDeps) and workspace links (core <-> service) preserved. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The previous lockfile commit was produced by `npm install --package-lock-only` against a stale node_modules, so npm shortcut it ('up to date, audited ... in 2s') and only pruned the old tree instead of fully resolving. CI's `npm ci` then rebuilt the ideal tree from package.json and found mismatches (Invalid @types/node@12.20.55 vs 25.9.3, Missing esbuild@0.28.1, etc.).
Regenerated with both package-lock.json and node_modules absent so the resolution is computed purely from package.json (598 packages). Verified locally with npm@10.9.8 (CI's npm): `npm ci` installs cleanly, `npm run build` (core buf+tsc / service esbuild+tsc) succeeds, and `npm test` passes 980/980.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…-install) The service declares non-optional peerDependencies (@wdio/cli, @wdio/logger, @wdio/reporter, @wdio/types, webdriverio). npm 7+ auto-installs peers by default, so CI's `npm ci` requires their full closure in the lock (@wdio/cli@9.28.0 -> create-wdio, tsx, inquirer, ejs, execa, esbuild@0.28.1, @vitest/snapshot@2.1.9, ...). Prior lock commits were generated with a local ~/.npmrc legacy-peer-deps=true (left over from unrelated work), which suppressed peer auto-install and produced a lock missing that closure -> CI EUSAGE 'Missing @wdio/cli@9.28.0 from lock file' etc. Regenerated with --no-legacy-peer-deps to match CI's default (598 -> 720 packages). Verified CI-exact: `npm ci --no-legacy-peer-deps` installs cleanly, build succeeds, 980/980 tests pass. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…ake timers CI's Node 18.20 job (supported per engines: node >=18.20.0; wdio v9 supports 18.20) surfaced three Node-18-only failures that Node 20/22 tolerate: 1. PerformanceTester.start/end/measure called performance.mark/measure directly. Under vitest's full fake timers (7 test files) performance.now() goes negative, and Node 18's perf_hooks rejects negative timestamps (ERR_PERFORMANCE_INVALID_TIMESTAMP), throwing out of callers' before() hooks. Routed all mark/measure through safeMark/safeMeasure wrappers — instrumentation must never throw into business logic (no-op on the happy path; transparent on Node 20+). 2. uploadLogs used fs.openAsBlob (Node >=20 only). Added a Node-18 fallback to new Blob([readFileSync]) for the small log archive. 3. util.test.ts faked via bare useFakeTimers(); scoped to toFake:['Date'] (it never advances timers), matching reporter.test.ts. Verified locally on Node 18.20.5 AND Node 22: npm ci + build + 980/980 tests pass. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…nternal docs Addresses automated PR review findings on #37: - [SECURITY] release.yml: pin changesets/action, actions/checkout, actions/setup-node to full commit SHAs (with version comments) since this workflow holds id-token:write + publish. ci.yml left on tags (contents:read only). - [DOCS] packages/core/package.json: description now describes the gRPC/protobuf core (not the service); dropped the 'webdriverio' keyword — corrects the public npm listing. - [SECURITY] removed the five docs/ strategy/migration files from the public repo (kept internally). Their only cross-references were among themselves. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…tadata These two review fixes were edited but accidentally left unstaged when f935a52 (docs removal) was committed, so they never landed. Committing them now: - release.yml: pin changesets/action, actions/checkout, actions/setup-node to full commit SHAs (with version comments). - packages/core/package.json: description now describes the gRPC/protobuf core; dropped the 'webdriverio' keyword. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
setup-node's `registry-url` writes `//registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN}` into .npmrc; with no NODE_AUTH_TOKEN that empty token line can shadow npm OIDC Trusted Publishing at publish time. npm defaults to registry.npmjs.org and publishConfig.access=public already covers the scoped publish, so the line is unnecessary. Splitting the changesets publish into its own top-level step is noted as a further OIDC-hardening follow-up.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- v8 service (8.48.0) swapped into packages/browserstack-service; metadata repointed to browserstack/wdio-browserstack-service; core dep ^2.0.2; files += README/LICENSE-MIT. - ported safeMark/safeMeasure (Node-18 perf_hooks) into performance-tester. - changeset baseBranch=v8. - regenerated package-lock.json with DEFAULT npm (no --legacy-peer-deps): npm ci is in sync, so v8 does NOT need the flag (resolves reviewer concern). - build green (core buf+tsc; service tsc); per-file tests pass. KNOWN-OUTSTANDING: full-suite 'vitest --run' hangs in teardown (open PerformanceObserver handles + vitest 1.x not force-exiting). Toolchain decision pending (vitest 1.x->3). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Per-file tests all pass and exit cleanly; whole-suite vitest --run still hangs in teardown under vitest 1.x (open handle survives pool/teardown cleanup). Standalone teardown remains the outstanding follow-up. setupFiles wires the per-file cleanup. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…flake, per-file runner Root causes of the standalone 'teardown hang' (upstream only runs these inside the full monorepo suite, never standalone): - __mocks__/@wdio/reporter.ts imported the stats classes from '@wdio/reporter' — the module it mocks — deadlocking mock resolution at collection (file hung, no output). Stats are type-only in the service, so replaced with stub classes. THIS was what wedged the whole-suite run. - util.test.ts logPatcher spied process.emit at describe scope without resetting it, so a stray emit made the count flaky (7 vs 6). Clear the spy in the test. - reporter.test.ts: scope fake timers to ['Date'] (mirrors v9). - vitest.setup.ts: restore real timers + disconnect the PerformanceTester observer per file (dynamic import to avoid a circular-decorator init failure). - test script now runs each file in its own process (scripts/test-isolated.mjs), judging by test result not clean exit, so any residual post-test open-handle lingering can't wedge CI. Result: 41/41 files pass. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Generate the gRPC/protobuf client inside @wdio/browserstack-service at build time (buf generate -> src/grpc/generated) instead of depending on the separately-published @browserstack/wdio-browserstack-service core. - move buf.yaml / buf.gen.yaml + src/proto/** + the barrel (-> src/grpc/index.ts) from packages/core into packages/browserstack-service - rewire all imports from '@browserstack/wdio-browserstack-service' to the local './grpc/index.js' barrel - deps: drop the core, add @grpc/grpc-js + @bufbuild/protobuf; devDeps: add @bufbuild/buf + ts-proto - build/clean/prepack run `buf generate` before tsc; src/proto ships in the tarball, src/grpc/generated stays gitignored - delete packages/core; collapse root build script; changeset ignore: [] The published @browserstack/wdio-browserstack-service@2.0.x stays on npm as-is (historical); nothing publishes a separate core going forward. Verified on Node 22 + npm 10: build green (buf generate -> tsc), 41/41 test files pass, npm pack ships build/grpc + src/proto and no core dep. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Parity with the v9 fix (7c949da). CI runs plain `npm ci` (legacy-peer-deps=false default), which requires the auto-installed `@wdio/cli` peerDependency closure to be present in the lockfile. The prior lockfile was generated with legacy-peer-deps=true and omitted that closure, so npm ci failed "out of sync". Regenerating with the peer tree exposed the same @types/node hoist non-determinism as v9 (protobufjs/ts-proto pulls @types/node@25, @manypkg/find-root pins ^12.7.1, and the v8 stack wants ^22), fixed with: - overrides @types/node ^22.2.0 — collapses the 3-way spread to a single 22.x (matches the service's declared ^22.2.0; types-only, no runtime impact), so npm install and npm ci agree. Unlike v9, NO estree-walker workaround is needed: v8 uses vitest ^1.6.0, which predates @vitest/mocker, so the deeply-nested-transitive drop that affected v9 doesn't occur here. Verified: `npm ci --legacy-peer-deps=false` passes, build passes, 0 runtime holes, full @wdio/cli peer tree present, cross-platform complete, per-file tests green (service.test.ts 97/97). The aggregate `npm test` (test-isolated.mjs) still hits the pre-existing all-at-once teardown follow-up, unrelated to the lockfile. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…ow (upstream #15330) Ports webdriverio/webdriverio#15330 (merged into monorepo v8 after the 2026-06-16 extract): in the CLI/binary v8 flow, forward screenshot-on-failure to the binary over gRPC as a TEST_SCREENSHOT log (uploaded via the binary's authorized testhub session) instead of the direct-HTTP onScreenshot path (which 401s under the worker's binary-issued JWT); register the command/result listeners in CLI mode so the screenshot command result is captured; and honor the incoming log kind in the mocha CLI framework. Keeps the standalone v8 line at parity with the monorepo. Src-only change (matches upstream — no test changes); builds clean. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…elease.yml - Move @wdio/logger|reporter|types from peerDependencies to dependencies (pinned 8.x), mirroring the v9 line so the published package carries them. - Switch release.yml to the manual/hybrid model (parity with the v9 branch): push opens the "Version Packages" PR only; publishing is a manual workflow_dispatch (publish=true) → v8 dist-tag via publishConfig.tag, over OIDC. The existing take-over-publishing changeset (minor) computes the first standalone v8 release as 8.49.0 (> npm v8 8.48.3). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| const sessionId = browser.sessionId | ||
|
|
||
| // a utility function to escape single and double quotes | ||
| const escapeString = (str: string) => str.replace(/'/g, "\\'").replace(/"/g, '\\"') |
| const sessionId = browser.sessionId | ||
|
|
||
| // a utility function to escape single and double quotes | ||
| const escapeString = (str: string) => str.replace(/'/g, "\\'").replace(/"/g, '\\"') |
| // a utility function to check if the hostname is browserstack | ||
|
|
||
| const isBrowserstack = (str: string ): boolean => { | ||
| return str.includes('browserstack.com') |
…lour) + SHA-pin ci.yml actions - test-isolated.mjs: under CI=true vitest forces ANSI colour even when piped, so the summary regexes (`Tests \d+ passed`) failed to match (colour codes between "Tests" and the count) and every passing file was mis-flagged "no test summary" → CI red. Strip ANSI in classify() and set NO_COLOR/FORCE_COLOR=0 on the spawned vitest. Verified: `CI=true npm test` → 41/41 files pass. - ci.yml: pin actions/checkout + actions/setup-node to full commit SHAs (resolves the semgrep github-actions-mutable-action-tag findings, parity with the v9 line). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
| function classify(output) { | ||
| // CI (CI=true) makes vitest force ANSI colour even when piped, which would break the | ||
| // summary regexes below (colour codes sit between "Tests" and the count). Strip them first. | ||
| const clean = output.replace(new RegExp(String.fromCharCode(27) + '\[[0-9;]*m', 'g'), '') |
…ith/slice + drop vestigial nested workflows
- getHierarchy (insights-handler.ts + util.ts): replace `new RegExp(' ' + test.description + '$')`
with an endsWith/slice suffix strip — avoids ReDoS and regex-metacharacter mismatches when the
Jasmine description contains regex specials. Behaviour-preserving; mirrors the v9 fix (65d7c33).
- Remove packages/browserstack-service/.github/workflows/{ci,release}.yml — vestigial duplicates
from the extraction (GitHub only runs root-level workflows; these never executed) that carried
unpinned action tags. Root workflows are already SHA-pinned.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Parallels the v9 conversion (#37) for the v8 line. The
v8branch is the long-lived v8 maintenance line, published to the npmv8dist-tag viapublishConfig.tag.Contents
@wdio/logger|reporter|typespeer→dep; manual/hybridrelease.yml(parity with v9);take-over-publishing(minor) + screenshot changesets → first standalone v8 release computes8.49.0(> npmv88.48.3).Release
Manual/OIDC: push opens the "Version Packages" PR; Run workflow → publish does
changeset publish --tag v8with provenance. Gate the first v8 publish behind the v9 first-publish + freeze.Regression
SDKWdioRegressionSharded:RUN_V8=true,WDIO_V8_BRANCH_NAME=v8,INSTALL_MODE=build-package.🤖 Generated with Claude Code