Merge branch 'develop' of https://github.com/ran-isenberg/aws-lambda-powertools-python into develop

Author: ran-isenberg

.github/scripts/label_related_issue.js

@@ -1,53 +1,29 @@
-const {
-  PR_AUTHOR,
-  PR_BODY,
-  PR_NUMBER,
-  IGNORE_AUTHORS,
-  LABEL_PENDING_RELEASE,
-  HANDLE_MAINTAINERS_TEAM,
-  PR_IS_MERGED,
-} = require("./constants")
-
 module.exports = async ({github, context, core}) => {
-    if (IGNORE_AUTHORS.includes(PR_AUTHOR)) {
-      return core.notice("Author in IGNORE_AUTHORS list; skipping...")
-    }
-
-    if (PR_IS_MERGED == "false") {
-      return core.notice("Only merged PRs to avoid spam; skipping")
-    }
+    const prBody = context.payload.body;
+    const prNumber = context.payload.number;
+    const releaseLabel = process.env.RELEASE_LABEL;
+    const maintainersTeam = process.env.MAINTAINERS_TEAM
 
     const RELATED_ISSUE_REGEX = /Issue number:[^\d\r\n]+(?<issue>\d+)/;
 
-    const isMatch = RELATED_ISSUE_REGEX.exec(PR_BODY);
-
-    try {
-      if (!isMatch) {
-        core.setFailed(`Unable to find related issue for PR number ${PR_NUMBER}.\n\n Body details: ${PR_BODY}`);
-        return await github.rest.issues.createComment({
-          owner: context.repo.owner,
-          repo: context.repo.repo,
-          body: `${HANDLE_MAINTAINERS_TEAM} No related issues found. Please ensure '${LABEL_PENDING_RELEASE}' label is applied before releasing.`,
-          issue_number: PR_NUMBER,
-        });
-      }
-    } catch (error) {
-      core.setFailed(`Unable to create comment on PR number ${PR_NUMBER}.\n\n Error details: ${error}`);
-      throw new Error(error);
-    }
-
-    const { groups: {issue} } = isMatch
-
-    try {
-      core.info(`Auto-labeling related issue ${issue} for release`)
-      return await github.rest.issues.addLabels({
-        issue_number: issue,
+    const isMatch = RELATED_ISSUE_REGEX.exec(prBody);
+    if (!isMatch) {
+      core.setFailed(`Unable to find related issue for PR number ${prNumber}.\n\n Body details: ${prBody}`);
+      return await github.rest.issues.createComment({
         owner: context.repo.owner,
         repo: context.repo.repo,
-        labels: [LABEL_PENDING_RELEASE]
-      })
-    } catch (error) {
-      core.setFailed(`Is this issue number (${issue}) valid? Perhaps a discussion?`);
-      throw new Error(error);
+        body: `${maintainersTeam} No related issues found. Please ensure '${releaseLabel}' label is applied before releasing.`,
+        issue_number: prNumber,
+      });
     }
+
+    const { groups: {relatedIssueNumber} } = isMatch
+
+    core.info(`Auto-labeling related issue ${relatedIssueNumber} for release`)
+    return await github.rest.issues.addLabels({
+      issue_number: relatedIssueNumber,
+      owner: context.repo.owner,
+      repo: context.repo.repo,
+      labels: [releaseLabel]
+    })
 }

docs/core/event_handler/api_gateway.md

@@ -3,11 +3,11 @@ title: REST API
 description: Core utility
 ---
 
-Event handler for Amazon API Gateway REST and HTTP APIs, Application Loader Balancer (ALB), and Lambda Function URLs.
+Event handler for Amazon API Gateway REST and HTTP APIs, and Application Loader Balancer (ALB).
 
 ## Key Features
 
-* Lightweight routing to reduce boilerplate for API Gateway REST/HTTP API, ALB and Lambda Function URLs.
+* Lightweight routing to reduce boilerplate for API Gateway REST/HTTP API and ALB
 * Support for CORS, binary and Gzip compression, Decimals JSON encoding and bring your own JSON serializer
 * Built-in integration with [Event Source Data Classes utilities](../../utilities/data_classes.md){target="_blank"} for self-documented event schema
 
@@ -18,31 +18,23 @@ Event handler for Amazon API Gateway REST and HTTP APIs, Application Loader Bala
 
 ### Required resources
 
-If you're using any API Gateway integration, you must have an existing [API Gateway Proxy integration](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html){target="_blank"} or [ALB](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/lambda-functions.html){target="_blank"} configured to invoke your Lambda function.
+You must have an existing [API Gateway Proxy integration](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html){target="_blank"} or [ALB](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/lambda-functions.html){target="_blank"} configured to invoke your Lambda function.
 
-This is the sample infrastructure for API Gateway and Lambda Function URLs we are using for the examples in this documentation.
+This is the sample infrastructure for API Gateway we are using for the examples in this documentation.
 
 ???+ info "There is no additional permissions or dependencies required to use this utility."
 
-=== "API Gateway SAM Template"
-
-    ```yaml title="AWS Serverless Application Model (SAM) example"
-    --8<-- "examples/event_handler_rest/sam/template.yaml"
-    ```
-
-=== "Lambda Function URL SAM Template"
-
-    ```yaml title="AWS Serverless Application Model (SAM) example"
-    --8<-- "examples/event_handler_lambda_function_url/sam/template.yaml"
-    ```
+```yaml title="AWS Serverless Application Model (SAM) example"
+--8<-- "examples/event_handler_rest/sam/template.yaml"
+```
 
 ### Event Resolvers
 
 Before you decorate your functions to handle a given path and HTTP method(s), you need to initialize a resolver.
 
 A resolver will handle request resolution, including [one or more routers](#split-routes-with-router), and give you access to the current event via typed properties.
 
-For resolvers, we provide: `APIGatewayRestResolver`, `APIGatewayHttpResolver`, `ALBResolver`, and `LambdaFunctionUrlResolver` .
+For resolvers, we provide: `APIGatewayRestResolver`, `APIGatewayHttpResolver`, and `ALBResolver`.
 
 ???+ info
     We will use `APIGatewayRestResolver` as the default across examples.
@@ -95,22 +87,6 @@ When using Amazon Application Load Balancer (ALB) to front your Lambda functions
 --8<-- "examples/event_handler_rest/src/getting_started_alb_api_resolver.py"
 ```
 
-#### Lambda Function URL
-
-When using [AWS Lambda Function URL](https://docs.aws.amazon.com/lambda/latest/dg/urls-configuration.html), you can use `LambdaFunctionUrlResolver`.
-
-=== "getting_started_lambda_function_url_resolver.py"
-
-    ```python hl_lines="5 11" title="Using Lambda Function URL resolver"
-    --8<-- "examples/event_handler_lambda_function_url/src/getting_started_lambda_function_url_resolver.py"
-    ```
-
-=== "getting_started_lambda_function_url_resolver.json"
-
-    ```json hl_lines="4-5" title="Example payload delivered to the handler"
-    --8<-- "examples/event_handler_lambda_function_url/src/getting_started_lambda_function_url_resolver.json"
-    ```
-
 ### Dynamic routes
 
 You can use `/todos/<todo_id>` to configure dynamic URL paths, where `<todo_id>` will be resolved at runtime.
@@ -222,7 +198,7 @@ You can use **`not_found`** decorator to override this behavior, and return a cu
 
 You can use **`exception_handler`** decorator with any Python exception. This allows you to handle a common exception outside your route, for example validation errors.
 
-```python hl_lines="13-14" title="Exception handling"
+```python hl_lines="14 15" title="Exception handling"
 --8<-- "examples/event_handler_rest/src/exception_handling.py"
 ```
 
@@ -291,7 +267,7 @@ This will ensure that CORS headers are always returned as part of the response w
 
 #### Pre-flight
 
-Pre-flight (OPTIONS) calls are typically handled at the API Gateway or Lambda Function URL level as per [our sample infrastructure](#required-resources), no Lambda integration is necessary. However, ALB expects you to handle pre-flight requests.
+Pre-flight (OPTIONS) calls are typically handled at the API Gateway level as per [our sample infrastructure](#required-resources), no Lambda integration necessary. However, ALB expects you to handle pre-flight requests.
 
 For convenience, we automatically handle that for you as long as you [setup CORS in the constructor level](#cors).
 
@@ -360,8 +336,6 @@ Like `compress` feature, the client must send the `Accept` header with the corre
 ???+ warning
     This feature requires API Gateway to configure binary media types, see [our sample infrastructure](#required-resources) for reference.
 
-???+ note
-    Lambda Function URLs handle binary media types automatically.
 === "binary_responses.py"
 
     ```python hl_lines="14 20"
@@ -403,7 +377,7 @@ This will enable full tracebacks errors in the response, print request and respo
 
 ### Custom serializer
 
-You can instruct event handler to use a custom serializer to best suit your needs, for example take into account Enums when serializing.
+You can instruct API Gateway handler to use a custom serializer to best suit your needs, for example take into account Enums when serializing.
 
 ```python hl_lines="35 40" title="Using a custom JSON serializer for responses"
 --8<-- "examples/event_handler_rest/src/custom_serializer.py"
@@ -413,7 +387,7 @@ You can instruct event handler to use a custom serializer to best suit your need
 
 As you grow the number of routes a given Lambda function should handle, it is natural to split routes into separate files to ease maintenance - That's where the `Router` feature is useful.
 
-Let's assume you have `split_route.py` as your Lambda function entrypoint and routes in `split_route_module.py`. This is how you'd use the `Router` feature.
+Let's assume you have `app.py` as your Lambda function entrypoint and routes in `split_route_module.py`, this is how you'd use the `Router` feature.
 
 === "split_route_module.py"
 
@@ -524,7 +498,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.
     * Engineering discipline is necessary for both approaches. Micro-function approach however requires further attention in consistency as the number of functions grow, just like any distributed system.
 * **Harder to share code**. Shared code must be carefully evaluated to avoid unnecessary deployments when that changes. Equally, if shared code isn't a library,
 your development, building, deployment tooling need to accommodate the distinct layout.