Logger has been moved and implemented as an internal lib (#449)

* Logger has been moved and implemented as an internal lib

* Fixing lint issue and removing irrelevant lines in shortener.controller.spec

* lint issue fixed in logger

* fix: remove buildable target from logger

* fix: prettier

---------

Co-authored-by: orig <[email protected]>
Co-authored-by: orig <[email protected]>

apps/backend/src/app.module.ts

@@ -4,7 +4,7 @@ import { ThrottlerModule } from '@nestjs/throttler';
 import { AuthModule } from './auth/auth.module';
 import { AppCacheModule } from './cache/cache.module';
 import { AppConfigModule, AppConfigService } from '@reduced.to/config';
-import { AppLoggerModule } from './logger/logger.module';
+import { AppLoggerModule } from '@reduced.to/logger';
 import { NovuModule } from './novu/novu.module';
 import { PrismaService } from '@reduced.to/prisma';
 import { UniqueConstraint } from './shared/decorators/unique/unique.decorator';

apps/backend/src/shortener/shortener.controller.spec.ts

@@ -5,7 +5,7 @@ import { ShortenerController } from './shortener.controller';
 import { Test } from '@nestjs/testing';
 import { ShortenerDto } from './dto';
 import { Request } from 'express';
-import { AppLoggerModule } from '../logger/logger.module';
+import { AppLoggerModule } from '@reduced.to/logger';
 
 describe('ShortenerController', () => {
   let shortenerController: ShortenerController;

apps/backend/src/shortener/shortener.controller.ts

@@ -4,7 +4,7 @@ import { ShortenerDto } from './dto';
 import { ShortenerService } from './shortener.service';
 import { UserContext } from '../auth/interfaces/user-context';
 import { OptionalJwtAuthGuard } from '../auth/guards/optional-jwt-auth.guard';
-import { AppLoggerSerivce } from '../logger/logger.service';
+import { AppLoggerSerivce } from '@reduced.to/logger';
 
 @Controller({
   path: 'shortener',

libs/logger/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

libs/logger/README.md

@@ -0,0 +1,7 @@
+# logger
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test logger` to execute the unit tests via [Jest](https://jestjs.io).

libs/logger/jest.config.ts

@@ -0,0 +1,11 @@
+/* eslint-disable */
+export default {
+  displayName: 'logger',
+  preset: '../../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/libs/logger',
+};

libs/logger/project.json

@@ -0,0 +1,30 @@
+{
+  "name": "logger",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/logger/src",
+  "projectType": "library",
+  "targets": {
+    "lint": {
+      "executor": "@nx/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["libs/logger/**/*.ts"]
+      }
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "libs/logger/jest.config.ts",
+        "passWithNoTests": true
+      },
+      "configurations": {
+        "ci": {
+          "ci": true,
+          "codeCoverage": true
+        }
+      }
+    }
+  },
+  "tags": []
+}

libs/logger/src/index.ts

@@ -0,0 +1,2 @@
+export * from './lib/logger.module';
+export * from './lib/logger.service';

apps/backend/src/logger/logger.service.ts → libs/logger/src/lib/logger.service.ts

@@ -4,20 +4,18 @@ import { AppConfigService } from '@reduced.to/config';
 
 @Injectable()
 export class AppLoggerSerivce implements LoggerService {
+  private readonly logger: Logger;
+
   constructor(private readonly config: AppConfigService) {
-    if (!this.logger) {
-      this.logger = new Logger({
-        transports: [
-          new ConsoleTransport({
-            threshold: this.config.getConfig().logger.console.threshold,
-          }),
-        ],
-      });
-    }
+    this.logger = new Logger({
+      transports: [
+        new ConsoleTransport({
+          threshold: this.config.getConfig().logger.console.threshold,
+        }),
+      ],
+    });
   }
 
-  private readonly logger: Logger;
-
   log = (message: any, ...optionalParams: any[]) => this.logger.info(message, ...optionalParams);
   error = (message: any, ...optionalParams: any[]) => this.logger.error(message, ...optionalParams);
   warn = (message: any, ...optionalParams: any[]) => this.logger.warn(message, ...optionalParams);

libs/logger/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "commonjs"
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

libs/logger/tsconfig.lib.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"],
+  "include": ["src/**/*.ts"]
+}

libs/logger/tsconfig.spec.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": ["jest.config.ts", "src/**/*.test.ts", "src/**/*.spec.ts", "src/**/*.d.ts"]
+}

tsconfig.base.json

@@ -16,6 +16,7 @@
     "baseUrl": ".",
     "paths": {
       "@reduced.to/config": ["libs/config/src/index.ts"],
+      "@reduced.to/logger": ["libs/logger/src/index.ts"],
       "@reduced.to/prisma": ["libs/prisma/src/index.ts"],
       "@reduced.to/queue-manager": ["libs/queue-manager/src/index.ts"]
     }