fix: support webpack publicPath: 'auto' (#312)

* fix: ignore webpack `publicPath: 'auto'` when generating manifest paths\n\nTreat 'auto' as runtime-resolved publicPath so we don’t serialize it into the manifest. Adds a unit test covering the behavior.\n\nRefs #307

* test: port two 'publicPath: auto' cases from #308 (credit @chouchouji)\n\n- publicPath 'auto' + basePath still prefixes manifest keys\n- publicPath 'auto' + plugin publicPath override applies to values\n\nRefs #307

---------

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

Author: charliecreates[bot]

src/hooks.ts

@@ -80,7 +80,13 @@ const emitHook = function emit(
     publicPath: true
   });
 
-  const publicPath = options.publicPath !== null ? options.publicPath : stats.publicPath;
+  // Webpack v5 supports `output.publicPath: 'auto'`, which resolves the publicPath
+  // at runtime based on the current script/asset location. In that mode, the
+  // string value 'auto' should not be serialized into the manifest. Treat it as
+  // an "unset" publicPath so manifest values remain unprefixed and consumers can
+  // resolve at runtime. See https://webpack.js.org/guides/public-path/#automatic-publicpath
+  const resolvedPublicPath = options.publicPath !== null ? options.publicPath : stats.publicPath;
+  const publicPath = resolvedPublicPath === 'auto' ? '' : resolvedPublicPath;
   const { basePath, removeKeyHash } = options;
 
   emitCountMap.set(manifestFileName, emitCount);

test/unit/paths.ts

@@ -72,6 +72,70 @@ test('prefixes paths with a public path', async (t) => {
   });
 });
 
+test("does not prefix paths when webpack's publicPath is 'auto'", async (t) => {
+  const config = {
+    context: __dirname,
+    entry: {
+      one: '../fixtures/file.js'
+    },
+    output: {
+      filename: `[name].${hashLiteral}.js`,
+      path: join(outputPath, 'public-auto'),
+      // Webpack will resolve the publicPath at runtime; the manifest should not contain 'auto'.
+      publicPath: 'auto'
+    }
+  } as any;
+  const { manifest, stats } = await compile(config, t);
+
+  t.deepEqual(manifest, {
+    'one.js': `one.${(stats as any).hash}.js`
+  });
+});
+
+test("prefixes definitions with a base path when webpack's publicPath is 'auto'", async (t) => {
+  const config = {
+    context: __dirname,
+    entry: {
+      one: '../fixtures/file.js'
+    },
+    output: {
+      filename: `[name].${hashLiteral}.js`,
+      path: join(outputPath, 'public-auto-with-basePath'),
+      publicPath: 'auto'
+    }
+  } as any;
+
+  const { manifest, stats } = await compile(config, t, {
+    basePath: '/app/'
+  });
+
+  t.deepEqual(manifest, {
+    '/app/one.js': `one.${(stats as any).hash}.js`
+  });
+});
+
+test("uses plugin 'publicPath' override when webpack's publicPath is 'auto'", async (t) => {
+  const config = {
+    context: __dirname,
+    entry: {
+      one: '../fixtures/file.js'
+    },
+    output: {
+      filename: `[name].${hashLiteral}.js`,
+      path: join(outputPath, 'public-auto-with-override'),
+      publicPath: 'auto'
+    }
+  } as any;
+
+  const { manifest, stats } = await compile(config, t, {
+    publicPath: '/cdn/'
+  });
+
+  t.deepEqual(manifest, {
+    'one.js': `/cdn/one.${(stats as any).hash}.js`
+  });
+});
+
 test(`prefixes paths with a public path and handle ${hashLiteral} from public path`, async (t) => {
   const config = {
     context: __dirname,