@autofleet/logger 4.0.3 → 4.0.5

package/package.json

@@ -1,14 +1,19 @@
 {
   "name": "@autofleet/logger",
-  "version": "4.0.3",
+  "version": "4.0.5",
   "description": "",
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "readme.md"
+  ],
   "scripts": {
     "coverage": "jest --coverage --forceExit --runInBand",
     "test": "jest --runInBand",
     "test-auto": "jest --watch --runInBand",
-    "linter": "./node_modules/.bin/eslint ./src",
-    "build": "tsc",
+    "linter": "eslint ./src",
+    "build": "tsc --project tsconfig.build.json",
     "prepublishOnly": "npm run build",
     "example": "ts-node example.ts"
   },

package/readme.md

@@ -0,0 +1,63 @@
+# Autofleet Node.js Logger
+
+A Winston-like logger for Node.js backend, now using Pino.
+
+## Usage:
+The logger provides a Winston-like API once initialized:
+
+```js
+import Logger from '@autofleet/logger';
+
+const logger = Logger();
+
+logger.info('it is working');
+logger.error('errors displayed in logs/error.log', new Error('test error'));
+logger.debug('debug with object', { a: 5 });
+```
+
+
+# Migration to V4
+
+In V4, we transitioned the underlying logger from Winston to Pino. Since Pino has a different API, we’ve added class methods to maintain a similar API, with two key changes:
+*  **Context Middleware:** Previously, the Zehut package would receive a Winston logger upon initialization to enable automatic tracing in logs. To remove this coupling, we’ve introduced a new method, addContextMiddleware, which allows you to add labels to each log. You can use this method to add the trace ID (see example below).
+* **TypeScript Compatibility:** Due to the migration to TypeScript, the import statement may differ in non-TypeScript files.
+
+
+**Old Logger**
+```js
+const Logger = require('@autofleet/logger');
+
+enableTracing({
+  outbreakOptions: {
+    headersPrefix: 'x-af',
+    winstonLogger: logger,
+  },
+});
+```
+
+**New Logger**
+```javascript
+// Typescript
+import Logger from '@autofleet/logger';
+
+const logger = Logger();
+
+logger.addContextMiddleware(() => ({
+  traceId: zehut.outbreak.getCurrentContext()?.context?.get('x-trace-id'),
+}));
+
+// Plain nodejs
+const { default: Logger } = require('@autofleet/logger');
+
+const logger = Logger();
+
+logger.addContextMiddleware(() => {
+    try {
+        return {
+            traceId: zehut.outbreak.getCurrentContext()?.context?.get('x-trace-id')
+        }
+    } catch(e) {
+        return {}
+    }
+});
+```

package/.jest.config.js

@@ -1,8 +0,0 @@
-module.exports = {
-  testEnvironment: 'node',
-  coverageThreshold: {
-    global: {
-      lines: 80,
-    },
-  },
-};

package/dist/example.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/example.js

@@ -1,14 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const index_1 = __importDefault(require("./index"));
-const logger = (0, index_1.default)('info');
-logger.info('it is working');
-logger.error('errors displayed in logs/error.log', new Error('test error'));
-logger.debug('debug with object', { a: 5 });
-const loggerMiddleware = () => ({ middleware: Math.random() });
-logger.addContextMiddleware(loggerMiddleware);
-logger.info('middleware added', { a: 5 });
-logger.error('middleware added', new Error('test error'));

package/dist/index.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/index.test.js

@@ -1,50 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const index_1 = __importDefault(require("./index"));
-const { env } = process;
-describe('Logger', () => {
-    it('it`s default level is info', () => {
-        env.NODE_ENV = '';
-        const logger = (0, index_1.default)();
-        expect(logger).toBeDefined();
-        expect(logger.level).toBe('debug');
-        logger.info('test');
-    });
-    it('its default develpment level is debug', () => {
-        env.NODE_ENV = 'development';
-        const logger = (0, index_1.default)();
-        expect(logger.level).toBe('debug');
-    });
-    it('its default test level is info', () => {
-        env.NODE_ENV = 'test';
-        const logger = (0, index_1.default)();
-        expect(logger.level).toBe('info');
-    });
-    it('its default production level is info', () => {
-        env.NODE_ENV = 'production';
-        const logger = (0, index_1.default)();
-        expect(logger.level).toBe('info');
-    });
-    it('its level can be override by LOG_LEVEL env variable', () => {
-        env.NODE_ENV = 'development';
-        env.LOG_LEVEL = 'warn';
-        const logger = (0, index_1.default)();
-        expect(logger.level).toBe('warn');
-    });
-    it('its level can be override by function variable', () => {
-        env.NODE_ENV = 'production';
-        env.LOG_LEVEL = 'warn';
-        const logger = (0, index_1.default)('info');
-        expect(logger.level).toBe('info');
-    });
-    it('its has functions for each level', () => {
-        const logger = (0, index_1.default)();
-        expect(typeof logger.error).toBe('function');
-        expect(typeof logger.warn).toBe('function');
-        expect(typeof logger.info).toBe('function');
-        expect(typeof logger.debug).toBe('function');
-    });
-});

package/src/example.ts

@@ -1,13 +0,0 @@
-import Logger from './index';
-
-const logger = Logger('info');
-
-logger.info('it is working');
-logger.error('errors displayed in logs/error.log', new Error('test error'));
-logger.debug('debug with object', { a: 5 });
-
-const loggerMiddleware = () => ({ middleware: Math.random() });
-logger.addContextMiddleware(loggerMiddleware);
-
-logger.info('middleware added', { a: 5 });
-logger.error('middleware added', new Error('test error'));

package/src/index.test.ts

@@ -1,53 +0,0 @@
-import Logger from './index';
-
-const { env } = process;
-
-describe('Logger', () => {
-  it('it`s default level is info', () => {
-    env.NODE_ENV = '';
-    const logger = Logger();
-    expect(logger).toBeDefined();
-    expect(logger.level).toBe('debug');
-    logger.info('test');
-  });
-
-  it('its default develpment level is debug', () => {
-    env.NODE_ENV = 'development';
-    const logger = Logger();
-    expect(logger.level).toBe('debug');
-  });
-
-  it('its default test level is info', () => {
-    env.NODE_ENV = 'test';
-    const logger = Logger();
-    expect(logger.level).toBe('info');
-  });
-
-  it('its default production level is info', () => {
-    env.NODE_ENV = 'production';
-    const logger = Logger();
-    expect(logger.level).toBe('info');
-  });
-
-  it('its level can be override by LOG_LEVEL env variable', () => {
-    env.NODE_ENV = 'development';
-    env.LOG_LEVEL = 'warn';
-    const logger = Logger();
-    expect(logger.level).toBe('warn');
-  });
-
-  it('its level can be override by function variable', () => {
-    env.NODE_ENV = 'production';
-    env.LOG_LEVEL = 'warn';
-    const logger = Logger('info');
-    expect(logger.level).toBe('info');
-  });
-
-  it('its has functions for each level', () => {
-    const logger = Logger();
-    expect(typeof logger.error).toBe('function');
-    expect(typeof logger.warn).toBe('function');
-    expect(typeof logger.info).toBe('function');
-    expect(typeof logger.debug).toBe('function');
-  });
-});

package/src/index.ts

@@ -1,117 +0,0 @@
-import Pino from 'pino';
-import { gcpLogOptions } from 'pino-cloud-logging';
-
-// eslint-disable-next-line no-shadow
-export enum LogLevel {
-  trace = 'trace',
-  debug = 'debug',
-  info = 'info',
-  warn = 'warn',
-  error = 'error',
-  fatal = 'fatal',
-}
-
-type LogLevels = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';
-
-const getLevel = (logLevel?: LogLevel): LogLevel => {
-  if (logLevel) return logLevel;
-  if (process.env.LOG_LEVEL) return process.env.LOG_LEVEL as LogLevel;
-  if (process.env.NODE_ENV && ['production', 'staging', 'test'].includes(process.env.NODE_ENV)) return LogLevel.info;
-  if (process.env.NODE_ENV === 'development') return LogLevel.debug;
-  return LogLevel.debug;
-};
-
-const createLoggerInstance = (level: LogLevel, options: object) => {
-  let loggerInstance;
-  if (process.env.NODE_ENV === 'production') {
-    loggerInstance = Pino(gcpLogOptions({
-      level: process.env.PINO_LOG_LEVEL || 'info',
-      ...options,
-    }));
-  } else {
-    loggerInstance = Pino({
-      level: process.env.PINO_LOG_LEVEL || 'info',
-      transport: {
-        target: 'pino-pretty',
-        options: {
-          colorize: true,
-        },
-      },
-      ...options,
-    });
-  }
-  loggerInstance.level = level;
-  return loggerInstance;
-};
-
-type MiddlewareFunction = () => Record<string, unknown>;
-
-export class LoggerInstanceManager {
-  contextMiddlewares: MiddlewareFunction[];
-
-  logger: Pino.Logger;
-
-  constructor(logLevel?: LogLevel) {
-    this.contextMiddlewares = [];
-    this.logger = createLoggerInstance(getLevel(logLevel), {
-      mixin: () => this.addMetadata(),
-    });
-  }
-
-  // To support winston like logging in pino
-  winstonLikeLoggerCall(logLevel: LogLevel, message: string, meta: unknown) {
-    if (meta) {
-      this.logger[logLevel](meta, message);
-    } else {
-      this.logger[logLevel](message);
-    }
-  }
-
-  addMetadata(): Record<string, unknown> {
-    const newMetadata = {};
-    this.contextMiddlewares.forEach((middleware) => {
-      const metadata = middleware();
-      Object.assign(newMetadata, metadata);
-    });
-    return newMetadata;
-  }
-
-  addContextMiddleware(middleware: MiddlewareFunction) {
-    this.contextMiddlewares.push(middleware);
-  }
-
-  trace(message: string, meta?: unknown) {
-    this.winstonLikeLoggerCall(LogLevel.trace, message, meta);
-  }
-
-  debug(message: string, meta?: unknown) {
-    this.winstonLikeLoggerCall(LogLevel.debug, message, meta);
-  }
-
-  info(message: string, meta?: unknown) {
-    this.winstonLikeLoggerCall(LogLevel.info, message, meta);
-  }
-
-  warn(message: string, meta?: unknown) {
-    this.winstonLikeLoggerCall(LogLevel.warn, message, meta);
-  }
-
-  error(message: string, meta?: unknown) {
-    this.winstonLikeLoggerCall(LogLevel.error, message, meta);
-  }
-
-  fatal(message: string, meta?: unknown) {
-    this.winstonLikeLoggerCall(LogLevel.fatal, message, meta);
-  }
-
-  child(metadata: Record<string, unknown>) {
-    return this.logger.child(metadata);
-  }
-
-  get level() {
-    return this.logger.level;
-  }
-}
-
-// eslint-disable-next-line max-len
-export default (loglevel?: LogLevels): LoggerInstanceManager => new LoggerInstanceManager(loglevel as LogLevel);

package/tsconfig.json

@@ -1,15 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES6",
-    "module": "commonjs",                                /* Specify what module code is generated. */       /* Allow 'import x from y' when a module doesn't have a default export. */
-    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
-    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
-    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
-
-    /* Type Checking */
-    "strict": true,                                      /* Enable all strict type-checking options. */
-    "outDir": "./dist",
-    "declaration": true,
-    "rootDir": "./src",
-  }
-}