[v8] Implement BrowserStack CLI support in browserstack service by AdityaHirapara · Pull Request #14617 · webdriverio/webdriverio

AdityaHirapara · 2025-07-07T18:30:12Z

Proposed changes

This implements changes in the BrowserStack service to enable BrowserStack products via BrowserStack CLI in the background.
As per the discussion here, this is to work in the direction of moving BrowserStack product-related logic out of webdriverio.

To summarise changes, this implementation consists of

Implementation of CLI binary download, start, connect, and stop workflows.
Framework instance to share context of ongoing test, and track test events to perform browserstack logic inside test lifecycle
Automation instance (similar to test instance) to share context of the browser(driver) running test, and track driver events lifecycle.
Product modules which register events on test and driver lifecycle, to perform product logic.
grpc utils and protobuffer files to implement communication between CLI binary and WDIO service.
Additionally, for now, we will need to keep old modules for fallback, in case the CLI flow fails. We can remove old code, once we verify the stability of the CLI flow.

Types of changes

Polish (an improvement for an existing feature)
Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation update (improvements to the project's docs)
Specification changes (updates to WebDriver command specifications)
Internal updates (everything related to internal scripts, governance documentation and CI files)

Checklist

I have read the CONTRIBUTING doc
I have added tests that prove my fix is effective or that my feature works
I have added the necessary documentation (if appropriate)
I have added proper type definitions for new commands (if appropriate)

Backport Request

//: # (The current main branch is the development branch for WebdriverIO v9. If your change should be released to the current major version of WebdriverIO (v8), please raise another PR with the same changes against the v8 branch.)

This change is solely for v9 and doesn't need to be back-ported
Back-ported PR at #XXXXX

Further comments

Reviewers: @webdriverio/project-committers

…nd testhub module with dummy hook

…event

AdityaHirapara · 2025-07-30T21:13:48Z

@christian-bromann, as you suggested, we will move proto files to a separate npm package, and publish compiled js files to import in browserstack service. This includes all .proto files at packages/wdio-browserstack-service/src/proto/browserstack/sdk/v1/.
Post that, can we consider this PR good for review and merge?

christian-bromann · 2025-07-31T04:33:34Z

Post that, can we consider this PR good for review and merge?

Sounds good!

Add ignore hooks support for v8

Wdio v8 cli

xxshubhamxx · 2025-08-22T13:41:52Z

Hi @christian-bromann
We have moved out the management of the proto files to an external npm module so that it doesn't affect the WebdriverIO project or complicates its build process.
Could you please review the PR?

christian-bromann · 2025-08-24T04:12:54Z

.gitignore

+packages/wdio-browserstack-service/src/proto/*.ts
+


Suggested change

packages/wdio-browserstack-service/src/proto/*.ts

christian-bromann · 2025-08-24T04:14:39Z

packages/wdio-browserstack-service/tsconfig.json

+    "src/@types/**/*"
+  ],
+  "exclude": [
+    "src/proto/**/*"


This should be reverted too?

christian-bromann · 2025-08-24T04:15:34Z

packages/wdio-types/src/Options.ts

+     * })
+     * ```
+     */
+    commonCapabilities?: WebdriverIO.Capabilities


I don't think we should add an option for BS specific things

xxshubhamxx · 2025-08-26T22:43:06Z

Hi @christian-bromann,
I’ve implemented the changes from your review comments.
Could you please review again at the earliest convenience?

xxshubhamxx · 2025-08-28T19:16:37Z

Hi @christian-bromann,
Gentle Reminder

xxshubhamxx · 2025-08-31T23:10:19Z

Hi @christian-bromann,
Gentle Reminder

xxshubhamxx · 2025-09-08T13:08:45Z

Hi @christian-bromann,
Gentle Reminder

AdityaHirapara and others added 30 commits May 19, 2025 15:17

Implement browserStack CLI initial setup

9f4a888

Invoke CLI start and stop from browserstack service

799e1c4

Fix linting and refactor

256ac2a

Add sample unit tests

29f6210

added unit tests

aa1c7ad

Implement classes to track test and automation framework instances, a…

e50cf97

…nd testhub module with dummy hook

Set nearest hub config from CLI response

df1c190

Add check

df348dd

updated unit tests

ed594c0

Pass platform index from worker id

71eceb1

Implement Testhub and O11y modules

2eb89de

Add support for download link env variable

7b8f996

Automate and app automate changes

2f662e2

Add grpc methods for driverInit and testSessionFramework requests

fd717b7

Implement webdriverIO module

148c88c

Load webdriver module and implement testhub hook to send testSession …

a444ed5

…event

Updated calls to CLI module

222d9f2

cli changes

277a479

minor change

360a5f7

Merge branch 'bstack_cli_testhub_o11y_v8' into bstack_cli_modules_v8

67562cd

Implement logic to report test results at testFinished

4b33245

Fix linting

b00aa9e

Fix config to use o11y options

061596e

Trigger test events via cli module

59d6614

Move testEvent calls to service for common trigger

56de453

Fix linting

1525bde

Fix error in logging

321dcfd

Fixes in o11y module

f89cb03

Invoke o11y module in CLI flow

cd466db

Enable o11y sync via CLI event

019ef21

xxshubhamxx and others added 15 commits July 31, 2025 12:07

Merge pull request #4 from xxshubhamxx/v8-ignore-hooks-support

9e5b56d

Add ignore hooks support for v8

Merge branch 'v8' into wdio-v8-cli

cd564db

SDK-3773: Removal of CLI Integration

4decec4

SDK-3773: Update the package name

c1e1878

revert package file changes

ff0cb06

Update the package files

2694ea6

update: change local .gz path to package version

eccb554

Minor fix

49488ed

Merge pull request #27 from xxshubhamxx/wdio-v8-cli

e500eb9

Wdio v8 cli

Merge remote-tracking branch 'upstream/v8' into wdio_cli_v8_key_metrics

c2fcf35

fix linter warning

f5fcc5f

Update package-lock.json

f7c6b70

Update package-lock.json

f997f7f

Code Fixes

f9b1e23

fix: npm ci

a4bc102

christian-bromann requested changes Aug 24, 2025

View reviewed changes

xxshubhamxx added 3 commits August 25, 2025 21:56

Merge remote-tracking branch 'upstream/v8' into wdio_cli_v8_key_metrics

20edcd9

Review comments

b8a2ffc

Review comment to remove additional capability

6927207

Removing an empty line

9583f72

christian-bromann approved these changes Sep 9, 2025

View reviewed changes

christian-bromann merged commit 232170e into webdriverio:v8 Sep 9, 2025
7 of 8 checks passed

kamal-kaur04 mentioned this pull request Oct 8, 2025

[v9] Implement BrowserStack CLI support in browserstack service #14796

Merged

13 tasks

Uh oh!

Conversation

AdityaHirapara commented Jul 7, 2025

Proposed changes

Types of changes

Checklist

Backport Request

Further comments

Reviewers: @webdriverio/project-committers

Uh oh!

AdityaHirapara commented Jul 30, 2025

Uh oh!

christian-bromann commented Jul 31, 2025

Uh oh!

xxshubhamxx commented Aug 22, 2025

Uh oh!

christian-bromann Aug 24, 2025

Choose a reason for hiding this comment

Uh oh!

xxshubhamxx Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

christian-bromann Aug 24, 2025

Choose a reason for hiding this comment

Uh oh!

xxshubhamxx Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

christian-bromann Aug 24, 2025

Choose a reason for hiding this comment

Uh oh!

xxshubhamxx Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

xxshubhamxx commented Aug 26, 2025

Uh oh!

xxshubhamxx commented Aug 28, 2025

Uh oh!

xxshubhamxx commented Aug 31, 2025

Uh oh!

xxshubhamxx commented Sep 8, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants