NestJS Bull模块远程Redis连接配置问题：本地正常远程无法写入队列

问题描述 #

我使用Nest.js的BullModule时，本地Redis连接正常，配置如下：

const REDIS = {
  host: 'localhost', 
};

@Module({
  imports: [
    TaskTypesModule,
    TasksModule,
    ScheduleModule.forRoot(),
    BullModule.forRoot({
      // @ts-ignore
      redis: REDIS,
    }),
  ],
  controllers: [AppController],
  providers: [AppService, PrismaService],
})
export class AppModule {}

切换到远程Redis（RedisLabs实例）后，配置修改为：

const REDIS = {
  host: process.env.REDIS_ENDPOINT,
  port: process.env.REDIS_PORT,
  password: process.env.REDIS_PASSWORD,
};

对应的环境变量：

REDIS_USERNAME=default
REDIS_PASSWORD=p----------------------S
REDIS_ENDPOINT=redis-1xxxxx4.c261.us-east-1-4.ec2.cloud.redislabs.com
REDIS_PORT=1xxxxx4

此时无法向Redis队列写入数据，但RedisInsight可以正常连接该远程Redis。

解决方案 #

• 添加用户名配置并修正端口类型
  环境变量中的REDIS_PORT是字符串类型，而Bull的Redis配置要求port为数字类型；同时RedisLabs实例需要显式指定用户名（即使是默认的default）。修改后的配置：

  const REDIS = {
    host: process.env.REDIS_ENDPOINT,
    port: parseInt(process.env.REDIS_PORT, 10), // 转换为数字类型
    password: process.env.REDIS_PASSWORD,
    username: process.env.REDIS_USERNAME, // 添加用户名配置
  };
  

• 使用URL连接字符串简化配置
  直接构造Redis连接URL替代分散的配置项，能避免类型错误和参数遗漏，同时自动处理特殊字符：

  // 构造带身份验证的Redis连接URL
  const REDIS_URL = `redis://${process.env.REDIS_USERNAME}:${encodeURIComponent(process.env.REDIS_PASSWORD)}@${process.env.REDIS_ENDPOINT}:${process.env.REDIS_PORT}`;
  
  @Module({
    imports: [
      TaskTypesModule,
      TasksModule,
      ScheduleModule.forRoot(),
      BullModule.forRoot({
        redis: REDIS_URL,
      }),
    ],
    controllers: [AppController],
    providers: [AppService, PrismaService],
  })
  export class AppModule {}
  

  注意用encodeURIComponent处理密码中的特殊字符，防止URL解析失败。

• 开启SSL连接
  多数RedisLabs云实例默认要求SSL连接，需要在配置中添加tls选项：

  const REDIS = {
    host: process.env.REDIS_ENDPOINT,
    port: parseInt(process.env.REDIS_PORT, 10),
    password: process.env.REDIS_PASSWORD,
    username: process.env.REDIS_USERNAME,
    tls: {}, // 启用默认SSL配置
  };
  

  如果RedisInsight连接时开启了SSL，Bull配置必须同步开启。

• 移除@ts-ignore并校验类型
  原配置中的// @ts-ignore会掩盖TypeScript类型错误，移除后根据编辑器提示修正参数，确保所有必填项符合类型要求。

内容的提问来源于stack exchange，提问作者Dave Edelhart