await using kysely = new Kysely() support. (#1167)

Author: igalklebanov

src/kysely.ts

@@ -42,6 +42,9 @@ import {
   provideControlledConnection,
 } from './util/provide-controlled-connection.js'
 
+// @ts-ignore
+Symbol.asyncDispose ??= Symbol('Symbol.asyncDispose')
+
 /**
  * The main Kysely class.
  *
@@ -87,7 +90,7 @@ import {
  */
 export class Kysely<DB>
   extends QueryCreator<DB>
-  implements QueryExecutorProvider
+  implements QueryExecutorProvider, AsyncDisposable
 {
   readonly #props: KyselyProps
 
@@ -509,6 +512,10 @@ export class Kysely<DB>
 
     return this.getExecutor().executeQuery<R>(compiledQuery, queryId)
   }
+
+  async [Symbol.asyncDispose]() {
+    await this.destroy()
+  }
 }
 
 export class Transaction<DB> extends Kysely<DB> {

test/node/src/async-dispose.test.ts

@@ -0,0 +1,65 @@
+import {
+  CompiledQuery,
+  DatabaseConnection,
+  DummyDriver,
+  Kysely,
+  PostgresAdapter,
+  PostgresIntrospector,
+  PostgresQueryCompiler,
+  QueryResult,
+  RootOperationNode,
+  sql,
+} from '../../..'
+import { expect } from './test-setup'
+
+describe('async dispose', function () {
+  it('should call destroy ', async () => {
+    const steps: string[] = []
+
+    {
+      await using db = new Kysely({
+        dialect: {
+          createAdapter: () => new PostgresAdapter(),
+          createDriver: () =>
+            new (class extends DummyDriver {
+              async acquireConnection() {
+                return new (class implements DatabaseConnection {
+                  async executeQuery<R>(): Promise<QueryResult<R>> {
+                    steps.push('executed')
+                    return { rows: [] }
+                  }
+                  streamQuery<R>(): AsyncIterableIterator<QueryResult<R>> {
+                    throw new Error('Method not implemented.')
+                  }
+                })()
+              }
+              async destroy(): Promise<void> {
+                steps.push('destroyed')
+              }
+            })(),
+          createIntrospector: (db) => new PostgresIntrospector(db),
+          createQueryCompiler: () =>
+            new (class extends PostgresQueryCompiler {
+              compileQuery(node: RootOperationNode): CompiledQuery<unknown> {
+                const compiled = super.compileQuery(node)
+                steps.push('compiled')
+                return compiled
+              }
+            })(),
+        },
+      })
+
+      await sql`select 1`.execute(db)
+    }
+
+    steps.push('after runScope')
+
+    expect(steps).to.length.to.be.greaterThan(1)
+    expect(steps).to.deep.equal([
+      'compiled',
+      'executed',
+      'destroyed',
+      'after runScope',
+    ])
+  })
+})

test/node/tsconfig.json

@@ -2,6 +2,8 @@
   "extends": "../../tsconfig-base.json",
   "include": ["src/**/*"],
   "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["ESNext"],
     "module": "CommonJS",
     "outDir": "dist",
     "skipLibCheck": true