Skip to content

Commit 23878ff

Browse files
clydinclydin
committed
refactor(@angular/build): use translation integrity for i18n inlining cache keys
Avoid full JSON serialization and hashing of the in-memory translation dictionary for each locale when computing persistent cache keys. Instead, use the combined translation file integrity hashes and the installed `@angular/localize` package version when available, falling back to the in-memory translation object if integrity is absent.
1 parent 359d09c commit 23878ff

4 files changed

Lines changed: 68 additions & 2 deletions

File tree

‎packages/angular/build/src/builders/application/i18n.ts‎

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88

99
import { BuilderContext } from '@angular-devkit/architect';
1010
import type { Metafile } from 'esbuild';
11+
import { readFile } from 'node:fs/promises';
1112
import { join } from 'node:path';
1213
import {
1314
ExecutionResult,
@@ -18,6 +19,7 @@ import { I18nInliner } from '../../tools/esbuild/i18n-inliner';
1819
import { maxWorkers } from '../../utils/environment-options';
1920
import { loadTranslations } from '../../utils/i18n-options';
2021
import { createTranslationLoader } from '../../utils/load-translations';
22+
import { createProjectResolver } from '../../utils/resolve-project';
2123
import { executePostBundleSteps } from './execute-post-bundle';
2224
import { NormalizedApplicationBuildOptions, getLocaleBaseHref } from './options';
2325

@@ -48,6 +50,7 @@ export async function inlineI18n(
4850
outputFiles: executionResult.outputFiles,
4951
shouldOptimize: optimizationOptions.scripts,
5052
persistentCachePath: cacheOptions.enabled ? cacheOptions.path : undefined,
53+
localizeVersion: i18nOptions.localizeVersion,
5154
},
5255
maxWorkers,
5356
);
@@ -72,10 +75,21 @@ export async function inlineI18n(
7275

7376
try {
7477
for (const locale of i18nOptions.inlineLocales) {
78+
const localeDescription = i18nOptions.locales[locale];
79+
let translationIntegrity: string | undefined = '';
80+
for (const file of localeDescription.files) {
81+
if (!file.integrity) {
82+
translationIntegrity = undefined;
83+
break;
84+
}
85+
translationIntegrity += (translationIntegrity ? '|' : '') + file.integrity;
86+
}
87+
7588
// A locale specific set of files is returned from the inliner.
7689
const localeInlineResult = await inliner.inlineForLocale(
7790
locale,
78-
i18nOptions.locales[locale].translation,
91+
localeDescription.translation,
92+
translationIntegrity,
7993
);
8094
const localeOutputFiles = localeInlineResult.outputFiles;
8195
inlineResult.errors.push(...localeInlineResult.errors);
@@ -176,6 +190,15 @@ export async function loadActiveTranslations(
176190
context: BuilderContext,
177191
i18n: NormalizedApplicationBuildOptions['i18nOptions'],
178192
) {
193+
if (!i18n.localizeVersion) {
194+
try {
195+
const projectResolve = createProjectResolver(context.workspaceRoot);
196+
const manifestPath = projectResolve('@angular/localize/package.json');
197+
const manifest = JSON.parse(await readFile(manifestPath, 'utf-8')) as { version?: string };
198+
i18n.localizeVersion = manifest.version;
199+
} catch {}
200+
}
201+
179202
// Load locale data and translations (if present)
180203
let loader;
181204
for (const [locale, desc] of Object.entries(i18n.locales)) {

‎packages/angular/build/src/tools/esbuild/i18n-inliner.ts‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ export interface I18nInlinerOptions {
4242
outputFiles: BuildOutputFile[];
4343
shouldOptimize?: boolean;
4444
persistentCachePath?: string;
45+
localizeVersion?: string;
4546
}
4647

4748
/**
@@ -131,11 +132,13 @@ export class I18nInliner {
131132
* of the localize function keyword.
132133
* @param locale The string representing the locale to inline.
133134
* @param translation The translation messages to use when inlining.
135+
* @param translationIntegrity An optional integrity value for the translation messages to use for caching.
134136
* @returns A promise that resolves to an array of OutputFiles representing a translated result.
135137
*/
136138
async inlineForLocale(
137139
locale: string,
138140
translation: Record<string, unknown> | undefined,
141+
translationIntegrity?: string,
139142
): Promise<{ outputFiles: BuildOutputFile[]; errors: string[]; warnings: string[] }> {
140143
await this.initCache();
141144

@@ -161,7 +164,13 @@ export class I18nInliner {
161164
// of bytes. Hashing the options directly would re-hash the full set of messages, which
162165
// can be several megabytes, once for every file.
163166
fileCacheKeyBase ??= calculateHash(
164-
JSON.stringify({ locale, translation, missingTranslation, shouldOptimize }),
167+
JSON.stringify({
168+
locale,
169+
translation: translationIntegrity ?? translation,
170+
missingTranslation,
171+
shouldOptimize,
172+
localizeVersion: this.options.localizeVersion,
173+
}),
165174
);
166175

167176
// NOTE: If additional options are added, this may need to be updated.

‎packages/angular/build/src/tools/esbuild/i18n-inliner_spec.ts‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -307,4 +307,37 @@ describe('I18nInliner', () => {
307307
'Malformed escape sequence in $localize template literal in file "main.js".',
308308
]);
309309
});
310+
311+
it('inlines the translations of a locale when translationIntegrity is provided', async () => {
312+
const { outputFiles, errors, warnings } = await createInliner([
313+
browserFile('main.js', GREETING_SOURCE),
314+
]).inlineForLocale('fr', { greeting: translationFor('Bonjour') }, 'sha256-test-integrity');
315+
316+
expect(errors).toEqual([]);
317+
expect(warnings).toEqual([]);
318+
expect(findFile(outputFiles, 'main.js').text).toContain('"Bonjour"');
319+
expect(findFile(outputFiles, 'main.js').text).not.toContain('$localize');
320+
});
321+
322+
it('inlines the translations of a locale when localizeVersion is configured in options', async () => {
323+
inliner = new I18nInliner(
324+
{
325+
missingTranslation: 'warning',
326+
outputFiles: [browserFile('main.js', GREETING_SOURCE)],
327+
localizeVersion: '20.2.0',
328+
},
329+
1,
330+
);
331+
332+
const { outputFiles, errors, warnings } = await inliner.inlineForLocale(
333+
'fr',
334+
{ greeting: translationFor('Bonjour') },
335+
'sha256-test-integrity',
336+
);
337+
338+
expect(errors).toEqual([]);
339+
expect(warnings).toEqual([]);
340+
expect(findFile(outputFiles, 'main.js').text).toContain('"Bonjour"');
341+
expect(findFile(outputFiles, 'main.js').text).not.toContain('$localize');
342+
});
310343
});

‎packages/angular/build/src/utils/i18n-options.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ export interface I18nOptions {
2828
flatOutput?: boolean;
2929
readonly shouldInline: boolean;
3030
hasDefinedSourceLocale?: boolean;
31+
localizeVersion?: string;
3132
}
3233

3334
function normalizeTranslationFileOption(

0 commit comments

Comments
 (0)