Skip to content

The open alternative to Salesforce, designed for AI.

Add REDIS_QUEUE_PREFIX so BullMQ works on clustered Redis (hash-tagged keys) (#26357)

Philipp R3a735fbe2220
diff --git a/packages/twenty-server/src/engine/core-modules/admin-panel/__tests__/worker.health.spec.ts b/packages/twenty-server/src/engine/core-modules/admin-panel/__tests__/worker.health.spec.ts
index 0d909bb5c65..46b872013e9 100644
--- a/packages/twenty-server/src/engine/core-modules/admin-panel/__tests__/worker.health.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/admin-panel/__tests__/worker.health.spec.ts
@@ -39,6 +39,7 @@ describe('WorkerHealthIndicator', () => {
const mockRedisService = {
getClient: () => mockRedis,
getQueueClient: () => mockRedis,
+ getQueuePrefix: () => 'bull',
} as unknown as RedisClientService;
healthIndicatorService = {
diff --git a/packages/twenty-server/src/engine/core-modules/admin-panel/admin-panel-health.service.ts b/packages/twenty-server/src/engine/core-modules/admin-panel/admin-panel-health.service.ts
index c0f8672f0ed..b8300527c21 100644
--- a/packages/twenty-server/src/engine/core-modules/admin-panel/admin-panel-health.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/admin-panel/admin-panel-health.service.ts
@@ -200,7 +200,10 @@ export class AdminPanelHealthService {
timeRange: QueueMetricsTimeRange = QueueMetricsTimeRange.OneDay,
): Promise<QueueMetricsDataDTO> {
const redis = this.redisClient.getQueueClient();
- const queue = new Queue(queueName, { connection: redis });
+ const queue = new Queue(queueName, {
+ connection: redis,
+ prefix: this.redisClient.getQueuePrefix(),
+ });
try {
const { pointsNeeded, samplingFactor } =
diff --git a/packages/twenty-server/src/engine/core-modules/admin-panel/admin-panel-queue.service.ts b/packages/twenty-server/src/engine/core-modules/admin-panel/admin-panel-queue.service.ts
index 771600c4744..bc9ab3cb691 100644
--- a/packages/twenty-server/src/engine/core-modules/admin-panel/admin-panel-queue.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/admin-panel/admin-panel-queue.service.ts
@@ -31,7 +31,10 @@ export class AdminPanelQueueService {
offset = 0,
) {
const redis = this.redisClient.getQueueClient();
- const queue = new Queue(queueName, { connection: redis });
+ const queue = new Queue(queueName, {
+ connection: redis,
+ prefix: this.redisClient.getQueuePrefix(),
+ });
try {
const validLimit = Math.min(Math.max(1, limit), 200);
@@ -124,7 +127,10 @@ export class AdminPanelQueueService {
results: JobOperationResult[];
}> {
const redis = this.redisClient.getQueueClient();
- const queue = new Queue(queueName, { connection: redis });
+ const queue = new Queue(queueName, {
+ connection: redis,
+ prefix: this.redisClient.getQueuePrefix(),
+ });
try {
if (jobIds.length === 0) {
@@ -196,7 +202,10 @@ export class AdminPanelQueueService {
results: JobOperationResult[];
}> {
const redis = this.redisClient.getQueueClient();
- const queue = new Queue(queueName, { connection: redis });
+ const queue = new Queue(queueName, {
+ connection: redis,
+ prefix: this.redisClient.getQueuePrefix(),
+ });
try {
const results: JobOperationResult[] = [];
diff --git a/packages/twenty-server/src/engine/core-modules/admin-panel/indicators/worker.health.ts b/packages/twenty-server/src/engine/core-modules/admin-panel/indicators/worker.health.ts
index 9b97a476b93..61aa494f405 100644
--- a/packages/twenty-server/src/engine/core-modules/admin-panel/indicators/worker.health.ts
+++ b/packages/twenty-server/src/engine/core-modules/admin-panel/indicators/worker.health.ts
@@ -55,7 +55,10 @@ export class WorkerHealthIndicator {
},
): Promise<WorkerQueueHealth | null> {
const redis = this.redisClient.getQueueClient();
- const queue = new Queue(queueName, { connection: redis });
+ const queue = new Queue(queueName, {
+ connection: redis,
+ prefix: this.redisClient.getQueuePrefix(),
+ });
try {
const workers = await queue.getWorkers();
diff --git a/packages/twenty-server/src/engine/core-modules/message-queue/message-queue.module-factory.ts b/packages/twenty-server/src/engine/core-modules/message-queue/message-queue.module-factory.ts
index c5fda367234..cdc1e7e06e9 100644
--- a/packages/twenty-server/src/engine/core-modules/message-queue/message-queue.module-factory.ts
+++ b/packages/twenty-server/src/engine/core-modules/message-queue/message-queue.module-factory.ts
@@ -23,6 +23,7 @@ export const messageQueueModuleFactory = async (
type: MessageQueueDriverType.BullMQ,
options: {
connection: redisClientService.getQueueClient(),
+ prefix: redisClientService.getQueuePrefix(),
},
metricsService,
twentyConfigService,
diff --git a/packages/twenty-server/src/engine/core-modules/redis-client/redis-client.service.ts b/packages/twenty-server/src/engine/core-modules/redis-client/redis-client.service.ts
index c974374fbd6..59e74461c6a 100644
--- a/packages/twenty-server/src/engine/core-modules/redis-client/redis-client.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/redis-client/redis-client.service.ts
@@ -32,6 +32,10 @@ export class RedisClientService implements OnModuleDestroy {
return this.redisQueueClient;
}
+ getQueuePrefix() {
+ return this.twentyConfigService.get('REDIS_QUEUE_PREFIX');
+ }
+
getClient() {
if (!this.redisClient) {
const redisUrl = this.twentyConfigService.get('REDIS_URL');
diff --git a/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts b/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts
index d998bf0d7b8..aae9103f914 100644
--- a/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts
+++ b/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts
@@ -1462,6 +1462,17 @@ export class ConfigVariables {
})
REDIS_QUEUE_URL: string;
+ @ConfigVariablesMetadata({
+ group: ConfigVariablesGroup.ADVANCED_SETTINGS,
+ description:
+ 'Key prefix for BullMQ queue keys. Wrap it in curly braces (e.g. "{twenty}") so all keys of a queue share one hash slot when Redis is clustered (Redis Cluster, Redis Enterprise / Azure Managed Redis), otherwise multi-key Lua scripts fail with CROSSSLOT. Changing it orphans jobs stored under the previous prefix.',
+ isEnvOnly: true,
+ type: ConfigVariableType.STRING,
+ })
+ @IsOptional()
+ @IsString()
+ REDIS_QUEUE_PREFIX: string = 'bull';
+
@ConfigVariablesMetadata({
group: ConfigVariablesGroup.ADVANCED_SETTINGS,
description: