-
Notifications
You must be signed in to change notification settings - Fork 0
TypeScript Rewrite: I18n command #39
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.
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
Open
d4mation
wants to merge
18
commits into
ENG-219/app-bootstrap
Choose a base branch
from
ENG-219/command-i18n
base: ENG-219/app-bootstrap
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
8a33786
ENG-219: Add i18n command
d4mation 0f35576
Merge branch 'ENG-219/app-bootstrap' into ENG-219/command-i18n
d4mation 177b84d
ENG-219: Add i18n command tests
d4mation f66dc8a
Merge branch 'ENG-219/app-bootstrap' into ENG-219/command-i18n
d4mation 851c557
Merge branch 'ENG-219/app-bootstrap' into ENG-219/command-i18n
d4mation 73869d5
Merge branch 'ENG-219/app-bootstrap' into ENG-219/command-i18n
d4mation 07f5ceb
ENG-219: Use createTempProject in i18n tests for isolation
d4mation 5b16d1f
Merge branch 'ENG-219/app-bootstrap' into ENG-219/command-i18n
d4mation 010a0aa
ENG-219: Align i18n command behavior with PHP implementation
d4mation 5636ad2
ENG-219: Fix --root flag to only affect download directory, not confi…
d4mation 2dae484
ENG-219: Add tests for --retries and --root flags
d4mation 3fee633
Merge branch 'ENG-219/app-bootstrap' into ENG-219/command-i18n
d4mation 77decf7
Merge branch 'ENG-219/app-bootstrap' into ENG-219/command-i18n
d4mation e4f2d8b
Merge branch 'ENG-219/app-bootstrap' into ENG-219/command-i18n
d4mation 30055fc
Merge branch 'ENG-219/app-bootstrap' into ENG-219/command-i18n
d4mation 6a15f85
ENG-219: Merge app-bootstrap and update imports to .ts
d4mation 37a4854
Merge branch 'ENG-219/app-bootstrap' into ENG-219/command-i18n
d4mation 167f40d
ENG-219: Port i18n 429 retry logic from PR #53
d4mation File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,317 @@ | ||
| import type { Command } from 'commander'; | ||
| import fs from 'fs-extra'; | ||
| import path from 'node:path'; | ||
| import { getConfig } from '../config.ts'; | ||
| import { PUP_VERSION } from '../app.ts'; | ||
| import * as output from '../utils/output.ts'; | ||
| import type { I18nResolvedConfig } from '../types.ts'; | ||
|
|
||
| /** | ||
| * Backoff multipliers for HTTP 429 rate limit errors. | ||
| * Index corresponds to the 429 occurrence count (0-indexed). | ||
| * Applied as: delay * multiplier. | ||
| * | ||
| * @since TBD | ||
| */ | ||
| const HTTP_429_BACKOFF_MULTIPLIERS = [16, 31, 91, 151]; | ||
|
|
||
| /** | ||
| * Registers the `i18n` command with the CLI program. | ||
| * | ||
| * @since TBD | ||
| * | ||
| * @param {Command} program - The Commander.js program instance. | ||
| * | ||
| * @returns {void} | ||
| */ | ||
| export function registerI18nCommand(program: Command): void { | ||
| program | ||
| .command('i18n') | ||
| .description('Fetches language files for the project.') | ||
| .option('--retries <number>', 'How many retries per translation file.', '3') | ||
| .option('--delay <number>', 'Delay (seconds) between retries and for 429 backoff.', '2') | ||
| .option('--batch-size <number>', 'Batch size for grouping downloads.', '3') | ||
| .option('--root <dir>', 'Set the root directory for downloading language files.') | ||
| .action(async (options: { retries?: string; delay?: string; batchSize?: string; root?: string }) => { | ||
| const config = getConfig(); | ||
| const i18nConfigs = config.getI18n(); | ||
| const cwd = options.root ?? config.getWorkingDir(); | ||
| const maxRetries = Math.max(1, Math.min(5, parseInt(options.retries ?? '3', 10))); | ||
| const delay = Math.max(1, parseInt(options.delay ?? '2', 10)); | ||
| const batchSize = Math.max(1, parseInt(options.batchSize ?? '3', 10)); | ||
|
|
||
| if (i18nConfigs.length === 0) { | ||
| output.log('No i18n configuration found. Skipping.'); | ||
| return; | ||
| } | ||
|
|
||
| for (const i18nConfig of i18nConfigs) { | ||
| const result = await downloadLanguageFiles(i18nConfig, cwd, maxRetries, delay, batchSize); | ||
|
|
||
| if (result !== 0) { | ||
| output.error('Failed to download language files.'); | ||
| output.warning('Config:'); | ||
| output.log(JSON.stringify(i18nConfig, null, 2)); | ||
| process.exitCode = result; | ||
| return; | ||
| } | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Extracts the wait time from the Retry-After header if present. | ||
| * Respects the server hint but caps it to the backoff schedule for that attempt. | ||
| * | ||
| * @since TBD | ||
| * | ||
| * @param {Response} response - The HTTP response containing potential Retry-After header. | ||
| * @param {number} backoffWait - The computed backoff wait time in seconds. | ||
| * | ||
| * @returns {number} The wait time in seconds. | ||
| */ | ||
| function getWaitTimeFor429(response: Response, backoffWait: number): number { | ||
| const retryAfter = response.headers.get('Retry-After'); | ||
|
|
||
| if (!retryAfter) { | ||
| return backoffWait; | ||
| } | ||
|
|
||
| // Retry-After can be numeric seconds or an HTTP-date; parse numeric only. | ||
| if (/^\d+$/.test(retryAfter)) { | ||
| const serverWait = parseInt(retryAfter, 10); | ||
| // Use the server hint but cap at our backoff (don't wait longer than we're willing to). | ||
| return Math.max(1, Math.min(serverWait, backoffWait)); | ||
| } | ||
|
|
||
| // HTTP-date format is complex to parse; fall back to backoff schedule. | ||
| return backoffWait; | ||
| } | ||
|
|
||
| /** | ||
| * Downloads language files for a single i18n configuration. | ||
| * Processes downloads sequentially with deterministic retry logic. | ||
| * | ||
| * @since TBD | ||
| * | ||
| * @param {I18nResolvedConfig} config - The resolved i18n configuration for this translation source. | ||
| * @param {string} cwd - The current working directory. | ||
| * @param {number} maxRetries - The maximum number of retry attempts for failed downloads. | ||
| * @param {number} delay - The base delay in seconds between retries and for 429 backoff. | ||
| * @param {number} batchSize - The batch size for grouping downloads. | ||
| * | ||
| * @returns {Promise<number>} 0 on success, 1 on failure. | ||
| */ | ||
| async function downloadLanguageFiles( | ||
| config: I18nResolvedConfig, | ||
| cwd: string, | ||
| maxRetries: number, | ||
| delay: number, | ||
| batchSize: number | ||
| ): Promise<number> { | ||
| const projectUrl = config.url | ||
| .replace('{slug}', config.slug) | ||
| .replace('%slug%', config.slug); | ||
|
|
||
| output.log(`Fetching language files for ${config.textdomain} from ${projectUrl}`); | ||
|
|
||
| let data: TranslationApiResponse; | ||
|
|
||
| try { | ||
| const response = await fetch(projectUrl, { | ||
| headers: { 'User-Agent': `StellarWP PUP/${PUP_VERSION}` }, | ||
| }); | ||
| if (!response.ok) { | ||
| output.error(`Failed to fetch project data from ${projectUrl}`); | ||
| return 1; | ||
| } | ||
| data = (await response.json()) as TranslationApiResponse; | ||
| } catch (err) { | ||
| output.error(`Failed to fetch translation data: ${err}`); | ||
| return 1; | ||
| } | ||
|
|
||
| if ( | ||
| !data.translation_sets || | ||
| !Array.isArray(data.translation_sets) || | ||
| data.translation_sets.length === 0 | ||
| ) { | ||
| output.error(`Failed to fetch translation sets from ${projectUrl}`); | ||
| return 1; | ||
| } | ||
|
|
||
| const minimumPercentage = config.filter.minimum_percentage; | ||
|
|
||
| const langDir = path.resolve(cwd, config.path); | ||
| await fs.mkdirp(langDir); | ||
|
|
||
| // Build a list of (translation, format) pairs to download. | ||
| const downloadItems: [TranslationSet, string][] = []; | ||
|
|
||
| for (const translation of data.translation_sets) { | ||
| // Skip when translations are zero. | ||
| if (translation.current_count === 0) { | ||
| continue; | ||
| } | ||
|
|
||
| // Skip any translation set that doesn't match the minimum percentage. | ||
| if (minimumPercentage > translation.percent_translated) { | ||
| continue; | ||
| } | ||
|
|
||
| for (const format of config.formats) { | ||
| downloadItems.push([translation, format]); | ||
| } | ||
| } | ||
|
|
||
| if (downloadItems.length === 0) { | ||
| return 0; | ||
| } | ||
|
|
||
| // Process downloads sequentially in batches (for grouping/visibility). | ||
| let failedCount = 0; | ||
|
|
||
| for (let offset = 0; offset < downloadItems.length; offset += batchSize) { | ||
| const batch = downloadItems.slice(offset, offset + batchSize); | ||
|
|
||
| // Process each item in the batch sequentially. | ||
| for (const [translation, format] of batch) { | ||
| try { | ||
| await downloadAndSaveTranslationSync( | ||
| config, translation, format, projectUrl, langDir, maxRetries, delay | ||
| ); | ||
| } catch (err) { | ||
| output.error(`Download failed: ${err instanceof Error ? err.message : String(err)}`); | ||
| failedCount++; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return failedCount > 0 ? 1 : 0; | ||
| } | ||
|
|
||
| /** | ||
| * Synchronously downloads and saves a translation with retry logic. | ||
| * Retries consume the standard retry budget; 429 responses use smarter delay logic. | ||
| * | ||
| * @since TBD | ||
| * | ||
| * @param {I18nResolvedConfig} config - The resolved i18n configuration. | ||
| * @param {TranslationSet} translation - The translation set to download. | ||
| * @param {string} format - The file format to download (e.g. "po", "mo"). | ||
| * @param {string} projectUrl - The base project API URL. | ||
| * @param {string} langDir - The absolute path to the language files directory. | ||
| * @param {number} maxRetries - The maximum number of retry attempts. | ||
| * @param {number} delay - The base delay in seconds between retries and for 429 backoff. | ||
| * | ||
| * @returns {Promise<void>} | ||
| */ | ||
| async function downloadAndSaveTranslationSync( | ||
| config: I18nResolvedConfig, | ||
| translation: TranslationSet, | ||
| format: string, | ||
| projectUrl: string, | ||
| langDir: string, | ||
| maxRetries: number, | ||
| delay: number | ||
| ): Promise<void> { | ||
| const translationUrl = `${projectUrl}/${translation.locale}/${translation.slug}/export-translations?format=${format}`; | ||
| let http429Count = 0; | ||
|
|
||
| for (let tried = 0; tried < maxRetries; tried++) { | ||
| const response = await fetch(translationUrl, { | ||
| headers: { 'User-Agent': `StellarWP PUP/${PUP_VERSION}` }, | ||
| }); | ||
| const statusCode = response.status; | ||
| const buffer = Buffer.from(await response.arrayBuffer()); | ||
| const bodySize = buffer.byteLength; | ||
|
|
||
| // Handle HTTP 429 (Too Many Requests) with smarter delay. | ||
| if (statusCode === 429) { | ||
| const multiplier = HTTP_429_BACKOFF_MULTIPLIERS[http429Count] ?? | ||
| HTTP_429_BACKOFF_MULTIPLIERS[HTTP_429_BACKOFF_MULTIPLIERS.length - 1]; | ||
| const backoffWait = delay * multiplier; | ||
| const waitTime = getWaitTimeFor429(response, backoffWait); | ||
|
|
||
| output.warning( | ||
| `Rate limited (HTTP 429) on ${translation.slug}. Waiting ${waitTime}s before retry...` | ||
| ); | ||
|
|
||
| await new Promise(resolve => setTimeout(resolve, waitTime * 1000)); | ||
| http429Count++; | ||
| continue; | ||
| } | ||
|
|
||
| // Check for valid response (non-429 case). | ||
| if (statusCode !== 200 || bodySize < 200) { | ||
| // Non-429 failure: use standard delay and retry. | ||
| if (tried < maxRetries - 1) { | ||
| output.error( | ||
| `Invalid response from ${translationUrl} (status: ${statusCode}, size: ${bodySize}). Retrying...` | ||
| ); | ||
| await new Promise(resolve => setTimeout(resolve, delay * 1000)); | ||
| continue; | ||
| } | ||
| break; | ||
| } | ||
|
|
||
| // Success: save and return. | ||
| saveTranslationFile(buffer, config, translation, format, langDir); | ||
| return; | ||
| } | ||
|
|
||
| // All retries exhausted. | ||
| throw new Error(`Failed to download ${translation.slug} after ${maxRetries} retries`); | ||
| } | ||
|
|
||
| /** | ||
| * Saves a translation file to disk. | ||
| * | ||
| * @since TBD | ||
| * | ||
| * @param {Buffer} content - The translation file content. | ||
| * @param {I18nResolvedConfig} config - The resolved i18n configuration. | ||
| * @param {TranslationSet} translation - The translation set metadata. | ||
| * @param {string} format - The file format (e.g. "po", "mo"). | ||
| * @param {string} langDir - The absolute path to the language files directory. | ||
| * | ||
| * @returns {void} | ||
| */ | ||
| function saveTranslationFile( | ||
| content: Buffer, | ||
| config: I18nResolvedConfig, | ||
| translation: TranslationSet, | ||
| format: string, | ||
| langDir: string | ||
| ): void { | ||
| const filename = config.file_format | ||
| .replace('%domainPath%', config.path) | ||
| .replace('%textdomain%', config.textdomain) | ||
| .replace('%locale%', translation.locale ?? '') | ||
| .replace('%wp_locale%', translation.wp_locale ?? '') | ||
| .replace('%format%', format); | ||
|
|
||
| const filePath = path.join(langDir, filename); | ||
| fs.writeFileSync(filePath, content); | ||
|
|
||
| // Verify the written file size matches the response size. | ||
| const stat = fs.statSync(filePath); | ||
| if (stat.size !== content.byteLength) { | ||
| fs.unlinkSync(filePath); | ||
| throw new Error(`Failed to write translation to ${filePath}`); | ||
| } | ||
|
|
||
| output.log(`* Translation created for ${filePath}`); | ||
| } | ||
|
|
||
| interface TranslationApiResponse { | ||
| translation_sets: TranslationSet[]; | ||
| } | ||
|
|
||
| interface TranslationSet { | ||
| locale: string; | ||
| wp_locale?: string; | ||
| slug: string; | ||
| current_count: number; | ||
| percent_translated: number; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| import type { I18nResolvedConfig } from '../types.js'; | ||
|
|
||
| /** | ||
| * Creates a resolved i18n configuration object. | ||
| * | ||
| * @since TBD | ||
| * | ||
| * @param {I18nResolvedConfig} config - The i18n configuration to clone. | ||
| * | ||
| * @returns {I18nResolvedConfig} A new copy of the i18n configuration object. | ||
| */ | ||
| export function createI18nConfig(config: I18nResolvedConfig): I18nResolvedConfig { | ||
| return { ...config }; | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is how it worked in the PHP version, but the description made it seem like it should instead load the
.puprcfrom that directory. I've updated the description to match the actual behavior.