docs: recommend alternatives to timeouts and update reviewer checklist #53156
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.
Summary
This PR improves the documentation around usage of timeouts in WPT tests. It provides recommended alternatives to using
setTimeout
and updates the reviewer checklist to align with these practices.Changes Made
testharness-api.md
:requestAnimationFrame
(ideally two frames) for rendering-related delays.step_timeout()
is acceptable, such as in APNG or reftest cases.checklist.md
:requestAnimationFrame
as better alternatives.step_timeout
) should only be used when necessary.Why
Timeouts in tests are a common source of flakiness and instability. This update addresses [Issue #20715]
by helping test authors and reviewers adopt more stable and reliable testing patterns.
Let me know if you’d like more clarification or examples added. Thanks!