Skip to content

[localization-plugin] Improve localized asset construction performance by 50% #4862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 6, 2024
Merged

[localization-plugin] Improve localized asset construction performance by 50% #4862

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a8f606
[localization-plugin] Improve localized asset construction performance
dmichon-msft Aug 6, 2024
87e20c6
[localization-plugin] Revert reverse iteration
dmichon-msft Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions ...es/@rushstack/webpack5-localization-plugin/localization-plugin-perf_2024-08-06-01-24.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@rushstack/webpack5-localization-plugin",
"comment": "Improve performance of localized asset reconstruction.",
"type": "patch"
}
],
"packageName": "@rushstack/webpack5-localization-plugin"
}
30 changes: 17 additions & 13 deletions webpack/webpack5-localization-plugin/src/AssetProcessor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,19 +228,25 @@ function _reconstructLocalized(

const escapedBackslash: string = element.escapedBackslash || '\\';

// Replace backslashes with the properly escaped backslash
BACKSLASH_REGEX.lastIndex = -1;
newValue = newValue.replace(BACKSLASH_REGEX, escapedBackslash);

// @todo: look into using JSON.parse(...) to get the escaping characters
const escapingCharacterSequence: string = escapedBackslash.slice(escapedBackslash.length / 2);
if (newValue.includes('\\')) {
// The vast majority of localized strings do not contain `\\`, so this check avoids an allocation.
// Replace backslashes with the properly escaped backslash
BACKSLASH_REGEX.lastIndex = -1;
newValue = newValue.replace(BACKSLASH_REGEX, escapedBackslash);
}

// Ensure the the quotemark, apostrophe, tab, and newline characters are properly escaped
ESCAPE_REGEX.lastIndex = -1;
newValue = newValue.replace(
ESCAPE_REGEX,
(match) => `${escapingCharacterSequence}${ESCAPE_MAP.get(match)}`
);
if (ESCAPE_REGEX.test(newValue)) {
// The majority of localized strings do not contain the characters that need to be escaped,
// so this check avoids an allocation.
// @todo: look into using JSON.parse(...) to get the escaping characters
const escapingCharacterSequence: string = escapedBackslash.slice(escapedBackslash.length / 2);
newValue = newValue.replace(
ESCAPE_REGEX,
(match) => `${escapingCharacterSequence}${ESCAPE_MAP.get(match)}`
);
}

result.replace(element.start, element.end - 1, newValue);
break;
Expand Down Expand Up @@ -305,9 +311,7 @@ function _parseStringToReconstructionSequence(
const jsonStringifyFormatLocaleForFilenameFn: FormatLocaleForFilenameFn = (locale: string) =>
JSON.stringify(formatLocaleForFilenameFn(locale));

let regexResult: RegExpExecArray | null;
PLACEHOLDER_REGEX.lastIndex = -1;
while ((regexResult = PLACEHOLDER_REGEX.exec(source))) {
for (const regexResult of source.matchAll(PLACEHOLDER_REGEX)) {
const [placeholder, escapedBackslash, elementLabel, placeholderSerialNumber] = regexResult;
const start: number = regexResult.index;
const end: number = start + placeholder.length;
Expand Down
Loading