[MS-758] feat: Cleanup erors

package.json

@@ -63,6 +63,7 @@
     "husky": "^9.1.6",
     "jose": "^5.9.4",
     "jsonwebtoken": "^9.0.2",
+    "klona": "^2.0.6",
     "nodemailer": "^6.9.15",
     "path-to-regexp": "^8.2.0",
     "pg": "^8.13.0",
@@ -73,6 +74,7 @@
     "react-email": "^3.0.1",
     "tailwind-merge": "^2.5.4",
     "tailwindcss": "^3.4.14",
+    "traverse": "^0.6.10",
     "ts-invariant": "^0.10.3",
     "tsconfig-paths": "^4.2.0",
     "typescript": "^5.6.3",
@@ -97,6 +99,7 @@
     "@types/node": "^20.16.11",
     "@types/nodemailer": "^6.4.16",
     "@types/pg": "^8.11.10",
+    "@types/traverse": "^0.6.37",
     "@typescript-eslint/parser": "^7.18.0",
     "@vitest/coverage-v8": "^2.1.3",
     "commitizen": "^4.3.1",

src/api/rest/routes.test.ts

@@ -1,4 +1,4 @@
-import { beforeEach, describe, expect, test, vi } from "vitest";
+import { beforeEach, describe, expect, it, vi } from "vitest";
 
 import * as validate from "@/lib/graphql/validate";
 import * as auth from "@/lib/saleor/auth";
@@ -8,7 +8,7 @@ import { EVENT_HANDLERS } from "./saleor/webhooks";
 
 describe("apiRoutes", () => {
   describe("/api/healthcheck", () => {
-    test("200", async () => {
+    it("200", async () => {
       const app = await createServer();
       const response = await app.inject({
         method: "GET",
@@ -31,7 +31,7 @@ describe("apiRoutes", () => {
       app.sqs.send = sendSpy;
     });
 
-    test("Should return 401 with invalid JWT.", async () => {
+    it("Should return 401 with invalid JWT.", async () => {
       // given
       const expectedStatusCode = 401;
       const expectedJson = {
@@ -56,7 +56,7 @@ describe("apiRoutes", () => {
       expect(response.statusCode).toStrictEqual(expectedStatusCode);
     });
 
-    test("Should return 400 passed when event is not supported.", async () => {
+    it("Should return 400 passed when event is not supported.", async () => {
       // given
       const expectedStatusCode = 400;
       const expectedJson = {
@@ -87,7 +87,7 @@ describe("apiRoutes", () => {
       expect(response.statusCode).toStrictEqual(expectedStatusCode);
     });
 
-    test("Should return proper response.", async () => {
+    it("Should return proper response.", async () => {
       const jwtVerifySpy = vi.spyOn(auth, "verifyJWTSignature");
       const validateSpy = vi.spyOn(validate, "validateDocumentAgainstData");
       const expectedJson = { status: "ok" };

src/api/rest/routes.ts

@@ -5,8 +5,8 @@ import { z } from "zod";
 
 import { CONFIG } from "@/config";
 import { OrderCreatedSubscriptionDocument } from "@/graphql/operations/subscriptions/generated";
-import { serializePayload } from "@/lib/emails/events/helpers";
 import { validateDocumentAgainstData } from "@/lib/graphql/validate";
+import { serializePayload } from "@/lib/payload";
 import { verifyJWTSignature } from "@/lib/saleor/auth";
 import { saleorBearerHeader } from "@/lib/saleor/schema";
 import { getJWKSProvider } from "@/providers/jwks";

src/api/rest/saleor/webhooks.test.ts

@@ -1,8 +1,8 @@
 import { JWTInvalid } from "jose/errors";
-import { beforeEach, describe, expect, test, vi } from "vitest";
+import { beforeEach, describe, expect, it, vi } from "vitest";
 
 import { CONFIG } from "@/config";
-import { serializePayload } from "@/lib/emails/events/helpers";
+import { serializePayload } from "@/lib/payload";
 import * as auth from "@/lib/saleor/auth";
 import { createServer } from "@/server";
 
@@ -21,7 +21,7 @@ describe("saleorWebhooksRoutes", () => {
   });
 
   describe("/api/saleor/webhooks/email/*", () => {
-    test.each(EVENT_HANDLERS)(
+    it.each(EVENT_HANDLERS)(
       "should register route for $event event",
       ({ event }) => {
         // Given
@@ -37,7 +37,7 @@ describe("saleorWebhooksRoutes", () => {
       }
     );
 
-    test("require saleor headers", async () => {
+    it("require saleor headers", async () => {
       // Given
       const url = `${baseUrl}account-confirmed`;
       const expectedStatusCode = 400;
@@ -82,7 +82,7 @@ describe("saleorWebhooksRoutes", () => {
       expect(response.statusCode).toStrictEqual(expectedStatusCode);
     });
 
-    test("is protected by JWT", async () => {
+    it("is protected by JWT", async () => {
       // Given
       const url = `${baseUrl}account-confirmed`;
       const expectedStatusCode = 401;
@@ -116,7 +116,7 @@ describe("saleorWebhooksRoutes", () => {
       expect(response.statusCode).toStrictEqual(expectedStatusCode);
     });
 
-    test("it should send SQS message with proper payload", async () => {
+    it("it should send SQS message with proper payload", async () => {
       // Given
       const url = `${baseUrl}account-confirmed`;
       const event = "account_confirmed";

src/api/rest/saleor/webhooks.ts

@@ -20,7 +20,7 @@ import {
   OrderRefundedSubscriptionDocument,
 } from "@/graphql/operations/subscriptions/generated";
 import { type WebhookEventTypeAsyncEnum } from "@/graphql/schema";
-import { serializePayload } from "@/lib/emails/events/helpers";
+import { serializePayload } from "@/lib/payload";
 import { verifyWebhookSignature } from "@/lib/saleor/auth";
 import { saleorWebhookHeaders } from "@/lib/saleor/schema";
 import { getJWKSProvider } from "@/providers/jwks";

src/emails-sender-proxy.ts

@@ -1,4 +1,3 @@
-import { SQSClient } from "@aws-sdk/client-sqs";
 import { type Context, type SQSEvent, type SQSRecord } from "aws-lambda";
 import { Consumer } from "sqs-consumer";
 
@@ -7,18 +6,14 @@ import { handler, logger } from "@/emails-sender";
 
 const app = Consumer.create({
   queueUrl: CONFIG.SQS_QUEUE_URL,
-  sqs: new SQSClient({
-    useQueueUrlAsEndpoint: false,
-    endpoint: CONFIG.SQS_QUEUE_URL,
-  }),
   handleMessageBatch: async (messages) => {
     const event: SQSEvent = {
       Records: messages as SQSRecord[],
     };
     const context = {} as Context;
     const callback = () => null;
 
-    await handler(event, context, () => callback);
+    return await handler(event, context, () => callback);
   },
 });
 

src/emails-sender.ts

@@ -1,20 +1,33 @@
 import "./instrument.emails-sender";
 
 import * as Sentry from "@sentry/aws-serverless";
-import { type Context, type SQSBatchResponse, type SQSEvent } from "aws-lambda";
+import {
+  type Callback,
+  type Context,
+  type SQSBatchItemFailure,
+  type SQSBatchResponse,
+  type SQSEvent,
+} from "aws-lambda";
 
 import { CONFIG } from "@/config";
-import { parseRecord } from "@/lib/aws/serverless/utils";
 import { TEMPLATES_MAP } from "@/lib/emails/const";
-import { getJSONFormatHeader } from "@/lib/saleor/apps/utils";
+import {
+  EventNotSupportedError,
+  FormatNotSupportedError,
+} from "@/lib/emails/errors";
+import { getJSONFormatHeader, parseRecord } from "@/lib/payload";
 import { getEmailProvider } from "@/providers/email";
 import { getLogger } from "@/providers/logger";
 
 export const logger = getLogger();
 
 export const handler = Sentry.wrapHandler(
-  async (event: SQSEvent, context: Context) => {
-    const failures: string[] = [];
+  async (
+    event: SQSEvent,
+    context: Context,
+    callback: Callback
+  ): Promise<SQSBatchResponse> => {
+    const batchItemFailures: SQSBatchItemFailure[] = [];
 
     logger.info(`Received event with ${event.Records.length} records.`);
 
@@ -25,16 +38,24 @@ export const handler = Sentry.wrapHandler(
         format,
         payload: { data, event },
       } = parseRecord(record);
+      const supportedJSONFormat = getJSONFormatHeader({
+        version: 1,
+        name: CONFIG.NAME,
+      });
 
-      if (format === getJSONFormatHeader({ version: 1, name: CONFIG.NAME })) {
+      if (format === supportedJSONFormat) {
         const match = TEMPLATES_MAP[event];
 
         if (!match) {
-          return logger.warn("Received payload with unhandled template.", {
+          logger.warn("Received payload with unhandled template.", {
             format,
             data,
             event,
           });
+          throw new EventNotSupportedError(
+            `No template matched for event: ${event}.`,
+            { cause: { format, data, event } }
+          );
         }
 
         const { extractFn, template } = match;
@@ -53,8 +74,6 @@ export const handler = Sentry.wrapHandler(
           props: { data },
           template,
         });
-        // TODO: Handle properly
-        // Will throw TypeError if failed to render / non transient
 
         await sender.send({
           html,
@@ -63,21 +82,32 @@ export const handler = Sentry.wrapHandler(
 
         logger.info("Email sent successfully.", { toEmail, event });
       } else {
-        return logger.warn("Received payload with unsupported format.", {
+        logger.warn("Received payload with unsupported format.", {
           format,
           data,
           event,
         });
+        throw new FormatNotSupportedError(
+          `Unsupported payload format header: ${format}`,
+          {
+            cause: {
+              supportedFormat: supportedJSONFormat,
+              incomingFormat: format,
+              data,
+              event,
+            },
+          }
+        );
       }
     }
 
-    if (failures.length) {
-      const batchFailure: SQSBatchResponse = {
-        batchItemFailures: failures.map((id) => ({ itemIdentifier: id })),
-      };
-      logger.error(`FAILING messages: ${JSON.stringify(batchFailure)}`);
-
-      return batchFailure;
+    if (batchItemFailures.length) {
+      const failedMessagesId = batchItemFailures.map(
+        ({ itemIdentifier }) => itemIdentifier
+      );
+      logger.error(`Failed messages: ${failedMessagesId.join(", ")}.`);
     }
+
+    return { batchItemFailures };
   }
 );

src/events-receiver.ts

@@ -1,5 +1,3 @@
-// TODO: Saleor events receiver & queue dispatcher
-
 import AWSLambdaFastify from "@fastify/aws-lambda";
 
 import { createServer } from "./server";