Remove deprecated keepAlive support in SocketSettings

jyemin · jyemin · commit dfcf57f3dfea · 2019-12-10T15:56:20.000-05:00
JAVA-3184
diff --git a/driver-core/src/main/com/mongodb/connection/SocketSettings.java b/driver-core/src/main/com/mongodb/connection/SocketSettings.java
@@ -33,7 +33,6 @@
 public class SocketSettings {
     private final long connectTimeoutMS;
     private final long readTimeoutMS;
-    private final boolean keepAlive;
     private final int receiveBufferSize;
     private final int sendBufferSize;
 
@@ -62,7 +61,6 @@ public static Builder builder(final SocketSettings socketSettings) {
     public static final class Builder {
         private long connectTimeoutMS = 10000;
         private long readTimeoutMS;
-        private boolean keepAlive = true;
         private int receiveBufferSize;
         private int sendBufferSize;
 
@@ -82,7 +80,6 @@ public Builder applySettings(final SocketSettings socketSettings) {
             notNull("socketSettings", socketSettings);
             connectTimeoutMS = socketSettings.connectTimeoutMS;
             readTimeoutMS = socketSettings.readTimeoutMS;
-            keepAlive = socketSettings.keepAlive;
             receiveBufferSize = socketSettings.receiveBufferSize;
             sendBufferSize = socketSettings.sendBufferSize;
             return this;
@@ -112,21 +109,6 @@ public Builder readTimeout(final int readTimeout, final TimeUnit timeUnit) {
             return this;
         }
 
-        /**
-         * Sets keep-alive.
-         *
-         * @param keepAlive false if keep-alive should be disabled
-         * @return this
-         * @deprecated configuring keep-alive has been deprecated. It now defaults to true and disabling it is not recommended.
-         * @see <a href="https://docs.mongodb.com/manual/faq/diagnostics/#does-tcp-keepalive-time-affect-mongodb-deployments">
-         *     Does TCP keep-alive time affect MongoDB Deployments?</a>
-         */
-        @Deprecated
-        public Builder keepAlive(final boolean keepAlive) {
-            this.keepAlive = keepAlive;
-            return this;
-        }
-
         /**
          * Sets the receive buffer size.
          *
@@ -200,19 +182,6 @@ public int getReadTimeout(final TimeUnit timeUnit) {
         return (int) timeUnit.convert(readTimeoutMS, MILLISECONDS);
     }
 
-    /**
-     * Gets whether keep-alive is enabled. Defaults to true.
-     *
-     * @return true if keep-alive is enabled.
-     * @deprecated configuring keep-alive has been deprecated. It now defaults to true and disabling it is not recommended.
-     * @see <a href="https://docs.mongodb.com/manual/faq/diagnostics/#does-tcp-keepalive-time-affect-mongodb-deployments">
-     *     Does TCP keep-alive time affect MongoDB Deployments?</a>
-     */
-    @Deprecated
-    public boolean isKeepAlive() {
-        return keepAlive;
-    }
-
     /**
      * Gets the receive buffer size. Defaults to the operating system default.
      * @return the receive buffer size
@@ -244,9 +213,6 @@ public boolean equals(final Object o) {
         if (connectTimeoutMS != that.connectTimeoutMS) {
             return false;
         }
-        if (keepAlive != that.keepAlive) {
-            return false;
-        }
         if (readTimeoutMS != that.readTimeoutMS) {
             return false;
         }
@@ -264,7 +230,6 @@ public boolean equals(final Object o) {
     public int hashCode() {
         int result = (int) (connectTimeoutMS ^ (connectTimeoutMS >>> 32));
         result = 31 * result + (int) (readTimeoutMS ^ (readTimeoutMS >>> 32));
-        result = 31 * result + (keepAlive ? 1 : 0);
         result = 31 * result + receiveBufferSize;
         result = 31 * result + sendBufferSize;
         return result;
@@ -275,16 +240,14 @@ public String toString() {
         return "SocketSettings{"
                + "connectTimeoutMS=" + connectTimeoutMS
                + ", readTimeoutMS=" + readTimeoutMS
-               + ", keepAlive=" + keepAlive
                + ", receiveBufferSize=" + receiveBufferSize
                + ", sendBufferSize=" + sendBufferSize
                + '}';
     }
 
-    SocketSettings(final Builder builder) {
+    private SocketSettings(final Builder builder) {
         connectTimeoutMS = builder.connectTimeoutMS;
         readTimeoutMS = builder.readTimeoutMS;
-        keepAlive = builder.keepAlive;
         receiveBufferSize = builder.receiveBufferSize;
         sendBufferSize = builder.sendBufferSize;
     }
diff --git a/driver-core/src/main/com/mongodb/connection/netty/NettyStream.java b/driver-core/src/main/com/mongodb/connection/netty/NettyStream.java
@@ -122,7 +122,7 @@ private void initializeChannel(final AsyncCompletionHandler<Void> handler, final
 
             bootstrap.option(ChannelOption.CONNECT_TIMEOUT_MILLIS, settings.getConnectTimeout(MILLISECONDS));
             bootstrap.option(ChannelOption.TCP_NODELAY, true);
-            bootstrap.option(ChannelOption.SO_KEEPALIVE, settings.isKeepAlive());
+            bootstrap.option(ChannelOption.SO_KEEPALIVE, true);
 
             if (settings.getReceiveBufferSize() > 0) {
                 bootstrap.option(ChannelOption.SO_RCVBUF, settings.getReceiveBufferSize());
diff --git a/driver-core/src/main/com/mongodb/internal/connection/AsynchronousSocketChannelStream.java b/driver-core/src/main/com/mongodb/internal/connection/AsynchronousSocketChannelStream.java
@@ -68,7 +68,7 @@ private void initializeSocketChannel(final AsyncCompletionHandler<Void> handler,
             try {
                 AsynchronousSocketChannel attemptConnectionChannel = AsynchronousSocketChannel.open(group);
                 attemptConnectionChannel.setOption(StandardSocketOptions.TCP_NODELAY, true);
-                attemptConnectionChannel.setOption(StandardSocketOptions.SO_KEEPALIVE, settings.isKeepAlive());
+                attemptConnectionChannel.setOption(StandardSocketOptions.SO_KEEPALIVE, true);
                 if (settings.getReceiveBufferSize() > 0) {
                     attemptConnectionChannel.setOption(StandardSocketOptions.SO_RCVBUF, settings.getReceiveBufferSize());
                 }
diff --git a/driver-core/src/main/com/mongodb/internal/connection/SocketStreamHelper.java b/driver-core/src/main/com/mongodb/internal/connection/SocketStreamHelper.java
@@ -37,7 +37,7 @@ static void initialize(final Socket socket, final InetSocketAddress inetSocketAd
                            final SslSettings sslSettings) throws IOException {
         socket.setTcpNoDelay(true);
         socket.setSoTimeout(settings.getReadTimeout(MILLISECONDS));
-        socket.setKeepAlive(settings.isKeepAlive());
+        socket.setKeepAlive(true);
         if (settings.getReceiveBufferSize() > 0) {
             socket.setReceiveBufferSize(settings.getReceiveBufferSize());
         }
diff --git a/driver-core/src/test/functional/com/mongodb/internal/connection/SocketStreamHelperSpecification.groovy b/driver-core/src/test/functional/com/mongodb/internal/connection/SocketStreamHelperSpecification.groovy
@@ -39,7 +39,6 @@ class SocketStreamHelperSpecification extends Specification {
         Socket socket = SocketFactory.default.createSocket()
         def socketSettings = SocketSettings.builder()
                 .readTimeout(10, SECONDS)
-                .keepAlive(true)
                 .build()
 
         when:
diff --git a/driver-core/src/test/unit/com/mongodb/MongoClientSettingsSpecification.groovy b/driver-core/src/test/unit/com/mongodb/MongoClientSettingsSpecification.groovy
@@ -147,7 +147,7 @@ class MongoClientSettingsSpecification extends Specification {
         settings.getReadConcern() == ReadConcern.LOCAL
         settings.getApplicationName() == 'app1'
         settings.getSocketSettings() == SocketSettings.builder().build()
-        settings.getHeartbeatSocketSettings() == SocketSettings.builder().readTimeout(10000, TimeUnit.MILLISECONDS).keepAlive(true).build()
+        settings.getHeartbeatSocketSettings() == SocketSettings.builder().readTimeout(10000, TimeUnit.MILLISECONDS).build()
         settings.getCommandListeners().get(0) == commandListener
         settings.getCodecRegistry() == codecRegistry
         settings.getCredential() == credential
diff --git a/driver-core/src/test/unit/com/mongodb/connection/SocketSettingsSpecification.groovy b/driver-core/src/test/unit/com/mongodb/connection/SocketSettingsSpecification.groovy
@@ -31,7 +31,6 @@ class SocketSettingsSpecification extends Specification {
         then:
         settings.getConnectTimeout(MILLISECONDS) == 10000
         settings.getReadTimeout(MILLISECONDS) == 0
-        settings.keepAlive
         settings.receiveBufferSize == 0
         settings.sendBufferSize == 0
     }
@@ -41,7 +40,6 @@ class SocketSettingsSpecification extends Specification {
         def settings = SocketSettings.builder()
                                      .connectTimeout(5000, MILLISECONDS)
                                      .readTimeout(2000, MILLISECONDS)
-                                     .keepAlive(false)
                                      .sendBufferSize(1000)
                                      .receiveBufferSize(1500)
                                      .build()
@@ -50,7 +48,6 @@ class SocketSettingsSpecification extends Specification {
         then:
         settings.getConnectTimeout(MILLISECONDS) == 5000
         settings.getReadTimeout(MILLISECONDS) == 2000
-        !settings.keepAlive
         settings.sendBufferSize == 1000
         settings.receiveBufferSize == 1500
     }
@@ -60,7 +57,6 @@ class SocketSettingsSpecification extends Specification {
         def original = SocketSettings.builder()
                 .connectTimeout(5000, MILLISECONDS)
                 .readTimeout(2000, MILLISECONDS)
-                .keepAlive(false)
                 .sendBufferSize(1000)
                 .receiveBufferSize(1500)
                 .build()
@@ -70,7 +66,6 @@ class SocketSettingsSpecification extends Specification {
         then:
         settings.getConnectTimeout(MILLISECONDS) == 5000
         settings.getReadTimeout(MILLISECONDS) == 2000
-        !settings.keepAlive
         settings.sendBufferSize == 1000
         settings.receiveBufferSize == 1500
     }
@@ -86,7 +81,6 @@ class SocketSettingsSpecification extends Specification {
         then:
         settings.getConnectTimeout(MILLISECONDS) == 5000
         settings.getReadTimeout(MILLISECONDS) == 2000
-        settings.keepAlive
         settings.sendBufferSize == 0
         settings.receiveBufferSize == 0
     }
@@ -97,7 +91,6 @@ class SocketSettingsSpecification extends Specification {
         def customSettings = SocketSettings.builder()
                 .connectTimeout(5000, MILLISECONDS)
                 .readTimeout(2000, MILLISECONDS)
-                .keepAlive(false)
                 .sendBufferSize(1000)
                 .receiveBufferSize(1500)
                 .build()
@@ -113,22 +106,20 @@ class SocketSettingsSpecification extends Specification {
         SocketSettings.builder()
                       .connectTimeout(5000, MILLISECONDS)
                       .readTimeout(2000, MILLISECONDS)
-                      .keepAlive(true)
                       .sendBufferSize(1000)
                       .receiveBufferSize(1500)
                       .build() ==
         SocketSettings.builder()
                       .connectTimeout(5000, MILLISECONDS)
                       .readTimeout(2000, MILLISECONDS)
-                      .keepAlive(true)
                       .sendBufferSize(1000)
                       .receiveBufferSize(1500)
                       .build()
     }
 
     def 'different settings should not be equal'() {
         expect:
-        SocketSettings.builder().keepAlive(true).build() != SocketSettings.builder().keepAlive(false).build()
+        SocketSettings.builder().receiveBufferSize(4) != SocketSettings.builder().receiveBufferSize(3).build()
     }
 
     def 'identical settings should have same hash code'() {
@@ -137,21 +128,19 @@ class SocketSettingsSpecification extends Specification {
         SocketSettings.builder()
                       .connectTimeout(5000, MILLISECONDS)
                       .readTimeout(2000, MILLISECONDS)
-                      .keepAlive(true)
                       .sendBufferSize(1000)
                       .receiveBufferSize(1500)
                       .build().hashCode() ==
         SocketSettings.builder()
                       .connectTimeout(5000, MILLISECONDS)
                       .readTimeout(2000, MILLISECONDS)
-                      .keepAlive(true)
                       .sendBufferSize(1000)
                       .receiveBufferSize(1500)
                       .build().hashCode()
     }
 
     def 'different settings should have different hash codes'() {
         expect:
-        SocketSettings.builder().keepAlive(true).build().hashCode() != SocketSettings.builder().keepAlive(false).build().hashCode()
+        SocketSettings.builder().sendBufferSize(4).build().hashCode() != SocketSettings.builder().sendBufferSize(3).build().hashCode()
     }
 }
diff --git a/driver-core/src/test/unit/com/mongodb/connection/netty/NettyStreamFactorySpecification.groovy b/driver-core/src/test/unit/com/mongodb/connection/netty/NettyStreamFactorySpecification.groovy
@@ -29,7 +29,7 @@ import spock.lang.Specification
 
 class NettyStreamFactorySpecification extends Specification {
 
-    private static final SOCKET_SETTINGS = SocketSettings.builder().keepAlive(true).build()
+    private static final SOCKET_SETTINGS = SocketSettings.builder().build()
     private static final SSL_SETTINGS = SslSettings.builder().enabled(true).invalidHostNameAllowed(true).build()
     private static final EVENT_LOOP_GROUP = new OioEventLoopGroup()
     private static final SOCKET_CHANNEL_CLASS = OioSocketChannel

Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ private void initializeSocketChannel(final AsyncCompletionHandler<Void> handler,`
`68`	`68`	`try {`
`69`	`69`	`AsynchronousSocketChannel attemptConnectionChannel = AsynchronousSocketChannel.open(group);`
`70`	`70`	`attemptConnectionChannel.setOption(StandardSocketOptions.TCP_NODELAY, true);`
`71`		`- attemptConnectionChannel.setOption(StandardSocketOptions.SO_KEEPALIVE, settings.isKeepAlive());`
	`71`	`+ attemptConnectionChannel.setOption(StandardSocketOptions.SO_KEEPALIVE, true);`
`72`	`72`	`if (settings.getReceiveBufferSize() > 0) {`
`73`	`73`	`attemptConnectionChannel.setOption(StandardSocketOptions.SO_RCVBUF, settings.getReceiveBufferSize());`
`74`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ static void initialize(final Socket socket, final InetSocketAddress inetSocketAd`
`37`	`37`	`final SslSettings sslSettings) throws IOException {`
`38`	`38`	`socket.setTcpNoDelay(true);`
`39`	`39`	`socket.setSoTimeout(settings.getReadTimeout(MILLISECONDS));`
`40`		`- socket.setKeepAlive(settings.isKeepAlive());`
	`40`	`+ socket.setKeepAlive(true);`
`41`	`41`	`if (settings.getReceiveBufferSize() > 0) {`
`42`	`42`	`socket.setReceiveBufferSize(settings.getReceiveBufferSize());`
`43`	`43`	`}`