Add a page on sleep and wait for browser module #1730
+264
−0
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
add/sleep-wait-browser
branch
4 times, most recently
from
b6e2060
to
6139ac2
Compare
ankur22
force-pushed
the
add/sleep-wait-browser
branch
from
6139ac2
to
6c5e6e1
Compare
inancgumus
approved these changes
Sep 23, 2024
| @@ -11,3 +11,4 @@ This section presents some examples and recommended practices when working with | |||
| - [Hybrid approach to performance](https://grafana.com/docs/k6/<K6_VERSION>/using-k6-browser/recommended-practices/hybrid-approach-to-performance) | |||
| - [Page object model pattern](https://grafana.com/docs/k6/<K6_VERSION>/using-k6-browser/recommended-practices/page-object-model-pattern) | |||
| - [Selecting elements](https://grafana.com/docs/k6/<K6_VERSION>/using-k6-browser/recommended-practices/selecting-elements) | |||
| - [`sleep` and `wait*`](https://grafana.com/docs/k6/<K6_VERSION>/using-k6-browser/recommended-practices/sleep-and-wait) | |||
There was a problem hiding this comment.
I'd suggest using human-readable text, also to be consistent with the other links in this list.
Suggested change
| - [`sleep` and `wait*`](https://grafana.com/docs/k6/<K6_VERSION>/using-k6-browser/recommended-practices/sleep-and-wait) | |
| - [Simulating wait operations](https://grafana.com/docs/k6/<K6_VERSION>/using-k6-browser/recommended-practices/sleep-and-wait) |
|
|
||
| To avoid flaky tests, avoid working with `sleep` or `page.waitForTimeout` to wait for state changes with an element (such as waiting for elements to appear/disappear or navigating to a different page). | ||
|
|
||
| They are, however, useful for mimicking a real user by slowing the test down between API calls, or to debug your test. |
There was a problem hiding this comment.
I'd put this line in the first paragraph to avoid confusion. Otherwise, users might think they can still use those and unintentionally face unexpected behavior. Maybe:
While using the
sleepfunction to wait for element state changes can be helpful, it's best to avoid it to prevent unreliable tests. Instead, it's better to usewait*prepended methods for reliable tests.
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.
What?
This new page details recommendation on
sleepand the variouswait*functions available to the browser module. The main reason for doing this is to guide users away from working withsleepand instead work with the variouswait*APIs, specifically replacingsleepwithpage.waitForTimeout.Checklist
npm startcommand locally and verified that the changes look good.docs/sources/nextfolder of the documentation.Related PR(s)/Issue(s)
Updates: #1719