Fb/new logger (#20)

* add grueni-logger as reference

* some logger level changes

* start logger v2

* more loggering

* bla bla progress

* bla bla progress 2

* bla bla progress 3

* bla bla progress 4

* bla bla proud of our progress 5

* bla bla proud of our progress 6

* bla bla proud of our progress 7

* bla bla proud of our progress 8

* bla bla proud of our progress 9

* bla bla proud of our progress 10

* bla bla proud of our progress 11

* slightly better handling of non-cf case

* update snapshots

* some more work on request logger

* child approach

* cds stuff

* update tests

* switch to loggerV2

* remove dependency

* more changes to incorporate new Logger

* fix cds context reading bugs

* add level_name enum and logging for subdomain if present

* test fixes

* new todos and consolidate logger

* progress 1

* lots of changes after discussions with max and make _ts nanos

* tests and logger api changes

* add instance id field

* help intellisense autocomplete

* readable => format

* lil cleanup pass

* readable level should be uppercase

* update snapshots where readable levels are uppercase

* fix component instance approach

* keep it in the js number range

* convert instance index to an integer

* explain hrtime trick

* wording

* more proofreading

* only log error info if it has content

* remove unneeded mocking

* remove main TODO for this PR

* better mocking for cfEnv

* move up tryRequire to other requires

Author: rlindner81

jest.config.js

@@ -1,6 +1,8 @@
 "use strict";
 
 module.exports = {
+  prettierPath: null,
+
   // A list of paths to modules that run some code to configure or set up the testing framework before each test
   setupFilesAfterEnv: ["./jest.setupAfterEnv.js"],
 };

package-lock.json

@@ -23,7 +23,6 @@
     "npm": ">=8.19.0"
   },
   "dependencies": {
-    "cf-nodejs-logging-support": "^7.1.0",
     "redis": "^4.6.7",
     "verror": "^1.10.1",
     "yaml": "^2.3.1"

package.json

@@ -1,44 +1,25 @@
 "use strict";
 
-const VError = require("verror");
-
-const { Logger } = require("./logger");
 const { ENV } = require("./shared/static");
 
-const COMPONENT_NAME = "/Env";
-const VERROR_CLUSTER_NAME = "Env";
-
-const isLocal = process.env[ENV.USER] !== "vcap";
-const isOnCF = !isLocal;
-
-const logger = new Logger(COMPONENT_NAME, isOnCF);
+const isOnCF = process.env[ENV.USER] === "vcap";
 
 class CfEnv {
   static parseEnvVar(env, envVar) {
     try {
       if (Object.prototype.hasOwnProperty.call(env, envVar)) {
         return JSON.parse(process.env[envVar]);
       }
-    } catch (err) {
-      logger.error(
-        new VError(
-          {
-            name: VERROR_CLUSTER_NAME,
-            cause: err,
-            info: {
-              envVar,
-            },
-          },
-          "environment variable is not valid JSON"
-        )
-      );
-    }
+    } catch (err) {} // eslint-disable-line no-empty
   }
 
   constructor(env = process.env) {
-    this.__cfApp = CfEnv.parseEnvVar(env, ENV.CF_APP) || {};
-    this.__cfServices = CfEnv.parseEnvVar(env, ENV.CF_SERVICES) || {};
-    this.__cfServiceList = [].concat(...Object.values(this.__cfServices));
+    this.cfApp = CfEnv.parseEnvVar(env, ENV.CF_APP) || {};
+    this.cfServices = CfEnv.parseEnvVar(env, ENV.CF_SERVICES) || {};
+    this.cfInstanceGuid = env[ENV.CF_INSTANCE_GUID];
+    this.cfInstanceIp = env[ENV.CF_INSTANCE_IP];
+    this.cfInstanceIndex = env[ENV.CF_INSTANCE_INDEX] ? parseInt(env[ENV.CF_INSTANCE_INDEX]) : undefined;
+    this.__cfServiceList = [].concat(...Object.values(this.cfServices));
     this.__cfServiceLabelMap = this.__cfServiceList.reduce((result, service) => {
       if (service.label && !result[service.label]) {
         result[service.label] = service;
@@ -47,21 +28,16 @@ class CfEnv {
     }, {});
   }
 
+  /**
+   * @return CfEnv
+   */
   static getInstance() {
     if (!CfEnv.__instance) {
       CfEnv.__instance = new CfEnv();
     }
     return CfEnv.__instance;
   }
 
-  cfApp() {
-    return this.__cfApp;
-  }
-
-  cfServices() {
-    return this.__cfServices;
-  }
-
   cfServiceCredentials(options) {
     const service = this.__cfServiceList.find((service) =>
       Object.entries(options).reduce((result, [key, value]) => result && service[key] === value, true)
@@ -76,7 +52,8 @@ class CfEnv {
 }
 
 module.exports = {
-  isLocal,
+  CfEnv,
+
   isOnCF,
   cfEnv: CfEnv.getInstance(),
 };

src/env.js

@@ -14,8 +14,6 @@
 // TODO locale for validation messages
 // TODO investigate how to turn library into a cds plugin similar to https://github.com/cap-js-community/event-queue
 //      this would incorporate a ready-made feature-service interface copied from example-cap-server
-// TODO remove dependency on cf-nodejs-logging-support. the way request level information are handled in there is
-//      not good. either we build our own logging, or hook into cds.log and make cds a full dependency...
 
 const { promisify } = require("util");
 const path = require("path");
@@ -97,7 +95,7 @@ const SCOPE_PREFERENCE_ORDER_MASKS = [
 ];
 
 const readFileAsync = promisify(readFile);
-let logger = new Logger(COMPONENT_NAME, isOnCF);
+let logger = new Logger(COMPONENT_NAME);
 
 const readConfigFromFile = async (configFilepath = DEFAULT_CONFIG_FILEPATH) => {
   const fileData = await readFileAsync(configFilepath);
@@ -125,7 +123,7 @@ class FeatureToggles {
    * Populate this.__config.
    */
   _processConfig(config) {
-    const { uris: cfAppUris } = cfEnv.cfApp();
+    const { uris: cfAppUris } = cfEnv.cfApp;
 
     const configEntries = Object.entries(config);
     for (const [featureKey, { type, active, appUrl, validation, fallbackValue, allowedScopes }] of configEntries) {
@@ -221,7 +219,7 @@ class FeatureToggles {
     }
     let cfApp;
     try {
-      cfApp = cfEnv.cfApp();
+      cfApp = cfEnv.cfApp;
       if (cfApp.application_name) {
         return cfApp.application_name;
       }