docs: small changes to help others + sentry dev dependency

Author: leandrodamascena

docs/utilities/batch.md

@@ -92,13 +92,13 @@ Processing batches from SQS works in three stages:
     The second record failed to be processed, therefore the processor added its message ID in the response.
 
     ```json
-    --8<-- "examples/batch_processing/src/getting_started_response.json"
+    --8<-- "examples/batch_processing/src/getting_started_sqs_response.json"
     ```
 
 === "Sample event"
 
     ```json
-    --8<-- "examples/batch_processing/src/getting_started_event.json"
+    --8<-- "examples/batch_processing/src/getting_started_sqs_event.json"
     ```
 
 #### FIFO queues
@@ -201,13 +201,13 @@ Processing batches from DynamoDB Streams works in three stages:
     The second record failed to be processed, therefore the processor added its sequence number in the response.
 
     ```json
-    --8<-- "examples/batch_processing/src/getting_started_dynamodb_event.json"
+    --8<-- "examples/batch_processing/src/getting_started_dynamodb_response.json"
     ```
 
 === "Sample event"
 
     ```json
-    --8<-- "examples/batch_processing/src/getting_started_dynamodb_response.json"
+    --8<-- "examples/batch_processing/src/getting_started_dynamodb_event.json"
     ```
 
 ### Partial failure mechanics
@@ -250,30 +250,48 @@ Inheritance is importance because we need to access message IDs and sequence num
 
 === "SQS"
 
-    ```python hl_lines="8 17 27 34"
+    ```python hl_lines="8 17 27 35"
     --8<-- "examples/batch_processing/src/pydantic_sqs.py"
     ```
 
+=== "SQS - Sample Event "
+
+    ```json hl_lines="6 22"
+    --8<-- "examples/batch_processing/src/pydantic_sqs_event.json"
+    ```
+
 === "Kinesis Data Streams"
 
-    ```python hl_lines="9 10 20 28 34 41"
+    ```python hl_lines="9 10 20 28 34 42"
     --8<-- "examples/batch_processing/src/pydantic_kinesis.py"
     ```
 
+=== "Kinesis - Sample Event "
+
+    ```json hl_lines="8 24"
+    --8<-- "examples/batch_processing/src/pydantic_kinesis_event.json"
+    ```
+
 === "DynamoDB Streams"
 
-    ```python hl_lines="12 13 22 32 37 41 47 55"
+    ```python hl_lines="12 13 22 32 37 41 47 56"
     --8<-- "examples/batch_processing/src/pydantic_dynamodb.py"
     ```
 
+=== "DynamoDB - Sample Event "
+
+    ```json hl_lines="13-15 36-38"
+    --8<-- "examples/batch_processing/src/pydantic_dynamodb_event.json"
+    ```
+
 ### Accessing processed messages
 
 Use the context manager to access a list of all returned values from your `record_handler` function.
 
 * **When successful**. We will include a tuple with `success`, the result of `record_handler`, and the batch record
 * **When failed**. We will include a tuple with `fail`, exception as a string, and the batch record
 
-```python hl_lines="26-34" title="Accessing processed messages via context manager"
+```python hl_lines="28-33" title="Accessing processed messages via context manager"
 --8<-- "examples/batch_processing/src/context_manager_access.py"
 ```
 
@@ -285,13 +303,13 @@ We can automatically inject the [Lambda context](https://docs.aws.amazon.com/lam
 
 === "Recommended"
 
-    ```python hl_lines="18"
+    ```python hl_lines="18 27"
     --8<-- "examples/batch_processing/src/advanced_accessing_lambda_context.py"
     ```
 
 === "As a decorator (legacy)"
 
-    ```python hl_lines="18"
+    ```python hl_lines="18 26"
     --8<-- "examples/batch_processing/src/advanced_accessing_lambda_context_decorator.py"
     ```
 
@@ -352,22 +370,22 @@ As there is no external calls, you can unit test your code with `BatchProcessor`
 
 Given a SQS batch where the first batch record succeeds and the second fails processing, we should have a single item reported in the function response.
 
-=== "test_app.py"
+=== "getting_started_with_test.py"
 
     ```python
-    --8<-- "examples/batch_processing/testing/test_app.py"
+    --8<-- "examples/batch_processing/src/getting_started_with_test.py"
     ```
 
-=== "src/app.py"
+=== "getting_started_with_test_app.py"
 
     ```python
-    --8<-- "examples/batch_processing/testing/src/app.py"
+    --8<-- "examples/batch_processing/src/getting_started_with_test_app.py"
     ```
 
 === "Sample SQS event"
 
     ```json title="events/sqs_event.json"
-    --8<-- "examples/batch_processing/testing/events/sqs_event.json"
+    --8<-- "examples/batch_processing/src/getting_started_sqs_event.json"
     ```
 
 ## FAQ

examples/batch_processing/src/context_manager_access.py

@@ -1,5 +1,7 @@
+from __future__ import annotations
+
 import json
-from typing import Any, List, Literal, Tuple, Union
+from typing import List, Literal, Tuple
 
 from aws_lambda_powertools import Logger, Tracer
 from aws_lambda_powertools.utilities.batch import BatchProcessor, EventType
@@ -27,10 +29,9 @@ def lambda_handler(event, context: LambdaContext):
         processed_messages: List[Tuple] = processor.process()
 
     for message in processed_messages:
-        status: Union[Literal["success"], Literal["fail"]] = message[0]
-        result: Any = message[1]
+        status: Literal["success"] | Literal["fail"] = message[0]
         record: SQSRecord = message[2]
 
-        logger.info(status, result, record)
+        logger.info(status, record=record)
 
     return processor.response()

examples/batch_processing/src/getting_started_dynamodb_event.json

@@ -1,7 +1,51 @@
+
 {
-  "batchItemFailures": [
+  "Records": [
     {
-      "itemIdentifier": "8640712661"
+      "eventID": "1",
+      "eventVersion": "1.0",
+      "dynamodb": {
+        "Keys": {
+          "Id": {
+            "N": "101"
+          }
+        },
+        "NewImage": {
+          "Message": {
+            "S": "failure"
+          }
+        },
+        "StreamViewType": "NEW_AND_OLD_IMAGES",
+        "SequenceNumber": "3275880929",
+        "SizeBytes": 26
+      },
+      "awsRegion": "us-west-2",
+      "eventName": "INSERT",
+      "eventSourceARN": "eventsource_arn",
+      "eventSource": "aws:dynamodb"
+    },
+    {
+      "eventID": "1",
+      "eventVersion": "1.0",
+      "dynamodb": {
+        "Keys": {
+          "Id": {
+            "N": "101"
+          }
+        },
+        "NewImage": {
+          "SomethingElse": {
+            "S": "success"
+          }
+        },
+        "StreamViewType": "NEW_AND_OLD_IMAGES",
+        "SequenceNumber": "8640712661",
+        "SizeBytes": 26
+      },
+      "awsRegion": "us-west-2",
+      "eventName": "INSERT",
+      "eventSourceARN": "eventsource_arn",
+      "eventSource": "aws:dynamodb"
     }
   ]
 }

examples/batch_processing/src/getting_started_dynamodb_response.json

@@ -1,50 +1,7 @@
 {
-  "Records": [
+  "batchItemFailures": [
     {
-      "eventID": "1",
-      "eventVersion": "1.0",
-      "dynamodb": {
-        "Keys": {
-          "Id": {
-            "N": "101"
-          }
-        },
-        "NewImage": {
-          "Message": {
-            "S": "failure"
-          }
-        },
-        "StreamViewType": "NEW_AND_OLD_IMAGES",
-        "SequenceNumber": "3275880929",
-        "SizeBytes": 26
-      },
-      "awsRegion": "us-west-2",
-      "eventName": "INSERT",
-      "eventSourceARN": "eventsource_arn",
-      "eventSource": "aws:dynamodb"
-    },
-    {
-      "eventID": "1",
-      "eventVersion": "1.0",
-      "dynamodb": {
-        "Keys": {
-          "Id": {
-            "N": "101"
-          }
-        },
-        "NewImage": {
-          "SomethingElse": {
-            "S": "success"
-          }
-        },
-        "StreamViewType": "NEW_AND_OLD_IMAGES",
-        "SequenceNumber": "8640712661",
-        "SizeBytes": 26
-      },
-      "awsRegion": "us-west-2",
-      "eventName": "INSERT",
-      "eventSourceARN": "eventsource_arn",
-      "eventSource": "aws:dynamodb"
+      "itemIdentifier": "8640712661"
     }
   ]
 }

examples/batch_processing/src/getting_started_event.json renamed to examples/batch_processing/src/getting_started_sqs_event.json

@@ -3,8 +3,7 @@
 from pathlib import Path
 
 import pytest
-
-from examples.batch_processing.testing.src import app
+from getting_started_with_test_app import lambda_handler, processor
 
 
 def load_event(path: Path):
@@ -32,15 +31,15 @@ def sqs_event():
 
 def test_app_batch_partial_response(sqs_event, lambda_context):
     # GIVEN
-    processor = app.processor  # access processor for additional assertions
+    processor_result = processor  # access processor for additional assertions
     successful_record = sqs_event["Records"][0]
     failed_record = sqs_event["Records"][1]
     expected_response = {"batchItemFailures": [{"itemIdentifier": failed_record["messageId"]}]}
 
     # WHEN
-    ret = app.lambda_handler(sqs_event, lambda_context)
+    ret = lambda_handler(sqs_event, lambda_context)
 
     # THEN
     assert ret == expected_response
-    assert len(processor.fail_messages) == 1
-    assert processor.success_messages[0] == successful_record
+    assert len(processor_result.fail_messages) == 1
+    assert processor_result.success_messages[0] == successful_record

examples/batch_processing/src/getting_started_response.json renamed to examples/batch_processing/src/getting_started_sqs_response.json

@@ -25,7 +25,7 @@ class OrderDynamoDB(BaseModel):
     # auto transform json string
     # so Pydantic can auto-initialize nested Order model
     @validator("Message", pre=True)
-    def transform_message_to_dict(self, value: Dict[Literal["S"], str]):
+    def transform_message_to_dict(cls, value: Dict[Literal["S"], str]):
         return json.loads(value["S"])
 
 
@@ -46,6 +46,7 @@ class OrderDynamoDBRecord(DynamoDBStreamRecordModel):
 @tracer.capture_method
 def record_handler(record: OrderDynamoDBRecord):
     if record.dynamodb.NewImage and record.dynamodb.NewImage.Message:
+        logger.info(record.dynamodb.NewImage.Message.item)
         return record.dynamodb.NewImage.Message.item
 
 

examples/batch_processing/testing/test_app.py renamed to examples/batch_processing/src/getting_started_with_test.py

@@ -0,0 +1,50 @@
+{
+    "Records": [
+      {
+        "eventID": "1",
+        "eventVersion": "1.0",
+        "dynamodb": {
+          "Keys": {
+            "Id": {
+              "N": "101"
+            }
+          },
+          "NewImage": {
+            "Message": {
+              "S": "{\"item\": {\"laptop\": \"amd\"}}"
+            }
+          },
+          "StreamViewType": "NEW_AND_OLD_IMAGES",
+          "SequenceNumber": "3275880929",
+          "SizeBytes": 26
+        },
+        "awsRegion": "us-west-2",
+        "eventName": "INSERT",
+        "eventSourceARN": "eventsource_arn",
+        "eventSource": "aws:dynamodb"
+      },
+      {
+        "eventID": "1",
+        "eventVersion": "1.0",
+        "dynamodb": {
+          "Keys": {
+            "Id": {
+              "N": "101"
+            }
+          },
+          "NewImage": {
+            "SomethingElse": {
+              "S": "success"
+            }
+          },
+          "StreamViewType": "NEW_AND_OLD_IMAGES",
+          "SequenceNumber": "8640712661",
+          "SizeBytes": 26
+        },
+        "awsRegion": "us-west-2",
+        "eventName": "INSERT",
+        "eventSourceARN": "eventsource_arn",
+        "eventSource": "aws:dynamodb"
+      }
+    ]
+  }

examples/batch_processing/testing/src/app.py renamed to examples/batch_processing/src/getting_started_with_test_app.py

@@ -32,6 +32,7 @@ class OrderKinesisRecord(KinesisDataStreamRecord):
 
 @tracer.capture_method
 def record_handler(record: OrderKinesisRecord):
+    logger.info(record.kinesis.data.item)
     return record.kinesis.data.item