[translation] [update] Add informative log and a manual confirmation before uploading + Remove safety check + Bring node-fetch back since it is experimental and showing warnings.

swashata · swashata · commit 0f6b0f1e57bf · 2024-03-31T15:08:16.000+05:30
diff --git a/gulptasks/transifex.js b/gulptasks/transifex.js
@@ -7,6 +7,10 @@
 const {transifexApi} = require('@transifex/api');
 const fs = require('node:fs');
 const log = require('fancy-log');
+const prompts = require('prompts');
+const {po} = require('gettext-parser');
+const chalk = require('chalk');
+const fetch = require('node-fetch'); // @todo - Remove once fetch is stabilized in NodeJS.
 
 transifexApi.setup({
     auth: process.env.TRANSIFEX_API
@@ -16,18 +20,13 @@ const SOURCE_SLUG = 'freemius-enpo';
 const SOURCE_NAME = 'freemius-en.po';
 
 async function getOrganization() {
-    // Safety check, unless we feel 100% confident, this wouldn't break the existing resources.
-    if ('wordpress-sdk' === process.env.TRANSIFEX_ORGANIZATION) {
-        throw new Error('Can not use the production organization yet!');
-    }
-
     const organization = await transifexApi.Organization.get({slug: process.env.TRANSIFEX_ORGANIZATION});
 
     if (!organization) {
         throw new Error(`Organization "${process.env.TRANSIFEX_ORGANIZATION}" not found!`);
     }
 
-    log(`Using organization "${organization.attributes.name}"`);
+    log(`Using organization "${chalk.bold.bgBlack.yellow(organization.attributes.name)}"`);
 
     return organization;
 }
@@ -44,7 +43,7 @@ async function getProject(organization) {
         throw new Error(`Project "${process.env.TRANSIFEX_PROJECT}" not found!`);
     }
 
-    log(`Using project "${project.attributes.name}"`);
+    log(`Using project "${chalk.bold.bgBlack.yellow(project.attributes.name)}"`);
 
     return project;
 }
@@ -78,10 +77,10 @@ async function getResourceStringForUpload(project, name, slug, i18nFormat) {
 
     try {
         resource = await resources.get({slug});
-        log(`Resource "${name}" already exists, updating...`)
+        log(`Resource "${chalk.bold.bgBlack.yellow(name)}" already exists, updating...`)
     } catch (e) {
         // No resources yet
-        log(`Creating resource "${name}"`);
+        log(`Creating resource "${chalk.bold.bgBlack.yellow(name)}"`);
         resource = await transifexApi.Resource.create({
             name,
             slug,
@@ -93,17 +92,60 @@ async function getResourceStringForUpload(project, name, slug, i18nFormat) {
     return resource;
 }
 
+function getLinesCount(parsedPot) {
+    let sentenceCount = 0;
+    let wordCount = 0;
+
+    Object.values(parsedPot.translations).forEach((messages) => {
+        Object.keys((messages)).forEach((source) => {
+            if ('' === source) {
+                return;
+            }
+
+            sentenceCount += 1;
+            wordCount += source.split(' ').length;
+        });
+    });
+
+    return {sentenceCount, wordCount};
+}
+
 async function uploadEnglishPoToTransifex(poPath) {
     const {organization, project} = await getOrgAndProject();
     const content = fs.readFileSync(poPath, {encoding: 'utf-8'});
 
+    // Get total number of lines in the file
+    const parsedPot = po.parse(content);
+
+    // Get total lines count from the parsedPot
+    const {sentenceCount, wordCount} = getLinesCount(parsedPot);
+
     const i18nFormat = await transifexApi.i18n_formats.get({
         organization,
         name: 'PO'
     });
 
     const resource = await getResourceStringForUpload(project, SOURCE_NAME, SOURCE_SLUG, i18nFormat);
 
+    log(`ATTENTION: ${chalk.bold.red('UPLOADING')}!!`);
+    log(`You are about to upload the freemius-en.po file to the production organization!.`);
+    log(`In ${chalk.bgYellow.black('Transifex')} freemius-en.po file has ${chalk.bold.magenta(resource.attributes.string_count)} lines and ${chalk.bold.cyan(resource.attributes.word_count)} words.`);
+    log(`In     ${chalk.bgYellow.black('Local')} freemius-en.po file has ${chalk.bold.magenta(sentenceCount)} lines and ${chalk.bold.cyan(wordCount)} words.`);
+    log(`Please make sure you have already tested the content of the file.`);
+    log(chalk.bold.red('Any data loss could be permanent.'));
+
+    const confirmation = await prompts({
+        type: 'confirm',
+        message: `Do you want to upload the file freemius-en.po to Transifex?`,
+        initial: false,
+        name: 'value',
+    });
+
+    if (!confirmation.value) {
+        log('Aborting upload');
+        return false;
+    }
+
     await transifexApi.ResourceStringsAsyncUpload.upload({
         resource,
         content,
diff --git a/gulptasks/translate.js b/gulptasks/translate.js
@@ -5,6 +5,7 @@ const path = require('node:path');
 const log = require('fancy-log');
 const fs = require('node:fs');
 const {po, mo} = require('gettext-parser');
+const chalk = require('chalk');
 const {uploadEnglishPoToTransifex, getTranslation} = require('./transifex');
 
 const root = path.resolve(__dirname, '..');
@@ -94,20 +95,26 @@ function updateTranslationFiles(languageCode, translation) {
 async function syncWithTransifex() {
     log('Updaing Transifex source...');
     const resource = await uploadEnglishPoToTransifex(freemiusPotPath);
+
+    if (false === resource) {
+        log.error('Failed to upload the English po file to Transifex.');
+        return;
+    }
+
     log('Transifex updated.');
 
     // Loop over LANGUAGE_CODE and download and update every one of them
     for (const code of LANGUAGE_CODES) {
-        log(`Updating ${code}...`);
+        log(`Updating ${chalk.cyan(code)}...`);
         try {
             const translation = await getTranslation(code, resource);
 
             // Update the po file in the file system
             updateTranslationFiles(code, translation);
 
-            log(`Updated ${code}.`);
+            log(`Updated ${chalk.cyan(code)}.`);
         } catch (e) {
-            log.error(`Failed to get translation of ${code}, skipping...`);
+            log.error(`Failed to get translation of ${chalk.red(code)}, skipping...`);
         }
     }
 }
diff --git a/languages/freemius-de_DE.po b/languages/freemius-de_DE.po
@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: freemius\n"
 "Report-Msgid-Bugs-To: https://github.com/Freemius/wordpress-sdk/issues\n"
-"POT-Creation-Date: 2024-01-30 15:07+0000\n"
+"POT-Creation-Date: 2024-03-31 08:37+0000\n"
 "Last-Translator: Swashata Ghosh, 2024\n"
 "Language-Team: German (Germany) "
 "(https://app.transifex.com/freemius/teams/184351/de_DE/)\n"
diff --git a/languages/freemius-es_ES.po b/languages/freemius-es_ES.po
@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: freemius\n"
 "Report-Msgid-Bugs-To: https://github.com/Freemius/wordpress-sdk/issues\n"
-"POT-Creation-Date: 2024-01-30 15:07+0000\n"
+"POT-Creation-Date: 2024-03-31 08:37+0000\n"
 "Last-Translator: Swashata Ghosh, 2024\n"
 "Language-Team: Spanish (Spain) "
 "(https://app.transifex.com/freemius/teams/184351/es_ES/)\n"
diff --git a/languages/freemius-fr_FR.po b/languages/freemius-fr_FR.po
@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: freemius\n"
 "Report-Msgid-Bugs-To: https://github.com/Freemius/wordpress-sdk/issues\n"
-"POT-Creation-Date: 2024-01-30 15:07+0000\n"
+"POT-Creation-Date: 2024-03-31 08:37+0000\n"
 "Last-Translator: Swashata Ghosh, 2024\n"
 "Language-Team: French (France) "
 "(https://app.transifex.com/freemius/teams/184351/fr_FR/)\n"
diff --git a/languages/freemius-nl_NL.po b/languages/freemius-nl_NL.po
@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: freemius\n"
 "Report-Msgid-Bugs-To: https://github.com/Freemius/wordpress-sdk/issues\n"
-"POT-Creation-Date: 2024-01-30 15:42+0000\n"
+"POT-Creation-Date: 2024-03-31 08:37+0000\n"
 "Last-Translator: Swashata Ghosh, 2024\n"
 "Language-Team: Dutch (Netherlands) "
 "(https://app.transifex.com/freemius/teams/184351/nl_NL/)\n"
diff --git a/languages/freemius-ru_RU.po b/languages/freemius-ru_RU.po
@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: freemius\n"
 "Report-Msgid-Bugs-To: https://github.com/Freemius/wordpress-sdk/issues\n"
-"POT-Creation-Date: 2024-01-30 15:42+0000\n"
+"POT-Creation-Date: 2024-03-31 08:37+0000\n"
 "Last-Translator: Swashata Ghosh, 2024\n"
 "Language-Team: Russian (Russia) "
 "(https://app.transifex.com/freemius/teams/184351/ru_RU/)\n"
diff --git a/languages/freemius.pot b/languages/freemius.pot
@@ -8,7 +8,7 @@ msgstr ""
 "Content-Transfer-Encoding: 8bit\n"
 "Language-Team: Freemius Team <admin@freemius.com>\n"
 "Last-Translator: Vova Feldman <vova@freemius.com>\n"
-"POT-Creation-Date: 2024-01-31 07:21+0000\n"
+"POT-Creation-Date: 2024-03-31 09:35+0000\n"
 "Report-Msgid-Bugs-To: https://github.com/Freemius/wordpress-sdk/issues\n"
 "X-Poedit-Basepath: ..\n"
 "X-Poedit-KeywordsList: get_text_inline;get_text_x_inline:1,2c;$this->get_text_inline;$this->get_text_x_inline:1,2c;$this->_fs->get_text_inline;$this->_fs->get_text_x_inline:1,2c;$this->fs->get_text_inline;$this->fs->get_text_x_inline:1,2c;$fs->get_text_inline;$fs->get_text_x_inline:1,2c;$this->_parent->get_text_inline;$this->_parent->get_text_x_inline:1,2c;fs_text_inline;fs_echo_inline;fs_esc_js_inline;fs_esc_attr_inline;fs_esc_attr_echo_inline;fs_esc_html_inline;fs_esc_html_echo_inline;fs_text_x_inline:1,2c;fs_echo_x_inline:1,2c;fs_esc_attr_x_inline:1,2c;fs_esc_js_x_inline:1,2c;fs_esc_js_echo_x_inline:1,2c;fs_esc_html_x_inline:1,2c;fs_esc_html_echo_x_inline:1,2c\n"
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
