feat(NODE-6245): add keepAliveInitialDelay config

src/cmap/connect.ts

@@ -307,6 +307,10 @@ function parseConnectOptions(options: ConnectionOptions): SocketConnectOpts {
       (result as Document)[name] = options[name];
     }
   }
+  if (result.keepAliveInitialDelay == null) {
+    result.keepAliveInitialDelay = 120000;
+  }
+  result.keepAlive = true;
 
   if (typeof hostAddress.socketPath === 'string') {
     result.path = hostAddress.socketPath;
@@ -377,7 +381,6 @@ export async function makeSocket(options: MakeConnectionOptions): Promise<Stream
     socket = net.createConnection(parseConnectOptions(options));
   }
 
-  socket.setKeepAlive(true, options.keepAliveInitialDelay ?? 120000);
   socket.setTimeout(connectTimeoutMS);
   socket.setNoDelay(noDelay);
 

src/connection_string.ts

@@ -872,9 +872,6 @@ export const OPTIONS = {
       return wc;
     }
   },
-  keepAliveInitialDelay: {
-    type: 'uint'
-  },
   loadBalanced: {
     default: false,
     type: 'boolean'
@@ -1276,6 +1273,7 @@ export const OPTIONS = {
   requestCert: { type: 'any' },
   rejectUnauthorized: { type: 'any' },
   checkServerIdentity: { type: 'any' },
+  keepAliveInitialDelay: { type: 'any' },
   ALPNProtocols: { type: 'any' },
   SNICallback: { type: 'any' },
   session: { type: 'any' },

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

@@ -1,7 +1,6 @@
 import { expect } from 'chai';
 import { once } from 'events';
 import * as net from 'net';
-import { Socket } from 'net';
 import * as sinon from 'sinon';
 
 import {
@@ -144,8 +143,9 @@ describe('class MongoClient', function () {
         let spy;
 
         beforeEach(async function () {
-          spy = sinon.spy(Socket.prototype, 'setKeepAlive');
-          client = this.configuration.newClient(options);
+          spy = sinon.spy(net, 'createConnection');
+          const uri = this.configuration.url();
+          client = new MongoClient(uri, options);
           await client.connect();
         });
 
@@ -155,7 +155,12 @@ describe('class MongoClient', function () {
         });
 
         it('passes through the option', function () {
-          expect(spy).to.have.been.calledWith(true, 0);
+          expect(spy).to.have.been.calledWith(
+            sinon.match({
+              keepAlive: true,
+              keepAliveInitialDelay: 0
+            })
+          );
         });
       });
 
@@ -165,8 +170,9 @@ describe('class MongoClient', function () {
         let spy;
 
         beforeEach(async function () {
-          spy = sinon.spy(Socket.prototype, 'setKeepAlive');
-          client = this.configuration.newClient(options);
+          spy = sinon.spy(net, 'createConnection');
+          const uri = this.configuration.url();
+          client = new MongoClient(uri, options);
           await client.connect();
         });
 
@@ -176,17 +182,39 @@ describe('class MongoClient', function () {
         });
 
         it('passes through the option', function () {
-          expect(spy).to.have.been.calledWith(true, 100);
+          expect(spy).to.have.been.calledWith(
+            sinon.match({
+              keepAlive: true,
+              keepAliveInitialDelay: 100
+            })
+          );
         });
       });
 
       context('when the value is negative', function () {
         const options = { keepAliveInitialDelay: -100 };
+        let client;
+        let spy;
+
+        beforeEach(async function () {
+          spy = sinon.spy(net, 'createConnection');
+          const uri = this.configuration.url();
+          client = new MongoClient(uri, options);
+          await client.connect();
+        });
 
-        it('raises an error', function () {
-          expect(() => {
-            this.configuration.newClient(options);
-          }).to.throw(/keepAliveInitialDelay can only be a positive int value/);
+        afterEach(async function () {
+          await client?.close();
+          spy.restore();
+        });
+
+        it('sets the option to 0', function () {
+          expect(spy).to.have.been.calledWith(
+            sinon.match({
+              keepAlive: true,
+              keepAliveInitialDelay: 0
+            })
+          );
         });
       });
     });
@@ -196,7 +224,7 @@ describe('class MongoClient', function () {
       let spy;
 
       beforeEach(async function () {
-        spy = sinon.spy(Socket.prototype, 'setKeepAlive');
+        spy = sinon.spy(net, 'createConnection');
         client = this.configuration.newClient();
         await client.connect();
       });
@@ -207,7 +235,12 @@ describe('class MongoClient', function () {
       });
 
       it('sets keepalive to 120000', function () {
-        expect(spy).to.have.been.calledWith(true, 120000);
+        expect(spy).to.have.been.calledWith(
+          sinon.match({
+            keepAlive: true,
+            keepAliveInitialDelay: 120000
+          })
+        );
       });
     });
   });