Accept long instead of int in SocketSettings.Builder.connectTimeout/readTimeout (#1279)

* Accept `long` instead of `int` in `SocketSettings.Builder.connectTimeout`/`readTimeout`

JAVA-3897

Author: stIncMale

driver-core/src/main/com/mongodb/connection/SocketSettings.java

@@ -20,9 +20,11 @@
 import com.mongodb.ConnectionString;
 import com.mongodb.annotations.Immutable;
 
+import java.util.Objects;
 import java.util.concurrent.TimeUnit;
 
 import static com.mongodb.assertions.Assertions.notNull;
+import static java.lang.Math.toIntExact;
 import static java.util.concurrent.TimeUnit.MILLISECONDS;
 
 /**
@@ -32,8 +34,8 @@
  */
 @Immutable
 public final class SocketSettings {
-    private final long connectTimeoutMS;
-    private final long readTimeoutMS;
+    private final int connectTimeoutMS;
+    private final int readTimeoutMS;
     private final int receiveBufferSize;
     private final int sendBufferSize;
     private final ProxySettings proxySettings;
@@ -62,8 +64,8 @@ public static Builder builder(final SocketSettings socketSettings) {
      * A builder for an instance of {@code SocketSettings}.
      */
     public static final class Builder {
-        private long connectTimeoutMS = 10000;
-        private long readTimeoutMS;
+        private int connectTimeoutMS = 10000;
+        private int readTimeoutMS;
         private int receiveBufferSize;
         private int sendBufferSize;
         private ProxySettings.Builder proxySettingsBuilder = ProxySettings.builder();
@@ -93,25 +95,27 @@ public Builder applySettings(final SocketSettings socketSettings) {
         /**
          * Sets the socket connect timeout.
          *
-         * @param connectTimeout the connect timeout
+         * @param connectTimeout the connect timeout.
+         * The timeout converted to milliseconds must not be greater than {@link Integer#MAX_VALUE}.
          * @param timeUnit the time unit
          * @return this
          */
-        public Builder connectTimeout(final int connectTimeout, final TimeUnit timeUnit) {
-            this.connectTimeoutMS = MILLISECONDS.convert(connectTimeout, timeUnit);
+        public Builder connectTimeout(final long connectTimeout, final TimeUnit timeUnit) {
+            this.connectTimeoutMS = timeoutArgumentToMillis(connectTimeout, timeUnit);
             return this;
         }
 
         /**
          * Sets the socket read timeout.
          *
-         * @param readTimeout the read timeout
+         * @param readTimeout the read timeout.
+         * The timeout converted to milliseconds must not be greater than {@link Integer#MAX_VALUE}.
          * @param timeUnit the time unit
          * @return this
          * @see #getReadTimeout(TimeUnit)
          */
-        public Builder readTimeout(final int readTimeout, final TimeUnit timeUnit) {
-            this.readTimeoutMS = MILLISECONDS.convert(readTimeout, timeUnit);
+        public Builder readTimeout(final long readTimeout, final TimeUnit timeUnit) {
+            this.readTimeoutMS = timeoutArgumentToMillis(readTimeout, timeUnit);
             return this;
         }
 
@@ -197,7 +201,7 @@ public int getConnectTimeout(final TimeUnit timeUnit) {
      *
      * @param timeUnit the time unit to get the timeout in
      * @return the read timeout in the requested time unit, or 0 if there is no timeout
-     * @see Builder#readTimeout(int, TimeUnit)
+     * @see Builder#readTimeout(long, TimeUnit)
      */
     public int getReadTimeout(final TimeUnit timeUnit) {
         return (int) timeUnit.convert(readTimeoutMS, MILLISECONDS);
@@ -260,12 +264,7 @@ public boolean equals(final Object o) {
 
     @Override
     public int hashCode() {
-        int result = (int) (connectTimeoutMS ^ (connectTimeoutMS >>> 32));
-        result = 31 * result + (int) (readTimeoutMS ^ (readTimeoutMS >>> 32));
-        result = 31 * result + receiveBufferSize;
-        result = 31 * result + sendBufferSize;
-        result = 31 * result + proxySettings.hashCode();
-        return result;
+        return Objects.hash(connectTimeoutMS, readTimeoutMS, receiveBufferSize, sendBufferSize, proxySettings);
     }
 
     @Override
@@ -285,4 +284,13 @@ private SocketSettings(final Builder builder) {
         sendBufferSize = builder.sendBufferSize;
         proxySettings = builder.proxySettingsBuilder.build();
     }
+
+    private static int timeoutArgumentToMillis(final long timeout, final TimeUnit timeUnit) throws IllegalArgumentException {
+        try {
+            return toIntExact(MILLISECONDS.convert(timeout, timeUnit));
+        } catch (ArithmeticException e) {
+            throw new IllegalArgumentException(
+                    "The timeout converted to milliseconds must not be greater than `Integer.MAX_VALUE`", e);
+        }
+    }
 }

driver-core/src/test/unit/com/mongodb/connection/SocketSettingsSpecification.groovy

@@ -21,7 +21,9 @@ import spock.lang.Specification
 
 import static java.util.concurrent.TimeUnit.MILLISECONDS
 
-
+/**
+ * New unit tests for {@link SocketSettings} are to be added to {@link SocketSettingsTest}.
+ */
 class SocketSettingsSpecification extends Specification {
 
     def 'should have correct defaults'() {

driver-core/src/test/unit/com/mongodb/connection/SocketSettingsTest.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2008-present MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.mongodb.connection;
+
+import org.junit.jupiter.api.Test;
+
+import java.util.concurrent.TimeUnit;
+
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+/**
+ * {@link SocketSettingsSpecification} contains older unit tests for {@link SocketSettings}.
+ */
+final class SocketSettingsTest {
+    @Test
+    void connectTimeoutThrowsIfArgumentIsTooLarge() {
+        assertThrows(IllegalArgumentException.class, () -> SocketSettings.builder().connectTimeout(Integer.MAX_VALUE / 2, TimeUnit.SECONDS));
+    }
+
+    @Test
+    void readTimeoutThrowsIfArgumentIsTooLarge() {
+        assertThrows(IllegalArgumentException.class, () -> SocketSettings.builder().readTimeout(Integer.MAX_VALUE / 2, TimeUnit.SECONDS));
+    }
+}