Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 751adb9

Browse filesBrowse files
Arul1998dgp1130
Arul1998
authored and
dgp1130
committed
fix(@angular/build): remap metafile paths when workspace root is a symlink or junction
esbuild always resolves its working directory through symbolic links and Windows directory junctions, so when preserveSymlinks is enabled the metafile paths are relative to a different base than the workspace root. This caused initial file detection to silently fail and index.html to be generated without script tags. The metafile paths are now remapped to be relative to the workspace root. Fixes #32306
1 parent 9671cc6 commit 751adb9
Copy full SHA for 751adb9

3 files changed

+180-1Lines changed: 180 additions & 1 deletion

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎packages/angular/build/BUILD.bazel‎

Copy file name to clipboardExpand all lines: packages/angular/build/BUILD.bazel
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@ ts_project(
148148
":node_modules/@babel/core",
149149
"//:node_modules/@angular/compiler-cli",
150150
"//:node_modules/@types/jasmine",
151+
"//:node_modules/esbuild",
151152
"//:node_modules/prettier",
152153
"//:node_modules/typescript",
153154
"//packages/angular/build/private",
Collapse file

‎packages/angular/build/src/tools/esbuild/bundler-context.ts‎

Copy file name to clipboardExpand all lines: packages/angular/build/src/tools/esbuild/bundler-context.ts
+80-1Lines changed: 80 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ import {
1717
context,
1818
} from 'esbuild';
1919
import assert from 'node:assert';
20-
import { basename, extname, join, relative } from 'node:path';
20+
import { realpathSync } from 'node:fs';
21+
import { basename, extname, join, relative, resolve } from 'node:path';
22+
import { toPosixPath } from '../../utils/path';
2123
import { SERVER_GENERATED_EXTERNALS } from '../../utils/server-rendering/manifest';
2224
import {
2325
type BuildOutputFile,
@@ -64,6 +66,7 @@ export class BundlerContext {
6466
#optionsFactory: BundlerOptionsFactory<BuildOptions & { metafile: true; write: false }>;
6567
#shouldCacheResult: boolean;
6668
#loadCache?: MemoryLoadResultCache;
69+
#realWorkspaceRoot?: string;
6770
readonly watchFiles = new Set<string>();
6871

6972
constructor(
@@ -261,6 +264,17 @@ export class BundlerContext {
261264
}
262265
}
263266

267+
// esbuild always resolves its working directory through symbolic links (including
268+
// Windows directory junctions) and generates metafile paths relative to the resolved
269+
// path. When `preserveSymlinks` is enabled, the workspace root is intentionally not
270+
// resolved, and the metafile paths are then relative to a different base directory.
271+
// The paths are remapped so that all downstream consumers can rely on the documented
272+
// invariant that metafile paths are relative to the workspace root.
273+
this.#realWorkspaceRoot ??= realpathSync(this.workspaceRoot);
274+
if (this.#realWorkspaceRoot !== this.workspaceRoot) {
275+
remapMetafileBasePath(result.metafile, this.#realWorkspaceRoot, this.workspaceRoot);
276+
}
277+
264278
// Update files that should be watched.
265279
// While this should technically not be linked to incremental mode, incremental is only
266280
// currently enabled with watch mode where watch files are needed.
@@ -487,6 +501,71 @@ export class BundlerContext {
487501
}
488502
}
489503

504+
/**
505+
* Remaps all relative paths within an esbuild metafile from one base directory to another.
506+
* Virtual files (e.g., `angular:` namespaced or bundler generated), external imports, and
507+
* non-relative paths are left unmodified.
508+
*
509+
* @param metafile The metafile to update in place.
510+
* @param fromBase The absolute base directory the metafile paths are currently relative to.
511+
* @param toBase The absolute base directory the metafile paths should be made relative to.
512+
*/
513+
export function remapMetafileBasePath(metafile: Metafile, fromBase: string, toBase: string): void {
514+
const remapped = new Map<string, string>();
515+
const remap = (value: string): string => {
516+
// Skip virtual files and paths with a scheme-like or namespace prefix (e.g., `angular:`)
517+
if (
518+
isInternalAngularFile(value) ||
519+
isInternalBundlerFile(value) ||
520+
/^[^\\/.]{2,}:/.test(value)
521+
) {
522+
return value;
523+
}
524+
525+
let result = remapped.get(value);
526+
if (result === undefined) {
527+
// esbuild metafile paths always use POSIX path separators
528+
result = toPosixPath(relative(toBase, resolve(fromBase, value)));
529+
remapped.set(value, result);
530+
}
531+
532+
return result;
533+
};
534+
535+
const inputs: Metafile['inputs'] = {};
536+
for (const [key, value] of Object.entries(metafile.inputs)) {
537+
for (const importRecord of value.imports) {
538+
if (!importRecord.external) {
539+
importRecord.path = remap(importRecord.path);
540+
}
541+
}
542+
inputs[remap(key)] = value;
543+
}
544+
metafile.inputs = inputs;
545+
546+
const outputs: Metafile['outputs'] = {};
547+
for (const [key, value] of Object.entries(metafile.outputs)) {
548+
if (value.entryPoint !== undefined) {
549+
value.entryPoint = remap(value.entryPoint);
550+
}
551+
if (value.cssBundle !== undefined) {
552+
value.cssBundle = remap(value.cssBundle);
553+
}
554+
for (const importRecord of value.imports) {
555+
if (!importRecord.external) {
556+
importRecord.path = remap(importRecord.path);
557+
}
558+
}
559+
const outputInputs: (typeof value)['inputs'] = {};
560+
for (const [inputKey, inputValue] of Object.entries(value.inputs)) {
561+
outputInputs[remap(inputKey)] = inputValue;
562+
}
563+
value.inputs = outputInputs;
564+
outputs[remap(key)] = value;
565+
}
566+
metafile.outputs = outputs;
567+
}
568+
490569
function isInternalAngularFile(file: string) {
491570
return file.startsWith('angular:');
492571
}
Collapse file

‎packages/angular/build/src/tools/esbuild/bundler-context_spec.ts‎

Copy file name to clipboard
+99Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
/**
2+
* @license
3+
* Copyright Google LLC All Rights Reserved.
4+
*
5+
* Use of this source code is governed by an MIT-style license that can be
6+
* found in the LICENSE file at https://angular.dev/license
7+
*/
8+
9+
import type { Metafile } from 'esbuild';
10+
import { join, relative } from 'node:path';
11+
import { remapMetafileBasePath } from './bundler-context';
12+
13+
describe('remapMetafileBasePath', () => {
14+
// Simulates a workspace root accessed through a symbolic link or Windows
15+
// directory junction (`toBase`) that resolves to a different real path
16+
// (`fromBase`), as esbuild resolves its working directory through links.
17+
const fromBase = join('/real', 'projects', 'demo');
18+
const toBase = join('/linked', 'demo');
19+
20+
/** Creates a metafile path as esbuild would: relative to the resolved (real) base. */
21+
const fromBaseRelative = (filePath: string): string => relative(fromBase, join(toBase, filePath));
22+
23+
it('remaps input and output paths onto the target base directory', () => {
24+
const metafile: Metafile = {
25+
inputs: {
26+
[fromBaseRelative('src/main.ts')]: { bytes: 10, imports: [] },
27+
},
28+
outputs: {
29+
[fromBaseRelative('main.js')]: {
30+
bytes: 100,
31+
inputs: { [fromBaseRelative('src/main.ts')]: { bytesInOutput: 10 } },
32+
imports: [{ path: fromBaseRelative('chunk-ABC.js'), kind: 'import-statement' }],
33+
exports: [],
34+
entryPoint: fromBaseRelative('src/main.ts'),
35+
cssBundle: fromBaseRelative('main.css'),
36+
},
37+
},
38+
};
39+
40+
remapMetafileBasePath(metafile, fromBase, toBase);
41+
42+
expect(Object.keys(metafile.inputs)).toEqual(['src/main.ts']);
43+
expect(Object.keys(metafile.outputs)).toEqual(['main.js']);
44+
45+
const output = metafile.outputs['main.js'];
46+
expect(output.entryPoint).toBe('src/main.ts');
47+
expect(output.cssBundle).toBe('main.css');
48+
expect(Object.keys(output.inputs)).toEqual(['src/main.ts']);
49+
expect(output.imports[0].path).toBe('chunk-ABC.js');
50+
});
51+
52+
it('does not modify virtual and namespaced files', () => {
53+
const metafile: Metafile = {
54+
inputs: {
55+
'angular:polyfills': {
56+
bytes: 10,
57+
imports: [{ path: '<runtime>', kind: 'import-statement' }],
58+
},
59+
},
60+
outputs: {
61+
[fromBaseRelative('polyfills.js')]: {
62+
bytes: 100,
63+
inputs: { 'angular:polyfills': { bytesInOutput: 10 } },
64+
imports: [],
65+
exports: [],
66+
entryPoint: 'angular:polyfills',
67+
},
68+
},
69+
};
70+
71+
remapMetafileBasePath(metafile, fromBase, toBase);
72+
73+
expect(Object.keys(metafile.inputs)).toEqual(['angular:polyfills']);
74+
expect(metafile.inputs['angular:polyfills'].imports[0].path).toBe('<runtime>');
75+
76+
const output = metafile.outputs['polyfills.js'];
77+
expect(output.entryPoint).toBe('angular:polyfills');
78+
expect(Object.keys(output.inputs)).toEqual(['angular:polyfills']);
79+
});
80+
81+
it('does not modify external imports', () => {
82+
const externalPath = 'https://example.com/module.js';
83+
const metafile: Metafile = {
84+
inputs: {},
85+
outputs: {
86+
[fromBaseRelative('main.js')]: {
87+
bytes: 100,
88+
inputs: {},
89+
imports: [{ path: externalPath, kind: 'import-statement', external: true }],
90+
exports: [],
91+
},
92+
},
93+
};
94+
95+
remapMetafileBasePath(metafile, fromBase, toBase);
96+
97+
expect(metafile.outputs['main.js'].imports[0].path).toBe(externalPath);
98+
});
99+
});

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.