Skip to content

improv(idempotency): consolidate internal implementation #1642

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

Merged

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

This PR introduces a refactor of the IdempotencyHandler and makeHandlerIdempotent Middy middleware so that the latter uses logic from the former rather than duplicating logic.

Prior to this PR the middleware was reimplementing some of the logic found in the IdempotencyHandler because at the time of implementing the handler its logic was not taking into account the request lifecycle that Middy middlewares use to handle requests.

The PR adds some new methods/hooks to the handler so that most of the idempotency logic still resides in the handler. Some of the actions still need to be manual due to how Middy works, a different approach would require a complete refactor of the IdempotencyHandler class.

Related issues, RFCs

Issue number: #1508

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@dreamorosi dreamorosi self-assigned this Aug 1, 2023
@dreamorosi dreamorosi requested a review from a team August 1, 2023 14:21
@dreamorosi dreamorosi linked an issue Aug 1, 2023 that may be closed by this pull request
2 tasks
@boring-cyborg boring-cyborg bot added idempotency This item relates to the Idempotency Utility tests PRs that add or change tests labels Aug 1, 2023
@pull-request-size pull-request-size bot added the size/XL PRs between 500-999 LOC, often PRs that grown with feedback label Aug 1, 2023
@dreamorosi
Copy link
Contributor Author

@sonarqubecloud
Copy link

sonarqubecloud bot commented Aug 1, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

Copy link
Contributor

@am29d am29d left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Substantial refactor to make it easier for middy and wrapper to use the same logic. Great work!

@am29d am29d merged commit 3ad0f5c into main Aug 3, 2023
@am29d am29d deleted the 1508-maintenance-consolidate-idempotencyhandler-implementation branch August 3, 2023 14:10
@github-actions github-actions bot added the enhancement PRs that introduce minor changes, usually to existing features label Aug 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement PRs that introduce minor changes, usually to existing features idempotency This item relates to the Idempotency Utility size/XL PRs between 500-999 LOC, often PRs that grown with feedback tests PRs that add or change tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: consolidate IdempotencyHandler implementation
2 participants