refactor: update Flowise integration for improved configuration and validation

gomessguii · gomessguii · commit 95bd85b6e3cd · 2025-05-27T15:49:15.000-03:00
This commit refines the Flowise integration by enhancing configuration management and validation logic. Key changes include:
- Reordered parameters in the FlowiseService constructor for consistency.
- Updated FlowiseController to utilize the configService for integration enablement checks.
- Simplified FlowiseDto and FlowiseSettingDto by removing unused properties.
- Enhanced validation logic in flowise.schema.ts to include new fields.
- Improved error handling in the createBot method to prevent duplicate entries.

These updates contribute to a more robust and maintainable Flowise integration.
diff --git a/src/api/integrations/chatbot/flowise/controllers/flowise.controller.ts b/src/api/integrations/chatbot/flowise/controllers/flowise.controller.ts
@@ -1,13 +1,16 @@
+import { InstanceDto } from '@api/dto/instance.dto';
 import { PrismaRepository } from '@api/repository/repository.service';
 import { WAMonitoringService } from '@api/services/monitor.service';
+import { configService, Flowise } from '@config/env.config';
 import { Logger } from '@config/logger.config';
-import { Flowise, IntegrationSession } from '@prisma/client';
+import { BadRequestException } from '@exceptions';
+import { Flowise as FlowiseModel, IntegrationSession } from '@prisma/client';
 
 import { BaseChatbotController } from '../../base-chatbot.controller';
 import { FlowiseDto } from '../dto/flowise.dto';
 import { FlowiseService } from '../services/flowise.service';
 
-export class FlowiseController extends BaseChatbotController<Flowise, FlowiseDto> {
+export class FlowiseController extends BaseChatbotController<FlowiseModel, FlowiseDto> {
   constructor(
     private readonly flowiseService: FlowiseService,
     prismaRepository: PrismaRepository,
@@ -23,14 +26,12 @@ export class FlowiseController extends BaseChatbotController<Flowise, FlowiseDto
   public readonly logger = new Logger('FlowiseController');
   protected readonly integrationName = 'Flowise';
 
-  integrationEnabled = true; // Set to true by default or use config value if available
+  integrationEnabled = configService.get<Flowise>('FLOWISE').ENABLED;
   botRepository: any;
   settingsRepository: any;
   sessionRepository: any;
   userMessageDebounce: { [key: string]: { message: string; timeoutId: NodeJS.Timeout } } = {};
 
-  // Implementation of abstract methods required by BaseChatbotController
-
   protected getFallbackBotId(settings: any): string | undefined {
     return settings?.flowiseIdFallback;
   }
@@ -50,21 +51,17 @@ export class FlowiseController extends BaseChatbotController<Flowise, FlowiseDto
     };
   }
 
-  // Implementation for bot-specific updates
   protected getAdditionalUpdateFields(data: FlowiseDto): Record<string, any> {
     return {
       apiUrl: data.apiUrl,
       apiKey: data.apiKey,
     };
   }
 
-  // Implementation for bot-specific duplicate validation on update
   protected async validateNoDuplicatesOnUpdate(botId: string, instanceId: string, data: FlowiseDto): Promise<void> {
     const checkDuplicate = await this.botRepository.findFirst({
       where: {
-        id: {
-          not: botId,
-        },
+        id: { not: botId },
         instanceId: instanceId,
         apiUrl: data.apiUrl,
         apiKey: data.apiKey,
@@ -76,16 +73,47 @@ export class FlowiseController extends BaseChatbotController<Flowise, FlowiseDto
     }
   }
 
-  // Process bot-specific logic
+  // Process Flowise-specific bot logic
   protected async processBot(
     instance: any,
     remoteJid: string,
-    bot: Flowise,
+    bot: FlowiseModel,
     session: IntegrationSession,
     settings: any,
     content: string,
     pushName?: string,
+    msg?: any,
   ) {
-    await this.flowiseService.process(instance, remoteJid, bot, session, settings, content, pushName);
+    await this.flowiseService.processBot(instance, remoteJid, bot, session, settings, content, pushName, msg);
+  }
+
+  // Override createBot to add module availability check and Flowise-specific validation
+  public async createBot(instance: InstanceDto, data: FlowiseDto) {
+    if (!this.integrationEnabled)
+      throw new BadRequestException('Flowise is disabled');
+
+    const instanceId = await this.prismaRepository.instance
+      .findFirst({
+        where: {
+          name: instance.instanceName,
+        },
+      })
+      .then((instance) => instance.id);
+
+    // Flowise-specific duplicate check
+    const checkDuplicate = await this.botRepository.findFirst({
+      where: {
+        instanceId: instanceId,
+        apiUrl: data.apiUrl,
+        apiKey: data.apiKey,
+      },
+    });
+
+    if (checkDuplicate) {
+      throw new Error('Flowise already exists');
+    }
+
+    // Let the base class handle the rest
+    return super.createBot(instance, data);
   }
 }
diff --git a/src/api/integrations/chatbot/flowise/dto/flowise.dto.ts b/src/api/integrations/chatbot/flowise/dto/flowise.dto.ts
@@ -1,39 +1,10 @@
-import { TriggerOperator, TriggerType } from '@prisma/client';
-
 import { BaseChatbotDto, BaseChatbotSettingDto } from '../../base-chatbot.dto';
 
 export class FlowiseDto extends BaseChatbotDto {
   apiUrl: string;
-  apiKey: string;
-  description: string;
-  keywordFinish?: string | null;
-  triggerType: TriggerType;
-  enabled?: boolean;
-  expire?: number;
-  delayMessage?: number;
-  unknownMessage?: string;
-  listeningFromMe?: boolean;
-  stopBotFromMe?: boolean;
-  keepOpen?: boolean;
-  debounceTime?: number;
-  triggerOperator?: TriggerOperator;
-  triggerValue?: string;
-  ignoreJids?: any;
-  splitMessages?: boolean;
-  timePerChar?: number;
+  apiKey?: string;
 }
 
 export class FlowiseSettingDto extends BaseChatbotSettingDto {
-  expire?: number;
-  keywordFinish?: string | null;
-  delayMessage?: number;
-  unknownMessage?: string;
-  listeningFromMe?: boolean;
-  stopBotFromMe?: boolean;
-  keepOpen?: boolean;
-  debounceTime?: number;
   flowiseIdFallback?: string;
-  ignoreJids?: any;
-  splitMessages?: boolean;
-  timePerChar?: number;
 }
diff --git a/src/api/integrations/chatbot/flowise/services/flowise.service.ts b/src/api/integrations/chatbot/flowise/services/flowise.service.ts
@@ -2,133 +2,135 @@
 import { PrismaRepository } from '@api/repository/repository.service';
 import { WAMonitoringService } from '@api/services/monitor.service';
 import { Integration } from '@api/types/wa.types';
-import { Auth, ConfigService, HttpServer } from '@config/env.config';
-import { Flowise, FlowiseSetting, IntegrationSession } from '@prisma/client';
-import { sendTelemetry } from '@utils/sendTelemetry';
+import { ConfigService, HttpServer } from '@config/env.config';
+import { Flowise as FlowiseModel, IntegrationSession } from '@prisma/client';
 import axios from 'axios';
 
 import { BaseChatbotService } from '../../base-chatbot.service';
 import { OpenaiService } from '../../openai/services/openai.service';
 
-export class FlowiseService extends BaseChatbotService<Flowise, FlowiseSetting> {
+export class FlowiseService extends BaseChatbotService<FlowiseModel> {
   private openaiService: OpenaiService;
+
   constructor(
     waMonitor: WAMonitoringService,
-    configService: ConfigService,
     prismaRepository: PrismaRepository,
+    configService: ConfigService,
     openaiService: OpenaiService,
   ) {
     super(waMonitor, prismaRepository, 'FlowiseService', configService);
     this.openaiService = openaiService;
   }
 
-  /**
-   * Get the bot type identifier
-   */
+  // Return the bot type for Flowise
   protected getBotType(): string {
     return 'flowise';
   }
 
-  /**
-   * Send a message to the Flowise API
-   */
+  // Process Flowise-specific bot logic
+  public async processBot(
+    instance: any,
+    remoteJid: string,
+    bot: FlowiseModel,
+    session: IntegrationSession,
+    settings: any,
+    content: string,
+    pushName?: string,
+    msg?: any,
+  ) {
+    await this.process(instance, remoteJid, bot, session, settings, content, pushName, msg);
+  }
+
+  // Implement the abstract method to send message to Flowise API
   protected async sendMessageToBot(
     instance: any,
     session: IntegrationSession,
-    settings: FlowiseSetting,
-    bot: Flowise,
+    settings: any,
+    bot: FlowiseModel,
     remoteJid: string,
     pushName: string,
     content: string,
     msg?: any,
   ): Promise<void> {
-    try {
-      const payload: any = {
-        question: content,
-        overrideConfig: {
-          sessionId: remoteJid,
-          vars: {
-            remoteJid: remoteJid,
-            pushName: pushName,
-            instanceName: instance.instanceName,
-            serverUrl: this.configService.get<HttpServer>('SERVER').URL,
-            apiKey: instance.token,
-          },
+    const payload: any = {
+      question: content,
+      overrideConfig: {
+        sessionId: remoteJid,
+        vars: {
+          remoteJid: remoteJid,
+          pushName: pushName,
+          instanceName: instance.instanceName,
+          serverUrl: this.configService.get<HttpServer>('SERVER').URL,
+          apiKey: instance.token,
         },
-      };
-
-      if (this.isAudioMessage(content) && msg) {
-        try {
-          this.logger.debug(`[EvolutionBot] Downloading audio for Whisper transcription`);
-          const transcription = await this.openaiService.speechToText(msg);
-          if (transcription) {
-            payload.query = transcription;
-          } else {
-            payload.query = '[Audio message could not be transcribed]';
-          }
-        } catch (err) {
-          this.logger.error(`[EvolutionBot] Failed to transcribe audio: ${err}`);
-          payload.query = '[Audio message could not be transcribed]';
+      },
+    };
+
+    // Handle audio messages
+    if (this.isAudioMessage(content) && msg) {
+      try {
+        this.logger.debug(`[Flowise] Downloading audio for Whisper transcription`);
+        const transcription = await this.openaiService.speechToText(msg, instance);
+        if (transcription) {
+          payload.question = transcription;
         }
+      } catch (err) {
+        this.logger.error(`[Flowise] Failed to transcribe audio: ${err}`);
       }
+    }
 
-      if (this.isImageMessage(content)) {
-        const contentSplit = content.split('|');
-
-        payload.uploads = [
-          {
-            data: contentSplit[1].split('?')[0],
-            type: 'url',
-            name: 'Flowise.png',
-            mime: 'image/png',
-          },
-        ];
-        payload.question = contentSplit[2] || content;
-      }
+    if (this.isImageMessage(content)) {
+      const contentSplit = content.split('|');
 
-      if (instance.integration === Integration.WHATSAPP_BAILEYS) {
-        await instance.client.presenceSubscribe(remoteJid);
-        await instance.client.sendPresenceUpdate('composing', remoteJid);
-      }
+      payload.uploads = [
+        {
+          data: contentSplit[1].split('?')[0],
+          type: 'url',
+          name: 'Flowise.png',
+          mime: 'image/png',
+        },
+      ];
+      payload.question = contentSplit[2] || content;
+    }
 
-      let headers: any = {
-        'Content-Type': 'application/json',
-      };
+    if (instance.integration === Integration.WHATSAPP_BAILEYS) {
+      await instance.client.presenceSubscribe(remoteJid);
+      await instance.client.sendPresenceUpdate('composing', remoteJid);
+    }
 
-      if (bot.apiKey) {
-        headers = {
-          ...headers,
-          Authorization: `Bearer ${bot.apiKey}`,
-        };
-      }
+    let headers: any = {
+      'Content-Type': 'application/json',
+    };
 
-      const endpoint = bot.apiUrl;
+    if (bot.apiKey) {
+      headers = {
+        ...headers,
+        Authorization: `Bearer ${bot.apiKey}`,
+      };
+    }
 
-      if (!endpoint) {
-        this.logger.error('No Flowise endpoint defined');
-        return;
-      }
+    const endpoint = bot.apiUrl;
 
-      const response = await axios.post(endpoint, payload, {
-        headers,
-      });
+    if (!endpoint) {
+      this.logger.error('No Flowise endpoint defined');
+      return;
+    }
 
-      if (instance.integration === Integration.WHATSAPP_BAILEYS) {
-        await instance.client.sendPresenceUpdate('paused', remoteJid);
-      }
+    const response = await axios.post(endpoint, payload, {
+      headers,
+    });
 
-      const message = response?.data?.text;
+    if (instance.integration === Integration.WHATSAPP_BAILEYS) {
+      await instance.client.sendPresenceUpdate('paused', remoteJid);
+    }
 
-      if (message) {
-        // Use the base class method to send the message to WhatsApp
-        await this.sendMessageWhatsApp(instance, remoteJid, message, settings);
-      }
+    const message = response?.data?.text;
 
-      // Send telemetry
-      sendTelemetry('/message/sendText');
-    } catch (error) {
-      this.logger.error(`Error in sendMessageToBot: ${error.message || JSON.stringify(error)}`);
-      return;
+    if (message) {
+      // Use the base class method to send the message to WhatsApp
+      await this.sendMessageWhatsApp(instance, remoteJid, message, settings);
     }
   }
+
+  // The service is now complete with just the abstract method implementations
 }
diff --git a/src/api/integrations/chatbot/flowise/validate/flowise.schema.ts b/src/api/integrations/chatbot/flowise/validate/flowise.schema.ts
@@ -40,6 +40,8 @@ export const flowiseSchema: JSONSchema7 = {
     keepOpen: { type: 'boolean' },
     debounceTime: { type: 'integer' },
     ignoreJids: { type: 'array', items: { type: 'string' } },
+    splitMessages: { type: 'boolean' },
+    timePerChar: { type: 'integer' },
   },
   required: ['enabled', 'apiUrl', 'triggerType'],
   ...isNotEmpty('enabled', 'apiUrl', 'triggerType'),
@@ -69,7 +71,9 @@ export const flowiseSettingSchema: JSONSchema7 = {
     keepOpen: { type: 'boolean' },
     debounceTime: { type: 'integer' },
     ignoreJids: { type: 'array', items: { type: 'string' } },
-    botIdFallback: { type: 'string' },
+    flowiseIdFallback: { type: 'string' },
+    splitMessages: { type: 'boolean' },
+    timePerChar: { type: 'integer' },
   },
   required: [
     'expire',
diff --git a/src/api/server.module.ts b/src/api/server.module.ts
diff --git a/src/config/env.config.ts b/src/config/env.config.ts
