feat(parser): add custom parse error (#2339)

aws-powertools · Apr 9, 2024 · 221c769 · 221c769
1 parent e0de20b
commit 221c769
Show file tree

Hide file tree

Showing 26 changed files with 241 additions and 78 deletions.
diff --git a/packages/parser/src/envelopes/apigw.ts b/packages/parser/src/envelopes/apigw.ts
@@ -2,6 +2,7 @@ import { Envelope } from './envelope.js';
 import { z, type ZodSchema } from 'zod';
 import { APIGatewayProxyEventSchema } from '../schemas/apigw.js';
 import type { ParsedResult } from '../types/parser.js';
+import { ParseError } from '../errors.js';
 
 /**
  * API Gateway envelope to extract data within body key
@@ -21,7 +22,11 @@ export class ApiGatewayEnvelope extends Envelope {
     const parsedEnvelope = APIGatewayProxyEventSchema.safeParse(data);
     if (!parsedEnvelope.success) {
       return {
-        ...parsedEnvelope,
+        success: false,
+        error: new ParseError(
+          'Failed to parse ApiGatewayEnvelope',
+          parsedEnvelope.error
+        ),
         originalEvent: data,
       };
     }
@@ -30,7 +35,11 @@ export class ApiGatewayEnvelope extends Envelope {
 
     if (!parsedBody.success) {
       return {
-        ...parsedBody,
+        success: false,
+        error: new ParseError(
+          'Failed to parse ApiGatewayEnvelope body',
+          parsedBody.error
+        ),
         originalEvent: data,
       };
     }

diff --git a/packages/parser/src/envelopes/apigwv2.ts b/packages/parser/src/envelopes/apigwv2.ts
@@ -2,6 +2,7 @@ import { z, type ZodSchema } from 'zod';
 import { APIGatewayProxyEventV2Schema } from '../schemas/apigwv2.js';
 import { Envelope } from './envelope.js';
 import type { ParsedResult } from '../types/index.js';
+import { ParseError } from '../errors.js';
 
 /**
  * API Gateway V2 envelope to extract data within body key
@@ -21,7 +22,11 @@ export class ApiGatewayV2Envelope extends Envelope {
     const parsedEnvelope = APIGatewayProxyEventV2Schema.safeParse(data);
     if (!parsedEnvelope.success) {
       return {
-        ...parsedEnvelope,
+        success: false,
+        error: new ParseError(
+          'Failed to parse API Gateway V2 envelope',
+          parsedEnvelope.error
+        ),
         originalEvent: data,
       };
     }
@@ -30,7 +35,11 @@ export class ApiGatewayV2Envelope extends Envelope {
 
     if (!parsedBody.success) {
       return {
-        ...parsedBody,
+        success: false,
+        error: new ParseError(
+          'Failed to parse API Gateway V2 envelope body',
+          parsedBody.error
+        ),
         originalEvent: data,
       };
     }

diff --git a/packages/parser/src/envelopes/cloudwatch.ts b/packages/parser/src/envelopes/cloudwatch.ts
@@ -2,6 +2,7 @@ import { z, type ZodSchema } from 'zod';
 import { Envelope } from './envelope.js';
 import { CloudWatchLogsSchema } from '../schemas/index.js';
 import type { ParsedResult } from '../types/index.js';
+import { ParseError } from '../errors.js';
 
 /**
  * CloudWatch Envelope to extract a List of log records.
@@ -33,7 +34,10 @@ export class CloudWatchEnvelope extends Envelope {
     if (!parsedEnvelope.success) {
       return {
         success: false,
-        error: parsedEnvelope.error,
+        error: new ParseError(
+          'Failed to parse CloudWatch envelope',
+          parsedEnvelope.error
+        ),
         originalEvent: data,
       };
     }
@@ -44,7 +48,10 @@ export class CloudWatchEnvelope extends Envelope {
       if (!parsedMessage.success) {
         return {
           success: false,
-          error: parsedMessage.error,
+          error: new ParseError(
+            'Failed to parse CloudWatch log event',
+            parsedMessage.error
+          ),
           originalEvent: data,
         };
       } else {

diff --git a/packages/parser/src/envelopes/dynamodb.ts b/packages/parser/src/envelopes/dynamodb.ts
@@ -2,6 +2,7 @@ import { z, type ZodSchema } from 'zod';
 import { DynamoDBStreamSchema } from '../schemas/index.js';
 import type { ParsedResult, ParsedResultError } from '../types/index.js';
 import { Envelope } from './envelope.js';
+import { ParseError } from '../errors.js';
 
 type DynamoDBStreamEnvelopeResponse<T extends ZodSchema> = {
   NewImage: z.infer<T>;
@@ -38,7 +39,10 @@ export class DynamoDBStreamEnvelope extends Envelope {
     if (!parsedEnvelope.success) {
       return {
         success: false,
-        error: parsedEnvelope.error,
+        error: new ParseError(
+          'Failed to parse DynamoDB Stream envelope',
+          parsedEnvelope.error
+        ),
         originalEvent: data,
       };
     }
@@ -51,8 +55,11 @@ export class DynamoDBStreamEnvelope extends Envelope {
         return {
           success: false,
           error: !parsedNewImage.success
-            ? parsedNewImage.error
-            : (parsedOldImage as ParsedResultError<unknown>).error,
+            ? new ParseError('Failed to parse NewImage', parsedNewImage.error)
+            : new ParseError(
+                'Failed to parse OldImage',
+                (parsedOldImage as ParsedResultError<unknown>).error
+              ),
           originalEvent: data,
         };
       } else {

diff --git a/packages/parser/src/envelopes/envelope.ts b/packages/parser/src/envelopes/envelope.ts
@@ -1,5 +1,6 @@
 import { z, type ZodSchema } from 'zod';
 import type { ParsedResult } from '../types/parser.js';
+import { ParseError } from '../errors.js';
 
 export class Envelope {
   /**
@@ -14,14 +15,20 @@ export class Envelope {
     data: unknown,
     schema: T
   ): z.infer<T> => {
-    if (typeof data === 'string') {
-      return schema.parse(JSON.parse(data));
-    } else if (typeof data === 'object') {
-      return schema.parse(data);
-    } else
-      throw new Error(
+    if (typeof data !== 'object' && typeof data !== 'string') {
+      throw new ParseError(
         `Invalid data type for envelope. Expected string or object, got ${typeof data}`
       );
+    }
+    try {
+      if (typeof data === 'string') {
+        return schema.parse(JSON.parse(data));
+      } else if (typeof data === 'object') {
+        return schema.parse(data);
+      }
+    } catch (e) {
+      throw new ParseError(`Failed to parse envelope`, e as Error);
+    }
   };
 
   /**
@@ -38,7 +45,7 @@ export class Envelope {
       if (typeof input !== 'object' && typeof input !== 'string') {
         return {
           success: false,
-          error: new Error(
+          error: new ParseError(
             `Invalid data type for envelope. Expected string or object, got ${typeof input}`
           ),
           originalEvent: input,
@@ -56,13 +63,13 @@ export class Envelope {
           }
         : {
             success: false,
-            error: parsed.error,
+            error: new ParseError(`Failed to parse envelope`, parsed.error),
             originalEvent: input,
           };
     } catch (e) {
       return {
         success: false,
-        error: e as Error,
+        error: new ParseError(`Failed to parse envelope`, e as Error),
         originalEvent: input,
       };
     }

diff --git a/packages/parser/src/envelopes/event-bridge.ts b/packages/parser/src/envelopes/event-bridge.ts
@@ -2,6 +2,7 @@ import { Envelope } from './envelope.js';
 import { z, type ZodSchema } from 'zod';
 import { EventBridgeSchema } from '../schemas/index.js';
 import type { ParsedResult } from '../types/index.js';
+import { ParseError } from '../errors.js';
 
 /**
  * Envelope for EventBridge schema that extracts and parses data from the `detail` key.
@@ -22,7 +23,11 @@ export class EventBridgeEnvelope extends Envelope {
 
     if (!parsedEnvelope.success) {
       return {
-        ...parsedEnvelope,
+        success: false,
+        error: new ParseError(
+          'Failed to parse EventBridge envelope',
+          parsedEnvelope.error
+        ),
         originalEvent: data,
       };
     }
@@ -31,7 +36,11 @@ export class EventBridgeEnvelope extends Envelope {
 
     if (!parsedDetail.success) {
       return {
-        ...parsedDetail,
+        success: false,
+        error: new ParseError(
+          'Failed to parse EventBridge envelope detail',
+          parsedDetail.error
+        ),
         originalEvent: data,
       };
     }

diff --git a/packages/parser/src/envelopes/kafka.ts b/packages/parser/src/envelopes/kafka.ts
@@ -5,6 +5,7 @@ import {
   KafkaSelfManagedEventSchema,
 } from '../schemas/kafka.js';
 import { ParsedResult, KafkaMskEvent } from '../types/index.js';
+import { ParseError } from '../errors.js';
 
 /**
  * Kafka event envelope to extract data within body key
@@ -51,7 +52,11 @@ export class KafkaEnvelope extends Envelope {
 
     if (!parsedEnvelope.success) {
       return {
-        ...parsedEnvelope,
+        success: false,
+        error: new ParseError(
+          'Failed to parse Kafka envelope',
+          parsedEnvelope.error
+        ),
         originalEvent: data,
       };
     }
@@ -63,7 +68,10 @@ export class KafkaEnvelope extends Envelope {
         if (!parsedRecord.success) {
           return {
             success: false,
-            error: parsedRecord.error,
+            error: new ParseError(
+              'Failed to parse Kafka record',
+              parsedRecord.error
+            ),
             originalEvent: data,
           };
         }

diff --git a/packages/parser/src/envelopes/kinesis-firehose.ts b/packages/parser/src/envelopes/kinesis-firehose.ts
@@ -2,6 +2,7 @@ import { z, type ZodSchema } from 'zod';
 import { Envelope } from './envelope.js';
 import { KinesisFirehoseSchema } from '../schemas/index.js';
 import type { ParsedResult } from '../types/index.js';
+import { ParseError } from '../errors.js';
 
 /**
  * Kinesis Firehose Envelope to extract array of Records
@@ -35,7 +36,11 @@ export class KinesisFirehoseEnvelope extends Envelope {
 
     if (!parsedEnvelope.success) {
       return {
-        ...parsedEnvelope,
+        success: false,
+        error: new ParseError(
+          'Failed to parse Kinesis Firehose envelope',
+          parsedEnvelope.error
+        ),
         originalEvent: data,
       };
     }
@@ -46,7 +51,10 @@ export class KinesisFirehoseEnvelope extends Envelope {
       if (!parsedData.success) {
         return {
           success: false,
-          error: parsedData.error,
+          error: new ParseError(
+            'Failed to parse Kinesis Firehose record',
+            parsedData.error
+          ),
           originalEvent: data,
         };
       }

diff --git a/packages/parser/src/envelopes/kinesis.ts b/packages/parser/src/envelopes/kinesis.ts
@@ -2,6 +2,7 @@ import { Envelope } from './envelope.js';
 import { z, type ZodSchema } from 'zod';
 import { KinesisDataStreamSchema } from '../schemas/kinesis.js';
 import type { ParsedResult } from '../types/index.js';
+import { ParseError } from '../errors.js';
 
 /**
  * Kinesis Data Stream Envelope to extract array of Records
@@ -32,7 +33,11 @@ export class KinesisEnvelope extends Envelope {
     const parsedEnvelope = KinesisDataStreamSchema.safeParse(data);
     if (!parsedEnvelope.success) {
       return {
-        ...parsedEnvelope,
+        success: false,
+        error: new ParseError(
+          'Failed to parse Kinesis Data Stream envelope',
+          parsedEnvelope.error
+        ),
         originalEvent: data,
       };
     }
@@ -43,7 +48,11 @@ export class KinesisEnvelope extends Envelope {
       const parsedRecord = super.safeParse(record.kinesis.data, schema);
       if (!parsedRecord.success) {
         return {
-          ...parsedRecord,
+          success: false,
+          error: new ParseError(
+            'Failed to parse Kinesis Data Stream record',
+            parsedRecord.error
+          ),
           originalEvent: data,
         };
       }

diff --git a/packages/parser/src/envelopes/lambda.ts b/packages/parser/src/envelopes/lambda.ts
@@ -2,6 +2,7 @@ import { Envelope } from './envelope.js';
 import { z, type ZodSchema } from 'zod';
 import { LambdaFunctionUrlSchema } from '../schemas/index.js';
 import type { ParsedResult } from '../types/index.js';
+import { ParseError } from '../errors.js';
 
 /**
  * Lambda function URL envelope to extract data within body key
@@ -28,15 +29,20 @@ export class LambdaFunctionUrlEnvelope extends Envelope {
 
     if (!parsedEnvelope.success) {
       return {
-        ...parsedEnvelope,
+        success: false,
+        error: new ParseError('Failed to parse Lambda function URL envelope'),
         originalEvent: data,
       };
     }
 
     const parsedBody = super.safeParse(parsedEnvelope.data.body, schema);
     if (!parsedBody.success) {
       return {
-        ...parsedBody,
+        success: false,
+        error: new ParseError(
+          'Failed to parse Lambda function URL body',
+          parsedBody.error
+        ),
         originalEvent: data,
       };
     }