feat: split plugins and routes

Author: tianheg

.gitignore

@@ -1,3 +1,4 @@
+pnpm-lock.yaml
 bun.lockb
 
 # Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore

api/index.js

@@ -1,6 +1,6 @@
 import app from "../app.js";
 
-export default async (req, res) => {
+export default async (request, reply) => {
   await app.ready();
-  app.server.emit("request", req, res);
+  app.server.emit("request", request, reply);
 };

app.js

@@ -1,47 +1,28 @@
-import compress from "@fastify/compress";
-import cors from "@fastify/cors";
-import formbody from "@fastify/formbody";
-import helmet from "@fastify/helmet";
-import jwt from "@fastify/jwt";
-import postgres from "@fastify/postgres";
-import rateLimit from "@fastify/rate-limit";
-import swagger from "@fastify/swagger";
-import swaggerUI from "@fastify/swagger-ui";
 import Fastify from "fastify";
+import Autoload from "@fastify/autoload";
 import pino from "pino";
 import pretty from "pino-pretty";
+import { dirname,join } from "node:path";
+import { fileURLToPath } from "node:url";
+import registerRoutes from "./routes/routes.js";
+import registerBooksRoutes from "./routes/booksRoutes.js";
 
 import * as dotenv from "dotenv";
 dotenv.config();
 
-import registerRoutes from "./routes/routes.js";
 
 // logger
 const stream = pretty({
   translateTime: "SYS:HH:MM:ss Z",
   messageFormat: "{msg} {req.method} {req.url}",
   include: "time,pid,level",
   hideObject: true,
-  colorize: false, // enable this will make Vercel log get:
-  // [15:32:27 UTC] INFO (10): incoming request GET /
-  //[15:32:27 UTC] INFO (10): request completed  
+  colorize: false,
 });
 const loggerInstance = pino({ level: "info" }, stream);
 
 const app = Fastify({ loggerInstance });
 
-/// plugins
-await app.register(compress, { encodings: ["gzip"] });
-
-// security
-// not using RegExp or a function for origin
-// avoid DoS attacks https://github.com/fastify/fastify-cors#warning-dos-attacks
-await app.register(cors);
-await app.register(formbody);
-await app.register(helmet);
-await app.register(jwt, {
-  secret: process.env.JWT_SECRET,
-})
 app.decorate("authenticate", async (request, reply) => {
   try {
     await request.jwtVerify();
@@ -50,50 +31,23 @@ app.decorate("authenticate", async (request, reply) => {
   }
 });
 
-await app.register(rateLimit, {
-  max: 100,
-  timeWindow: "1 minute",
-});
-await app.register(swagger, {
-  openapi: {
-    info: {
-      title: "tianheg's API",
-      description: "Recording things in my life",
-      version: "1.0.0",
-    },
-    // components: {
-    //   securitySchemes: {
-    //     bearerAuth: {
-    //       type: 'http',
-    //       scheme: 'bearer',
-    //       bearerFormat: 'JWT',
-    //     },
-    //   },
-    // },
-  },
-});
-await app.register(swaggerUI, {
-  routePrefix: "/doc",
-  uiConfig: {
-    docExpansion: "list",
-    deepLinking: false,
-  },
-});
-
-// database
-await app.register(postgres, {
-  connectionString: process.env.POSTGRES_URL,
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+await app.register(Autoload, {
+  dir: join(__dirname, "plugins"),
+  dirNameRoutePrefix: false,
+  ignorePattern: /.*.no-load\.js/,
+  indexPattern: /^no$/i,
 });
 
-/// routes
+// routes
 await registerRoutes(app);
 
+// books routes
+await registerBooksRoutes(app);
+
+// start server
 if (process.env.NODE_ENV === "development") {
-  /**
-   * A function that asynchronously starts the application listening on port 3000.
-   *
-   * @return {Promise} A promise that resolves when the application starts listening successfully.
-   */
   const start = async () => {
     try {
       await app.listen({ port: 3000 });

package.json

@@ -23,6 +23,7 @@
     "@fastify/swagger-ui": "^5.0.1",
     "@fastify/under-pressure": "^9.0.1",
     "fastify": "^5.0.0",
+    "fastify-plugin": "^5.0.1",
     "pg": "^8.13.0"
   },
   "scripts": {

plugins/compress.js

@@ -0,0 +1,6 @@
+import fp from "fastify-plugin";
+import compress from "@fastify/compress";
+
+export default fp(async (app, opts) => {
+  await app.register(compress, { encodings: ["gzip"] });
+});

plugins/cors.js

@@ -0,0 +1,9 @@
+import fp from "fastify-plugin";
+import cors from "@fastify/cors";
+
+// not using RegExp or a function for origin
+// avoid DoS attacks https://github.com/fastify/fastify-cors#warning-dos-attacks
+
+export default fp(async (app, opts) => {
+  await app.register(cors);
+});

plugins/database.js

@@ -0,0 +1,12 @@
+import fp from "fastify-plugin";
+import pg from "@fastify/postgres";
+
+import { config } from "dotenv";
+
+config();
+
+export default fp(async (app, opts) => {
+  await app.register(pg, {
+    connectionString: process.env.POSTGRES_URL,
+  });
+})

plugins/formbody.js

@@ -0,0 +1,6 @@
+import fp from "fastify-plugin";
+import formbody from "@fastify/formbody";
+
+export default fp(async (app, opts) => {
+  await app.register(formbody);
+});

plugins/helmet.js

@@ -0,0 +1,6 @@
+import fp from "fastify-plugin";
+import helmet from "@fastify/helmet";
+
+export default fp(async (app, opts) => {
+  await app.register(helmet);
+});

plugins/jwt.js

@@ -0,0 +1,8 @@
+import fp from "fastify-plugin";
+import jwt from "@fastify/jwt";
+
+export default fp(async (app, opts) => {
+  await app.register(jwt, {
+    secret: process.env.JWT_SECRET,
+  });
+});