Broyster 🕶️🦪

^{(browser + oyster)}

Broyster runs your Vitest browser mode tests on real browsers in BrowserStack, using Selenium WebDriver to drive the remote browsers. It orchestrates one Vitest process per browser, routes the remote browsers back to your local test server through a pluggable transport (BrowserStack Local tunnel or Cloudflare Tunnel), retries failed test files automatically, and marks the BrowserStack sessions as passed or failed.

Project structure:

• node — the test tools. Published as an @fpjs-incubator/broyster Node package.
• example_project — an example project that uses the testing tools.

Quick start

Make sure you have Node.js 22.13 or newer (the pnpm 11 floor) and pnpm installed.

pnpm install
pnpm --dir node build

Then run:

# Run example tests in a local browser (Chromium via Playwright)
pnpm --dir example_project test:local

# Or run example tests on BrowserStack
# For Linux, macOS and WSL (Linux on Windows)
BROWSERSTACK_USERNAME=your-username BROWSERSTACK_ACCESS_KEY=your-key pnpm --dir example_project test:browserstack

See the package readme for usage and configuration.

Contributing

See the Contribution guidelines to learn how to contribute to the project or run the project locally. Please read it carefully before making a pull request.