Rewrite createServicePolicy tests#8666
Open
mcmire wants to merge 3 commits into
Open
Conversation
The tests for `createServicePolicy` are too exhaustive and are very painful to maintain. This commit rewrites the tests so that they focus on covering all lines instead of all code paths. Note that there are still some coverage issues with `createServicePolicy` because Istanbul treats the re-exported Cockatiel functions as untested. There doesn't seem to be a way around this short of switching to v8.
Contributor
Author
|
Adding |
mcmire
commented
May 1, 2026
|
|
||
| expect(mockService).toHaveBeenCalledTimes(1); | ||
| }); | ||
| describe('execute', () => { |
Contributor
Author
There was a problem hiding this comment.
Probably best to view this file on its own rather than going through the diff.
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
1 participant
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.
Explanation
The tests for
createServicePolicyare too exhaustive and are very painful to maintain. This commit rewrites the tests so that they focus on covering all lines instead of all code paths.Note that there are still some coverage issues with
createServicePolicybecause Istanbul treats the re-exported Cockatiel functions as untested. There doesn't seem to be a way around this short of switching to v8. We may consider doing that in another commit, but that is out of scope for now.References
(Prerequisite for another PR that updates
createServicePolicy)Checklist
Note
Low Risk
Test-only refactor with no production code changes; risk is limited to possible gaps if the slimmer suite drops edge cases the old combinatorial tests covered.
Overview
Replaces the ~3.7k-line
createServicePolicytest suite with a ~1k-line version aimed at line coverage and easier maintenance instead of enumerating every combination of defaults and options.The new structure groups cases by behavior (
executesuccess/degraded listeners, always-failing retries, circuit open vs closed, recovery aftercircuitBreakDuration, customretryFilterPolicy/isServiceFailure,httpStatus, plusgetRemainingCircuitOpenDuration,getCircuitState, andreset). Shared helperscreateServicePolicyForTestingRetries(zeroConstantBackoff, auto-advance timers on retry, optionalbreakAfterFirstExecution) andcreateErroringServicecut duplicated mock/timer boilerplate.No changes to
create-service-policyimplementation in this diff—only tests and imports (ConstantBackoff,ServicePolicy).Reviewed by Cursor Bugbot for commit 1dd02ec. Bugbot is set up for automated code reviews on this repo. Configure here.