fix(puppeteer,playwright): Await page close at end of test #487
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
|
|
|
Hey @jpveooys, Thank you for your contribution, we will review this today |
1 similar comment
|
Hey @jpveooys, Thank you for your contribution, we will review this today |
Zidious
requested changes
Mar 30, 2022
packages/playwright/src/index.ts
Outdated
Comment on lines
288
to
296
| try { | ||
| return await blankPage.evaluate(axeFinishRun, { | ||
| partialResults, | ||
| options | ||
| }) | ||
| .finally(() => { | ||
| blankPage.close(); | ||
| }); | ||
| } finally { | ||
| await blankPage.close(); | ||
| } | ||
| } |
There was a problem hiding this comment.
We should be able to await the blankPage.close() from within the finally block without the use of the try:
return await blankPage
.evaluate(axeFinishRun, {
partialResults,
options
})
.finally(async () => {
await blankPage.close();
});
Comment on lines
277
to
286
| try { | ||
| return await blankPage.evaluate( | ||
| axeFinishRun, | ||
| partialResults as JSONArray, | ||
| axeOptions as JSONObject | ||
| ) | ||
| .finally(() => { | ||
| blankPage.close(); | ||
| }); | ||
| ); | ||
| } finally { | ||
| await blankPage.close(); | ||
| } | ||
| } |
There was a problem hiding this comment.
Same here:
return await blankPage
.evaluate(
axeFinishRun,
partialResults as JSONArray,
axeOptions as JSONObject
)
.finally(async () => {
await blankPage.close();
});This resolves an intermittent 'ProtocolError: Protocol error (Target.closeTarget): Target closed.' error at the end of a test suite run depending on the environment.
In the interest of correctness and to match puppeteer.
7b64e99 to
74dbcb5
Compare
|
Hi @Zidious I've amended that – though I'd point out the rest of code in those files is using try blocks rather then promise methods, so I'm not sure what the reluctance is here. Thanks |
|
|
Due to circleCI not performing the tests, we will need to cherry pick this PR to get it merged. |
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.
Resolves #484
This awaits the page close to resolve the intermittent error at the end of a test suite run mentioned in the linked issue.
The error was observed for Puppeteer, but the same fix is applied here for Playwright in the interest of correctness and consistency.
I'm not aware of any easy way to test for the original error, but all existing tests should be passing.