fix(@angular/build): serialize server manifest asset paths

Serialize route-derived asset keys, base paths, hashes, and App Engine entry points before embedding them in executable ESM manifests.

Generate bounded ASCII asset chunk names with a path digest so filesystem-sensitive and URL-significant characters remain filename data without creating chunk-name collisions. Add focused manifest coverage and exercise an apostrophe-bearing prerender route end to end.

Author: SkyZeroZx

packages/angular/build/src/utils/server-rendering/manifest.ts

@@ -15,6 +15,7 @@ import {
   BuildOutputFileType,
   createOutputFile,
 } from '../../tools/esbuild/bundler-files';
+import { calculateHash } from '../hash';
 
 export const SERVER_APP_MANIFEST_FILENAME = 'angular-app-manifest.mjs';
 export const SERVER_APP_ENGINE_MANIFEST_FILENAME = 'angular-app-engine-manifest.mjs';
@@ -60,6 +61,37 @@ function escapeUnsafeChars(str: string): string {
   return str.replace(/[$`\\]/g, (c) => UNSAFE_CHAR_MAP[c]);
 }
 
+/**
+ * Matches every character which is not safe in the name of a generated server asset chunk.
+ */
+const UNSAFE_CHUNK_NAME_CHARACTER_REGEXP = /[^a-zA-Z0-9_-]/g;
+
+/**
+ * The maximum number of characters of an asset path kept in the name of its generated chunk.
+ * The appended digest is what makes the name unique, so the readable part can be truncated to
+ * stay well within the file name length limits of all supported platforms.
+ */
+const MAX_CHUNK_NAME_LENGTH = 128;
+
+/**
+ * Builds the path of the generated chunk which holds the content of a server asset.
+ *
+ * Asset paths are derived from route paths and can therefore contain characters which are unusable
+ * in a file name (`?`, `:` and `*` are invalid on Windows) or which change how the generated
+ * dynamic import is resolved (`?`, `#` and `%` are URL syntax). Those characters are replaced, and
+ * a digest of the asset path is appended so that two asset paths never share a chunk.
+ *
+ * @param assetPath - The path of the asset, for example `store/summer sale/index.html`.
+ * @returns The path of the chunk to generate for the asset.
+ */
+function generateServerAssetChunkPath(assetPath: string): string {
+  const name = assetPath
+    .replace(UNSAFE_CHUNK_NAME_CHARACTER_REGEXP, '_')
+    .slice(0, MAX_CHUNK_NAME_LENGTH);
+
+  return `assets-chunks/${name}-${calculateHash(assetPath)}.mjs`;
+}
+
 /**
  * Generates the server manifest for the App Engine environment.
  *
@@ -85,7 +117,7 @@ export function generateAngularServerAppEngineManifest(
     for (const locale of i18nOptions.inlineLocales) {
       const { subPath } = i18nOptions.locales[locale];
       const importPath = `${subPath ? `${subPath}/` : ''}${MAIN_SERVER_OUTPUT_FILENAME}`;
-      entryPoints[subPath] = `() => import('./${importPath}')`;
+      entryPoints[subPath] = `() => import(${JSON.stringify(`./${importPath}`)})`;
       supportedLocales[locale] = subPath;
     }
   } else {
@@ -101,12 +133,12 @@ export function generateAngularServerAppEngineManifest(
 
   const manifestContent = `
 export default {
-  basePath: '${basePath}',
+  basePath: ${JSON.stringify(basePath)},
   allowedHosts: ${JSON.stringify(allowedHosts, undefined, 2)},
   supportedLocales: ${JSON.stringify(supportedLocales, undefined, 2)},
   entryPoints: {
     ${Object.entries(entryPoints)
-      .map(([key, value]) => `'${key}': ${value}`)
+      .map(([key, value]) => `${JSON.stringify(key)}: ${value}`)
       .join(',\n    ')}
   },
 };
@@ -163,7 +195,7 @@ export function generateAngularServerAppManifest(
   for (const file of [...additionalHtmlOutputFiles.values(), ...outputFiles]) {
     const extension = extname(file.path);
     if (extension === '.html' || (inlineCriticalCss && extension === '.css')) {
-      const jsChunkFilePath = `assets-chunks/${file.path.replace(/[./]/g, '_')}.mjs`;
+      const jsChunkFilePath = generateServerAssetChunkPath(file.path);
       const escapedContent = escapeUnsafeChars(file.text);
 
       serverAssetsChunks.push(
@@ -183,8 +215,11 @@ export function generateAngularServerAppManifest(
         pos = file.text.indexOf('\r\n', pos + 2);
       }
 
+      // Asset paths are derived from route paths and can contain arbitrary characters, so they are
+      // serialized rather than interpolated into the generated executable manifest.
       serverAssets[file.path] =
-        `{size: ${size}, hash: '${file.hash}', text: () => import('./${jsChunkFilePath}').then(m => m.default)}`;
+        `{size: ${size}, hash: ${JSON.stringify(file.hash)}, ` +
+        `text: () => import(${JSON.stringify(`./${jsChunkFilePath}`)}).then(m => m.default)}`;
     }
   }
 
@@ -197,13 +232,13 @@ export function generateAngularServerAppManifest(
 export default {
   bootstrap: () => import('./main.server.mjs').then(m => m.default),
   inlineCriticalCss: ${inlineCriticalCss},
-  baseHref: '${baseHref}',
+  baseHref: ${JSON.stringify(baseHref)},
   locale: ${JSON.stringify(locale)},
   routes: ${JSON.stringify(routes, undefined, 2)},
   entryPointToBrowserMapping: ${JSON.stringify(entryPointToBrowserMapping, undefined, 2)},
   assets: {
     ${Object.entries(serverAssets)
-      .map(([key, value]) => `'${key}': ${value}`)
+      .map(([key, value]) => `${JSON.stringify(key)}: ${value}`)
       .join(',\n    ')}
   },
 };

packages/angular/build/src/utils/server-rendering/manifest_spec.ts

@@ -0,0 +1,105 @@
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.dev/license
+ */
+
+import { BuildOutputFileType, createOutputFile } from '../../tools/esbuild/bundler-files';
+import { initializeHash } from '../hash';
+import { generateAngularServerAppManifest } from './manifest';
+
+/**
+ * Evaluates a generated manifest, which both asserts that it is syntactically valid JavaScript and
+ * gives access to the values it declares. The dynamic imports it contains are never invoked.
+ */
+function evaluateManifest(manifestContent: string): Record<string, unknown> {
+  return new Function(manifestContent.replace('export default', 'return'))() as Record<
+    string,
+    unknown
+  >;
+}
+
+function generateManifest(
+  htmlOutputFiles: Record<string, string>,
+  baseHref = '/',
+): ReturnType<typeof generateAngularServerAppManifest> {
+  const additionalHtmlOutputFiles = new Map(
+    Object.entries(htmlOutputFiles).map(([path, content]) => [
+      path,
+      createOutputFile(path, content, BuildOutputFileType.Browser),
+    ]),
+  );
+
+  return generateAngularServerAppManifest(
+    additionalHtmlOutputFiles,
+    [],
+    false,
+    undefined,
+    undefined,
+    baseHref,
+    new Set(),
+    { inputs: {}, outputs: {} },
+    undefined,
+  );
+}
+
+describe('generateAngularServerAppManifest', () => {
+  beforeAll(async () => {
+    await initializeHash();
+  });
+
+  it('serializes asset paths which contain JavaScript string delimiters', () => {
+    const assetPath = "catalog/customer's-choice/index.html";
+    const { manifestContent } = generateManifest({ [assetPath]: '<main>Featured</main>' });
+
+    const assets = evaluateManifest(manifestContent)['assets'] as Record<string, unknown>;
+    expect(Object.keys(assets)).toEqual([assetPath]);
+  });
+
+  it('serializes a base href which contains JavaScript string delimiters', () => {
+    const { manifestContent } = generateManifest({ 'index.html': '<main></main>' }, "/o'brien/");
+
+    expect(evaluateManifest(manifestContent)['baseHref']).toBe("/o'brien/");
+  });
+
+  it('generates chunk names which are usable as a file name and as a module specifier', () => {
+    const assetPath = "catalog/customer's#featured?ratio=50%/index.html";
+    const { serverAssetsChunks } = generateManifest({ [assetPath]: '<main>Featured</main>' });
+
+    expect(serverAssetsChunks).toHaveSize(1);
+    expect(serverAssetsChunks[0].path).toMatch(/^assets-chunks\/[a-zA-Z0-9_-]+\.mjs$/);
+  });
+
+  it('generates a dynamic import which resolves back to the emitted chunk', () => {
+    // The in-memory ESM loader used while prerendering resolves the specifier as a URL and looks the
+    // result up by output file path, so the two have to match exactly.
+    const assetPath = "catalog/customer's#featured?ratio=50%/index.html";
+    const { manifestContent, serverAssetsChunks } = generateManifest({
+      [assetPath]: '<main>Featured</main>',
+    });
+
+    const assets = evaluateManifest(manifestContent)['assets'] as Record<
+      string,
+      { text: () => Promise<string> }
+    >;
+    const specifier = /import\("(.+?)"\)/.exec(assets[assetPath].text.toString())?.[1];
+
+    const root = 'file:///virtual/root/';
+    expect(specifier).toBeDefined();
+    expect(new URL(specifier as string, root).href.slice(root.length)).toBe(
+      serverAssetsChunks[0].path,
+    );
+  });
+
+  it('generates a distinct chunk for asset paths which map to the same name', () => {
+    const { serverAssetsChunks } = generateManifest({
+      'foo/bar/index.html': '<main>nested</main>',
+      'foo_bar/index.html': '<main>flat</main>',
+    });
+
+    expect(serverAssetsChunks).toHaveSize(2);
+    expect(serverAssetsChunks[0].path).not.toBe(serverAssetsChunks[1].path);
+  });
+});

tests/e2e/tests/build/server-rendering/server-routes-output-mode-server.ts

@@ -77,7 +77,7 @@ export default async function () {
       path: 'ssg/:id',
       renderMode: RenderMode.Prerender,
       headers: { 'x-custom': 'ssg-with-params' },
-      getPrerenderParams: async() => [{id: 'one'}, {id: 'two'}],
+      getPrerenderParams: async() => [{id: 'one'}, {id: 'two'}, {id: "customer's-choice"}],
     },
     {
       path: 'ssr',
@@ -115,6 +115,7 @@ export default async function () {
     'ssg/index.html': 'ssg works!',
     'ssg/one/index.html': 'ssg-with-params works!',
     'ssg/two/index.html': 'ssg-with-params works!',
+    "ssg/customer's-choice/index.html": 'ssg-with-params works!',
   };
 
   for (const [filePath, fileMatch] of Object.entries(expects)) {