#210 [firestore-translate-text] Rename variables to generic names (#337)

#210 [firestore-translate-text] Rename variables to generic names

Author: Ehesp

firestore-translate-text/POSTINSTALL.md

@@ -6,18 +6,18 @@ To test out this extension, follow these steps:
 
 1.  If it doesn't exist already, create a collection called `${param:COLLECTION_PATH}`.
 
-1.  Create a document with a field named `${param:MESSAGE_FIELD_NAME}` and make its value a word or phrase that you want to translate.
+1.  Create a document with a field named `${param:INPUT_FIELD_NAME}` and make its value a word or phrase that you want to translate.
 
-1.  In a few seconds, you'll see a new field called `${param:TRANSLATIONS_FIELD_NAME}` pop up in the same document you just created; it will contain the translations. 
+1.  In a few seconds, you'll see a new field called `${param:OUTPUT_FIELD_NAME}` pop up in the same document you just created; it will contain the translations for each language specified. 
 
 ### Using the extension
 
-Whenever a string is written to the field `${param:MESSAGE_FIELD_NAME}` in `${param:COLLECTION_PATH}`, this extension translates the string into your specified target language(s). The source language of the string is automatically detected. This extension adds the translated string to `${param:TRANSLATIONS_FIELD_NAME}` in the same document using the following format:
+Whenever a string is written to the field `${param:INPUT_FIELD_NAME}` in `${param:COLLECTION_PATH}`, this extension translates the string into your specified target language(s). The source language of the string is automatically detected. This extension adds the translated string to `${param:OUTPUT_FIELD_NAME}` in the same document using the following format:
 
 ```
 {
-  ${param:MESSAGE_FIELD_NAME}: 'My name is Bob',
-  ${param:TRANSLATIONS_FIELD_NAME}: {
+  ${param:INPUT_FIELD_NAME}: 'My name is Bob',
+  ${param:OUTPUT_FIELD_NAME}: {
     de: 'Ich heiße Bob',
     en: 'My name is Bob',
     es: 'Mi nombre es Bob',
@@ -26,7 +26,7 @@ Whenever a string is written to the field `${param:MESSAGE_FIELD_NAME}` in `${pa
 }
 ```
 
-If the `${param:MESSAGE_FIELD_NAME}` field of the document is updated, then the translations will be automatically updated, as well.
+If the `${param:INPUT_FIELD_NAME}` field of the document is updated, then the translations will be automatically updated, as well.
 
 ### Monitoring
 

firestore-translate-text/README.md

@@ -16,10 +16,10 @@
 * Collection path: *What is the path to the collection that contains the strings that you want to translate?
 *
 
-* Message field name: *What is the name of the field that contains the strings that you want to translate?
+* Input field name: *What is the name of the field that contains the string that you want to translate?
 *
 
-* Translations field name: *What is the name of the field where you want to store your translations?
+* Output field name: *What is the name of the field where you want to store your translations?
 *
 
 

firestore-translate-text/extension.yaml

@@ -81,11 +81,12 @@ params:
         value: asia-northeast1
     default: us-central1
     required: true
+
   - param: LANGUAGES
     label: Target languages for translations, as a comma-separated list
     description: >
       Into which target languages do you want to translate new strings?
-      The languages are identifed using ISO-639-1 codes in a comma-separated list, for example: en,es,de,fr.
+      The languages are identified using ISO-639-1 codes in a comma-separated list, for example: en,es,de,fr.
       For these codes, visit the [supported languages list](https://cloud.google.com/translate/docs/languages).
     default: en,es,de,fr
     example: en,es,de,fr
@@ -98,24 +99,24 @@ params:
     label: Collection path
     description: >
       What is the path to the collection that contains the strings that you want to translate?
-    default: messages
-    example: messages
+    default: translations
+    example: translations
     validationRegex: "^[^/]+(/[^/]+/[^/]+)*$"
     validationErrorMessage: Must be a valid Cloud Firestore Collection
     required: true
 
-  - param: MESSAGE_FIELD_NAME
-    label: Message field name
+  - param: INPUT_FIELD_NAME
+    label: Input field name
     description: >
-      What is the name of the field that contains the strings that you want to translate?
-    default: message
-    example: message
+      What is the name of the field that contains the string that you want to translate?
+    default: input
+    example: input
     required: true
 
-  - param: TRANSLATIONS_FIELD_NAME
-    label: Translations field name
+  - param: OUTPUT_FIELD_NAME
+    label: Translations output field name
     description: >
       What is the name of the field where you want to store your translations?
-    default: translations
-    example: translations
+    default: translated
+    example: translated
     required: true

firestore-translate-text/functions/lib/config.js

@@ -18,6 +18,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
     languages: process.env.LANGUAGES.split(","),
     location: process.env.LOCATION,
-    messageFieldName: process.env.MESSAGE_FIELD_NAME,
-    translationsFieldName: process.env.TRANSLATIONS_FIELD_NAME,
+    inputFieldName: process.env.INPUT_FIELD_NAME,
+    outputFieldName: process.env.OUTPUT_FIELD_NAME,
 };

firestore-translate-text/functions/lib/index.js

@@ -15,10 +15,11 @@
  * limitations under the License.
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
         function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
         function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
@@ -39,15 +40,15 @@ const translate = new translate_1.Translate({ projectId: process.env.PROJECT_ID
 // Initialize the Firebase Admin SDK
 admin.initializeApp();
 logs.init();
-exports.fstranslate = functions.handler.firestore.document.onWrite((change) => __awaiter(this, void 0, void 0, function* () {
+exports.fstranslate = functions.handler.firestore.document.onWrite((change) => __awaiter(void 0, void 0, void 0, function* () {
     logs.start();
-    const { languages, messageFieldName, translationsFieldName } = config_1.default;
-    if (validators.fieldNamesMatch(messageFieldName, translationsFieldName)) {
+    const { languages, inputFieldName, outputFieldName } = config_1.default;
+    if (validators.fieldNamesMatch(inputFieldName, outputFieldName)) {
         logs.fieldNamesNotDifferent();
         return;
     }
-    if (validators.fieldNameIsTranslationPath(messageFieldName, translationsFieldName, languages)) {
-        logs.messageFieldNameIsTranslationPath();
+    if (validators.fieldNameIsTranslationPath(inputFieldName, outputFieldName, languages)) {
+        logs.inputFieldNameIsOutputPath();
         return;
     }
     const changeType = getChangeType(change);
@@ -71,8 +72,8 @@ exports.fstranslate = functions.handler.firestore.document.onWrite((change) => _
         logs.error(err);
     }
 }));
-const extractMsg = (snapshot) => {
-    return snapshot.get(config_1.default.messageFieldName);
+const extractInput = (snapshot) => {
+    return snapshot.get(config_1.default.inputFieldName);
 };
 const getChangeType = (change) => {
     if (!change.after.exists) {
@@ -83,77 +84,76 @@ const getChangeType = (change) => {
     }
     return ChangeType.UPDATE;
 };
-const handleCreateDocument = (snapshot) => __awaiter(this, void 0, void 0, function* () {
-    const msg = extractMsg(snapshot);
-    if (msg) {
-        logs.documentCreatedWithMsg();
+const handleCreateDocument = (snapshot) => __awaiter(void 0, void 0, void 0, function* () {
+    const input = extractInput(snapshot);
+    if (input) {
+        logs.documentCreatedWithInput();
         yield translateDocument(snapshot);
     }
     else {
-        logs.documentCreatedNoMsg();
+        logs.documentCreatedNoInput();
     }
 });
 const handleDeleteDocument = () => {
     logs.documentDeleted();
 };
-const handleUpdateDocument = (before, after) => __awaiter(this, void 0, void 0, function* () {
-    const msgAfter = extractMsg(after);
-    const msgBefore = extractMsg(before);
-    const msgHasChanged = msgAfter !== msgBefore;
-    if (!msgHasChanged) {
-        logs.documentUpdatedUnchangedMsg();
+const handleUpdateDocument = (before, after) => __awaiter(void 0, void 0, void 0, function* () {
+    const inputAfter = extractInput(after);
+    const inputBefore = extractInput(before);
+    const inputHasChanged = inputAfter !== inputBefore;
+    if (!inputHasChanged) {
+        logs.documentUpdatedUnchangedInput();
         return;
     }
-    if (msgAfter) {
-        logs.documentUpdatedChangedMsg();
+    if (inputAfter) {
+        logs.documentUpdatedChangedInput();
         yield translateDocument(after);
     }
-    else if (msgBefore) {
-        logs.documentUpdatedDeletedMsg();
+    else if (inputBefore) {
+        logs.documentUpdatedDeletedInput();
         yield updateTranslations(after, admin.firestore.FieldValue.delete());
     }
     else {
-        logs.documentUpdatedNoMsg();
+        logs.documentUpdatedNoInput();
     }
 });
-const translateDocument = (snapshot) => __awaiter(this, void 0, void 0, function* () {
-    const message = extractMsg(snapshot);
-    logs.translateMsgAllLanguages(message, config_1.default.languages);
-    const tasks = config_1.default.languages.map((targetLanguage) => __awaiter(this, void 0, void 0, function* () {
-        const translatedMsg = yield translateMessage(message, targetLanguage);
+const translateDocument = (snapshot) => __awaiter(void 0, void 0, void 0, function* () {
+    const input = extractInput(snapshot);
+    logs.translateInputStringToAllLanguages(input, config_1.default.languages);
+    const tasks = config_1.default.languages.map((targetLanguage) => __awaiter(void 0, void 0, void 0, function* () {
         return {
             language: targetLanguage,
-            message: translatedMsg,
+            output: yield translateString(input, targetLanguage),
         };
     }));
     try {
         const translations = yield Promise.all(tasks);
-        logs.translateMsgAllLanguagesComplete(message);
+        logs.translateInputToAllLanguagesComplete(input);
         const translationsMap = translations.reduce((output, translation) => {
-            output[translation.language] = translation.message;
+            output[translation.language] = translation.output;
             return output;
         }, {});
         yield updateTranslations(snapshot, translationsMap);
     }
     catch (err) {
-        logs.translateMsgAllLanguagesError(message, err);
+        logs.translateInputToAllLanguagesError(input, err);
         throw err;
     }
 });
-const translateMessage = (msg, targetLanguage) => __awaiter(this, void 0, void 0, function* () {
+const translateString = (string, targetLanguage) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        logs.translateMsg(msg, targetLanguage);
-        const [translatedMsg] = yield translate.translate(msg, targetLanguage);
-        logs.translateMsgComplete(msg, targetLanguage);
-        return translatedMsg;
+        logs.translateInputString(string, targetLanguage);
+        const [translatedString] = yield translate.translate(string, targetLanguage);
+        logs.translateStringComplete(string, targetLanguage);
+        return translatedString;
     }
     catch (err) {
-        logs.translateMsgError(msg, targetLanguage, err);
+        logs.translateStringError(string, targetLanguage, err);
         throw err;
     }
 });
-const updateTranslations = (snapshot, translations) => __awaiter(this, void 0, void 0, function* () {
+const updateTranslations = (snapshot, translations) => __awaiter(void 0, void 0, void 0, function* () {
     logs.updateDocument(snapshot.ref.path);
-    yield snapshot.ref.update(config_1.default.translationsFieldName, translations);
+    yield snapshot.ref.update(config_1.default.outputFieldName, translations);
     logs.updateDocumentComplete(snapshot.ref.path);
 });

firestore-translate-text/functions/lib/logs.js

@@ -19,59 +19,59 @@ const config_1 = require("./config");
 exports.complete = () => {
     console.log("Completed execution of extension");
 };
-exports.documentCreatedNoMsg = () => {
-    console.log("Document was created without a string, no processing is required");
+exports.documentCreatedNoInput = () => {
+    console.log("Document was created without an input string, no processing is required");
 };
-exports.documentCreatedWithMsg = () => {
-    console.log("Document was created with a string");
+exports.documentCreatedWithInput = () => {
+    console.log("Document was created with an input string");
 };
 exports.documentDeleted = () => {
     console.log("Document was deleted, no processing is required");
 };
-exports.documentUpdatedChangedMsg = () => {
-    console.log("Document was updated, string has changed");
+exports.documentUpdatedChangedInput = () => {
+    console.log("Document was updated, input string has changed");
 };
-exports.documentUpdatedDeletedMsg = () => {
-    console.log("Document was updated, string was deleted");
+exports.documentUpdatedDeletedInput = () => {
+    console.log("Document was updated, input string was deleted");
 };
-exports.documentUpdatedNoMsg = () => {
-    console.log("Document was updated, no string exists, no processing is required");
+exports.documentUpdatedNoInput = () => {
+    console.log("Document was updated, no input string exists, no processing is required");
 };
-exports.documentUpdatedUnchangedMsg = () => {
-    console.log("Document was updated, string has not changed, no processing is required");
+exports.documentUpdatedUnchangedInput = () => {
+    console.log("Document was updated, input string has not changed, no processing is required");
 };
 exports.error = (err) => {
     console.error("Failed execution of extension", err);
 };
 exports.fieldNamesNotDifferent = () => {
-    console.error("The `Message` and `Translations` field names must be different for this extension to function correctly");
+    console.error("The `Input` and `Output` field names must be different for this extension to function correctly");
 };
 exports.init = () => {
     console.log("Initializing extension with configuration", config_1.default);
 };
-exports.messageFieldNameIsTranslationPath = () => {
-    console.error("The `Message` field name must not be the same as a `Translation` path for this extension to function correctly");
+exports.inputFieldNameIsOutputPath = () => {
+    console.error("The `Input` field name must not be the same as an `Output` path for this extension to function correctly");
 };
 exports.start = () => {
     console.log("Started execution of extension with configuration", config_1.default);
 };
-exports.translateMsg = (msg, language) => {
-    console.log(`Translating msg: '${msg}' into language(s): '${language}'`);
+exports.translateInputString = (string, language) => {
+    console.log(`Translating string: '${string}' into language(s): '${language}'`);
 };
-exports.translateMsgComplete = (msg, language) => {
-    console.log(`Finished translating msg: '${msg}' into language(s): '${language}'`);
+exports.translateStringComplete = (string, language) => {
+    console.log(`Finished translating string: '${string}' into language(s): '${language}'`);
 };
-exports.translateMsgError = (msg, language, err) => {
-    console.error(`Error when translating msg: '${msg}' into language(s): '${language}'`, err);
+exports.translateStringError = (string, language, err) => {
+    console.error(`Error when translating string: '${string}' into language(s): '${language}'`, err);
 };
-exports.translateMsgAllLanguages = (msg, languages) => {
-    console.log(`Translating msg: '${msg}' into language(s): '${languages.join(",")}'`);
+exports.translateInputStringToAllLanguages = (string, languages) => {
+    console.log(`Translating string: '${string}' into language(s): '${languages.join(",")}'`);
 };
-exports.translateMsgAllLanguagesComplete = (msg) => {
-    console.log(`Finished translating msg: '${msg}'`);
+exports.translateInputToAllLanguagesComplete = (string) => {
+    console.log(`Finished translating string: '${string}'`);
 };
-exports.translateMsgAllLanguagesError = (msg, err) => {
-    console.error(`Error when translating msg: '${msg}'`, err);
+exports.translateInputToAllLanguagesError = (string, err) => {
+    console.error(`Error when translating string: '${string}'`, err);
 };
 exports.updateDocument = (path) => {
     console.log(`Updating Cloud Firestore document: '${path}'`);

firestore-translate-text/functions/lib/validators.js

@@ -16,9 +16,9 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fieldNamesMatch = (field1, field2) => field1 === field2;
-exports.fieldNameIsTranslationPath = (field, translationsField, languages) => {
+exports.fieldNameIsTranslationPath = (inputFieldName, outputFieldName, languages) => {
     for (const language of languages) {
-        if (field === `${translationsField}.${language}`) {
+        if (inputFieldName === `${outputFieldName}.${language}`) {
             return true;
         }
     }

firestore-translate-text/functions/src/config.ts

@@ -17,6 +17,6 @@
 export default {
   languages: process.env.LANGUAGES.split(","),
   location: process.env.LOCATION,
-  messageFieldName: process.env.MESSAGE_FIELD_NAME,
-  translationsFieldName: process.env.TRANSLATIONS_FIELD_NAME,
+  inputFieldName: process.env.INPUT_FIELD_NAME,
+  outputFieldName: process.env.OUTPUT_FIELD_NAME,
 };