Merge pull request #844 from Hexastack/feat/change-getDefaultSettings-to-async

feat: change getDefaultSettings to be async

api/src/chat/controllers/block.controller.ts

@@ -93,7 +93,7 @@ export class BlockController extends BaseController<
    * @returns An array containing the settings of the specified plugin.
    */
   @Get('customBlocks/settings')
-  findSettings(@Query('plugin') pluginName: PluginName) {
+  async findSettings(@Query('plugin') pluginName: PluginName) {
     try {
       if (!pluginName) {
         throw new BadRequestException(
@@ -110,7 +110,7 @@ export class BlockController extends BaseController<
         throw new NotFoundException('Plugin Not Found');
       }
 
-      return plugin.getDefaultSettings();
+      return await plugin.getDefaultSettings();
     } catch (e) {
       this.logger.error('Unable to fetch plugin settings', e);
       throw e;
@@ -123,18 +123,21 @@ export class BlockController extends BaseController<
    * @returns An array containing available custom blocks.
    */
   @Get('customBlocks')
-  findAll() {
+  async findAll() {
     try {
       const plugins = this.pluginsService
         .getAllByType(PluginType.block)
-        .map((p) => ({
+        .map(async (p) => {
+          const defaultSettings = await p.getDefaultSettings();
+
+          return {
             id: p.getName(),
             namespace: p.getNamespace(),
             template: {
               ...p.template,
               message: {
                 plugin: p.name,
-              args: p.getDefaultSettings().reduce(
+                args: defaultSettings.reduce(
                   (acc, setting) => {
                     acc[setting.label] = setting.value;
                     return acc;
@@ -143,9 +146,11 @@ export class BlockController extends BaseController<
                 ),
               },
             },
-          effects: typeof p.effects === 'object' ? Object.keys(p.effects) : [],
-        }));
-      return plugins;
+            effects:
+              typeof p.effects === 'object' ? Object.keys(p.effects) : [],
+          };
+        });
+      return await Promise.all(plugins);
     } catch (e) {
       this.logger.error(e);
       throw e;

api/src/i18n/services/translation.service.spec.ts

@@ -132,7 +132,7 @@ describe('TranslationService', () => {
     expect(strings).toEqual(['Test message', 'Fallback message']);
   });
 
-  it('should return plugin-related strings from block message with translatable args', () => {
+  it('should return plugin-related strings from block message with translatable args', async () => {
     const block: Block = {
       name: 'Ollama Plugin',
       patterns: [],
@@ -203,7 +203,7 @@ describe('TranslationService', () => {
         return '/mock/path';
       }
 
-      getDefaultSettings() {
+      async getDefaultSettings() {
         return this.settings;
       }
     }
@@ -215,8 +215,7 @@ describe('TranslationService', () => {
       .spyOn(pluginService, 'getPlugin')
       .mockImplementation(() => mockedPlugin);
 
-    const result = service.getBlockStrings(block);
-
+    const result = await service.getBlockStrings(block);
     expect(result).toEqual(['String 2', 'String 3']);
   });
 
@@ -225,7 +224,7 @@ describe('TranslationService', () => {
     expect(strings).toEqual(['Global fallback message']);
   });
 
-  it('should return an array of strings from a block with a quick reply message', () => {
+  it('should return an array of strings from a block with a quick reply message', async () => {
     const block = {
       id: 'blockId',
       name: 'Test Block',
@@ -252,7 +251,7 @@ describe('TranslationService', () => {
       createdAt: new Date(),
       updatedAt: new Date(),
     } as Block;
-    const strings = service.getBlockStrings(block);
+    const strings = await service.getBlockStrings(block);
     expect(strings).toEqual([
       'Test message',
       'Quick reply 1',
@@ -261,7 +260,7 @@ describe('TranslationService', () => {
     ]);
   });
 
-  it('should return an array of strings from a block with a button message', () => {
+  it('should return an array of strings from a block with a button message', async () => {
     const block = {
       id: 'blockId',
       name: 'Test Block',
@@ -288,7 +287,7 @@ describe('TranslationService', () => {
       createdAt: new Date(),
       updatedAt: new Date(),
     } as Block;
-    const strings = service.getBlockStrings(block);
+    const strings = await service.getBlockStrings(block);
     expect(strings).toEqual([
       'Test message',
       'Button 1',
@@ -297,7 +296,7 @@ describe('TranslationService', () => {
     ]);
   });
 
-  it('should return an array of strings from a block with a text message', () => {
+  it('should return an array of strings from a block with a text message', async () => {
     const block = {
       id: 'blockId',
       name: 'Test Block',
@@ -314,11 +313,11 @@ describe('TranslationService', () => {
       createdAt: new Date(),
       updatedAt: new Date(),
     } as Block;
-    const strings = service.getBlockStrings(block);
+    const strings = await service.getBlockStrings(block);
     expect(strings).toEqual(['Test message', 'Fallback message']);
   });
 
-  it('should return an array of strings from a block with a nested message object', () => {
+  it('should return an array of strings from a block with a nested message object', async () => {
     const block = {
       id: 'blockId',
       name: 'Test Block',
@@ -337,11 +336,11 @@ describe('TranslationService', () => {
       createdAt: new Date(),
       updatedAt: new Date(),
     } as Block;
-    const strings = service.getBlockStrings(block);
+    const strings = await service.getBlockStrings(block);
     expect(strings).toEqual(['Test message', 'Fallback message']);
   });
 
-  it('should handle different message formats in getBlockStrings', () => {
+  it('should handle different message formats in getBlockStrings', async () => {
     // Covers lines 54-60, 65
 
     // Test with an array message (line 54-57)
@@ -350,7 +349,7 @@ describe('TranslationService', () => {
       message: ['This is a text message'],
       options: { fallback: { message: ['Fallback message'] } },
     } as Block;
-    const strings1 = service.getBlockStrings(block1);
+    const strings1 = await service.getBlockStrings(block1);
     expect(strings1).toEqual(['This is a text message', 'Fallback message']);
 
     // Test with an object message (line 58-60)
@@ -359,7 +358,7 @@ describe('TranslationService', () => {
       message: { text: 'Another text message' },
       options: { fallback: { message: ['Fallback message'] } },
     } as Block;
-    const strings2 = service.getBlockStrings(block2);
+    const strings2 = await service.getBlockStrings(block2);
     expect(strings2).toEqual(['Another text message', 'Fallback message']);
 
     // Test a block without a fallback (line 65)
@@ -368,7 +367,7 @@ describe('TranslationService', () => {
       message: { text: 'Another test message' },
       options: {},
     } as Block;
-    const strings3 = service.getBlockStrings(block3);
+    const strings3 = await service.getBlockStrings(block3);
     expect(strings3).toEqual(['Another test message']);
   });
 });

api/src/i18n/services/translation.service.ts

@@ -45,8 +45,9 @@ export class TranslationService extends BaseService<Translation> {
    *
    * @returns An array of strings
    */
-  getBlockStrings(block: Block): string[] {
+  async getBlockStrings(block: Block): Promise<string[]> {
     let strings: string[] = [];
+
     if (Array.isArray(block.message)) {
       // Text Messages
       strings = strings.concat(block.message);
@@ -56,12 +57,11 @@ export class TranslationService extends BaseService<Translation> {
           PluginType.block,
           block.message.plugin,
         );
+        const defaultSettings = await plugin?.getDefaultSettings();
 
         // plugin
         Object.entries(block.message.args).forEach(([l, arg]) => {
-          const setting = plugin
-            ?.getDefaultSettings()
-            .find(({ label }) => label === l);
+          const setting = defaultSettings?.find(({ label }) => label === l);
           if (setting?.translatable) {
             if (Array.isArray(arg)) {
               // array of text
@@ -123,10 +123,12 @@ export class TranslationService extends BaseService<Translation> {
     if (blocks.length === 0) {
       return [];
     }
-    return blocks.reduce((acc, block) => {
-      const strings = this.getBlockStrings(block);
-      return acc.concat(strings);
-    }, [] as string[]);
+    const allStrings: string[] = [];
+    for (const block of blocks) {
+      const strings = await this.getBlockStrings(block);
+      allStrings.push(...strings);
+    }
+    return allStrings;
   }
 
   /**

api/src/plugins/base-block-plugin.ts

@@ -38,7 +38,7 @@ export abstract class BaseBlockPlugin<
     this.settings = require(path.join(this.getPath(), 'settings')).default;
   }
 
-  getDefaultSettings(): T {
+  getDefaultSettings(): Promise<T> | T {
     return this.settings;
   }