skeleton updates

Author: aditi-khare-mongoDB

test/integration/client-close/client_close.test.ts

@@ -1,136 +1,196 @@
+import { fork } from 'child_process';
 import {
   MongoClient,
 } from '../../mongodb';
+import { on, once } from 'node:events';
+import { readFile, unlink, writeFile } from 'node:fs/promises';
+import { TestConfiguration } from '../../tools/runner/config';
+import { expect } from 'chai';
+import { StringOrPlaceholder } from '../../tools/unified-spec-runner/schema';
 
 /*
-async function runWithProcessAndCheck(_fn) {
-  start process
-  Run fn in process
-  Assert no resources
-  Close process
-} 
+export async function testScriptFactory(
+  name: string,
+  uri: string,
+  iterations: number,
+  func: Function
+) {
+  let resourceScript = await readFile(RESOURCE_SCRIPT_PATH, { encoding: 'utf8' });
+
+  resourceScript = resourceScript.replace('DRIVER_SOURCE_PATH', DRIVER_SRC_PATH);
+  resourceScript = resourceScript.replace('FUNCTION_STRING', `(${func.toString()})`);
+  resourceScript = resourceScript.replace('NAME_STRING', JSON.stringify(name));
+  resourceScript = resourceScript.replace('URI_STRING', JSON.stringify(uri));
+  resourceScript = resourceScript.replace('ITERATIONS_STRING', `${iterations}`);
+
+  return resourceScript;
+}
+
+export async function runScriptAndReturnResourceInfo(
+  name: string,
+  config: TestConfiguration,
+  func: Function
+) {
+
+  const pathName = `scripts/${name}.cjs`;
+  const scriptContent = await testScriptFactory(name, config.url(), func);
+  await writeFile(name, func.toString(), { encoding: 'utf8' });
+
+  const processDiedController = new AbortController();
+  const script = fork(name, { execArgv: ['--expose-gc'] });
+
+  // Interrupt our awaiting of messages if the process crashed
+  script.once('close', exitCode => {
+    if (exitCode !== 0) {
+      processDiedController.abort(new Error(`process exited with: ${exitCode}`));
+    }
+  });
+
+  const willClose = once(script, 'close');
+
+  // make sure the process ended
+  const [exitCode] = await willClose;
+  expect(exitCode, 'process should have exited with zero').to.equal(0);
+
+  return process.report.getReport().libuv;
+}
 */
 
-describe.only('client.close() Resource Management Integration tests', () => {
+describe.only('client.close() Integration', () => {
   let client: MongoClient;
+  let config: TestConfiguration;
   beforeEach(function () {
+    config = this.configuration;
     client = this.configuration.newClient();
   });
 
   describe('File System', () => {
-    context('when client is closed', () => {
-        context('after client is connected', () => {
-            it('the TLS file access is cleaned up', () => {
+    describe('when client is connected and reading a TLS long file', () => {
+        it('the file read is interrupted by client.close', () => {
 
-            });
         });
-        context('after client is created ', () => {
-            // 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 .docker file access is cleaned up', () => {
-
-            });
+    });
+    describe('when client is created and reading 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', () => {
         });
+    });
 
-        context('when FLE is enabled', () => {
-            context('after client has made a KMS request', () => {
-                it('the TLS file access is cleaned up', () => {
+    describe('when FLE is enabled and the client has made a KMS request that is reading a long TLS file', () => {
+        it('the file read is interrupted by client.close', () => {
 
-                });
-            });
         });
     });
   });
 
   describe('Connection Creation and Socket Lifetime', () => {
-    context('when client is closed', () => {
-        context('after client is connected', () => {
-            it('the socket is cleaned up', () => {
+    describe('after client is connected', () => {
+        it('no sockets remain after client.close', () => {
 
-            });
         });
+        it('no server-side connection threads remain after client.close', () => {
 
-        context('after a connection is checked out', () => {
-            it('the socket is cleaned up', () => {
+        });
+    });
+
+    describe('after a connection is checked out', () => {
+        it('no sockets remain after client.close', () => {
+
+        });
+        it('no server-side connection threads remain after client.close', () => {
 
-            });
         });
+    });
 
-        context('after a minPoolSize has been set on the ConnectionPool', () => {
-            it('the socket is cleaned up', () => {
+    describe('after a minPoolSize has been set on the ConnectionPool', () => {
+        it('no sockets remain after client.close', () => {
 
-            });
         });
+        it('no server-side connection threads remain after client.close', () => {
+
+        });
+    });
+
+    describe('when connection monitoring is turned on', () => {
+        it('no sockets remain after client.close', () => {
 
-        context('when connection monitoring is turned on', () => {
-            it('the socket is cleaned up', () => {
+        });
+        it('no server-side connection threads remain after client.close', () => {
 
-            });
         });
+    });
 
-        context('when rtt monitoring is turned on', () => {
-            it('the socket is cleaned up', () => {
+    describe('when rtt monitoring is turned on', () => {
+        it('no sockets remain after client.close', () => {
 
-            });
         });
+        it('no server-side connection threads remain after client.close', () => {
+
+        });
+    });
 
-        context('when FLE is enabled', () => {
-            context('after client has made a KMS request', () => {
-                it('the socket is cleaned up', () => {
+    describe('when FLE is enabled and the client has made a KMS request', () => {
+        it('no sockets remain after client.close', () => {
+
+        });
+        it('no server-side connection threads remain after client.close', () => {
 
-                });
-            });
         });
     });
   });
 
   describe('Timers', () => {
-    context('when client is closed', () => {
-        context('after SRVPoller is explicitly created', () => {
-            it('timers are cleaned up', () => {
+    describe('after SRVPoller is explicitly created', () => {
+        it('timers are cleaned up by client.close()', () => {
 
-            });
         });
+    });
 
-        // SRVPoller is implicitly created after an SRV string's topology transitions to sharded
-        context('after SRVPoller is implicitly created', () => {
-            it('timers are cleaned up', () => {
+    // SRVPoller is implicitly created after an SRV string's topology transitions to sharded
+    describe('after SRVPoller is implicitly created', () => {
+        it('timers are cleaned up by client.close()', () => {
 
-            });
         });
+    });
 
-        context('after new connection pool is created', () => {
-            it('minPoolSize timer is cleaned up', () => {
+    describe('after new connection pool is created', () => {
+        it('minPoolSize timer is cleaned up by client.close()', () => {
 
-            });
         });
+    });
 
-        context('after a new monitor is made', () => {
-            it('monitor interval timer is cleaned up', () => {
+    describe('after a new monitor is made', () => {
+        it('monitor interval timer is cleaned up by client.close()', () => {
 
-            });
         });
+    });
 
-        context('after a heartbeat fails', () => {
-            it('monitor interval timer is cleaned up', () => {
+    describe('after a heartbeat fails', () => {
+        it('monitor interval timer is cleaned up by client.close()', () => {
 
-            });
         });
+    });
 
-        context('after helloReply has a topologyVersion defined fails', () => {
-            it('rtt pinger timer is cleaned up', () => {
+    describe('after helloReply has a topologyVersion defined fails', () => {
+        it('rtt pinger timer is cleaned up by client.close()', () => {
 
-            });
         });
     });
   });
 
   describe('Cursor Clean-up', () => {
-    context('when client is closed', () => {
-        context('after cursors are created', () => {
-            it('closes all active cursors', () => {
+    describe('after cursors are created', () => {
+        it('all active server-side cursors are closed by client.close()', () => {
+
+        });
+    });
+  });
+
+  describe('Sessions', () => {
+    describe('after a clientSession is created', () => {
+        it('the server-side ServerSession is cleaned up by client.close()', () => {
 
-            });
         });
     });
   });

test/tools/fixtures/close_resource_script.in.js

@@ -0,0 +1,43 @@
+'use strict';
+
+/* eslint-disable no-undef */
+
+const driverPath = DRIVER_SOURCE_PATH;
+const func = FUNCTION_STRING;
+const name = NAME_STRING;
+const uri = URI_STRING;
+const iterations = ITERATIONS_STRING;
+
+const { MongoClient } = require(driverPath);
+const process = require('node:process');
+const v8 = require('node:v8');
+const util = require('node:util');
+const timers = require('node:timers');
+
+const sleep = util.promisify(timers.setTimeout);
+
+const run = func;
+
+const MB = (2 ** 10) ** 2;
+
+async function main() {
+  for (let iteration = 0; iteration < iterations; iteration++) {
+    await run({ MongoClient, uri, iteration });
+    global.gc();
+  }
+
+  global.gc();
+  // Sleep b/c maybe gc will run
+  await sleep(100);
+  global.gc();
+
+  process.send({ process.report.getReport()});
+}
+
+main()
+  .then(() => {
+    process.exit(0);
+  })
+  .catch(() => {
+    process.exit(1);
+  });