Brinque com NestJS e função assíncrona
Estou tentando testar uma função assíncrona de um service
em NestJS .
esta função é assíncrona ... basicamente obter um valor (JSON) do banco de dados (usando o repositório - TypeORM), e quando obter os dados com sucesso, "transformar" para uma classe diferente (DTO) ... a implementação:
async getAppConfig(): Promise<ConfigAppDto> {
return this.configRepository.findOne({
key: Equal("APPLICATION"),
}).then(config => {
if (config == null) {
return new class implements ConfigAppDto {
clientId = '';
clientSecret = '';
};
}
return JSON.parse(config.value) as ConfigAppDto;
});
}
usando um controlador, verifiquei se funcionava bem. Agora estou tentando usar o Jest para fazer os testes, mas sem sucesso ... Meu problema é como simular a findOne
função de repository
..
Edit : Estou tentando usar @golevelup/nestjs-testing
para zombar Repository
!
Já zombei do repository
, mas por algum motivo, o resolve
nunca é chamado ..
describe('getAppConfig', () => {
const repo = createMock<Repository<Config>>();
beforeEach(async () => {
await Test.createTestingModule({
providers: [
ConfigService,
{
provide: getRepositoryToken(Config),
useValue: repo,
}
],
}).compile();
});
it('should return ConfigApp parameters', async () => {
const mockedConfig = new Config('APPLICATION', '{"clientId": "foo","clientSecret": "bar"}');
repo.findOne.mockResolvedValue(mockedConfig);
expect(await repo.findOne()).toEqual(mockedConfig); // ok
const expectedReturn = new class implements ConfigAppDto {
clientId = 'foo';
clientSecret = 'bar';
};
expect(await service.getAppConfig()).toEqual(expectedReturn);
// jest documentation about async -> https://jestjs.io/docs/en/asynchronous
// return expect(service.getAppConfig()).resolves.toBe(expectedReturn);
});
})
- o
expect(await repo.findOne()).toEqual(mockedConfig);
funciona muito bem; expect(await service.getAppConfig()).toEqual(expectedReturn);
obteve um tempo limite =>Async callback was not invoked within the 5000 ms timeout specified by jest.setTimeout
;
usando debug, vejo que o service.getAppConfig()
é chamado, o repository.findOne()
também, mas o .then
repositório de findOne nunca é chamado.
Atualização : estou tentando simular o repositório usando @golevelup/nestjs-testing
e, por algum motivo, o resultado simulado não funciona no serviço. Se eu simular o repositório usando apenas jest
(como o código abaixo), o teste funciona ... então, acho que meu verdadeiro problema é @golevelup/nestjs-testing
.
...
provide: getRepositoryToken(Config),
useValue: {
find: jest.fn().mockResolvedValue([new Config()])
},
...
Respostas
Então, meu verdadeiro problema é como estou zombando do Repository
on NestJS
. Por alguma razão, quando eu simulo usando o @golevelup/nestjs-testing
, coisas estranhas acontecem!
Eu realmente não encontrei uma boa documentação sobre isso @golevelup/nestjs-testing
, então desisti de usá-lo.
Minha solução para a questão foi usar apenas as funções Jest
e NestJS
... o código do resultado foi:
Serviço :
// i'm injecting Connection because I need for some transactions later;
constructor(@InjectRepository(Config) private readonly configRepo: Repository<Config>, private connection: Connection) {}
async getAppConfig(): Promise<ConfigApp> {
return this.configRepo.findOne({
key: Equal("APPLICATION"),
}).then(config => {
if (config == null) {
return new ConfigApp();
}
return JSON.parse(config.value) as ConfigApp;
})
}
Teste :
describe('getAppConfig', () => {
const configApi = new Config();
configApi.key = 'APPLICATION';
configApi.value = '{"clientId": "foo", "clientSecret": "bar"}';
beforeEach(async () => {
const module = await Test.createTestingModule({
providers: [
ConfigAppService,
{
provide: getRepositoryToken(Config),
useValue: {
findOne: jest.fn().mockResolvedValue(new
Config("APPLICATION", '{"clientId": "foo", "clientSecret": "bar"}')),
},
},
{
provide: getConnectionToken(),
useValue: {},
}
],
}).compile();
service = module.get<ConfigAppService>(ConfigAppService);
});
it('should return ConfigApp parameters', async () => {
const expectedValue: ConfigApp = new ConfigApp("foo", "bar");
return service.getAppConfig().then(value => {
expect(value).toEqual(expectedValue);
})
});
})
algumas fontes utilizadas para esta solução: https://github.com/jmcdo29/testing-nestjs/tree/master/apps/typeorm-sample
Acho que expect(await repo.findOne()).toEqual(mockedConfig);
funciona porque você zombou dele, então ele retorna imediatamente. No caso de expect(await service.getAppConfig()).toEqual(expectedReturn);
, você não fez o mock, então provavelmente está demorando mais, então a it
função retorna antes do Promise
resolvido completamente.
Os comentários que você postou da documentação de jest devem funcionar se você zombar da chamada para getAppConfig()
.
service.getAppConfig = jest.fn(() => Promise.resolve(someFakeValue))
ou
spyOn(service, 'getAppConfig').and.mockReturnValue(Promise.resolve(fakeValue))