feat: Improve performance of ByRole in waitFor* #590
Merged
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
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit a184166:
|
kentcdodds
previously approved these changes
May 28, 2020
|
🎉 This PR is included in version 7.6.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
4 tasks
Open
4 tasks
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:
Closes #552
Why:
Error diagnostics are the most expensive part of
ByRoleand are completely wasted in successfulfindByqueries.In the test profiled we spent 11.5 ms in
queryAllByRoleand180msingetElementError.Profile on master: https://drive.google.com/file/d/1tagr32Pzo7eU4MoEJZcq-4h6tgTBFDkA/view?usp=sharing
Profile with this PR: https://drive.google.com/file/d/18y3fnD9f46rU6dR-dPvIM52zdNog16Ll/view?usp=sharing
How:
Add a variable at the module scope that controls whether we run these expensive diagnostics. In
waitForwe flip this tofalsewhen running the given callback.This reduces the time spent in
getElementErrorto 2ms (only pretty printing the DOM).This means we improve runtime by (in this particular instance) 94%.
The issue is that on timeout the user is left without useful diagnostics. We could run the callback again with expensive diagnostics enabled but this would make the passed
timeoutless exact. Would that be a problem?Checklist:
[ ]Documentation added to thedocs site
[ ]I've prepared a PR for types targetingDefinitelyTyped