test(NODE-6631): Implement integration tests for improved client.close() - sockets + timers

heartbeat-failed-monitor-timer.cjs

@@ -0,0 +1,141 @@
+'use strict';
+
+/* eslint-disable no-undef */
+/* eslint-disable no-unused-vars */
+const driverPath = "/Users/aditi.khare/Desktop/node-mongodb-native/lib";
+const func = (async function ({ MongoClient, uri, expect, sleep, getTimerCount }) {
+                                    const heartbeatFrequencyMS = 2000;
+                                    const client = new MongoClient('mongodb://fakeUri', { heartbeatFrequencyMS });
+                                    let heartbeatHappened = false;
+                                    client.on('serverHeartbeatFailed', () => heartbeatHappened = true);
+                                    client.connect();
+                                    await sleep(heartbeatFrequencyMS * 2.5);
+                                    expect(heartbeatHappened).to.be.true;
+                                    function getMonitorTimer(servers) {
+                                        for (const server of servers) {
+                                            return server[1]?.monitor.monitorId.timerId;
+                                        }
+                                    }
+                                    ;
+                                    const servers = client.topology.s.servers;
+                                    expect(getMonitorTimer(servers)).to.exist;
+                                    await client.close();
+                                    expect(getMonitorTimer(servers)).to.not.exist;
+                                    expect(getTimerCount()).to.equal(0);
+                                });
+const scriptName = "heartbeat-failed-monitor-timer";
+const uri = "mongodb://localhost:27017/integration_tests?authSource=admin";
+
+const mongodb = require(driverPath);
+const { MongoClient } = mongodb;
+const process = require('node:process');
+const util = require('node:util');
+const timers = require('node:timers');
+const fs = require('node:fs');
+const sinon = require('sinon');
+const { expect } = require('chai');
+const { setTimeout } = require('timers');
+
+let originalReport;
+const logFile = scriptName + '.logs.txt';
+const sleep = util.promisify(setTimeout);
+
+const run = func;
+
+/**
+ *
+ * Returns an array containing the new libuv resources created after script started.
+ * A new resource is something that will keep the event loop running.
+ *
+ * In order to be counted as a new resource, a resource MUST:
+ * - Must NOT share an address with a libuv resource that existed at the start of script
+ * - Must be referenced. See [here](https://nodejs.org/api/timers.html#timeoutref) for more context.
+ *
+ * We're using the following tool to track resources: `process.report.getReport().libuv`
+ * For more context, see documentation for [process.report.getReport()](https://nodejs.org/api/report.html), and [libuv](https://docs.libuv.org/en/v1.x/handle.html).
+ *
+ */
+function getNewLibuvResourceArray() {
+  let currReport = process.report.getReport().libuv;
+  const originalReportAddresses = originalReport.map(resource => resource.address);
+
+  /**
+   * @typedef {Object} LibuvResource
+   * @property {string} type What is the resource type? For example, 'tcp' | 'timer' | 'udp' | 'tty'... (See more in [docs](https://docs.libuv.org/en/v1.x/handle.html)).
+   * @property {boolean} is_referenced Is the resource keeping the JS event loop active?
+   *
+   * @param {LibuvResource} resource
+   */
+  function isNewLibuvResource(resource) {
+    const serverType = ['tcp', 'udp'];
+    return (
+      !originalReportAddresses.includes(resource.address) && resource.is_referenced // if a resource is unreferenced, it's not keeping the event loop open
+    );
+  }
+
+  currReport = currReport.filter(resource => isNewLibuvResource(resource));
+  return currReport;
+}
+
+/**
+ * Returns an object of the new resources created after script started.
+ *
+ *
+ * In order to be counted as a new resource, a resource MUST either:
+ * - Meet the criteria to be returned by our helper utility `getNewLibuvResourceArray()`
+ * OR
+ * - Be returned by `process.getActiveResourcesInfo() and is not 'TTYWrap'
+ *
+ * The reason we are using both methods to detect active resources is:
+ * - `process.report.getReport().libuv` does not detect active requests (such as timers or file reads) accurately
+ * - `process.getActiveResourcesInfo()` does not contain enough server information we need for our assertions
+ *
+ */
+function getNewResources() {
+
+  return {
+    libuvResources: getNewLibuvResourceArray(),
+    activeResources: process.getActiveResourcesInfo()
+  };
+}
+
+/**
+ * @returns Number of active timers in event loop
+ */
+const getTimerCount = () => process.getActiveResourcesInfo().filter(r => r === 'Timeout').length;
+
+// A log function for debugging
+function log(message) {
+  // remove outer parentheses for easier parsing
+  const messageToLog = JSON.stringify(message) + ' \n';
+  fs.writeFileSync(logFile, messageToLog, { flag: 'a' });
+}
+
+async function main() {
+  originalReport = process.report.getReport().libuv;
+  process.on('beforeExit', () => {
+    log({ beforeExitHappened: true });
+  });
+  await run({ MongoClient, uri, log, expect, mongodb, sleep, sinon, getTimerCount });
+  log({ newResources: getNewResources() });
+}
+
+main()
+  .then(() => {})
+  .catch(e => {
+    log({ error: { message: e.message, stack: e.stack, resources: getNewResources() } });
+    process.exit(1);
+  });
+
+setTimeout(() => {
+  // this means something was in the event loop such that it hung for more than 10 seconds
+  // so we kill the process
+  log({
+    error: {
+      message: 'Process timed out: resources remain in the event loop',
+      resources: getNewResources()
+    }
+  });
+  process.exit(99);
+  // using `unref` will ensure this setTimeout call is not a resource / does not keep the event loop running
+}, 10000).unref();

heartbeat-failed-monitor-timer.logs.txt

@@ -0,0 +1,2 @@
+{"error":{"message":"expected 1 to equal +0","stack":"AssertionError: expected 1 to equal +0\n    at func (/Users/aditi.khare/Desktop/node-mongodb-native/heartbeat-failed-monitor-timer.cjs:24:64)\n    at async main (/Users/aditi.khare/Desktop/node-mongodb-native/heartbeat-failed-monitor-timer.cjs:119:3)","resources":{"libuvResources":[],"activeResources":[]}}} 
+{"error":{"message":"expected 1 to equal +0","stack":"AssertionError: expected 1 to equal +0\n    at func (/Users/aditi.khare/Desktop/node-mongodb-native/heartbeat-failed-monitor-timer.cjs:24:64)\n    at async main (/Users/aditi.khare/Desktop/node-mongodb-native/heartbeat-failed-monitor-timer.cjs:119:3)","resources":{"libuvResources":[],"activeResources":["TTYWrap"]}}}