initial commit

Author: baileympearson

package-lock.json

@@ -110,7 +110,7 @@
     "source-map-support": "^0.5.21",
     "ts-node": "^10.9.2",
     "tsd": "^0.31.0",
-    "typescript": "5.0",
+    "typescript": "5.3",
     "typescript-cached-transpile": "^0.0.6",
     "v8-heapsnapshot": "^1.3.1",
     "yargs": "^17.7.2"

package.json

@@ -525,6 +525,9 @@ export interface UpdateDescription<TSchema extends Document = Document> {
   disambiguatedPaths?: Document;
 }
 
+// @ts-expect-error Assigning to a readonly property.
+Symbol.asyncDispose ??= Symbol('asyncDispose');
+
 /** @public */
 export type ChangeStreamEvents<
   TSchema extends Document = Document,
@@ -544,9 +547,17 @@ export type ChangeStreamEvents<
  * @public
  */
 export class ChangeStream<
-  TSchema extends Document = Document,
-  TChange extends Document = ChangeStreamDocument<TSchema>
-> extends TypedEventEmitter<ChangeStreamEvents<TSchema, TChange>> {
+    TSchema extends Document = Document,
+    TChange extends Document = ChangeStreamDocument<TSchema>
+  >
+  extends TypedEventEmitter<ChangeStreamEvents<TSchema, TChange>>
+  implements AsyncDisposable
+{
+  async [Symbol.asyncDispose]() {
+    console.error('ChangeStream[Symbol.asyncDispose]() called.');
+    await this.close();
+  }
+
   pipeline: Document[];
   /**
    * @remarks WriteConcern can still be present on the options because

src/change_stream.ts

@@ -1,3 +1,4 @@
+import { once } from 'events';
 import { Readable, Transform } from 'stream';
 
 import { type BSONSerializeOptions, type Document, Long, pluckBSONSerializeOptions } from '../bson';
@@ -122,6 +123,9 @@ export type AbstractCursorEvents = {
   [AbstractCursor.CLOSE](): void;
 };
 
+// @ts-expect-error Assigning to a readonly property.
+Symbol.asyncDispose ??= Symbol('asyncDispose');
+
 /** @public */
 export abstract class AbstractCursor<
   TSchema = any,
@@ -275,6 +279,12 @@ export abstract class AbstractCursor<
     return !!this.cursorClient.topology?.loadBalanced;
   }
 
+  async [Symbol.asyncDispose]() {
+    const name = this.constructor.name;
+    console.error(name + '[Symbol.asyncDispose]() called.');
+    await this.close();
+  }
+
   /** Returns current buffered documents length */
   bufferedCount(): number {
     return this.documents?.length ?? 0;

src/cursor/abstract_cursor.ts

@@ -325,6 +325,9 @@ export type MongoClientEvents = Pick<TopologyEvents, (typeof MONGO_CLIENT_EVENTS
 
 const kOptions = Symbol('options');
 
+// @ts-expect-error Assigning to a readonly property.
+Symbol.asyncDispose ??= Symbol('asyncDispose');
+
 /**
  * The **MongoClient** class is a class that allows for making Connections to MongoDB.
  * @public
@@ -344,7 +347,7 @@ const kOptions = Symbol('options');
  * await client.insertOne({ name: 'spot', kind: 'dog' });
  * ```
  */
-export class MongoClient extends TypedEventEmitter<MongoClientEvents> {
+export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements AsyncDisposable {
   /** @internal */
   s: MongoClientPrivate;
   /** @internal */
@@ -404,6 +407,11 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> {
     this.checkForNonGenuineHosts();
   }
 
+  async [Symbol.asyncDispose]() {
+    console.error('MongoClient[Symbol.asyncDispose]() called.');
+    await this.close();
+  }
+
   /** @internal */
   private checkForNonGenuineHosts() {
     const documentDBHostnames = this[kOptions].hosts.filter((hostAddress: HostAddress) =>

src/mongo_client.ts

@@ -99,6 +99,9 @@ export interface EndSessionOptions {
   forceClear?: boolean;
 }
 
+// @ts-expect-error Assigning to a readonly property.
+Symbol.asyncDispose ??= Symbol('asyncDispose');
+
 /**
  * A class representing a client session on the server
  *
@@ -287,6 +290,11 @@ export class ClientSession extends TypedEventEmitter<ClientSessionEvents> {
     }
   }
 
+  async [Symbol.asyncDispose]() {
+    console.error('ClientSession[Symbol.asyncDispose]() called.');
+    await this.endSession({ force: true });
+  }
+
   /**
    * Advances the operationTime for a ClientSession.
    *

src/sessions.ts

@@ -11,7 +11,8 @@
     "lib": [
       "es2021",
       "ES2022.Error",
-      "ES2022.Object"
+      "ES2022.Object",
+      "ESNext.Disposable"
     ],
     // We don't make use of tslib helpers, all syntax used is supported by target engine
     "importHelpers": false,