Merge branch 'develop' into docs/dynamic-feature-toggles

* develop:
  feat(params): expose high level max_age, raise_on_transform_error (#567)
  fix(parser): apigw wss validation check_message_id; housekeeping (#553)
  chore(deps-dev): bump isort from 5.9.2 to 5.9.3 (#574)
  feat(data-classes): decode json_body if based64 encoded (#560)
  chore(deps-dev): bump mkdocs-material from 7.2.0 to 7.2.1 (#566)

Author: heitorlessa

aws_lambda_powertools/tracing/tracer.py

@@ -335,7 +335,7 @@ def decorate(event, context, **kwargs):
     # see #465
     @overload
     def capture_method(self, method: "AnyCallableT") -> "AnyCallableT":
-        ...
+        ...  # pragma: no cover
 
     @overload
     def capture_method(
@@ -344,7 +344,7 @@ def capture_method(
         capture_response: Optional[bool] = None,
         capture_error: Optional[bool] = None,
     ) -> Callable[["AnyCallableT"], "AnyCallableT"]:
-        ...
+        ...  # pragma: no cover
 
     def capture_method(
         self,

aws_lambda_powertools/utilities/data_classes/common.py

@@ -65,7 +65,7 @@ def body(self) -> Optional[str]:
     @property
     def json_body(self) -> Any:
         """Parses the submitted body as json"""
-        return json.loads(self["body"])
+        return json.loads(self.decoded_body)
 
     @property
     def decoded_body(self) -> str:

aws_lambda_powertools/utilities/feature_toggles/appconfig_fetcher.py

@@ -1,5 +1,5 @@
 import logging
-from typing import Any, Dict, Optional
+from typing import Any, Dict, Optional, cast
 
 from botocore.config import Config
 
@@ -56,11 +56,15 @@ def get_json_configuration(self) -> Dict[str, Any]:
             parsed JSON dictionary
         """
         try:
-            return self._conf_store.get(
-                name=self.configuration_name,
-                transform=TRANSFORM_TYPE,
-                max_age=self._cache_seconds,
-            )  # parse result conf as JSON, keep in cache for self.max_age seconds
+            # parse result conf as JSON, keep in cache for self.max_age seconds
+            return cast(
+                dict,
+                self._conf_store.get(
+                    name=self.configuration_name,
+                    transform=TRANSFORM_TYPE,
+                    max_age=self._cache_seconds,
+                ),
+            )
         except (GetParameterError, TransformParameterError) as exc:
             error_str = f"unable to get AWS AppConfig configuration file, exception={str(exc)}"
             self._logger.error(error_str)

aws_lambda_powertools/utilities/idempotency/idempotency.py

@@ -78,9 +78,7 @@ def idempotent(
         try:
             return idempotency_handler.handle()
         except IdempotencyInconsistentStateError:
-            if i < max_handler_retries:
-                continue
-            else:
+            if i == max_handler_retries:
                 # Allow the exception to bubble up after max retries exceeded
                 raise
 
@@ -117,7 +115,6 @@ def __init__(
         self.context = context
         self.event = event
         self.lambda_handler = lambda_handler
-        self.max_handler_retries = 2
 
     def handle(self) -> Any:
         """

aws_lambda_powertools/utilities/idempotency/persistence/dynamodb.py

@@ -154,7 +154,7 @@ def _update_record(self, data_record: DataRecord):
             "ExpressionAttributeNames": expression_attr_names,
         }
 
-        self.table.update_item(**kwargs)
+        self.table.update_item(**kwargs)  # type: ignore
 
     def _delete_record(self, data_record: DataRecord) -> None:
         logger.debug(f"Deleting record for idempotency key: {data_record.idempotency_key}")

aws_lambda_powertools/utilities/parameters/appconfig.py

@@ -12,7 +12,7 @@
 
 from ...shared import constants
 from ...shared.functions import resolve_env_var_choice
-from .base import DEFAULT_PROVIDERS, BaseProvider
+from .base import DEFAULT_MAX_AGE_SECS, DEFAULT_PROVIDERS, BaseProvider
 
 CLIENT_ID = str(uuid4())
 
@@ -110,6 +110,7 @@ def get_app_config(
     application: Optional[str] = None,
     transform: Optional[str] = None,
     force_fetch: bool = False,
+    max_age: int = DEFAULT_MAX_AGE_SECS,
     **sdk_options
 ) -> Union[str, list, dict, bytes]:
     """
@@ -127,6 +128,8 @@ def get_app_config(
         Transforms the content from a JSON object ('json') or base64 binary string ('binary')
     force_fetch: bool, optional
         Force update even before a cached item has expired, defaults to False
+    max_age: int
+        Maximum age of the cached value
     sdk_options: dict, optional
         Dictionary of options that will be passed to the Parameter Store get_parameter API call
 
@@ -165,4 +168,6 @@ def get_app_config(
 
     sdk_options["ClientId"] = CLIENT_ID
 
-    return DEFAULT_PROVIDERS["appconfig"].get(name, transform=transform, force_fetch=force_fetch, **sdk_options)
+    return DEFAULT_PROVIDERS["appconfig"].get(
+        name, max_age=max_age, transform=transform, force_fetch=force_fetch, **sdk_options
+    )

aws_lambda_powertools/utilities/parameters/dynamodb.py

@@ -3,7 +3,7 @@
 """
 
 
-from typing import Any, Dict, Optional
+from typing import Dict, Optional
 
 import boto3
 from boto3.dynamodb.conditions import Key
@@ -141,11 +141,6 @@ class DynamoDBProvider(BaseProvider):
         c   Parameter value c
     """
 
-    table: Any = None
-    key_attr = None
-    sort_attr = None
-    value_attr = None
-
     def __init__(
         self,
         table_name: str,

aws_lambda_powertools/utilities/parameters/secrets.py

@@ -8,7 +8,7 @@
 import boto3
 from botocore.config import Config
 
-from .base import DEFAULT_PROVIDERS, BaseProvider
+from .base import DEFAULT_MAX_AGE_SECS, DEFAULT_PROVIDERS, BaseProvider
 
 
 class SecretsProvider(BaseProvider):
@@ -94,7 +94,11 @@ def _get_multiple(self, path: str, **sdk_options) -> Dict[str, str]:
 
 
 def get_secret(
-    name: str, transform: Optional[str] = None, force_fetch: bool = False, **sdk_options
+    name: str,
+    transform: Optional[str] = None,
+    force_fetch: bool = False,
+    max_age: int = DEFAULT_MAX_AGE_SECS,
+    **sdk_options
 ) -> Union[str, dict, bytes]:
     """
     Retrieve a parameter value from AWS Secrets Manager
@@ -107,6 +111,8 @@ def get_secret(
         Transforms the content from a JSON object ('json') or base64 binary string ('binary')
     force_fetch: bool, optional
         Force update even before a cached item has expired, defaults to False
+    max_age: int
+        Maximum age of the cached value
     sdk_options: dict, optional
         Dictionary of options that will be passed to the get_secret_value call
 
@@ -143,4 +149,6 @@ def get_secret(
     if "secrets" not in DEFAULT_PROVIDERS:
         DEFAULT_PROVIDERS["secrets"] = SecretsProvider()
 
-    return DEFAULT_PROVIDERS["secrets"].get(name, transform=transform, force_fetch=force_fetch, **sdk_options)
+    return DEFAULT_PROVIDERS["secrets"].get(
+        name, max_age=max_age, transform=transform, force_fetch=force_fetch, **sdk_options
+    )

aws_lambda_powertools/utilities/parameters/ssm.py

@@ -186,7 +186,12 @@ def _get_multiple(self, path: str, decrypt: bool = False, recursive: bool = Fals
 
 
 def get_parameter(
-    name: str, transform: Optional[str] = None, decrypt: bool = False, force_fetch: bool = False, **sdk_options
+    name: str,
+    transform: Optional[str] = None,
+    decrypt: bool = False,
+    force_fetch: bool = False,
+    max_age: int = DEFAULT_MAX_AGE_SECS,
+    **sdk_options
 ) -> Union[str, list, dict, bytes]:
     """
     Retrieve a parameter value from AWS Systems Manager (SSM) Parameter Store
@@ -201,6 +206,8 @@ def get_parameter(
         If the parameter values should be decrypted
     force_fetch: bool, optional
         Force update even before a cached item has expired, defaults to False
+    max_age: int
+        Maximum age of the cached value
     sdk_options: dict, optional
         Dictionary of options that will be passed to the Parameter Store get_parameter API call
 
@@ -240,7 +247,9 @@ def get_parameter(
     # Add to `decrypt` sdk_options to we can have an explicit option for this
     sdk_options["decrypt"] = decrypt
 
-    return DEFAULT_PROVIDERS["ssm"].get(name, transform=transform, force_fetch=force_fetch, **sdk_options)
+    return DEFAULT_PROVIDERS["ssm"].get(
+        name, max_age=max_age, transform=transform, force_fetch=force_fetch, **sdk_options
+    )
 
 
 def get_parameters(
@@ -249,6 +258,8 @@ def get_parameters(
     recursive: bool = True,
     decrypt: bool = False,
     force_fetch: bool = False,
+    max_age: int = DEFAULT_MAX_AGE_SECS,
+    raise_on_transform_error: bool = False,
     **sdk_options
 ) -> Union[Dict[str, str], Dict[str, dict], Dict[str, bytes]]:
     """
@@ -266,6 +277,11 @@ def get_parameters(
         If the parameter values should be decrypted
     force_fetch: bool, optional
         Force update even before a cached item has expired, defaults to False
+    max_age: int
+        Maximum age of the cached value
+    raise_on_transform_error: bool, optional
+        Raises an exception if any transform fails, otherwise this will
+        return a None value for each transform that failed
     sdk_options: dict, optional
         Dictionary of options that will be passed to the Parameter Store get_parameters_by_path API call
 
@@ -305,4 +321,11 @@ def get_parameters(
     sdk_options["recursive"] = recursive
     sdk_options["decrypt"] = decrypt
 
-    return DEFAULT_PROVIDERS["ssm"].get_multiple(path, transform=transform, force_fetch=force_fetch, **sdk_options)
+    return DEFAULT_PROVIDERS["ssm"].get_multiple(
+        path,
+        max_age=max_age,
+        transform=transform,
+        raise_on_transform_error=raise_on_transform_error,
+        force_fetch=force_fetch,
+        **sdk_options
+    )

aws_lambda_powertools/utilities/parser/models/apigw.py

@@ -68,6 +68,13 @@ class APIGatewayEventRequestContext(BaseModel):
     routeKey: Optional[str]
     operationName: Optional[str]
 
+    @root_validator
+    def check_message_id(cls, values):
+        message_id, event_type = values.get("messageId"), values.get("eventType")
+        if message_id is not None and event_type != "MESSAGE":
+            raise TypeError("messageId is available only when the `eventType` is `MESSAGE`")
+        return values
+
 
 class APIGatewayProxyEventModel(BaseModel):
     version: Optional[str]
@@ -83,10 +90,3 @@ class APIGatewayProxyEventModel(BaseModel):
     stageVariables: Optional[Dict[str, str]]
     isBase64Encoded: bool
     body: str
-
-    @root_validator()
-    def check_message_id(cls, values):
-        message_id, event_type = values.get("messageId"), values.get("eventType")
-        if message_id is not None and event_type != "MESSAGE":
-            raise TypeError("messageId is available only when the `eventType` is `MESSAGE`")
-        return values

poetry.lock

@@ -39,7 +39,7 @@ flake8-debugger = "^4.0.0"
 flake8-fixme = "^1.1.1"
 flake8-isort = "^4.0.0"
 flake8-variables-names = "^0.0.4"
-isort = "^5.9.2"
+isort = "^5.9.3"
 pytest-cov = "^2.12.1"
 pytest-mock = "^3.5.1"
 pdoc3 = "^0.9.2"
@@ -49,7 +49,7 @@ radon = "^4.5.0"
 xenon = "^0.7.3"
 flake8-eradicate = "^1.1.0"
 flake8-bugbear = "^21.3.2"
-mkdocs-material = "^7.2.0"
+mkdocs-material = "^7.2.1"
 mkdocs-git-revision-date-plugin = "^0.3.1"
 mike = "^0.6.0"
 mypy = "^0.910"

pyproject.toml

@@ -395,7 +395,6 @@ def test_idempotent_lambda_expired_during_request(
     lambda_apigw_event,
     timestamp_expired,
     lambda_response,
-    expected_params_update_item,
     hashed_idempotency_key,
     lambda_context,
 ):

tests/functional/idempotency/test_idempotency.py

@@ -1,3 +1,6 @@
+import pytest
+from pydantic import ValidationError
+
 from aws_lambda_powertools.utilities.parser import envelopes, event_parser
 from aws_lambda_powertools.utilities.parser.models import APIGatewayProxyEventModel
 from aws_lambda_powertools.utilities.typing import LambdaContext
@@ -100,3 +103,44 @@ def test_apigw_event():
     assert request_context.operationName is None
     assert identity.apiKey is None
     assert identity.apiKeyId is None
+
+
+def test_apigw_event_with_invalid_websocket_request():
+    # GIVEN an event with an eventType != MESSAGE and has  a messageId
+    event = {
+        "resource": "/",
+        "path": "/",
+        "httpMethod": "GET",
+        "headers": {},
+        "multiValueHeaders": {},
+        "isBase64Encoded": False,
+        "body": "Foo!",
+        "requestContext": {
+            "accountId": "1234",
+            "apiId": "myApi",
+            "httpMethod": "GET",
+            "identity": {
+                "sourceIp": "127.0.0.1",
+            },
+            "path": "/",
+            "protocol": "Https",
+            "requestId": "1234",
+            "requestTime": "2018-09-07T16:20:46Z",
+            "requestTimeEpoch": 1536992496000,
+            "resourcePath": "/",
+            "stage": "test",
+            "eventType": "DISCONNECT",
+            "messageId": "messageId",
+        },
+    }
+
+    # WHEN calling event_parser with APIGatewayProxyEventModel
+    with pytest.raises(ValidationError) as err:
+        handle_apigw_event(event, LambdaContext())
+
+    # THEN raise TypeError for invalid event
+    errors = err.value.errors()
+    assert len(errors) == 1
+    expected_msg = "messageId is available only when the `eventType` is `MESSAGE`"
+    assert errors[0]["msg"] == expected_msg
+    assert expected_msg in str(err.value)