@adminforth/i18n 1.0.13 → 1.0.16-next.0

package/Changelog.md

@@ -6,7 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## [1.0.14]
 
+### Fixed
+
+- Add `ignoreInitial` for watch to prevent initial messages loading
+- Add locking mechanism to prevent initial messages loading call in parallel (just in case)
 
 ## [1.0.13]
 

package/dist/index.js

@@ -12,6 +12,8 @@ import iso6391 from 'iso-639-1';
 import path from 'path';
 import fs from 'fs-extra';
 import chokidar from 'chokidar';
+import { AsyncQueue } from '@sapphire/async-queue';
+const processFrontendMessagesQueue = new AsyncQueue();
 const SLAVIC_PLURAL_EXAMPLES = {
     uk: 'яблук | Яблуко | Яблука | Яблук', // zero | singular | 2-4 | 5+
     bg: 'ябълки | ябълка | ябълки | ябълки', // zero | singular | 2-4 | 5+
@@ -275,19 +277,23 @@ export default class I18N extends AdminForthPlugin {
                     confirm: 'Are you sure you want to translate selected items?',
                     state: 'selected',
                     action: (_j) => __awaiter(this, [_j], void 0, function* ({ selectedIds, tr }) {
+                        let translatedCount = 0;
                         try {
-                            yield this.bulkTranslate({ selectedIds });
+                            translatedCount = yield this.bulkTranslate({ selectedIds });
                         }
                         catch (e) {
                             if (e instanceof AiTranslateError) {
+                                process.env.HEAVY_DEBUG && console.error('🪲⛔ bulkTranslate error', e);
                                 return { ok: false, error: e.message };
                             }
                         }
-                        console.log('🪲bulkTranslate done', selectedIds);
+                        process.env.HEAVY_DEBUG && console.log('🪲bulkTranslate done', selectedIds);
                         this.updateUntranslatedMenuBadge();
                         return {
                             ok: true, error: undefined,
-                            successMessage: yield tr(`Translated {count} items`, 'backend', { count: selectedIds.length }),
+                            successMessage: yield tr(`Translated {count} items`, 'backend', {
+                                count: translatedCount,
+                            }),
                         };
                     })
                 });
@@ -349,7 +355,7 @@ export default class I18N extends AdminForthPlugin {
                     let totalTranslated = 0;
                     for (let i = 0; i < strings.length; i += maxKeysInOneReq) {
                         const slicedStrings = strings.slice(i, i + maxKeysInOneReq);
-                        console.log('🪲🔪slicedStrings ', slicedStrings);
+                        process.env.HEAVY_DEBUG && console.log('🪲🔪slicedStrings len', slicedStrings.length);
                         totalTranslated += yield translateToLang(langIsoCode, slicedStrings, plurals);
                     }
                     return totalTranslated;
@@ -368,10 +374,10 @@ ${JSON.stringify(strings.reduce((acc, s) => {
                 }, {}), null, 2)}
 \`\`\`
 `;
-                process.env.HEAVY_DEBUG && console.log('llm prompt', prompt);
+                process.env.HEAVY_DEBUG && console.log('🧠 llm prompt', prompt);
                 // call OpenAI
                 const resp = yield this.options.completeAdapter.complete(prompt, [], 300);
-                process.env.HEAVY_DEBUG && console.log('llm resp', resp);
+                process.env.HEAVY_DEBUG && console.log('🧠 llm resp', resp);
                 if (resp.error) {
                     throw new AiTranslateError(resp.error);
                 }
@@ -386,7 +392,7 @@ ${JSON.stringify(strings.reduce((acc, s) => {
                 }
                 catch (e) {
                     console.error('error in parsing OpenAI', resp);
-                    return;
+                    throw new AiTranslateError('Error in parsing OpenAI response');
                 }
                 res = JSON.parse(res);
                 for (const [enStr, translatedStr] of Object.entries(res)) {
@@ -433,6 +439,7 @@ ${JSON.stringify(strings.reduce((acc, s) => {
     }
     processExtractedMessages(adminforth, filePath) {
         return __awaiter(this, void 0, void 0, function* () {
+            yield processFrontendMessagesQueue.wait();
             // messages file is in i18n-messages.json
             let messages;
             try {
@@ -482,7 +489,10 @@ ${JSON.stringify(strings.reduce((acc, s) => {
             this.processExtractedMessages(adminforth, messagesFile);
             // we use watcher because file can't be yet created when we start - bundleNow can be done in build time or can be done now
             // that is why we make attempt to process it now and then watch for changes
-            const w = chokidar.watch(messagesFile, { persistent: true });
+            const w = chokidar.watch(messagesFile, {
+                persistent: true,
+                ignoreInitial: true, // don't trigger 'add' event for existing file on start
+            });
             w.on('change', () => {
                 process.env.HEAVY_DEBUG && console.log('🪲🔔messagesFile change', messagesFile);
                 this.processExtractedMessages(adminforth, messagesFile);

package/index.ts

@@ -5,6 +5,9 @@ import iso6391, { LanguageCode } from 'iso-639-1';
 import path from 'path';
 import fs from 'fs-extra';
 import chokidar from 'chokidar';
+import  { AsyncQueue } from '@sapphire/async-queue';
+
+const processFrontendMessagesQueue = new AsyncQueue();
 
 const SLAVIC_PLURAL_EXAMPLES = {
   uk: 'яблук | Яблуко | Яблука | Яблук', // zero | singular | 2-4 | 5+
@@ -315,18 +318,22 @@ export default class I18N extends AdminForthPlugin {
           confirm: 'Are you sure you want to translate selected items?',
           state: 'selected',
           action: async ({ selectedIds, tr }) => {
+            let translatedCount = 0;
             try {
-              await this.bulkTranslate({ selectedIds });
+              translatedCount = await this.bulkTranslate({ selectedIds });
             } catch (e) {
               if (e instanceof AiTranslateError) {
+                process.env.HEAVY_DEBUG && console.error('🪲⛔ bulkTranslate error', e);
                 return { ok: false, error: e.message };
               }
             }
-            console.log('🪲bulkTranslate done', selectedIds);
+            process.env.HEAVY_DEBUG && console.log('🪲bulkTranslate done', selectedIds);
             this.updateUntranslatedMenuBadge();
             return { 
               ok: true, error: undefined, 
-              successMessage: await tr(`Translated {count} items`, 'backend', {count: selectedIds.length}),
+              successMessage: await tr(`Translated {count} items`, 'backend', {
+                count: translatedCount,
+              }),
             };
           }
         }
@@ -408,7 +415,7 @@ export default class I18N extends AdminForthPlugin {
         let totalTranslated = 0;
         for (let i = 0; i < strings.length; i += maxKeysInOneReq) {
           const slicedStrings = strings.slice(i, i + maxKeysInOneReq);
-          console.log('🪲🔪slicedStrings ', slicedStrings);
+          process.env.HEAVY_DEBUG && console.log('🪲🔪slicedStrings len', slicedStrings.length);
           totalTranslated += await translateToLang(langIsoCode, slicedStrings, plurals);
         }
         return totalTranslated;
@@ -432,7 +439,7 @@ ${
 \`\`\`
 `;
 
-      process.env.HEAVY_DEBUG && console.log('llm prompt', prompt);
+      process.env.HEAVY_DEBUG && console.log('🧠 llm prompt', prompt);
 
       // call OpenAI
       const resp = await this.options.completeAdapter.complete(
@@ -441,7 +448,7 @@ ${
         300,
       );
 
-      process.env.HEAVY_DEBUG && console.log('llm resp', resp);
+      process.env.HEAVY_DEBUG && console.log('🧠 llm resp', resp);
 
       if (resp.error) {
         throw new AiTranslateError(resp.error);
@@ -457,7 +464,7 @@ ${
         res = resp.content.split("```json")[1].split("```")[0];
       } catch (e) {
         console.error('error in parsing OpenAI', resp);
-        return;
+        throw new AiTranslateError('Error in parsing OpenAI response');
       }
       res = JSON.parse(res);
 
@@ -524,6 +531,7 @@ ${
   }
 
   async processExtractedMessages(adminforth: IAdminForth, filePath: string) {
+    await processFrontendMessagesQueue.wait();
     // messages file is in i18n-messages.json
     let messages;
     try {
@@ -535,7 +543,7 @@ ${
       return;
     }
     // loop over missingKeys[i].path and add them to database if not exists
-
+    
     const missingKeysDeduplicated = messages.missingKeys.reduce((acc: any[], missingKey: any) => {
       if (!acc.find((a) => a.path === missingKey.path)) {
         acc.push(missingKey);
@@ -579,7 +587,10 @@ ${
     this.processExtractedMessages(adminforth, messagesFile);
     // we use watcher because file can't be yet created when we start - bundleNow can be done in build time or can be done now
     // that is why we make attempt to process it now and then watch for changes
-    const w = chokidar.watch(messagesFile, { persistent: true });
+    const w = chokidar.watch(messagesFile, { 
+      persistent: true,
+      ignoreInitial: true, // don't trigger 'add' event for existing file on start
+    });
     w.on('change', () => {
       process.env.HEAVY_DEBUG && console.log('🪲🔔messagesFile change', messagesFile);
 

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@adminforth/i18n",
-  "version": "1.0.13",
+  "version": "1.0.16-next.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
   "scripts": {
     "build": "tsc && rsync -av --exclude 'node_modules' custom dist/ && npm version patch",
     "rollout": "npm run build && npm publish --access public",
+    "rollout-next": "npm run build && npm version prerelease --preid=next && npm publish --tag next",
     "prepare": "npm link adminforth"
   },
   "keywords": [],
@@ -15,6 +16,7 @@
   "description": "",
   "dependencies": {
     "@aws-sdk/client-ses": "^3.654.0",
+    "@sapphire/async-queue": "^1.5.5",
     "chokidar": "^4.0.1",
     "iso-639-1": "^3.1.3"
   },