JAVA-2383: Allow elapsed time of zero nanoseconds for VMs that have imprecise nanosecond clocks

Author: jyemin

driver-core/src/main/com/mongodb/event/CommandFailedEvent.java

@@ -18,6 +18,8 @@
 
 import java.util.concurrent.TimeUnit;
 
+import static com.mongodb.assertions.Assertions.isTrueArgument;
+
 /**
  * An event representing the failure of a MongoDB database command.
  *
@@ -33,12 +35,13 @@ public final class CommandFailedEvent extends CommandEvent {
      * @param requestId the requestId
      * @param connectionDescription the connection description
      * @param commandName the command name
-     * @param elapsedTimeNanos the elapsed time in nanoseconds for the operation to complete
+     * @param elapsedTimeNanos the non-negative elapsed time in nanoseconds for the operation to complete
      * @param throwable the throwable cause of the failure
      */
     public CommandFailedEvent(final int requestId, final ConnectionDescription connectionDescription, final String commandName,
                               final long elapsedTimeNanos, final Throwable throwable) {
         super(requestId, connectionDescription, commandName);
+        isTrueArgument("elapsed time is not negative", elapsedTimeNanos >= 0);
         this.elapsedTimeNanos = elapsedTimeNanos;
         this.throwable = throwable;
     }

driver-core/src/main/com/mongodb/event/CommandSucceededEvent.java

@@ -19,6 +19,8 @@
 
 import java.util.concurrent.TimeUnit;
 
+import static com.mongodb.assertions.Assertions.isTrueArgument;
+
 /**
  * An event representing the completion of a MongoDB database command.
  *
@@ -34,12 +36,13 @@ public final class CommandSucceededEvent extends CommandEvent {
      * @param connectionDescription the connection description
      * @param commandName the command name
      * @param response the command response
-     * @param elapsedTimeNanos the elapsed time in nanoseconds for the operation to complete
+     * @param elapsedTimeNanos the non-negative elapsed time in nanoseconds for the operation to complete
      */
     public CommandSucceededEvent(final int requestId, final ConnectionDescription connectionDescription,
                                  final String commandName, final BsonDocument response, final long elapsedTimeNanos) {
         super(requestId, connectionDescription, commandName);
         this.response = response;
+        isTrueArgument("elapsed time is not negative", elapsedTimeNanos >= 0);
         this.elapsedTimeNanos = elapsedTimeNanos;
     }
 

driver-core/src/main/com/mongodb/event/ServerHeartbeatFailedEvent.java

@@ -21,7 +21,7 @@
 
 import java.util.concurrent.TimeUnit;
 
-import static com.mongodb.assertions.Assertions.isTrue;
+import static com.mongodb.assertions.Assertions.isTrueArgument;
 import static com.mongodb.assertions.Assertions.notNull;
 
 /**
@@ -38,12 +38,12 @@ public final class ServerHeartbeatFailedEvent {
      * Construct an instance.
      *
      * @param connectionId the non-null connectionId
-     * @param elapsedTimeNanos the positive elapsed time in nanoseconds
+     * @param elapsedTimeNanos the non-negative elapsed time in nanoseconds
      * @param throwable the non-null exception that caused the failure
      */
     public ServerHeartbeatFailedEvent(final ConnectionId connectionId, final long elapsedTimeNanos, final Throwable throwable) {
         this.connectionId = notNull("connectionId", connectionId);
-        isTrue("elapsed time is positive", elapsedTimeNanos > 0);
+        isTrueArgument("elapsed time is not negative", elapsedTimeNanos >= 0);
         this.elapsedTimeNanos = elapsedTimeNanos;
         this.throwable = notNull("throwable", throwable);
     }

driver-core/src/main/com/mongodb/event/ServerHeartbeatSucceededEvent.java

@@ -21,7 +21,7 @@
 
 import java.util.concurrent.TimeUnit;
 
-import static com.mongodb.assertions.Assertions.isTrue;
+import static com.mongodb.assertions.Assertions.isTrueArgument;
 import static com.mongodb.assertions.Assertions.notNull;
 
 /**
@@ -39,12 +39,12 @@ public final class ServerHeartbeatSucceededEvent {
      *
      * @param connectionId the non-null connectionId
      * @param reply the non-null reply to an isMaster command
-     * @param elapsedTimeNanos the positive elapsted time in nanoseconds
+     * @param elapsedTimeNanos the non-negative elapsed time in nanoseconds
      */
     public ServerHeartbeatSucceededEvent(final ConnectionId connectionId, final BsonDocument reply, final long elapsedTimeNanos) {
         this.connectionId = notNull("connectionId", connectionId);
         this.reply = notNull("reply", reply);
-        isTrue("elapsed time is positive", elapsedTimeNanos > 0);
+        isTrueArgument("elapsed time is not negative", elapsedTimeNanos >= 0);
         this.elapsedTimeNanos = elapsedTimeNanos;
     }
 

driver-core/src/test/unit/com/mongodb/event/CommandEventSpecification.groovy

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2016 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.event
+
+import com.mongodb.ServerAddress
+import com.mongodb.connection.ClusterId
+import com.mongodb.connection.ConnectionDescription
+import com.mongodb.connection.ServerId
+import org.bson.BsonDocument
+import org.bson.BsonInt32
+import spock.lang.Specification
+
+class CommandEventSpecification extends Specification {
+    def 'should fail if elapsed time is negative'() {
+        when:
+        new CommandSucceededEvent(1, new ConnectionDescription(new ServerId(new ClusterId(), new ServerAddress())), 'ping',
+                new BsonDocument('ok', new BsonInt32(1)), -1)
+
+        then:
+        def e = thrown(IllegalArgumentException)
+        e.getMessage() == 'state should be: elapsed time is not negative'
+
+        when:
+        new CommandFailedEvent(1, new ConnectionDescription(new ServerId(new ClusterId(), new ServerAddress())), 'ping', -1,
+                new Throwable())
+
+        then:
+        e = thrown(IllegalArgumentException)
+        e.getMessage() == 'state should be: elapsed time is not negative'
+    }
+}

driver-core/src/test/unit/com/mongodb/event/ServerHeartbeatEventSpecification.groovy

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2016 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.event
+
+import com.mongodb.ServerAddress
+import com.mongodb.connection.ClusterId
+import com.mongodb.connection.ConnectionId
+import com.mongodb.connection.ServerId
+import org.bson.BsonDocument
+import org.bson.BsonInt32
+import spock.lang.Specification
+
+class ServerHeartbeatEventSpecification extends Specification {
+    def 'should fail if elapsed time is negative'() {
+        when:
+        new ServerHeartbeatSucceededEvent(new ConnectionId(new ServerId(new ClusterId(), new ServerAddress())),
+                new BsonDocument('ok', new BsonInt32(1)), -1)
+
+        then:
+        def e = thrown(IllegalArgumentException)
+        e.getMessage() == 'state should be: elapsed time is not negative'
+
+        when:
+        new ServerHeartbeatFailedEvent(new ConnectionId(new ServerId(new ClusterId(), new ServerAddress())), -1, new Throwable())
+
+        then:
+        e = thrown(IllegalArgumentException)
+        e.getMessage() == 'state should be: elapsed time is not negative'
+    }
+}