feat(handler): custom error handling (#2943)

apps/api/graphql/tsconfig.json

@@ -110,8 +110,8 @@
       "~/*": ["./src/*"],
       "@webiny/api-aco/*": ["../../../packages/api-aco/src/*"],
       "@webiny/api-aco": ["../../../packages/api-aco/src"],
-      "@webiny/api-aco-so-ddb/*": ["../../../packages/api-aco/src/*"],
-      "@webiny/api-aco-so-ddb": ["../../../packages/api-aco/src"],
+      "@webiny/api-aco-so-ddb/*": ["../../../packages/api-aco-so-ddb/src/*"],
+      "@webiny/api-aco-so-ddb": ["../../../packages/api-aco-so-ddb/src"],
       "@webiny/api-admin-users-cognito/*": ["../../../packages/api-admin-users-cognito/src/*"],
       "@webiny/api-admin-users-cognito": ["../../../packages/api-admin-users-cognito/src"],
       "@webiny/api-admin-users-cognito-so-ddb/*": [

packages/handler-aws/src/dynamodb/index.ts

@@ -25,7 +25,7 @@ export interface CreateHandlerParams extends BaseCreateHandlerParams {
 export const createHandler = (params: CreateHandlerParams): HandlerCallable => {
     return (payload, context) => {
         const app = createBaseHandler({
-            plugins: params.plugins,
+            ...params,
             options: {
                 logger: params.debug === true,
                 ...(params.options || {})

packages/handler-aws/src/eventBridge/index.ts

@@ -30,7 +30,7 @@ export const createHandler = <DetailType extends string, Detail>(
 ): HandlerCallable<DetailType, Detail> => {
     return (payload, context) => {
         const app = createBaseHandler({
-            plugins: params.plugins,
+            ...params,
             options: {
                 logger: params.debug === true,
                 ...(params.options || {})

packages/handler-aws/src/gateway/index.ts

@@ -64,7 +64,7 @@ const attachRequiredProperties = (event: APIGatewayEvent): void => {
 export const createHandler = (params: CreateHandlerParams): HandlerCallable => {
     return (event, context) => {
         const app = createBaseHandler({
-            plugins: params.plugins,
+            ...params,
             options: {
                 logger: params.http?.debug === true,
                 ...(params.options || {})

packages/handler-aws/src/raw/index.ts

@@ -32,7 +32,7 @@ export const createHandler = <Payload = any, Response = APIGatewayProxyResult>(
 ): HandlerCallable<Payload, Response> => {
     return (payload, context) => {
         const app = createBaseHandler({
-            plugins: params.plugins,
+            ...params,
             options: {
                 logger: params.http?.debug === true,
                 ...(params.options || {})

packages/handler-aws/src/s3/index.ts

@@ -22,7 +22,7 @@ export interface CreateHandlerParams extends BaseCreateHandlerParams {
 export const createHandler = (params: CreateHandlerParams): HandlerCallable => {
     return (payload, context) => {
         const app = createBaseHandler({
-            plugins: params.plugins,
+            ...params,
             options: {
                 logger: params.debug === true,
                 ...(params.options || {})

packages/handler-aws/src/sqs/index.ts

@@ -22,7 +22,7 @@ export interface CreateHandlerParams extends BaseCreateHandlerParams {
 export const createHandler = (params: CreateHandlerParams): HandlerCallable => {
     return (payload, context) => {
         const app = createBaseHandler({
-            plugins: params.plugins,
+            ...params,
             options: {
                 logger: params.debug === true,
                 ...(params.options || {})

packages/handler/__tests__/customErrorHandler.test.ts

@@ -0,0 +1,107 @@
+import { createHandler } from "~/fastify";
+import { createRoute } from "~/plugins/RoutePlugin";
+import WebinyError from "@webiny/error";
+import { createModifyFastifyPlugin } from "~/plugins/ModifyFastifyPlugin";
+
+describe("custom error handler", () => {
+    const data = {
+        stringValue: "123",
+        numberValue: 123,
+        booleanValue: false,
+        arrayValue: ["123", 123, false],
+        objectValue: {
+            testing: true,
+            errorMessage: "not ok"
+        }
+    };
+
+    it("should properly output error via built-in error handler", async () => {
+        const app = createHandler({
+            plugins: [
+                createRoute(({ onAll }) => {
+                    onAll("/webiny-test", async () => {
+                        throw new WebinyError(
+                            "Testing custom error handler output",
+                            "CUSTOM_ERROR_HANDLER_CODE",
+                            data
+                        );
+                    });
+                })
+            ]
+        });
+
+        const result = await app.inject({
+            path: "/webiny-test",
+            headers: {
+                "content-type": "application/json"
+            },
+            method: "POST",
+            payload: "{}"
+        });
+
+        const expected = JSON.stringify({
+            message: "Testing custom error handler output",
+            code: "CUSTOM_ERROR_HANDLER_CODE",
+            data: {
+                stringValue: "123",
+                numberValue: 123,
+                booleanValue: false,
+                arrayValue: ["123", 123, false],
+                objectValue: {
+                    testing: true,
+                    errorMessage: "not ok"
+                }
+            }
+        });
+
+        expect(result).toMatchObject({
+            payload: expected,
+            body: expected,
+            statusCode: 500
+        });
+    });
+
+    it("should properly output error via user defined error handler", async () => {
+        const app = createHandler({
+            plugins: [
+                createModifyFastifyPlugin(instance => {
+                    instance.setErrorHandler((error, request, reply) => {
+                        return reply
+                            .send({
+                                justSimpleOutput: true
+                            })
+                            .code(404);
+                    });
+                }),
+                createRoute(({ onAll }) => {
+                    onAll("/webiny-test", async () => {
+                        throw new WebinyError(
+                            "Testing custom error handler output",
+                            "CUSTOM_ERROR_HANDLER_CODE",
+                            data
+                        );
+                    });
+                })
+            ]
+        });
+
+        const result = await app.inject({
+            path: "/webiny-test",
+            headers: {
+                "content-type": "application/json"
+            },
+            method: "GET",
+            payload: "{}"
+        });
+
+        const expected = JSON.stringify({
+            justSimpleOutput: true
+        });
+
+        expect(result).toMatchObject({
+            payload: expected,
+            body: expected,
+            statusCode: 404
+        });
+    });
+});

packages/handler/__tests__/modifyFastify.test.ts

@@ -0,0 +1,16 @@
+import { createHandler } from "~/fastify";
+import { createModifyFastifyPlugin } from "~/plugins/ModifyFastifyPlugin";
+
+describe("modify fastify with plugin", () => {
+    it("should modify existing Fastify instance via the plugin", async () => {
+        const app = createHandler({
+            plugins: [
+                createModifyFastifyPlugin(instance => {
+                    (instance as any).modifiedValue = true;
+                })
+            ]
+        });
+
+        expect((app as any).modifiedValue).toEqual(true);
+    });
+});

packages/handler/src/fastify.ts

@@ -16,6 +16,7 @@ import { ContextPlugin } from "@webiny/api";
 import { BeforeHandlerPlugin } from "./plugins/BeforeHandlerPlugin";
 import { HandlerResultPlugin } from "./plugins/HandlerResultPlugin";
 import { HandlerErrorPlugin } from "./plugins/HandlerErrorPlugin";
+import { ModifyFastifyPlugin } from "~/plugins/ModifyFastifyPlugin";
 
 const DEFAULT_HEADERS: Record<string, string> = {
     "Cache-Control": "no-store",
@@ -300,15 +301,31 @@ export const createHandler = (params: CreateHandlerParams) => {
 
     app.addHook("preSerialization", preSerialization);
 
-    app.addHook("onError", async (_, reply, error) => {
+    app.setErrorHandler<WebinyError>(async (error, request, reply) => {
+        return reply
+            .status(500)
+            .headers({
+                "Cache-Control": "no-store"
+            })
+            .send({
+                message: error.message,
+                code: error.code,
+                data: error.data
+            });
+    });
+
+    app.addHook("onError", async (_, reply, error: any) => {
         const plugins = app.webiny.plugins.byType<HandlerErrorPlugin>(HandlerErrorPlugin.type);
-        // Log error to cloud, as these can be extremely annoying to debug!
+        /**
+         * Log error to cloud, as these can be extremely annoying to debug!
+         */
         console.log("@webiny/handler");
         console.log(
             JSON.stringify({
-                ...(error || {}),
-                message: error?.message,
-                code: error?.code
+                ...error,
+                message: error.message,
+                code: error.code,
+                data: error.data
             })
         );
         const handler = middleware(
@@ -321,11 +338,24 @@ export const createHandler = (params: CreateHandlerParams) => {
         await handler(app.webiny, error);
 
         return reply
+            .send({
+                message: error.message,
+                code: error.code,
+                data: error.data
+            })
             .headers({
                 "Cache-Control": "no-store"
             })
             .status(500);
     });
 
+    /**
+     * With these plugins we give users possibility to do anything they want on our fastify instance.
+     */
+    const modifyPlugins = app.webiny.plugins.byType<ModifyFastifyPlugin>(ModifyFastifyPlugin.type);
+    for (const plugin of modifyPlugins) {
+        plugin.modify(app);
+    }
+
     return app;
 };

packages/handler/src/index.ts

@@ -1,8 +1,9 @@
-export * from "~/fastify";
 export * from "@webiny/api/plugins/ContextPlugin";
+export * from "~/fastify";
 export * from "~/Context";
 export * from "~/plugins/EventPlugin";
 export * from "~/plugins/RoutePlugin";
 export * from "~/plugins/BeforeHandlerPlugin";
 export * from "~/plugins/HandlerErrorPlugin";
 export * from "~/plugins/HandlerResultPlugin";
+export * from "~/plugins/ModifyFastifyPlugin";

packages/handler/src/plugins/ModifyFastifyPlugin.ts

@@ -0,0 +1,25 @@
+import { Plugin } from "@webiny/plugins/Plugin";
+import { FastifyInstance } from "fastify";
+
+interface ModifyFastifyPluginCallable {
+    (app: FastifyInstance): void;
+}
+
+export class ModifyFastifyPlugin extends Plugin {
+    public static override type = "handler.fastify.modify";
+
+    private readonly cb: ModifyFastifyPluginCallable;
+
+    public constructor(cb: ModifyFastifyPluginCallable) {
+        super();
+        this.cb = cb;
+    }
+
+    public modify(app: FastifyInstance): void {
+        this.cb(app);
+    }
+}
+
+export const createModifyFastifyPlugin = (cb: ModifyFastifyPluginCallable) => {
+    return new ModifyFastifyPlugin(cb);
+};