add rough behavior testing

Author: baileympearson

.evergreen/config.in.yml

@@ -353,6 +353,18 @@ functions:
         args:
           - "${PROJECT_DIRECTORY}/.evergreen/run-typescript.sh"
 
+  "check resource management":
+    - command: subprocess.exec
+      type: test
+      params:
+        working_dir: "src"
+        timeout_secs: 60
+        env:
+          PROJECT_DIRECTORY: ${PROJECT_DIRECTORY}
+        binary: bash
+        args:
+          - "${PROJECT_DIRECTORY}/.evergreen/run-resource-management.sh"
+
   "compile driver":
     - command: subprocess.exec
       type: test

.evergreen/config.yml

@@ -316,6 +316,17 @@ functions:
         binary: bash
         args:
           - ${PROJECT_DIRECTORY}/.evergreen/run-typescript.sh
+  check resource management:
+    - command: subprocess.exec
+      type: test
+      params:
+        working_dir: src
+        timeout_secs: 60
+        env:
+          PROJECT_DIRECTORY: ${PROJECT_DIRECTORY}
+        binary: bash
+        args:
+          - ${PROJECT_DIRECTORY}/.evergreen/run-resource-management.sh
   compile driver:
     - command: subprocess.exec
       type: test
@@ -3461,6 +3472,30 @@ tasks:
             - {key: NPM_VERSION, value: '9'}
       - func: install dependencies
       - func: run lint checks
+  - name: run-resource-management-no-async-dispose
+    tags:
+      - resource-management
+    commands:
+      - command: expansions.update
+        type: setup
+        params:
+          updates:
+            - {key: NODE_LTS_VERSION, value: v16.20.2}
+            - {key: NPM_VERSION, value: '9'}
+      - func: install dependencies
+      - func: check resource management
+  - name: run-resource-management-async-dispose
+    tags:
+      - resource-management
+    commands:
+      - command: expansions.update
+        type: setup
+        params:
+          updates:
+            - {key: NODE_LTS_VERSION, value: latest}
+            - {key: NPM_VERSION, value: '9'}
+      - func: install dependencies
+      - func: check resource management
   - name: check-types-typescript-next-node-types-20.14.10
     tags:
       - check-types-typescript-next
@@ -5020,6 +5055,7 @@ buildvariants:
       - .unit-tests
       - .lint-checks
       - .typescript-compilation
+      - .resource-management
   - name: generate-combined-coverage
     display_name: Generate Combined Coverage
     run_on: rhel80-large

.evergreen/generate_evergreen_tasks.js

@@ -492,6 +492,30 @@ SINGLETON_TASKS.push(
         { func: 'run lint checks' }
       ]
     },
+    {
+      name: 'run-resource-management-no-async-dispose',
+      tags: ['resource-management'],
+      commands: [
+        updateExpansions({
+          NODE_LTS_VERSION: "v16.20.2",
+          NPM_VERSION: 9
+        }),
+        { func: 'install dependencies' },
+        { func: 'check resource management' }
+      ]
+    },
+    {
+      name: 'run-resource-management-async-dispose',
+      tags: ['resource-management'],
+      commands: [
+        updateExpansions({
+          NODE_LTS_VERSION: 'latest',
+          NPM_VERSION: 9
+        }),
+        { func: 'install dependencies' },
+        { func: 'check resource management' }
+      ]
+    },
     ...Array.from(makeTypescriptTasks())
   ]
 );
@@ -548,7 +572,7 @@ BUILD_VARIANTS.push({
   name: 'lint',
   display_name: 'lint',
   run_on: DEFAULT_OS,
-  tasks: ['.unit-tests', '.lint-checks', '.typescript-compilation']
+  tasks: ['.unit-tests', '.lint-checks', '.typescript-compilation', '.resource-management']
 });
 
 BUILD_VARIANTS.push({
@@ -755,6 +779,7 @@ fileData.tasks = (fileData.tasks || [])
   .concat(AUTH_DISABLED_TASKS)
   .concat(AWS_LAMBDA_HANDLER_TASKS)
   .concat(MONGOCRYPTD_CSFLE_TASKS);
+
 fileData.buildvariants = (fileData.buildvariants || []).concat(BUILD_VARIANTS);
 
 fs.writeFileSync(

.evergreen/install-dependencies.sh

@@ -1,6 +1,10 @@
 #!/usr/bin/env bash
 set -o errexit  # Exit the script with error if any of the commands fail
 
+# allowed values:
+## a nodejs major version (i.e., 16)
+## 'latest'
+## a full nodejs version, in the format v<major>.<minor>.patch
 NODE_LTS_VERSION=${NODE_LTS_VERSION:-16}
 # npm version can be defined in the environment for cases where we need to install
 # a version lower than latest to support EOL Node versions.

package.json

@@ -145,6 +145,7 @@
     "check:unit": "mocha test/unit",
     "check:ts": "node ./node_modules/typescript/bin/tsc -v && node ./node_modules/typescript/bin/tsc --noEmit",
     "check:atlas": "mocha --config test/manual/mocharc.json test/manual/atlas_connectivity.test.ts",
+    "check:resource-management": "mocha --config test/manual/mocharc.json test/manual/resource_management.test.ts",
     "check:drivers-atlas-testing": "mocha --config test/mocha_mongodb.json test/atlas/drivers_atlas_testing.test.ts",
     "check:adl": "mocha --config test/mocha_mongodb.json test/manual/atlas-data-lake-testing",
     "check:aws": "nyc mocha --config test/mocha_mongodb.json test/integration/auth/mongodb_aws.test.ts",

src/resource_management.ts

@@ -1,3 +1,7 @@
+import { AbstractCursor, ChangeStream } from './beta';
+import { MongoClient } from './mongo_client';
+import { ClientSession } from './sessions';
+
 /**
  * @public
  * @experimental
@@ -6,3 +10,25 @@ export interface AsyncDisposable {
   /** @beta */
   [Symbol.asyncDispose]: () => Promise<void>;
 }
+
+export function load() {
+  Symbol.asyncDispose &&
+    (MongoClient.prototype[Symbol.asyncDispose] = async function () {
+      await this.close();
+    });
+
+  Symbol.asyncDispose &&
+    (ClientSession.prototype[Symbol.asyncDispose] = async function () {
+      await this.endSession({ force: true });
+    });
+
+  Symbol.asyncDispose &&
+    (AbstractCursor.prototype[Symbol.asyncDispose] = async function () {
+      await this.close();
+    });
+
+  Symbol.asyncDispose &&
+    (ChangeStream.prototype[Symbol.asyncDispose] = async function () {
+      await this.close();
+    });
+}

test/manual/resource_management.test.ts

@@ -20,11 +20,9 @@ describe('Explicit Resource Management Tests', function () {
       }
     });
 
-    this.afterEach(function () {});
-
     describe('MongoClient', function () {
       it('closes the the client', async function () {
-        client = new MongoClient(process.env.MONGODB_URI);
+        client = new MongoClient('mongodb://localhost:27017');
 
         const spy = sinon.spy(client, 'close');
         await client[Symbol.asyncDispose]();
@@ -34,7 +32,7 @@ describe('Explicit Resource Management Tests', function () {
 
     describe('ClientSession', function () {
       it('ends the session', async function () {
-        client = new MongoClient(process.env.MONGODB_URI);
+        client = new MongoClient('mongodb://localhost:27017');
         const session = client.startSession();
 
         const spy = sinon.spy(session, 'endSession');
@@ -45,7 +43,7 @@ describe('Explicit Resource Management Tests', function () {
 
     describe('ChangeStreams', function () {
       it('closes the change stream', async function () {
-        client = new MongoClient(process.env.MONGODB_URI);
+        client = new MongoClient('mongodb://localhost:27017');
         const changeStream = client.watch();
 
         const spy = sinon.spy(changeStream, 'close');
@@ -56,7 +54,7 @@ describe('Explicit Resource Management Tests', function () {
 
     describe('cursors', function () {
       it('closes the cursor', async function () {
-        client = new MongoClient(process.env.MONGODB_URI);
+        client = new MongoClient('mongodb://localhost:27017');
         const cursor = client.db('foo').collection('bar').find();
 
         const spy = sinon.spy(cursor, 'close');

test/mongodb.ts

@@ -187,6 +187,7 @@ export * from '../src/operations/update';
 export * from '../src/operations/validate_collection';
 export * from '../src/read_concern';
 export * from '../src/read_preference';
+export * from '../src/resource_management';
 export * from '../src/sdam/common';
 export * from '../src/sdam/events';
 export * from '../src/sdam/monitor';