@k8slens/logger

Signed-off-by: Gabriel <gaccettola@mirantis.com>

packages/logger/README.md

@@ -0,0 +1,19 @@
+# @k8slens/logger
+
+This package contains stuff related to creating Lens-applications. 
+
+# Usage
+
+```bash
+$ npm install @k8slens/logger
+```
+
+```typescript
+import { loggerFeature } from "@k8slens/logger";
+import type { Logger } from "@k8slens/logger";
+import { loggerInjectable } from "@k8slens/logger";
+import { winstonLoggerInjectable } from "@k8slens/logger";
+import { prefixedLoggerInjectable } from "@k8slens/logger";
+```
+
+## Extendability

packages/logger/index.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+export type { Logger } from "./src/logger";
+export { loggerInjectable } from "./src/logger.injectable";
+export { prefixedLoggerInjectable } from "./src/prefixed-logger.injectable";
+export { loggerTransportInjectionToken } from "./src/transports";
+export { winstonLoggerInjectable } from "./src/winston-logger.injectable";
+export { loggerFeature } from "./src/feature";

packages/logger/jest.config.js

@@ -0,0 +1,4 @@
+const { configForReact } =
+  require("@k8slens/jest").monorepoPackageConfig(__dirname);
+
+module.exports = configForReact;

packages/logger/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@k8slens/logger",
+  "private": false,
+  "version": "1.0.0-alpha.5",
+  "description": "Highly extendable logger in the Lens.",
+  "type": "commonjs",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lensapp/lens.git"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": {
+    "name": "OpenLens Authors",
+    "email": "info@k8slens.dev"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/lensapp/lens",
+  "scripts": {
+    "build": "webpack",
+    "lint": "lens-lint",
+    "lint:fix": "lens-lint --fix"
+  },
+  "peerDependencies": {
+    "@k8slens/feature-core": "^6.5.0-alpha.0",
+    "@k8slens/react-application": "^1.0.0-alpha.0",
+    "@ogre-tools/fp": "^15.3.1",
+    "@ogre-tools/injectable": "^15.3.1",
+    "@ogre-tools/injectable-extension-for-auto-registration": "^15.3.0",
+    "@ogre-tools/injectable-react": "^15.3.0",
+    "auto-bind": "^4.0.0",
+    "lodash": "^4.17.21",
+    "mobx": "^6.8.0",
+    "mobx-react": "^7.6.0",
+    "react": "^17",
+    "react-dom": "^17.0.2",
+    "winston": "^3.8.2"
+  },
+  "devDependencies": {
+    "@async-fn/jest": "^1.6.4",
+    "@k8slens/eslint-config": "6.5.0-alpha.1",
+    "@k8slens/react-testing-library-discovery": "^1.0.0-alpha.3",
+    "@testing-library/react": "^12.1.5",
+    "@testing-library/user-event": "^13.5.0"
+  }
+}

packages/logger/src/feature.ts

@@ -0,0 +1,17 @@
+import { getFeature } from "@k8slens/feature-core";
+import { autoRegister } from "@ogre-tools/injectable-extension-for-auto-registration";
+
+export const loggerFeature = getFeature({
+  id: "logger-feature",
+
+  register: (di) => {
+    autoRegister({
+      di,
+      targetModule: module,
+      getRequireContexts: () => [
+        require.context("./", true, /\.injectable\.(ts|tsx)$/),
+      ],
+    });
+  },
+
+});

packages/logger/src/logger.injectable.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 type { Logger } from "./logger";
+import { winstonLoggerInjectable } from "./winston-logger.injectable";
+
+export const loggerInjectable = getInjectable({
+  id: "logger",
+  instantiate: (di): Logger => {
+    const baseLogger = di.inject(winstonLoggerInjectable);
+
+    return {
+      debug: (message, ...data) => baseLogger.debug(message, ...data),
+      info: (message, ...data) => baseLogger.info(message, ...data),
+      warn: (message, ...data) => baseLogger.warn(message, ...data),
+      error: (message, ...data) => baseLogger.error(message, ...data),
+      silly: (message, ...data) => baseLogger.silly(message, ...data),
+    };
+  },
+
+  decorable: false,
+});

packages/logger/src/logger.ts

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+
+export interface Logger {
+  info: (message: string, ...args: any) => void;
+  error: (message: string, ...args: any) => void;
+  debug: (message: string, ...args: any) => void;
+  warn: (message: string, ...args: any) => void;
+  silly: (message: string, ...args: any) => void;
+}

packages/logger/src/prefixed-logger.injectable.ts

@@ -0,0 +1,35 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable";
+import type { Logger } from "./logger";
+import { loggerInjectable } from "./logger.injectable";
+
+export const prefixedLoggerInjectable = getInjectable({
+  id: "prefixed-logger",
+  instantiate: (di, prefix): Logger => {
+    const logger = di.inject(loggerInjectable);
+
+    return {
+      debug: (message, ...args) => {
+        logger.debug(`[${prefix}]: ${message}`, ...args);
+      },
+      error: (message, ...args) => {
+        logger.error(`[${prefix}]: ${message}`, ...args);
+      },
+      info: (message, ...args) => {
+        logger.info(`[${prefix}]: ${message}`, ...args);
+      },
+      silly: (message, ...args) => {
+        logger.silly(`[${prefix}]: ${message}`, ...args);
+      },
+      warn: (message, ...args) => {
+        logger.warn(`[${prefix}]: ${message}`, ...args);
+      },
+    };
+  },
+  lifecycle: lifecycleEnum.keyedSingleton({
+    getInstanceKey: (di, prefix: string) => prefix,
+  }),
+});

packages/logger/src/transports.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",
+});

packages/logger/src/winston-logger.injectable.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 { createLogger, format } from "winston";
+import { loggerTransportInjectionToken } from "./transports";
+
+export const winstonLoggerInjectable = getInjectable({
+  id: "winston-logger",
+  instantiate: (di) =>
+    createLogger({
+      format: format.combine(format.splat(), format.simple()),
+      transports: di.injectMany(loggerTransportInjectionToken),
+    }),
+});

packages/logger/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "@k8slens/typescript/config/base.json",
+  "include": ["**/*.ts", "**/*.tsx"],
+}

packages/logger/webpack.config.js

@@ -0,0 +1 @@
+module.exports = require("@k8slens/webpack").configForReact;