asdf

Author: baileympearson

.eslintrc.json

@@ -271,7 +271,8 @@
     {
       // Settings for generated definition files
       "files": [
-        "mongodb.d.ts"
+        "**/*.d.ts",
+        "lib/*.d.ts"
       ],
       "parser": "@typescript-eslint/parser",
       "rules": {

api-extractor.json

@@ -10,7 +10,8 @@
   "dtsRollup": {
     "enabled": true,
     "untrimmedFilePath": "",
-    "publicTrimmedFilePath": "<projectFolder>/<unscopedPackageName>.d.ts"
+    "publicTrimmedFilePath": "<projectFolder>/<unscopedPackageName>.d.ts",
+    "betaTrimmedFilePath": "<projectFolder>/lib/beta.d.ts"
   },
   "tsdocMetadata": {
     "enabled": false

etc/clean_definition_files.cjs

@@ -21,7 +21,7 @@ if (fs.existsSync(libPath)) {
   const definitionFiles = Array.from(walk(libPath)).filter(filePath => {
     return filePath.endsWith('.d.ts') || filePath.endsWith('.d.ts.map');
   });
-  for (const definitionFile of definitionFiles) {
+  for (const definitionFile of definitionFiles.filter(file => !file.endsWith('beta.d.ts'))) {
     fs.unlinkSync(definitionFile);
   }
 }

package-lock.json

@@ -7,25 +7,10 @@
     "src",
     "etc/prepare.js",
     "mongodb.d.ts",
-    "mongodb-next.d.ts",
     "tsconfig.json"
   ],
-  "exports": {
-    ".": {
-      "import": "./lib/index.js",
-      "types": "./mongodb.d.ts",
-      "require": "./lib/index.js",
-      "node": "./lib/index.js",
-      "default": "./lib/index.js"
-    },
-    "./next": {
-      "import": "./lib/index.js",
-      "types": "./mongodb-next.d.ts",
-      "require": "./lib/index.js",
-      "node": "./lib/index.js",
-      "default": "./lib/index.js"
-    }
-  },
+  "main": "lib/index.js",
+  "types": "mongodb.d.ts",
   "repository": {
     "type": "git",
     "url": "[email protected]:mongodb/node-mongodb-native.git"
@@ -88,7 +73,7 @@
     "@types/express": "^4.17.21",
     "@types/kerberos": "^1.1.5",
     "@types/mocha": "^10.0.6",
-    "@types/node": "^20.12.7",
+    "@types/node": "^20.14.10",
     "@types/saslprep": "^1.0.3",
     "@types/semver": "^7.5.8",
     "@types/sinon": "^17.0.3",
@@ -141,7 +126,7 @@
   "scripts": {
     "build:evergreen": "node .evergreen/generate_evergreen_tasks.js",
     "build:ts": "node ./node_modules/typescript/bin/tsc",
-    "build:dts": "npm run build:ts && api-extractor run && node etc/clean_definition_files.cjs && ts-node polyfill.ts",
+    "build:dts": "npm run build:ts && api-extractor run && node etc/clean_definition_files.cjs && eslint --no-ignore --fix mongodb.d.ts lib/beta.d.ts",
     "build:docs": "./etc/docs/build.ts",
     "build:typedoc": "typedoc",
     "build:nightly": "node ./.github/scripts/nightly.mjs",

package.json

@@ -0,0 +1 @@
+export * from './index';

src/beta.ts

@@ -14,6 +14,7 @@ import {
   MongoRuntimeError
 } from './error';
 import { MongoClient } from './mongo_client';
+import { AsyncDisposable } from './resource_management';
 import { type InferIdType, TypedEventEmitter } from './mongo_types';
 import type { AggregateOptions } from './operations/aggregate';
 import type { CollationOptions, OperationParent } from './operations/command';
@@ -525,9 +526,6 @@ 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,
@@ -553,10 +551,8 @@ export class ChangeStream<
   extends TypedEventEmitter<ChangeStreamEvents<TSchema, TChange>>
   implements AsyncDisposable
 {
-  async [Symbol.asyncDispose]() {
-    console.error('ChangeStream[Symbol.asyncDispose]() called.');
-    await this.close();
-  }
+  /** @beta */
+  declare [Symbol.asyncDispose]: () => Promise<void>;
 
   pipeline: Document[];
   /**
@@ -997,3 +993,7 @@ export class ChangeStream<
     }
   }
 }
+
+Symbol.asyncDispose && (ChangeStream.prototype[Symbol.asyncDispose] = async function() {
+  await this.close();
+})

src/change_stream.ts

@@ -1,4 +1,3 @@
-import { once } from 'events';
 import { Readable, Transform } from 'stream';
 
 import { type BSONSerializeOptions, type Document, Long, pluckBSONSerializeOptions } from '../bson';
@@ -21,6 +20,7 @@ import { ReadPreference, type ReadPreferenceLike } from '../read_preference';
 import type { Server } from '../sdam/server';
 import { ClientSession, maybeClearPinnedConnection } from '../sessions';
 import { type MongoDBNamespace, squashError } from '../utils';
+import { AsyncDisposable } from '../resource_management';
 
 /**
  * @internal
@@ -123,14 +123,11 @@ 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,
   CursorEvents extends AbstractCursorEvents = AbstractCursorEvents
-> extends TypedEventEmitter<CursorEvents> {
+> extends TypedEventEmitter<CursorEvents> implements AsyncDisposable {
   /** @internal */
   private cursorId: Long | null;
   /** @internal */
@@ -279,11 +276,8 @@ 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();
-  }
+  /** @beta */
+  declare [Symbol.asyncDispose]: () => Promise<void>;
 
   /** Returns current buffered documents length */
   bufferedCount(): number {
@@ -926,3 +920,7 @@ class ReadableCursorStream extends Readable {
     );
   }
 }
+
+Symbol.asyncDispose && (AbstractCursor.prototype[Symbol.asyncDispose] = async function() {
+  await this.close();
+})

src/cursor/abstract_cursor.ts

@@ -107,6 +107,7 @@ export { CURSOR_FLAGS } from './cursor/abstract_cursor';
 export { MongoErrorLabel } from './error';
 export { ExplainVerbosity } from './explain';
 export { ServerApiVersion } from './mongo_client';
+export { AsyncDisposable } from './resource_management';
 export { ReturnDocument } from './operations/find_and_modify';
 export { ProfilingLevel } from './operations/set_profiling_level';
 export { ReadConcernLevel } from './read_concern';

src/index.ts

@@ -54,6 +54,7 @@ import {
   squashError
 } from './utils';
 import type { W, WriteConcern, WriteConcernSettings } from './write_concern';
+import { AsyncDisposable } from './resource_management';
 
 /** @public */
 export const ServerApiVersion = Object.freeze({
@@ -325,9 +326,6 @@ 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
@@ -407,10 +405,8 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
     this.checkForNonGenuineHosts();
   }
 
-  async [Symbol.asyncDispose]() {
-    console.error('MongoClient[Symbol.asyncDispose]() called.');
-    await this.close();
-  }
+  /** @beta */
+  declare [Symbol.asyncDispose]: () => Promise<void>;
 
   /** @internal */
   private checkForNonGenuineHosts() {
@@ -766,6 +762,10 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
   }
 }
 
+Symbol.asyncDispose && (MongoClient.prototype[Symbol.asyncDispose] = async function() {
+  await this.close();
+})
+
 /**
  * Parsed Mongo Client Options.
  *

src/mongo_client.ts

@@ -0,0 +1,8 @@
+/**
+ * @public
+ * @experimental
+ */
+export interface AsyncDisposable {
+	/** @beta */
+	[Symbol.asyncDispose]: () => Promise<void>;
+}

src/resource_management.ts

@@ -27,6 +27,7 @@ import { executeOperation } from './operations/execute_operation';
 import { RunAdminCommandOperation } from './operations/run_command';
 import { ReadConcernLevel } from './read_concern';
 import { ReadPreference } from './read_preference';
+import { AsyncDisposable } from './resource_management';
 import { _advanceClusterTime, type ClusterTime, TopologyType } from './sdam/common';
 import {
   isTransactionCommand,
@@ -99,16 +100,13 @@ 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
  *
  * NOTE: not meant to be instantiated directly.
  * @public
  */
-export class ClientSession extends TypedEventEmitter<ClientSessionEvents> {
+export class ClientSession extends TypedEventEmitter<ClientSessionEvents> implements AsyncDisposable {
   /** @internal */
   client: MongoClient;
   /** @internal */
@@ -289,11 +287,8 @@ export class ClientSession extends TypedEventEmitter<ClientSessionEvents> {
       maybeClearPinnedConnection(this, { force: true, ...options });
     }
   }
-
-  async [Symbol.asyncDispose]() {
-    console.error('ClientSession[Symbol.asyncDispose]() called.');
-    await this.endSession({ force: true });
-  }
+/** @beta */
+  declare [Symbol.asyncDispose]: () => Promise<void>;
 
   /**
    * Advances the operationTime for a ClientSession.
@@ -492,6 +487,10 @@ export class ClientSession extends TypedEventEmitter<ClientSessionEvents> {
   }
 }
 
+Symbol.asyncDispose && (ClientSession.prototype[Symbol.asyncDispose] = async function() {
+  await this.endSession({ force: true });
+})
+
 const MAX_WITH_TRANSACTION_TIMEOUT = 120000;
 const NON_DETERMINISTIC_WRITE_CONCERN_ERRORS = new Set([
   'CannotSatisfyWriteConcern',