Merge branch 'develop' into fix/logger-applications

heitorlessa · heitorlessa · commit 1fdfa2219de8 · 2023-05-26T11:46:13.000+02:00
* develop: chore(deps-dev): bump aws-cdk from 2.80.0 to 2.81.0 (aws-powertools#2332) chore(deps-dev): bump coverage from 7.2.5 to 7.2.6 (aws-powertools#2326) chore(deps-dev): bump pytest-cov from 4.0.0 to 4.1.0 (aws-powertools#2327) chore(deps): bump actions/setup-python from 4.6.0 to 4.6.1 (aws-powertools#2325) fix(docs): use concrete secrets from settings (aws-powertools#2322) fix(logger): add setLevel function to set level programmatically (aws-powertools#2320) feat(parser): add support for parsing SQS events wrapped in Kinesis Firehose (aws-powertools#2294)
diff --git a/.github/workflows/on_push_docs.yml b/.github/workflows/on_push_docs.yml
@@ -19,7 +19,8 @@ jobs:
       contents: write
       pages: write
       id-token: write
+    secrets: inherit
     uses: ./.github/workflows/reusable_publish_docs.yml
     with:
       version: develop
-      alias: stage
+      alias: stage
diff --git a/.github/workflows/publish_v2_layer.yml b/.github/workflows/publish_v2_layer.yml
@@ -47,7 +47,7 @@ jobs:
         with:
           node-version: "16.12"
       - name: Setup python
-        uses: actions/setup-python@57ded4d7d5e986d7296eab16560982c6dd7c923b # v4.6.0
+        uses: actions/setup-python@bd6b4b6205c4dbad673328db7b31b7fab9e241c0 # v4.6.1
         with:
           python-version: "3.10"
           cache: "pip"
@@ -224,6 +224,7 @@ jobs:
       pages: write
       pull-requests: none
       id-token: write
+    secrets: inherit
     uses: ./.github/workflows/reusable_publish_docs.yml
     with:
       version: ${{ inputs.latest_published_version }}
diff --git a/.github/workflows/python_build.yml b/.github/workflows/python_build.yml
@@ -36,7 +36,7 @@ jobs:
       - name: Install poetry
         run: pipx install poetry
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@57ded4d7d5e986d7296eab16560982c6dd7c923b # v4.6.0
+        uses: actions/setup-python@bd6b4b6205c4dbad673328db7b31b7fab9e241c0 # v4.6.1
         with:
           python-version: ${{ matrix.python-version }}
           cache: "poetry"
diff --git a/.github/workflows/rebuild_latest_docs.yml b/.github/workflows/rebuild_latest_docs.yml
@@ -23,6 +23,7 @@ jobs:
       contents: write
       pages: write
       id-token: write
+    secrets: inherit
     uses: ./.github/workflows/reusable_publish_docs.yml
     with:
       version: ${{ inputs.latest_published_version }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -139,7 +139,7 @@ jobs:
       - name: Install poetry
         run: pipx install git+https://github.com/python-poetry/poetry@68b88e5390720a3dd84f02940ec5200bfce39ac6 # v1.5.0
       - name: Set up Python
-        uses: actions/setup-python@57ded4d7d5e986d7296eab16560982c6dd7c923b # v4.6.0
+        uses: actions/setup-python@bd6b4b6205c4dbad673328db7b31b7fab9e241c0 # v4.6.1
         with:
           python-version: "3.10"
           cache: "poetry"
@@ -177,7 +177,7 @@ jobs:
       - name: Install poetry
         run: pipx install git+https://github.com/python-poetry/poetry@68b88e5390720a3dd84f02940ec5200bfce39ac6 # v1.5.0
       - name: Set up Python
-        uses: actions/setup-python@57ded4d7d5e986d7296eab16560982c6dd7c923b # v4.6.0
+        uses: actions/setup-python@bd6b4b6205c4dbad673328db7b31b7fab9e241c0 # v4.6.1
         with:
           python-version: "3.10"
           cache: "poetry"
diff --git a/.github/workflows/reusable_deploy_v2_layer_stack.yml b/.github/workflows/reusable_deploy_v2_layer_stack.yml
@@ -108,7 +108,7 @@ jobs:
         with:
           node-version: "16.12"
       - name: Setup python
-        uses: actions/setup-python@57ded4d7d5e986d7296eab16560982c6dd7c923b # v4.6.0
+        uses: actions/setup-python@bd6b4b6205c4dbad673328db7b31b7fab9e241c0 # v4.6.1
         with:
           python-version: "3.10"
           cache: "pip"
diff --git a/.github/workflows/reusable_publish_docs.yml b/.github/workflows/reusable_publish_docs.yml
@@ -37,7 +37,7 @@ jobs:
     concurrency:
       group: on-docs-rebuild
     runs-on: ubuntu-latest
-    environment: Docs
+    environment: "Docs"
     steps:
       - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab  # v3.5.2
         with:
@@ -46,7 +46,7 @@ jobs:
       - name: Install poetry
         run: pipx install poetry
       - name: Set up Python
-        uses: actions/setup-python@57ded4d7d5e986d7296eab16560982c6dd7c923b # v4.6.0
+        uses: actions/setup-python@bd6b4b6205c4dbad673328db7b31b7fab9e241c0 # v4.6.1
         with:
           python-version: "3.10"
           cache: "poetry"
diff --git a/.github/workflows/run-e2e-tests.yml b/.github/workflows/run-e2e-tests.yml
@@ -38,7 +38,7 @@ jobs:
       - name: Install poetry
         run: pipx install poetry
       - name: "Use Python"
-        uses: actions/setup-python@57ded4d7d5e986d7296eab16560982c6dd7c923b # v4.6.0
+        uses: actions/setup-python@bd6b4b6205c4dbad673328db7b31b7fab9e241c0 # v4.6.1
         with:
           python-version: ${{ matrix.version }}
           architecture: "x64"
diff --git a/aws_lambda_powertools/logging/logger.py b/aws_lambda_powertools/logging/logger.py
@@ -86,7 +86,9 @@ class Logger:
     service : str, optional
         service name to be appended in logs, by default "service_undefined"
     level : str, int optional
-        logging.level, by default "INFO"
+        The level to set. Can be a string representing the level name: 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'
+        or an integer representing the level value: 10 for 'DEBUG', 20 for 'INFO', 30 for 'WARNING', 40 for 'ERROR', 50 for 'CRITICAL'. # noqa: E501
+        by default "INFO"
     child: bool, optional
         create a child Logger named <service>.<caller_file_name>, False by default
     sample_rate: float, optional
@@ -322,7 +324,7 @@ def _configure_sampling(self):
         try:
             if self.sampling_rate and random.random() <= float(self.sampling_rate):
                 logger.debug("Setting log level to Debug due to sampling rate")
-                self.log_level = logging.DEBUG
+                self.setLevel(logging.DEBUG)
         except ValueError:
             raise InvalidLoggerSamplingRateError(
                 f"Expected a float value ranging 0 to 1, but received {self.sampling_rate} instead."
@@ -438,6 +440,19 @@ def decorate(event, context, *args, **kwargs):
 
         return decorate
 
+    def setLevel(self, level: Union[str, int]):
+        """
+        Set the logging level for the logger.
+
+        Parameters:
+        -----------
+        level str | int
+            The level to set. Can be a string representing the level name: 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'
+            or an integer representing the level value: 10 for 'DEBUG', 20 for 'INFO', 30 for 'WARNING', 40 for 'ERROR', 50 for 'CRITICAL'. # noqa: E501
+        """
+        self.log_level = level
+        self._logger.setLevel(level)
+
     def info(
         self,
         msg: object,
diff --git a/aws_lambda_powertools/utilities/parser/models/__init__.py b/aws_lambda_powertools/utilities/parser/models/__init__.py
@@ -42,6 +42,7 @@
     KinesisFirehoseRecord,
     KinesisFirehoseRecordMetadata,
 )
+from .kinesis_firehose_sqs import KinesisFirehoseSqsModel, KinesisFirehoseSqsRecord
 from .lambda_function_url import LambdaFunctionUrlModel
 from .s3 import (
     S3EventNotificationEventBridgeDetailModel,
@@ -144,4 +145,6 @@
     "KafkaRecordModel",
     "KafkaMskEventModel",
     "KafkaBaseEventModel",
+    "KinesisFirehoseSqsModel",
+    "KinesisFirehoseSqsRecord",
 ]
diff --git a/aws_lambda_powertools/utilities/parser/models/kinesis_firehose_sqs.py b/aws_lambda_powertools/utilities/parser/models/kinesis_firehose_sqs.py
@@ -0,0 +1,29 @@
+import json
+from typing import List, Optional
+
+from pydantic import BaseModel, PositiveInt, validator
+
+from aws_lambda_powertools.shared.functions import base64_decode
+from aws_lambda_powertools.utilities.parser.models import KinesisFirehoseRecordMetadata
+
+from .sqs import SqsRecordModel
+
+
+class KinesisFirehoseSqsRecord(BaseModel):
+    data: SqsRecordModel
+    recordId: str
+    approximateArrivalTimestamp: PositiveInt
+    kinesisRecordMetadata: Optional[KinesisFirehoseRecordMetadata]
+
+    @validator("data", pre=True, allow_reuse=True)
+    def data_base64_decode(cls, value):
+        # Firehose payload is encoded
+        return json.loads(base64_decode(value))
+
+
+class KinesisFirehoseSqsModel(BaseModel):
+    invocationId: str
+    deliveryStreamArn: str
+    region: str
+    sourceKinesisStreamArn: Optional[str]
+    records: List[KinesisFirehoseSqsRecord]
diff --git a/docs/utilities/parser.md b/docs/utilities/parser.md
@@ -168,6 +168,7 @@ Parser comes with the following built-in models:
 | **KafkaSelfManagedEventModel**          | Lambda Event Source payload for self managed Kafka payload                            |
 | **KinesisDataStreamModel**              | Lambda Event Source payload for Amazon Kinesis Data Streams                           |
 | **KinesisFirehoseModel**                | Lambda Event Source payload for Amazon Kinesis Firehose                               |
+| **KinesisFirehoseSqsModel**             | Lambda Event Source payload for SQS messages wrapped in Kinesis Firehose records      |
 | **LambdaFunctionUrlModel**              | Lambda Event Source payload for Lambda Function URL payload                           |
 | **S3EventNotificationEventBridgeModel** | Lambda Event Source payload for Amazon S3 Event Notification to EventBridge.          |
 | **S3Model**                             | Lambda Event Source payload for Amazon S3                                             |
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,6 +2,6 @@
   "name": "aws-lambda-powertools-python-e2e",
   "version": "1.0.0",
   "devDependencies": {
-    "aws-cdk": "^2.80.0"
+    "aws-cdk": "^2.81.0"
   }
 }
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/tests/events/kinesisFirehoseSQSEvent.json b/tests/events/kinesisFirehoseSQSEvent.json
diff --git a/tests/functional/parser/test_kinesis_firehose.py b/tests/functional/parser/test_kinesis_firehose.py
diff --git a/tests/functional/test_logger.py b/tests/functional/test_logger.py

Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,7 @@`
`42`	`42`	`KinesisFirehoseRecord,`
`43`	`43`	`KinesisFirehoseRecordMetadata,`
`44`	`44`	`)`
	`45`	`+from .kinesis_firehose_sqs import KinesisFirehoseSqsModel, KinesisFirehoseSqsRecord`
`45`	`46`	`from .lambda_function_url import LambdaFunctionUrlModel`
`46`	`47`	`from .s3 import (`
`47`	`48`	`S3EventNotificationEventBridgeDetailModel,`
`@@ -144,4 +145,6 @@`
`144`	`145`	`"KafkaRecordModel",`
`145`	`146`	`"KafkaMskEventModel",`
`146`	`147`	`"KafkaBaseEventModel",`
	`148`	`+ "KinesisFirehoseSqsModel",`
	`149`	`+ "KinesisFirehoseSqsRecord",`
`147`	`150`	`]`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,6 @@`
`2`	`2`	`"name": "aws-lambda-powertools-python-e2e",`
`3`	`3`	`"version": "1.0.0",`
`4`	`4`	`"devDependencies": {`
`5`		`- "aws-cdk": "^2.80.0"`
	`5`	`+ "aws-cdk": "^2.81.0"`
`6`	`6`	`}`
`7`	`7`	`}`