INestApplication doesn't resolve close() as a property when running e2e tests

Is there an existing issue for this?

• I have searched the existing issues

Current behavior

Running npm run test:e2e throws the following error:

TypeError: Cannot read properties of undefined (reading ‘close’)

this prevents the app from closing. Leaving multiple ports open when running tests, and causing subsequent tests to fail when ran on the same port.

speficially, it cannot read the property close() property from the ‘INestApplication’ interface from @nestjs/testing. This is used to define app.close();

import { Test } from '@nestjs/testing';
import { AppModule } from '../src/app.module';
import { INestApplication, ValidationPipe } from '@nestjs/common';
import { PrismaService } from '../src/prisma/prisma.service';
import * as pactum from 'pactum';
import { AuthDto } from '../src/auth/dto';

describe('App e2e', () => {
  let app: INestApplication;
  let prisma: PrismaService;
  beforeAll(async () => {
    const moduleRef = await Test.createTestingModule({
        imports: [AppModule],
    }).compile();
    const app = moduleRef.createNestApplication();
    app.useGlobalPipes(
        new ValidationPipe({
          whitelist: true,
        }),
    );
    const port = 3060;
    await app.init();
    await app.listen(port);
    prisma = app.get(PrismaService)
      await prisma.cleanDb();
    pactum.request.setBaseUrl(`http://localhost:${port}`)
  });

  afterAll(() => {
      app.close();
  });

result:

Minimum reproduction code

https://github.com/nakajimayoshi/auth-api

Steps to reproduce

1. Download the repo and open in an IDE

2. Setup env variables

3. Run the following command:

test coverage

$ npm run test:e2e

Expected behavior

Unit test should pass

Package

• I don’t know. Or some 3rd-party package
• @nestjs/common
• @nestjs/core
• @nestjs/microservices
• @nestjs/platform-express
• @nestjs/platform-fastify
• @nestjs/platform-socket.io
• @nestjs/platform-ws
• @nestjs/testing
• @nestjs/websockets
• Other (see below)

Other package

No response

NestJS version

9.0.0

Packages versions

 "dependencies": {
    "@nestjs/common": "^9.0.0",
    "@nestjs/config": "^2.2.0",
    "@nestjs/core": "^9.0.0",
    "@nestjs/jwt": "^9.0.0",
    "@nestjs/passport": "^9.0.0",
    "@nestjs/platform-express": "^9.0.0",
    "@prisma/client": "^4.1.0",
    "argon2": "^0.28.7",
    "class-transformer": "^0.5.1",
    "class-validator": "^0.13.2",
    "dotenv-cli": "^6.0.0",
    "passport": "^0.6.0",
    "passport-jwt": "^4.0.0",
    "passport-local": "^1.0.0",
    "prisma": "^4.1.0",
    "reflect-metadata": "^0.1.13",
    "rimraf": "^3.0.2",
    "rxjs": "^7.2.0"
  },

Node.js version

16.13.2

In which operating systems have you tested?

• macOS
• Windows
• Linux

Other

No response

[jmcdo29]

https://docs.nestjs.com/fundamentals/lifecycle-events#lifecycle-events-1

[jmcdo29]

This is most likely from never closing the PrimsaClient. You should create an OnApplicationShutdown hook that closes the connection to ensure the server can properly shutdown.