feature: align with event handler, add better docs, better logger UX (ran-isenberg#742)

Co-authored-by: Ran Isenberg <ran.isenberg@ranthebuilder.cloud>

Author: ran-isenberg

cdk/service/api_construct.py

@@ -87,7 +87,7 @@ def _add_post_lambda_integration(self, api_name: aws_apigateway.Resource, role:
  constants.CREATE_LAMBDA,
  runtime=_lambda.Runtime.PYTHON_3_11,
  code=_lambda.Code.from_asset(constants.BUILD_FOLDER),
- handler='service.handlers.create_order.lambda_handler',
+ handler='service.handlers.handle_create_order.lambda_handler',
  environment={
  constants.POWERTOOLS_SERVICE_NAME: constants.SERVICE_NAME, # for logger, tracer and metrics
  constants.POWER_TOOLS_LOG_LEVEL: 'DEBUG', # for logger

cdk/service/configuration/schema.py

@@ -1,11 +1,11 @@
-from typing import Any, Dict, Optional
+from typing import Any, Optional
 
 from aws_lambda_powertools.utilities.feature_flags import SchemaValidator
 from pydantic import BaseModel, field_validator
 
 
 class FeatureFlagsConfiguration(BaseModel):
- features: Optional[Dict[str, Any]]
+ features: Optional[dict[str, Any]]
 
  @field_validator('features', mode='before')
  def validate_features(cls, value):

docs/best_practices/dynamic_configuration.md

@@ -123,7 +123,7 @@ The function fetch the JSON file from AWS AppConfig and return a parsed instance
 
 === "my_handler.py"
 
-```python hl_lines="15 18 23"
+```python hl_lines="19 21 26"
 --8<-- "docs/examples/best_practices/dynamic_configuration/parse_configuration.py"
 ```
 
@@ -210,7 +210,7 @@ The combined JSON configuration look like this:
 
 === "my_handler.py"
 
-```python hl_lines="24-29 31-36"
+```python hl_lines="17 23-28 30-35"
 --8<-- "docs/examples/best_practices/dynamic_configuration/evaluate_feature_flags.py"
 ```
 
@@ -220,7 +220,7 @@ In this example, we evaluate both feature flags' value and provide a context.
 
 The rule for ``premium_features`` is matched (which returns a ``True`` value for the flag) when the context dictionary has a key ``customer_name`` with a value of ``RanTheBuilder`` EQUALS ``RanTheBuilder``.
 
-Line 31 will return a value of ``True`` for the context ``{'customer_name': 'RanTheBuilder'}`` and ``False`` for any other input.
+Line 30 will return a value of ``True`` for the context ``{'customer_name': 'RanTheBuilder'}`` and ``False`` for any other input.
 
 There are several actions for conditions such as ``STARTSWITH``, ``ENDSWITH``, ``EQUALS``, etc.
 

docs/best_practices/environment_variables.md

@@ -16,6 +16,12 @@ The best practice for handling environment variables is to validate & parse them
 
 In case of misconfiguration, a validation exception is raised with all the relevant exception details.
 
+## **Open source**
+The code in this post has been moved to an open source project you can use:
+
+The [AWS Lambda environment variables modeler](https://github.com/ran-isenberg/aws-lambda-env-modeler){:target="_blank" rel="noopener"}
+
+
 ## **Blog Reference**
 
 Read more about the importance of validating environment variables and how this utility works. Click [**HERE**](https://www.ranthebuilder.cloud/post/aws-lambda-cookbook-environment-variables){:target="_blank" rel="noopener"}

docs/examples/best_practices/dynamic_configuration/configuration_schema.py

@@ -1,8 +1,6 @@
-from typing import List
-
 from pydantic import BaseModel
 
 
 # does not include feature flags part of the JSON
 class MyConfiguration(BaseModel):
- countries: List[str]
+ countries: list[str]

docs/examples/best_practices/dynamic_configuration/evaluate_feature_flags.py

@@ -1,38 +1,36 @@
+import json
 from http import HTTPStatus
-from typing import Any, Dict
+from typing import Any
 
 from aws_lambda_env_modeler import init_environment_variables
-from aws_lambda_powertools.utilities.feature_flags.exceptions import ConfigurationStoreError, SchemaValidationError
 from aws_lambda_powertools.utilities.typing import LambdaContext
 
 from service.handlers.schemas.dynamic_configuration import MyConfiguration
 from service.handlers.schemas.env_vars import MyHandlerEnvVars
-from service.handlers.utils.dynamic_configuration import get_dynamic_configuration_store, parse_configuration
-from service.handlers.utils.http_responses import build_response
+from service.handlers.utils.dynamic_configuration import get_configuration_store, parse_configuration
 from service.handlers.utils.observability import logger
 
 
 @init_environment_variables(model=MyHandlerEnvVars)
-def my_handler(event: Dict[str, Any], context: LambdaContext) -> Dict[str, Any]:
+def my_handler(event: dict[str, Any], context: LambdaContext) -> dict[str, Any]:
  try:
  my_configuration: MyConfiguration = parse_configuration(model=MyConfiguration) # type: ignore
- logger.debug('fetched dynamic configuration', extra={'configuration': my_configuration.model_dump()})
- except (SchemaValidationError, ConfigurationStoreError) as exc:
- logger.exception(f'dynamic configuration error, error={str(exc)}')
- return build_response(http_status=HTTPStatus.INTERNAL_SERVER_ERROR, body={})
+ logger.debug('fetched dynamic configuration', configuration=my_configuration.model_dump())
+ except Exception:
+ logger.exception('dynamic configuration error')
+ return {'statusCode': HTTPStatus.INTERNAL_SERVER_ERROR, 'headers': {'Content-Type': 'application/json'}, 'body': ''}
 
- campaign = get_dynamic_configuration_store().evaluate(
+ campaign = get_configuration_store().evaluate(
  name='ten_percent_off_campaign',
  context={},
  default=False,
  )
- logger.debug('campaign feature flag value', extra={'campaign': campaign})
+ logger.debug('campaign feature flag value', campaign=campaign)
 
- premium = get_dynamic_configuration_store().evaluate(
+ premium = get_configuration_store().evaluate(
  name='premium_features',
  context={'customer_name': 'RanTheBuilder'},
  default=False,
  )
- logger.debug('premium feature flag value', extra={'premium': premium})
-
- return build_response(http_status=HTTPStatus.OK, body={'message': 'success'})
+ logger.debug('premium feature flag value', premium=premium)
+ return {'statusCode': HTTPStatus.OK, 'headers': {'Content-Type': 'application/json'}, 'body': json.dumps({'message': 'success'})}

docs/examples/best_practices/dynamic_configuration/lambda_cdk.py

@@ -1,4 +1,4 @@
-from aws_cdk import Duration, aws_apigateway
+from aws_cdk import Duration
 from aws_cdk import aws_dynamodb as dynamodb
 from aws_cdk import aws_iam as iam
 from aws_cdk import aws_lambda as _lambda
@@ -31,11 +31,11 @@ def _build_lambda_role(self, db: dynamodb.Table) -> iam.Role:
  )
 
 
-def _build_lambda_function(self, api_name: aws_apigateway.Resource, role: iam.Role, db: dynamodb.Table, appconfig_app_name: str) -> _lambda.Function:
+def _build_lambda_function(self, role: iam.Role, db: dynamodb.Table, appconfig_app_name: str) -> _lambda.Function:
  return _lambda.Function(
  self,
  'ServicePost',
- runtime=_lambda.Runtime.PYTHON_3_8,
+ runtime=_lambda.Runtime.PYTHON_3_11,
  code=_lambda.Code.from_asset(constants.BUILD_FOLDER),
  handler='service.handlers.create_order.create_order',
  environment={

docs/examples/best_practices/dynamic_configuration/mock.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict
+from typing import Any
 
 MOCKED_SCHEMA = {
  'features': {
@@ -23,7 +23,7 @@
 }
 
 
-def mock_dynamic_configuration(mocker, mock_schema: Dict[str, Any]) -> None:
+def mock_dynamic_configuration(mocker, mock_schema: dict[str, Any]) -> None:
  """Mock AppConfig Store get_configuration method to use mock schema instead"""
  mocked_get_conf = mocker.patch('aws_lambda_powertools.utilities.parameters.AppConfigProvider.get')
  mocked_get_conf.return_value = mock_schema

docs/examples/best_practices/dynamic_configuration/parse_configuration.py

@@ -1,24 +1,27 @@
+import json
 from http import HTTPStatus
-from typing import Any, Dict
+from typing import Any
 
 from aws_lambda_env_modeler import init_environment_variables
-from aws_lambda_powertools.utilities.feature_flags.exceptions import ConfigurationStoreError, SchemaValidationError
 from aws_lambda_powertools.utilities.typing import LambdaContext
 
 from service.handlers.schemas.dynamic_configuration import MyConfiguration
 from service.handlers.schemas.env_vars import MyHandlerEnvVars
 from service.handlers.utils.dynamic_configuration import parse_configuration
-from service.handlers.utils.http_responses import build_response
 from service.handlers.utils.observability import logger
 
 
+def build_response(http_status: HTTPStatus, body: dict[str, Any]) -> dict[str, Any]:
+ return {'statusCode': http_status, 'headers': {'Content-Type': 'application/json'}, 'body': json.dumps(body)}
+
+
 @init_environment_variables(model=MyHandlerEnvVars)
-def my_handler(event: Dict[str, Any], context: LambdaContext) -> Dict[str, Any]:
+def my_handler(event: dict[str, Any], context: LambdaContext) -> dict[str, Any]:
  try:
- my_configuration: MyConfiguration = parse_configuration(model=MyConfiguration) # type: ignore
- except (SchemaValidationError, ConfigurationStoreError) as exc:
- logger.exception(f'dynamic configuration error, error={str(exc)}')
+ my_configuration = parse_configuration(model=MyConfiguration)
+ except Exception:
+ logger.exception('dynamic configuration error')
  return build_response(http_status=HTTPStatus.INTERNAL_SERVER_ERROR, body={})
 
- logger.debug('fetched dynamic configuration', extra={'countries': my_configuration.countries})
+ logger.debug('fetched dynamic configuration', countries=my_configuration.countries)
  return build_response(http_status=HTTPStatus.OK, body={'message': 'success'})

docs/examples/best_practices/environment_variables/getter.py

@@ -1,6 +1,6 @@
 import json
 from http import HTTPStatus
-from typing import Any, Dict
+from typing import Any
 
 from aws_lambda_env_modeler import get_environment_variables, init_environment_variables
 from aws_lambda_powertools.utilities.typing import LambdaContext
@@ -9,6 +9,6 @@
 
 
 @init_environment_variables(model=MyHandlerEnvVars)
-def my_handler(event: Dict[str, Any], context: LambdaContext) -> Dict[str, Any]:
+def my_handler(event: dict[str, Any], context: LambdaContext) -> dict[str, Any]:
  env_vars: MyHandlerEnvVars = get_environment_variables(model=MyHandlerEnvVars) # noqa: F841
  return {'statusCode': HTTPStatus.OK, 'headers': {'Content-Type': 'application/json'}, 'body': json.dumps({'message': 'success'})}