Fix flaky runWithRateLimit test by using fake timers#7290
Merged
gonzaloriestra merged 1 commit intomainfrom Apr 14, 2026
Merged
Fix flaky runWithRateLimit test by using fake timers#7290gonzaloriestra merged 1 commit intomainfrom
gonzaloriestra merged 1 commit intomainfrom
Conversation
The 'throttles the task when the cache is populated recently' test was flaky because it used real time with a 1-second timeout window. Under CI load, the time between filling the rate limit cache and checking it could exceed 1 second, causing the old occurrences to be swept out and the rate limit to no longer be exceeded. Fix by using vi.useFakeTimers() to freeze time during the test, matching the pattern already used by the 'cache is populated but outdated' test in the same describe block. The existing afterEach hook already calls vi.useRealTimers() for cleanup. Also applied the same fix to the 'rate limit isn't used up' test to prevent the same class of flake.
byrichardpowell
approved these changes
Apr 14, 2026
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.
WHY are these changes introduced?
Flaky test: https://github.com/Shopify/cli/actions/runs/24396106090
The 'throttles the task when the cache is populated recently' test was flaky because it used real time with a 1-second timeout window. Under CI load, the time between filling the rate limit cache and checking it could exceed 1 second, causing the old occurrences to be swept out and the rate limit to no longer be exceeded.
WHAT is this pull request doing?
Fix by using
vi.useFakeTimers()to freeze time during the test, matching the pattern already used by the 'cache is populated but outdated' test in the same describe block. The existing afterEach hook already callsvi.useRealTimers()for cleanup.Also applied the same fix to the 'rate limit isn't used up' test to prevent the same class of flake.
How to test your changes?
CI
Checklist
pnpm changeset add