refactor(idempotent): Change UX to use a config class for non-persistence related features

[michaelbrewer]

Description of changes:

UX for idempotent decorator changes from:

import json
from aws_lambda_powertools.utilities.idempotency import DynamoDBPersistenceLayer, idempotent

# Treat everything under the "body" key in
# the event json object as our payload
persistence_layer = DynamoDBPersistenceLayer(
    event_key_jmespath="body",
    table_name="IdempotencyTable"
)

@idempotent(persistence_store=persistence_layer)
def handler(event, context):
    body = json.loads(event['body'])
    payment = create_subscription_payment(
        user=body['user'],
        product=body['product_id']
    )
    ...
    return {"message": "success", "statusCode": 200, "payment_id": payment.id}

to

import json
from aws_lambda_powertools.utilities.idempotency import DynamoDBPersistenceLayer, IdempotencyConfig, idempotent

# Treat everything under the "body" key in
# the event json object as our payload
config = IdempotencyConfig(event_key_jmespath="body")
persistence_layer = DynamoDBPersistenceLayer(table_name="IdempotencyTable")

@idempotent(config=config, persistence_store=persistence_layer)
def handler(event, context):
    body = json.loads(event['body'])
    payment = create_subscription_payment(
        user=body['user'],
        product=body['product_id']
    )
    ...
    return {"message": "success", "statusCode": 200, "payment_id": payment.id}

All other changes include:

• Skip the performance tests for the coverage-html
• pragma: no cover for old uncovered code

Checklist

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

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

[michaelbrewer]

WIP comments

[codecov-io]

Codecov Report

Merging #306 (7d4304b) into develop (153567e) will increase coverage by 0.24%.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##           develop     #306      +/-   ##
===========================================
+ Coverage    99.54%   99.79%   +0.24%     
===========================================
  Files           90       91       +1     
  Lines         3291     3340      +49     
  Branches       160      161       +1     
===========================================
+ Hits          3276     3333      +57     
+ Misses          10        5       -5     
+ Partials         5        2       -3     

Impacted Files	Coverage Δ
...ambda_powertools/utilities/idempotency/__init__.py	100.00% <100.00%> (ø)
..._lambda_powertools/utilities/idempotency/config.py	100.00% <100.00%> (ø)
...da_powertools/utilities/idempotency/idempotency.py	98.46% <100.00%> (+0.04%)	⬆️
...wertools/utilities/idempotency/persistence/base.py	99.34% <100.00%> (+5.91%)	⬆️
...ools/utilities/idempotency/persistence/dynamodb.py	100.00% <100.00%> (ø)
aws_lambda_powertools/logging/logger.py	100.00% <0.00%> (ø)
aws_lambda_powertools/tracing/tracer.py	100.00% <0.00%> (ø)
aws_lambda_powertools/metrics/metrics.py	100.00% <0.00%> (ø)
aws_lambda_powertools/logging/formatter.py	100.00% <0.00%> (ø)
aws_lambda_powertools/utilities/batch/base.py	100.00% <0.00%> (ø)
... and 7 more

---

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 153567e...7d4304b. Read the comment docs.

[heitorlessa]

One small change for consistency across utilities (or outside the constructor)

[heitorlessa]

💯

[heitorlessa]

Looks great - Hopefully when 3.6 is EOL we'll be able to move to dataclasses to make this easier too, including having a generic Config that auto-discovers env vars based on config option name

[michaelbrewer]

@heitorlessa should we add a mini project for ideas?

[heitorlessa]

to make refactoring easier later, could you please (I can do too): Use or logic outside the instantiation e.g. config = config or IdempotencyConfig()

nitpick: kwargs over args for refactoring too

[heitorlessa]

I was thinking of having this in the constructor and change the way we call it within IdempotencyHandler, but honestly that can be done later - there are a few areas we'll need to refactor, and this will be an internal change either way, and in the worst case we're calling it Beta too, it'll be a minor change IF that.

[heitorlessa]

I don't seem to have permissions to send a quick commit to fix what I asked, so I'm merging as-is, and sending a direct push to develop afterwards

[heitorlessa]

There’s an issue for enabling the new GitHub discussions - I just haven’t had time to play with it yet. Then a board to unify accepted ideas etc

…

On Fri, 5 Mar 2021 at 23:14, Michael Brewer ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In aws_lambda_powertools/utilities/idempotency/config.py <#306 (comment)> : > +class IdempotencyConfig: + def __init__( @heitorlessa <https://github.com/heitorlessa> should we add a mini project for ideas? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#306 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAZPQBH7ENPETI2WJSPHBWLTCFJUHANCNFSM4YS2X7OA> .