Make socket keepAlive default to true

rozza · rozza · commit 238d4a1f2291 · 2017-06-15T13:53:20.000+01:00
JAVA-2531
diff --git a/docs/reference/content/driver-async/index.md b/docs/reference/content/driver-async/index.md
@@ -18,7 +18,7 @@ There are two higher level MongoDB Asynchronous Java Drivers available, that use
 * [MongoDB Reactive Streams Java Driver](http://mongodb.github.io/mongo-java-driver-reactivestreams/) A Reactive Streams implementation for the JVM.
 {{% /note %}}
 
-### What's New in 3.4
+### What's New in 3.5
 
 The [What's New]({{< relref "whats-new.md" >}}) guide explains the major new features of the driver.
 
diff --git a/docs/reference/content/driver-async/tutorials/connect-to-mongodb.md b/docs/reference/content/driver-async/tutorials/connect-to-mongodb.md
@@ -24,6 +24,15 @@ deployment (e.g. standalone, replica set, or a sharded cluster) and use it acros
 -  To dispose of an instance, call `MongoClient.close()` to clean up resources.
 {{% /note %}}
 
+{{% note %}}
+The 3.5 release deprecated socket keep-alive settings, also socket keep-alive checks are now on by default.
+It is *strongly recommended* that system keep-alive settings should be configured with shorter timeouts. 
+
+See the 
+['does TCP keep-alive time affect MongoDB deployments?']({{<docsref "/faq/diagnostics/#does-tcp-keepalive-time-affect-mongodb-deployments">}}) 
+documentation for more information.
+{{% /note %}}
+
 
 ## Prerequisites
 
diff --git a/docs/reference/content/driver/index.md b/docs/reference/content/driver/index.md
@@ -7,12 +7,12 @@ title = "MongoDB Driver"
   pre = "<i class='fa fa-arrows-h'></i>"
 +++
 
-## MongoDB Driver 3.4 Documentation
+## MongoDB Driver 3.5 Documentation
 
 The following guide provides information on using the synchronous
-MongoDB Java Driver 3.4.
+MongoDB Java Driver 3.5.
 
-### What's New in 3.4
+### What's New in 3.5
 
 The [What's New]({{< relref "whats-new.md" >}}) guide explains
 the major new features of the driver.
diff --git a/docs/reference/content/driver/tutorials/connect-to-mongodb.md b/docs/reference/content/driver/tutorials/connect-to-mongodb.md
@@ -19,6 +19,15 @@ MongoClient constructors, see
 [`MongoClient() API documentation`]({{< apiref "com/mongodb/MongoClient.html">}}).
 {{% /note %}}
 
+{{% note %}}
+The 3.5 release deprecated socket keep-alive settings, also socket keep-alive checks are now on by default.
+It is *strongly recommended* that system keep-alive settings should be configured with shorter timeouts. 
+
+See the 
+['does TCP keep-alive time affect MongoDB deployments?']({{<docsref "/faq/diagnostics/#does-tcp-keepalive-time-affect-mongodb-deployments">}}) 
+documentation for more information.
+{{% /note %}}
+
 ## Prerequisites
 
 - Running MongoDB deployments to which to connect. For example, to connect to a standalone, you must have a running standalone.
diff --git a/docs/reference/content/whats-new.md b/docs/reference/content/whats-new.md
@@ -7,9 +7,22 @@ title = "What's New"
   pre = "<i class='fa fa-level-up'></i>"
 +++
 
-# What's New
+# What's New 3.5
 
-This release includes full support for the upcoming MongoDB 3.4 server release.  Key new features include:
+
+### KeepAlive configuration deprecated
+
+The 3.5 release deprecated socket keep-alive settings, also socket keep-alive checks are now on by default.
+It is *strongly recommended* that system keep-alive settings should be configured with shorter timeouts. 
+
+See the 
+['does TCP keep-alive time affect MongoDB deployments?']({{<docsref "/faq/diagnostics/#does-tcp-keepalive-time-affect-mongodb-deployments">}}) 
+documentation for more information.
+
+
+## What's New in 3.4
+
+The 3.4 release included full support for the upcoming MongoDB 3.4 server release.  Key new features include:
 
 ### Support for Decimal128 Format
 
diff --git a/driver-core/src/main/com/mongodb/connection/AsynchronousSocketChannelStream.java b/driver-core/src/main/com/mongodb/connection/AsynchronousSocketChannelStream.java
@@ -62,6 +62,7 @@ public void open() throws IOException {
         handler.getOpen();
     }
 
+    @SuppressWarnings("deprecation")
     @Override
     public void openAsync(final AsyncCompletionHandler<Void> handler) {
         isTrue("unopened", channel == null);
diff --git a/driver-core/src/main/com/mongodb/connection/SocketSettings.java b/driver-core/src/main/com/mongodb/connection/SocketSettings.java
@@ -50,7 +50,7 @@ public static Builder builder() {
     public static class Builder {
         private long connectTimeoutMS = 10000;
         private long readTimeoutMS;
-        private boolean keepAlive;
+        private boolean keepAlive = true;
         private int receiveBufferSize;
         private int sendBufferSize;
 
@@ -81,9 +81,13 @@ public Builder readTimeout(final int readTimeout, final TimeUnit timeUnit) {
         /**
          * Sets keep-alive.
          *
-         * @param keepAlive true if keep-alive should be enabled
+         * @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;
@@ -159,10 +163,14 @@ public int getReadTimeout(final TimeUnit timeUnit) {
     }
 
     /**
-     * Gets whether keep-alive is enabled. Defaults to false.
+     * 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;
     }
diff --git a/driver-core/src/main/com/mongodb/connection/SocketStreamHelper.java b/driver-core/src/main/com/mongodb/connection/SocketStreamHelper.java
@@ -29,6 +29,8 @@
 import static java.util.concurrent.TimeUnit.MILLISECONDS;
 
 final class SocketStreamHelper {
+
+    @SuppressWarnings("deprecation")
     static void initialize(final Socket socket, final ServerAddress address, final SocketSettings settings, final SslSettings sslSettings)
     throws IOException {
         socket.setTcpNoDelay(true);
diff --git a/driver-core/src/main/com/mongodb/connection/netty/NettyStream.java b/driver-core/src/main/com/mongodb/connection/netty/NettyStream.java
@@ -101,6 +101,7 @@ public void open() throws IOException {
         handler.get();
     }
 
+    @SuppressWarnings("deprecation")
     @Override
     public void openAsync(final AsyncCompletionHandler<Void> handler) {
         Bootstrap bootstrap = new Bootstrap();
diff --git a/driver-core/src/test/unit/com/mongodb/connection/SocketSettingsSpecification.groovy b/driver-core/src/test/unit/com/mongodb/connection/SocketSettingsSpecification.groovy
@@ -21,15 +21,17 @@ import spock.lang.Specification
 
 import static java.util.concurrent.TimeUnit.MILLISECONDS
 
+@SuppressWarnings('deprecation')
 class SocketSettingsSpecification extends Specification {
+
     def 'should have correct defaults'() {
         when:
         def settings = SocketSettings.builder().build()
 
         then:
         settings.getConnectTimeout(MILLISECONDS) == 10000
         settings.getReadTimeout(MILLISECONDS) == 0
-        !settings.keepAlive
+        settings.keepAlive
         settings.receiveBufferSize == 0
         settings.sendBufferSize == 0
     }
@@ -39,17 +41,16 @@ class SocketSettingsSpecification extends Specification {
         def settings = SocketSettings.builder()
                                      .connectTimeout(5000, MILLISECONDS)
                                      .readTimeout(2000, MILLISECONDS)
-                                     .keepAlive(true)
+                                     .keepAlive(false)
                                      .sendBufferSize(1000)
                                      .receiveBufferSize(1500)
-                                     .keepAlive(true)
                                      .build()
 
 
         then:
         settings.getConnectTimeout(MILLISECONDS) == 5000
         settings.getReadTimeout(MILLISECONDS) == 2000
-        settings.keepAlive
+        !settings.keepAlive
         settings.sendBufferSize == 1000
         settings.receiveBufferSize == 1500
     }
@@ -65,7 +66,7 @@ class SocketSettingsSpecification extends Specification {
         then:
         settings.getConnectTimeout(MILLISECONDS) == 5000
         settings.getReadTimeout(MILLISECONDS) == 2000
-        !settings.keepAlive
+        settings.keepAlive
         settings.sendBufferSize == 0
         settings.receiveBufferSize == 0
     }
@@ -79,15 +80,13 @@ class SocketSettingsSpecification extends Specification {
                       .keepAlive(true)
                       .sendBufferSize(1000)
                       .receiveBufferSize(1500)
-                      .keepAlive(true)
                       .build() ==
         SocketSettings.builder()
                       .connectTimeout(5000, MILLISECONDS)
                       .readTimeout(2000, MILLISECONDS)
                       .keepAlive(true)
                       .sendBufferSize(1000)
                       .receiveBufferSize(1500)
-                      .keepAlive(true)
                       .build()
     }
 
@@ -105,20 +104,18 @@ class SocketSettingsSpecification extends Specification {
                       .keepAlive(true)
                       .sendBufferSize(1000)
                       .receiveBufferSize(1500)
-                      .keepAlive(true)
                       .build().hashCode() ==
         SocketSettings.builder()
                       .connectTimeout(5000, MILLISECONDS)
                       .readTimeout(2000, MILLISECONDS)
                       .keepAlive(true)
                       .sendBufferSize(1000)
                       .receiveBufferSize(1500)
-                      .keepAlive(true)
                       .build().hashCode()
     }
 
     def 'different settings should have different hash codes'() {
         expect:
         SocketSettings.builder().keepAlive(true).build().hashCode() != SocketSettings.builder().keepAlive(false).build().hashCode()
     }
-}
+}
diff --git a/driver/src/main/com/mongodb/MongoClientOptions.java b/driver/src/main/com/mongodb/MongoClientOptions.java
@@ -98,6 +98,7 @@ public class MongoClientOptions {
     private final List<ServerListener> serverListeners;
     private final List<ServerMonitorListener> serverMonitorListeners;
 
+    @SuppressWarnings("deprecation")
     private MongoClientOptions(final Builder builder) {
         description = builder.description;
         applicationName = builder.applicationName;
@@ -341,13 +342,17 @@ public int getSocketTimeout() {
     }
 
     /**
-     * <p>This flag controls the socket keep alive feature that keeps a connection alive through firewalls {@link
+     * <p>This flag controls the socket keep-alive feature that keeps a connection alive through firewalls {@link
      * java.net.Socket#setKeepAlive(boolean)}</p>
      *
-     * <p>Default is {@code false}.</p>
+     * <p>Default is {@code true}.</p>
      *
      * @return whether keep-alive is enabled on each socket
+     * @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 isSocketKeepAlive() {
         return socketKeepAlive;
     }
@@ -880,7 +885,7 @@ public static class Builder {
         private int maxConnectionLifeTime;
         private int connectTimeout = 1000 * 10;
         private int socketTimeout = 0;
-        private boolean socketKeepAlive = false;
+        private boolean socketKeepAlive = true;
         private boolean sslEnabled = false;
         private boolean sslInvalidHostNameAllowed = false;
         private SSLContext sslContext;
@@ -914,6 +919,7 @@ public Builder() {
          *
          * @param options create a builder from existing options
          */
+        @SuppressWarnings("deprecation")
         public Builder(final MongoClientOptions options) {
             description = options.getDescription();
             applicationName = options.getApplicationName();
@@ -1112,12 +1118,15 @@ public Builder socketTimeout(final int socketTimeout) {
         }
 
         /**
-         * Sets whether socket keep alive is enabled.
+         * Sets whether socket keep-alive is enabled.
          *
-         * @param socketKeepAlive keep alive
+         * @param socketKeepAlive keep-alive
          * @return {@code this}
-         * @see com.mongodb.MongoClientOptions#isSocketKeepAlive()
+         * @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 socketKeepAlive(final boolean socketKeepAlive) {
             this.socketKeepAlive = socketKeepAlive;
             return this;
diff --git a/driver/src/test/unit/com/mongodb/MongoClientOptionsSpecification.groovy b/driver/src/test/unit/com/mongodb/MongoClientOptionsSpecification.groovy
@@ -39,6 +39,7 @@ import static java.util.concurrent.TimeUnit.MILLISECONDS
 import static java.util.concurrent.TimeUnit.SECONDS
 import static spock.util.matcher.HamcrestSupport.expect
 
+@SuppressWarnings('deprecation')
 class MongoClientOptionsSpecification extends Specification {
 
     def 'should set the correct default values'() {
@@ -54,7 +55,7 @@ class MongoClientOptionsSpecification extends Specification {
         options.getConnectTimeout() == 10000
         options.getReadPreference() == ReadPreference.primary()
         options.getThreadsAllowedToBlockForConnectionMultiplier() == 5
-        !options.isSocketKeepAlive()
+        options.isSocketKeepAlive()
         !options.isSslEnabled()
         !options.isSslInvalidHostNameAllowed()
         options.getSslContext() == null
@@ -162,7 +163,7 @@ class MongoClientOptionsSpecification extends Specification {
                                         .maxConnectionIdleTime(300)
                                         .maxConnectionLifeTime(400)
                                         .threadsAllowedToBlockForConnectionMultiplier(2)
-                                        .socketKeepAlive(true)
+                                        .socketKeepAlive(false)
                                         .socketFactory(socketFactory)
                                         .sslEnabled(true)
                                         .sslInvalidHostNameAllowed(true)
@@ -192,7 +193,7 @@ class MongoClientOptionsSpecification extends Specification {
         options.getConnectTimeout() == 100
         options.getSocketTimeout() == 700
         options.getThreadsAllowedToBlockForConnectionMultiplier() == 2
-        options.isSocketKeepAlive()
+        !options.isSocketKeepAlive()
         options.socketFactory == socketFactory
         options.isSslEnabled()
         options.isSslInvalidHostNameAllowed()
@@ -213,9 +214,9 @@ class MongoClientOptionsSpecification extends Specification {
                                                                 .maxWaitTime(200, MILLISECONDS).maxConnectionLifeTime(400, MILLISECONDS)
                                                                 .maxConnectionIdleTime(300, MILLISECONDS).build()
         options.socketSettings == SocketSettings.builder().connectTimeout(100, MILLISECONDS).readTimeout(700, MILLISECONDS)
-                                                .keepAlive(true).build()
+                                                .keepAlive(false).build()
         options.heartbeatSocketSettings == SocketSettings.builder().connectTimeout(15, MILLISECONDS).readTimeout(20, MILLISECONDS)
-                                                         .keepAlive(true).build()
+                                                         .keepAlive(false).build()
         options.serverSettings == ServerSettings.builder().minHeartbeatFrequency(11, MILLISECONDS).heartbeatFrequency(5, MILLISECONDS)
                                                 .build()
         options.sslSettings == SslSettings.builder().enabled(true).invalidHostNameAllowed(true)
@@ -295,7 +296,7 @@ class MongoClientOptionsSpecification extends Specification {
                 .maxConnectionIdleTime(300)
                 .maxConnectionLifeTime(400)
                 .threadsAllowedToBlockForConnectionMultiplier(2)
-                .socketKeepAlive(true)
+                .socketKeepAlive(false)
                 .sslEnabled(true)
                 .sslInvalidHostNameAllowed(true)
                 .sslContext(SSLContext.getDefault())
@@ -556,7 +557,7 @@ class MongoClientOptionsSpecification extends Specification {
                 .maxConnectionIdleTime(300)
                 .maxConnectionLifeTime(400)
                 .threadsAllowedToBlockForConnectionMultiplier(2)
-                .socketKeepAlive(true)
+                .socketKeepAlive(false)
                 .sslEnabled(true)
                 .sslInvalidHostNameAllowed(true)
                 .sslContext(SSLContext.getDefault())
diff --git a/driver/src/test/unit/com/mongodb/MongoClientURISpecification.groovy b/driver/src/test/unit/com/mongodb/MongoClientURISpecification.groovy
@@ -165,14 +165,13 @@ class MongoClientURISpecification extends Specification {
         MongoClientOptions options = new MongoClientURI('mongodb://localhost').getOptions();
 
         then:
-        options.getConnectionsPerHost() == 100;
-        options.getThreadsAllowedToBlockForConnectionMultiplier() == 5;
-        options.getMaxWaitTime() == 120000;
-        options.getConnectTimeout() == 10000;
-        options.getSocketTimeout() == 0;
-        !options.isSocketKeepAlive();
-        options.getDescription() == null;
-        options.getReadPreference() == ReadPreference.primary();
+        options.getConnectionsPerHost() == 100
+        options.getThreadsAllowedToBlockForConnectionMultiplier() == 5
+        options.getMaxWaitTime() == 120000
+        options.getConnectTimeout() == 10000
+        options.getSocketTimeout() == 0
+        options.getDescription() == null
+        options.getReadPreference() == ReadPreference.primary()
         options.getRequiredReplicaSetName() == null
         !options.isSslEnabled()
     }

Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,7 @@ public void open() throws IOException {`
`62`	`62`	`handler.getOpen();`
`63`	`63`	`}`
`64`	`64`
	`65`	`+ @SuppressWarnings("deprecation")`
`65`	`66`	`@Override`
`66`	`67`	`public void openAsync(final AsyncCompletionHandler<Void> handler) {`
`67`	`68`	`isTrue("unopened", channel == null);`
Original file line number	Diff line number	Diff line change
`@@ -101,6 +101,7 @@ public void open() throws IOException {`
`101`	`101`	`handler.get();`
`102`	`102`	`}`
`103`	`103`
	`104`	`+ @SuppressWarnings("deprecation")`
`104`	`105`	`@Override`
`105`	`106`	`public void openAsync(final AsyncCompletionHandler<Void> handler) {`
`106`	`107`	`Bootstrap bootstrap = new Bootstrap();`