@webiny/handler 6.0.0-beta.0 → 6.0.0-rc.0

package/fastify.d.ts

@@ -1,9 +1,11 @@
-/// <reference types="node" />
-import { PluginCollection, PluginsContainer } from "@webiny/plugins/types";
-import { FastifyInstance, FastifyServerOptions as ServerOptions } from "fastify";
+import type { PluginCollection } from "@webiny/plugins/types.js";
+import { PluginsContainer } from "@webiny/plugins/types.js";
+import type { FastifyInstance, FastifyServerOptions as ServerOptions } from "fastify";
 export interface CreateHandlerParams {
     plugins: PluginCollection | PluginsContainer;
     options?: ServerOptions;
     debug?: boolean;
 }
-export declare const createHandler: (params: CreateHandlerParams) => FastifyInstance<import("fastify").RawServerDefault, import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault> & PromiseLike<FastifyInstance<import("fastify").RawServerDefault, import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault>>;
+export declare const createHandler: (params: CreateHandlerParams) => FastifyInstance<import("fastify").RawServerDefault, import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault> & PromiseLike<FastifyInstance<import("fastify").RawServerDefault, import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault>> & {
+    __linterBrands: "SafePromiseLike";
+};

package/fastify.js

@@ -1,91 +1,48 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createHandler = void 0;
-var _types = require("@webiny/plugins/types");
-var _fastify = _interopRequireDefault(require("fastify"));
-var _utils = require("@webiny/utils");
-var _Context = require("./Context");
-var _error = _interopRequireDefault(require("@webiny/error"));
-var _RoutePlugin = require("./plugins/RoutePlugin");
-var _handlerClient = require("@webiny/handler-client");
-var _cookie = _interopRequireDefault(require("@fastify/cookie"));
-var _compress = _interopRequireDefault(require("@fastify/compress"));
-var _api = require("@webiny/api");
-var _BeforeHandlerPlugin = require("./plugins/BeforeHandlerPlugin");
-var _HandlerResultPlugin = require("./plugins/HandlerResultPlugin");
-var _HandlerErrorPlugin = require("./plugins/HandlerErrorPlugin");
-var _ModifyFastifyPlugin = require("./plugins/ModifyFastifyPlugin");
-var _HandlerOnRequestPlugin = require("./plugins/HandlerOnRequestPlugin");
-var _ResponseHeaders = require("./ResponseHeaders");
-var _ModifyResponseHeadersPlugin = require("./plugins/ModifyResponseHeadersPlugin");
-function createDefaultHeaders() {
-  return _ResponseHeaders.ResponseHeaders.create({
-    "content-type": "application/json; charset=utf-8",
-    "cache-control": "no-store",
-    "access-control-allow-origin": "*",
-    "access-control-allow-headers": "*",
-    "access-control-allow-methods": "OPTIONS,POST,GET,DELETE,PUT,PATCH",
-    ...(0, _utils.getWebinyVersionHeaders)()
-  });
-}
-const getDefaultOptionsHeaders = () => {
-  return _ResponseHeaders.ResponseHeaders.create({
-    "access-control-max-age": "86400",
-    "cache-control": "public, max-age=86400"
-  });
-};
-const getDefaultHeaders = routes => {
-  const headers = createDefaultHeaders();
-
-  /**
-   * If we are accepting all headers, just output that one.
-   */
-  const keys = Object.keys(routes);
-  const all = keys.every(key => routes[key].length > 0);
-  if (all) {
-    headers.set("access-control-allow-methods", "*");
-  } else {
-    const allowedMethods = keys.filter(type => {
-      if (!routes[type] || !Array.isArray(routes[type])) {
-        return false;
-      }
-      return routes[type].length > 0;
-    }).sort().join(",");
-    headers.set("access-control-allow-methods", allowedMethods);
-  }
-  return headers;
-};
-const stringifyError = error => {
-  const {
-    name,
-    message,
-    code,
-    stack,
-    data
-  } = error;
-  return JSON.stringify({
-    ...error,
-    constructorName: error.constructor?.name || "UnknownError",
-    name: name || "No error name",
-    message: message || "No error message",
-    code: code || "NO_CODE",
-    data,
-    stack: process.env.DEBUG === "true" ? stack : "Turn on the debug flag to see the stack."
-  });
-};
+import { PluginsContainer } from "@webiny/plugins/types.js";
+import fastify from "fastify";
+import { middleware } from "@webiny/utils";
+import { Context } from "./Context.js";
+import WebinyError from "@webiny/error";
+import { RoutePlugin } from "./plugins/RoutePlugin.js";
+import { createHandlerClient } from "@webiny/handler-client";
+import fastifyCookie from "@fastify/cookie";
+import fastifyCompress from "@fastify/compress";
+import { ContextPlugin } from "@webiny/api";
+import { BeforeHandlerPlugin } from "./plugins/BeforeHandlerPlugin.js";
+import { HandlerResultPlugin } from "./plugins/HandlerResultPlugin.js";
+import { HandlerErrorPlugin } from "./plugins/HandlerErrorPlugin.js";
+import { ModifyFastifyPlugin } from "./plugins/ModifyFastifyPlugin.js";
+import { HandlerOnRequestPlugin } from "./plugins/HandlerOnRequestPlugin.js";
+import { ResponseHeaders } from "./ResponseHeaders.js";
+import { ModifyResponseHeadersPlugin } from "./plugins/ModifyResponseHeadersPlugin.js";
+import { SetDefaultHeaders } from "./PreHandler/SetDefaultHeaders.js";
+import { PreHandler } from "./PreHandler/PreHandler.js";
+import { stringifyError } from "./stringifyError.js";
+import { ProcessHandlerOnRequestPlugins } from "./PreHandler/ProcessHandlerOnRequestPlugins.js";
+import { ProcessContextPlugins } from "./PreHandler/ProcessContextPlugins.js";
+import { IfNotOptionsRequest } from "./PreHandler/IfNotOptionsRequest.js";
+import { ProcessBeforeHandlerPlugins } from "./PreHandler/ProcessBeforeHandlerPlugins.js";
+import { IfOptionsRequest } from "./PreHandler/IfOptionsRequest.js";
+import { SendEarlyOptionsResponse } from "./PreHandler/SendEarlyOptionsResponse.js";
+import { OnRequestTimeoutPlugin } from "./plugins/OnRequestTimeoutPlugin.js";
+import { OnRequestResponseSendPlugin } from "./plugins/OnRequestResponseSendPlugin.js";
+import { Request } from "./abstractions/Request.js";
+import { Reply } from "./abstractions/Reply.js";
 const modifyResponseHeaders = (app, request, reply) => {
-  const modifyHeaders = app.webiny.plugins.byType(_ModifyResponseHeadersPlugin.ModifyResponseHeadersPlugin.type);
-  const headers = _ResponseHeaders.ResponseHeaders.create(reply.getHeaders());
+  const modifyHeaders = app.webiny.plugins.byType(ModifyResponseHeadersPlugin.type);
+  const replyHeaders = reply.getHeaders();
+  const headers = ResponseHeaders.create(replyHeaders);
   modifyHeaders.forEach(plugin => {
     plugin.modify(request, headers);
   });
-  reply.headers(headers.getHeaders());
+
+  // Exclude 'set-cookie' header to avoid duplication.
+  // Cookies are managed by @fastify/cookie and calling reply.headers() with 'set-cookie' duplicates them.
+  const headersToSet = headers.getHeaders();
+  delete headersToSet["set-cookie"];
+  reply.headers(headersToSet);
 };
-const createHandler = params => {
+export const createHandler = params => {
   const definedRoutes = {
     POST: [],
     GET: [],
@@ -102,11 +59,14 @@ const createHandler = params => {
     PROPPATCH: [],
     SEARCH: [],
     TRACE: [],
-    UNLOCK: []
+    UNLOCK: [],
+    REPORT: [],
+    MKCALENDAR: []
   };
   const throwOnDefinedRoute = (type, path, options) => {
     if (type === "ALL") {
-      const all = Object.keys(definedRoutes).find(key => {
+      const all = Object.keys(definedRoutes).find(k => {
+        const key = k.toUpperCase();
         const routes = definedRoutes[key];
         return routes.includes(path);
       });
@@ -115,7 +75,7 @@ const createHandler = params => {
       }
       console.error(`Error while registering onAll route. One of the routes is already defined.`);
       console.error(JSON.stringify(all));
-      throw new _error.default(`You cannot override a route with onAll() method, please remove unnecessary route from the system.`, "OVERRIDE_ROUTE_ERROR", {
+      throw new WebinyError(`You cannot override a route with onAll() method, please remove unnecessary route from the system.`, "OVERRIDE_ROUTE_ERROR", {
         type,
         path
       });
@@ -125,12 +85,13 @@ const createHandler = params => {
       return;
     }
     console.error(`Error while trying to override route: [${type}] ${path}`);
-    throw new _error.default(`When you are trying to override existing route, you must send "override" parameter when adding that route.`, "OVERRIDE_ROUTE_ERROR", {
+    throw new WebinyError(`When you are trying to override existing route, you must send "override" parameter when adding that route.`, "OVERRIDE_ROUTE_ERROR", {
       type,
       path
     });
   };
-  const addDefinedRoute = (type, path) => {
+  const addDefinedRoute = (input, path) => {
+    const type = input.toUpperCase();
     if (!definedRoutes[type]) {
       return;
     } else if (definedRoutes[type].includes(path)) {
@@ -142,17 +103,16 @@ const createHandler = params => {
   /**
    * We must attach the server to our internal context if we want to have it accessible.
    */
-  const app = (0, _fastify.default)({
+  const app = fastify({
     bodyLimit: 536870912,
     // 512MB
-
-    // TODO: in the near future, pass own Pino logger instance.
-    logger: false,
+    disableRequestLogging: true,
+    allowErrorHandlerOverride: true,
     ...(params.options || {})
   });
 
   /**
-   * We need to register routes in our system so we can output headers later on and dissallow overriding routes.
+   * We need to register routes in our system to output headers later on, and disallow route overriding.
    */
   app.addHook("onRoute", route => {
     const method = route.method;
@@ -173,7 +133,7 @@ const createHandler = params => {
    *
    * https://github.com/fastify/fastify-cookie
    */
-  app.register(_cookie.default, {
+  app.register(fastifyCookie, {
     parseOptions: {} // options for parsing cookies
   });
   /**
@@ -181,7 +141,7 @@ const createHandler = params => {
    *
    * https://github.com/fastify/fastify-compress
    */
-  app.register(_compress.default, {
+  app.register(fastifyCompress, {
     global: true,
     threshold: 1024,
     onUnsupportedEncoding: (encoding, _, reply) => {
@@ -229,15 +189,15 @@ const createHandler = params => {
     }
   };
   let context;
-  const plugins = new _types.PluginsContainer([
+  const plugins = new PluginsContainer([
   /**
    * We must have handlerClient by default.
    * And it must be one of the first context plugins applied.
    */
-  (0, _handlerClient.createHandlerClient)()]);
+  createHandlerClient()]);
   plugins.merge(params.plugins || []);
   try {
-    context = new _Context.Context({
+    context = new Context({
       plugins,
       /**
        * Inserted via webpack at build time.
@@ -257,95 +217,68 @@ const createHandler = params => {
   app.decorate("webiny", context);
 
   /**
-   * On every request we add default headers, which can be changed later.
-   * Also, if it is an options request, we skip everything after this hook and output options headers.
+   * To prevent Unsupported Media Type errors on OPTIONS requests with a body,
+   * we need to have a custom parser
    */
-  app.addHook("onRequest", async (request, reply) => {
-    const isOptionsRequest = request.method === "OPTIONS";
-    /**
-     * Our default headers are always set. Users can override them.
-     */
-    const defaultHeaders = getDefaultHeaders(definedRoutes);
-    const initialHeaders = isOptionsRequest ? defaultHeaders.merge(getDefaultOptionsHeaders()) : defaultHeaders;
-    reply.headers(initialHeaders.getHeaders());
-    /**
-     * Users can define their own custom handlers for the onRequest event - so let's run them first.
-     */
-    const plugins = app.webiny.plugins.byType(_HandlerOnRequestPlugin.HandlerOnRequestPlugin.type);
-    let name;
-    try {
-      for (const plugin of plugins) {
-        name = plugin.name;
-        const result = await plugin.exec(request, reply);
-        if (result === false) {
-          return;
-        }
-      }
-    } catch (ex) {
-      console.error(`Error while running the "HandlerOnRequestPlugin" ${name ? `(${name})` : ""} plugin in the onRequest hook.`);
-      console.error(stringifyError(ex));
-      throw ex;
-    }
-    /**
-     * When we receive the OPTIONS request, we end it before it goes any further as there is no need for anything to run after this - at least for our use cases.
-     *
-     * Users can prevent this by creating their own HandlerOnRequestPlugin and returning false as the result of the callable.
-     */
-    if (!isOptionsRequest) {
-      return;
-    }
-    if (reply.sent) {
-      /**
-       * At this point throwing an exception will not do anything with the response. So just log it.
-       */
-      console.error(JSON.stringify({
-        message: `Output was already sent. Please check custom plugins of type "HandlerOnRequestPlugin".`,
-        explanation: "This error can happen if the user plugin ended the reply, but did not return false as response."
-      }));
+  app.addContentTypeParser("application/json", {
+    parseAs: "string",
+    bodyLimit: 1024 * 1024
+  }, (req, body, done) => {
+    if (req.method === "OPTIONS") {
+      done(null, undefined);
       return;
     }
-    modifyResponseHeaders(app, request, reply);
-    reply.code(204).send("").hijack();
-  });
-  app.addHook("preParsing", async (request, reply) => {
-    app.webiny.request = request;
-    app.webiny.reply = reply;
-    const plugins = app.webiny.plugins.byType(_api.ContextPlugin.type);
-    let name;
     try {
-      for (const plugin of plugins) {
-        name = plugin.name;
-        await plugin.apply(app.webiny);
-      }
-    } catch (ex) {
-      console.error(`Error while running the "ContextPlugin" ${name ? `(${name})` : ""} plugin in the preParsing hook.`);
-      console.error(stringifyError(ex));
-      throw ex;
+      const json = typeof body === "string" ? body : body.toString("utf8");
+      done(null, JSON.parse(json));
+    } catch (err) {
+      done(err);
     }
   });
+
   /**
+   * With this we ensure that an undefined request body is not parsed on OPTIONS requests,
+   * in case there's a `content-type` header set for whatever reason.
    *
+   * @see https://fastify.dev/docs/latest/Reference/ContentTypeParser/#content-type-parser
    */
-  app.addHook("preHandler", async () => {
-    const plugins = app.webiny.plugins.byType(_BeforeHandlerPlugin.BeforeHandlerPlugin.type);
-    let name;
-    try {
-      for (const plugin of plugins) {
-        name = plugin.name;
-        await plugin.apply(app.webiny);
-      }
-    } catch (ex) {
-      console.error(`Error while running the "BeforeHandlerPlugin" ${name ? `(${name})` : ""} plugin in the preHandler hook.`);
-      console.error(stringifyError(ex));
-      throw ex;
+  app.addHook("onRequest", async request => {
+    if (request.method === "OPTIONS" && request.body === undefined) {
+      request.headers["content-type"] = undefined;
     }
   });
 
   /**
-   *
+   * At this point, request body is properly parsed, and we can execute Webiny business logic.
+   * - set default headers
+   * - process `HandlerOnRequestPlugin`
+   * - if OPTIONS request, exit early
+   * - process `ContextPlugin`
+   * - process `BeforeHandlerPlugin`
    */
-  const preSerialization = async (_, __, payload) => {
-    const plugins = app.webiny.plugins.byType(_HandlerResultPlugin.HandlerResultPlugin.type);
+  app.addHook("preHandler", async (request, reply) => {
+    app.webiny.request = request;
+    app.webiny.reply = reply;
+
+    // Bind request and reply to DI container for runtime access
+    if (app.webiny.container) {
+      app.webiny.container.registerInstance(Request, request);
+      app.webiny.container.registerInstance(Reply, reply);
+    }
+    /**
+     * Default code to 200 - so we do not need to set it again.
+     * Usually we set errors manually when we use reply.send.
+     */
+    reply.code(200);
+    const handlerOnRequestPlugins = app.webiny.plugins.byType(HandlerOnRequestPlugin.type);
+    const contextPlugins = app.webiny.plugins.byType(ContextPlugin.type);
+    const beforeHandlerPlugins = app.webiny.plugins.byType(BeforeHandlerPlugin.type);
+    const modifyHeadersPlugins = app.webiny.plugins.byType(ModifyResponseHeadersPlugin.type);
+    const preHandler = new PreHandler([new SetDefaultHeaders(definedRoutes), new ProcessHandlerOnRequestPlugins(handlerOnRequestPlugins), new IfNotOptionsRequest([new ProcessContextPlugins(app.webiny, contextPlugins), new ProcessBeforeHandlerPlugins(app.webiny, beforeHandlerPlugins)]), new IfOptionsRequest([new SendEarlyOptionsResponse(modifyHeadersPlugins)])]);
+    await preHandler.execute(request, reply, app.webiny);
+  });
+  app.addHook("preSerialization", async (_, __, payload) => {
+    const plugins = app.webiny.plugins.byType(HandlerResultPlugin.type);
     let name;
     try {
       for (const plugin of plugins) {
@@ -358,9 +291,31 @@ const createHandler = params => {
       throw ex;
     }
     return payload;
-  };
-  app.addHook("preSerialization", preSerialization);
-  app.setErrorHandler(async (error, request, reply) => {
+  });
+  app.setErrorHandler(async (error, _, reply) => {
+    /**
+     * IMPORTANT! Do not send anything if reply was already sent.
+     */
+    if (reply.sent) {
+      console.warn("Reply already sent, cannot send the result (handler:setErrorHandler).");
+      return reply;
+    }
+    if (error.code?.startsWith("Authentication/")) {
+      return reply.status(401).headers({
+        "Cache-Control": "no-store"
+      }).send(JSON.stringify({
+        message: error.message,
+        code: error.code
+      }));
+    }
+    if (error.code === "Tenancy/TenantDisabled") {
+      return reply.status(503).headers({
+        "Cache-Control": "no-store"
+      }).send(JSON.stringify({
+        message: error.message,
+        code: error.code
+      }));
+    }
     return reply.status(500).headers({
       "Cache-Control": "no-store"
     }).send(
@@ -374,24 +329,37 @@ const createHandler = params => {
     }));
   });
   app.addHook("onError", async (_, reply, error) => {
-    const plugins = app.webiny.plugins.byType(_HandlerErrorPlugin.HandlerErrorPlugin.type);
+    const plugins = app.webiny.plugins.byType(HandlerErrorPlugin.type);
     /**
      * Log error to cloud, as these can be extremely annoying to debug!
      */
-    console.error("@webiny/handler");
-    console.error(stringifyError(error));
-    reply.status(500).headers({
-      "Cache-Control": "no-store"
-    }).send(
+    console.error("Logging error in @webiny/handler");
+    try {
+      console.error(stringifyError(error));
+    } catch (ex) {
+      console.warn("Could not stringify error:");
+      console.log(error);
+      console.error("Stringify error:", ex);
+    }
     /**
-     * When we are sending the error in the response, we cannot send the whole error object, as it might contain some sensitive data.
+     * IMPORTANT! Do not send anything if reply was already sent.
      */
-    JSON.stringify({
-      message: error.message,
-      code: error.code,
-      data: error.data
-    }));
-    const handler = (0, _utils.middleware)(plugins.map(pl => {
+    if (!reply.sent) {
+      reply.status(500).headers({
+        "Cache-Control": "no-store"
+      }).send(
+      /**
+       * When we are sending the error in the response, we cannot send the whole error object, as it might contain some sensitive data.
+       */
+      JSON.stringify({
+        message: error.message,
+        code: error.code,
+        data: error.data
+      }));
+    } else {
+      console.warn("Reply already sent, cannot send the result (handler:addHook:onError).");
+    }
+    const handler = middleware(plugins.map(pl => {
       return (context, error, next) => {
         return pl.handle(context, error, next);
       };
@@ -403,8 +371,13 @@ const createHandler = params => {
   /**
    * Apply response headers modifier plugins.
    */
-  app.addHook("onSend", async (request, reply, payload) => {
+  app.addHook("onSend", async (request, reply, input) => {
     modifyResponseHeaders(app, request, reply);
+    const plugins = app.webiny.plugins.byType(OnRequestResponseSendPlugin.type);
+    let payload = input;
+    for (const plugin of plugins) {
+      payload = await plugin.exec(request, reply, payload);
+    }
     return payload;
   });
 
@@ -414,14 +387,18 @@ const createHandler = params => {
   app.addHook("onResponse", async () => {
     await context.benchmark.output();
   });
-  app.addHook("onTimeout", async () => {
+  app.addHook("onTimeout", async (request, reply) => {
+    const plugins = app.webiny.plugins.byType(OnRequestTimeoutPlugin.type);
+    for (const plugin of plugins) {
+      await plugin.exec(request, reply);
+    }
     await context.benchmark.output();
   });
 
   /**
    * 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);
+  const modifyPlugins = app.webiny.plugins.byType(ModifyFastifyPlugin.type);
   let modifyFastifyPluginName;
   try {
     for (const plugin of modifyPlugins) {
@@ -441,7 +418,7 @@ const createHandler = params => {
    *
    * Routes are registered in fastify but events must be handled in package which implements cloud specific methods.
    */
-  const routePlugins = app.webiny.plugins.byType(_RoutePlugin.RoutePlugin.type);
+  const routePlugins = app.webiny.plugins.byType(RoutePlugin.type);
 
   /**
    * Add routes to the system.
@@ -462,6 +439,5 @@ const createHandler = params => {
   }
   return app;
 };
-exports.createHandler = createHandler;
 
 //# sourceMappingURL=fastify.js.map