Merge pull request #83 from moda20/improvement/categorize-configs-with-a-new-route

Author: moda20

src/api/system/config.controller.ts

@@ -5,6 +5,7 @@ import {
   ObjectifyFlattenedProperties,
   updateMultiConfig,
 } from "@config/config.service";
+import { categorizeConfig, transposedConfigMap } from "@utils/convictUtils";
 import { createElysia } from "@utils/createElysia";
 import qs from "qs";
 
@@ -18,7 +19,14 @@ export const configController = createElysia({ prefix: "/system/config" })
   })
   .get("/getConfig", async () => {
     const config = await getConfigWithDBEncryptionStatus();
-    return ObjectifyFlattenedProperties(config);
+    return {
+      configArray: ObjectifyFlattenedProperties(config),
+      categoriesMap: transposedConfigMap,
+    };
+  })
+  .get("/getCategorizedConfig", async () => {
+    const config = await getConfigWithDBEncryptionStatus();
+    return categorizeConfig(ObjectifyFlattenedProperties(config));
   })
   .post(
     "/updateConfig",

src/api/websocket/mainSocket.service.ts

@@ -103,8 +103,8 @@ export default {
     }
   },
   unsubscribeFromTopics(userId: string, topics: string[]) {
-    this.topicsSubscriptions[userId] = this.topicsSubscriptions[userId].filter(
-      (e) => !topics.includes(e),
-    );
+    this.topicsSubscriptions[userId] =
+      this.topicsSubscriptions[userId]?.filter((e) => !topics.includes(e)) ??
+      [];
   },
 };

src/repositories/configs.ts

@@ -1,6 +1,7 @@
 import { basePrisma } from "@initialization/index";
+import { LogEventNames } from "@typesDef/api/jobs";
 import encryptionUtils from "@utils/encryptionUtils";
-
+import logger, { eventLog } from "@utils/loggers";
 export const getAllConfigs = (
   limit?: number,
   offset?: number,
@@ -67,6 +68,14 @@ export const saveConfig = async (
       key: key,
     },
   });
+  if (existingConfig?.is_encrypted !== is_encrypted) {
+    const sysLog = eventLog(LogEventNames.SysLogEvent);
+    const message = `config ${key} has changed encryption status from ${existingConfig?.is_encrypted} to ${is_encrypted}`;
+    sysLog.warn(message, {
+      eventName: "CONFIG_ENCRYPTION_STATUS_CHANGED",
+    });
+    logger.warn(message);
+  }
   const finalValue = is_encrypted
     ? encryptionUtils.encryptWithMasterKey(value)
     : value;
@@ -78,14 +87,15 @@ export const saveConfig = async (
         },
         data: {
           value: finalValue,
+          is_encrypted: is_encrypted ?? existingConfig.is_encrypted,
           appConfigAudit: {
             create: {
               changedBy: {
                 connect: {
                   id: userId,
                 },
               },
-              newValue: value,
+              newValue: finalValue,
               oldValue: existingConfig.value,
             },
           },
@@ -108,7 +118,7 @@ export const saveConfig = async (
                         id: userId,
                       },
                     },
-                    newValue: value,
+                    newValue: finalValue,
                     oldValue: null,
                   },
                 },

src/utils/convictUtils.ts

@@ -136,3 +136,32 @@ export const toSafeString = (input: any) => {
     return input;
   }
 };
+
+// A human-readable map of config categories, might change to the convict schema if possible
+const categoriesMap: any = {
+  system: ["DB", "baseDB", "env", "appName", "server", "jobs", "swaggerServer"],
+  logging: ["files"],
+  notifications: ["notifications", "grafana"],
+};
+
+export const transposedConfigMap = Object.keys(categoriesMap).reduce(
+  (p: any, c: string) => {
+    categoriesMap[c].forEach((e: any) => {
+      p[e] = c;
+    });
+    return p;
+  },
+  {},
+);
+
+export const categorizeConfig = (inputConfigObject: any) => {
+  return Object.keys(inputConfigObject).reduce((p: any, c: string) => {
+    const categoryName = transposedConfigMap[c] ?? "custom";
+    if (p[categoryName]) {
+      p[categoryName][c] = inputConfigObject[c];
+    } else {
+      p[categoryName] = { [c]: inputConfigObject[c] };
+    }
+    return p;
+  }, {});
+};