feat(connect): add @tsed/logger-connect to configure external logger

.github/workflows/build.yml

@@ -84,6 +84,7 @@ jobs:
           CI: true
           GH_TOKEN: ${{ secrets.GH_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
         run: yarn release
       - uses: actions/upload-artifact@v2
         with:
@@ -117,4 +118,5 @@ jobs:
           CI: true
           GH_TOKEN: ${{ secrets.GH_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
         run: yarn docs:publish

docs/.vuepress/config.js

@@ -177,6 +177,7 @@ module.exports = {
             children: [
               {title: "Configuration", path: "/appenders/"},
               {title: "Console", path: "/appenders/console"},
+              {title: "Connect", path: "/appenders/connect"},
               {title: "File", path: "/appenders/file"},
               {title: "File date", path: "/appenders/file-date"},
               {title: "Stdout", path: "/appenders/stdout"},
@@ -202,6 +203,7 @@ module.exports = {
               "/layouts/dummy",
               "/layouts/message-pass-through",
               "/layouts/json",
+              "/layouts/object",
               "/layouts/pattern"
             ]
           },
@@ -214,6 +216,7 @@ module.exports = {
           "/appenders/console",
           "/appenders/file",
           "/appenders/file-date",
+          "/appenders/connect",
           "/appenders/stdout",
           "/appenders/stderr",
           "/appenders/insight",
@@ -229,6 +232,7 @@ module.exports = {
           "/layouts/colored",
           "/layouts/dummy",
           "/layouts/message-pass-through",
+          "/layouts/object",
           "/layouts/json",
           "/layouts/pattern"
         ],

docs/appenders/connect.md

@@ -0,0 +1,33 @@
+# Connect Appender
+
+The module let developer use external logger that implement the classic logger methods (info, debug, warn, trace, error, fatal).
+
+```bash
+npm install --save @tsed/logger-connect
+```
+
+## Configuration
+
+- `type` - `connect`
+- `options.logger` - your instance logger
+
+## Example
+
+```typescript
+import {$log} from "@tsed/logger";
+import "@tsed/logger-connect";
+
+$log.clear()
+$log.appenders.set("channel", {
+  type: "connect",
+  logger: {
+    info: (obj) => console.log(obj),
+    warn: (obj) => console.warn(obj),
+    debug: (obj) => console.debug(obj),
+    trace: (obj) => console.trace(obj),
+    error: (obj) => console.error(obj),
+  }
+});
+
+$log.info({tags: ["my-tag-1", "my-tag-2"]}, "Some message");
+```

docs/layouts/object.md

@@ -0,0 +1,23 @@
+# Object layout
+
+- type - `object`
+
+## Example
+
+```typescript
+import {$log} from "@tsed/logger";
+import "@tsed/logger-connect";
+import {myLogger} from "./MyLogger";
+
+$log.clear()
+$log.appenders.set("std-log-json", {
+  type: "connect",
+  options: {
+    logger: myLogger // should implements .info/debug/trace/warn/error/fatal
+  }
+});
+
+$log.info("this is just a test");
+$log.error("of a custom appender");
+$log.warn("that outputs json");
+```

package.json

@@ -78,6 +78,7 @@
     "jest": "^28.1.0",
     "prettier": "2.6.1",
     "semantic-release": "^19.0.2",
+    "semantic-release-slack-bot": "^3.5.3",
     "source-map-support": "0.5.21",
     "ts-jest": "^28.0.3",
     "ts-node": "^10.8.0",

packages/connect/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@tsed/logger-connect",
+  "version": "6.1.4",
+  "description": "Connect Ts.ED logger with another logger that implement the expected interface",
+  "source": "./src/index.ts",
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "typings": "./lib/types/index.d.ts",
+  "exports": {
+    "types": "./lib/types/index.d.ts",
+    "import": "./lib/esm/index.js",
+    "require": "./lib/cjs/index.js",
+    "default": "./lib/esm/index.js"
+  },
+  "scripts": {
+    "build": "yarn barrels && yarn run build:esm && yarn run build:cjs",
+    "build:cjs": "tsc --build tsconfig.compile.json",
+    "build:esm": "tsc --build tsconfig.compile.esm.json",
+    "barrels": "yarn barrelsby --delete -d ./src -e \"\\.spec\\.ts\" -e \"__mock__\" -e \".benchmark.ts\""
+  },
+  "private": false,
+  "author": {
+    "name": "Romain Lenzotti"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tsedio/logger.git"
+  },
+  "keywords": [
+    "ts",
+    "log",
+    "debug",
+    "typescript",
+    "trace",
+    "connect"
+  ],
+  "bugs": {
+    "url": "https://github.com/tsedio/logger/issues"
+  },
+  "homepage": "https://github.com/tsedio/logger",
+  "dependencies": {
+    "tslib": "2.3.1"
+  },
+  "devDependencies": {
+    "@tsed/logger": "6.1.4"
+  },
+  "peerDependencies": {
+    "@tsed/logger": ">=6.0.0"
+  }
+}

packages/connect/readme.md

@@ -0,0 +1,76 @@
+# @tsed/logger-connect
+
+[![Build Status](https://travis-ci.org/tsedio/logger.svg?branch=master)](https://travis-ci.org/tsedio/logger)
+[![Coverage Status](https://coveralls.io/repos/github/tsedio/logger/badge.svg?branch=master)](https://coveralls.io/github/tsedio/logger?branch=master)
+[![TypeScript](https://badges.frapsoft.com/typescript/love/typescript.svg?v=100)](https://github.com/ellerbrock/typescript-badges/)
+[![npm version](https://badge.fury.io/js/%40tsed%2Flogger.svg)](https://badge.fury.io/js/%40tsed%2Flogger)
+[![Dependencies](https://david-dm.org/tsedio/logger.svg)](https://david-dm.org/tsedio/logger#info=dependencies)
+[![img](https://david-dm.org/tsedio/logger/dev-status.svg)](https://david-dm.org/tsedio/logger/#info=devDependencies)
+[![img](https://david-dm.org/tsedio/logger/peer-status.svg)](https://david-dm.org/tsedio/logger/#info=peerDependenciess)
+[![Known Vulnerabilities](https://snyk.io/test/github/tsedio/logger/badge.svg)](https://snyk.io/test/github/tsedio/ts-express-decorators)
+
+<p style="text-align: center" align="center">
+ <a href="https://tsed.io" target="_blank"><img src="https://tsed.io/tsed-og.png" width="200" alt="Ts.ED logo"/></a>
+</p>
+
+A package of Ts.ED logger framework.
+
+## Features
+
+The module let developer use external logger that implement the classic logger methods (info, debug, warn, trace, error, fatal).
+
+## Installation
+
+```bash
+npm install --save @tsed/logger-connect
+```
+
+## Configuration
+
+- `type` - `connect`
+- `options.logger` - your instance logger
+
+## Example
+
+```typescript
+import {$log} from "@tsed/logger";
+import "@tsed/logger-connect";
+
+$log.clear()
+$log.appenders.set("channel", {
+  type: "connect",
+  logger: {
+    info: (obj) => console.log(obj),
+    warn: (obj) => console.warn(obj),
+    debug: (obj) => console.debug(obj),
+    trace: (obj) => console.trace(obj),
+    error: (obj) => console.error(obj),
+  }
+});
+
+$log.info({tags: ["my-tag-1", "my-tag-2"]}, "Some message");
+```
+
+This will result in a log message being sent to loggly with the tags `tag1`, `my-tag-1`, `my-tag-2`.
+
+## Backers
+
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tsed#backer)]
+
+<a href="https://opencollective.com/tsed#backers" target="_blank"><img src="https://opencollective.com/tsed/tiers/backer.svg?width=890"></a>
+
+## Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2016 - 2018 Romain Lenzotti
+
+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.

packages/connect/src/ConnectAppender.spec.ts

@@ -0,0 +1,137 @@
+import {Logger} from "@tsed/logger";
+import {ConnectAppender} from "./ConnectAppender";
+
+describe("ConnectAppender", () => {
+  it("should log something (from class)", () => {
+    const externalLogger = {
+      debug: jest.fn(),
+      error: jest.fn(),
+      fatal: jest.fn(),
+      info: jest.fn(),
+      trace: jest.fn(),
+      warn: jest.fn()
+    };
+
+    const logger = new Logger("test");
+    logger.appenders.set("connect", {
+      type: ConnectAppender,
+      options: {
+        logger: externalLogger
+      }
+    });
+
+    logger.debug({test: "test"});
+    logger.error({test: "test"});
+    logger.fatal({test: "test"});
+    logger.info({test: "test"});
+    logger.trace({test: "test"});
+    logger.warn({test: "test"});
+
+    expect(externalLogger.debug).toHaveBeenCalledWith(
+      expect.objectContaining({
+        categoryName: "test",
+        data: [],
+        level: "DEBUG",
+        test: "test"
+      })
+    );
+    expect(externalLogger.error).toHaveBeenCalledWith(
+      expect.objectContaining({
+        categoryName: "test",
+        data: [],
+        level: "ERROR",
+        test: "test"
+      })
+    );
+    expect(externalLogger.fatal).toHaveBeenCalledWith(
+      expect.objectContaining({
+        categoryName: "test",
+        data: [],
+        level: "FATAL",
+        test: "test"
+      })
+    );
+    expect(externalLogger.info).toHaveBeenCalledWith(
+      expect.objectContaining({
+        categoryName: "test",
+        data: [],
+        level: "INFO",
+        test: "test"
+      })
+    );
+    expect(externalLogger.warn).toHaveBeenCalledWith(
+      expect.objectContaining({
+        categoryName: "test",
+        data: [],
+        level: "WARN",
+        test: "test"
+      })
+    );
+  });
+  it("should log something (from name)", () => {
+    const externalLogger = {
+      debug: jest.fn(),
+      error: jest.fn(),
+      fatal: jest.fn(),
+      info: jest.fn(),
+      trace: jest.fn(),
+      warn: jest.fn()
+    };
+
+    const logger = new Logger("test");
+    logger.appenders.set("connect", {
+      type: "connect",
+      options: {
+        logger: externalLogger
+      }
+    });
+
+    logger.debug({test: "test"});
+    logger.error({test: "test"});
+    logger.fatal({test: "test"});
+    logger.info({test: "test"});
+    logger.trace({test: "test"});
+    logger.warn({test: "test"});
+
+    expect(externalLogger.debug).toHaveBeenCalledWith(
+      expect.objectContaining({
+        categoryName: "test",
+        data: [],
+        level: "DEBUG",
+        test: "test"
+      })
+    );
+    expect(externalLogger.error).toHaveBeenCalledWith(
+      expect.objectContaining({
+        categoryName: "test",
+        data: [],
+        level: "ERROR",
+        test: "test"
+      })
+    );
+    expect(externalLogger.fatal).toHaveBeenCalledWith(
+      expect.objectContaining({
+        categoryName: "test",
+        data: [],
+        level: "FATAL",
+        test: "test"
+      })
+    );
+    expect(externalLogger.info).toHaveBeenCalledWith(
+      expect.objectContaining({
+        categoryName: "test",
+        data: [],
+        level: "INFO",
+        test: "test"
+      })
+    );
+    expect(externalLogger.warn).toHaveBeenCalledWith(
+      expect.objectContaining({
+        categoryName: "test",
+        data: [],
+        level: "WARN",
+        test: "test"
+      })
+    );
+  });
+});