Repository navigation
test(e2e): Wait for the soft navigation entry before hiding the page - #25127
Merged
Lms24 merged 1 commit intoOct 8, 2026
Merged
Lms24 merged 1 commit into
Lms24 merged 1 commit into
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
The soft navigation web vitals tests hid the page right after the click. If Chrome delivered the soft-navigation entry after that, web-vitals reported CLS for the pageload instead and never finalized the soft navigation's metrics, so the test timed out. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor
size-limit report 📦
|
Sorry, something went wrong.
Lms24
marked this pull request as ready for review
October 7, 2026 10:33
Comment thread
dev-packages/test-utils/src/page.ts
Comment on lines
+97
to
+107
| // The SDK's observer was registered first, so it is notified first. Resolving from a task after | ||
| // ours runs lets it handle the entry before the caller continues. | ||
| const observer = new PerformanceObserver(() => { | ||
| observer.disconnect(); | ||
| setTimeout(resolve, 0); | ||
| }); | ||
| observer.observe({ type: 'soft-navigation', buffered: true }); | ||
| }); | ||
| }); | ||
| /* oxlint-enable no-restricted-globals */ | ||
| } |
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Bug: The waitForSoftNavigation function lacks a timeout. If the browser doesn't emit a 'soft-navigation' entry, the test will hang until the global timeout, instead of failing quickly.
Severity: MEDIUM
Add a timeout to the waitForSoftNavigation function, similar to the pattern used in the hidePage function. A setTimeout can be used to reject the promise after a reasonable duration if no 'soft-navigation' entry is received, preventing the test from hanging.
Prompt for AI AgentReview the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: dev-packages/test-utils/src/page.ts#L88-L107 Potential issue: The `waitForSoftNavigation` function waits for a 'soft-navigation' `PerformanceEntry` from the browser, but it lacks a timeout or fallback mechanism. According to browser documentation, these entries are not guaranteed to be generated for every navigation. If an entry is not created for any reason (e.g., browser heuristics not met, a race condition, or a browser quirk), the promise will never resolve. This will cause the test to hang for the full test runner timeout (e.g., 30 seconds) instead of failing quickly. A similar function, `hidePage`, includes a `setTimeout` fallback to prevent this exact issue.
Did we get this right? 👍 / 👎 to inform future reviews.
Sorry, something went wrong.
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
That's the point
Sorry, something went wrong.
logaretm
approved these changes
Oct 7, 2026
logaretm
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
I like the util 👍
Sorry, something went wrong.
47 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
Assignees
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.
The soft navigation web vitals tests hid the page right after the click. Chrome only delivers the soft-navigation entry once the new route has painted, so it can arrive after the page is hidden. web-vitals then reports CLS for the pageload, and never finalizes the soft navigation's metrics, so the test times out. This was flaky on develop, e.g. in this run, where vue-3 (latest) and vue-3 (vue-router 5) both timed out.
The tests now wait for the soft-navigation entry before calling hidePage, using a new waitForSoftNavigation helper in test-utils.