Add winston formatting support for error causes (#6576)

* Add winston formatting support for error causes

Signed-off-by: Sebastian Malton <[email protected]>

* Fix failing to run built version

- Finally make logger fully injectable
- Simplify startMainApplication to only have runMany(Sync) invocations
  to fix time of use bugs related to logger

Signed-off-by: Sebastian Malton <[email protected]>

* Remove legacy type enforced ipc to fix tests

Signed-off-by: Sebastian Malton <[email protected]>

* Fix type error

Signed-off-by: Sebastian Malton <[email protected]>

Signed-off-by: Sebastian Malton <[email protected]>

Author: Nokel81

package.json

@@ -290,7 +290,6 @@
     "uuid": "^8.3.2",
     "win-ca": "^3.5.0",
     "winston": "^3.8.2",
-    "winston-console-format": "^1.0.8",
     "winston-transport-browserconsole": "^1.0.5",
     "ws": "^8.11.0",
     "xterm-link-provider": "^1.3.1"
@@ -366,6 +365,7 @@
     "@typescript-eslint/parser": "^5.43.0",
     "adr": "^1.4.3",
     "ansi_up": "^5.1.0",
+    "chalk": "^4.1.2",
     "chart.js": "^2.9.4",
     "circular-dependency-plugin": "^5.2.2",
     "cli-progress": "^3.11.2",

src/common/app-paths/directory-for-logs.injectable.ts

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { getInjectable } from "@ogre-tools/injectable";
+import appPathsInjectable from "./app-paths.injectable";
+
+const directoryForLogsInjectable = getInjectable({
+  id: "directory-for-logs",
+  instantiate: (di) => di.inject(appPathsInjectable).logs,
+});
+
+export default directoryForLogsInjectable;

src/common/ipc/__tests__/type-enforced-ipc.test.ts

@@ -5,4 +5,3 @@
 
 export * from "./ipc";
 export * from "./invalid-kubeconfig";
-export * from "./type-enforced-ipc";

src/common/ipc/index.ts

@@ -3,12 +3,19 @@
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
 import { getInjectable } from "@ogre-tools/injectable";
+import { createLogger, format } from "winston";
 import type { Logger } from "./logger";
-import logger from "./logger";
+import { loggerTransportInjectionToken } from "./logger/transports";
 
 const loggerInjectable = getInjectable({
   id: "logger",
-  instantiate: (): Logger => logger,
+  instantiate: (di): Logger => createLogger({
+    format: format.combine(
+      format.splat(),
+      format.simple(),
+    ),
+    transports: di.injectMany(loggerTransportInjectionToken),
+  }),
 });
 
 export default loggerInjectable;

src/common/ipc/type-enforced-ipc.ts

@@ -3,12 +3,8 @@
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
 
-import { app, ipcMain } from "electron";
-import winston, { format } from "winston";
-import type Transport from "winston-transport";
-import { consoleFormat } from "winston-console-format";
-import { isDebugging, isTestEnv } from "./vars";
-import BrowserConsole from "winston-transport-browserconsole";
+import { asLegacyGlobalForExtensionApi } from "../extensions/as-legacy-globals-for-extension-api/as-legacy-global-object-for-extension-api";
+import loggerInjectable from "./logger.injectable";
 
 export interface Logger {
   info: (message: string, ...args: any) => void;
@@ -18,64 +14,7 @@ export interface Logger {
   silly: (message: string, ...args: any) => void;
 }
 
-const logLevel = process.env.LOG_LEVEL
-  ? process.env.LOG_LEVEL
-  : isDebugging
-    ? "debug"
-    : isTestEnv
-      ? "error"
-      : "info";
-
-const transports: Transport[] = [];
-
-if (ipcMain) {
-  transports.push(
-    new winston.transports.Console({
-      handleExceptions: false,
-      level: logLevel,
-      format: format.combine(
-        format.colorize({ level: true, message: false }),
-        format.padLevels(),
-        format.ms(),
-        consoleFormat({
-          showMeta: true,
-          inspectOptions: {
-            depth: 4,
-            colors: true,
-            maxArrayLength: 10,
-            breakLength: 120,
-            compact: Infinity,
-          },
-        }),
-      ),
-    }),
-  );
-
-  if (!isTestEnv) {
-    transports.push(
-      new winston.transports.File({
-        handleExceptions: false,
-        level: "debug",
-        filename: "lens.log",
-        /**
-         * SAFTEY: the `ipcMain` check above should mean that this is only
-         * called in the main process
-         */
-        dirname: app.getPath("logs"),
-        maxsize: 1024 * 1024,
-        maxFiles: 16,
-        tailable: true,
-      }),
-    );
-  }
-} else {
-  transports.push(new BrowserConsole());
-}
-
-export default winston.createLogger({
-  format: format.combine(
-    format.splat(),
-    format.simple(),
-  ),
-  transports,
-}) as Logger;
+/**
+ * @deprecated use `di.inject(loggerInjectable)` instead
+ */
+export default asLegacyGlobalForExtensionApi(loggerInjectable);

src/common/logger.injectable.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import { getInjectionToken } from "@ogre-tools/injectable";
+import type TransportStream from "winston-transport";
+
+export const loggerTransportInjectionToken = getInjectionToken<TransportStream>({
+  id: "logger-transport",
+});