@autofleet/logger 4.0.3 → 4.0.4

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@autofleet/logger",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "description": "",
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "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/tsconfig.build.json

@@ -0,0 +1,9 @@
+{
+    "extends": "./tsconfig.json",
+    "exclude": [
+        "node_modules",
+        "dist",
+        "src/**/*.test.ts",
+        "src/example.ts"
+    ]
+}

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');
-    });
-});