refactor(webui): Complete migration to new Fastify Architecture by removing log-viewer-webui Fastify app. (#1106)

Author: davemarco

components/webui/server/package.json

@@ -6,13 +6,13 @@
   "scripts": {
     "build": "tsc",
     "build:watch": "npm run build -- -w",
-    "dev:start": "fastify start --ignore-watch=.ts$ -w -l info -P dist/server/src/fastify-v2/app.js",
+    "dev:start": "fastify start --ignore-watch=.ts$ -w -l info -P dist/server/src/app.js",
     "dev": "npm run build && concurrently -k -p \"[{name}]\" -n \"TypeScript,App\" -c \"yellow.bold,cyan.bold\" \"npm:build:watch\" \"npm:dev:start\"",
-    "start": "npm run build && fastify start -l info dist/server/src/fastify-v2/app.js",
+    "start": "npm run build && fastify start -l info dist/server/src/app.js",
     "standalone": "npm run build && node --env-file=.env dist/server/src/main.js",
     "lint:check": "eslint . --max-warnings 0",
     "lint:fix": "npm run lint:check -- --fix",
-    "test": "NODE_ENV=test tap --include='**/*test.ts'"
+    "test": "tap --include='**/*test.ts'"
   },
   "author": "YScope Inc. <dev@yscope.com>",
   "license": "Apache-2.0",

components/webui/server/src/app.ts

@@ -1,25 +1,106 @@
+// Reference: https://github.com/fastify/demo/blob/main/src/app.ts
+
+import path from "node:path";
+
+import {fastifyAutoload} from "@fastify/autoload";
 import {
     FastifyInstance,
-    FastifyPluginAsync,
+    FastifyPluginOptions,
 } from "fastify";
+import {StatusCodes} from "http-status-codes";
 
-import staticRoutes from "./routes/static.js";
 
+const RATE_LIMIT_MAX_REQUESTS = 3;
+const RATE_LIMIT_TIME_WINDOW_MS = 500;
 
 /**
- * Creates the Fastify app with the given options.
- *
- * TODO: Once old webui code is refactored to new modlular fastify style, this plugin should be
- * removed.
+ * Registers all plugins and routes.
  *
  * @param fastify
- * @return
+ * @param opts
  */
-const FastifyV1App: FastifyPluginAsync = async (
-    fastify: FastifyInstance
-) => {
-    // Register the routes
-    await fastify.register(staticRoutes);
-};
-
-export default FastifyV1App;
+// eslint-disable-next-line max-lines-per-function
+export default async function serviceApp (
+    fastify: FastifyInstance,
+    opts: FastifyPluginOptions
+) {
+    // Option only serves testing purpose. It's used in testing to expose all decorators to the
+    // test app. Some decorators may not be exposed in production.
+    delete opts.skipOverride;
+
+    // Loads all external plugins. Registered first as application plugins might depend on them.
+    await fastify.register(fastifyAutoload, {
+        dir: path.join(import.meta.dirname, "plugins/external"),
+        options: {...opts},
+    });
+
+    // Loads all application plugins.
+    fastify.register(fastifyAutoload, {
+        dir: path.join(import.meta.dirname, "plugins/app"),
+        options: {...opts},
+    });
+
+    // Loads all routes.
+    fastify.register(fastifyAutoload, {
+        autoHooks: true,
+        cascadeHooks: true,
+        dir: path.join(import.meta.dirname, "routes"),
+        options: {...opts},
+    });
+
+    fastify.setErrorHandler((err, request, reply) => {
+        fastify.log.error(
+            {
+                err: err,
+                request: {
+                    method: request.method,
+                    url: request.url,
+                    query: request.query,
+                    params: request.params,
+                },
+            },
+            "Unhandled error occurred"
+        );
+
+        if ("undefined" !== typeof err.statusCode &&
+            Number(StatusCodes.INTERNAL_SERVER_ERROR) > err.statusCode
+        ) {
+            reply.code(err.statusCode);
+
+            return err.message;
+        }
+
+        reply.internalServerError();
+
+        return {
+            message: "Internal Server Error",
+        };
+    });
+
+    // An attacker could search for valid URLs if 404 error handling is not rate limited.
+    fastify.setNotFoundHandler(
+        {
+            preHandler: fastify.rateLimit({
+                max: RATE_LIMIT_MAX_REQUESTS,
+                timeWindow: RATE_LIMIT_TIME_WINDOW_MS,
+            }),
+        },
+        (request, reply) => {
+            request.log.warn(
+                {
+                    request: {
+                        method: request.method,
+                        url: request.url,
+                        query: request.query,
+                        params: request.params,
+                    },
+                },
+                "Resource not found"
+            );
+
+            reply.notFound();
+
+            return {message: "Not Found"};
+        }
+    );
+}

components/webui/server/src/fastify-v2/app.ts

@@ -4,7 +4,7 @@ import closeWithGrace from "close-with-grace";
 import fastify from "fastify";
 import fp from "fastify-plugin";
 
-import serviceApp from "./fastify-v2/app.js";
+import serviceApp from "./app.js";
 
 
 const DEFAULT_FASTIFY_CLOSE_GRACE_DELAY = 500;

components/webui/server/src/main.ts

@@ -6,14 +6,14 @@ import {FastifyInstance} from "fastify";
 import fp from "fastify-plugin";
 import {ResultSetHeader} from "mysql2";
 
-import settings from "../../../../../settings.json" with {type: "json"};
+import settings from "../../../../settings.json" with {type: "json"};
 import {
     QUERY_JOB_STATUS,
     QUERY_JOB_STATUS_WAITING_STATES,
     QUERY_JOB_TYPE,
     QUERY_JOBS_TABLE_COLUMN_NAMES,
     QueryJob,
-} from "../../../../typings/query.js";
+} from "../../../typings/query.js";
 import {JOB_COMPLETION_STATUS_POLL_INTERVAL_MILLIS} from "./typings.js";
 
 

components/webui/server/src/fastify-v2/plugins/app/QueryJobDbManager/index.ts renamed to components/webui/server/src/plugins/app/QueryJobDbManager/index.ts

@@ -5,8 +5,8 @@ import {
 import {getSignedUrl} from "@aws-sdk/s3-request-presigner";
 import fp from "fastify-plugin";
 
-import settings from "../../../../../settings.json" with {type: "json"};
-import {Nullable} from "../../../../typings/common.js";
+import settings from "../../../../settings.json" with {type: "json"};
+import {Nullable} from "../../../typings/common.js";
 import {PRE_SIGNED_URL_EXPIRY_TIME_SECONDS} from "./typings.js";
 
 

components/webui/server/src/fastify-v2/plugins/app/QueryJobDbManager/typings.ts renamed to components/webui/server/src/plugins/app/QueryJobDbManager/typings.ts

@@ -4,13 +4,13 @@ import {
 } from "fastify";
 import fp from "fastify-plugin";
 
-import settings from "../../../../settings.json" with {type: "json"};
-import {Nullable} from "../../../typings/common.js";
-import {QUERY_JOB_TYPE} from "../../../typings/query.js";
+import settings from "../../../settings.json" with {type: "json"};
+import {Nullable} from "../../typings/common.js";
+import {QUERY_JOB_TYPE} from "../../typings/query.js";
 import {
     StreamFileMetadata,
     StreamFilesCollection,
-} from "../../../typings/stream-files.js";
+} from "../../typings/stream-files.js";
 
 
 /**

components/webui/server/src/fastify-v2/plugins/app/S3Manager/index.ts renamed to components/webui/server/src/plugins/app/S3Manager/index.ts

@@ -4,7 +4,7 @@ import type {
     Db,
 } from "mongodb";
 
-import {QueryId} from "../../../../../../../common/index.js";
+import {QueryId} from "../../../../../../common/index.js";
 import {
     CLIENT_UPDATE_TIMEOUT_MILLIS,
     MongoCustomSocket,