feat: Warn on floating promises #34845
Merged
Conversation
This file contains hidden or 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
…loating-promise-warning
This comment has been minimized.
This comment has been minimized.
agg23
commented
Feb 18, 2025
This comment has been minimized.
This comment has been minimized.
| return testInfo._wrapPromiseAPIResult(this._stepInternal(expectation, testInfo, title, body, options)); | ||
| } | ||
|
|
||
| async _stepInternal<T>(expectation: 'pass'|'skip', testInfo: TestInfoImpl, title: string, body: (step: TestStepInfo) => T | Promise<T>, options: {box?: boolean, location?: Location, timeout?: number } = {}): Promise<T> { |
Member
There was a problem hiding this comment.
Code in /common/* should not accept TestInfoImpl that only exists in /worker/ process.
Contributor
Author
There was a problem hiding this comment.
I'm confused by this statement. We're already directly referencing TestInfoImpl a few lines above: https://github.com/microsoft/playwright/blob/main/packages/playwright/src/common/testType.ts#L251. That doesn't have an explicit type, but the original _step method consumes the type as an argument to body.
Contributor
Test results for "tests 1"10 flaky38623 passed, 794 skipped Merge workflow run. |
pavelfeldman
approved these changes
Feb 19, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Prints a warning when a Playwright API promise that is expected to always be awaited is never attached to by the end of the test run. This warning is managed via a normal test annotation.
This could follow in a separate PR, but at the time of writing this PR includes changes to the various terminal reporters to display warnings (annotations with
type: 'warning'), grouping them by warning type. The HTML reporter doesn't have any special handling; it displays like a normal annotation right now, though we will likely change this in the future.