Merge pull request #1707 from embroider-build/better-logging

improved resolver logging
embroider-build · Dec 6, 2023 · b446d89 · b446d89
2 parents 996b2ff + 76d22a8
commit b446d89
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 7 deletions.
diff --git a/packages/core/src/module-resolver.ts b/packages/core/src/module-resolver.ts
@@ -28,26 +28,45 @@ import { readFileSync } from 'fs';
 import type UserOptions from './options';
 
 const debug = makeDebug('embroider:resolver');
+
+// Using a formatter makes this work lazy so nothing happens when we aren't
+// logging. It is unfortunate that formatters are a globally mutable config and
+// you can only use single character names, but oh well.
+makeDebug.formatters.p = (s: string) => {
+  let cwd = process.cwd();
+  if (s.startsWith(cwd)) {
+    return s.slice(cwd.length + 1);
+  }
+  return s;
+};
+
 function logTransition<R extends ModuleRequest>(reason: string, before: R, after: R = before): R {
   if (after.isVirtual) {
-    debug(`virtualized %s in %s because %s`, before.specifier, before.fromFile, reason);
+    debug(`[%s:virtualized] %s because %s\n  in    %p`, before.debugType, before.specifier, reason, before.fromFile);
   } else if (before.specifier !== after.specifier) {
     if (before.fromFile !== after.fromFile) {
       debug(
-        `aliased and rehomed: %s to %s, from %s to %s because %s`,
+        `[%s:aliased and rehomed] %s to %s\n  because %s\n  from    %p\n  to      %p`,
+        before.debugType,
         before.specifier,
         after.specifier,
+        reason,
         before.fromFile,
-        after.fromFile,
-        reason
+        after.fromFile
       );
     } else {
-      debug(`aliased: %s to %s in %s because`, before.specifier, after.specifier, before.fromFile, reason);
+      debug(`[%s:aliased] %s to %s\n  because %s`, before.debugType, before.specifier, after.specifier, reason);
     }
   } else if (before.fromFile !== after.fromFile) {
-    debug(`rehomed: %s from %s to %s because`, before.specifier, before.fromFile, after.fromFile, reason);
+    debug(
+      `[%s:rehomed] because %s\n  from    %p\n  to      %p`,
+      before.debugType,
+      reason,
+      before.fromFile,
+      after.fromFile
+    );
   } else {
-    debug(`unchanged: %s in %s because %s`, before.specifier, before.fromFile, reason);
+    debug(`[%s:unchanged] %s because %s\n  in    %p`, before.debugType, before.specifier, reason, before.fromFile);
   }
   return after;
 }
@@ -117,6 +136,7 @@ export interface ModuleRequest {
   readonly fromFile: string;
   readonly isVirtual: boolean;
   readonly meta: Record<string, unknown> | undefined;
+  readonly debugType: string;
   alias(newSpecifier: string): this;
   rehome(newFromFile: string): this;
   virtualize(virtualFilename: string): this;
@@ -130,6 +150,11 @@ class NodeModuleRequest implements ModuleRequest {
     readonly isVirtual: boolean,
     readonly meta: Record<string, any> | undefined
   ) {}
+
+  get debugType() {
+    return 'node';
+  }
+
   alias(specifier: string): this {
     return new NodeModuleRequest(specifier, this.fromFile, false, this.meta) as this;
   }

diff --git a/packages/vite/src/esbuild-request.ts b/packages/vite/src/esbuild-request.ts
@@ -25,6 +25,10 @@ export class EsBuildModuleRequest implements ModuleRequest {
     readonly isVirtual: boolean
   ) {}
 
+  get debugType() {
+    return 'esbuild';
+  }
+
   alias(newSpecifier: string) {
     return new EsBuildModuleRequest(newSpecifier, this.fromFile, this.meta, this.isVirtual) as this;
   }

diff --git a/packages/vite/src/request.ts b/packages/vite/src/request.ts
@@ -36,6 +36,10 @@ export class RollupModuleRequest implements ModuleRequest {
     readonly meta: Record<string, any> | undefined
   ) {}
 
+  get debugType() {
+    return 'rollup';
+  }
+
   get isVirtual(): boolean {
     return this.specifier.startsWith(virtualPrefix);
   }

diff --git a/packages/webpack/src/webpack-resolver-plugin.ts b/packages/webpack/src/webpack-resolver-plugin.ts
@@ -157,6 +157,10 @@ class WebpackModuleRequest implements ModuleRequest {
     this.meta = state.contextInfo._embroiderMeta ? { ...state.contextInfo._embroiderMeta } : undefined;
   }
 
+  get debugType() {
+    return 'webpack';
+  }
+
   alias(newSpecifier: string) {
     this.state.request = newSpecifier;
     return new WebpackModuleRequest(this.babelLoaderPrefix, this.appRoot, this.state) as this;