@orion-js/logger 3.12.0 → 3.13.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Orionjs Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/jest.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  roots: ['./src'],
+  testMatch: ['**/__tests__/**/*.+(ts|tsx|js)', '**/?(*.)+(spec|test).+(ts|tsx|js)'],
+  transform: {
+    '^.+\\.(ts|tsx)$': 'ts-jest'
+  },
+  verbose: true
+}

package/lib/formats.d.ts

@@ -0,0 +1,6 @@
+import { transports } from 'winston';
+export declare const sentryFormat: import("logform").FormatWrap;
+export declare const textConsoleFormat: import("logform").Format;
+export declare const textConsoleTransport: transports.ConsoleTransportInstance;
+export declare const jsonConsoleFormat: import("logform").Format;
+export declare const jsonConsoleTransport: transports.ConsoleTransportInstance;

package/lib/formats.js

@@ -0,0 +1,81 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsonConsoleTransport = exports.jsonConsoleFormat = exports.textConsoleTransport = exports.textConsoleFormat = exports.sentryFormat = void 0;
+const winston_1 = require("winston");
+const node_util_1 = __importDefault(require("node:util"));
+const lodash_1 = require("lodash");
+const api_1 = __importDefault(require("@opentelemetry/api"));
+const { metadata, timestamp, json, colorize, combine, printf } = winston_1.format;
+const opentelemetryContext = (0, winston_1.format)(info => {
+    const activeSpan = api_1.default.trace.getActiveSpan();
+    if (activeSpan) {
+        const spanContex = activeSpan.spanContext();
+        if (activeSpan.name && !info.context) {
+            info.context = activeSpan.name;
+        }
+        const fields = {
+            trace_id: spanContex.traceId,
+            span_id: spanContex.spanId,
+            trace_flags: `0${spanContex.traceFlags.toString(16)}`,
+        };
+        Object.assign(info, fields);
+    }
+    return info;
+});
+const metaError = (0, winston_1.format)(info => {
+    if (info?.metadata?.value?.error instanceof Error) {
+        info.stack = info?.metadata?.value?.error.stack;
+        info.errorMessage = info?.metadata?.value?.error.message;
+        delete info?.metadata?.value?.error;
+    }
+    if (info?.metadata?.value instanceof Error) {
+        info.stack = info?.metadata?.value.stack;
+        info.errorMessage = info?.metadata?.value.message;
+        delete info?.metadata?.value;
+    }
+    return info;
+});
+exports.sentryFormat = (0, winston_1.format)(info => {
+    const { path, label, ...extra } = info;
+    return {
+        ...extra,
+        tags: {
+            path: path || '',
+            request_id: label,
+        },
+    };
+});
+function getMetadataText(metadata) {
+    const { value, ...rest } = metadata;
+    if ((0, lodash_1.isEmpty)(rest)) {
+        if (typeof value === 'undefined')
+            return '';
+        return node_util_1.default.inspect(value);
+    }
+    return `${node_util_1.default.inspect(value)} ${node_util_1.default.inspect(rest)}`;
+}
+exports.textConsoleFormat = combine(colorize(), metadata({ fillExcept: ['fileName', 'level', 'message', 'stack'] }), opentelemetryContext(), metaError(), timestamp(), printf(info => {
+    // console.log(info)
+    const date = new Date(info.timestamp);
+    const timeLabel = `${date.getHours()}:${date.getMinutes()}:${date.getSeconds()}`;
+    const fileNameLabel = info.fileName ? `[${info.fileName}]` : '';
+    const stack = info.stack ? `\n${info.stack}` : '';
+    const value = getMetadataText(info.metadata);
+    const traceId = info.trace_id
+        ? `${String(info.trace_id).substring(0, 8)}@${String(info.span_id).substring(0, 8)}`
+        : '';
+    const context = `${info.context || ''} ${traceId}`.trim();
+    return `[${info.level}] [${timeLabel}] [${context}] ${fileNameLabel} ${info.message} ${value} ${stack}`;
+}));
+exports.textConsoleTransport = new winston_1.transports.Console({
+    handleExceptions: true,
+    format: exports.textConsoleFormat,
+});
+exports.jsonConsoleFormat = combine(metadata({ fillExcept: ['fileName', 'level', 'message'] }), opentelemetryContext(), metaError(), timestamp(), json());
+exports.jsonConsoleTransport = new winston_1.transports.Console({
+    handleExceptions: true,
+    format: exports.jsonConsoleFormat,
+});

package/lib/helpers/getFileName.d.ts

@@ -0,0 +1,2 @@
+export declare const getFileName: () => string;
+export declare const improveFileName: (path: string) => string;

package/lib/helpers/getFileName.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.improveFileName = exports.getFileName = void 0;
+const getFileName = () => {
+    try {
+        const stack = new Error().stack;
+        const lines = stack.split('\n');
+        const filePath = lines[3].split('(')[1].split(')')[0];
+        return (0, exports.improveFileName)(filePath);
+    }
+    catch (error) {
+        return;
+    }
+};
+exports.getFileName = getFileName;
+const improveFileName = (path) => {
+    if (path.includes('orionjs/packages')) {
+        return path.replace(/^.+\/orionjs\/packages\//, '@orion-js/');
+    }
+    if (path.includes('.orion/build')) {
+        return path.replace(/^.+\.orion\/build\//, '');
+    }
+    if (path.includes('/node_modules/@')) {
+        const after = path.split('/node_modules/')[1];
+        const parts = after.split('/');
+        return `${parts[0]}/${parts[1]}`;
+    }
+    if (path.includes('/node_modules/')) {
+        const after = path.split('/node_modules/')[1];
+        const parts = after.split('/');
+        return `${parts[0]}`;
+    }
+    return path;
+};
+exports.improveFileName = improveFileName;

package/lib/helpers/getFileName.test.d.ts

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

package/lib/helpers/getFileName.test.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const getFileName_1 = require("./getFileName");
+describe('GetFileName', () => {
+    it('Should clean @package in node_modules', () => {
+        const fileName = '/Users/nicolaslopezj/Code/Projects/justo/drivers/server/node_modules/@orion-js/dogs/lib/services/WorkerService.js:39:25';
+        const improvedFileName = (0, getFileName_1.improveFileName)(fileName);
+        expect(improvedFileName).toBe('@orion-js/dogs');
+    });
+    it('Should clean simple package in node modules', () => {
+        const fileName = '/Users/nicolaslopezj/Code/Projects/justo/drivers/server/node_modules/dogs/lib/services/WorkerService.js:39:25';
+        const improvedFileName = (0, getFileName_1.improveFileName)(fileName);
+        expect(improvedFileName).toBe('dogs');
+    });
+});

package/lib/index.d.ts

@@ -0,0 +1,5 @@
+import winston from 'winston';
+export * from './formats';
+export * from './logger';
+export * from './types';
+export { winston };

package/lib/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.winston = void 0;
+const winston_1 = __importDefault(require("winston"));
+exports.winston = winston_1.default;
+__exportStar(require("./formats"), exports);
+__exportStar(require("./logger"), exports);
+__exportStar(require("./types"), exports);

package/lib/index.test.d.ts

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

package/lib/index.test.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const logger_1 = require("./logger");
+(0, logger_1.setLogLevel)('debug');
+describe('Log', () => {
+    test('Test logs', () => {
+        logger_1.logger.debug('debug');
+        logger_1.logger.info('info');
+        logger_1.logger.warn('warn');
+        logger_1.logger.warn('warn', { info: 'of the log' });
+    });
+    it('shouldnt fail when passing a non object to the metadata', () => {
+        logger_1.logger.info('info', 'a string');
+        logger_1.logger.info('info', ['array']);
+    });
+    it('should log errors correctly', () => {
+        logger_1.logger.error('an error', new Error('message'));
+        logger_1.logger.error('an error2', { error: new Error('message'), info: 'of the log' });
+    });
+    it('should pass the context', () => {
+        const withMeta = logger_1.logger.addMetadata({ context: 'context' });
+        withMeta.info('info', { notContext: 'notContext' });
+    });
+});

package/lib/logger.d.ts

@@ -0,0 +1,8 @@
+import winston from 'winston';
+import { OrionLogger } from './types';
+export declare const winstonLogger: winston.Logger;
+export declare const configureLogger: (options: winston.LoggerOptions) => void;
+export declare const setLogLevel: (level: string) => string;
+export declare const addTransport: (transport: winston.transport) => winston.Logger;
+export declare const getLogger: (context: string) => winston.Logger;
+export declare const logger: OrionLogger;

package/lib/logger.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = exports.getLogger = exports.addTransport = exports.setLogLevel = exports.configureLogger = exports.winstonLogger = void 0;
+const winston_1 = require("winston");
+const formats_1 = require("./formats");
+const getFileName_1 = require("./helpers/getFileName");
+const transports = [
+    process.env.ORION_DEV || process.env.JEST_WORKER_ID ? formats_1.textConsoleTransport : formats_1.jsonConsoleTransport
+];
+exports.winstonLogger = (0, winston_1.createLogger)({
+    levels: winston_1.config.npm.levels,
+    handleExceptions: true,
+    format: winston_1.format.errors({ stack: true }),
+    transports: transports
+});
+const configureLogger = (options) => {
+    return exports.winstonLogger.configure(options);
+};
+exports.configureLogger = configureLogger;
+const setLogLevel = (level) => {
+    return (exports.winstonLogger.level = level);
+};
+exports.setLogLevel = setLogLevel;
+const addTransport = (transport) => {
+    return exports.winstonLogger.add(transport);
+};
+exports.addTransport = addTransport;
+const getLogger = (context) => {
+    return exports.winstonLogger.child({ context });
+};
+exports.getLogger = getLogger;
+const createLogger = (logger) => {
+    return {
+        debug: (message, value) => {
+            const fileName = (0, getFileName_1.getFileName)();
+            return logger.debug({ message, fileName, value });
+        },
+        info: (message, value) => {
+            const fileName = (0, getFileName_1.getFileName)();
+            return logger.info({ message, fileName, value });
+        },
+        warn: (message, value) => {
+            const fileName = (0, getFileName_1.getFileName)();
+            return logger.warn({ message, fileName, value });
+        },
+        error: (message, value) => {
+            const fileName = (0, getFileName_1.getFileName)();
+            return logger.error({ message, fileName, value });
+        },
+        addContext: (module) => {
+            if (module.id) {
+                const split = String(module.id).split('.orion/build/');
+                const fileName = split.length > 1 ? split[1] : split[0];
+                return createLogger(logger.child({ fileName }));
+            }
+            return createLogger(logger.child({}));
+        },
+        addMetadata: (metadata) => {
+            return createLogger(logger.child(metadata));
+        }
+    };
+};
+exports.logger = createLogger(exports.winstonLogger);

package/lib/types/index.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="node" />
+export declare type LogFunction = (message: string, metadata?: any) => void;
+export interface OrionLogger {
+    debug: LogFunction;
+    info: LogFunction;
+    warn: LogFunction;
+    error: LogFunction;
+    addContext: (module: NodeJS.Module) => OrionLogger;
+    addMetadata: (metadata: any) => OrionLogger;
+}

package/lib/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,17 +1,16 @@
 {
   "name": "@orion-js/logger",
-  "version": "3.12.0",
-  "main": "./dist/index.cjs",
+  "version": "3.13.1",
+  "main": "lib/index.js",
   "author": "nicolaslopezj",
   "license": "MIT",
   "scripts": {
-    "test": "bun test",
+    "test": "ORION_DEV=1 jest",
     "prepare": "yarn run build",
-    "clean": "rm -rf ./dist",
-    "build": "bun run build.ts",
+    "clean": "rm -rf ./lib",
+    "build": "yarn run clean && tsc",
     "watch": "tsc -w",
-    "upgrade-interactive": "yarn upgrade-interactive",
-    "dev": "bun --watch src/index.ts"
+    "upgrade-interactive": "yarn upgrade-interactive"
   },
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
@@ -22,23 +21,14 @@
     "winston": "^3.6.0"
   },
   "devDependencies": {
+    "@types/jest": "^27.0.2",
     "@types/lodash": "^4.14.182",
-    "typescript": "^5.4.5",
-    "@types/bun": "^1.2.4"
+    "jest": "27.3.1",
+    "ts-jest": "27.0.7",
+    "typescript": "^4.4.4"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9d85ab24776533db109843c277324e42c65ddedd",
-  "type": "module",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    "types": "./dist/index.d.ts",
-    "import": "./dist/index.js",
-    "require": "./dist/index.cjs"
-  },
-  "files": [
-    "dist"
-  ]
-}
+  "gitHead": "18ab5a9711863e6bd3d3c61e7bb8f9067afca82c"
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "strict": false,
+    "outDir": "./lib",
+    "rootDir": "./src",
+    "module": "commonjs",
+    "target": "es2020",
+    "moduleResolution": "node",
+    "lib": ["es2020"],
+    "declaration": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  }
+}