fix for logger after cfEnv changes

Author: rlindner81

src/logger.js

@@ -2,7 +2,7 @@
 const util = require("util");
 const VError = require("verror");
 
-const { cfEnv, isOnCF } = require("./env");
+const { cfEnv } = require("./env");
 const { tryRequire } = require("./shared/static");
 const cds = tryRequire("@sap/cds");
 
@@ -72,7 +72,7 @@ const MILLIS_IN_NANOS_NUMBER = 1000000;
 const MILLIS_IN_NANOS_BIGINT = BigInt(MILLIS_IN_NANOS_NUMBER);
 
 const cfApp = cfEnv.cfApp;
-const cfAppData = isOnCF
+const cfAppData = cfEnv.isOnCf
   ? {
       [FIELD.COMPONENT_TYPE]: "application",
       [FIELD.COMPONENT_NAME]: cfApp.application_name,
@@ -93,7 +93,7 @@ class Logger {
       type = "log",
       maxLevel = LEVEL.INFO,
       customData,
-      format = isOnCF ? FORMAT.JSON : FORMAT.TEXT,
+      format = cfEnv.isOnCf ? FORMAT.JSON : FORMAT.TEXT,
       inspectOptions = { colors: false },
     } = {}
   ) {

test/logger.test.js

@@ -5,9 +5,12 @@ const featureTogglesModule = require("../src/featureToggles");
 const { FeatureToggles } = featureTogglesModule;
 const { FORMAT, Logger } = require("../src/logger");
 
-const redisWrapper = require("../src/redisWrapper");
+const redisWrapperMock = require("../src/redisWrapper");
 jest.mock("../src/redisWrapper", () => require("./__mocks__/redisWrapper"));
 
+const envMock = require("../src/env");
+jest.mock("../src/env", () => require("./__mocks__/env"));
+
 const { FEATURE, mockConfig, redisKey, redisChannel, refreshMessage } = require("./mockdata");
 
 let featureToggles = null;
@@ -18,10 +21,14 @@ const processStreamSpy = {
 };
 
 const cleanupTextLogCalls = (args) =>
-  args.map((arg) =>
-    typeof arg !== "string"
-      ? arg
-      : arg.replace(/\d\d:\d\d:\d\d.\d\d\d/g, "88:88:88.888").replace(/(?<=\n)\s+at.*?\n/g, "")
+  args.map(
+    (arg) =>
+      typeof arg !== "string"
+        ? arg
+        : arg
+            .replace(/\d\d:\d\d:\d\d.\d\d\d/g, "88:88:88.888") // timestamps
+            .replace(/\n$/g, "") // final newline
+            .replace(/(?<=\n)\s+at.*?\n/g, "") // stacktrace
   );
 
 const cleanupJsonLogCalls = (args) =>
@@ -50,7 +57,8 @@ let layer = "/test";
 
 describe("logger test", () => {
   beforeEach(() => {
-    redisWrapper._reset();
+    redisWrapperMock._reset();
+    envMock._reset();
     featureToggles = new FeatureToggles({ redisKey, redisChannel, refreshMessage });
   });
 
@@ -72,12 +80,10 @@ describe("logger test", () => {
     "88:88:88.888 | WARN | /test | FeatureTogglesError: found invalid fallback values during initialization
 {
   validationErrors: '[{"featureKey":"test/feature_b","errorMessage":"registered validator \\\\"{0}\\\\" failed for value \\\\"{1}\\\\" with error {2}","errorMessageValues":["mockConstructor",1,"bad validator"]}]'
-}
-",
+}",
   ],
   [
-    "88:88:88.888 | INFO | /test | finished initialization with 9 feature toggles with CF_REDIS
-",
+    "88:88:88.888 | INFO | /test | finished initialization with 9 feature toggles with CF_REDIS",
   ],
 ]
 `);
@@ -90,8 +96,7 @@ caused by: Error: bad validator
   validator: 'mockConstructor',
   featureKey: 'test/feature_b',
   value: 1
-}
-",
+}",
   ],
 ]
 `);
@@ -136,8 +141,7 @@ caused by: Error: bad validator
       logger.info("some info");
       expect(processStreamSpy.stdout.mock.calls.map(cleanupTextLogCalls)[0]).toMatchInlineSnapshot(`
 [
-  "88:88:88.888 | INFO | some info
-",
+  "88:88:88.888 | INFO | some info",
 ]
 `);
       expect(processStreamSpy.stdout.mock.calls.length).toBe(1);
@@ -159,8 +163,19 @@ caused by: Error: bad validator
       logger.info("some info");
       expect(processStreamSpy.stdout.mock.calls.map(cleanupTextLogCalls)[0]).toMatchInlineSnapshot(`
 [
-  "88:88:88.888 | INFO | /test | some info
-",
+  "88:88:88.888 | INFO | /test | some info",
+]
+`);
+      expect(processStreamSpy.stdout.mock.calls.length).toBe(1);
+    });
+
+    it("info on cf defaults to json format", async () => {
+      envMock.cfEnv.isOnCf = true;
+      logger = new Logger(layer);
+      logger.info("some info");
+      expect(processStreamSpy.stdout.mock.calls.map(cleanupJsonLogCalls)[0]).toMatchInlineSnapshot(`
+[
+  "{"level":"info","msg":"some info","type":"log","layer":"/test"}",
 ]
 `);
       expect(processStreamSpy.stdout.mock.calls.length).toBe(1);