@trayio/winston 0.11.0

package/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023 Tray.io, Inc
+
+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/dist/cli/WinstonCliLogging.d.ts

@@ -0,0 +1,9 @@
+import { DynamicObject } from '@trayio/commons/dynamictype/DynamicType';
+import { CliLogging, CliColors } from '@trayio/commons/cli/CliLogging';
+export declare class WinstonCliLogging implements CliLogging {
+    private logger;
+    constructor();
+    log(message: string | DynamicObject): void;
+    logBlock(message: string, color: CliColors): void;
+}
+//# sourceMappingURL=WinstonCliLogging.d.ts.map

package/dist/cli/WinstonCliLogging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WinstonCliLogging.d.ts","sourceRoot":"","sources":["../../src/cli/WinstonCliLogging.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AACxE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,gCAAgC,CAAC;AAWvE,qBAAa,iBAAkB,YAAW,UAAU;IACnD,OAAO,CAAC,MAAM,CAAgB;;IA8B9B,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,aAAa;IAInC,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS;CAkB1C"}

package/dist/cli/WinstonCliLogging.js

@@ -0,0 +1,60 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WinstonCliLogging = void 0;
+const CliLogging_1 = require("@trayio/commons/cli/CliLogging");
+const json_colorizer_1 = __importDefault(require("json-colorizer"));
+const winston_1 = require("winston");
+const chalk_1 = __importDefault(require("chalk"));
+class WinstonCliLogging {
+    constructor() {
+        const logFormatter = (info) => {
+            if (typeof info.message === 'object') {
+                const messageStr = JSON.stringify(info.message, null, 2);
+                return (0, json_colorizer_1.default)(messageStr, {
+                    colors: {
+                        STRING_KEY: 'white',
+                        STRING_LITERAL: 'green',
+                        NUMBER_LITERAL: 'yellow',
+                        BRACE: 'gray',
+                        BRACKET: 'white',
+                        COLON: 'gray',
+                        COMMA: 'gray',
+                        BOOLEAN_LITERAL: 'yellow',
+                        NULL_LITERAL: 'blue',
+                    },
+                });
+            }
+            return info.message;
+        };
+        this.logger = (0, winston_1.createLogger)({
+            level: 'info',
+            format: winston_1.format.combine(winston_1.format.splat(), winston_1.format.printf(logFormatter)),
+            transports: [new winston_1.transports.Console()],
+        });
+    }
+    log(message) {
+        this.logger.info(message);
+    }
+    logBlock(message, color) {
+        let messageBlock;
+        switch (color) {
+            case CliLogging_1.CliColors.blue:
+                messageBlock = chalk_1.default.white.bgBlue(` ${message} `);
+                break;
+            case CliLogging_1.CliColors.red:
+                messageBlock = chalk_1.default.white.bgRed(` ${message} `);
+                break;
+            case CliLogging_1.CliColors.yellow:
+                messageBlock = chalk_1.default.white.bgYellow(` ${message} `);
+                break;
+            default:
+                messageBlock = chalk_1.default.white.bgBlue(` ${message} `);
+                break;
+        }
+        this.logger.info(messageBlock);
+    }
+}
+exports.WinstonCliLogging = WinstonCliLogging;

package/dist/logging/WinstonLogging.d.ts

@@ -0,0 +1,14 @@
+import { ObservabilityContext, Logging } from '@trayio/commons/logging/Logging';
+declare class WinstonLogging implements Logging {
+    private winstonLogger;
+    private context;
+    constructor(context?: ObservabilityContext);
+    info(message: string, context: ObservabilityContext): void;
+    debug(message: string, context: ObservabilityContext): void;
+    error(message: string, context: ObservabilityContext): void;
+    warning(message: string, context: ObservabilityContext): void;
+    private getDefaultContext;
+}
+export declare const getLogger: (context?: ObservabilityContext) => WinstonLogging;
+export {};
+//# sourceMappingURL=WinstonLogging.d.ts.map

package/dist/logging/WinstonLogging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WinstonLogging.d.ts","sourceRoot":"","sources":["../../src/logging/WinstonLogging.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,oBAAoB,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAEhF,cAAM,cAAe,YAAW,OAAO;IACtC,OAAO,CAAC,aAAa,CAAgB;IAErC,OAAO,CAAC,OAAO,CAAuB;gBAE1B,OAAO,GAAE,oBAAyB;IAU9C,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB;IAInD,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB;IAIpD,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB;IAIpD,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB;IAItD,OAAO,CAAC,iBAAiB;CAOzB;AAED,eAAO,MAAM,SAAS,aAAa,oBAAoB,mBAC3B,CAAC"}

package/dist/logging/WinstonLogging.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLogger = void 0;
+const winston_1 = require("winston");
+class WinstonLogging {
+    constructor(context = {}) {
+        this.winstonLogger = (0, winston_1.createLogger)({
+            format: winston_1.format.json(),
+            exitOnError: false,
+            transports: [new winston_1.transports.Console()],
+        });
+        this.context = this.getDefaultContext(context);
+    }
+    info(message, context) {
+        this.winstonLogger.info(message, Object.assign(Object.assign({}, this.context), context));
+    }
+    debug(message, context) {
+        this.winstonLogger.debug(message, Object.assign(Object.assign({}, this.context), context));
+    }
+    error(message, context) {
+        this.winstonLogger.error(message, Object.assign(Object.assign({}, this.context), context));
+    }
+    warning(message, context) {
+        this.winstonLogger.warn(message, Object.assign(Object.assign({}, this.context), context));
+    }
+    getDefaultContext(context) {
+        context.service = process.env.npm_package_name;
+        return context;
+    }
+}
+const getLogger = (context = {}) => new WinstonLogging(context);
+exports.getLogger = getLogger;

package/dist/logging/WinstonLogging.unit.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=WinstonLogging.unit.test.d.ts.map

package/dist/logging/WinstonLogging.unit.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WinstonLogging.unit.test.d.ts","sourceRoot":"","sources":["../../src/logging/WinstonLogging.unit.test.ts"],"names":[],"mappings":""}

package/dist/logging/WinstonLogging.unit.test.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const winston_1 = require("winston");
+const WinstonLogging_1 = require("./WinstonLogging");
+jest.mock('winston', () => (Object.assign(Object.assign({}, jest.requireActual('winston')), { createLogger: jest.fn(), Logger: jest.fn() })));
+describe('Logger', () => {
+    const mockedCreateLogger = winston_1.createLogger;
+    beforeEach(() => {
+        jest.clearAllMocks();
+    });
+    describe.each([
+        { logLevel: 'info', winstonLogLevel: 'info' },
+        { logLevel: 'error', winstonLogLevel: 'error' },
+        { logLevel: 'warning', winstonLogLevel: 'warn' },
+        { logLevel: 'debug', winstonLogLevel: 'debug' },
+    ])('log level %s', ({ logLevel, winstonLogLevel }) => {
+        describe('When provided with a message and observability context', () => {
+            const mockInfo = jest.fn();
+            const mockWinston = {
+                [winstonLogLevel]: mockInfo,
+            };
+            beforeEach(() => {
+                mockedCreateLogger.mockImplementation(() => mockWinston);
+                const logger = (0, WinstonLogging_1.getLogger)();
+                logger[logLevel]('test log message', {
+                    host: 'localhost',
+                });
+            });
+            it('should instantiate the logger with console and json formatting', () => {
+                expect(winston_1.createLogger).toHaveBeenCalledWith({
+                    format: winston_1.format.json(),
+                    exitOnError: false,
+                    transports: [expect.any(winston_1.transports.Console)],
+                });
+            });
+            it('Should log the message and context', () => {
+                expect(mockInfo).toHaveBeenCalledWith('test log message', {
+                    host: 'localhost',
+                    service: 'tray-typescript-sdk',
+                });
+            });
+        });
+    });
+    describe('when logging a message', () => {
+        describe('when no context is provided', () => {
+            const mockInfo = jest.fn();
+            const mockWinston = {
+                info: mockInfo,
+            };
+            beforeEach(() => {
+                mockedCreateLogger.mockImplementation(() => mockWinston);
+                const logger = (0, WinstonLogging_1.getLogger)({ env: 'test' });
+                logger.info('test log message', {});
+            });
+            it('should log the default context of service name and env', () => {
+                expect(mockInfo).toHaveBeenCalledWith('test log message', {
+                    service: 'tray-typescript-sdk',
+                    env: 'test',
+                });
+            });
+        });
+        describe('when an initial context is provided', () => {
+            const mockInfo = jest.fn();
+            const mockWinston = {
+                info: mockInfo,
+            };
+            beforeEach(() => {
+                mockedCreateLogger.mockImplementation(() => mockWinston);
+                const logger = (0, WinstonLogging_1.getLogger)({ env: 'test' });
+                logger.info('test log message', {});
+                logger.info('test log message two', {});
+            });
+            it('should log the inital context with every subsequent log', () => {
+                expect(mockInfo).toHaveBeenNthCalledWith(1, 'test log message', {
+                    service: 'tray-typescript-sdk',
+                    env: 'test',
+                });
+                expect(mockInfo).toHaveBeenNthCalledWith(2, 'test log message two', {
+                    service: 'tray-typescript-sdk',
+                    env: 'test',
+                });
+            });
+        });
+    });
+});

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@trayio/winston",
+  "version": "0.11.0",
+  "description": "Tray implementation of Winston logger",
+  "author": "Tray.io",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@trayio/commons": "0.11.0",
+    "chalk": "*",
+    "json-colorizer": "*",
+    "winston": "*"
+  },
+  "exports": {
+    "./*": "./dist/*.js"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "*",
+        "dist/*"
+      ]
+    }
+  },
+  "files": [
+    "/dist"
+  ]
+}