feat(event_handlers): Add support for Lambda Function URLs #1408

rubenfonseca · 2022-08-03T12:03:33Z

Issue number: #1142, #1141

Summary

Changes

Please provide a summary of what's being changed

This PR adds support for Lambda Function URL events (data class) and event handlers.

Data Class

For now, it seems that Lambda Function URL events follow the exact same payload as HTTP APIs Payload Format Version 2.0.

Event Handler

Certain keys in this payload format don't make sense for function urls (e.g: routeKey, stage). These keys will have default values that come on the payload, but they are not useful since they can't be changed.

User experience

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

Users could already use Lambda Function URLs before by using the API Gateway HTTP API data classes and handlers. However, we make the usage explicit and prepare for any future deviation from the API Gateway format.

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Meet 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.

View rendered docs/core/event_handler/api_gateway.md
View rendered docs/index.md
View rendered docs/utilities/data_classes.md

gwlester · 2022-08-03T15:30:48Z

Looks good -- thanks much!!!!

aws_lambda_powertools/event_handler/lambda_function_url.py

jplock

Please correct spelling errors

codecov-commenter · 2022-08-03T20:33:46Z

Codecov Report

Merging #1408 (eaebeee) into develop (144e9cc) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff            @@
##           develop    #1408   +/-   ##
========================================
  Coverage    99.89%   99.89%           
========================================
  Files          119      121    +2     
  Lines         5456     5480   +24     
  Branches       624      627    +3     
========================================
+ Hits          5450     5474   +24     
  Misses           2        2           
  Partials         4        4

Impacted Files	Coverage Δ
aws_lambda_powertools/event_handler/__init__.py	`100.00% <100.00%> (ø)`
aws_lambda_powertools/event_handler/api_gateway.py	`100.00% <100.00%> (ø)`
...da_powertools/event_handler/lambda_function_url.py	`100.00% <100.00%> (ø)`
aws_lambda_powertools/logging/correlation_paths.py	`100.00% <100.00%> (ø)`
...mbda_powertools/utilities/data_classes/__init__.py	`100.00% <100.00%> (ø)`
.../utilities/data_classes/api_gateway_proxy_event.py	`100.00% <100.00%> (ø)`
...lambda_powertools/utilities/data_classes/common.py	`100.00% <100.00%> (ø)`
...tilities/data_classes/lambda_function_url_event.py	`100.00% <100.00%> (ø)`

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

heitorlessa

looks great, thank you @rubenfonseca !!!! Minor suggestions that you can easily commit, then we're good to merge and release tomorrow!

heitorlessa · 2022-08-04T09:34:50Z

aws_lambda_powertools/event_handler/api_gateway.py

@@ -546,6 +552,9 @@ def _to_proxy_event(self, event: Dict) -> BaseProxyEvent:
        if self._proxy_type == ProxyEventType.APIGatewayProxyEventV2:
            logger.debug("Converting event to API Gateway HTTP API contract")
            return APIGatewayProxyEventV2(event)
+        if self._proxy_type == ProxyEventType.LambdaFunctionUrlEvent:


note to future self: we should improve the return type to a more accurate one with @overload.

note to future self: wait for python 3.10 to actually have proper pattern matching

aws_lambda_powertools/event_handler/lambda_function_url.py

aws_lambda_powertools/logging/correlation_paths.py

aws_lambda_powertools/event_handler/lambda_function_url.py

docs/core/event_handler/api_gateway.md

heitorlessa · 2022-08-04T10:01:05Z

docs/core/event_handler/api_gateway.md

@@ -501,7 +526,7 @@ A micro function means that your final code artifact will be different to each f

 **Downsides**

-* **Upfront investment**. You need custom build tooling to bundle assets, including [C bindings for runtime compatibility](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html){target="_blank"}. `Operations become more elaborate — you need to standardize tracing labels/annotations, structured logging, and metrics to pinpoint root causes.
+* **Upfront investment**. You need custom build tooling to bundle assets, including [C bindings for runtime compatibility](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html){target="_blank"}. Operations become more elaborate — you need to standardize tracing labels/annotations, structured logging, and metrics to pinpoint root causes.


great catch!!

docs/index.md

heitorlessa · 2022-08-04T10:03:09Z

examples/event_handler_lambda_function_url/sam/template.yaml

+        POWERTOOLS_SERVICE_NAME: example
+    FunctionUrlConfig:
+      Cors: # see CORS section
+        # Notice that values here are Lists of Strings, vs comma-separated values on API Gateway


Great note!

examples/event_handler_lambda_function_url/sam/template.yaml

heitorlessa · 2022-08-04T10:16:20Z

YES except we won’t be able to use it (unless someone backported it? :/

…

On Thu, 4 Aug 2022 at 12:13, Ruben Fonseca ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In aws_lambda_powertools/event_handler/api_gateway.py <#1408 (comment)> : > @@ -546,6 +552,9 @@ def _to_proxy_event(self, event: Dict) -> BaseProxyEvent: if self._proxy_type == ProxyEventType.APIGatewayProxyEventV2: logger.debug("Converting event to API Gateway HTTP API contract") return APIGatewayProxyEventV2(event) + if self._proxy_type == ProxyEventType.LambdaFunctionUrlEvent: note to future self: wait for python 3.10 to actually have proper pattern matching <https://peps.python.org/pep-0634/> — Reply to this email directly, view it on GitHub <#1408 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAZPQBDYSRNV2NIQ6OXQAY3VXOJWDANCNFSM55OS2IVQ> . You are receiving this because you were assigned.Message ID: ***@***.*** com>

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

heitorlessa · 2022-08-04T12:06:54Z

Merging! Should be out in our next release tomorrow

rubenfonseca added 3 commits August 3, 2022 13:46

feat(event_sources): add support for Lambda Function URL events

a8b3f48

feat(event_handlers): add support for Lambda Function URL

aca525c

chore(docs): add documentation for Lambda Functoin URLs

cb3bc5b

pull-request-size bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Aug 3, 2022

boring-cyborg bot added documentation Improvements or additions to documentation event_handlers logger tests utilities labels Aug 3, 2022

chore(docs): remove file commited by mistake

1039c04

github-actions bot added the feature New feature or functionality label Aug 3, 2022

pull-request-size bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Aug 3, 2022

rubenfonseca added area/event_handlers labels Aug 3, 2022

rubenfonseca added 2 commits August 3, 2022 14:12

chore(docs): updated links

febe483

chore(docs): typo

184d84f

rubenfonseca marked this pull request as ready for review August 3, 2022 12:24

rubenfonseca requested a review from a team as a code owner August 3, 2022 12:24

rubenfonseca requested review from heitorlessa and removed request for a team August 3, 2022 12:24

This was referenced Aug 3, 2022

Feature request: Add Event Source Data Class for AWS Lambda Function URLs #1141

Closed

Feature request: Add Event handler for AWS Lambda Function URLs #1142

Closed

jplock reviewed Aug 3, 2022

View reviewed changes

aws_lambda_powertools/event_handler/lambda_function_url.py Outdated Show resolved Hide resolved

jplock reviewed Aug 3, 2022

View reviewed changes

aws_lambda_powertools/event_handler/lambda_function_url.py Outdated Show resolved Hide resolved

jplock reviewed Aug 3, 2022

View reviewed changes

chore: typos

0711e6d

rubenfonseca requested a review from jplock August 3, 2022 20:29

heitorlessa self-assigned this Aug 4, 2022

rubenfonseca changed the title ~~feat(event_sources,event_handlers): Add support for Lambda Function URLs~~ feat(event_handlers): Add support for Lambda Function URLs Aug 4, 2022

heitorlessa suggested changes Aug 4, 2022

View reviewed changes

rubenfonseca and others added 3 commits August 4, 2022 12:18

chore(event_handlers): apply suggestions from code review

a47f6eb

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

chore(tests): add missing new line

8ccf4b6

chore(tests): typo

eaebeee

rubenfonseca requested review from heitorlessa and removed request for jplock August 4, 2022 10:43

heitorlessa approved these changes Aug 4, 2022

View reviewed changes

heitorlessa merged commit 5dfc459 into aws-powertools:develop Aug 4, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(event_handlers): Add support for Lambda Function URLs #1408

feat(event_handlers): Add support for Lambda Function URLs #1408

rubenfonseca commented Aug 3, 2022 •

edited

Loading

gwlester commented Aug 3, 2022

jplock left a comment

codecov-commenter commented Aug 3, 2022 •

edited

Loading

heitorlessa left a comment

heitorlessa Aug 4, 2022

rubenfonseca Aug 4, 2022

heitorlessa Aug 4, 2022

heitorlessa Aug 4, 2022

heitorlessa commented Aug 4, 2022 via email

heitorlessa commented Aug 4, 2022

feat(event_handlers): Add support for Lambda Function URLs #1408

feat(event_handlers): Add support for Lambda Function URLs #1408

Conversation

rubenfonseca commented Aug 3, 2022 • edited Loading

Summary

Changes

Data Class

Event Handler

User experience

Checklist

Acknowledgment

gwlester commented Aug 3, 2022

jplock left a comment

Choose a reason for hiding this comment

codecov-commenter commented Aug 3, 2022 • edited Loading

Codecov Report

heitorlessa left a comment

Choose a reason for hiding this comment

heitorlessa Aug 4, 2022

Choose a reason for hiding this comment

rubenfonseca Aug 4, 2022

Choose a reason for hiding this comment

heitorlessa Aug 4, 2022

Choose a reason for hiding this comment

heitorlessa Aug 4, 2022

Choose a reason for hiding this comment

heitorlessa commented Aug 4, 2022 via email

heitorlessa commented Aug 4, 2022

rubenfonseca commented Aug 3, 2022 •

edited

Loading

codecov-commenter commented Aug 3, 2022 •

edited

Loading