add middy middleware

Author: am29d

packages/parser/src/envelopes/eventBridgeEnvelope.ts renamed to packages/parser/src/envelopes/event-bridge.ts

@@ -0,0 +1,56 @@
+import { MiddyLikeRequest } from '@aws-lambda-powertools/commons/types';
+import { MiddlewareObj } from '@middy/core';
+import { ZodSchema } from 'zod';
+import { Envelope } from '../types/envelope.js';
+
+interface ParserOptions<S extends ZodSchema> {
+  schema: S;
+  envelope?: Envelope;
+}
+
+/**
+ * A middiy middleware to parse your event.
+ *
+ * @exmaple
+ * ```typescirpt
+ * import { parser } from '@aws-lambda-powertools/parser/middleware';
+ * import middy from '@middy/core';
+ * import { sqsEnvelope } from '@aws-lambda-powertools/parser/envelopes/sqs;'
+ *
+ * const oderSchema = z.object({
+ *   id: z.number(),
+ *   description: z.string(),
+ *   quantity: z.number(),
+ * });
+ *
+ * type Order = z.infer<typeof oderSchema>;
+ *
+ * export const handler = middy(
+ *   async (event: Order, _context: unknown): Promise<void> => {
+ *     // event is validated as sqs message envelope
+ *     // the body is unwrapped and parsed into object ready to use
+ *     // you can now use event as Order in your code
+ *   }
+ * ).use(parser({ schema: oderSchema, envelope: sqsEnvelope }));
+ * ```
+ *
+ * @param options
+ */
+const parser = <S extends ZodSchema>(
+  options: ParserOptions<S>
+): MiddlewareObj => {
+  const before = (request: MiddyLikeRequest): void => {
+    const { schema, envelope } = options;
+    if (envelope) {
+      request.event = envelope(request.event, schema);
+    } else {
+      request.event = schema.parse(request.event);
+    }
+  };
+
+  return {
+    before,
+  };
+};
+
+export { parser };

packages/parser/src/middleware/parser.ts

@@ -0,0 +1,30 @@
+import { apiGatewayEnvelope } from '../envelopes/apigw.js';
+import { apiGatewayV2Envelope } from '../envelopes/apigwv2.js';
+import { cloudWatchEnvelope } from '../envelopes/cloudwatch.js';
+import { dynamoDDStreamEnvelope } from '../envelopes/dynamodb.js';
+import { kafkaEnvelope } from '../envelopes/kafka.js';
+import { kinesisEnvelope } from '../envelopes/kinesis.js';
+import { kinesisFirehoseEnvelope } from '../envelopes/kinesis-firehose.js';
+import { lambdaFunctionUrlEnvelope } from '../envelopes/lambda.js';
+import { snsEnvelope } from '../envelopes/sns.js';
+import { snsSqsEnvelope } from '../envelopes/sns.js';
+import { sqsEnvelope } from '../envelopes/sqs.js';
+import { vpcLatticeEnvelope } from '../envelopes/vpc-lattice.js';
+import { vpcLatticeV2Envelope } from '../envelopes/vpc-latticev2.js';
+import { eventBridgeEnvelope } from '../envelopes/event-bridge.js';
+
+export type Envelope =
+  | typeof apiGatewayEnvelope
+  | typeof apiGatewayV2Envelope
+  | typeof cloudWatchEnvelope
+  | typeof dynamoDDStreamEnvelope
+  | typeof eventBridgeEnvelope
+  | typeof kafkaEnvelope
+  | typeof kinesisEnvelope
+  | typeof kinesisFirehoseEnvelope
+  | typeof lambdaFunctionUrlEnvelope
+  | typeof snsEnvelope
+  | typeof snsSqsEnvelope
+  | typeof sqsEnvelope
+  | typeof vpcLatticeEnvelope
+  | typeof vpcLatticeV2Envelope;

packages/parser/src/types/envelope.ts

@@ -7,7 +7,7 @@
 import { TestEvents, TestSchema } from '../schema/utils.js';
 import { generateMock } from '@anatine/zod-mock';
 import { EventBridgeEvent } from 'aws-lambda';
-import { eventBridgeEnvelope } from '../../../src/envelopes/eventBridgeEnvelope';
+import { eventBridgeEnvelope } from '../../../src/envelopes/event-bridge.js';
 
 describe('EventBridgeEnvelope ', () => {
   it('should parse eventbridge event', () => {

packages/parser/tests/unit/envelopes/eventbridge.test.ts

@@ -0,0 +1,121 @@
+/**
+ * Test middelware parser
+ *
+ * @group unit/parser
+ */
+
+import middy from '@middy/core';
+import { Context } from 'aws-lambda';
+import { parser } from '../../src/middleware/parser.js';
+import { generateMock } from '@anatine/zod-mock';
+import { SqsSchema } from '../../src/schemas/sqs.js';
+import { z, ZodSchema } from 'zod';
+import { sqsEnvelope } from '../../src/envelopes/sqs';
+
+describe('Middleware: parser', () => {
+  const schema = z.object({
+    name: z.string(),
+    age: z.number().min(18).max(99),
+  });
+  type schema = z.infer<typeof schema>;
+  const handler = async (
+    event: schema | unknown,
+    _context: Context
+  ): Promise<schema | unknown> => {
+    return event;
+  };
+
+  describe(' when envelope is provided ', () => {
+    const middyfiedHandler = middy(handler).use(
+      parser({ schema: schema, envelope: sqsEnvelope })
+    );
+
+    it('should parse request body with schema and envelope', async () => {
+      const bodyMock = generateMock(schema);
+
+      const event = generateMock(SqsSchema, {
+        stringMap: {
+          body: () => JSON.stringify(bodyMock),
+        },
+      });
+
+      const result = (await middyfiedHandler(event, {} as Context)) as schema[];
+      result.forEach((item) => {
+        expect(item).toEqual(bodyMock);
+      });
+    });
+
+    it('should throw when envelope does not match', async () => {
+      await expect(async () => {
+        await middyfiedHandler({ name: 'John', age: 18 }, {} as Context);
+      }).rejects.toThrowError();
+    });
+
+    it('should throw when schema does not match', async () => {
+      const event = generateMock(SqsSchema, {
+        stringMap: {
+          body: () => '42',
+        },
+      });
+
+      await expect(middyfiedHandler(event, {} as Context)).rejects.toThrow();
+    });
+    it('should throw when provided schema is invalid', async () => {
+      const middyfiedHandler = middy(handler).use(
+        parser({ schema: {} as ZodSchema, envelope: sqsEnvelope })
+      );
+
+      await expect(middyfiedHandler(42, {} as Context)).rejects.toThrowError();
+    });
+    it('should throw when envelope is correct but schema is invalid', async () => {
+      const event = generateMock(SqsSchema, {
+        stringMap: {
+          body: () => JSON.stringify({ name: 'John', foo: 'bar' }),
+        },
+      });
+
+      const middyfiedHandler = middy(handler).use(
+        parser({ schema: {} as ZodSchema, envelope: sqsEnvelope })
+      );
+
+      await expect(
+        middyfiedHandler(event, {} as Context)
+      ).rejects.toThrowError();
+    });
+  });
+
+  describe(' when envelope is not provided', () => {
+    it('should parse the event with built-in schema', async () => {
+      const event = generateMock(SqsSchema);
+
+      const middyfiedHandler = middy(handler).use(
+        parser({ schema: SqsSchema })
+      );
+
+      expect(await middyfiedHandler(event, {} as Context)).toEqual(event);
+    });
+
+    it('should parse custom event', async () => {
+      const event = { name: 'John', age: 18 };
+      const middyfiedHandler = middy(handler).use(parser({ schema }));
+
+      expect(await middyfiedHandler(event, {} as Context)).toEqual(event);
+    });
+
+    it('should throw when the schema does not match', async () => {
+      const middyfiedHandler = middy(handler).use(parser({ schema }));
+
+      await expect(middyfiedHandler(42, {} as Context)).rejects.toThrow();
+    });
+
+    it('should throw when provided schema is invalid', async () => {
+      const middyfiedHandler = middy(handler).use(
+        parser({ schema: {} as ZodSchema })
+      );
+
+      await expect(
+        middyfiedHandler({ foo: 'bar' }, {} as Context)
+      ).rejects.toThrowError();
+    });
+  });
+});