@tsed/platform-fastify 8.5.0-beta.1

package/package.json

@@ -0,0 +1,118 @@
+{
+  "name": "@tsed/platform-fastify",
+  "type": "module",
+  "version": "8.5.0-beta.1",
+  "description": "Fastify package for Ts.ED framework",
+  "source": "./src/index.ts",
+  "main": "./lib/esm/index.js",
+  "module": "./lib/esm/index.js",
+  "typings": "./lib/types/index.d.ts",
+  "exports": {
+    ".": {
+      "@tsed/source": "./src/index.ts",
+      "types": "./lib/types/index.d.ts",
+      "import": "./lib/esm/index.js",
+      "default": "./lib/esm/index.js"
+    }
+  },
+  "scripts": {
+    "build": "yarn barrels && yarn build:ts",
+    "barrels": "barrels",
+    "start": "node --import @swc-node/register/esm-register test/app/index.ts",
+    "test": "vitest run -u",
+    "build:ts": "tsc --build tsconfig.json",
+    "test:ci": "vitest run --coverage.thresholds.autoUpdate=true"
+  },
+  "keywords": [
+    "Fastify",
+    "TypeScript",
+    "Decorator",
+    "decorators",
+    "fastify",
+    "Controller",
+    "Inject",
+    "ioc",
+    "di",
+    "mvc",
+    "swagger",
+    "swagger ui",
+    "ESM",
+    "ES6",
+    "server",
+    "rest",
+    "api",
+    "validation"
+  ],
+  "author": "Romain Lenzotti",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/tsedio/tsed/issues"
+  },
+  "homepage": "https://github.com/tsedio/tsed/tree/production/packages/platform/platform-fastify",
+  "repository": "https://github.com/tsedio/tsed",
+  "dependencies": {
+    "@fastify/accepts": ">=5.0.2",
+    "@fastify/middie": ">=9.0.2",
+    "@fastify/static": ">=8.0.4",
+    "content-disposition": ">=0.5.4",
+    "tslib": "2.7.0"
+  },
+  "devDependencies": {
+    "@fastify/cookie": "11.0.1",
+    "@fastify/formbody": "8.0.1",
+    "@fastify/session": "11.0.1",
+    "@tsed/barrels": "8.5.0-beta.1",
+    "@tsed/core": "8.5.0-beta.1",
+    "@tsed/di": "8.5.0-beta.1",
+    "@tsed/platform-http": "8.5.0-beta.1",
+    "@tsed/platform-test-sdk": "8.5.0-beta.1",
+    "@types/content-disposition": "^0.5.4",
+    "cross-env": "7.0.3",
+    "fastify": "5.2.1",
+    "fastify-raw-body": "5.0.0",
+    "ts-node": "10.9.2"
+  },
+  "peerDependencies": {
+    "@fastify/accepts": ">=4.3.0",
+    "@fastify/cookie": ">=9.3.1",
+    "@fastify/formbody": ">=7.4.0",
+    "@tsed/core": ">=8.5.0-beta.1",
+    "@tsed/di": ">=8.5.0-beta.1",
+    "@tsed/json-mapper": ">=8.5.0-beta.1",
+    "@tsed/logger": ">=7.0.0",
+    "@tsed/openspec": ">=8.5.0-beta.1",
+    "@tsed/platform-http": ">=8.5.0-beta.1",
+    "@tsed/schema": ">=8.5.0-beta.1",
+    "fastify": ">=5.1.0",
+    "fastify-raw-body": ">=5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@tsed/common": {
+      "optional": false
+    },
+    "@tsed/core": {
+      "optional": false
+    },
+    "@tsed/di": {
+      "optional": false
+    },
+    "@tsed/json-mapper": {
+      "optional": false
+    },
+    "@tsed/logger": {
+      "optional": false
+    },
+    "@tsed/openspec": {
+      "optional": false
+    },
+    "@tsed/schema": {
+      "optional": false
+    },
+    "fastify": {
+      "optional": false
+    }
+  },
+  "publishConfig": {
+    "tag": "beta"
+  }
+}

package/readme.md

@@ -0,0 +1,67 @@
+<p style="text-align: center" align="center">
+ <a href="https://tsed.io" target="_blank"><img src="https://tsed.io/tsed-og.png" width="200" alt="Ts.ED logo"/></a>
+</p>
+
+<div align="center">
+   <h1>Platform Fastify</h1>
+
+[![Build & Release](https://github.com/tsedio/tsed/workflows/Build%20&%20Release/badge.svg)](https://github.com/tsedio/tsed/actions?query=workflow%3A%22Build+%26+Release%22)
+[![PR Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/tsedio/tsed/blob/master/CONTRIBUTING.md)
+[![Coverage Status](https://coveralls.io/repos/github/tsedio/tsed/badge.svg?branch=production)](https://coveralls.io/github/tsedio/tsed?branch=production)
+[![npm version](https://badge.fury.io/js/%40tsed%2Fcommon.svg)](https://badge.fury.io/js/%40tsed%2Fcommon)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![github](https://img.shields.io/static/v1?label=Github%20sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/romakita)
+[![opencollective](https://img.shields.io/static/v1?label=OpenCollective%20sponsor&message=%E2%9D%A4&logo=OpenCollective&color=%23fe8e86)](https://opencollective.com/tsed)
+
+</div>
+
+<div align="center">
+  <a href="https://tsed.io/">Website</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://tsed.io/getting-started/">Getting started</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://api.tsed.io/rest/slack/tsedio/tsed">Slack</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://twitter.com/TsED_io">Twitter</a>
+</div>
+
+<hr />
+
+A package of the Ts.ED framework. See the [Getting Started Guide](https://tsed.io/getting-started/).
+
+## Installation
+
+Run npm command (or yarn):
+
+```bash
+npm install --save @tsed/platform-fastify fastify
+```
+
+## Contributors
+
+Please read [contributing guidelines here](https://tsed.io/CONTRIBUTING.html)
+
+<a href="https://github.com/tsedio/ts-express-decorators/graphs/contributors"><img src="https://opencollective.com/tsed/contributors.svg?width=890" /></a>
+
+## Backers
+
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tsed#backer)]
+
+<a href="https://opencollective.com/tsed#backers" target="_blank"><img src="https://opencollective.com/tsed/backers.svg?width=890"></a>
+
+## Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2016 - today Romain Lenzotti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/src/components/PlatformFastify.spec.ts

@@ -0,0 +1,34 @@
+import {PlatformBuilder} from "@tsed/platform-http";
+
+import {PlatformFastify} from "./PlatformFastify.js";
+
+class Server {}
+
+describe("PlatformFastify", () => {
+  describe("create()", () => {
+    beforeEach(() => {
+      vi.spyOn(PlatformBuilder, "create").mockReturnValue({} as never);
+    });
+    afterEach(() => vi.resetAllMocks());
+    it("should create platform", () => {
+      PlatformFastify.create(Server, {});
+
+      expect(PlatformBuilder.create).toHaveBeenCalledWith(Server, {
+        adapter: PlatformFastify
+      });
+    });
+  });
+  describe("bootstrap()", () => {
+    beforeEach(() => {
+      vi.spyOn(PlatformBuilder, "bootstrap").mockReturnValue({} as never);
+    });
+    afterEach(() => vi.resetAllMocks());
+    it("should create platform", async () => {
+      await PlatformFastify.bootstrap(Server, {});
+
+      expect(PlatformBuilder.bootstrap).toHaveBeenCalledWith(Server, {
+        adapter: PlatformFastify
+      });
+    });
+  });
+});

package/src/components/PlatformFastify.ts

@@ -0,0 +1,361 @@
+import * as Http from "node:http";
+import {IncomingMessage, ServerResponse} from "node:http";
+import * as Https from "node:https";
+
+import fastifyMiddie from "@fastify/middie";
+import fastifyStatics from "@fastify/static";
+import {type Env, isFunction, isString, ReturnHostInfoFromPort, Type} from "@tsed/core";
+import {constant, inject, logger, runInContext} from "@tsed/di";
+import {NotFound} from "@tsed/exceptions";
+import {PlatformExceptions} from "@tsed/platform-exceptions";
+import {
+  adapter,
+  createContext,
+  createServer,
+  Platform,
+  PlatformAdapter,
+  PlatformApplication,
+  PlatformBuilder,
+  PlatformHandler,
+  PlatformMulterSettings,
+  PlatformRequest,
+  PlatformResponse,
+  PlatformStaticsOptions
+} from "@tsed/platform-http";
+import {PlatformHandlerMetadata, PlatformHandlerType, PlatformLayer} from "@tsed/platform-router";
+import Fastify, {FastifyInstance, FastifyReply, FastifyRequest} from "fastify";
+
+import type {PlatformFastifyPluginLoadingOptions, PlatformFastifyPluginSettings} from "../interfaces/interfaces.js";
+import type {PlatformFastifySettings} from "../interfaces/PlatformFastifySettings.js";
+import {PlatformFastifyRequest} from "../services/PlatformFastifyRequest.js";
+import {PlatformFastifyResponse} from "../services/PlatformFastifyResponse.js";
+
+declare global {
+  namespace TsED {
+    export interface Application extends FastifyInstance {}
+  }
+
+  namespace TsED {}
+}
+
+export class PlatformFastify extends PlatformAdapter<FastifyInstance> {
+  readonly NAME = "fastify";
+
+  readonly providers = [
+    {
+      token: PlatformHandler
+    },
+    {token: PlatformApplication},
+    {token: Platform},
+    {
+      token: PlatformResponse,
+      useClass: PlatformFastifyResponse
+    },
+    {
+      token: PlatformRequest,
+      useClass: PlatformFastifyRequest
+    }
+  ];
+  private staticsDecorated = false;
+
+  /**
+   * Create new serverless application. In this mode, the component scan are disabled.
+   * @param module
+   * @param settings
+   */
+  static create(module: Type<any>, settings: Partial<TsED.Configuration> = {}) {
+    return PlatformBuilder.create<FastifyInstance>(module, {
+      ...settings,
+      adapter: PlatformFastify
+    });
+  }
+
+  /**
+   * Bootstrap a server application
+   * @param module
+   * @param settings
+   */
+  static bootstrap(module: Type<any>, settings: Partial<TsED.Configuration> = {}) {
+    return PlatformBuilder.bootstrap<FastifyInstance>(module, {
+      ...settings,
+      adapter: PlatformFastify
+    });
+  }
+
+  mapLayers(layers: PlatformLayer[]) {
+    const {app} = this;
+    const rawApp: FastifyInstance = app.getApp();
+
+    layers.forEach((layer) => {
+      switch (layer.method) {
+        case "use":
+          if ((rawApp as any).use) {
+            (rawApp as any).use(...layer.getArgs());
+          }
+          return;
+        case "statics":
+          this.statics(layer.path as string, layer.opts as any);
+
+          // rawApp.register();
+          return;
+      }
+      try {
+        rawApp.route({
+          method: layer.method.toUpperCase() as any,
+          url: layer.path as any,
+          handler: this.compose(layer),
+          config: {
+            rawBody: layer.handlers.some((handler) => handler.opts?.paramsTypes?.RAW_BODY)
+          }
+        });
+      } catch (er) {
+        logger().warn({
+          error_name: er.code,
+          error_message: er.message
+        });
+      }
+    });
+  }
+
+  mapHandler(handler: (...args: any[]) => any, metadata: PlatformHandlerMetadata) {
+    if (metadata.isRawMiddleware()) {
+      return handler;
+    }
+
+    switch (metadata.type) {
+      case PlatformHandlerType.MIDDLEWARE:
+        return (request: IncomingMessage, _: ServerResponse, done: (err?: any) => void) => {
+          const {$ctx} = request;
+
+          $ctx.next = done;
+
+          return runInContext($ctx, () => handler($ctx));
+        };
+
+      default:
+        return async (request: FastifyRequest, _: FastifyReply, done: (err?: any) => void) => {
+          const {$ctx} = request;
+
+          $ctx.next = done;
+
+          await runInContext($ctx, () => handler($ctx));
+
+          if (metadata.type === PlatformHandlerType.CTX_FN) {
+            done();
+          }
+        };
+    }
+  }
+
+  async useContext() {
+    const {app} = this;
+    const invoke = createContext();
+    const rawApp: FastifyInstance = app.getApp();
+
+    rawApp.addHook("onRequest", async (request, reply) => {
+      const $ctx = invoke({
+        request: request as any,
+        response: reply as any
+      });
+
+      ($ctx.request.getReq() as any).$ctx = $ctx;
+
+      await $ctx.start();
+    });
+
+    rawApp.addHook("onResponse", async (request, reply) => {
+      const {$ctx} = request;
+      ($ctx.request.getReq() as any).$ctx = undefined;
+      await $ctx.finish();
+    });
+
+    await rawApp.register(fastifyMiddie, {
+      hook: "onRequest"
+    });
+
+    const plugins = await this.resolvePlugins();
+
+    for (const plugin of plugins) {
+      // console.log("register", (plugin.use as any)[Symbol.for("plugin-meta")].name, plugin.options)
+      await rawApp.register(plugin.use as any, plugin.options!);
+    }
+  }
+
+  createApp() {
+    const {app, ...props} = constant<PlatformFastifySettings>("fastify") || {};
+    const httpPort = constant<number | false>("httpPort");
+    const httpOptions = constant<Http.ServerOptions>("httpOptions");
+    const httpsPort = constant<number | false>("httpsPort");
+    const httpsOptions = constant<Https.ServerOptions>("httpsOptions");
+    const opts = {
+      ...props,
+      ignoreTrailingSlash: true,
+      http:
+        httpPort !== false
+          ? {
+              ...httpOptions
+            }
+          : null,
+      https:
+        httpsPort !== false
+          ? {
+              ...httpsOptions
+            }
+          : null
+    };
+
+    const instance: FastifyInstance = app || Fastify(opts);
+
+    instance.decorateRequest("$ctx", null as never);
+    instance.decorateReply("locals", null);
+
+    return {
+      app: instance,
+      callback: () => {
+        return async (request: IncomingMessage, response: ServerResponse) => {
+          await instance.ready();
+          instance.server.emit("request", request, response);
+        };
+      }
+    };
+  }
+
+  afterLoadRoutes() {
+    const rawApp: FastifyInstance = this.app.getApp();
+
+    rawApp.setErrorHandler((error, request, reply) => {
+      const {$ctx} = request;
+      $ctx.error = $ctx.error || error;
+
+      return inject<PlatformExceptions>(PlatformExceptions)?.catch(error, $ctx);
+    });
+
+    rawApp.setNotFoundHandler((request, reply) => {
+      const {$ctx} = request;
+
+      return inject<PlatformExceptions>(PlatformExceptions)?.catch(new NotFound(`Resource "${request.originalUrl}" not found`), $ctx);
+    });
+
+    return Promise.resolve();
+  }
+
+  getServers(): any[] {
+    const httpsPort = constant<string | false>("httpsPort");
+    const httpPort = constant<string | false>("httpPort");
+
+    const listen = (hostinfo: ReturnHostInfoFromPort) =>
+      this.app.getApp().listen({
+        host: hostinfo.address,
+        port: hostinfo.port
+      });
+
+    const server = () => this.app.getApp().server;
+
+    return [
+      createServer({
+        port: httpsPort,
+        type: "https",
+        token: Https.Server,
+        server,
+        listen
+      }),
+      createServer({
+        port: httpPort,
+        type: "http",
+        token: Http.Server,
+        server,
+        listen
+      })
+    ];
+  }
+
+  bodyParser(type: string, opts: Record<string, any> | undefined): any {
+    return null;
+  }
+
+  multipart(options: PlatformMulterSettings): any {
+    logger().warn({
+      event: "PLATFORM_UNSUPPORTED_FEATURE",
+      message: "Multipart method is not implemented yet",
+      options
+    });
+    return null;
+  }
+
+  statics(endpoint: string, options: PlatformStaticsOptions): any {
+    this.app.getApp().register(fastifyStatics, {
+      root: options.root,
+      prefix: endpoint,
+      decorateReply: !this.staticsDecorated
+    });
+    this.staticsDecorated = true;
+
+    return null;
+  }
+
+  protected compose(layer: PlatformLayer) {
+    return (req: FastifyRequest, reply: FastifyReply) => {
+      return runInContext(req.$ctx, async () => {
+        const $ctx = req.$ctx;
+        $ctx.next = null;
+
+        for (const metadata of layer.handlers) {
+          try {
+            if (!req.$ctx.isDone()) {
+              if (
+                ($ctx.error && metadata.type === PlatformHandlerType.ERR_MIDDLEWARE) ||
+                (!$ctx.error && metadata.type !== PlatformHandlerType.ERR_MIDDLEWARE)
+              ) {
+                await metadata.compiledHandler($ctx);
+              }
+            }
+          } catch (er) {
+            $ctx.error = er;
+          }
+        }
+
+        if (req.$ctx.error) {
+          // TODO maybe we can use platform exception here?
+          throw req.$ctx.error;
+        }
+      });
+    };
+  }
+
+  protected async resolvePlugins(): Promise<PlatformFastifyPluginLoadingOptions[]> {
+    let plugins = constant<PlatformFastifyPluginSettings[]>("plugins", []);
+    const env = constant<Env>("env");
+
+    const promises = plugins.map(async (plugin: PlatformFastifyPluginSettings): Promise<PlatformFastifyPluginLoadingOptions> => {
+      if (isFunction(plugin)) {
+        return {
+          env,
+          use: plugin
+        };
+      }
+
+      if (isString(plugin)) {
+        plugin = {env, use: plugin};
+      }
+
+      let {use} = plugin;
+
+      if (isString(use)) {
+        const mod = await import(use);
+        use = mod.default || mod;
+      }
+
+      return {
+        env,
+        ...plugin,
+        use
+      };
+    });
+
+    plugins = await Promise.all(promises);
+
+    return plugins.filter((middleware) => middleware.use).filter((middleware) => middleware.env === env);
+  }
+}
+
+adapter(PlatformFastify);

package/src/index.ts

@@ -0,0 +1,8 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./components/PlatformFastify.js";
+export * from "./interfaces/interfaces.js";
+export * from "./interfaces/PlatformFastifySettings.js";
+export * from "./services/PlatformFastifyRequest.js";
+export * from "./services/PlatformFastifyResponse.js";

package/src/interfaces/PlatformFastifySettings.ts

@@ -0,0 +1,5 @@
+import type {FastifyInstance} from "fastify";
+
+export interface PlatformFastifySettings {
+  app?: FastifyInstance;
+}

package/src/interfaces/interfaces.ts

@@ -0,0 +1,26 @@
+import type {Env} from "@tsed/core";
+import type {FastifyPluginOptions, FastifyRegisterOptions} from "fastify";
+
+import type {PlatformFastifySettings} from "./PlatformFastifySettings.js";
+
+export * from "./PlatformFastifySettings.js";
+
+export type PlatformFastifyPluginTypes = ((opts?: any) => any) | /*Type<any> |*/ string;
+export type PlatformFastifyPluginLoadingOptions = {
+  env?: Env;
+  use: PlatformFastifyPluginTypes;
+  options?: FastifyRegisterOptions<FastifyPluginOptions>;
+};
+export type PlatformFastifyPluginSettings = PlatformFastifyPluginTypes | PlatformFastifyPluginLoadingOptions | any;
+
+declare global {
+  namespace TsED {
+    export interface Configuration {
+      /**
+       * Configuration related to Fastify platform application.
+       */
+      fastify: PlatformFastifySettings;
+      plugins: PlatformFastifyPluginSettings[];
+    }
+  }
+}

package/src/services/PlatformFastifyRequest.spec.ts

@@ -0,0 +1,54 @@
+import {PlatformTest} from "@tsed/platform-http/testing";
+
+import {PlatformFastifyRequest} from "./PlatformFastifyRequest.js";
+
+function createRequest() {
+  const request = PlatformTest.createRequest();
+  const ctx = PlatformTest.createRequestContext({
+    event: {
+      request
+    },
+    RequestKlass: PlatformFastifyRequest
+  });
+
+  return {req: request, request: ctx.request};
+}
+
+describe("PlatformFastifyRequest", () => {
+  beforeEach(() => PlatformTest.create());
+  afterEach(() => PlatformTest.reset());
+
+  it("should create a PlatformRequest instance", () => {
+    const {req, request} = createRequest();
+
+    expect(request.raw).toEqual(req);
+  });
+
+  describe("secure", () => {
+    it("should get secure info", () => {
+      const {req, request} = createRequest();
+      req.protocol = "https";
+
+      expect(request.secure).toEqual(true);
+    });
+  });
+
+  describe("host()", () => {
+    it("should return the host", () => {
+      const {req, request} = createRequest();
+
+      req.hostname = "host";
+
+      expect(request.host).toEqual("host");
+    });
+  });
+
+  describe("getReq()", () => {
+    it("should return nodejs request", () => {
+      const {req, request} = createRequest();
+      req.raw = {};
+
+      expect(request.getReq()).toEqual({});
+    });
+  });
+});