refactor(webui): Migrate S3Manager to new Fastify architecture. (#1098)

Author: davemarco

components/webui/server/src/app.ts

@@ -3,8 +3,6 @@ import {
     FastifyPluginAsync,
 } from "fastify";
 
-import settings from "../settings.json" with {type: "json"};
-import S3Manager from "./plugins/S3Manager.js";
 import staticRoutes from "./routes/static.js";
 
 
@@ -20,16 +18,6 @@ import staticRoutes from "./routes/static.js";
 const FastifyV1App: FastifyPluginAsync = async (
     fastify: FastifyInstance
 ) => {
-    if ("test" !== process.env.NODE_ENV) {
-        await fastify.register(
-            S3Manager,
-            {
-                region: settings.StreamFilesS3Region,
-                profile: settings.StreamFilesS3Profile,
-            }
-        );
-    }
-
     // Register the routes
     await fastify.register(staticRoutes);
 };

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

@@ -3,16 +3,13 @@ import {
     S3Client,
 } from "@aws-sdk/client-s3";
 import {getSignedUrl} from "@aws-sdk/s3-request-presigner";
-import fastifyPlugin from "fastify-plugin";
+import fp from "fastify-plugin";
 
-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";
 
 
-/**
- * Expiry time in seconds for pre-signed URLs.
- */
-const PRE_SIGNED_URL_EXPIRY_TIME_SECONDS = 3600;
-
 /**
  * Class to manage Simple Storage Service (S3) objects.
  */
@@ -61,24 +58,27 @@ class S3Manager {
     }
 }
 
-/**
- * Initializes a Fastify plugin, which decorates the application with an S3 manager at the
- * "s3Manager" property only when all plugin options are valid.
- */
-export default fastifyPlugin(
-    async (app, options: {region: Nullable<string>; profile: Nullable<string>}) => {
-        const {region, profile} = options;
-        if (null === region) {
-            return;
-        }
-
-        console.log(`Initializing S3Manager with region="${region}" and profile="${profile}"...`);
-        app.decorate("s3Manager", new S3Manager(region, profile));
-    }
-);
-
 declare module "fastify" {
     interface FastifyInstance {
-        s3Manager?: S3Manager;
+        S3Manager?: S3Manager;
     }
 }
+
+export default fp(
+    (fastify) => {
+        const region = settings.StreamFilesS3Region;
+        const profile = settings.StreamFilesS3Profile;
+
+        // Only decorate if the region is set (i.e. s3 support is configured in package)
+        // Disable no-unnecessary-condition since linter doesn't understand that settings
+        // values are not hardcoded.
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+        if (null !== region && "" !== region) {
+            fastify.log.info(
+                {region, profile},
+                "Initializing S3Manager"
+            );
+            fastify.decorate("S3Manager", new S3Manager(region, profile));
+        }
+    },
+);

components/webui/server/src/fastify-v2/plugins/app/S3Manager/typings.ts

@@ -0,0 +1,4 @@
+/**
+ * Expiry time in seconds for pre-signed URLs.
+ */
+export const PRE_SIGNED_URL_EXPIRY_TIME_SECONDS = 3600;

components/webui/server/src/fastify-v2/routes/api/stream-files/index.ts

@@ -69,8 +69,8 @@ const plugin: FastifyPluginAsyncTypebox = async (fastify) => {
                 }
             }
 
-            if (fastify.hasDecorator("s3Manager") && "undefined" !== typeof fastify.s3Manager) {
-                streamMetadata.path = await fastify.s3Manager.getPreSignedUrl(
+            if (fastify.hasDecorator("S3Manager") && "undefined" !== typeof fastify.S3Manager) {
+                streamMetadata.path = await fastify.S3Manager.getPreSignedUrl(
                     `s3://${settings.StreamFilesS3PathPrefix}${streamMetadata.path}`
                 );
             } else {