fix: specify inspect depth for node inspect.custom (#2007)

Discussed in mikro-orm/mikro-orm#5525 (reply in thread)

Author: connor4312

src/adapter/templates/getStringyProps.ts

@@ -9,6 +9,9 @@ const enum DescriptionSymbols {
   Generic = 'debug.description',
   // Node.js-specific symbol that is used for some Node types https://nodejs.org/api/util.html#utilinspectcustom
   Node = 'nodejs.util.inspect.custom',
+
+  // Depth for `nodejs.util.inspect.custom`
+  Depth = 2,
 }
 
 /**
@@ -58,7 +61,7 @@ export const getStringyProps = templateFunction(function (
           continue;
         }
         try {
-          str = value[sym]();
+          str = value[sym](DescriptionSymbols.Depth);
           break;
         } catch {
           // ignored
@@ -101,11 +104,11 @@ export const getToStringIfCustom = templateFunction(function (
       Symbol.for(DescriptionSymbols.Generic),
       Symbol.for(DescriptionSymbols.Node),
     ]) {
-      if (typeof (this as Record<symbol, () => string>)[sym] !== 'function') {
+      if (typeof (this as Record<symbol, (depth?: number) => string>)[sym] !== 'function') {
         continue;
       }
       try {
-        str = (this as Record<symbol, () => string>)[sym]();
+        str = (this as Record<symbol, (depth?: number) => string>)[sym](DescriptionSymbols.Depth);
         break;
       } catch {
         // ignored

src/test/console/console-format-popular-types.txt

@@ -366,11 +366,11 @@ Evaluating: 'console.log([new class { [Symbol.for("debug.description")]() { retu
 stdout> (1) [{…}]
 stdout> > (1) [{…}]
 
-Evaluating: 'console.log(new class { [Symbol.for("nodejs.util.inspect.custom")]() { return "some node repr" } })'
+Evaluating: 'console.log(new class { [Symbol.for("nodejs.util.inspect.custom")](depth) { return "some node repr, depth: " + depth } })'
 stdout> {}
-stdout> > some node repr
+stdout> > some node repr, depth: 2
 
-Evaluating: 'console.log([new class { [Symbol.for("nodejs.util.inspect.custom")]() { return "some node repr" } }])'
+Evaluating: 'console.log([new class { [Symbol.for("nodejs.util.inspect.custom")](depth) { return "some node repr, depth: " + depth } }])'
 stdout> (1) [{…}]
 stdout> > (1) [{…}]
 

src/test/console/consoleFormatTest.ts

@@ -157,7 +157,7 @@ describe('console format', () => {
       'new class { toString() { return "custom to string" } }',
       'new class { toString() { return "long custom to string".repeat(500) } }',
       'new class { [Symbol.for("debug.description")]() { return "some custom repr" } }',
-      'new class { [Symbol.for("nodejs.util.inspect.custom")]() { return "some node repr" } }',
+      'new class { [Symbol.for("nodejs.util.inspect.custom")](depth) { return "some node repr, depth: " + depth } }',
     ];
     const expressions = variables.map(v => [`console.log(${v})`, `console.log([${v}])`]);
     await p.logger.evaluateAndLog(([] as string[]).concat(...expressions), { depth: 0 });