@viplance/nestjs-logger 0.4.0 → 0.4.1

package/public/scripts/common.js

@@ -10,7 +10,7 @@ const selectedLogTypes = {
 const logTypes = Object.keys(selectedLogTypes).filter((key) => key !== `all`);
 
 let logs = [];
-let text = "";
+let text = '';
 
 connectWebSocket();
 
@@ -105,12 +105,12 @@ function getDate(incomingDate) {
   const date = new Date(incomingDate);
 
   const formatter = new Intl.DateTimeFormat(undefined, {
-    hour: "2-digit",
-    minute: "2-digit",
-    second: "2-digit",
-    month: "short",
-    day: "2-digit",
-    year: "numeric",
+    hour: '2-digit',
+    minute: '2-digit',
+    second: '2-digit',
+    month: 'short',
+    day: '2-digit',
+    year: 'numeric',
     hour12: false,
   });
 
@@ -133,20 +133,20 @@ function getLogHtmlElement(log) {
         <div class="log-info">${log.message}</div>
         <div class="date">${getDate(log.updatedAt)}</div>
       </div>
-      <div class="col context">${log.trace || ""}</div>
+      <div class="col context">${log.trace || ''}</div>
       <div class="col">${log.count}</div>
     </div>`;
 }
 
 function renderLogs(logList = logs) {
-  let html = "";
+  let html = '';
 
   logList
     .filter((log) => {
-      return selectedLogTypes["all"] || selectedLogTypes[log.type];
+      return selectedLogTypes['all'] || selectedLogTypes[log.type];
     })
     .filter((log) => {
-      if (text === "") return true;
+      if (text === '') return true;
 
       return (
         log.message.toLowerCase().includes(text) ||
@@ -160,32 +160,32 @@ function renderLogs(logList = logs) {
       html += getLogHtmlElement(log);
     });
 
-  document.getElementById("logs").innerHTML = html;
+  document.getElementById('logs').innerHTML = html;
 }
 
 async function checkElementsVisibility(logList = logs) {
   if (logList.length === 0) {
-    document.getElementById("no-logs").style.display = "block";
-    document.getElementById("search").style.display = "none";
-    document.querySelector(".table-header").style.display = "none";
-    document.querySelector("nav").style.display = "none";
+    document.getElementById('no-logs').style.display = 'block';
+    document.getElementById('search').style.display = 'none';
+    document.querySelector('.table-header').style.display = 'none';
+    document.querySelector('nav').style.display = 'none';
   } else {
-    document.getElementById("no-logs").style.display = "none";
-    document.getElementById("search").style.display = "inline-block";
-    document.querySelector(".table-header").style.display = "flex";
-    document.querySelector("nav").style.display = "flex";
+    document.getElementById('no-logs').style.display = 'none';
+    document.getElementById('search').style.display = 'inline-block';
+    document.querySelector('.table-header').style.display = 'flex';
+    document.querySelector('nav').style.display = 'flex';
   }
 }
 
 async function getLogs() {
   const { origin, pathname, search } = window.location;
   const searchParams = new URLSearchParams(search);
-  const key = searchParams.get("key");
+  const key = searchParams.get('key');
 
   if (!!socket) {
     socket.send(
       JSON.stringify({
-        action: "getLogs",
+        action: 'getLogs',
         key,
       })
     );
@@ -199,7 +199,7 @@ async function getLogs() {
 
       renderLogs();
     } else {
-      alert("An error occurred while fetching logs.");
+      alert('An error occurred while fetching logs.');
     }
   }
 }
@@ -210,12 +210,12 @@ async function deleteLog(_id) {
   const { origin, pathname, search: searchParams } = window.location;
 
   const searchParamsWithId = new URLSearchParams(searchParams);
-  const key = searchParamsWithId.get("key");
+  const key = searchParamsWithId.get('key');
 
   if (!!socket) {
     socket.send(
       JSON.stringify({
-        action: "delete",
+        action: 'delete',
         key,
         data: {
           _id,
@@ -225,12 +225,12 @@ async function deleteLog(_id) {
     closePopup();
     getLogs();
   } else {
-    searchParamsWithId.set("id", _id);
+    searchParamsWithId.set('id', _id);
 
     const res = await fetch(
       `${origin}${pathname}api?${searchParamsWithId.toString()}`,
       {
-        method: "DELETE",
+        method: 'DELETE',
       }
     );
 
@@ -238,7 +238,7 @@ async function deleteLog(_id) {
       closePopup();
       getLogs();
     } else {
-      alert("An error occurred while deleting log.");
+      alert('An error occurred while deleting log.');
     }
   }
 }

package/public/scripts/details-popup.js

@@ -6,9 +6,9 @@ function showLogDetails(log) {
   const timeInfo =
     log.updatedAt === log.createdAt
       ? getDate(log.updatedAt)
-      : `Updated: ${getDate(log.updatedAt)}.   First seen: ${getDate(
-          log.createdAt
-        )}`;
+      : `Updated: ${getDate(
+          log.updatedAt
+        )}.   First seen: ${getDate(log.createdAt)}`;
 
   popup.innerHTML = `
     <div class="content center">
@@ -23,7 +23,7 @@ function showLogDetails(log) {
               <h3 class="mt-15">Trace</h3>
               <p class="key pl-2"><span>${getTrace(log.trace)}</span></p>
               `
-              : ""
+              : ''
           }
           ${
             context
@@ -31,7 +31,7 @@ function showLogDetails(log) {
             <h3 class="mt-15">Context</h3>
             <p>${jsonViewer(context)}</p>
             `
-              : ""
+              : ''
           }
           ${
             breadcrumbs && breadcrumbs.length > 0
@@ -39,7 +39,7 @@ function showLogDetails(log) {
             <h3 class="mt-15">Breadcrumbs</h3>
             <p>${jsonViewer(breadcrumbs)}</p>
             `
-              : ""
+              : ''
           }
         <div class="content">
           <button class="white mt-2" onclick="closePopup()">Close</button>
@@ -50,11 +50,11 @@ function showLogDetails(log) {
       </div>
     <div>`;
 
-  popup.style.display = "block";
+  popup.style.display = 'block';
 }
 
 function getObject(context) {
-  if (typeof context === "string") {
+  if (typeof context === 'string') {
     return JSON.parse(context);
   }
 
@@ -62,10 +62,10 @@ function getObject(context) {
 }
 
 function getTrace(trace) {
-  return trace.replace(new RegExp(String.fromCharCode(10), "g"), "<br />");
+  return trace.replace(new RegExp(String.fromCharCode(10), 'g'), '<br />');
 }
 
 function closePopup() {
   const popup = document.getElementById(`popup`);
-  popup.style.display = "none";
+  popup.style.display = 'none';
 }

package/public/scripts/json-viewer.js

@@ -1,6 +1,6 @@
 function jsonViewer(json, parentKey) {
   if (!json) {
-    return "";
+    return '';
   }
 
   res = `<div>`;
@@ -8,7 +8,7 @@ function jsonViewer(json, parentKey) {
   if (Array.isArray(json)) {
     json.forEach((item) => {
       res += `<div class="key pl-2">${
-        typeof item === "object" ? jsonViewer(item) : `<span>${item}</span>`
+        typeof item === 'object' ? jsonViewer(item) : `<span>${item}</span>`
       }</div>`;
     });
 
@@ -23,7 +23,7 @@ function jsonViewer(json, parentKey) {
   }
 
   for (const key of keys) {
-    if (typeof json[key] === "object") {
+    if (typeof json[key] === 'object') {
       res += jsonViewer(json[key], key);
     } else {
       res += `<div class="key pl-2">${key}: <span>${json[key]}</span></div>`;
@@ -34,7 +34,7 @@ function jsonViewer(json, parentKey) {
     res += `</div>`;
   }
 
-  res += "</div>";
+  res += '</div>';
 
   return res;
 }

package/src/defaults.ts

@@ -1 +1 @@
-export const defaultTable = "logs";
+export const defaultTable = 'logs';

package/src/entities/log.entity.ts

@@ -1,14 +1,14 @@
-import { DataSourceOptions, EntitySchema } from "typeorm";
+import { DataSourceOptions, EntitySchema } from 'typeorm';
 
 export function createLogEntity(
   name: string,
-  dbType: DataSourceOptions["type"] | "memory"
+  dbType: DataSourceOptions['type'] | 'memory'
 ) {
   return new EntitySchema({
     name,
     columns: {
       _id: {
-        type: dbType === "mongodb" ? String : Number,
+        type: dbType === 'mongodb' ? String : Number,
         objectId: true,
         primary: true,
         generated: true,

package/src/guards/access.guard.ts

@@ -3,9 +3,9 @@ import {
   ExecutionContext,
   HttpException,
   Injectable,
-} from "@nestjs/common";
-import { LogService } from "../services/log.service";
-import querystring from "node:querystring";
+} from '@nestjs/common';
+import { LogService } from '../services/log.service';
+import querystring from 'node:querystring';
 
 @Injectable()
 export class LogAccessGuard implements CanActivate {
@@ -14,10 +14,10 @@ export class LogAccessGuard implements CanActivate {
       ? context.switchToHttp().getRequest()
       : context; // hook for using as method
 
-    const params = querystring.parse(req.url.split("?")[1]);
+    const params = querystring.parse(req.url.split('?')[1]);
 
     if (LogService.options.key && params.key !== LogService.options.key) {
-      throw new HttpException("Unauthorized", 401);
+      throw new HttpException('Unauthorized', 401);
     }
 
     return true;

package/src/index.ts

@@ -1,4 +1,4 @@
-export * from "./interceptors/log.interceptor";
-export * from "./log.module";
-export * from "./types/index";
-export * from "./services/log.service";
+export * from './interceptors/log.interceptor';
+export * from './log.module';
+export * from './types/index';
+export * from './services/log.service';

package/src/interceptors/log.interceptor.ts

@@ -1,8 +1,8 @@
-import type { CallHandler, NestInterceptor } from "@nestjs/common";
-import { Inject, Injectable } from "@nestjs/common";
-import { Observable, tap } from "rxjs";
-import { LogService } from "../services/log.service";
-import { ExecutionContextHost } from "@nestjs/core/helpers/execution-context-host";
+import type { CallHandler, NestInterceptor } from '@nestjs/common';
+import { Inject, Injectable } from '@nestjs/common';
+import { Observable, tap } from 'rxjs';
+import { LogService } from '../services/log.service';
+import { ExecutionContextHost } from '@nestjs/core/helpers/execution-context-host';
 
 @Injectable()
 export class LogInterceptor implements NestInterceptor {

package/src/log.module.ts

@@ -1,14 +1,14 @@
-import { Module, Global, HttpException } from "@nestjs/common";
-import { LogService } from "./services/log.service";
-import { MemoryDbService } from "./services/memory-db.service";
-import { LogInterceptor } from "./interceptors/log.interceptor";
-import { LogModuleOptions } from "./types";
-import { TypeOrmModule } from "@nestjs/typeorm";
-import querystring from "node:querystring";
-import { ApplicationConfig } from "@nestjs/core";
-import { join } from "node:path";
-import { LogAccessGuard } from "./guards/access.guard";
-import { WsService } from "./services/ws.service";
+import { Module, Global, HttpException } from '@nestjs/common';
+import { LogService } from './services/log.service';
+import { MemoryDbService } from './services/memory-db.service';
+import { LogInterceptor } from './interceptors/log.interceptor';
+import { LogModuleOptions } from './types';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import querystring from 'node:querystring';
+import { ApplicationConfig } from '@nestjs/core';
+import { join } from 'node:path';
+import { LogAccessGuard } from './guards/access.guard';
+import { WsService } from './services/ws.service';
 
 @Global()
 @Module({
@@ -40,7 +40,7 @@ export class LogModule {
     app.useGlobalInterceptors(new LogInterceptor(logService)); // intercept all errors
 
     if (options?.path) {
-      app.useStaticAssets(join(__dirname, "..", "public"), {
+      app.useStaticAssets(join(__dirname, '..', 'public'), {
         prefix: options.path,
       });
 
@@ -48,7 +48,7 @@ export class LogModule {
 
       // frontend settings endpoint
       httpAdapter.get(
-        join(options.path, "settings"),
+        join(options.path, 'settings'),
         async (req: any, res: any) => {
           logAccessGuard.canActivate(req);
 
@@ -58,7 +58,7 @@ export class LogModule {
             result.websocket = {
               namespace: options.websocket?.namespace,
               port: options.websocket?.port,
-              host: options.websocket?.host || req.headers?.host.split(":")[0],
+              host: options.websocket?.host || req.headers?.host.split(':')[0],
             };
           }
 
@@ -67,7 +67,7 @@ export class LogModule {
       );
 
       // get all logs endpoint
-      httpAdapter.get(join(options.path, "api"), async (req: any, res: any) => {
+      httpAdapter.get(join(options.path, 'api'), async (req: any, res: any) => {
         logAccessGuard.canActivate(req);
 
         res.json(await logService.getAll());
@@ -75,14 +75,14 @@ export class LogModule {
 
       // delete log endpoint
       httpAdapter.delete(
-        join(options.path, "api"),
+        join(options.path, 'api'),
         async (req: any, res: any) => {
           logAccessGuard.canActivate(req);
 
-          const params = querystring.parse(req.url.split("?")[1]);
+          const params = querystring.parse(req.url.split('?')[1]);
 
           if (!params.id) {
-            throw new HttpException("id is required", 400);
+            throw new HttpException('id is required', 400);
           }
 
           res.json(await logService.delete(params.id.toString()));

package/src/services/log.service.ts

@@ -3,28 +3,28 @@ import {
   LoggerService,
   OnApplicationShutdown,
   Scope,
-} from "@nestjs/common";
-import { MemoryDbService } from "./memory-db.service";
-import { defaultTable } from "../defaults";
-import { Context, LogModuleOptions, LogType } from "../types";
+} from '@nestjs/common';
+import { MemoryDbService } from './memory-db.service';
+import { defaultTable } from '../defaults';
+import { Context, LogModuleOptions, LogType } from '../types';
 import {
   DataSource,
   DataSourceOptions,
   EntityManager,
   EntitySchema,
-} from "typeorm";
-import { createLogEntity } from "../entities/log.entity";
-import { ExecutionContextHost } from "@nestjs/core/helpers/execution-context-host";
-import { setInterval } from "timers";
-import { entity2table } from "../utils/entity2table";
-import { WsService } from "./ws.service";
-import { Subscription } from "rxjs";
+} from 'typeorm';
+import { createLogEntity } from '../entities/log.entity';
+import { ExecutionContextHost } from '@nestjs/core/helpers/execution-context-host';
+import { setInterval } from 'timers';
+import { entity2table } from '../utils/entity2table';
+import { WsService } from './ws.service';
+import { Subscription } from 'rxjs';
 
 @Injectable({ scope: Scope.TRANSIENT })
 export class LogService implements LoggerService, OnApplicationShutdown {
   static connection: DataSource;
   static options: LogModuleOptions;
-  static Log: EntitySchema = createLogEntity(defaultTable, "memory");
+  static Log: EntitySchema = createLogEntity(defaultTable, 'memory');
   static timer: ReturnType<typeof setInterval>;
   static subscription: Subscription;
 
@@ -44,7 +44,7 @@ export class LogService implements LoggerService, OnApplicationShutdown {
   async connectDb(options: LogModuleOptions): Promise<DataSource> {
     LogService.Log = createLogEntity(
       options.database?.collection || options.database?.table || defaultTable,
-      options.database?.type || "mongodb"
+      options.database?.type || 'mongodb'
     );
 
     if (!LogService.options) {
@@ -62,7 +62,7 @@ export class LogService implements LoggerService, OnApplicationShutdown {
     LogService.connection = new DataSource(dataSourceOptions);
     await LogService.connection.initialize();
 
-    if (dataSourceOptions.type !== "mongodb") {
+    if (dataSourceOptions.type !== 'mongodb') {
       const queryRunner = LogService.connection.createQueryRunner();
 
       try {
@@ -92,13 +92,13 @@ export class LogService implements LoggerService, OnApplicationShutdown {
       LogService.subscription = this.wsService.onMessage.subscribe(
         async (message) => {
           switch (message.action) {
-            case "getLogs":
+            case 'getLogs':
               this.wsService.sendMessage({
-                action: "list",
+                action: 'list',
                 data: await this.getAll(),
               });
               break;
-            case "delete":
+            case 'delete':
               this.delete(message.data._id);
               break;
           }
@@ -159,23 +159,23 @@ export class LogService implements LoggerService, OnApplicationShutdown {
   async getAll(): Promise<any[]> {
     return this.getConnection().find(LogService.Log, {
       select: [
-        "_id",
-        "type",
-        "message",
-        "count",
-        "createdAt",
-        "updatedAt",
-        "context",
-        "trace",
-        "breadcrumbs",
+        '_id',
+        'type',
+        'message',
+        'count',
+        'createdAt',
+        'updatedAt',
+        'context',
+        'trace',
+        'breadcrumbs',
       ],
-      order: { updatedAt: "DESC" },
+      order: { updatedAt: 'DESC' },
     });
   }
 
   async delete(_id: string) {
     this.wsService.sendMessage({
-      action: "delete",
+      action: 'delete',
       data: { _id },
     });
     return this.getConnection().delete(LogService.Log, _id);
@@ -192,12 +192,16 @@ export class LogService implements LoggerService, OnApplicationShutdown {
     const connection = this.getConnection();
 
     // find the same log in DB
-    const log = await connection.findOne(LogService.Log, {
-      where: {
-        type: data.type,
-        message: data.message,
-      },
-    });
+    let log;
+
+    if (LogService.options.join) {
+      log = await connection.findOne(LogService.Log, {
+        where: {
+          type: data.type,
+          message: data.message,
+        },
+      });
+    }
 
     const context = data.context ? this.parseContext(data.context) : undefined;
 
@@ -211,11 +215,11 @@ export class LogService implements LoggerService, OnApplicationShutdown {
       };
 
       this.wsService.sendMessage({
-        action: "update",
+        action: 'update',
         data: { ...log, ...updatedLog },
       });
 
-      await connection.update(LogService.Log, log["_id"], {
+      await connection.update(LogService.Log, log['_id'], {
         context,
         trace: data.trace,
         breadcrumbs: this.breadcrumbs,
@@ -241,7 +245,7 @@ export class LogService implements LoggerService, OnApplicationShutdown {
     const _id = this.getNewObjectId(res);
 
     this.wsService.sendMessage({
-      action: "insert",
+      action: 'insert',
       data: { _id, ...insertedLog },
     });
 
@@ -299,9 +303,9 @@ export class LogService implements LoggerService, OnApplicationShutdown {
   private async checkRecords() {
     if (LogService.options?.maxSize) {
       const latest = await this.getConnection().find(LogService.Log, {
-        order: { updatedAt: "DESC" },
+        order: { updatedAt: 'DESC' },
         take: LogService.options?.maxSize,
-        select: ["_id"],
+        select: ['_id'],
       });
 
       const latestIds = latest.map((item) => item.id);
@@ -311,7 +315,7 @@ export class LogService implements LoggerService, OnApplicationShutdown {
         .createQueryBuilder()
         .delete()
         .from(LogService.Log)
-        .where("_id NOT IN (:...ids)", { ids: latestIds })
+        .where('_id NOT IN (:...ids)', { ids: latestIds })
         .execute();
     }
   }

package/src/services/memory-db.service.ts

@@ -1,8 +1,8 @@
 // Memory DB layer
-import { Injectable } from "@nestjs/common";
-import { createHash, randomBytes } from "crypto";
-import { defaultTable } from "../defaults";
-import { EntitySchema, FindManyOptions } from "typeorm";
+import { Injectable } from '@nestjs/common';
+import { createHash, randomBytes } from 'crypto';
+import { defaultTable } from '../defaults';
+import { EntitySchema, FindManyOptions } from 'typeorm';
 
 const tables = [defaultTable];
 
@@ -20,8 +20,8 @@ export class MemoryDbService {
     const table = this.getTableName(entity);
 
     // generate new random _id
-    const randomData = randomBytes(24).toString("hex");
-    const _id = createHash("sha256").update(randomData).digest("hex");
+    const randomData = randomBytes(24).toString('hex');
+    const _id = createHash('sha256').update(randomData).digest('hex');
 
     this.db[table].push({
       ...data,
@@ -39,7 +39,7 @@ export class MemoryDbService {
     const table = this.getTableName(entity);
     let index: number | null = null;
 
-    if (typeof condition === "string") {
+    if (typeof condition === 'string') {
       index = this.findIndex(entity, { where: { _id: condition } });
     }
 
@@ -136,8 +136,8 @@ export class MemoryDbService {
     if (
       obj1 == null ||
       obj2 == null ||
-      typeof obj1 !== "object" ||
-      typeof obj2 !== "object"
+      typeof obj1 !== 'object' ||
+      typeof obj2 !== 'object'
     ) {
       return false;
     }

package/src/services/ws.d.ts

@@ -1 +1 @@
-declare module "ws";
+declare module 'ws';