Fix memory leaks in Driver class

polRk · polRk · commit 9d7e10c0288f · 2025-11-19T13:13:09.000+03:00
- Remove waitForChannelReady from constructor to prevent Promise chain memory leaks
- Add lazy initialization for discovery client (only created when needed)
- Implement channel connectivity check in ready() method for non-discovery mode
- Add test for memory leak prevention (100,000 Driver instances)
- Use Promise.withResolvers() for cleaner promise handling
- Properly handle AbortSignal cancellation in channel connectivity loop
- Import ConnectivityState enum for type-safe state checks

The main issue was that waitForChannelReady() in constructor created Promise
chains with closures that held references to 'this', preventing garbage
collection. Now channel connectivity is checked lazily only when ready() is
called, and the promise chain is properly managed."
diff --git a/examples/api/package.json b/examples/api/package.json
@@ -16,7 +16,7 @@
 		"@bufbuild/protobuf": "^2.6.0",
 		"@ydbjs/api": "^6.0.0",
 		"@ydbjs/auth": "^6.0.0",
-		"@ydbjs/core": "^6.0.0"
+		"@ydbjs/core": "^6.0.6"
 	},
 	"publishConfig": {
 		"access": "restricted"
diff --git a/examples/auth-yandex-cloud/package.json b/examples/auth-yandex-cloud/package.json
@@ -15,8 +15,8 @@
 	},
 	"dependencies": {
 		"@ydbjs/auth-yandex-cloud": "^0.1.2",
-		"@ydbjs/core": "^6.0.0",
-		"@ydbjs/query": "^6.0.0"
+		"@ydbjs/core": "^6.0.6",
+		"@ydbjs/query": "^6.0.6"
 	},
 	"publishConfig": {
 		"access": "restricted"
diff --git a/examples/query/package.json b/examples/query/package.json
@@ -13,8 +13,8 @@
 		"dev": "DEBUG=ydbjs:* node index.js"
 	},
 	"dependencies": {
-		"@ydbjs/core": "^6.0.0",
-		"@ydbjs/query": "^6.0.0",
+		"@ydbjs/core": "^6.0.6",
+		"@ydbjs/query": "^6.0.6",
 		"@ydbjs/value": "^6.0.0"
 	},
 	"publishConfig": {
diff --git a/examples/sls/package.json b/examples/sls/package.json
@@ -15,8 +15,8 @@
 	},
 	"dependencies": {
 		"@ydbjs/auth": "^6.0.0",
-		"@ydbjs/core": "^6.0.0",
-		"@ydbjs/query": "^6.0.0"
+		"@ydbjs/core": "^6.0.6",
+		"@ydbjs/query": "^6.0.6"
 	},
 	"publishConfig": {
 		"access": "restricted"
diff --git a/examples/tls/package.json b/examples/tls/package.json
@@ -15,7 +15,7 @@
 	"dependencies": {
 		"@ydbjs/api": "^6.0.0",
 		"@ydbjs/auth": "^6.0.0",
-		"@ydbjs/core": "^6.0.0"
+		"@ydbjs/core": "^6.0.6"
 	},
 	"publishConfig": {
 		"access": "restricted"
diff --git a/examples/topic/package.json b/examples/topic/package.json
@@ -13,9 +13,9 @@
 		"dev": "DEBUG=ydbjs:* node index.js"
 	},
 	"dependencies": {
-		"@ydbjs/core": "^6.0.0",
-		"@ydbjs/query": "^6.0.0",
-		"@ydbjs/topic": "^6.0.0"
+		"@ydbjs/core": "^6.0.6",
+		"@ydbjs/query": "^6.0.6",
+		"@ydbjs/topic": "^6.0.6"
 	},
 	"publishConfig": {
 		"access": "restricted"
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -20,7 +20,8 @@
 		"attw": "turbo run attw",
 		"test": "vitest --run",
 		"lint": "oxlint",
-		"publish-packages": "turbo run clean build attw test && changeset version && changeset publish"
+		"version": "npx changeset version && npm install",
+		"publish": "npx changeset publish"
 	},
 	"dependencies": {
 		"@types/node": "^24.10.0"
diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @ydbjs/core
 
+## 6.0.6
+
+### Patch Changes
+
+- Fix memory leaks in Driver class
+
 ## 6.0.5
 
 ### Patch Changes
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "@ydbjs/core",
-	"version": "6.0.5",
+	"version": "6.0.6",
 	"description": "Core driver for YDB: manages connections, endpoint discovery, authentication, and service client creation. Foundation for all YDB client operations.",
 	"keywords": [
 		"ydb",
diff --git a/packages/core/src/driver.test.ts b/packages/core/src/driver.test.ts
@@ -56,3 +56,30 @@ test('allows custom channel options override', () => {
 
 	driver.close()
 })
+
+test('creating thousands of drivers with using does not leak memory', async () => {
+	let iterations = 100000
+	let memoryBefore = process.memoryUsage().heapUsed
+
+	for (let i = 0; i < iterations; i++) {
+		using _driver = new Driver('grpc://localhost:2136/local', {
+			'ydb.sdk.enable_discovery': false,
+		})
+
+		if (i % 1000 === 0 && i > 0) {
+			if (global.gc) {
+				global.gc()
+			}
+		}
+	}
+
+	if (global.gc) {
+		global.gc()
+	}
+
+	let memoryAfter = process.memoryUsage().heapUsed
+	let memoryGrowth = memoryAfter - memoryBefore
+	let memoryGrowthMB = memoryGrowth / (1024 * 1024)
+
+	expect(memoryGrowthMB).toBeLessThan(50)
+})
diff --git a/packages/core/src/driver.ts b/packages/core/src/driver.ts
@@ -12,6 +12,7 @@ import { loggers } from '@ydbjs/debug'
 import { YDBError } from '@ydbjs/error'
 import { type RetryConfig, defaultRetryConfig, retry } from '@ydbjs/retry'
 import {
+	type Channel,
 	type ChannelOptions,
 	type Client,
 	ClientError,
@@ -21,13 +22,13 @@ import {
 	Status,
 	composeClientMiddleware,
 	createClientFactory,
-	waitForChannelReady,
 } from 'nice-grpc'
 import pkg from '../package.json' with { type: 'json' }
 import { type Connection, LazyConnection } from './conn.js'
 import { debug } from './middleware.js'
 import { ConnectionPool } from './pool.js'
 import { detectRuntime } from './runtime.js'
+import { ConnectivityState } from '@grpc/grpc-js/build/src/connectivity-state.js'
 
 let dbg = loggers.driver
 
@@ -170,24 +171,11 @@ export class Driver implements Disposable {
 
 		this.#pool = new ConnectionPool(channelCredentials, this.options.channelOptions)
 
-		this.#discoveryClient = createClientFactory()
-			.use(this.#middleware)
-			.create(DiscoveryServiceDefinition, this.#connection.channel)
-
 		if (this.options['ydb.sdk.enable_discovery'] === false) {
 			dbg.log('discovery disabled, using single endpoint')
-			waitForChannelReady(
-				this.#connection.channel,
-				new Date(Date.now() + (this.options['ydb.sdk.ready_timeout_ms'] || 10000))
-			)
-				.then(() => {
-					dbg.log('single endpoint ready')
-					return this.#ready.resolve()
-				})
-				.catch((error) => {
-					dbg.log('single endpoint failed to become ready: %O', error)
-					this.#ready.reject(error)
-				})
+			// Channel will be lazily created on first use
+			// Readiness check is skipped to avoid memory leaks from Promise chains
+			this.#ready.resolve()
 		}
 
 		if (this.options['ydb.sdk.enable_discovery'] === true) {
@@ -242,6 +230,16 @@ export class Driver implements Disposable {
 		return this.cs.protocol === 'https:' || this.cs.protocol === 'grpcs:'
 	}
 
+	get #getDiscoveryClient(): Client<typeof DiscoveryServiceDefinition> {
+		if (this.#discoveryClient === null) {
+			dbg.log('creating discovery client')
+			this.#discoveryClient = createClientFactory()
+				.use(this.#middleware)
+				.create(DiscoveryServiceDefinition, this.#connection.channel)
+		}
+		return this.#discoveryClient
+	}
+
 	async #discovery(signal: AbortSignal): Promise<void> {
 		dbg.log('starting discovery for database: %s', this.database)
 
@@ -255,7 +253,7 @@ export class Driver implements Disposable {
 
 		let result = await retry(retryConfig, async (signal) => {
 			dbg.log('attempting to list endpoints for database: %s', this.database)
-			let response = await this.#discoveryClient.listEndpoints({ database: this.database }, { signal })
+			let response = await this.#getDiscoveryClient.listEndpoints({ database: this.database }, { signal })
 			if (!response.operation) {
 				throw new ClientError(
 					DiscoveryServiceDefinition.listEndpoints.path,
@@ -289,19 +287,63 @@ export class Driver implements Disposable {
 
 	async ready(signal?: AbortSignal): Promise<void> {
 		dbg.log('waiting for driver to become ready')
-		signal = signal
-			? AbortSignal.any([signal, AbortSignal.timeout(this.options['ydb.sdk.ready_timeout_ms']!)])
-			: AbortSignal.timeout(this.options['ydb.sdk.ready_timeout_ms']!)
+
+		let timeoutMs = this.options['ydb.sdk.ready_timeout_ms']!
+		let effectiveSignal = signal
+			? AbortSignal.any([signal, AbortSignal.timeout(timeoutMs)])
+			: AbortSignal.timeout(timeoutMs)
 
 		try {
-			await abortable(signal, this.#ready.promise)
+			await abortable(effectiveSignal, this.#ready.promise)
+
+			if (this.options['ydb.sdk.enable_discovery'] === false) {
+				dbg.log('checking channel connectivity for single endpoint mode')
+				await this.#checkChannelConnectivity(this.#connection.channel, timeoutMs, effectiveSignal)
+			}
+
 			dbg.log('driver is ready')
 		} catch (error) {
 			dbg.log('driver failed to become ready: %O', error)
 			throw error
 		}
 	}
 
+	async #checkChannelConnectivity(channel: Channel, timeoutMs: number, signal: AbortSignal): Promise<void> {
+		let deadline = new Date(Date.now() + timeoutMs)
+
+		while (true) {
+			if (signal.aborted) {
+				throw signal.reason || new Error('Aborted while waiting for channel connectivity')
+			}
+
+			let state = channel.getConnectivityState(true) // true = try to connect
+			dbg.log('channel connectivity state: %d', state)
+
+			if (state === ConnectivityState.READY) {
+				dbg.log('channel is ready')
+				return
+			}
+
+			if (state === ConnectivityState.SHUTDOWN) {
+				throw new Error('Channel is shutdown')
+			}
+
+			let { promise, resolve, reject } = Promise.withResolvers<void>()
+			channel.watchConnectivityState(state, deadline, (err?: Error) => {
+				if (err) {
+					dbg.log('channel connectivity state change timeout: %O', err)
+					reject(err)
+				} else {
+					dbg.log('channel connectivity state changed')
+					resolve()
+				}
+			})
+
+			// oxlint-disable-next-line no-await-in-loop
+			await abortable(signal, promise)
+		}
+	}
+
 	close(): void {
 		dbg.log('closing driver')
 		if (this.#rediscoverTimer) {
diff --git a/packages/query/CHANGELOG.md b/packages/query/CHANGELOG.md
@@ -1,5 +1,14 @@
 # @ydbjs/query
 
+## 6.0.6
+
+### Patch Changes
+
+- Fix memory leaks in Driver class
+
+- Updated dependencies []:
+  - @ydbjs/core@6.0.6
+
 ## 6.0.5
 
 ### Patch Changes
diff --git a/packages/query/package.json b/packages/query/package.json
diff --git a/packages/topic/CHANGELOG.md b/packages/topic/CHANGELOG.md
diff --git a/packages/topic/package.json b/packages/topic/package.json
diff --git a/vitest.config.ts b/vitest.config.ts
diff --git a/vitest.setup.ydb.ts b/vitest.setup.ydb.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@ydbjs/core",`
`3`		`- "version": "6.0.5",`
	`3`	`+ "version": "6.0.6",`
`4`	`4`	`"description": "Core driver for YDB: manages connections, endpoint discovery, authentication, and service client creation. Foundation for all YDB client operations.",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"ydb",`