Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Exponential Retry Mechanism with Idempotency Headers #57

Open
5 tasks
Cliftonz opened this issue Oct 6, 2023 · 4 comments · May be fixed by #59
Open
5 tasks

Add Exponential Retry Mechanism with Idempotency Headers #57

Cliftonz opened this issue Oct 6, 2023 · 4 comments · May be fixed by #59
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@Cliftonz
Copy link

Cliftonz commented Oct 6, 2023

In order to enhance the resilience and reliability of our SDK, we would like to introduce an Exponential Retry mechanism for retrying failed requests. Additionally, to ensure the idempotent processing of requests, it's vital to incorporate support for providing an Idempotency Key as per the draft specified in the HTTP Idempotency Key Header Field.

The key requirements for this implementation include:

  1. Exponential Retry Mechanism:

    • The SDK should retry failed requests following an exponential backoff strategy to minimize the contention and impact on the systems involved.
    • The SDK should ensure that the retry mechanism is configurable (e.g., max retries, initial delay, maximum delay).
  2. Idempotency Key Provisioning:

    • The SDK should allow for either automatic or manual provisioning of an Idempotency Key for each request.
    • The Idempotency Key should conform to either CUID, ULID, or UUID formats as specified in the draft.
    • The Idempotency Key should be included in the HTTP Header as Idempotency-Key and following the standards outlined in the draft.
  3. Configuration and Documentation:

    • The SDK should provide configuration options for enabling/disabling the Exponential Retry mechanism and Idempotency Key provisioning.
    • Comprehensive documentation should be provided explaining the configuration options, operational behavior, and the benefits of using the Exponential Retry mechanism along with Idempotency Keys.

Acceptance Criteria:

  • Implementation of the Exponential Retry mechanism with configurable parameters.
  • Provisioning of Idempotency Keys, either automatically or manually, conforming to specified formats (CUID, ULID, or UUID).
  • Adequate unit and integration testing to ensure the robustness and reliability of the implemented features.
  • Comprehensive documentation on the usage and configuration of the Exponential Retry mechanism and Idempotency Key provisioning.
  • Adherence to the specifications outlined in the HTTP Idempotency Key Header Field draft.

Update: You can reference the go-lang library to keep the method signature and configuration the same.
novuhq/go-novu#62

Please refer to the draft for further details on the HTTP Idempotency Key Header Field and ensure adherence to the specified standards while implementing this feature in the SDK.

@Cliftonz Cliftonz added enhancement New feature or request help wanted Extra attention is needed labels Oct 6, 2023
@dammy001
Copy link

@Cliftonz I'm working on this.

@unicodeveloper
Copy link
Contributor

unicodeveloper commented Oct 19, 2023 via email

@unicodeveloper
Copy link
Contributor

I can see that you have a draft PR up @dammy001. So I'll assign you to the issue.

For next time, please ask to be assigned so that multiple folks are not working on the same thing at the same time.

@dammy001
Copy link

I can see that you have a draft PR up @dammy001. So I'll assign you to the issue.

For next time, please ask to be assigned so that multiple folks are not working on the same thing at the same time.

@unicodeveloper Yeah, thanks.

@dammy001 dammy001 linked a pull request Oct 19, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants