Skip to content

Commit 65b7a2b

Browse files
clydinclydin
committed
refactor(@angular/build): use ɵParsedTranslation in i18n inliner
Replace untyped Record<string, unknown> translation dictionaries with Record<string, ɵParsedTranslation> throughout the i18n inliner and related utilities. The SharedTranslationDictionary and createSharedTranslationProxy utilities now default to ɵParsedTranslation with generic support for custom value types in unit tests.
1 parent 5ce398f commit 65b7a2b

7 files changed

Lines changed: 55 additions & 37 deletions

File tree

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
*/
88

99
import remapping, { type DecodedSourceMap, type SourceMapInput } from '@ampproject/remapping';
10+
import type { ɵParsedTranslation } from '@angular/localize';
1011
import type { Node } from '@oxc-project/types';
1112
import { MagicString } from 'magic-string';
1213
import assert from 'node:assert';
@@ -111,7 +112,7 @@ const fileDataCache = new Map<string, Promise<CachedFileData>>();
111112
/**
112113
* Cache of deserialized translation messages keyed by locale.
113114
*/
114-
const deserializedTranslations = new Map<string, Promise<Record<string, unknown>>>();
115+
const deserializedTranslations = new Map<string, Promise<Record<string, ɵParsedTranslation>>>();
115116

116117
/**
117118
* Retrieves the file data for a filename, loading and extracting localization metadata.
@@ -159,7 +160,7 @@ function loadFileData(filename: string, cache = true): Promise<CachedFileData> {
159160
function loadTranslation(
160161
locale: string,
161162
translation?: Blob | SharedArrayBuffer,
162-
): Promise<Record<string, unknown>> | undefined {
163+
): Promise<Record<string, ɵParsedTranslation>> | undefined {
163164
if (!translation) {
164165
return undefined;
165166
}
@@ -169,7 +170,7 @@ function loadTranslation(
169170
if (translation instanceof Blob) {
170171
messagesPromise = translation
171172
.arrayBuffer()
172-
.then((buffer) => deserialize(new Uint8Array(buffer)) as Record<string, unknown>)
173+
.then((buffer) => deserialize(new Uint8Array(buffer)) as Record<string, ɵParsedTranslation>)
173174
.catch((error) => {
174175
deserializedTranslations.delete(locale);
175176
throw error;
@@ -431,7 +432,7 @@ async function inlineLocalize(
431432
map: SourceMapInput | undefined,
432433
metadata: FileLocalizeMetadata,
433434
locale: string,
434-
translation: Record<string, unknown> | undefined,
435+
translation: Record<string, ɵParsedTranslation> | undefined,
435436
filename: string,
436437
) {
437438
const magicString = new MagicString(code);

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
* found in the LICENSE file at https://angular.dev/license
77
*/
88

9+
import type { ɵParsedTranslation } from '@angular/localize';
910
import assert from 'node:assert';
1011
import { extname, join } from 'node:path';
1112
import { serialize } from 'node:v8';
@@ -38,7 +39,7 @@ const DEFAULT_LOCALE_WINDOW_SIZE = 8;
3839
* @returns A SharedArrayBuffer or Blob containing the serialized messages, or undefined if none.
3940
*/
4041
function serializeTranslation(
41-
translation: Record<string, unknown> | undefined,
42+
translation: Record<string, ɵParsedTranslation> | undefined,
4243
): SharedArrayBuffer | Blob | undefined {
4344
if (!translation) {
4445
return undefined;
@@ -73,7 +74,7 @@ export interface LocaleInlineOptions {
7374
/**
7475
* The translation messages for the locale, or undefined for the source/untranslated locale.
7576
*/
76-
translation?: Record<string, unknown>;
77+
translation?: Record<string, ɵParsedTranslation>;
7778

7879
/**
7980
* An optional content integrity hash of the translation file(s) for fast cache key calculation.
@@ -470,7 +471,7 @@ export class I18nInliner {
470471
*/
471472
async inlineForLocale(
472473
locale: string,
473-
translation: Record<string, unknown> | undefined,
474+
translation: Record<string, ɵParsedTranslation> | undefined,
474475
translationIntegrity?: string,
475476
): Promise<LocaleInlineResult> {
476477
const results = await this.inlineAll([{ locale, translation, translationIntegrity }]);
@@ -482,7 +483,7 @@ export class I18nInliner {
482483

483484
async inlineTemplateUpdate(
484485
locale: string,
485-
translation: Record<string, unknown> | undefined,
486+
translation: Record<string, ɵParsedTranslation> | undefined,
486487
templateCode: string,
487488
templateId: string,
488489
): Promise<{ code: string; errors: string[]; warnings: string[] }> {

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

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
* found in the LICENSE file at https://angular.dev/license
77
*/
88

9+
import type { ɵParsedTranslation } from '@angular/localize';
910
import { transform } from 'esbuild';
1011
import fs from 'node:fs/promises';
1112
import os from 'node:os';
@@ -21,11 +22,22 @@ import { I18nInliner } from './i18n-inliner';
2122
const GREETING_SOURCE = 'export const greeting = $localize`:@@greeting:Hello`;\n';
2223

2324
/**
24-
* Creates the parsed translation form that `@angular/localize` expects for a message without
25-
* placeholders.
25+
* Creates the parsed translation form that `@angular/localize` expects.
2626
*/
27-
function translationFor(message: string): Record<string, unknown> {
28-
return { messageParts: [message], placeholderNames: [], text: message };
27+
function parsedTranslation(
28+
parts: string[],
29+
placeholderNames: string[] = [],
30+
text?: string,
31+
): ɵParsedTranslation {
32+
return {
33+
messageParts: Object.assign([...parts], { raw: [...parts] }),
34+
placeholderNames,
35+
text: text ?? parts.join(''),
36+
};
37+
}
38+
39+
function translationFor(message: string): ɵParsedTranslation {
40+
return parsedTranslation([message], [], message);
2941
}
3042

3143
function browserFile(path: string, contents: string): BuildOutputFile {
@@ -222,11 +234,7 @@ describe('I18nInliner', () => {
222234
const { outputFiles, errors, warnings } = await createInliner([
223235
browserFile('main.js', source),
224236
]).inlineForLocale('fr', {
225-
welcome: {
226-
messageParts: ['Bonjour ', ' !'],
227-
placeholderNames: ['PH'],
228-
text: 'Bonjour {$PH} !',
229-
},
237+
welcome: parsedTranslation(['Bonjour ', ' !'], ['PH'], 'Bonjour {$PH} !'),
230238
});
231239

232240
expect(errors).toEqual([]);
@@ -294,11 +302,11 @@ describe('I18nInliner', () => {
294302
browserFile('main.js', source),
295303
]).inlineForLocale('fr', {
296304
inner: translationFor('Pomme'),
297-
outer: {
298-
messageParts: ['Vous avez sélectionné ', ' pour la livraison.'],
299-
placeholderNames: ['PH'],
300-
text: 'Vous avez sélectionné {$PH} pour la livraison.',
301-
},
305+
outer: parsedTranslation(
306+
['Vous avez sélectionné ', ' pour la livraison.'],
307+
['PH'],
308+
'Vous avez sélectionné {$PH} pour la livraison.',
309+
),
302310
});
303311

304312
expect(errors).toEqual([]);

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
* found in the LICENSE file at https://angular.dev/license
77
*/
88

9+
import type { ɵParsedTranslation } from '@angular/localize';
10+
911
/**
1012
* Magic header identifier for i18n SharedArrayBuffer translation tables ('I18N').
1113
*/
@@ -19,7 +21,9 @@ export const I18N_MAGIC_ID = 0x4931384e;
1921
* @param translation The translation dictionary object.
2022
* @returns A SharedArrayBuffer containing the binary encoded translation catalog.
2123
*/
22-
export function encodeTranslationToBuffer(translation: Record<string, unknown>): SharedArrayBuffer {
24+
export function encodeTranslationToBuffer<T = ɵParsedTranslation>(
25+
translation: Record<string, T>,
26+
): SharedArrayBuffer {
2327
const encoder = new TextEncoder();
2428
const entries = Object.entries(translation);
2529
const entryCount = entries.length;

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ describe('SharedArrayBuffer Translation Encoder & Reader', () => {
2222
};
2323

2424
const buffer = encodeTranslationToBuffer(translation);
25-
const dictionary = new SharedTranslationDictionary(buffer);
25+
const dictionary = new SharedTranslationDictionary<unknown>(buffer);
2626

2727
expect(dictionary.get('greeting')).toEqual('Hello');
2828
expect(dictionary.get('farewell')).toEqual('Goodbye');
@@ -38,7 +38,7 @@ describe('SharedArrayBuffer Translation Encoder & Reader', () => {
3838
};
3939

4040
const buffer = encodeTranslationToBuffer(translation);
41-
const proxy = createSharedTranslationProxy(buffer);
41+
const proxy = createSharedTranslationProxy<string>(buffer);
4242

4343
expect(proxy['msg1']).toEqual('Message 1');
4444
expect(proxy['msg2']).toEqual('Message 2');
@@ -54,7 +54,7 @@ describe('SharedArrayBuffer Translation Encoder & Reader', () => {
5454
};
5555

5656
const buffer = encodeTranslationToBuffer(translation);
57-
const proxy = createSharedTranslationProxy(buffer);
57+
const proxy = createSharedTranslationProxy<string>(buffer);
5858

5959
expect(Object.prototype.hasOwnProperty.call(proxy, 'msg1')).toBeTrue();
6060
expect(Object.prototype.hasOwnProperty.call(proxy, 'unknown')).toBeFalse();
@@ -83,7 +83,7 @@ describe('SharedArrayBuffer Translation Encoder & Reader', () => {
8383
};
8484

8585
const buffer = encodeTranslationToBuffer(translation);
86-
const dictionary = new SharedTranslationDictionary(buffer);
86+
const dictionary = new SharedTranslationDictionary<string>(buffer);
8787

8888
expect(dictionary.get('😀')).toEqual('emoji message');
8989
expect(dictionary.get('\uE000')).toEqual('uE000 message');
@@ -102,8 +102,8 @@ describe('SharedArrayBuffer Translation Encoder & Reader', () => {
102102
msg1: 'Message 1',
103103
};
104104

105-
const buffer = encodeTranslationToBuffer(translation);
106-
const dictionary = new SharedTranslationDictionary(buffer);
105+
const buffer = encodeTranslationToBuffer<string>(translation);
106+
const dictionary = new SharedTranslationDictionary<string>(buffer);
107107

108108
// First lookup for missing key
109109
expect(dictionary.get('missingKey')).toBeUndefined();

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

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
* found in the LICENSE file at https://angular.dev/license
77
*/
88

9+
import type { ɵParsedTranslation } from '@angular/localize';
910
import { I18N_MAGIC_ID } from './i18n-translation-encoder';
1011

1112
/**
@@ -43,13 +44,13 @@ function compareBytes(
4344
* A zero-copy reader that queries translation messages directly from a SharedArrayBuffer
4445
* using binary search over a sorted key index.
4546
*/
46-
export class SharedTranslationDictionary {
47+
export class SharedTranslationDictionary<T = ɵParsedTranslation> {
4748
private readonly entryCount: number;
4849
private readonly uint32Index: Uint32Array;
4950
private readonly uint8Pool: Uint8Array;
5051
private readonly decoder = new TextDecoder();
5152
private readonly encoder = new TextEncoder();
52-
private readonly lazyCache = new Map<string, unknown>();
53+
private readonly lazyCache = new Map<string, T | typeof NOT_FOUND>();
5354

5455
constructor(buffer: SharedArrayBuffer) {
5556
if (buffer.byteLength < 16) {
@@ -86,7 +87,7 @@ export class SharedTranslationDictionary {
8687
* @param targetKey The message key ID to search for.
8788
* @returns The parsed translation message, or undefined if not found.
8889
*/
89-
get(targetKey: string): unknown | undefined {
90+
get(targetKey: string): T | undefined {
9091
const cached = this.lazyCache.get(targetKey);
9192
if (cached !== undefined) {
9293
return cached === NOT_FOUND ? undefined : cached;
@@ -117,7 +118,7 @@ export class SharedTranslationDictionary {
117118
const valJson = this.decoder.decode(valBytes);
118119

119120
try {
120-
const val = JSON.parse(valJson);
121+
const val = JSON.parse(valJson) as T;
121122
this.lazyCache.set(targetKey, val);
122123

123124
return val;
@@ -150,8 +151,10 @@ export class SharedTranslationDictionary {
150151
* @param buffer The SharedArrayBuffer containing binary encoded translation catalog.
151152
* @returns A Proxy object that intercepts property reads and queries the SharedTranslationDictionary.
152153
*/
153-
export function createSharedTranslationProxy(buffer: SharedArrayBuffer): Record<string, unknown> {
154-
const dictionary = new SharedTranslationDictionary(buffer);
154+
export function createSharedTranslationProxy<T = ɵParsedTranslation>(
155+
buffer: SharedArrayBuffer,
156+
): Record<string, T> {
157+
const dictionary = new SharedTranslationDictionary<T>(buffer);
155158

156159
return new Proxy(
157160
{},

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
* found in the LICENSE file at https://angular.dev/license
77
*/
88

9+
import type { ɵParsedTranslation } from '@angular/localize';
910
import path from 'node:path';
1011
import type { TranslationLoader } from './load-translations';
1112

@@ -15,7 +16,7 @@ export interface LocaleDescription {
1516
integrity?: string;
1617
format?: string;
1718
}[];
18-
translation?: Record<string, unknown>;
19+
translation?: Record<string, ɵParsedTranslation>;
1920
dataPath?: string;
2021
baseHref?: string;
2122
subPath: string;
@@ -244,7 +245,7 @@ export function loadTranslations(
244245
usedFormats?: Set<string>,
245246
duplicateTranslation?: 'ignore' | 'error' | 'warning',
246247
) {
247-
let translations: Record<string, unknown> | undefined = undefined;
248+
let translations: Record<string, ɵParsedTranslation> | undefined = undefined;
248249
for (const file of desc.files) {
249250
const loadResult = loader(path.join(workspaceRoot, file.path));
250251

0 commit comments

Comments
 (0)