From f2ca00f1d82a58eb6b11891310e63e9c3490dd0b Mon Sep 17 00:00:00 2001 From: abdou6666 Date: Fri, 21 Mar 2025 15:17:59 +0100 Subject: [PATCH 1/5] feat: change getDefaultSettings to be async --- api/src/chat/controllers/block.controller.ts | 39 +++++++++++-------- .../i18n/services/translation.service.spec.ts | 31 +++++++-------- api/src/i18n/services/translation.service.ts | 21 +++++----- api/src/plugins/base-block-plugin.ts | 2 +- 4 files changed, 50 insertions(+), 43 deletions(-) diff --git a/api/src/chat/controllers/block.controller.ts b/api/src/chat/controllers/block.controller.ts index f09de5dc..c490ed84 100644 --- a/api/src/chat/controllers/block.controller.ts +++ b/api/src/chat/controllers/block.controller.ts @@ -127,24 +127,29 @@ export class BlockController extends BaseController< try { const plugins = this.pluginsService .getAllByType(PluginType.block) - .map((p) => ({ - id: p.getName(), - namespace: p.getNamespace(), - template: { - ...p.template, - message: { - plugin: p.name, - args: p.getDefaultSettings().reduce( - (acc, setting) => { - acc[setting.label] = setting.value; - return acc; - }, - {} as { [key: string]: any }, - ), + .map(async (p) => { + const defaultSettings = await p.getDefaultSettings(); + + return { + id: p.getName(), + namespace: p.getNamespace(), + template: { + ...p.template, + message: { + plugin: p.name, + args: defaultSettings.reduce( + (acc, setting) => { + acc[setting.label] = setting.value; + return acc; + }, + {} as { [key: string]: any }, + ), + }, }, - }, - effects: typeof p.effects === 'object' ? Object.keys(p.effects) : [], - })); + effects: + typeof p.effects === 'object' ? Object.keys(p.effects) : [], + }; + }); return plugins; } catch (e) { this.logger.error(e); diff --git a/api/src/i18n/services/translation.service.spec.ts b/api/src/i18n/services/translation.service.spec.ts index 9e7a0565..6103d0ef 100644 --- a/api/src/i18n/services/translation.service.spec.ts +++ b/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']); }); }); diff --git a/api/src/i18n/services/translation.service.ts b/api/src/i18n/services/translation.service.ts index 93bea9af..4c68d40c 100644 --- a/api/src/i18n/services/translation.service.ts +++ b/api/src/i18n/services/translation.service.ts @@ -45,8 +45,9 @@ export class TranslationService extends BaseService { * * @returns An array of strings */ - getBlockStrings(block: Block): string[] { + async getBlockStrings(block: Block): Promise { let strings: string[] = []; + if (Array.isArray(block.message)) { // Text Messages strings = strings.concat(block.message); @@ -56,12 +57,11 @@ export class TranslationService extends BaseService { 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); + Object.entries(block.message.args).forEach(async ([l, arg]) => { + const setting = defaultSettings?.find(({ label }) => label === l); if (setting?.translatable) { if (Array.isArray(arg)) { // array of text @@ -123,10 +123,13 @@ export class TranslationService extends BaseService { 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); + // allStrings = allStrings.concat(strings); + } + return allStrings; } /** diff --git a/api/src/plugins/base-block-plugin.ts b/api/src/plugins/base-block-plugin.ts index 0755cab3..fa30a4a7 100644 --- a/api/src/plugins/base-block-plugin.ts +++ b/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 { + async getDefaultSettings(): Promise { return this.settings; } From 409422b2c486c9912c5afc2af705c54782a0f7a1 Mon Sep 17 00:00:00 2001 From: abdou6666 Date: Fri, 21 Mar 2025 15:21:10 +0100 Subject: [PATCH 2/5] fix: remove comment --- api/src/i18n/services/translation.service.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/api/src/i18n/services/translation.service.ts b/api/src/i18n/services/translation.service.ts index 4c68d40c..3f38367f 100644 --- a/api/src/i18n/services/translation.service.ts +++ b/api/src/i18n/services/translation.service.ts @@ -127,7 +127,6 @@ export class TranslationService extends BaseService { for (const block of blocks) { const strings = await this.getBlockStrings(block); allStrings.push(...strings); - // allStrings = allStrings.concat(strings); } return allStrings; } From 408d50a5d38ed14e36f623d5904f81d7ae7c8ec7 Mon Sep 17 00:00:00 2001 From: abdou6666 Date: Mon, 24 Mar 2025 11:56:52 +0100 Subject: [PATCH 3/5] fix: base plugin getDefaultSettings --- api/src/plugins/base-block-plugin.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/src/plugins/base-block-plugin.ts b/api/src/plugins/base-block-plugin.ts index fa30a4a7..19d3d4f9 100644 --- a/api/src/plugins/base-block-plugin.ts +++ b/api/src/plugins/base-block-plugin.ts @@ -38,7 +38,7 @@ export abstract class BaseBlockPlugin< this.settings = require(path.join(this.getPath(), 'settings')).default; } - async getDefaultSettings(): Promise { + getDefaultSettings(): Promise | T { return this.settings; } From 992ae79fc3fcdd0551498dad98fbc53af52ac495 Mon Sep 17 00:00:00 2001 From: abdou6666 Date: Mon, 24 Mar 2025 11:59:18 +0100 Subject: [PATCH 4/5] fix: update block controller --- api/src/chat/controllers/block.controller.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/api/src/chat/controllers/block.controller.ts b/api/src/chat/controllers/block.controller.ts index c490ed84..92b48823 100644 --- a/api/src/chat/controllers/block.controller.ts +++ b/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,7 +123,7 @@ 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) @@ -150,7 +150,7 @@ export class BlockController extends BaseController< typeof p.effects === 'object' ? Object.keys(p.effects) : [], }; }); - return plugins; + return await Promise.all(plugins); } catch (e) { this.logger.error(e); throw e; From ccbe954bef43596b9404075d67b7db3f174c8947 Mon Sep 17 00:00:00 2001 From: abdou6666 Date: Mon, 24 Mar 2025 12:03:50 +0100 Subject: [PATCH 5/5] fix: remove unnecessary async --- api/src/i18n/services/translation.service.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/src/i18n/services/translation.service.ts b/api/src/i18n/services/translation.service.ts index 3f38367f..c2adddd8 100644 --- a/api/src/i18n/services/translation.service.ts +++ b/api/src/i18n/services/translation.service.ts @@ -60,7 +60,7 @@ export class TranslationService extends BaseService { const defaultSettings = await plugin?.getDefaultSettings(); // plugin - Object.entries(block.message.args).forEach(async ([l, arg]) => { + Object.entries(block.message.args).forEach(([l, arg]) => { const setting = defaultSettings?.find(({ label }) => label === l); if (setting?.translatable) { if (Array.isArray(arg)) {