Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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,
Expand Down Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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)
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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):
Expand Down Expand Up @@ -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]:
Expand Down Expand Up @@ -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
Expand All @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand All @@ -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]:
Expand Down
6 changes: 3 additions & 3 deletions aws_lambda_powertools/utilities/data_classes/kafka_event.py
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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()
}

Expand Down
14 changes: 14 additions & 0 deletions tests/unit/data_classes/_boto3/test_code_pipeline_job_event.py
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Original file line number Diff line number Diff line change
Expand Up @@ -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"]]
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
]
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Original file line number Diff line number Diff line change
Expand Up @@ -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")]
Original file line number Diff line number Diff line change
Expand Up @@ -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]