feat(api-gateway): add debug mode

[michaelbrewer]

Issue #, if available:

• Feature Request: Add DEBUG mode to the API Gateway Event Handler powertools-lambda#4

Pairs with #506

Description of changes:

Add debug mode support:

• Pretty print json request
• Pretty print json responses
• Output full stack trace

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.

[codecov-commenter]

Codecov Report

Merging #507 (f1e6faa) into develop (f61b02f) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff            @@
##           develop     #507   +/-   ##
========================================
  Coverage    99.90%   99.90%           
========================================
  Files          107      107           
  Lines         4266     4280   +14     
  Branches       208      212    +4     
========================================
+ Hits          4262     4276   +14     
  Misses           1        1           
  Partials         3        3           

Impacted Files	Coverage Δ
aws_lambda_powertools/event_handler/api_gateway.py	100.00% <100.00%> (ø)
...s_lambda_powertools/event_handler/content_types.py	100.00% <100.00%> (ø)
aws_lambda_powertools/shared/constants.py	100.00% <100.00%> (ø)

---

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 f61b02f...f1e6faa. Read the comment docs.

[heitorlessa]

Looks good! One minor change in env var. QQ: how helpful would it be to literally print the event when this flag is enabled too?

I think this could be handled by Logger with the LOG_EVENT piece, so I'm on the fence.

[michaelbrewer]

Looks good! One minor change in env var. QQ: how helpful would it be to literally print the event when this flag is enabled too?

I think this could be handled by Logger with the LOG_EVENT piece, so I'm on the fence.

Maybe as a debug tip to turn on log event environment variable.

[michaelbrewer]

@heitorlessa ok it is all merged up.

[michaelbrewer]

@heitorlessa i added the print of the request

[michaelbrewer]

Looks good! One minor change in env var. QQ: how helpful would it be to literally print the event when this flag is enabled too?

I think this could be handled by Logger with the LOG_EVENT piece, so I'm on the fence.

I added the print part

[michaelbrewer]

@heitorlessa any other updates needed?

[heitorlessa]

Thanks a lot for the changes - I’ll check as soon as I can on Friday or early next week

…

On Wed, 7 Jul 2021 at 20:04, Michael Brewer ***@***.***> wrote: @heitorlessa <https://github.com/heitorlessa> any other updates needed? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#507 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAZPQBHMBK4TMUWLU7KNR33TWSJMLANCNFSM47ZNVXDA> .

[heitorlessa]

That's great, one tiny change so we don't use mock in a functional test and capture stdout instead, then it's good to merge :)

You know, it'd be great to have permissions to push these so I don't have to bother ya ;)

[michaelbrewer]

That's great, one tiny change so we don't use mock in a functional test and capture stdout instead, then it's good to merge :)

You know, it'd be great to have permissions to push these so I don't have to bother ya ;)

i think that only works if i do it via my personal account :)