Skip to content

Commit 6392018

Browse files
committed
perf(@angular/build): reuse precomputed hash for in-memory build asset ETags
Reuse the precomputed outputFile.hash on in-memory ResultFile entries in createBuildAssetsMiddleware instead of recomputing a SHA256 digest on every HTTP request.
1 parent cf88074 commit 6392018

2 files changed

Lines changed: 164 additions & 1 deletion

File tree

‎packages/angular/build/src/tools/vite/middlewares/assets-middleware.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,8 +237,9 @@ export function createBuildAssetsMiddleware(
237237
if (outputFile) {
238238
const contents =
239239
outputFile.origin === 'memory' ? outputFile.contents : readHandler(outputFile.source);
240+
const hash = outputFile.origin === 'memory' ? outputFile.hash : calculateHash(contents);
240241

241-
const etag = `W/"${calculateHash(contents)}"`;
242+
const etag = `W/"${hash}"`;
242243
if (checkAndHandleEtag(req, res, etag)) {
243244
return;
244245
}
Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
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 { IncomingMessage, ServerResponse } from 'node:http';
10+
import type { ResultFile } from '../../../builders/application/results';
11+
import { calculateHash, initializeHash } from '../../../utils/hash';
12+
import { BuildOutputFileType } from '../../esbuild/bundler-files';
13+
import { createBuildAssetsMiddleware } from './assets-middleware';
14+
15+
describe('createBuildAssetsMiddleware', () => {
16+
beforeAll(async () => {
17+
await initializeHash();
18+
});
19+
20+
function createMockReqRes(
21+
url: string,
22+
headers: Record<string, string> = {},
23+
): {
24+
req: IncomingMessage;
25+
res: ServerResponse & { setHeader: jasmine.Spy; end: jasmine.Spy };
26+
} {
27+
const req = {
28+
url,
29+
method: 'GET',
30+
headers,
31+
} as unknown as IncomingMessage;
32+
33+
const res = {
34+
statusCode: 200,
35+
writableEnded: false,
36+
setHeader: jasmine.createSpy('setHeader'),
37+
end: jasmine.createSpy('end'),
38+
} as unknown as ServerResponse & { setHeader: jasmine.Spy; end: jasmine.Spy };
39+
40+
return { req, res };
41+
}
42+
43+
it('uses precomputed outputFile.hash for memory files instead of recalculating hash', () => {
44+
const contents = new TextEncoder().encode('body { color: red; }');
45+
const precomputedHash = 'precomputed-memory-hash';
46+
const buildResultFiles = new Map<string, ResultFile>([
47+
[
48+
'styles.css',
49+
{
50+
origin: 'memory',
51+
path: 'styles.css',
52+
contents,
53+
hash: precomputedHash,
54+
type: BuildOutputFileType.Browser,
55+
},
56+
],
57+
]);
58+
59+
const readHandler = jasmine.createSpy('readHandler');
60+
const middleware = createBuildAssetsMiddleware('/', buildResultFiles, readHandler);
61+
const { req, res } = createMockReqRes('/styles.css');
62+
const next = jasmine.createSpy('next');
63+
64+
middleware(req, res, next);
65+
66+
expect(next).not.toHaveBeenCalled();
67+
expect(readHandler).not.toHaveBeenCalled();
68+
expect(res.setHeader).toHaveBeenCalledWith('Content-Type', 'text/css');
69+
expect(res.setHeader).toHaveBeenCalledWith('ETag', `W/"${precomputedHash}"`);
70+
expect(res.setHeader).toHaveBeenCalledWith('Cache-Control', 'no-cache');
71+
expect(res.end).toHaveBeenCalledWith(contents);
72+
});
73+
74+
it('returns 304 for memory files when If-None-Match matches precomputed outputFile.hash', () => {
75+
const contents = new TextEncoder().encode('body { color: red; }');
76+
const precomputedHash = 'precomputed-memory-hash';
77+
const buildResultFiles = new Map<string, ResultFile>([
78+
[
79+
'styles.css',
80+
{
81+
origin: 'memory',
82+
path: 'styles.css',
83+
contents,
84+
hash: precomputedHash,
85+
type: BuildOutputFileType.Browser,
86+
},
87+
],
88+
]);
89+
90+
const middleware = createBuildAssetsMiddleware('/', buildResultFiles);
91+
const { req, res } = createMockReqRes('/styles.css', {
92+
'if-none-match': `W/"${precomputedHash}"`,
93+
});
94+
const next = jasmine.createSpy('next');
95+
96+
middleware(req, res, next);
97+
98+
expect(next).not.toHaveBeenCalled();
99+
expect(res.statusCode).toBe(304);
100+
expect(res.end).toHaveBeenCalledWith();
101+
});
102+
103+
it('calculates hash from disk contents when outputFile.origin is disk', () => {
104+
const diskBuffer = Buffer.from('console.log("asset");', 'utf-8');
105+
const expectedHash = calculateHash(diskBuffer);
106+
const buildResultFiles = new Map<string, ResultFile>([
107+
[
108+
'assets/data.json',
109+
{
110+
origin: 'disk',
111+
path: 'assets/data.json',
112+
source: '/workspace/src/assets/data.json',
113+
type: BuildOutputFileType.Browser,
114+
},
115+
],
116+
]);
117+
118+
const readHandler = jasmine.createSpy('readHandler').and.returnValue(diskBuffer);
119+
const middleware = createBuildAssetsMiddleware('/', buildResultFiles, readHandler);
120+
const { req, res } = createMockReqRes('/assets/data.json');
121+
const next = jasmine.createSpy('next');
122+
123+
middleware(req, res, next);
124+
125+
expect(next).not.toHaveBeenCalled();
126+
expect(readHandler).toHaveBeenCalledOnceWith('/workspace/src/assets/data.json');
127+
expect(res.setHeader).toHaveBeenCalledWith('Content-Type', 'application/json');
128+
expect(res.setHeader).toHaveBeenCalledWith('ETag', `W/"${expectedHash}"`);
129+
expect(res.setHeader).toHaveBeenCalledWith('Cache-Control', 'no-cache');
130+
expect(res.end).toHaveBeenCalledWith(diskBuffer);
131+
});
132+
133+
it('returns 304 for disk files when If-None-Match matches calculated hash', () => {
134+
const diskBuffer = Buffer.from('{"ok":true}', 'utf-8');
135+
const expectedHash = calculateHash(diskBuffer);
136+
const buildResultFiles = new Map<string, ResultFile>([
137+
[
138+
'assets/data.json',
139+
{
140+
origin: 'disk',
141+
path: 'assets/data.json',
142+
source: '/workspace/src/assets/data.json',
143+
type: BuildOutputFileType.Browser,
144+
},
145+
],
146+
]);
147+
148+
const readHandler = jasmine.createSpy('readHandler').and.returnValue(diskBuffer);
149+
const middleware = createBuildAssetsMiddleware('/', buildResultFiles, readHandler);
150+
const { req, res } = createMockReqRes('/assets/data.json', {
151+
'if-none-match': `W/"${expectedHash}"`,
152+
});
153+
const next = jasmine.createSpy('next');
154+
155+
middleware(req, res, next);
156+
157+
expect(next).not.toHaveBeenCalled();
158+
expect(readHandler).toHaveBeenCalledOnceWith('/workspace/src/assets/data.json');
159+
expect(res.statusCode).toBe(304);
160+
expect(res.end).toHaveBeenCalledWith();
161+
});
162+
});

0 commit comments

Comments
 (0)