feat(NODE-5190)!: remove deprecated keep alive options (#3771)

mongodb · Jul 13, 2023 · 7ade907 · 7ade907
1 parent c407454
commit 7ade907
Show file tree

Hide file tree

Showing 6 changed files with 1 addition and 67 deletions.
diff --git a/src/cmap/connect.ts b/src/cmap/connect.ts
@@ -331,15 +331,9 @@ const SOCKET_ERROR_EVENTS = new Set(SOCKET_ERROR_EVENT_LIST);
 
 function makeConnection(options: MakeConnectionOptions, _callback: Callback<Stream>) {
   const useTLS = options.tls ?? false;
-  const keepAlive = options.keepAlive ?? true;
-  const socketTimeoutMS = options.socketTimeoutMS ?? Reflect.get(options, 'socketTimeout') ?? 0;
   const noDelay = options.noDelay ?? true;
   const connectTimeoutMS = options.connectTimeoutMS ?? 30000;
   const rejectUnauthorized = options.rejectUnauthorized ?? true;
-  const keepAliveInitialDelay =
-    ((options.keepAliveInitialDelay ?? 120000) > socketTimeoutMS
-      ? Math.round(socketTimeoutMS / 2)
-      : options.keepAliveInitialDelay) ?? 120000;
   const existingSocket = options.existingSocket;
 
   let socket: Stream;
@@ -377,7 +371,7 @@ function makeConnection(options: MakeConnectionOptions, _callback: Callback<Stre
     socket = net.createConnection(parseConnectOptions(options));
   }
 
-  socket.setKeepAlive(keepAlive, keepAliveInitialDelay);
+  socket.setKeepAlive(true, 300000);
   socket.setTimeout(connectTimeoutMS);
   socket.setNoDelay(noDelay);
 

diff --git a/src/cmap/connection.ts b/src/cmap/connection.ts
@@ -122,10 +122,6 @@ export interface ConnectionOptions
   credentials?: MongoCredentials;
   connectTimeoutMS?: number;
   tls: boolean;
-  /** @deprecated - Will not be able to turn off in the future. */
-  keepAlive?: boolean;
-  /** @deprecated - Will not be configurable in the future. */
-  keepAliveInitialDelay?: number;
   noDelay?: boolean;
   socketTimeoutMS?: number;
   cancellationToken?: CancellationToken;

diff --git a/src/connection_string.ts b/src/connection_string.ts
@@ -858,16 +858,6 @@ export const OPTIONS = {
       return wc;
     }
   },
-  keepAlive: {
-    default: true,
-    type: 'boolean',
-    deprecated: 'Will not be able to turn off in the future.'
-  },
-  keepAliveInitialDelay: {
-    default: 120000,
-    type: 'uint',
-    deprecated: 'Will not be configurable in the future.'
-  },
   loadBalanced: {
     default: false,
     type: 'boolean'

diff --git a/src/mongo_client.ts b/src/mongo_client.ts
@@ -208,13 +208,6 @@ export interface MongoClientOptions extends BSONSerializeOptions, SupportedNodeC
   writeConcern?: WriteConcern | WriteConcernSettings;
   /** TCP Connection no delay */
   noDelay?: boolean;
-  /** @deprecated TCP Connection keep alive enabled. Will not be able to turn off in the future. */
-  keepAlive?: boolean;
-  /**
-   * @deprecated The number of milliseconds to wait before initiating keepAlive on the TCP socket.
-   *             Will not be configurable in the future.
-   */
-  keepAliveInitialDelay?: number;
   /** Force server to assign `_id` values instead of driver */
   forceServerObjectId?: boolean;
   /** A primary key factory function for generation of custom `_id` keys */
@@ -707,8 +700,6 @@ export interface MongoOptions
         | 'forceServerObjectId'
         | 'minHeartbeatFrequencyMS'
         | 'heartbeatFrequencyMS'
-        | 'keepAlive'
-        | 'keepAliveInitialDelay'
         | 'localThresholdMS'
         | 'maxConnecting'
         | 'maxIdleTimeMS'

diff --git a/test/unit/connection_string.test.ts b/test/unit/connection_string.test.ts
@@ -15,7 +15,6 @@ import {
   type MongoOptions,
   MongoParseError,
   MongoRuntimeError,
-  OPTIONS,
   parseOptions,
   resolveSRVRecord
 } from '../mongodb';
@@ -726,36 +725,4 @@ describe('Connection String', function () {
       ]);
     });
   });
-
-  context('default deprecated values', () => {
-    afterEach(() => sinon.restore());
-    before('ensure that `keepAlive` is deprecated', () => {
-      const { deprecated } = OPTIONS.keepAlive;
-      expect(deprecated).to.exist;
-    });
-    context('when no value is provided', () => {
-      it('uses the default value', () => {
-        const options = parseOptions('mongodb://localhost:27017');
-        expect(options).to.have.property('keepAlive', true);
-      });
-      it('does not emit a deprecation warning', async () => {
-        const spy = sinon.spy(process, 'emitWarning');
-        parseOptions('mongodb://localhost:27017');
-        expect(spy.called).to.be.false;
-      });
-    });
-
-    context('when a value is provided', () => {
-      it('uses the provided value', () => {
-        const options = parseOptions('mongodb://localhost:27017?keepAlive=false');
-        expect(options).to.have.property('keepAlive', false);
-      });
-      it('emits a deprecation warning', async () => {
-        const spy = sinon.spy(process, 'emitWarning');
-        parseOptions('mongodb://localhost:27017?keepAlive=false');
-        expect(spy.called, 'expected a warning to be emitted, but none was').to.be.true;
-        expect(spy.getCalls()[0].args[0]).to.match(/keepAlive is a deprecated option/);
-      });
-    });
-  });
 });
diff --git a/test/unit/mongo_client.test.js b/test/unit/mongo_client.test.js
@@ -87,8 +87,6 @@ describe('MongoOptions', function () {
     ignoreUndefined: false,
     j: true,
     journal: false,
-    keepAlive: true,
-    keepAliveInitialDelay: 3,
     localThresholdMS: 3,
     maxConnecting: 5,
     maxIdleTimeMS: 3,
@@ -578,8 +576,6 @@ describe('MongoOptions', function () {
       ['directconnection', false],
       ['forceserverobjectid', false],
       ['heartbeatfrequencyms', 10000],
-      ['keepalive', true],
-      ['keepaliveinitialdelay', 120000],
       ['localthresholdms', 15],
       ['maxidletimems', 0],
       ['maxpoolsize', 100],