docs(batch): added flow charts (#1640)

Author: dreamorosi

docs/snippets/batch/accessProcessedMessages.ts

@@ -22,16 +22,17 @@ export const handler = async (
   event: SQSEvent,
   context: Context
 ): Promise<SQSBatchResponse> => {
-  const batch = event.Records;
+  const batch = event.Records; // (1)!
 
-  processor.register(batch, recordHandler, { context });
+  processor.register(batch, recordHandler, { context }); // (2)!
   const processedMessages = processor.process();
 
   for (const message of processedMessages) {
     const status: 'success' | 'fail' = message[0];
+    const error = message[1];
     const record = message[2];
 
-    logger.info('Processed record', { status, record });
+    logger.info('Processed record', { status, record, error });
   }
 
   return processor.response();

docs/snippets/batch/customPartialProcessor.ts

@@ -11,7 +11,7 @@ import {
 import type {
   SuccessResponse,
   FailureResponse,
-  EventSourceType,
+  BaseRecord,
 } from '@aws-lambda-powertools/batch';
 import type { SQSEvent, Context, SQSBatchResponse } from 'aws-lambda';
 
@@ -27,7 +27,7 @@ class MyPartialProcessor extends BasePartialProcessor {
   }
 
   public async asyncProcessRecord(
-    _record: EventSourceType
+    _record: BaseRecord
   ): Promise<SuccessResponse | FailureResponse> {
     throw new Error('Not implemented');
   }
@@ -69,9 +69,7 @@ class MyPartialProcessor extends BasePartialProcessor {
    * Here we are keeping the status of each run, `this.handler` is
    * the function that is passed when calling `processor.register()`.
    */
-  public processRecord(
-    record: EventSourceType
-  ): SuccessResponse | FailureResponse {
+  public processRecord(record: BaseRecord): SuccessResponse | FailureResponse {
     try {
       const result = this.handler(record);
 

docs/snippets/batch/gettingStartedDynamoDBStreams.ts

@@ -11,7 +11,7 @@ import type {
   DynamoDBBatchResponse,
 } from 'aws-lambda';
 
-const processor = new BatchProcessor(EventType.DynamoDBStreams);
+const processor = new BatchProcessor(EventType.DynamoDBStreams); // (1)!
 const logger = new Logger();
 
 const recordHandler = (record: DynamoDBRecord): void => {

docs/snippets/batch/gettingStartedErrorHandling.ts

@@ -0,0 +1,43 @@
+import {
+  BatchProcessor,
+  EventType,
+  processPartialResponse,
+} from '@aws-lambda-powertools/batch';
+import { Logger } from '@aws-lambda-powertools/logger';
+import type {
+  SQSEvent,
+  SQSRecord,
+  Context,
+  SQSBatchResponse,
+} from 'aws-lambda';
+
+const processor = new BatchProcessor(EventType.SQS);
+const logger = new Logger();
+
+class InvalidPayload extends Error {
+  public constructor(message: string) {
+    super(message);
+    this.name = 'InvalidPayload';
+  }
+}
+
+const recordHandler = (record: SQSRecord): void => {
+  const payload = record.body;
+  if (payload) {
+    const item = JSON.parse(payload);
+    logger.info('Processed item', { item });
+  } else {
+    // prettier-ignore
+    throw new InvalidPayload('Payload does not contain minumum required fields'); // (1)!
+  }
+};
+
+export const handler = async (
+  event: SQSEvent,
+  context: Context
+): Promise<SQSBatchResponse> => {
+  // prettier-ignore
+  return processPartialResponse(event, recordHandler, processor, { // (2)!
+    context,
+  });
+};

docs/snippets/batch/gettingStartedKinesis.ts

@@ -11,7 +11,7 @@ import type {
   KinesisStreamBatchResponse,
 } from 'aws-lambda';
 
-const processor = new BatchProcessor(EventType.KinesisDataStreams);
+const processor = new BatchProcessor(EventType.KinesisDataStreams); // (1)!
 const logger = new Logger();
 
 const recordHandler = (record: KinesisStreamRecord): void => {

docs/snippets/batch/gettingStartedSQS.ts

@@ -11,10 +11,11 @@ import type {
   SQSBatchResponse,
 } from 'aws-lambda';
 
-const processor = new BatchProcessor(EventType.SQS);
+const processor = new BatchProcessor(EventType.SQS); // (1)!
 const logger = new Logger();
 
-const recordHandler = (record: SQSRecord): void => {
+// prettier-ignore
+const recordHandler = (record: SQSRecord): void => { // (2)!
   const payload = record.body;
   if (payload) {
     const item = JSON.parse(payload);
@@ -26,7 +27,8 @@ export const handler = async (
   event: SQSEvent,
   context: Context
 ): Promise<SQSBatchResponse> => {
-  return processPartialResponse(event, recordHandler, processor, {
+  // prettier-ignore
+  return processPartialResponse(event, recordHandler, processor, { // (3)!
     context,
   });
 };

docs/snippets/batch/gettingStartedSQSFifo.ts

@@ -10,7 +10,7 @@ import type {
   SQSBatchResponse,
 } from 'aws-lambda';
 
-const processor = new SqsFifoPartialProcessor();
+const processor = new SqsFifoPartialProcessor(); // (1)!
 const logger = new Logger();
 
 const recordHandler = (record: SQSRecord): void => {