NestJS连接Elasticsearch报错：无法读取undefined的'cloud'属性

问题描述 #

在NestJS中使用@nestjs/elasticsearch模块搭建Elasticsearch连接时，出现如下报错，调试发现ElasticsearchService的options参数被传入了undefined。

代码示例 #

import { Module } from '@nestjs/common';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { ElasticsearchModule } from '@nestjs/elasticsearch';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { SearchModule } from './search/search.module';

@Module({
  imports: [
    ConfigModule.forRoot(), // Make sure this line is present
    ElasticsearchModule.registerAsync({
      imports: [ConfigModule],
      useFactory: (configService: ConfigService) => ({
        node: configService.get('ELASTICSEARCH_NODE'),
      }),
      inject: [ConfigService],
    }),
    SearchModule,
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

报错信息 #

[Nest] 470882  - 06/06/2023, 8:08:10 PM   ERROR [ExceptionHandler] Cannot read properties of undefined (reading 'cloud')
TypeError: Cannot read properties of undefined (reading 'cloud')
    at new Client (/home/oem/Documents/nestjs-starter/node_modules/@elastic/elasticsearch/src/client.ts:128:15)
    at new ElasticsearchService (/home/oem/Documents/nestjs-starter/node_modules/@nestjs/elasticsearch/dist/elasticsearch.service.js:21:9)
    at Injector.instantiateClass (/home/oem/Documents/nestjs-starter/node_modules/@nestjs/core/injector/injector.js:340:19)
    at callback (/home/oem/Documents/nestjs-starter/node_modules/@nestjs/core/injector/injector.js:53:45)
    at Injector.resolveConstructorParams (/home/oem/Documents/nestjs-starter/node_modules/@nestjs/core/injector/injector.js:132:24)
    at Injector.loadInstance (/home/oem/Documents/nestjs-starter/node_modules/@nestjs/core/injector/injector.js:57:13)
    at Injector.loadProvider (/home/oem/Documents/nestjs-starter/node_modules/@nestjs/core/injector/injector.js:84:9)
    at async Promise.all (index 4)
    at InstanceLoader.createInstancesOfProviders (/home/oem/Documents/nestjs-starter/node_modules/@nestjs/core/injector/instance-loader.js:44:9)
    at /home/oem/Documents/nestjs-starter/node_modules/@nestjs/core/injector/instance-loader.js:29:13

解决方法 #

1. 验证环境变量加载情况 #

• 检查项目根目录的.env文件，确认ELASTICSEARCH_NODE变量存在且格式正确（例如http://localhost:9200）。
• 在useFactory中添加日志输出，确认是否成功获取到环境变量值：

  useFactory: (configService: ConfigService) => {
    const esNode = configService.get('ELASTICSEARCH_NODE');
    console.log('Elasticsearch Node:', esNode); // 查看控制台输出
    return { node: esNode };
  },
  

2. 确保ConfigModule全局可用 #

• 将ConfigModule设置为全局模块，避免模块间依赖导入问题：

  ConfigModule.forRoot({ isGlobal: true }),
  

  此时ElasticsearchModule.registerAsync中可以移除imports: [ConfigModule]配置。

3. 检查版本兼容性 #

• @nestjs/elasticsearch与底层@elastic/elasticsearch存在版本绑定关系，例如@nestjs/elasticsearch@10.x要求@elastic/elasticsearch@8.x。
• 查看package.json中的版本，若不匹配，重新安装兼容版本：

  npm install @nestjs/elasticsearch@10 @elastic/elasticsearch@8
  

4. 显式返回完整配置对象并添加默认值 #

• 为避免环境变量未加载导致返回undefined，可以添加默认值，并确保返回完整的Client配置结构：

  useFactory: (configService: ConfigService) => ({
    node: configService.get<string>('ELASTICSEARCH_NODE') || 'http://localhost:9200',
    // 若有认证需求，添加以下配置（无则可省略）
    auth: {
      username: configService.get('ELASTICSEARCH_USER') || 'elastic',
      password: configService.get('ELASTICSEARCH_PASSWORD') || 'changeme',
    },
  }),
  

5. 排查重复注册问题 #

• 检查SearchModule或其他子模块中是否重复注册了ElasticsearchModule，确保整个应用仅全局注册一次该模块。

内容的提问来源于stack exchange，提问作者Bhavya Dhiman