[DEV-IMP] Add error logging and hide sensitive configs from individual jobs

src/config/config.service.ts

@@ -68,9 +68,11 @@ const verifyMasterKey = () => {
 export const getConvictSchemaProperties = ({
   encryptedValues = true,
   onlyMirroredValues = true,
+  withJobHiddenProperties = true,
 }: {
   encryptedValues?: boolean;
   onlyMirroredValues?: boolean;
+  withJobHiddenProperties?: boolean;
 } = {}) => {
   const propertiesValues: FlattenedProperties = flattenedProperties(
     config.getProperties(),
@@ -105,6 +107,13 @@ export const getConvictSchemaProperties = ({
     if (onlyMirroredValues && !propertiesValues[pvk].db_mirror) {
       delete propertiesValues[pvk];
     }
+    if (
+      !withJobHiddenProperties &&
+      propertiesValues[pvk] &&
+      propertiesValues[pvk].job_hidden
+    ) {
+      delete propertiesValues[pvk];
+    }
   });
 
   return propertiesValues;

src/config/config.ts

@@ -320,6 +320,7 @@ const config = convict({
       env: "MASTER_ENCRYPTION_KEY",
       sensitive: true,
       db_mirror: false,
+      job_hidden: true,
     },
   },
   version: {

src/initialization/jobsManager.ts

@@ -58,6 +58,13 @@ export const fullStartAJob = async (job: JobDTO) => {
   } else {
     logger.error("Error when starting Job");
     logger.error(d);
+    const sysLog = eventLog(LogEventNames.SysLogEvent);
+    sysLog.error(
+      `Error when starting job ${job.getName()} ${JSON.stringify(d, null, 4)}`,
+      {
+        eventName: "JOB_START_ERROR",
+      },
+    );
     throw d;
   }
 };

src/jobConsumer/jobConsumer.ts

@@ -1,4 +1,8 @@
 import config from "@config/config";
+import {
+  getConvictSchemaProperties,
+  ObjectifyFlattenedProperties,
+} from "@config/config.service";
 import { handleEvent } from "@repositories/notification";
 import {
   getAllGlobalEventHandlers,
@@ -240,7 +244,12 @@ export class JobConsumer extends Consumer {
     try {
       this.options = {
         utils: jobConsumerUtils,
-        config: config.getProperties(),
+        config: ObjectifyFlattenedProperties(
+          getConvictSchemaProperties({
+            encryptedValues: false,
+            withJobHiddenProperties: false,
+          }),
+        ),
       };
       await this.injectNotificationServices(
         job?.param?.notificationServices || [],

src/types/models/config.ts

@@ -3,6 +3,7 @@ export interface FlattenedProperties {
     value: any;
     is_encrypted?: boolean;
     db_mirror?: boolean;
+    job_hidden?: boolean;
     doc?: string;
     default?: string;
     format?: string;

src/utils/convictUtils.ts

@@ -139,7 +139,16 @@ export const toSafeString = (input: any) => {
 
 // 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"],
+  system: [
+    "DB",
+    "baseDB",
+    "env",
+    "appName",
+    "server",
+    "jobs",
+    "swaggerServer",
+    "proxies",
+  ],
   logging: ["files"],
   notifications: ["notifications", "grafana"],
 };