feature: upgrade to pydantic v2 (#682)

Author: ran-isenberg

.github/workflows/scorecard.yml

@@ -32,12 +32,12 @@ jobs:
 
     steps:
       - name: "Checkout code"
-        uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9  # v3.5.3
+        uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
         with:
           persist-credentials: false
 
       - name: "Run analysis"
-        uses: ossf/scorecard-action@e38b1902ae4f44df626f11ba0734b14fb91f8f86 # v2.1.2
+        uses: ossf/scorecard-action@08b4669551908b1024bb425080c797723083c031 # v2.2.0
         with:
           results_file: results.sarif
           results_format: sarif
@@ -59,7 +59,7 @@ jobs:
       # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
       # format to the repository Actions tab.
       - name: "Upload artifact"
-        uses: actions/upload-artifact@3cea5372237819ed00197afe530f5a7ea3e805c8 # v3.1.0
+        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
         with:
           name: SARIF file
           path: results.sarif

.github/workflows/serverless-service.yml

@@ -28,7 +28,7 @@ jobs:
         with:
           python-version: "3.10"
       - name: Set up Node
-        uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0
+        uses: actions/setup-node@e33196f7422957bea03ed53f6fbb155025ffc7b8 # v3.7.0
         with:
           node-version: "16"
       - name: Install dependencies

cdk/my_service/configuration/configuration_construct.py

@@ -88,5 +88,5 @@ def _get_and_validate_configuration(self, environment: str) -> str:
         conf_filepath = current / (f'json/{environment}_configuration.json')
         configuration_str = conf_filepath.read_text()
         # validate configuration (check feature flags schema structure if exists)
-        FeatureFlagsConfiguration.parse_raw(configuration_str)
+        FeatureFlagsConfiguration.model_validate_json(configuration_str)
         return configuration_str

cdk/my_service/configuration/schema.py

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

cdk/my_service/service_stack.py

@@ -80,5 +80,9 @@ def _add_security_tests(self) -> None:
                     'id': 'AwsSolutions-COG4',
                     'reason': 'not using cognito'
                 },
+                {
+                    'id': 'AwsSolutions-L1',
+                    'reason': 'https://github.com/aws/aws-cdk/issues/26451'
+                },
             ],
         )

docs/examples/best_practices/dynamic_configuration/evaluate_feature_flags.py

@@ -1,13 +1,13 @@
 from http import HTTPStatus
 from typing import Any, Dict
 
+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.env_vars_parser import init_environment_variables
 from service.handlers.utils.http_responses import build_response
 from service.handlers.utils.observability import logger
 
@@ -16,7 +16,7 @@
 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.dict()})
+        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={})

docs/examples/best_practices/dynamic_configuration/parse_configuration.py

@@ -1,13 +1,13 @@
 from http import HTTPStatus
 from typing import Any, Dict
 
+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.env_vars_parser import init_environment_variables
 from service.handlers.utils.http_responses import build_response
 from service.handlers.utils.observability import logger
 

docs/examples/best_practices/environment_variables/getter.py

@@ -2,10 +2,10 @@
 from http import HTTPStatus
 from typing import Any, Dict
 
+from aws_lambda_env_modeler import get_environment_variables, init_environment_variables
 from aws_lambda_powertools.utilities.typing import LambdaContext
 
 from service.handlers.schemas.env_vars import MyHandlerEnvVars
-from service.handlers.utils.env_vars_parser import get_environment_variables, init_environment_variables
 
 
 @init_environment_variables(model=MyHandlerEnvVars)

docs/examples/best_practices/environment_variables/my_handler.py

@@ -2,10 +2,10 @@
 from http import HTTPStatus
 from typing import Any, Dict
 
+from aws_lambda_env_modeler import get_environment_variables, init_environment_variables
 from aws_lambda_powertools.utilities.typing import LambdaContext
 
 from service.handlers.schemas.env_vars import MyHandlerEnvVars
-from service.handlers.utils.env_vars_parser import get_environment_variables, init_environment_variables
 
 
 @init_environment_variables(model=MyHandlerEnvVars)

mkdocs.yml

@@ -73,7 +73,7 @@ markdown_extensions:
           class: mermaid
           format: !!python/name:pymdownx.superfences.fence_code_format
 
-copyright: Copyright © 2022 Ran Isenberg
+copyright: Copyright © 2023 Ran Isenberg
 
 plugins:
   - git-revision-date