mirror of
https://github.com/hexastack/hexabot
synced 2024-11-24 04:53:41 +00:00
fix: display translatable settings only in translations UI
This commit is contained in:
parent
2d4b00b9c0
commit
c655026386
@ -7,6 +7,7 @@
|
||||
*/
|
||||
|
||||
import { Attachment } from '@/attachment/schemas/attachment.schema';
|
||||
import { PluginName } from '@/plugins/types';
|
||||
|
||||
import { Message } from '../message.schema';
|
||||
|
||||
@ -107,7 +108,7 @@ export type StdOutgoingAttachmentMessage<
|
||||
};
|
||||
|
||||
export type StdPluginMessage = {
|
||||
plugin: string;
|
||||
plugin: PluginName;
|
||||
args: { [key: string]: any };
|
||||
};
|
||||
|
||||
|
@ -45,6 +45,7 @@ export default [
|
||||
label: Web.SettingLabel.greeting_message,
|
||||
value: 'Welcome! Ready to start a conversation with our chatbot?',
|
||||
type: SettingType.textarea,
|
||||
translatable: true,
|
||||
},
|
||||
{
|
||||
group: WEB_CHANNEL_NAMESPACE,
|
||||
@ -58,6 +59,7 @@ export default [
|
||||
label: Web.SettingLabel.window_title,
|
||||
value: 'Widget Title',
|
||||
type: SettingType.text,
|
||||
translatable: true,
|
||||
},
|
||||
{
|
||||
group: WEB_CHANNEL_NAMESPACE,
|
||||
|
@ -10,6 +10,8 @@ import { EventEmitter2 } from '@nestjs/event-emitter';
|
||||
import { Test, TestingModule } from '@nestjs/testing';
|
||||
|
||||
import { I18nService } from '@/i18n/services/i18n.service';
|
||||
import { PluginService } from '@/plugins/plugins.service';
|
||||
import { SettingType } from '@/setting/schemas/types';
|
||||
import { SettingService } from '@/setting/services/setting.service';
|
||||
|
||||
import { Block } from '../../chat/schemas/block.schema';
|
||||
@ -22,6 +24,7 @@ describe('TranslationService', () => {
|
||||
let service: TranslationService;
|
||||
let settingService: SettingService;
|
||||
let i18nService: I18nService;
|
||||
let pluginService: PluginService;
|
||||
|
||||
beforeEach(async () => {
|
||||
const module: TestingModule = await Test.createTestingModule({
|
||||
@ -39,6 +42,12 @@ describe('TranslationService', () => {
|
||||
]),
|
||||
},
|
||||
},
|
||||
{
|
||||
provide: PluginService,
|
||||
useValue: {
|
||||
getPlugin: jest.fn(),
|
||||
},
|
||||
},
|
||||
{
|
||||
provide: BlockService,
|
||||
useValue: {
|
||||
@ -58,12 +67,16 @@ describe('TranslationService', () => {
|
||||
{
|
||||
provide: SettingService,
|
||||
useValue: {
|
||||
getSettings: jest.fn().mockResolvedValue({
|
||||
chatbot_settings: {
|
||||
global_fallback: true,
|
||||
fallback_message: ['Global fallback message'],
|
||||
getSettings: jest
|
||||
.fn()
|
||||
.mockResolvedValue(['Global fallback message']),
|
||||
find: jest.fn().mockResolvedValue([
|
||||
{
|
||||
translatable: true,
|
||||
key: 'global_fallback',
|
||||
value: 'Global fallback message',
|
||||
},
|
||||
}),
|
||||
]),
|
||||
},
|
||||
},
|
||||
{
|
||||
@ -79,6 +92,7 @@ describe('TranslationService', () => {
|
||||
service = module.get<TranslationService>(TranslationService);
|
||||
settingService = module.get<SettingService>(SettingService);
|
||||
i18nService = module.get<I18nService>(I18nService);
|
||||
pluginService = module.get<PluginService>(PluginService);
|
||||
});
|
||||
|
||||
it('should call refreshDynamicTranslations with translations from findAll', async () => {
|
||||
@ -98,9 +112,60 @@ describe('TranslationService', () => {
|
||||
expect(strings).toEqual(['Test message', 'Fallback message']);
|
||||
});
|
||||
|
||||
it('should return an array of strings from the settings when global fallback is enabled', async () => {
|
||||
const strings = await service.getSettingStrings();
|
||||
expect(strings).toEqual(['Global fallback message']);
|
||||
it('should return plugin-related strings from block message with translatable args', () => {
|
||||
const block: Block = {
|
||||
name: 'Ollama Plugin',
|
||||
patterns: [],
|
||||
assign_labels: [],
|
||||
trigger_channels: [],
|
||||
trigger_labels: [],
|
||||
nextBlocks: [],
|
||||
category: '673f82f4bafd1e2a00e7e53e',
|
||||
starts_conversation: false,
|
||||
builtin: false,
|
||||
capture_vars: [],
|
||||
createdAt: new Date(),
|
||||
updatedAt: new Date(),
|
||||
id: '673f8724007f1087c96d30d0',
|
||||
position: { x: 702, y: 321.8333282470703 },
|
||||
message: {
|
||||
plugin: 'ollama-plugin',
|
||||
args: {
|
||||
model: 'String 1',
|
||||
context: ['String 2', 'String 3'],
|
||||
},
|
||||
},
|
||||
options: {},
|
||||
};
|
||||
|
||||
const mockedPlugin: any = {
|
||||
name: 'ollama-plugin',
|
||||
type: 'block',
|
||||
settings: [
|
||||
{
|
||||
label: 'model',
|
||||
group: 'default',
|
||||
type: SettingType.text,
|
||||
value: 'llama3.2',
|
||||
translatable: false,
|
||||
},
|
||||
{
|
||||
label: 'context',
|
||||
group: 'default',
|
||||
type: SettingType.multiple_text,
|
||||
value: ['Answer the user QUESTION using the DOCUMENTS text above.'],
|
||||
translatable: true,
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
jest
|
||||
.spyOn(pluginService, 'getPlugin')
|
||||
.mockImplementation(() => mockedPlugin);
|
||||
|
||||
const result = service.getBlockStrings(block);
|
||||
|
||||
expect(result).toEqual(['String 2', 'String 3']);
|
||||
});
|
||||
|
||||
it('should return an empty array from the settings when global fallback is disabled', async () => {
|
||||
|
@ -10,6 +10,8 @@ import { Injectable } from '@nestjs/common';
|
||||
import { OnEvent } from '@nestjs/event-emitter';
|
||||
|
||||
import { I18nService } from '@/i18n/services/i18n.service';
|
||||
import { PluginService } from '@/plugins/plugins.service';
|
||||
import { PluginType } from '@/plugins/types';
|
||||
import { SettingService } from '@/setting/services/setting.service';
|
||||
import { BaseService } from '@/utils/generics/base-service';
|
||||
|
||||
@ -24,6 +26,7 @@ export class TranslationService extends BaseService<Translation> {
|
||||
readonly repository: TranslationRepository,
|
||||
private readonly blockService: BlockService,
|
||||
private readonly settingService: SettingService,
|
||||
private readonly pluginService: PluginService,
|
||||
private readonly i18n: I18nService,
|
||||
) {
|
||||
super(repository);
|
||||
@ -49,8 +52,16 @@ export class TranslationService extends BaseService<Translation> {
|
||||
strings = strings.concat(block.message);
|
||||
} else if (typeof block.message === 'object') {
|
||||
if ('plugin' in block.message) {
|
||||
const plugin = this.pluginService.getPlugin(
|
||||
PluginType.block,
|
||||
block.message.plugin,
|
||||
);
|
||||
|
||||
// plugin
|
||||
Object.values(block.message.args).forEach((arg) => {
|
||||
Object.entries(block.message.args).forEach(([l, arg]) => {
|
||||
const setting = plugin.settings.find(({ label }) => label === l);
|
||||
|
||||
if (setting?.translatable) {
|
||||
if (Array.isArray(arg)) {
|
||||
// array of text
|
||||
strings = strings.concat(arg);
|
||||
@ -58,6 +69,7 @@ export class TranslationService extends BaseService<Translation> {
|
||||
// text
|
||||
strings.push(arg);
|
||||
}
|
||||
}
|
||||
});
|
||||
} else if ('text' in block.message && Array.isArray(block.message.text)) {
|
||||
// array of text
|
||||
@ -121,12 +133,18 @@ export class TranslationService extends BaseService<Translation> {
|
||||
* @returns A promise of all strings available in a array
|
||||
*/
|
||||
async getSettingStrings(): Promise<string[]> {
|
||||
let strings: string[] = [];
|
||||
const translatableSettings = await this.settingService.find({
|
||||
translatable: true,
|
||||
});
|
||||
const settings = await this.settingService.getSettings();
|
||||
if (settings.chatbot_settings.global_fallback) {
|
||||
strings = strings.concat(settings.chatbot_settings.fallback_message);
|
||||
}
|
||||
return strings;
|
||||
return Object.values(settings)
|
||||
.map((group: Record<string, string | string[]>) => Object.entries(group))
|
||||
.flat()
|
||||
.filter(([l]) => {
|
||||
return translatableSettings.find(({ label }) => label === l);
|
||||
})
|
||||
.map(([, v]) => v)
|
||||
.flat();
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -24,7 +24,9 @@ export interface CustomBlocks {}
|
||||
|
||||
type BlockAttrs = Partial<BlockCreateDto> & { name: string };
|
||||
|
||||
export type PluginSetting = Omit<SettingCreateDto, 'weight'>;
|
||||
export type PluginSetting = Omit<SettingCreateDto, 'weight'> & {
|
||||
translatable?: boolean;
|
||||
};
|
||||
|
||||
export type PluginBlockTemplate = Omit<
|
||||
BlockAttrs,
|
||||
|
@ -9,6 +9,7 @@
|
||||
import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
|
||||
import {
|
||||
IsArray,
|
||||
IsBoolean,
|
||||
IsIn,
|
||||
IsNotEmpty,
|
||||
IsOptional,
|
||||
@ -65,8 +66,20 @@ export class SettingCreateDto {
|
||||
//TODO: adding swagger decorators
|
||||
config?: Record<string, any>;
|
||||
|
||||
//TODO: adding swagger decorators
|
||||
@ApiPropertyOptional({
|
||||
description:
|
||||
'Defines the display order of the setting in the user interface',
|
||||
type: Number,
|
||||
})
|
||||
weight: number;
|
||||
|
||||
@ApiPropertyOptional({
|
||||
description: 'Indicates whether this setting supports translation',
|
||||
type: Boolean,
|
||||
})
|
||||
@IsBoolean()
|
||||
@IsOptional()
|
||||
translatable?: boolean;
|
||||
}
|
||||
|
||||
export class SettingUpdateDto {
|
||||
|
@ -58,6 +58,12 @@ export class Setting extends BaseSchema {
|
||||
default: 0,
|
||||
})
|
||||
weight?: number;
|
||||
|
||||
@Prop({
|
||||
type: Boolean,
|
||||
default: false,
|
||||
})
|
||||
translatable?: boolean;
|
||||
}
|
||||
|
||||
export const SettingModel: ModelDefinition = LifecycleHookManager.attach({
|
||||
|
@ -69,6 +69,7 @@ export const DEFAULT_SETTINGS = [
|
||||
] as string[],
|
||||
type: SettingType.multiple_text,
|
||||
weight: 5,
|
||||
translatable: true,
|
||||
},
|
||||
{
|
||||
group: 'contact',
|
||||
|
18
api/src/utils/test/fixtures/setting.ts
vendored
18
api/src/utils/test/fixtures/setting.ts
vendored
@ -19,6 +19,15 @@ export const settingFixtures: SettingCreateDto[] = [
|
||||
value: 'admin@example.com',
|
||||
type: SettingType.text,
|
||||
weight: 1,
|
||||
translatable: false,
|
||||
},
|
||||
{
|
||||
group: 'contact',
|
||||
label: 'greeting',
|
||||
value: 'hello',
|
||||
type: SettingType.text,
|
||||
weight: 10,
|
||||
translatable: true,
|
||||
},
|
||||
{
|
||||
group: 'contact',
|
||||
@ -26,6 +35,7 @@ export const settingFixtures: SettingCreateDto[] = [
|
||||
value: 'Your company name',
|
||||
type: SettingType.text,
|
||||
weight: 2,
|
||||
translatable: false,
|
||||
},
|
||||
{
|
||||
group: 'contact',
|
||||
@ -33,6 +43,7 @@ export const settingFixtures: SettingCreateDto[] = [
|
||||
value: '(+999) 9999 9999 999',
|
||||
type: SettingType.text,
|
||||
weight: 3,
|
||||
translatable: false,
|
||||
},
|
||||
{
|
||||
group: 'contact',
|
||||
@ -40,6 +51,7 @@ export const settingFixtures: SettingCreateDto[] = [
|
||||
value: 'contact[at]mycompany.com',
|
||||
type: SettingType.text,
|
||||
weight: 4,
|
||||
translatable: false,
|
||||
},
|
||||
{
|
||||
group: 'contact',
|
||||
@ -47,6 +59,7 @@ export const settingFixtures: SettingCreateDto[] = [
|
||||
value: '71 Pilgrim Avenue',
|
||||
type: SettingType.text,
|
||||
weight: 5,
|
||||
translatable: false,
|
||||
},
|
||||
{
|
||||
group: 'contact',
|
||||
@ -54,6 +67,7 @@ export const settingFixtures: SettingCreateDto[] = [
|
||||
value: '',
|
||||
type: SettingType.text,
|
||||
weight: 6,
|
||||
translatable: false,
|
||||
},
|
||||
{
|
||||
group: 'contact',
|
||||
@ -61,6 +75,7 @@ export const settingFixtures: SettingCreateDto[] = [
|
||||
value: 'Chevy Chase',
|
||||
type: SettingType.text,
|
||||
weight: 7,
|
||||
translatable: false,
|
||||
},
|
||||
{
|
||||
group: 'contact',
|
||||
@ -68,6 +83,7 @@ export const settingFixtures: SettingCreateDto[] = [
|
||||
value: '85705',
|
||||
type: SettingType.text,
|
||||
weight: 8,
|
||||
translatable: false,
|
||||
},
|
||||
{
|
||||
group: 'contact',
|
||||
@ -75,6 +91,7 @@ export const settingFixtures: SettingCreateDto[] = [
|
||||
value: 'Orlando',
|
||||
type: SettingType.text,
|
||||
weight: 9,
|
||||
translatable: false,
|
||||
},
|
||||
{
|
||||
group: 'contact',
|
||||
@ -82,6 +99,7 @@ export const settingFixtures: SettingCreateDto[] = [
|
||||
value: 'US',
|
||||
type: SettingType.text,
|
||||
weight: 10,
|
||||
translatable: false,
|
||||
},
|
||||
];
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user