Merge pull request #12561 from micalevisk/fix/logger-print-classes

fix(common): when passing class functions to logger methods
nestjs · Oct 23, 2023 · 55c6a9a · 55c6a9a
2 parents ecdd86f + a26de50
commit 55c6a9a
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 26 deletions.
diff --git a/packages/common/services/console-logger.service.ts b/packages/common/services/console-logger.service.ts
@@ -245,10 +245,18 @@ export class ConsoleLogger implements LoggerService {
   }
 
   protected stringifyMessage(message: unknown, logLevel: LogLevel) {
-    // If the message is a function, call it and re-resolve its value.
-    return isFunction(message)
-      ? this.stringifyMessage(message(), logLevel)
-      : isPlainObject(message) || Array.isArray(message)
+    if (isFunction(message)) {
+      const messageAsStr = Function.prototype.toString.call(message);
+      const isClass = messageAsStr.startsWith('class ');
+      if (isClass) {
+        // If the message is a class, we will display the class name.
+        return this.stringifyMessage(message.name, logLevel);
+      }
+      // If the message is a non-class function, call it and re-resolve its value.
+      return this.stringifyMessage(message(), logLevel);
+    }
+
+    return isPlainObject(message) || Array.isArray(message)
       ? `${this.colorize('Object:', logLevel)}\n${JSON.stringify(
           message,
           (key, value) =>

diff --git a/packages/common/test/services/logger.service.spec.ts b/packages/common/test/services/logger.service.spec.ts
@@ -298,6 +298,34 @@ describe('Logger', () => {
         );
       });
     });
+
+    describe('classes for message', () => {
+      let processStdoutWriteSpy: sinon.SinonSpy;
+
+      beforeEach(() => {
+        processStdoutWriteSpy = sinon.spy(process.stdout, 'write');
+      });
+      afterEach(() => {
+        processStdoutWriteSpy.restore();
+      });
+
+      it("should display class's name or empty for anonymous classes", () => {
+        const logger = new ConsoleLogger();
+
+        // in-line anonymous class
+        logger.log(class {});
+
+        // named class
+        class Test {
+          #privateField = 'private field';
+          publicField = 'public field';
+        }
+        logger.log(Test);
+
+        expect(processStdoutWriteSpy.firstCall.firstArg).to.include('');
+        expect(processStdoutWriteSpy.secondCall.firstArg).to.include(Test.name);
+      });
+    });
   });
 
   describe('[instance methods]', () => {

diff --git a/packages/core/injector/module.ts b/packages/core/injector/module.ts
@@ -39,7 +39,6 @@ import { CONTROLLER_ID_KEY } from './constants';
 import { NestContainer } from './container';
 import { ContextId, InstanceWrapper } from './instance-wrapper';
 import { ModuleRef, ModuleRefGetOrResolveOpts } from './module-ref';
-import { Injector } from './injector';
 
 export class Module {
   private readonly _id: string;

diff --git a/packages/core/middleware/routes-mapper.ts b/packages/core/middleware/routes-mapper.ts
@@ -87,28 +87,27 @@ export class RoutesMapper {
       version === VERSION_NEUTRAL ? undefined : version;
 
     const toRouteInfo = (item: RouteDefinition, prefix: string) =>
-      item.path
-        ?.flatMap(p => {
-          let endpointPath = modulePath ?? '';
-          endpointPath += this.normalizeGlobalPath(prefix) + addLeadingSlash(p);
-
-          const routeInfo: RouteInfo = {
-            path: endpointPath,
-            method: item.requestMethod,
-          };
-          const version = item.version ?? controllerVersion;
-          if (version && versioningConfig) {
-            if (typeof version !== 'string' && Array.isArray(version)) {
-              return version.map(v => ({
-                ...routeInfo,
-                version: toUndefinedIfNeural(v),
-              }));
-            }
-            routeInfo.version = toUndefinedIfNeural(version);
+      item.path?.flatMap(p => {
+        let endpointPath = modulePath ?? '';
+        endpointPath += this.normalizeGlobalPath(prefix) + addLeadingSlash(p);
+
+        const routeInfo: RouteInfo = {
+          path: endpointPath,
+          method: item.requestMethod,
+        };
+        const version = item.version ?? controllerVersion;
+        if (version && versioningConfig) {
+          if (typeof version !== 'string' && Array.isArray(version)) {
+            return version.map(v => ({
+              ...routeInfo,
+              version: toUndefinedIfNeural(v),
+            }));
           }
+          routeInfo.version = toUndefinedIfNeural(version);
+        }
 
-          return routeInfo;
-        });
+        return routeInfo;
+      });
 
     return []
       .concat(routePath)

diff --git a/packages/microservices/server/server-mqtt.ts b/packages/microservices/server/server-mqtt.ts
@@ -189,7 +189,7 @@ export class ServerMqtt extends Server implements CustomTransportStrategy {
     if (this.messageHandlers.has(route)) {
       return this.messageHandlers.get(route) || null;
     }
-  
+
     for (const [key, value] of this.messageHandlers) {
       const keyWithoutSharedPrefix = this.removeHandlerKeySharedPrefix(key);
       if (this.matchMqttPattern(keyWithoutSharedPrefix, route)) {