feat(idempotency): Add raise_on_no_idempotency_key flag #297

michaelbrewer · 2021-02-22T03:05:49Z

Description of changes:

Add an option to raise an error when idempotency key value is None

GIVEN a persistence_store with event_key_jmespath = body and option raise_on_no_idempotency_key
WHEN getting the hashed idempotency key with an event without a body key value
THEN raise IdempotencyKeyError

Checklist

Meet tenets criteria
Update tests
Update docs
PR title follows conventional commit semantics

Breaking change checklist

Raising any kind of error when not passing in the data for the idemptency data is not what we currently do

GIVEN a persistence_store with event_key_jmespath = `body` WHEN getting the hashed idempotency key with an event without a `body` key THEN raise IdempotencyValidationError

michaelbrewer · 2021-02-22T03:07:27Z

@cakepietoast @heitorlessa - you might want to debate this.

For example when event_key_jmespath = "[body, queryStringParameters]"
and the event is {} then the data is [None, None]

codecov-io · 2021-02-22T03:07:31Z

Codecov Report

Merging #297 (8308fe1) into develop (f1a8832) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff            @@
##           develop     #297   +/-   ##
========================================
  Coverage    99.71%   99.71%           
========================================
  Files           86       86           
  Lines         3143     3145    +2     
  Branches       149      150    +1     
========================================
+ Hits          3134     3136    +2     
  Misses           5        5           
  Partials         4        4

Impacted Files	Coverage Δ
...wertools/utilities/idempotency/persistence/base.py	`99.20% <100.00%> (+0.01%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f1a8832...8308fe1. Read the comment docs.

michaelbrewer · 2021-02-22T06:22:48Z

@cakepietoast @heitorlessa - you might want to debate this.

For example when event_key_jmespath = "[body, queryStringParameters]"
and the event is {} then the data is [None, None]

Also if we do raise an error, should it be a new type for Idempotency key errors?

Add `raise_on_no_idempotency_key` to enforce a idempotency key value is passed into the lambda.

michaelbrewer · 2021-02-25T11:36:48Z

@heitorlessa @cakepietoast - i added a raise_on_no_idempotency_key option and a new exception IdempotencyKeyError

michaelbrewer · 2021-03-02T13:49:21Z

@heitorlessa any concerns or changes needed for this PR ?

heitorlessa · 2021-03-02T13:58:09Z

I’ll look into this tomorrow morning and update here as soon as I can.

…

On Tue, 2 Mar 2021 at 14:49, Michael Brewer ***@***.***> wrote: @heitorlessa <https://github.com/heitorlessa> any concerns or changes needed for this PR ? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#297 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAZPQBGI5BSLL64OLRLETILTBTUHDANCNFSM4X7V2Q3A> .

heitorlessa · 2021-03-03T12:49:03Z

Checking this now

heitorlessa

LGTM after logic to catch iterables like empty tuple and dicts as well as doc

aws_lambda_powertools/utilities/idempotency/persistence/base.py

tests/functional/idempotency/test_idempotency.py

heitorlessa · 2021-03-03T13:09:35Z

docs/utilities/idempotency.md

+### Making idempotency key required
+
+By default, events without any idempotency key don't raise any exception and just trigger a warning.
+If you want to ensure that at an idempotency is found, you can pass in `raise_on_no_idempotency_key` as True and an


Not sure what you mean by "If you want to ensure that at an idempotency is found" - could you simplify this to non-native English speakers, please?

Take in account for empty data structures, including non-lists iterables like tuples, dictionaries Co-authored-by: Heitor Lessa <heitor.lessa@hotmail.com>

Co-authored-by: Heitor Lessa <heitor.lessa@hotmail.com>

heitorlessa · 2021-03-03T13:49:39Z

Merging it - Thanks a lot @michaelbrewer 🎉

feat(idempotencty): Raise error when event data is None

8308fe1

GIVEN a persistence_store with event_key_jmespath = `body` WHEN getting the hashed idempotency key with an event without a `body` key THEN raise IdempotencyValidationError

michaelbrewer changed the title ~~feat(idempotencty): Raise error when event data is None~~ feat(idempotency): Option to raise an error when idempotency key is None Feb 25, 2021

feat(idempotency): Add raise_on_no_idempotency_key

fc8b053

Add `raise_on_no_idempotency_key` to enforce a idempotency key value is passed into the lambda.

michaelbrewer changed the title ~~feat(idempotency): Option to raise an error when idempotency key is None~~ feat(idempotency): Add raise_on_no_idempotency_key flag Feb 25, 2021

Michael Brewer added 2 commits February 26, 2021 17:38

Merge branch 'develop' into feat-indemptency-none-for-idempotency_key

2508e6f

Merge branch 'develop' into feat-indemptency-none-for-idempotency_key

335a430

heitorlessa added the area/utilities label Mar 3, 2021

heitorlessa suggested changes Mar 3, 2021

View reviewed changes

fix: Include empty data structures

6fa4824

Take in account for empty data structures, including non-lists iterables like tuples, dictionaries Co-authored-by: Heitor Lessa <heitor.lessa@hotmail.com>

github-actions bot removed the area/utilities label Mar 3, 2021

Michael Brewer and others added 4 commits March 3, 2021 05:15

tests: Include tests for empty data structures

fd04193

Co-authored-by: Heitor Lessa <heitor.lessa@hotmail.com>

Merge branch 'develop' into feat-indemptency-none-for-idempotency_key

a33b1c5

fix: tests

03176b1

docs: Make some doc changes

351846c

heitorlessa approved these changes Mar 3, 2021

View reviewed changes

heitorlessa added the area/utilities label Mar 3, 2021

heitorlessa self-assigned this Mar 3, 2021

heitorlessa merged commit 6e293b1 into aws-powertools:develop Mar 3, 2021

michaelbrewer deleted the feat-indemptency-none-for-idempotency_key branch March 3, 2021 13:52

heitorlessa added enhancement feature New feature or functionality and removed enhancement labels Mar 3, 2021

dependabot bot mentioned this pull request Mar 8, 2021

Bump aws-lambda-powertools from 1.10.5 to 1.11.0 in /lambda/src plus3it/terraform-aws-org-new-account-iam-role#33

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(idempotency): Add raise_on_no_idempotency_key flag #297

feat(idempotency): Add raise_on_no_idempotency_key flag #297

michaelbrewer commented Feb 22, 2021 •

edited

Loading

michaelbrewer commented Feb 22, 2021

codecov-io commented Feb 22, 2021 •

edited

Loading

michaelbrewer commented Feb 22, 2021

michaelbrewer commented Feb 25, 2021 •

edited

Loading

michaelbrewer commented Mar 2, 2021

heitorlessa commented Mar 2, 2021 via email

heitorlessa commented Mar 3, 2021

heitorlessa left a comment

heitorlessa Mar 3, 2021

heitorlessa commented Mar 3, 2021

feat(idempotency): Add raise_on_no_idempotency_key flag #297

feat(idempotency): Add raise_on_no_idempotency_key flag #297

Conversation

michaelbrewer commented Feb 22, 2021 • edited Loading

Description of changes:

Breaking change checklist

michaelbrewer commented Feb 22, 2021

codecov-io commented Feb 22, 2021 • edited Loading

Codecov Report

michaelbrewer commented Feb 22, 2021

michaelbrewer commented Feb 25, 2021 • edited Loading

michaelbrewer commented Mar 2, 2021

heitorlessa commented Mar 2, 2021 via email

heitorlessa commented Mar 3, 2021

heitorlessa left a comment

Choose a reason for hiding this comment

heitorlessa Mar 3, 2021

Choose a reason for hiding this comment

heitorlessa commented Mar 3, 2021

michaelbrewer commented Feb 22, 2021 •

edited

Loading

codecov-io commented Feb 22, 2021 •

edited

Loading

michaelbrewer commented Feb 25, 2021 •

edited

Loading