fix: try to fix two flaky tests - #712
Open
MathyV wants to merge 1 commit into
Open
Conversation
These tests don't fail every time, heavy CPU usage causes them to fail more often since it is more a timing issue then anything else. The keep-alive test used the same Response object for all fetch calls, so depending on the timing, a second call either failed or not. Now each call gets its own Response object. The config route test wrote the session-secret file into the working directory but didn't wait for the unlink to complete, so the file could outlive the test. It is put into the temp directory now and properly removed.
There was a problem hiding this comment.
Pull request overview
This PR aims to reduce Vitest flakiness in the JMAP client resilience suite and the config route suite by eliminating shared/lingering test state (reused Response bodies, keep-alive timers, and a shared working-directory secret file).
Changes:
- Adjusts the JMAP resilience tests to return a fresh
Responseper mockedfetchcall for keep-alive scenarios. - Adds explicit teardown of connected JMAP clients between tests to prevent keep-alive intervals from leaking across tests.
- Moves the config route test’s
SESSION_SECRET_FILEto a temp directory and removes it deterministically during teardown.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| lib/tests/jmap-client-resilience.test.ts | Improves fetch mocking and adds teardown intended to prevent keep-alive timer leakage. |
| lib/tests/config-route.test.ts | Uses a temp-backed secret file and synchronous cleanup to prevent cross-test filesystem leakage. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
53
to
60
| afterEach(() => { | ||
| // Connecting starts a keep-alive interval that outlives the test unless it | ||
| // is stopped here, and its ping then consumes a later test's mocked fetch. | ||
| connectedClients.forEach((client) => client.disconnect()); | ||
| connectedClients.length = 0; | ||
| fetchSpy.mockRestore(); | ||
| vi.useRealTimers(); | ||
| }); |
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
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.
Summary
I noticed while developing the other PR. These tests don't fail every time, heavy CPU usage causes them to fail more often since it is more a timing issue then anything else.
Changes
Related issues
None
Type of change
Checklist
npm run typecheck && npm run lintand there are no errorsnpm run build)locales/) if my changes affect user-facing textScreenshots / demo
None
Notes for reviewers
None