it doesn't close connection on module destroy

[stalniy]

Why

I want to db level testing. I create repository instance, pass inside drizzle db and when I try to destroy my test db after test finishes I get an error:

Error during teardown: error: database "test_notifications_1755143757200_notification_channel.repository" is being accessed by other users

Example code:

describe(NotificationChannelRepository.name, () => {
  const testDbService = new TestDatabaseService(expect.getState().testPath!);

  beforeAll(async () => {
    await testDbService.setup();
  });

  afterAll(async () => {
    await testDbService.teardown(); // <-- destroy test db
  });

  it("creates a default notification channel if it doesn't exist", async () => {
    const module = await setup();
    const repository = module.get(NotificationChannelRepository);

    const channel = await repository.createDefaultChannel({
      name: "Default",
      type: "email",
      userId: faker.string.uuid(),
      config: {
        addresses: ["test@test.com"]
      }
    });

  });

  let testModule: TestingModule | undefined;
  afterEach(async () => {
    await testModule?.close(); // <- destroys testModule
  });

  async function setup() {
    const module: TestingModule = await Test.createTestingModule({
      imports: [
        ConfigModule.forRoot({ isGlobal: true }),
        ...register(schema)
      ],
      providers: [
        NotificationChannelRepository,
      ]
    }).compile();
    testModule = module;

    return module;
  }
});

What

drizzle service should be destroyed, its connection to pg must be closed on application shutdown or module destroy

Workaround

It's possible to rely on any and use private methods of drizzle and run it afterEach:

 await testModule?.get(DRIZZLE_PROVIDER_TOKEN).session.client.end();

[mithleshjs]

The connection do get closed when the Drizzle module is destroyed or when application is shutdown. But there can be cases when the DB need to be told to close the connections as they don't do it automatically for such cases refer to this - #8

[stalniy]

Basically you recommend to rely on drizzle private api which may be broken at any time, is this correct?

[mithleshjs]

Basically you recommend to rely on drizzle private api which may be broken at any time, is this correct?

That is the API of the underlying DB driver not the drizzle, so it won't change.

We didn't force the connection close because there are certain scenarios where people want to control connections manually.

[stalniy]

I agree in regards toclient.end() but it’s exposed on drizzle session property which may be converted to private property at any time

[stalniy]

session.client is not a part of their type definitions

[mithleshjs]

session.client is not a part of their type definitions

I checked their recent docs. They now provide access to the client.

const client = db.$client;