fix: make logger rotation tests deterministic#172
Merged
Conversation
Replace setTimeout sleeps with awaitable waitForRotation(). Logger now tracks the rotation promise internally; tests await it instead of guessing timing. Logger test suite runs in 9ms instead of ~1500ms. Closes #171 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR makes the logger rotation tests deterministic by removing fixed setTimeout sleeps and replacing them with an awaitable mechanism tied to the logger’s actual rotation work. It fits the codebase by improving the reliability and speed of the Vitest suite around src/logger.ts’s self-managed log rotation.
Changes:
- Track the in-progress rotation via an internal
_rotationPromiseupdated when rotation starts. - Expose a testing-oriented
waitForRotation()helper so tests can await completion rather than sleep. - Update
src/logger.test.tsto useawait waitForRotation()at rotation points, reducing runtime and flakiness.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
src/logger.ts |
Tracks rotation with _rotationPromise and exports waitForRotation() to await rotation completion (used by tests). |
src/logger.test.ts |
Replaces timing-based sleeps with waitForRotation() to make rotation assertions deterministic and faster. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Replace
setTimeoutsleeps in logger rotation tests with an awaitablewaitForRotation()function. The logger now tracks its rotation promise internally; testsawaitit instead of guessing timing.Result: Logger test suite runs in ~9ms instead of ~1500ms. No more timing-dependent flakiness.
Closes #171