chore: Add support for custom key prefixes in Idempotency utility

[hjgraca]

Please provide the issue number

Issue number: #703

Summary

Changes

This pull request introduces a new feature to allow custom prefixes for idempotency keys in the Idempotency utility. The changes include updates to the IdempotentAttribute class, the IdempotencyAspectHandler class, and various test cases to support and validate the new feature (including E2E tests).

New Feature: Custom Prefix for Idempotency Key

• libraries/src/AWS.Lambda.Powertools.Idempotency/IdempotentAttribute.cs: Added a KeyPrefix property to the IdempotentAttribute class to allow custom prefixes for idempotency keys. Updated the WrapSync and WrapAsync methods to pass the KeyPrefix to the IdempotencyAspectHandler. [1] [2] [3]

• libraries/src/AWS.Lambda.Powertools.Idempotency/Internal/IdempotencyAspectHandler.cs: Modified the constructor of IdempotencyAspectHandler to accept a keyPrefix parameter and updated the Configure method of the persistence store to use the keyPrefix if provided.

Persistence Store Configuration

• libraries/src/AWS.Lambda.Powertools.Idempotency/Persistence/BasePersistenceStore.cs: Updated the Configure method to handle the new keyPrefix parameter. If the keyPrefix is provided, it is used as the function name; otherwise, the environment variable or default value is used. [1] [2]

Test Cases

• Added new test cases to validate the custom prefix functionality:

  • libraries/tests/AWS.Lambda.Powertools.Idempotency.Tests/Handlers/IdempotencyAttributeWithCustomKeyPrefix.cs: Added a new handler to test idempotency with a custom key prefix on a method.
  • libraries/tests/AWS.Lambda.Powertools.Idempotency.Tests/Handlers/IdempotencyHandlerWithCustomKeyPrefix.cs: Added a new handler to test idempotency with a custom key prefix on a handler.
  • libraries/tests/AWS.Lambda.Powertools.Idempotency.Tests/Internal/IdempotentAspectTests.cs: Added new test methods to validate the custom prefix key functionality for both handlers and methods.

• Updated existing test cases to include the keyPrefix parameter where necessary:

  • libraries/tests/AWS.Lambda.Powertools.Idempotency.Tests/Persistence/BasePersistenceStoreTests.cs: Updated various test methods to pass the keyPrefix parameter to the Configure method. [1] [2] [3] [4] [5] [6] [7] [8] [9]

User experience

Please share what the user experience looks like before and after this change

Checklist

Please leave checklist items unchecked if they do not apply to your change.

• Meets tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented
• PR title follows conventional commit semantics

Is this a breaking change?

RFC issue number:

Checklist:

• Migration process documented
• Implement warnings (if it can live side by side)

Acknowledgment

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.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[codecov]

Codecov Report

Attention: Patch coverage is 95.65217% with 1 line in your changes missing coverage. Please review.

Project coverage is 73.49%. Comparing base (fb7e6c3) to head (ffda1ec).
Report is 23 commits behind head on develop.

Files with missing lines	Patch %	Lines
...ls.Idempotency/Persistence/BasePersistenceStore.cs	94.44%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #745      +/-   ##
===========================================
+ Coverage    73.46%   73.49%   +0.02%     
===========================================
  Files          203      203              
  Lines         8181     8190       +9     
  Branches       878      879       +1     
===========================================
+ Hits          6010     6019       +9     
  Misses        1880     1880              
  Partials       291      291              

Flag	Coverage Δ
unittests	73.49% <95.65%> (+0.02%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[leandrodamascena]

Super nice @hjgraca! APPROVED