E2E: Fix performance tests by making inserter search container waiting optional #46268
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
tyxla
added
[Type] Performance
|
Size Change: +23 B (0%) Total Size: 1.33 MB
ℹ️ View Unchanged
|
youknowriad
approved these changes
Dec 2, 2022
youknowriad
reviewed
Dec 2, 2022
| @@ -103,7 +103,13 @@ async function waitForInserterCloseAndContentFocus() { | |||
| * Wait for the inserter search to yield results because that input is debounced. | |||
| */ | |||
| async function waitForInserterSearch() { | |||
| await page.waitForSelector( '.block-editor-inserter__no-tab-container' ); | |||
| try { | |||
There was a problem hiding this comment.
Potentially we could use Promise.any and only wait like 2 seconds or so
There was a problem hiding this comment.
True, we could. We could also reduce the timeout of waitForSelector() to like 2 seconds, which should be more than enough. No need to wait for the full 30 seconds. Done in fc8f801
There was a problem hiding this comment.
I think a universal solution to this could be using the Page.waitForResponse method. AFAIR, both previous and current Inserter versions use the /search endpoint, so something like this should improve stability and require less maintenance at the same time:
async function waitForInserterSearch() {
return await page.waitForResponse( '/search' );
}There was a problem hiding this comment.
To be extra sure the response is not returned before the waitForInserterSearch is called, I'd refactor a bit further and couple waitForRequest with the term input so that we start waiting before the search request is triggered, for example:
async function inserterSearch( searchTerm ) {
return await Promise.all( [
page.waitForResponse( `/search?term=${ searchTerm }` ),
page.keyboard.type( searchTerm )
] );
}Puppeteer doesn't seem to recommend this convention, but Playwright does. I think both implementations work the same way, so my recommendation would be going with the Playwright convention, also because we're currently migrating to it :)
Does that make sense?
There was a problem hiding this comment.
Makes a lot of sense! Thanks for offering a better alternative @WunderBart! Would you like to follow up with that, or should I give it a go?
There was a problem hiding this comment.
Thanks a bunch, @WunderBart 🙌
There was a problem hiding this comment.
Sharing an early WiP #46366 - did a bit more than planned, but it's mostly removing unnecessary waits and code duplication. Waiting for the test results now! 🤞
There was a problem hiding this comment.
Thanks @WunderBart! Let me know when you feel it's ready for a look.
There was a problem hiding this comment.
It's basically ready, @tyxla. I'm still looking at the few tests that keep failing, but they don't seem to be related to the change, and they do pass for me locally. 🤔 I've just updated the branch with the current trunk, so hopefully it helps. 🤞
|
Performance tests are now passing in |
mpkelly
pushed a commit
to mpkelly/gutenberg
that referenced
this pull request
Dec 7, 2022
…g optional (WordPress#46268) * E2E: Fix performance tests by making inserter search container waiting optional * Set timeout to 2s
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?
In #46153 we broke the performance tests because we started waiting for a selector that doesn't exist in older versions. This PR fixes it by making that selector optional.
Why?
In older versions, this wrapper doesn't exist, nor is the inserter search debounced.
How?
We're still waiting for the selector, but catching the error if it's not found in order to continue with the e2e test execution.
Testing Instructions
Verify all e2e tests and performance tests still pass.