fix: Adjusts in redis for save instances

Author: DavidsonGomes

CHANGELOG.md

@@ -3,11 +3,12 @@
 ### Fixed
 * Revert fix audio encoding
 * Recovering messages lost with redis cache
+* Adjusts in redis for save instances
 * Adjusts in proxy
 * Revert pull request #523
 * Added instance name on logs
 * Added support for Spanish
-* Fix error: invalid operator. The allowed operators for identifier are equal_to,not_equal_to
+* Fix error: invalid operator. The allowed operators for identifier are equal_to,not_equal_to in chatwoot
 
 # 1.7.2 (2024-04-12 17:31)
 

Docker/.env.example

@@ -33,7 +33,10 @@ CLEAN_STORE_CHATS=true
 
 # Permanent data storage
 DATABASE_ENABLED=false
-DATABASE_CONNECTION_URI=mongodb://root:root@mongodb:27017/?authSource=admin&readPreference=primary&ssl=false&directConnection=true
+DATABASE_CONNECTION_URI=mongodb://root:root@mongodb:27017/?authSource=admin &
+readPreference=primary &
+ssl=false &
+directConnection=true
 DATABASE_CONNECTION_DB_PREFIX_NAME=evdocker
 
 # Choose the data you want to save in the application's database or store
@@ -43,10 +46,6 @@ DATABASE_SAVE_MESSAGE_UPDATE=false
 DATABASE_SAVE_DATA_CONTACTS=false
 DATABASE_SAVE_DATA_CHATS=false
 
-REDIS_ENABLED=false
-REDIS_URI=redis://redis:6379
-REDIS_PREFIX_KEY=evdocker
-
 RABBITMQ_ENABLED=false
 RABBITMQ_RABBITMQ_MODE=global
 RABBITMQ_EXCHANGE_NAME=evolution_exchange
@@ -73,7 +72,7 @@ WEBHOOK_GLOBAL_URL=''
 WEBHOOK_GLOBAL_ENABLED=false
 # With this option activated, you work with a url per webhook event, respecting the global url and the name of each event
 WEBHOOK_GLOBAL_WEBHOOK_BY_EVENTS=false
-## Set the events you want to hear  
+## Set the events you want to hear
 WEBHOOK_EVENTS_APPLICATION_STARTUP=false
 WEBHOOK_EVENTS_QRCODE_UPDATED=true
 WEBHOOK_EVENTS_MESSAGES_SET=true
@@ -129,6 +128,14 @@ CHATWOOT_MESSAGE_READ=false # false | true
 CHATWOOT_IMPORT_DATABASE_CONNECTION_URI=postgres://user:password@hostname:port/dbname
 CHATWOOT_IMPORT_DATABASE_PLACEHOLDER_MEDIA_MESSAGE=true
 
+CACHE_REDIS_ENABLED=false
+CACHE_REDIS_URI=redis://redis:6379
+CACHE_REDIS_PREFIX_KEY=evolution
+CACHE_REDIS_TTL=604800
+CACHE_REDIS_SAVE_INSTANCES=false
+CACHE_LOCAL_ENABLED=false
+CACHE_LOCAL_TTL=604800
+
 # Defines an authentication type for the api
 # We recommend using the apikey because it will allow you to use a custom token,
 # if you use jwt, a random token will be generated and may be expired and you will have to generate a new token
@@ -143,4 +150,4 @@ AUTHENTICATION_EXPOSE_IN_FETCH_INSTANCES=true
 AUTHENTICATION_JWT_EXPIRIN_IN=0
 AUTHENTICATION_JWT_SECRET='L=0YWt]b2w[WF>#>:&E`'
 
-LANGUAGE=en # pt-BR, en
+LANGUAGE=en # pt-BR, en

Docker/evolution-api-all-services/.env.example

@@ -33,7 +33,10 @@ CLEAN_STORE_CHATS=true
 
 # Permanent data storage
 DATABASE_ENABLED=true
-DATABASE_CONNECTION_URI=mongodb://root:root@mongodb:27017/?authSource=admin&readPreference=primary&ssl=false&directConnection=true
+DATABASE_CONNECTION_URI=mongodb://root:root@mongodb:27017/?authSource=admin &
+readPreference=primary &
+ssl=false &
+directConnection=true
 DATABASE_CONNECTION_DB_PREFIX_NAME=evolution
 
 # Choose the data you want to save in the application's database or store
@@ -43,18 +46,14 @@ DATABASE_SAVE_MESSAGE_UPDATE=false
 DATABASE_SAVE_DATA_CONTACTS=false
 DATABASE_SAVE_DATA_CHATS=false
 
-REDIS_ENABLED=true
-REDIS_URI=redis://redis:6379
-REDIS_PREFIX_KEY=evolution
-
 # Global Webhook Settings
 # Each instance's Webhook URL and events will be requested at the time it is created
 ## Define a global webhook that will listen for enabled events from all instances
 WEBHOOK_GLOBAL_URL=''
 WEBHOOK_GLOBAL_ENABLED=false
 # With this option activated, you work with a url per webhook event, respecting the global url and the name of each event
 WEBHOOK_GLOBAL_WEBHOOK_BY_EVENTS=false
-## Set the events you want to hear  
+## Set the events you want to hear
 WEBHOOK_EVENTS_APPLICATION_STARTUP=false
 WEBHOOK_EVENTS_QRCODE_UPDATED=true
 WEBHOOK_EVENTS_MESSAGES_SET=true
@@ -87,6 +86,14 @@ CONFIG_SESSION_PHONE_NAME=chrome
 # Set qrcode display limit
 QRCODE_LIMIT=30
 
+CACHE_REDIS_ENABLED=false
+CACHE_REDIS_URI=redis://redis:6379
+CACHE_REDIS_PREFIX_KEY=evolution
+CACHE_REDIS_TTL=604800
+CACHE_REDIS_SAVE_INSTANCES=false
+CACHE_LOCAL_ENABLED=false
+CACHE_LOCAL_TTL=604800
+
 # Defines an authentication type for the api
 # We recommend using the apikey because it will allow you to use a custom token,
 # if you use jwt, a random token will be generated and may be expired and you will have to generate a new token
@@ -109,4 +116,4 @@ AUTHENTICATION_INSTANCE_NAME=evolution
 AUTHENTICATION_INSTANCE_WEBHOOK_URL=''
 AUTHENTICATION_INSTANCE_CHATWOOT_ACCOUNT_ID=1
 AUTHENTICATION_INSTANCE_CHATWOOT_TOKEN=123456
-AUTHENTICATION_INSTANCE_CHATWOOT_URL=''
+AUTHENTICATION_INSTANCE_CHATWOOT_URL=''

Dockerfile

@@ -58,10 +58,6 @@ ENV DATABASE_SAVE_MESSAGE_UPDATE=false
 ENV DATABASE_SAVE_DATA_CONTACTS=false
 ENV DATABASE_SAVE_DATA_CHATS=false
 
-ENV REDIS_ENABLED=false
-ENV REDIS_URI=redis://redis:6379
-ENV REDIS_PREFIX_KEY=evolution
-
 ENV RABBITMQ_ENABLED=false
 ENV RABBITMQ_MODE=global
 ENV RABBITMQ_EXCHANGE_NAME=evolution_exchange
@@ -129,6 +125,14 @@ ENV QRCODE_COLOR=#198754
 
 ENV TYPEBOT_API_VERSION=latest
 
+ENV CACHE_REDIS_ENABLED=false
+ENV CACHE_REDIS_URI=redis://redis:6379
+ENV CACHE_REDIS_PREFIX_KEY=evolution
+ENV CACHE_REDIS_TTL=604800
+ENV CACHE_REDIS_SAVE_INSTANCES=false
+ENV CACHE_LOCAL_ENABLED=false
+ENV CACHE_LOCAL_TTL=604800
+
 ENV AUTHENTICATION_TYPE=apikey
 
 ENV AUTHENTICATION_API_KEY=B6D711FCDE4D4FD5936544120E713976

src/api/abstract/abstract.cache.ts

@@ -1,13 +1,19 @@
 export interface ICache {
   get(key: string): Promise<any>;
 
+  hGet(key: string, field: string): Promise<any>;
+
   set(key: string, value: any, ttl?: number): void;
 
+  hSet(key: string, field: string, value: any): Promise<void>;
+
   has(key: string): Promise<boolean>;
 
   keys(appendCriteria?: string): Promise<string[]>;
 
   delete(key: string | string[]): Promise<number>;
 
+  hDelete(key: string, field: string): Promise<any>;
+
   deleteAll(appendCriteria?: string): Promise<number>;
 }

src/api/controllers/instance.controller.ts

@@ -6,7 +6,6 @@ import { v4 } from 'uuid';
 import { ConfigService, HttpServer, WaBusiness } from '../../config/env.config';
 import { Logger } from '../../config/logger.config';
 import { BadRequestException, InternalServerErrorException } from '../../exceptions';
-import { RedisCache } from '../../libs/redis.client';
 import { InstanceDto, SetPresenceDto } from '../dto/instance.dto';
 import { ChatwootService } from '../integrations/chatwoot/services/chatwoot.service';
 import { RabbitmqService } from '../integrations/rabbitmq/services/rabbitmq.service';
@@ -41,7 +40,7 @@ export class InstanceController {
     private readonly typebotService: TypebotService,
     private readonly integrationService: IntegrationService,
     private readonly proxyService: ProxyController,
-    private readonly cache: RedisCache,
+    private readonly cache: CacheService,
     private readonly chatwootCache: CacheService,
     private readonly messagesLostCache: CacheService,
   ) {}

src/api/guards/instance.guard.ts

@@ -2,7 +2,7 @@ import { NextFunction, Request, Response } from 'express';
 import { existsSync } from 'fs';
 import { join } from 'path';
 
-import { configService, Database, Redis } from '../../config/env.config';
+import { CacheConf, configService, Database } from '../../config/env.config';
 import { INSTANCE_DIR } from '../../config/path.config';
 import {
   BadRequestException,
@@ -17,12 +17,13 @@ import { cache, waMonitor } from '../server.module';
 async function getInstance(instanceName: string) {
   try {
     const db = configService.get<Database>('DATABASE');
-    const redisConf = configService.get<Redis>('REDIS');
+    const cacheConf = configService.get<CacheConf>('CACHE');
 
     const exists = !!waMonitor.waInstances[instanceName];
 
-    if (redisConf.ENABLED) {
-      const keyExists = await cache.keyExists();
+    if (cacheConf.REDIS.ENABLED && cacheConf.REDIS.SAVE_INSTANCES) {
+      const keyExists = await cache.has(instanceName);
+
       return exists || keyExists;
     }
 

src/api/server.module.ts

@@ -3,7 +3,6 @@ import { configService } from '../config/env.config';
 import { eventEmitter } from '../config/event.config';
 import { Logger } from '../config/logger.config';
 import { dbserver } from '../libs/db.connect';
-import { RedisCache } from '../libs/redis.client';
 import { ChatController } from './controllers/chat.controller';
 import { GroupController } from './controllers/group.controller';
 import { InstanceController } from './controllers/instance.controller';
@@ -107,7 +106,7 @@ export const repository = new RepositoryBroker(
   dbserver?.getClient(),
 );
 
-export const cache = new RedisCache();
+export const cache = new CacheService(new CacheEngine(configService, 'instance').getEngine());
 const chatwootCache = new CacheService(new CacheEngine(configService, ChatwootService.name).getEngine());
 const messagesLostCache = new CacheService(new CacheEngine(configService, 'baileys').getEngine());
 

src/api/services/cache.service.ts

@@ -1,3 +1,5 @@
+import { BufferJSON } from '@whiskeysockets/baileys';
+
 import { Logger } from '../../config/logger.config';
 import { ICache } from '../abstract/abstract.cache';
 
@@ -20,6 +22,21 @@ export class CacheService {
     return this.cache.get(key);
   }
 
+  public async hGet(key: string, field: string) {
+    try {
+      const data = await this.cache.hGet(key, field);
+
+      if (data) {
+        return JSON.parse(data, BufferJSON.reviver);
+      }
+
+      return null;
+    } catch (error) {
+      this.logger.error(error);
+      return null;
+    }
+  }
+
   async set(key: string, value: any) {
     if (!this.cache) {
       return;
@@ -28,6 +45,16 @@ export class CacheService {
     this.cache.set(key, value);
   }
 
+  public async hSet(key: string, field: string, value: any) {
+    try {
+      const json = JSON.stringify(value, BufferJSON.replacer);
+
+      await this.cache.hSet(key, field, json);
+    } catch (error) {
+      this.logger.error(error);
+    }
+  }
+
   async has(key: string) {
     if (!this.cache) {
       return;
@@ -44,6 +71,16 @@ export class CacheService {
     return this.cache.delete(key);
   }
 
+  async hDelete(key: string, field: string) {
+    try {
+      await this.cache.hDelete(key, field);
+      return true;
+    } catch (error) {
+      this.logger.error(error);
+      return false;
+    }
+  }
+
   async deleteAll(appendCriteria?: string) {
     if (!this.cache) {
       return;

src/api/services/monitor.service.ts

@@ -5,11 +5,10 @@ import { Db } from 'mongodb';
 import { Collection } from 'mongoose';
 import { join } from 'path';
 
-import { Auth, ConfigService, Database, DelInstance, HttpServer, Redis } from '../../config/env.config';
+import { Auth, CacheConf, ConfigService, Database, DelInstance, HttpServer } from '../../config/env.config';
 import { Logger } from '../../config/logger.config';
 import { INSTANCE_DIR, STORE_DIR } from '../../config/path.config';
 import { NotFoundException } from '../../exceptions';
-import { RedisCache } from '../../libs/redis.client';
 import {
   AuthModel,
   ChamaaiModel,
@@ -34,7 +33,7 @@ export class WAMonitoringService {
     private readonly eventEmitter: EventEmitter2,
     private readonly configService: ConfigService,
     private readonly repository: RepositoryBroker,
-    private readonly cache: RedisCache,
+    private readonly cache: CacheService,
     private readonly chatwootCache: CacheService,
     private readonly messagesLostCache: CacheService,
   ) {
@@ -44,15 +43,15 @@ export class WAMonitoringService {
     this.noConnection();
 
     Object.assign(this.db, configService.get<Database>('DATABASE'));
-    Object.assign(this.redis, configService.get<Redis>('REDIS'));
+    Object.assign(this.redis, configService.get<CacheConf>('CACHE'));
 
     this.dbInstance = this.db.ENABLED
       ? this.repository.dbServer?.db(this.db.CONNECTION.DB_PREFIX_NAME + '-instances')
       : undefined;
   }
 
   private readonly db: Partial<Database> = {};
-  private readonly redis: Partial<Redis> = {};
+  private readonly redis: Partial<CacheConf> = {};
 
   private dbInstance: Db;
 
@@ -213,7 +212,7 @@ export class WAMonitoringService {
           });
           this.logger.verbose('instance files deleted: ' + name);
         });
-      } else if (!this.redis.ENABLED) {
+      } else if (!this.redis.REDIS.ENABLED && !this.redis.REDIS.SAVE_INSTANCES) {
         const dir = opendirSync(INSTANCE_DIR, { encoding: 'utf-8' });
         for await (const dirent of dir) {
           if (dirent.isDirectory()) {
@@ -248,10 +247,9 @@ export class WAMonitoringService {
       return;
     }
 
-    if (this.redis.ENABLED) {
+    if (this.redis.REDIS.ENABLED && this.redis.REDIS.SAVE_INSTANCES) {
       this.logger.verbose('cleaning up instance in redis: ' + instanceName);
-      this.cache.reference = instanceName;
-      await this.cache.delAll();
+      await this.cache.delete(instanceName);
       return;
     }
 
@@ -304,7 +302,7 @@ export class WAMonitoringService {
     this.logger.verbose('Loading instances');
 
     try {
-      if (this.redis.ENABLED) {
+      if (this.redis.REDIS.ENABLED && this.redis.REDIS.SAVE_INSTANCES) {
         await this.loadInstancesFromRedis();
       } else if (this.db.ENABLED && this.db.SAVE_DATA.INSTANCE) {
         await this.loadInstancesFromDatabase();
@@ -377,12 +375,11 @@ export class WAMonitoringService {
 
   private async loadInstancesFromRedis() {
     this.logger.verbose('Redis enabled');
-    await this.cache.connect(this.redis as Redis);
-    const keys = await this.cache.getInstanceKeys();
+    const keys = await this.cache.keys();
 
     if (keys?.length > 0) {
       this.logger.verbose('Reading instance keys and setting instances');
-      await Promise.all(keys.map((k) => this.setInstance(k.split(':')[1])));
+      await Promise.all(keys.map((k) => this.setInstance(k.split(':')[2])));
     } else {
       this.logger.verbose('No instance keys found');
     }