chore: update test memory leaks (#2394)

* chore: cleaning up main files

* chore: update all nock imports

* chore: fix timer mocks

* chore: update redis spin down

* chore: update faker method

* chore: set log level to silent for tests

* chore: use tigerbeetle environment to spin down container

* chore: remove ts-jest

* chore: correct timer faking

* chore: log heap usage

* chore: remove pino pretty in tests

* chore: dont log heap usage

* chore: revert test timeout to default

* ci: try --runInBand

* Revert "ci: try --runInBand"

This reverts commit 9b4b53e.

* chore: remove ts-jest from jest.config.js

Author: mkurapov

jest.config.js

@@ -1,7 +1,6 @@
 'use strict'
 
 module.exports = {
-  preset: 'ts-jest',
   testEnvironment: 'node',
   projects: ['<rootDir>/packages/*/jest.config.js']
 }

package.json

@@ -43,7 +43,6 @@
     "jest": "^29.7.0",
     "npm-run-all2": "^5.0.2",
     "prettier": "^3.2.5",
-    "ts-jest": "^29.1.2",
     "tunnelmole": "^2.2.14",
     "typescript": "^5.3.3",
     "uuid": "^9.0.1"

packages/backend/jest.config.js

@@ -4,6 +4,8 @@ const baseConfig = require('../../jest.config.base.js')
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const packageName = require('./package.json').name
 
+process.env.LOG_LEVEL = 'silent'
+
 module.exports = {
   ...baseConfig,
   clearMocks: true,
@@ -12,6 +14,7 @@ module.exports = {
   globalSetup: `<rootDir>/packages/${packageName}/jest.setup.ts`,
   globalTeardown: `<rootDir>/packages/${packageName}/jest.teardown.js`,
   testRegex: `(packages/${packageName}/.*/__tests__/.*|\\.(test|spec))\\.tsx?$`,
+  testEnvironment: `<rootDir>/packages/${packageName}/jest.custom-environment.ts`,
   moduleDirectories: [
     `node_modules`,
     `packages/${packageName}/node_modules`,

packages/backend/jest.custom-environment.ts

@@ -0,0 +1,9 @@
+import { TestEnvironment } from 'jest-environment-node'
+import nock from 'nock'
+
+export default class CustomEnvironment extends TestEnvironment {
+  constructor(config, context) {
+    super(config, context)
+    this.global.nock = nock
+  }
+}

packages/backend/jest.setup.ts

@@ -1,5 +1,3 @@
-require('ts-node/register')
-
 import { knex } from 'knex'
 import { GenericContainer, Wait } from 'testcontainers'
 

packages/backend/jest.tigerbeetle-environment.ts

@@ -0,0 +1,21 @@
+import { startTigerbeetleContainer } from './src/tests/tigerbeetle'
+import { StartedTestContainer } from 'testcontainers'
+
+import CustomTestEnvironment from './jest.custom-environment'
+
+export default class TigerbeetleEnvironment extends CustomTestEnvironment {
+  private tbContainer: StartedTestContainer | undefined
+
+  public async setup(): Promise<void> {
+    await super.setup()
+    const tbContainer = await startTigerbeetleContainer()
+
+    this.tbContainer = tbContainer.container
+    this.global.tigerbeetlePort = tbContainer.port
+  }
+
+  public async teardown(): Promise<void> {
+    await super.teardown()
+    await this.tbContainer?.stop()
+  }
+}

packages/backend/package.json

@@ -32,16 +32,15 @@
     "@types/uuid": "^9.0.8",
     "cross-fetch": "^4.0.0",
     "ilp-protocol-stream": "^2.7.2-alpha.2",
+    "jest-environment-node": "^29.7.0",
     "jest-openapi": "^0.14.2",
     "nock": "^13.5.3",
     "node-mocks-http": "^1.14.1",
     "openapi-types": "^12.1.3",
-    "pino-pretty": "^10.3.1",
     "react": "~18.2.0",
     "rosie": "^2.1.1",
     "testcontainers": "^10.7.1",
-    "tmp": "^0.2.1",
-    "ts-node": "^10.9.2"
+    "tmp": "^0.2.1"
   },
   "dependencies": {
     "@adonisjs/fold": "^8.2.0",

packages/backend/src/accounting/tigerbeetle/service.test.ts

@@ -1,3 +1,7 @@
+/**
+ * @jest-environment ./packages/backend/jest.tigerbeetle-environment.ts
+ */
+
 import assert from 'assert'
 import { CreateAccountError as CreateTbAccountError } from 'tigerbeetle-node'
 import { v4 as uuid } from 'uuid'
@@ -9,7 +13,6 @@ import { IocContract } from '@adonisjs/fold'
 import { initIocContainer } from '../../'
 import { AppServices } from '../../app'
 import { truncateTables } from '../../tests/tableManager'
-import { startTigerbeetleContainer } from '../../tests/tigerbeetle'
 import { AccountFactory, FactoryAccount } from '../../tests/accountFactory'
 import { isTransferError, TransferError } from '../errors'
 import {
@@ -20,7 +23,7 @@ import {
   Withdrawal
 } from '../service'
 
-describe('Accounting Service', (): void => {
+describe('Tigerbeetle Accounting Service', (): void => {
   let deps: IocContract<AppServices>
   let appContainer: TestContainer
   let accountingService: AccountingService
@@ -33,10 +36,14 @@ describe('Accounting Service', (): void => {
   }
 
   beforeAll(async (): Promise<void> => {
-    const { port } = await startTigerbeetleContainer()
-    Config.tigerbeetleReplicaAddresses = [port.toString()]
+    const tigerbeetlePort = (global as unknown as { tigerbeetlePort: number })
+      .tigerbeetlePort
 
-    deps = await initIocContainer({ ...Config, useTigerbeetle: true })
+    deps = initIocContainer({
+      ...Config,
+      tigerbeetleReplicaAddresses: [tigerbeetlePort.toString()],
+      useTigerbeetle: true
+    })
     appContainer = await createTestApp(deps)
     accountingService = await deps.use('accountingService')
     accountFactory = new AccountFactory(accountingService, newLedger)
@@ -48,7 +55,6 @@ describe('Accounting Service', (): void => {
 
   afterAll(async (): Promise<void> => {
     await appContainer.shutdown()
-    // TODO: find a way to gracefully stop TB container without running into a thread panic
   })
 
   describe('Create Liquidity Account', (): void => {
@@ -83,11 +89,11 @@ describe('Accounting Service', (): void => {
           },
           LiquidityAccountType.ASSET
         )
-      ).rejects.toThrowError('unable to create account, invalid id')
+      ).rejects.toThrow('unable to create account, invalid id')
     })
 
     test('Create throws on error', async (): Promise<void> => {
-      const tigerbeetle = await deps.use('tigerbeetle')
+      const tigerbeetle = await deps.use('tigerbeetle')!
       jest.spyOn(tigerbeetle, 'createAccounts').mockResolvedValueOnce([
         {
           index: 0,
@@ -106,7 +112,7 @@ describe('Accounting Service', (): void => {
           },
           LiquidityAccountType.ASSET
         )
-      ).rejects.toThrowError(
+      ).rejects.toThrow(
         new TigerbeetleCreateAccountError(
           CreateTbAccountError.exists_with_different_ledger
         )

packages/backend/src/app.ts

@@ -239,7 +239,7 @@ export interface AppServices {
   autoPeeringService: Promise<AutoPeeringService>
   autoPeeringRoutes: Promise<AutoPeeringRoutes>
   connectorApp: Promise<ConnectorApp>
-  tigerbeetle: Promise<TigerbeetleClient>
+  tigerbeetle?: Promise<TigerbeetleClient>
   paymentMethodHandlerService: Promise<PaymentMethodHandlerService>
   ilpPaymentService: Promise<IlpPaymentService>
 }
@@ -615,8 +615,8 @@ export class App {
     if (this.openPaymentsServer) {
       await this.stopServer(this.openPaymentsServer)
     }
-    if (this.adminServer) {
-      await this.stopServer(this.adminServer)
+    if (this.apolloServer) {
+      await this.apolloServer.stop()
     }
     if (this.ilpConnectorService) {
       await this.stopServer(this.ilpConnectorService)

packages/backend/src/graphql/resolvers/auto-peering.test.ts

@@ -1,7 +1,6 @@
 import { faker } from '@faker-js/faker'
 import { gql } from '@apollo/client'
 import assert from 'assert'
-import nock from 'nock'
 
 import { createTestApp, TestContainer } from '../../tests/app'
 import { IocContract } from '@adonisjs/fold'
@@ -20,6 +19,8 @@ import { CreateOrUpdatePeerByUrlInput } from '../generated/graphql'
 import { AutoPeeringService } from '../../payment-method/ilp/auto-peering/service'
 import { v4 as uuid } from 'uuid'
 
+const nock = (global as unknown as { nock: typeof import('nock') }).nock
+
 describe('Auto Peering Resolvers', (): void => {
   let deps: IocContract<AppServices>
   let appContainer: TestContainer

packages/backend/src/index.ts

@@ -54,9 +54,6 @@ BigInt.prototype.toJSON = function () {
   return this.toString()
 }
 
-const container = initIocContainer(Config)
-const app = new App(container)
-
 export function initIocContainer(
   config: typeof Config
 ): IocContract<AppServices> {
@@ -121,13 +118,6 @@ export function initIocContainer(
       serverAddress: config.ilpAddress
     })
   })
-  container.singleton('tigerbeetle', async (deps) => {
-    const config = await deps.use('config')
-    return createClient({
-      cluster_id: BigInt(config.tigerbeetleClusterId),
-      replica_addresses: config.tigerbeetleReplicaAddresses
-    })
-  })
 
   container.singleton('ratesService', async (deps) => {
     const config = await deps.use('config')
@@ -225,7 +215,15 @@ export function initIocContainer(
     }
 
     if (config.useTigerbeetle) {
-      const tigerbeetle = await deps.use('tigerbeetle')
+      container.singleton('tigerbeetle', async (deps) => {
+        const config = await deps.use('config')
+        return createClient({
+          cluster_id: BigInt(config.tigerbeetleClusterId),
+          replica_addresses: config.tigerbeetleReplicaAddresses
+        })
+      })
+
+      const tigerbeetle = await deps.use('tigerbeetle')!
 
       return createTigerbeetleAccountingService({
         logger,
@@ -504,9 +502,15 @@ export const gracefulShutdown = async (
   await app.shutdown()
   const knex = await container.use('knex')
   await knex.destroy()
-  const tigerbeetle = await container.use('tigerbeetle')
-  tigerbeetle.destroy()
+
+  const config = await container.use('config')
+  if (config.useTigerbeetle) {
+    const tigerbeetle = await container.use('tigerbeetle')
+    tigerbeetle?.destroy()
+  }
+
   const redis = await container.use('redis')
+  await redis.quit()
   redis.disconnect()
 
   const telemetry = await container.use('telemetry')
@@ -600,7 +604,10 @@ export const start = async (
 }
 
 // If this script is run directly, start the server
-if (!module.parent) {
+if (require.main === module) {
+  const container = initIocContainer(Config)
+  const app = new App(container)
+
   start(container, app).catch(async (e): Promise<void> => {
     const errInfo = e && typeof e === 'object' && e.stack ? e.stack : e
     const logger = await container.use('logger')

packages/backend/src/middleware/cache/data-stores/redis.test.ts

@@ -13,12 +13,12 @@ describe('Redis Data Store', (): void => {
   const dataStore = createRedisDataStore(redis, ttlMs)
 
   afterEach(async () => {
+    jest.useRealTimers()
     await redis.flushall()
   })
 
   afterAll(async () => {
-    redis.disconnect()
-    jest.useRealTimers()
+    await redis.quit()
   })
 
   describe('set', (): void => {

packages/backend/src/middleware/lock/redis.test.ts

@@ -15,7 +15,7 @@ describe('Redis Lock', (): void => {
   })
 
   afterAll(async () => {
-    redis.disconnect()
+    await redis.quit()
   })
 
   describe('acquire', () => {

packages/backend/src/open_payments/auth/middleware.test.ts

@@ -1,6 +1,5 @@
 import { generateKeyPairSync } from 'crypto'
 import { faker } from '@faker-js/faker'
-import nock from 'nock'
 import { Client, ActiveTokenInfo } from 'token-introspection'
 import { v4 as uuid } from 'uuid'
 import {
@@ -30,6 +29,8 @@ import { setup } from '../wallet_address/model.test'
 import { parseLimits } from '../payment/outgoing/limits'
 import { AccessAction, AccessType } from '@interledger/open-payments'
 
+const nock = (global as unknown as { nock: typeof import('nock') }).nock
+
 type AppMiddleware = (
   ctx: WalletAddressContext,
   next: () => Promise<void>

packages/backend/src/open_payments/grant/service.test.ts

@@ -32,8 +32,8 @@ describe('Grant Service', (): void => {
   })
 
   afterEach(async (): Promise<void> => {
-    await truncateTables(knex)
     jest.useRealTimers()
+    await truncateTables(knex)
   })
 
   afterAll(async (): Promise<void> => {

packages/backend/src/open_payments/wallet_address/key/service.test.ts

@@ -16,19 +16,14 @@ describe('Wallet Address Key Service', (): void => {
   let deps: IocContract<AppServices>
   let appContainer: TestContainer
   let walletAddressKeyService: WalletAddressKeyService
-  const mockMessageProducer = {
-    send: jest.fn()
-  }
 
   beforeAll(async (): Promise<void> => {
-    deps = await initIocContainer(Config)
-    deps.bind('messageProducer', async () => mockMessageProducer)
+    deps = initIocContainer(Config)
     appContainer = await createTestApp(deps)
     walletAddressKeyService = await deps.use('walletAddressKeyService')
   })
 
   afterEach(async (): Promise<void> => {
-    jest.useRealTimers()
     await truncateTables(appContainer.knex)
   })
 

packages/backend/src/open_payments/wallet_address/service.test.ts

@@ -413,8 +413,7 @@ describe('Open Payments Wallet Address Service', (): void => {
         let delayProcessAt: Date | null = null
 
         beforeEach((): void => {
-          jest.useFakeTimers()
-          jest.setSystemTime(new Date())
+          jest.useFakeTimers({ now: Date.now() })
           if (withdrawalThrottleDelay !== undefined) {
             delayProcessAt = new Date(Date.now() + withdrawalThrottleDelay)
           }

packages/backend/src/payment-method/ilp/auto-peering/service.test.ts

@@ -1,6 +1,5 @@
 import assert from 'assert'
 import { IocContract } from '@adonisjs/fold'
-import nock from 'nock'
 import { initIocContainer } from '../../..'
 import { AppServices } from '../../../app'
 import { Config, IAppConfig } from '../../../config/app'
@@ -19,6 +18,8 @@ import { PeerError } from '../peer/errors'
 import { v4 as uuid } from 'uuid'
 import { AccountingService } from '../../../accounting/service'
 
+const nock = (global as unknown as { nock: typeof import('nock') }).nock
+
 describe('Auto Peering Service', (): void => {
   let deps: IocContract<AppServices>
   let appContainer: TestContainer

packages/backend/src/payment-method/ilp/connector/core/factories/ilp-packet.ts

@@ -5,7 +5,7 @@ import { faker } from '@faker-js/faker'
 
 export const IlpPrepareFactory = Factory.define<IlpPrepare>('IlpPrepare').attrs(
   {
-    amount: faker.finance.amount(1, 100, 0),
+    amount: faker.finance.amount({ min: 1, max: 100, dec: 0 }),
     data: Buffer.alloc(0),
     destination: 'test.rafiki.' + faker.person.firstName(),
     expiresAt: new Date(Date.now() + 10 * 1000),

packages/backend/src/payment-method/ilp/connector/core/test/controllers/stream-controller.test.ts

@@ -30,7 +30,7 @@ describe('Stream Controller', function () {
 
   afterAll(async () => {
     await services.redis.flushdb()
-    await services.redis.disconnect()
+    await services.redis.quit()
   })
 
   test('constructs a reply for a receive account', async () => {