From 0be9808562e8522b0ff5eabe9dfc8fcd950ee5e7 Mon Sep 17 00:00:00 2001 From: EC2 Default User Date: Sat, 21 Nov 2026 18:27:24 +0400 Subject: [PATCH] fix(data_classes): honour a custom json_deserializer in event classes that override __init__ or nest records ActiveMQEvent, KafkaEvent, RabbitMQEvent, CodePipelineJobEvent and AWSConfigRuleEvent override __init__ without the json_deserializer parameter DictWrapper accepts, so passing one raised TypeError. RabbitMQEvent, CodePipelineJobEvent, CloudWatchAlarmEvent and ConnectOutboundCampaignsEvent also built nested wrappers without forwarding it, so json_data / decoded_user_parameters / reason_data_decoded / json_customer_data fell back to json.loads. --- .../utilities/data_classes/active_mq_event.py | 6 +++--- .../data_classes/aws_config_rule_event.py | 9 ++++++--- .../data_classes/cloud_watch_alarm_event.py | 6 +++--- .../data_classes/code_pipeline_job_event.py | 18 ++++++++++++------ .../data_classes/connect_campaign_event.py | 4 ++-- .../utilities/data_classes/kafka_event.py | 6 +++--- .../utilities/data_classes/rabbit_mq_event.py | 11 +++++++---- .../_boto3/test_code_pipeline_job_event.py | 14 ++++++++++++++ .../test_active_mq_event.py | 15 +++++++++++++++ .../test_aws_config_rule_event.py | 15 +++++++++++++++ .../test_cloud_watch_alarm_event.py | 18 ++++++++++++++++++ .../test_connect_campaign_event.py | 15 +++++++++++++++ .../required_dependencies/test_kafka_event.py | 15 +++++++++++++++ .../test_rabbit_mq_event.py | 15 +++++++++++++++ 14 files changed, 143 insertions(+), 24 deletions(-) diff --git a/aws_lambda_powertools/utilities/data_classes/active_mq_event.py b/aws_lambda_powertools/utilities/data_classes/active_mq_event.py index 26ed82dc32c..fa2f48682e7 100644 --- a/aws_lambda_powertools/utilities/data_classes/active_mq_event.py +++ b/aws_lambda_powertools/utilities/data_classes/active_mq_event.py @@ -7,7 +7,7 @@ from aws_lambda_powertools.utilities.data_classes.shared_functions import base64_decode if TYPE_CHECKING: - from collections.abc import Iterator + from collections.abc import Callable, Iterator class ActiveMQMessage(DictWrapper): @@ -115,8 +115,8 @@ class ActiveMQEvent(DictWrapper): - https://aws.amazon.com/blogs/compute/using-amazon-mq-as-an-event-source-for-aws-lambda/ """ - def __init__(self, data: dict[str, Any]): - super().__init__(data) + def __init__(self, data: dict[str, Any], json_deserializer: Callable | None = None): + super().__init__(data, json_deserializer=json_deserializer) self._messages: Iterator[ActiveMQMessage] | None = None @property diff --git a/aws_lambda_powertools/utilities/data_classes/aws_config_rule_event.py b/aws_lambda_powertools/utilities/data_classes/aws_config_rule_event.py index 040228ee884..22c46b67616 100644 --- a/aws_lambda_powertools/utilities/data_classes/aws_config_rule_event.py +++ b/aws_lambda_powertools/utilities/data_classes/aws_config_rule_event.py @@ -1,9 +1,12 @@ from __future__ import annotations -from typing import Any +from typing import TYPE_CHECKING, Any from aws_lambda_powertools.utilities.data_classes.common import DictWrapper +if TYPE_CHECKING: + from collections.abc import Callable + def get_invoke_event( invoking_event: dict, @@ -286,8 +289,8 @@ class AWSConfigRuleEvent(DictWrapper): - https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules_lambda-functions.html """ - def __init__(self, data: dict[str, Any]): - super().__init__(data) + def __init__(self, data: dict[str, Any], json_deserializer: Callable | None = None): + super().__init__(data, json_deserializer=json_deserializer) self._invoking_event: Any | None = None self._rule_parameters: Any | None = None diff --git a/aws_lambda_powertools/utilities/data_classes/cloud_watch_alarm_event.py b/aws_lambda_powertools/utilities/data_classes/cloud_watch_alarm_event.py index 8fae6a1fd83..71248fd7f0e 100644 --- a/aws_lambda_powertools/utilities/data_classes/cloud_watch_alarm_event.py +++ b/aws_lambda_powertools/utilities/data_classes/cloud_watch_alarm_event.py @@ -144,14 +144,14 @@ def state(self) -> CloudWatchAlarmState: """ The current state of the Alarm. """ - return CloudWatchAlarmState(self["state"]) + return CloudWatchAlarmState(self["state"], json_deserializer=self._json_deserializer) @property def previous_state(self) -> CloudWatchAlarmState: """ The previous state of the Alarm. """ - return CloudWatchAlarmState(self["previousState"]) + return CloudWatchAlarmState(self["previousState"], json_deserializer=self._json_deserializer) @property def configuration(self) -> CloudWatchAlarmConfiguration: @@ -247,4 +247,4 @@ def alarm_data(self) -> CloudWatchAlarmData: """ Contains basic data about the Alarm and its current and previous states. """ - return CloudWatchAlarmData(self["alarmData"]) + return CloudWatchAlarmData(self["alarmData"], json_deserializer=self._json_deserializer) diff --git a/aws_lambda_powertools/utilities/data_classes/code_pipeline_job_event.py b/aws_lambda_powertools/utilities/data_classes/code_pipeline_job_event.py index d314fde4cb3..011d987afe7 100644 --- a/aws_lambda_powertools/utilities/data_classes/code_pipeline_job_event.py +++ b/aws_lambda_powertools/utilities/data_classes/code_pipeline_job_event.py @@ -3,11 +3,14 @@ import tempfile import zipfile from functools import cached_property -from typing import Any +from typing import TYPE_CHECKING, Any from urllib.parse import unquote_plus from aws_lambda_powertools.utilities.data_classes.common import DictWrapper +if TYPE_CHECKING: + from collections.abc import Callable + class CodePipelineConfiguration(DictWrapper): @property @@ -33,7 +36,7 @@ class CodePipelineActionConfiguration(DictWrapper): @property def configuration(self) -> CodePipelineConfiguration: - return CodePipelineConfiguration(self["configuration"]) + return CodePipelineConfiguration(self["configuration"], json_deserializer=self._json_deserializer) class CodePipelineS3Location(DictWrapper): @@ -115,7 +118,10 @@ class CodePipelineData(DictWrapper): @property def action_configuration(self) -> CodePipelineActionConfiguration: """CodePipeline action configuration""" - return CodePipelineActionConfiguration(self["actionConfiguration"]) + return CodePipelineActionConfiguration( + self["actionConfiguration"], + json_deserializer=self._json_deserializer, + ) @property def input_artifacts(self) -> list[CodePipelineArtifact]: @@ -153,8 +159,8 @@ class CodePipelineJobEvent(DictWrapper): - https://docs.aws.amazon.com/lambda/latest/dg/services-codepipeline.html """ - def __init__(self, data: dict[str, Any]): - super().__init__(data) + def __init__(self, data: dict[str, Any], json_deserializer: Callable | None = None): + super().__init__(data, json_deserializer=json_deserializer) self._job = self["CodePipeline.job"] @property @@ -170,7 +176,7 @@ def account_id(self) -> str: @property def data(self) -> CodePipelineData: """Code pipeline jab data""" - return CodePipelineData(self._job["data"]) + return CodePipelineData(self._job["data"], json_deserializer=self._json_deserializer) @property def user_parameters(self) -> str | None: diff --git a/aws_lambda_powertools/utilities/data_classes/connect_campaign_event.py b/aws_lambda_powertools/utilities/data_classes/connect_campaign_event.py index 414ab1061ac..e1ba4c86525 100644 --- a/aws_lambda_powertools/utilities/data_classes/connect_campaign_event.py +++ b/aws_lambda_powertools/utilities/data_classes/connect_campaign_event.py @@ -73,7 +73,7 @@ class ConnectOutboundCampaignItems(DictWrapper): def customer_profiles(self) -> Iterator[ConnectOutboundCampaignCustomerProfile]: """Iterate over customer profiles.""" for item in self["CustomerProfiles"]: - yield ConnectOutboundCampaignCustomerProfile(item) + yield ConnectOutboundCampaignCustomerProfile(item, json_deserializer=self._json_deserializer) class ConnectOutboundCampaignsEvent(DictWrapper): @@ -92,7 +92,7 @@ def invocation_metadata(self) -> ConnectOutboundCampaignInvocationMetadata: @property def items_payload(self) -> ConnectOutboundCampaignItems: """Items payload containing customer profiles.""" - return ConnectOutboundCampaignItems(self["Items"]) + return ConnectOutboundCampaignItems(self["Items"], json_deserializer=self._json_deserializer) @property def customer_profiles(self) -> Iterator[ConnectOutboundCampaignCustomerProfile]: diff --git a/aws_lambda_powertools/utilities/data_classes/kafka_event.py b/aws_lambda_powertools/utilities/data_classes/kafka_event.py index 53d23530cec..66854ba6779 100644 --- a/aws_lambda_powertools/utilities/data_classes/kafka_event.py +++ b/aws_lambda_powertools/utilities/data_classes/kafka_event.py @@ -8,7 +8,7 @@ from aws_lambda_powertools.utilities.data_classes.common import CaseInsensitiveDict, DictWrapper if TYPE_CHECKING: - from collections.abc import Iterator + from collections.abc import Callable, Iterator class KafkaEventRecordSchemaMetadata(DictWrapper): @@ -144,8 +144,8 @@ class KafkaEvent(KafkaEventBase): - https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html """ - def __init__(self, data: dict[str, Any]): - super().__init__(data) + def __init__(self, data: dict[str, Any], json_deserializer: Callable | None = None): + super().__init__(data, json_deserializer=json_deserializer) self._records: Iterator[KafkaEventRecord] | None = None @property diff --git a/aws_lambda_powertools/utilities/data_classes/rabbit_mq_event.py b/aws_lambda_powertools/utilities/data_classes/rabbit_mq_event.py index 1f654dfc0d7..c11ba03a36e 100644 --- a/aws_lambda_powertools/utilities/data_classes/rabbit_mq_event.py +++ b/aws_lambda_powertools/utilities/data_classes/rabbit_mq_event.py @@ -1,11 +1,14 @@ from __future__ import annotations from functools import cached_property -from typing import Any +from typing import TYPE_CHECKING, Any from aws_lambda_powertools.utilities.data_classes.common import DictWrapper from aws_lambda_powertools.utilities.data_classes.shared_functions import base64_decode +if TYPE_CHECKING: + from collections.abc import Callable + class BasicProperties(DictWrapper): @property @@ -102,10 +105,10 @@ class RabbitMQEvent(DictWrapper): - https://aws.amazon.com/blogs/compute/using-amazon-mq-for-rabbitmq-as-an-event-source-for-lambda/ """ - def __init__(self, data: dict[str, Any]): - super().__init__(data) + def __init__(self, data: dict[str, Any], json_deserializer: Callable | None = None): + super().__init__(data, json_deserializer=json_deserializer) self._rmq_messages_by_queue = { - key: [RabbitMessage(message) for message in messages] + key: [RabbitMessage(message, json_deserializer=self._json_deserializer) for message in messages] for key, messages in self["rmqMessagesByQueue"].items() } diff --git a/tests/unit/data_classes/_boto3/test_code_pipeline_job_event.py b/tests/unit/data_classes/_boto3/test_code_pipeline_job_event.py index 9d9c8f82450..f815fe75732 100644 --- a/tests/unit/data_classes/_boto3/test_code_pipeline_job_event.py +++ b/tests/unit/data_classes/_boto3/test_code_pipeline_job_event.py @@ -317,3 +317,17 @@ def test_code_pipeline_put_output_artifact_not_found(): assert parsed_event.find_output_artifact("not-found") is None with pytest.raises(ValueError): parsed_event.put_artifact(artifact_name="not-found", body="", content_type="text/plain") + + +def test_code_pipeline_event_uses_custom_json_deserializer(): + raw_event = load_event("codePipelineEventData.json") + calls: list[str] = [] + + def custom_deserializer(value: str) -> dict: + calls.append(value) + return {"deserialized_by": "custom"} + + parsed_event = CodePipelineJobEvent(raw_event, json_deserializer=custom_deserializer) + + assert parsed_event.decoded_user_parameters == {"deserialized_by": "custom"} + assert calls == [parsed_event.user_parameters] diff --git a/tests/unit/data_classes/required_dependencies/test_active_mq_event.py b/tests/unit/data_classes/required_dependencies/test_active_mq_event.py index adb2d51aae6..2f01ff45e3a 100644 --- a/tests/unit/data_classes/required_dependencies/test_active_mq_event.py +++ b/tests/unit/data_classes/required_dependencies/test_active_mq_event.py @@ -58,3 +58,18 @@ def test_activemq_message_property_with_stopiteration_error(): assert parsed_event.message.message_type is not None assert parsed_event.message.data is not None assert parsed_event.message.decoded_data is not None + + +def test_active_mq_event_uses_custom_json_deserializer(): + raw_event = load_event("activeMQEvent.json") + calls: list[str] = [] + + def custom_deserializer(value: str) -> dict: + calls.append(value) + return {"deserialized_by": "custom"} + + parsed_event = ActiveMQEvent(raw_event, json_deserializer=custom_deserializer) + message = parsed_event.message + + assert message.json_data == {"deserialized_by": "custom"} + assert calls == [message.decoded_data] diff --git a/tests/unit/data_classes/required_dependencies/test_aws_config_rule_event.py b/tests/unit/data_classes/required_dependencies/test_aws_config_rule_event.py index 239637a5429..5df09185df4 100644 --- a/tests/unit/data_classes/required_dependencies/test_aws_config_rule_event.py +++ b/tests/unit/data_classes/required_dependencies/test_aws_config_rule_event.py @@ -197,3 +197,18 @@ def test_aws_config_rule_scheduled(): assert parsed_event.invoking_event.notification_creation_time == invoking_event["notificationCreationTime"] assert parsed_event.invoking_event.message_type == invoking_event["messageType"] assert parsed_event.invoking_event.record_version == invoking_event["recordVersion"] + + +def test_aws_config_rule_event_uses_custom_json_deserializer(): + raw_event = load_event("awsConfigRuleConfigurationChanged.json") + calls: list[str] = [] + + def custom_deserializer(value: str) -> dict: + calls.append(value) + return json.loads(value) + + parsed_event = AWSConfigRuleEvent(raw_event, json_deserializer=custom_deserializer) + + assert parsed_event.rule_parameters == json.loads(raw_event["ruleParameters"]) + assert parsed_event.invoking_event.message_type == json.loads(raw_event["invokingEvent"])["messageType"] + assert calls == [raw_event["ruleParameters"], raw_event["invokingEvent"]] diff --git a/tests/unit/data_classes/required_dependencies/test_cloud_watch_alarm_event.py b/tests/unit/data_classes/required_dependencies/test_cloud_watch_alarm_event.py index 56a3675f6b7..432d72f9289 100644 --- a/tests/unit/data_classes/required_dependencies/test_cloud_watch_alarm_event.py +++ b/tests/unit/data_classes/required_dependencies/test_cloud_watch_alarm_event.py @@ -121,3 +121,21 @@ def test_cloud_watch_alarm_event_composite_metric(): == raw_event["alarmData"]["configuration"]["actionsSuppressor"] ) assert isinstance(parsed_event.alarm_data.configuration.metrics, list) + + +def test_cloud_watch_alarm_event_uses_custom_json_deserializer(): + raw_event = load_event("cloudWatchAlarmEventSingleMetric.json") + calls: list[str] = [] + + def custom_deserializer(value: str) -> dict: + calls.append(value) + return {"deserialized_by": "custom"} + + parsed_event = CloudWatchAlarmEvent(raw_event, json_deserializer=custom_deserializer) + + assert parsed_event.alarm_data.state.reason_data_decoded == {"deserialized_by": "custom"} + assert parsed_event.alarm_data.previous_state.reason_data_decoded == {"deserialized_by": "custom"} + assert calls == [ + raw_event["alarmData"]["state"]["reasonData"], + raw_event["alarmData"]["previousState"]["reasonData"], + ] diff --git a/tests/unit/data_classes/required_dependencies/test_connect_campaign_event.py b/tests/unit/data_classes/required_dependencies/test_connect_campaign_event.py index df458b52da1..acd9ba95e54 100644 --- a/tests/unit/data_classes/required_dependencies/test_connect_campaign_event.py +++ b/tests/unit/data_classes/required_dependencies/test_connect_campaign_event.py @@ -43,3 +43,18 @@ def test_connect_outbound_campaigns_event(): "email": "jane.smith@example.com", } assert p2.idempotency_token == "token-abc456" + + +def test_connect_outbound_campaigns_event_uses_custom_json_deserializer(): + raw_event = load_event("connectOutboundCampaignsEvent.json") + calls: list[str] = [] + + def custom_deserializer(value: str) -> dict: + calls.append(value) + return {"deserialized_by": "custom"} + + event = ConnectOutboundCampaignsEvent(raw_event, json_deserializer=custom_deserializer) + profiles = list(event.customer_profiles) + + assert [profile.json_customer_data for profile in profiles] == [{"deserialized_by": "custom"}] * 2 + assert calls == [profile.customer_data for profile in profiles] diff --git a/tests/unit/data_classes/required_dependencies/test_kafka_event.py b/tests/unit/data_classes/required_dependencies/test_kafka_event.py index 98e933ab94a..b3a56c4b0fc 100644 --- a/tests/unit/data_classes/required_dependencies/test_kafka_event.py +++ b/tests/unit/data_classes/required_dependencies/test_kafka_event.py @@ -93,3 +93,18 @@ def test_kafka_record_property_with_stopiteration_error(): with pytest.raises(StopIteration): for _ in range(5): assert parsed_event.record.topic is not None + + +def test_kafka_event_uses_custom_json_deserializer(): + raw_event = load_event("kafkaEventMsk.json") + calls: list[str] = [] + + def custom_deserializer(value: str) -> dict: + calls.append(value) + return {"deserialized_by": "custom"} + + parsed_event = KafkaEvent(raw_event, json_deserializer=custom_deserializer) + record = parsed_event.record + + assert record.json_value == {"deserialized_by": "custom"} + assert calls == [record.decoded_value.decode("utf-8")] diff --git a/tests/unit/data_classes/required_dependencies/test_rabbit_mq_event.py b/tests/unit/data_classes/required_dependencies/test_rabbit_mq_event.py index 3a0fea94010..fa6a7fa722c 100644 --- a/tests/unit/data_classes/required_dependencies/test_rabbit_mq_event.py +++ b/tests/unit/data_classes/required_dependencies/test_rabbit_mq_event.py @@ -46,3 +46,18 @@ def test_rabbit_mq_event(): assert properties.app_id is None assert properties.cluster_id is None assert properties.body_size == raw_event["rmqMessagesByQueue"]["pizzaQueue::/"][0]["basicProperties"]["bodySize"] + + +def test_rabbit_mq_event_uses_custom_json_deserializer(): + raw_event = load_event("rabbitMQEvent.json") + calls: list[str] = [] + + def custom_deserializer(value: str) -> dict: + calls.append(value) + return {"deserialized_by": "custom"} + + parsed_event = RabbitMQEvent(raw_event, json_deserializer=custom_deserializer) + message = parsed_event.rmq_messages_by_queue["pizzaQueue::/"][0] + + assert message.json_data == {"deserialized_by": "custom"} + assert calls == [message.decoded_data]