chore: migrate from TimeoutAttribute to CancelAfterAttribute #3119
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
mxschmitt
force-pushed
the
chore--migrate-from-TimeoutAttribute-to-CancelAfterAttribute
branch
2 times, most recently
from
5ed9631 to
dbbc139
Compare
mxschmitt
commented
Mar 5, 2025
|
|
||
| using System.Runtime.InteropServices; | ||
|
|
||
| [assembly: NUnit.Framework.Timeout(Microsoft.Playwright.Tests.TestConstants.DefaultTestTimeout)] |
Contributor
Author
There was a problem hiding this comment.
First line removed, second line moved to the PlaywrightTestAttribute.cs.
mxschmitt
commented
Mar 5, 2025
|
|
||
|
|
||
| [PlaywrightTest("screencast.spec.ts", "video.path()/saveAs() does not hang immediately after launchPersistentContext and context.close()")] | ||
| [CancelAfter(30_000)] |
Contributor
Author
There was a problem hiding this comment.
30 is the default, hence removed.
mxschmitt
force-pushed
the
chore--migrate-from-TimeoutAttribute-to-CancelAfterAttribute
branch
from
dbbc139 to
3cf89e5
Compare
mxschmitt
commented
Mar 5, 2025
| /// <param name="fileName"><see cref="FileName"/></param> | ||
| /// <param name="describe"><see cref="Describe"/></param> | ||
| /// <param name="nameOfTest"><see cref="TestName"/></param> | ||
| public PlaywrightTestAttribute(string fileName, string describe, string nameOfTest) : this(fileName, nameOfTest) |
Contributor
Author
There was a problem hiding this comment.
This method with this kind of signature we haven't used much, hence removed + modified the tests which used it.
There was a problem hiding this comment.
PR Overview
This PR migrates internal tests from using the TimeoutAttribute to the new CancelAfterAttribute, addressing test timeout handling and removing obsolete attributes. Key changes include:
- Adding CancelAfterAttribute usage and corresponding interface implementations in PlaywrightTestAttribute.
- Updating tests to use CancelAfter with appropriate timeout constants.
- Removing legacy timeout and parallelization assembly attributes.
Reviewed Changes
| File | Description |
|---|---|
| src/Playwright.Tests/Attributes/PlaywrightTestAttribute.cs | Extended attribute to implement additional contexts and to apply CancelAfter for timing out tests. |
| src/Playwright.Tests/PageDispatchEventTests.cs | Updated PlaywrightTest attribute usage by removing redundant parameters. |
| src/Playwright.Tests/PageWaitForNavigationTests.cs | Replaced direct timeout values with TestConstants and removed one CancelAfter attribute. |
| src/Playwright.Tests/ElementHandleConvenienceTests.cs | Updated PlaywrightTest attribute usage by removing an extra parameter. |
| src/Playwright.Tests/TestConstants.cs | Removed assembly-level attributes to align with the new timeout handling approach. |
| src/Playwright.Tests/PageEvaluateTests.cs | Removed inline description from PlaywrightTest in favor of a code comment. |
| src/Playwright.Tests/ScreencastTests.cs | Removed the CancelAfter attribute to streamline test timeout configuration. |
| src/Playwright.Tests/BrowserContextBasicTests.cs | Updated PlaywrightTest attributes to omit redundant descriptions. |
| src/Playwright.Tests/PageNetworkRequestTest.cs | Updated the PlaywrightTest attribute usage for clarity and consistency. |
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (1)
src/Playwright.Tests/PageWaitForNavigationTests.cs:317
- The removal of the CancelAfter attribute on this test might lead to unintended behavior if a test-specific timeout is expected. Please confirm that the omission of a CancelAfter configuration is intentional to avoid potential flakiness.
public async Task ShouldTakeTimeoutIntoAccount()
dgozman
approved these changes
Mar 5, 2025
mxschmitt
deleted the
chore--migrate-from-TimeoutAttribute-to-CancelAfterAttribute
branch
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.
This only affects our internal tests.
Fixes #3118