feat: change operations retry logic to be opt-in #39
Conversation
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
🦋 Changeset detectedLatest commit: 9dec4fc The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
Pull Request Overview
This pull request makes the operations retry logic opt-in, allowing callers to enable retry behavior by providing the WithRetry option. Key changes include:
- Removing explicit generic type parameters from NewReport calls in tests and report generation.
- Refactoring the retry configuration to use an Enabled flag rather than a DisableRetry flag.
- Updating tests to reflect the new retry logic and naming conventions.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| operations/report_test.go | Updated NewReport invocation to match the new generic signature. |
| operations/report.go | Adjusted genericReport usage to remove explicit type arguments. |
| operations/execute_test.go | Modified test cases names and options to align with opt-in retry logic. |
| operations/execute.go | Refactored retry configuration and logic; now using an Enabled flag. |
| .changeset/tangy-plums-draw.md | Updated changeset to document the breaking change. |
operations/execute.go
Outdated
| @@ -18,16 +18,59 @@ type ExecuteConfig[IN, DEP any] struct { | |||
| type ExecuteOption[IN, DEP any] func(*ExecuteConfig[IN, DEP]) | |||
|
|
|||
| type RetryConfig[IN, DEP any] struct { | |||
| // DisableRetry disables the retry mechanism if set to true. | |||
| DisableRetry bool | |||
| // Enabled dermines if the retry is enabled for the operation. | |||
There was a problem hiding this comment.
There's a spelling mistake in the comment; change 'dermines' to 'determines'.
Suggested change
| // Enabled dermines if the retry is enabled for the operation. | |
| // Enabled determines if the retry is enabled for the operation. |
Copilot uses AI. Check for mistakes.
BREAKING CHANGE: The retry logic for operations is now opt-in. To enable the retry, the caller must now provide the `WithRetry` option to the `ExecuteOperation`. This change is intended to provide greater control over the retry behavior and to avoid unintended retries in certain scenarios.
jkongie
force-pushed
the
CLD-201/opt-in-op-retry
branch
from
87594f7 to
9dec4fc
Compare
ajaskolski
approved these changes
Apr 29, 2025
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.
BREAKING CHANGE: The retry logic for operations is now opt-in. To enable the retry, the caller must now provide the
WithRetryoption to theExecuteOperation. This change is intended to provide greater control over the retry behavior and to avoid unintended retries in certain scenarios.