NestJS e2e 测试模拟 Session 装饰器

Question

我正在尝试使用 supertest 编写一个 e2e 测试，其中我的控制器实际上使用了 @Session() 装饰器。但是，我不想承担启动与数据库连接等的会话的全部负担，因此我在测试中的应用程序实际上并未初始化会话。

相反，我更想首先模拟装饰器提供的数据，并将其替换为静态数据。但是，我真的找不到关于如何实现这一点的解决方案。

来自控制器的样本：

@Get('/user/me')
public async getMe(@Session() session: Record<string, unknown>) {
  if (!session?.user) {
    throw new InternalServerErrorException();
  }
  return session.user;
}

我希望模拟看起来像什么：

jest.mock(Session, jest.fn().mockImplementation(() => {
  return { user: { name: "test user" } };
})

但是这行不通。

根据官方 TypeScript 文档，参数装饰器只能用于观察已在特定方法上设置的参数。因为这实际上不是使用 @Session() 装饰器时发生的事情，所以我尝试查看 nestjs 如何实际实现这些装饰器的源代码，但我在正确理解它时遇到了一些麻烦。

如果我没记错的话，装饰器似乎写了一些元数据，另一个装饰器（在这种情况下可能 @Get()？）可以利用并提取必要的数据。

我对如何正确测试它有点困惑，所以非常感谢您的一些建议:)

============================================= ==============================

更新：我现在将继续，而不是模拟 Session 装饰器本身模拟 req.session，同时在 beforeAll() 挂钩中设置我的 app。因此我选择了以下解决方案：

app.use((req, res, next) => {
    req.session = {
      user: {
        firstName: 'Max',
        lastName: 'Mustermann',
      },
    };
    next();
});

如果有人知道更好的解决方案，我仍然会很高兴。

Answer 1

为了解决这个问题，创建一个公共函数，为 e2e 创建嵌套应用程序，并提供钩子配置，可以覆盖测试模块和 express 的应用程序中间件注入

常用设置函数


/**
 * Hook for overriding the testing module
 */
export type TestingModuleCreatePreHook = (
  moduleBuilder: TestingModuleBuilder,
) => TestingModuleBuilder;


/**
 * Hook for adding items to nest application
 */
export type TestingAppCreatePreHook = (
  app: NestExpressApplication,
) => Promise<void>;

/**
 * Sets basic e2e testing module of app
 */
export async function basicE2eSetup(
  config: {
    moduleBuilderHook?: TestingModuleCreatePreHook;
    appInitHook?: TestingAppCreatePreHook;
  } = {},
): Promise<[NestExpressApplication, TestingModule]> {
  let moduleBuilder: TestingModuleBuilder = Test.createTestingModule({
    imports: [AppModule],
  });

  if (!!config.moduleBuilderHook) {
    moduleBuilder = config.moduleBuilderHook(moduleBuilder);
  }

  const moduleFixture: TestingModule = await moduleBuilder.compile();
  const app = moduleFixture.createNestApplication<NestExpressApplication>();  

  if (config.appInitHook) {
    await config.appInitHook(app);
  }

  return [await app.init(), moduleFixture];
}

用法


describe('AppController (e2e)', () => {
  let app: INestApplication;

  beforeEach(async () => {
    [app] = await basicE2eSetup({
      moduleBuilderHook: (moduleBuilder) => {
        // your overrides go here
        // Refer: https://docs.nestjs.com/fundamentals/testing#end-to-end-testing
        // eg: moduleBuilder.overrideProvider(ProviderName).useValue(value)
        return moduleBuilder;
      },
      appInitHook: async (app) => {
        const result = await someAction();
        // or get some service from app 
        // eg: const service = app.get<YourService>(YourService)
        app.use((req, res, next) => {
          // do something with request of response object
          next();
        })
      } 
    });
  });

  it('/ (GET)', () => {
    return request(app.getHttpServer())
      .get('/')
      .expect((res) => {
        expect(res.text).toContain('Hi There');
      });
  });
});

NestJS e2e 测试模拟 Session 装饰器

NestJS e2e test mock Session decorator

session

node.js

typescript

nestjs

常用设置函数

用法