preliminary tests finished

Author: aditi-khare-mongoDB

test/integration/node-specific/client_close.test.ts

@@ -1,8 +1,8 @@
-import { expect } from 'chai';
+import sinon = require('sinon');
 import { TestConfiguration } from '../../tools/runner/config';
-import { runScriptAndReturnResourceInfo } from './resource_tracking_script_builder';
+import { runScriptAndGetProcessInfo } from './resource_tracking_script_builder';
 
-describe.skip('client.close() Integration', () => {
+describe('client.close() Integration', () => {
   let config: TestConfiguration;
   beforeEach(function () {
     config = this.configuration;
@@ -12,27 +12,39 @@ describe.skip('client.close() Integration', () => {
     describe('when client is being instantiated and reads a long docker file', () => {
         // our docker env detection uses fs.access which will not be aborted until after it runs
         // fs.access does not support abort signals
-        it('the file read is not interrupted by client.close', () => {
+        it.only('the file read is not interrupted by client.close()', async () => {
+          await runScriptAndGetProcessInfo(
+            'docker-read',
+            config,
+            async function run({ MongoClient, uri }) {
+              const dockerPath = '.dockerenv';
+              sinon.stub(fs, 'access').callsFake(async () => await sleep(5000));
+              await fs.writeFile('.dockerenv', '', { encoding: 'utf8' });
+              const client = new MongoClient(uri);;
+              await client.close();
+              unlink(dockerPath);
+            });
         });
     });
     describe('when client is connecting and reads a TLS long file', () => {
-        it('the file read is interrupted by client.close', () => {
+        it('the file read is interrupted by client.close()', async () => {
+
         });
     });
   });
 
   describe('MongoClientAuthProviders', () => {
     describe('when MongoClientAuthProviders is instantiated and token file read hangs', () => {
-        it('the file read is interrupted by client.close', () => {
+        it('the file read is interrupted by client.close()', async () => {
         });
     });
   });
 
-  describe('Topology', () => {
+  describe.only('Topology', () => {
     describe('after a Topology is created through client.connect()', () => {
         it('server selection timers are cleaned up by client.close()', async () => {
-            await runScriptAndReturnResourceInfo(
-                'topology-clean-up', 
+            await runScriptAndGetProcessInfo(
+                'server-selection-timers',
                 config,
                 async function run({ MongoClient, uri }) {
                     const client = new MongoClient(uri);
@@ -45,64 +57,80 @@ describe.skip('client.close() Integration', () => {
   });
 
   describe('SRVPoller', () => {
-    // SRVPoller is implicitly created after an SRV string's topology transitions to sharded
+    // TODO: only non-LB mode
     describe('after SRVPoller is created', () => {
-        it('timers are cleaned up by client.close()', () => {
-
+        it('timers are cleaned up by client.close()', async () => {
+          await runScriptAndGetProcessInfo(
+                'srv-poller',
+                config,
+                async function run({ MongoClient, uri }) {
+                    const client = new MongoClient(uri);
+                    await client.connect();
+                    await client.close();
+                }
+            );
         });
     });
   });
 
   describe('ClientSession', () => {
     describe('after a clientSession is created and used', () => {
-        it('the server-side ServerSession and transaction are cleaned up by client.close()', () => {
-            // must send a command to the server
+        it('the server-side ServerSession and transaction are cleaned up by client.close()', async () => {
+          await runScriptAndGetProcessInfo(
+                'client-session',
+                config,
+                async function run({ MongoClient, uri }) {
+                    const client = new MongoClient(uri);
+                    await client.connect();
+                    const session = client.startSession();
+                    session.startTransaction();
+                    client.db('db').collection('coll').insertOne({ a: 1 });
+                    await session.endSession();
+                    await client.close();
+                }
+            );
         });
     });
   });
 
   describe('StateMachine', () => {
     describe('when FLE is enabled and the client has made a KMS request', () => {
-        it('no sockets remain after client.close', () => {
+        it('no sockets remain after client.close()', async () => {
 
         });
         describe('when the TLS file read hangs', () => {
-            it('the file read is interrupted by client.close', () => {
+            it('the file read is interrupted by client.close()', async () => {
 
             });
         });
     });
   });
 
-  describe('Server', () => {
-
-  });
-
   describe('ConnectionPool', () => {
     describe('after new connection pool is created', () => {
-        it('minPoolSize timer is cleaned up by client.close()', () => {
+        it('minPoolSize timer is cleaned up by client.close()', async () => {
 
         });
     });
   });
 
   describe('MonitorInterval', () => {
     describe('after a new monitor is made', () => {
-        it('monitor interval timer is cleaned up by client.close()', () => {
+        it('monitor interval timer is cleaned up by client.close()', async () => {
 
         });
     });
 
     describe('after a heartbeat fails', () => {
-        it('the new monitor interval timer is cleaned up by client.close()', () => {
+        it('the new monitor interval timer is cleaned up by client.close()', async () => {
 
         });
     });
   });
 
   describe('RTTPinger', () => {
     describe('after entering monitor streaming mode ', () => {
-        it('the rtt pinger timer is cleaned up by client.close()', () => {
+        it('the rtt pinger timer is cleaned up by client.close()', async () => {
             // helloReply has a topologyVersion defined
         });
     });
@@ -111,45 +139,54 @@ describe.skip('client.close() Integration', () => {
   describe('Connection', () => {
     describe('when connection monitoring is turned on', () => {
         // connection monitoring is by default turned on - with the exception of load-balanced mode
-        it('no sockets remain after client.close', () => {
-
-        });
-        it('no server-side connection threads remain after client.close', () => {
+        it('no sockets remain after client.close()', async () => {
+          // TODO: skip for LB mode
+          await runScriptAndGetProcessInfo(
+                'connection-monitoring',
+                config,
+                async function run({ MongoClient, uri }) {
+                    const client = new MongoClient(uri);
+                    await client.connect();
+                    await client.close();
+                }
+            );
+          });
+        it('no server-side connection threads remain after client.close()', async () => {
 
         });
     });
 
     describe('when rtt monitoring is turned on', () => {
-        it('no sockets remain after client.close', () => {
+        it('no sockets remain after client.close()', async () => {
 
         });
-        it('no server-side connection threads remain after client.close', () => {
+        it('no server-side connection threads remain after client.close()', async () => {
 
         });
     });
 
     describe('after a connection is checked out', () => {
-        it('no sockets remain after client.close', () => {
+        it('no sockets remain after client.close()', async () => {
 
         });
-        it('no server-side connection threads remain after client.close', () => {
+        it('no server-side connection threads remain after client.close()', async () => {
 
         });
     });
 
     describe('after a minPoolSize has been set on the ConnectionPool', () => {
-        it('no sockets remain after client.close', () => {
+        it('no sockets remain after client.close()', async () => {
 
         });
-        it('no server-side connection threads remain after client.close', () => {
+        it('no server-side connection threads remain after client.close()', async () => {
 
         });
     });
   });
 
   describe('Cursor', () => {
     describe('after cursors are created', () => {
-        it('all active server-side cursors are closed by client.close()', () => {
+        it('all active server-side cursors are closed by client.close()', async () => {
 
         });
     });

test/integration/node-specific/resource_tracking_script_builder.ts

@@ -8,13 +8,21 @@ import { parseSnapshot } from 'v8-heapsnapshot';
 
 import { type MongoClient } from '../../mongodb';
 import { type TestConfiguration } from '../../tools/runner/config';
+import { sleep } from '../../tools/utils';
 
-export type ResourceTestFunction = (options: {
+export type ResourceTestFunction = HeapResourceTestFunction | ProcessResourceTestFunction;
+
+export type HeapResourceTestFunction = (options: {
   MongoClient: typeof MongoClient;
   uri: string;
   iteration: number;
 }) => Promise<void>;
 
+export type ProcessResourceTestFunction = (options: {
+  MongoClient: typeof MongoClient;
+  uri: string;
+}) => Promise<void>;
+
 const HEAP_RESOURCE_SCRIPT_PATH = path.resolve(__dirname, '../../tools/fixtures/resource_script.in.js');
 const REPORT_RESOURCE_SCRIPT_PATH = path.resolve(__dirname, '../../tools/fixtures/close_resource_script.in.js');
 const DRIVER_SRC_PATH = JSON.stringify(path.resolve(__dirname, '../../../lib'));
@@ -40,7 +48,8 @@ export async function testScriptFactory(
 }
 
 /**
- * A helper for running arbitrary MongoDB Driver scripting code in a resource information collecting script
+ * A helper for running arbitrary MongoDB Driver scripting code in a resource information collecting script.
+ * This script uses heap data to collect resource information.
  *
  * **The provided function is run in an isolated Node.js process**
  *
@@ -64,7 +73,7 @@ export async function testScriptFactory(
 export async function runScriptAndReturnHeapInfo(
   name: string,
   config: TestConfiguration,
-  func: ResourceTestFunction,
+  func: HeapResourceTestFunction,
   { iterations = 100 } = {}
 ) {
   const scriptName = `${name}.cjs`;
@@ -111,10 +120,31 @@ export async function runScriptAndReturnHeapInfo(
   };
 }
 
-export async function runScriptAndReturnResourceInfo(
+
+/**
+ * A helper for running arbitrary MongoDB Driver scripting code in a resource information collecting script.
+ * This script uses info from node:process to collect resource information.
+ *
+ * **The provided function is run in an isolated Node.js process**
+ *
+ * A user of this function will likely need to familiarize themselves with the surrounding scripting, but briefly:
+ * - Every MongoClient you construct should have an asyncResource attached to it like so:
+ * ```js
+ * mongoClient.asyncResource = new this.async_hooks.AsyncResource('MongoClient');
+ * ```
+ * - You can perform any number of operations and connects/closes of MongoClients
+ * - This function performs assertions that at the end of the provided function, the js event loop has been exhausted
+ *
+ * @param name - the name of the script, this defines the name of the file, it will be cleaned up if the function returns successfully
+ * @param config - `this.configuration` from your mocha config
+ * @param func - your javascript function, you can write it inline! this will stringify the function, use the references on the `this` context to get typechecking
+ * @param options - settings for the script
+ * @throws Error - if the process exits with failure or if the process' resources are not cleaned up by the provided function.
+ */
+export async function runScriptAndGetProcessInfo(
   name: string,
   config: TestConfiguration,
-  func: ResourceTestFunction
+  func: ProcessResourceTestFunction
 ) {
 
   const scriptName = `${name}.cjs`;
@@ -137,15 +167,23 @@ export async function runScriptAndReturnResourceInfo(
   const report = await messages.next();
   let { finalReport, originalReport } = report.value[0];
 
- // const beforeExit = await messages.next();
+  const nullishSleepFn = async function () {
+    await sleep(5000);
+    return null;
+  }
+
+  // in the event the beforeExit event doesn't fire, set the event value to null after waiting 5 seconds
+  const beforeExitEvent = await Promise.race([messages.next(), nullishSleepFn()]);
 
   // make sure the process ended
   const [exitCode] = await willClose;
 
+  await unlink(scriptName);
+
   // assertions about exit status
   expect(exitCode, 'process should have exited with zero').to.equal(0);
 
   // assertions about clean-up
   expect(originalReport.length).to.equal(finalReport.length);
-  // expect(beforeExitEventHappened).to.be.true; 
+  expect(beforeExitEvent).to.not.be.null;
 }

test/tools/fixtures/resource_script.in.js renamed to test/tools/fixtures/heap_resource_script.in.js

@@ -12,15 +12,17 @@ const process = require('node:process');
 const v8 = require('node:v8');
 const util = require('node:util');
 const timers = require('node:timers');
+const fs = require('node:fs');
+const sinon = require('sinon');
 
 const run = func;
 
 async function main() {
   process.on('beforeExit', (code) => {
-    console.log('Process beforeExit event with code: ', code);
+    process.send({ beforeExitCode: code });
   });
   const originalReport = process.report.getReport().libuv;
-  await run({ MongoClient, uri });
+  await run({ MongoClient, uri, fs, sinon });
   const finalReport = process.report.getReport().libuv;
   process.send({originalReport, finalReport});
 }