feat(parser): small changes

Author: leandrodamascena

aws_lambda_powertools/utilities/parser/envelopes/kafka.py

@@ -1,7 +1,7 @@
 import logging
 from typing import Any, Dict, List, Optional, Type, Union
 
-from ..models import KafkaEventModel
+from ..models import KafkaMskEventModel
 from ..types import Model
 from .base import BaseEnvelope
 
@@ -32,8 +32,8 @@ def parse(self, data: Optional[Union[Dict[str, Any], Any]], model: Type[Model])
         List
             List of records parsed with model provided
         """
-        logger.debug(f"Parsing incoming data with Kafka event model {KafkaEventModel}")
-        parsed_envelope: KafkaEventModel = KafkaEventModel.parse_obj(data)
+        logger.debug(f"Parsing incoming data with Kafka event model {KafkaMskEventModel}")
+        parsed_envelope: KafkaMskEventModel = KafkaMskEventModel.parse_obj(data)
         logger.debug(f"Parsing Kafka event records in `value` with {model}")
         ret_list = []
         for records in parsed_envelope.records.values():

aws_lambda_powertools/utilities/parser/models/__init__.py

@@ -17,7 +17,7 @@
 from .cloudwatch import CloudWatchLogsData, CloudWatchLogsDecode, CloudWatchLogsLogEvent, CloudWatchLogsModel
 from .dynamodb import DynamoDBStreamChangedRecordModel, DynamoDBStreamModel, DynamoDBStreamRecordModel
 from .event_bridge import EventBridgeModel
-from .kafka import KafkaBaseEventModel, KafkaEventModel, KafkaRecordModel, MskEventModel
+from .kafka import KafkaBaseEventModel, KafkaMskEventModel, KafkaRecordModel, KafkaSelfManagedEventModel
 from .kinesis import KinesisDataStreamModel, KinesisDataStreamRecord, KinesisDataStreamRecordPayload
 from .lambda_function_url import LambdaFunctionUrlModel
 from .s3 import S3Model, S3RecordModel
@@ -99,8 +99,8 @@
     "APIGatewayEventRequestContext",
     "APIGatewayEventAuthorizer",
     "APIGatewayEventIdentity",
-    "KafkaEventModel",
+    "KafkaSelfManagedEventModel",
     "KafkaRecordModel",
-    "MskEventModel",
+    "KafkaMskEventModel",
     "KafkaBaseEventModel",
 ]

aws_lambda_powertools/utilities/parser/models/kafka.py

@@ -44,7 +44,7 @@ def split_servers(cls, value):
         return None if not value else value.split(SERVERS_DELIMITER)
 
 
-class KafkaEventModel(KafkaBaseEventModel):
+class KafkaSelfManagedEventModel(KafkaBaseEventModel):
     """Self-managed Apache Kafka event trigger
     Documentation:
     --------------
@@ -54,7 +54,7 @@ class KafkaEventModel(KafkaBaseEventModel):
     eventSource: Literal["aws:SelfManagedKafka"]
 
 
-class MskEventModel(KafkaBaseEventModel):
+class KafkaMskEventModel(KafkaBaseEventModel):
     """Fully-managed AWS Apache Kafka event trigger
     Documentation:
     --------------

docs/utilities/parser.md

@@ -168,8 +168,8 @@ Parser comes with the following built-in models:
 | **APIGatewayProxyEventModel**   | Lambda Event Source payload for Amazon API Gateway                 |
 | **APIGatewayProxyEventV2Model** | Lambda Event Source payload for Amazon API Gateway v2 payload      |
 | **LambdaFunctionUrlModel**      | Lambda Event Source payload for Lambda Function URL payload        |
-| **KafkaModel**                  | Lambda Event Source payload for self managed Kafka payload         |
-| **MskEventModel**               | Lambda Event Source payload for AWS MSK payload                    |
+| **KafkaSelfManagedEventModel**  | Lambda Event Source payload for self managed Kafka payload         |
+| **KafkaMskEventModel**          | Lambda Event Source payload for AWS MSK payload                    |
 
 ### extending built-in models
 

tests/functional/parser/test_kafka.py

@@ -1,7 +1,11 @@
 from typing import List
 
 from aws_lambda_powertools.utilities.parser import envelopes, event_parser
-from aws_lambda_powertools.utilities.parser.models import KafkaEventModel, KafkaRecordModel, MskEventModel
+from aws_lambda_powertools.utilities.parser.models import (
+    KafkaMskEventModel,
+    KafkaRecordModel,
+    KafkaSelfManagedEventModel,
+)
 from aws_lambda_powertools.utilities.typing import LambdaContext
 from tests.functional.parser.schemas import MyLambdaKafkaBusiness
 from tests.functional.utils import load_event
@@ -13,19 +17,19 @@ def handle_lambda_kafka_with_envelope(event: List[MyLambdaKafkaBusiness], _: Lam
     assert len(event) == 1
 
 
-@event_parser(model=KafkaEventModel)
-def handle_kafka_event(event: KafkaEventModel, _: LambdaContext):
+@event_parser(model=KafkaSelfManagedEventModel)
+def handle_kafka_event(event: KafkaSelfManagedEventModel, _: LambdaContext):
     return event
 
 
 def test_kafka_event_with_envelope():
-    event = load_event("kafkaEventSelfManaged.json")
+    event = load_event("kafkaEventMsk.json")
     handle_lambda_kafka_with_envelope(event, LambdaContext())
 
 
 def test_self_managed_kafka_event():
     json_event = load_event("kafkaEventSelfManaged.json")
-    event: KafkaEventModel = handle_kafka_event(json_event, LambdaContext())
+    event: KafkaSelfManagedEventModel = handle_kafka_event(json_event, LambdaContext())
     assert event.eventSource == "aws:SelfManagedKafka"
     bootstrap_servers = [
         "b-2.demo-cluster-1.a1bcde.c1.kafka.us-east-1.amazonaws.com:9092",
@@ -49,14 +53,14 @@ def test_self_managed_kafka_event():
     assert record.headers[0]["headerKey"] == b"headerValue"
 
 
-@event_parser(model=MskEventModel)
-def handle_msk_event(event: MskEventModel, _: LambdaContext):
+@event_parser(model=KafkaMskEventModel)
+def handle_msk_event(event: KafkaMskEventModel, _: LambdaContext):
     return event
 
 
 def test_kafka_msk_event():
     json_event = load_event("kafkaEventMsk.json")
-    event: MskEventModel = handle_msk_event(json_event, LambdaContext())
+    event: KafkaMskEventModel = handle_msk_event(json_event, LambdaContext())
     assert event.eventSource == "aws:kafka"
     bootstrap_servers = [
         "b-2.demo-cluster-1.a1bcde.c1.kafka.us-east-1.amazonaws.com:9092",