Update context, newContext and newPage description for browser module #1242
Conversation
This file contains 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
ankur22
force-pushed
the
refactor/925-refactor-contexts
branch
2 times, most recently
from
ebd370d to
6d1f78a
Compare
|
There's a version of the docs published here: https://mdr-ci.staging.k6.io/docs/refs/pull/1242/merge It will be deleted automatically in 30 days. |
We've made a change which means that there is now a 1-to-1 mapping between browser and a browserContext. This means that there can only ever be one browserContext open at any given point per browser. So the contexts method on browser now only needs to return the current browserContext.
The discription on browser.newContext needs to reflect the new change where only one browserContext can be open at any given time per browser. We need to notify the user how they can work with this new behaviour.
The description on browser.newPage needs to reflect the new change where only one browserContext can be open at any given time per browser. We need to notify the user how they can work with this new behaviour.
ankur22
force-pushed
the
refactor/925-refactor-contexts
branch
from
6d1f78a to
4ff194e
Compare
ka3de
approved these changes
Jul 5, 2023
src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/context.md
Outdated
Show resolved
Hide resolved
… browser/context.md Co-authored-by: ka3de <daniel.jimenez@grafana.com>
mdcruz
approved these changes
Jul 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Due to the change in grafana/xk6-browser#929 and grafana/xk6-browser#945, we need to update the following to reflect this new behaviour where a
browsercan only hold a singlebrowserContextand if a user wishes to create a newbrowserContextthen they can only close the existing one and create a new one.browser.contextstobrowser.contextto retrieve the currentbrowserContext.browser.newPageto help user understand how they can work with more than onebrowserContextsequentially.browser.newContextto help user understand how they can work with more than onebrowserContextsequentially.