Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Browser: Register sync and async JS APIs (k6-core side) #3778

Closed
Tracked by #1362
inancgumus opened this issue Jun 7, 2024 · 0 comments · Fixed by #3793
Closed
Tracked by #1362

Browser: Register sync and async JS APIs (k6-core side) #3778

inancgumus opened this issue Jun 7, 2024 · 0 comments · Fixed by #3793
Assignees

Comments

@inancgumus
Copy link
Member

inancgumus commented Jun 7, 2024

What

Expose two JS import paths for the browser module:

  • k6/browser -> The new async API
  • k6/experimental/browser -> The old sync API

Why

The browser team has been working on migrating the existing API to Async.

With v0.52.0's release date two weeks away, we're confident that the new Async API can be delivered in one shot. Since these changes are the last piece of the API design and we don't anticipate any breaking changes in the near future, it's worth discussing the graduation of the experimental Browser API to a stable module.

Here are a few reasons that brought us to this idea:

  • With the async API, we're aligned with Playwright, and we don't expect any further breaking changes to bridge this gap.
  • Releasing the new API may make future changes in the import path more challenging.
  • Releasing the async version of the API under a separate import path, k6/browser, while keeping k6/experimental/browser for a while during the deprecation window is a non-breaking change for existing user scripts.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants