scratch-l10n/scripts/tx-pull-www.js
Cori Hudson 137b6e3d09 fix(scripts): add retries, correct formatting for editor
retries flaky transifex api calls up to 5 times; converts message with description to plain message for editor translations
2022-09-20 14:40:38 -04:00

99 lines
3.2 KiB
JavaScript
Executable file

#!/usr/bin/env babel-node
/**
* @fileoverview
* Script to pull www translations from transifex for all resources.
* Expects that the project and that the person running the script
* has the the TX_TOKEN environment variable set to an api
* token that has developer access.
*/
const args = process.argv.slice(2);
const usage = `
Pull supported language translations from Transifex for the 'scratch-website' project.
It will query transifex for the list of resources.
Usage:
node tx-pull-www.js path [lang]
path: root for the translated resources.
Each resource will be a subdirectory containing language json files.
lang: optional language code - will only pull resources for that language
NOTE: TX_TOKEN environment variable needs to be set with a Transifex API token.
See the Localization page on the GUI wiki for information about setting up Transifex.
`;
// Fail immediately if the TX_TOKEN is not defined
if (!process.env.TX_TOKEN || args.length < 1) {
process.stdout.write(usage);
process.exit(1);
}
import fs from 'fs';
import path from 'path';
import mkdirp from 'mkdirp';
import {txPull, txResources} from '../lib/transifex.js';
import locales, {localeMap} from '../src/supported-locales.js';
import {batchMap} from '../lib/batch.js';
// Globals
const PROJECT = 'scratch-website';
const OUTPUT_DIR = path.resolve(args[0]);
// const MODE = {mode: 'reviewed'}; // default is everything for www
const CONCURRENCY_LIMIT = 36;
const lang = args.length === 2 ? args[1] : '';
const getLocaleData = async function (item) {
const locale = item.locale;
const resource = item.resource;
let txLocale = localeMap[locale] || locale;
for (let i = 0; i < 5; i++) {
try {
const translations = await txPull(PROJECT, resource, txLocale);
const txOutdir = `${OUTPUT_DIR}/${PROJECT}.${resource}`;
mkdirp.sync(txOutdir);
const fileName = `${txOutdir}/${locale}.json`;
fs.writeFileSync(
fileName,
JSON.stringify(translations, null, 4)
);
return {
resource: resource,
locale: locale,
file: fileName
};
} catch (e) {
// eslint-disable-next-line no-console
console.error(`got ${e.message}, retrying after ${i + 1} attempts`);
}
}
throw Error('failed to pull translations after 5 retries');
};
const expandResourceFiles = (resources) => {
let items = [];
for (let resource of resources) {
if (lang) {
items.push({resource: resource, locale: lang});
} else {
for (let locale of Object.keys(locales)) {
items.push({resource: resource, locale: locale});
}
}
}
return items;
};
const pullTranslations = async function () {
const resources = await txResources('scratch-website');
const allFiles = expandResourceFiles(resources);
try {
await batchMap(allFiles, CONCURRENCY_LIMIT, getLocaleData);
} catch (err) {
console.error(err); // eslint-disable-line no-console
process.exit(1);
}
};
pullTranslations();