Skip to content

Commit

Permalink
Test that durations are included on relevant pool events (#1370)
Browse files Browse the repository at this point in the history 
JAVA-5426
  • Loading branch information
@stIncMale
stIncMale authored Apr 23, 2024
1 parent bec3def commit f9edd86
Show file tree
Hide file tree
Showing 9 changed files with 92 additions and 16 deletions.
6 changes: 4 additions & 2 deletions .../resources/connection-monitoring-and-pooling/cmap-format/pool-checkin-make-available.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
{
"type": "ConnectionCheckedOut",
"connectionId": 1,
"address": 42
"address": 42,
"duration": 42
},
{
"type": "ConnectionCheckedIn",
Expand All @@ -32,7 +33,8 @@
{
"type": "ConnectionCheckedOut",
"connectionId": 1,
"address": 42
"address": 42,
"duration": 42
}
],
"ignore": [
Expand Down
6 changes: 4 additions & 2 deletions ...est/resources/connection-monitoring-and-pooling/cmap-format/pool-checkout-connection.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,14 @@
{
"type": "ConnectionReady",
"connectionId": 1,
"address": 42
"address": 42,
"duration": 42
},
{
"type": "ConnectionCheckedOut",
"connectionId": 1,
"address": 42
"address": 42,
"duration": 42
}
],
"ignore": [
Expand Down
4 changes: 3 additions & 1 deletion ...t/resources/connection-monitoring-and-pooling/cmap-format/pool-checkout-error-closed.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@
{
"type": "ConnectionCheckedOut",
"address": 42,
"connectionId": 42
"connectionId": 42,
"duration": 42
},
{
"type": "ConnectionCheckedIn",
Expand All @@ -56,6 +57,7 @@
{
"type": "ConnectionCheckOutFailed",
"address": 42,
"duration": 42,
"reason": "poolClosed"
}
],
Expand Down
3 changes: 2 additions & 1 deletion ...es/connection-monitoring-and-pooling/cmap-format/pool-checkout-maxConnecting-timeout.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,8 @@
{
"type": "ConnectionCheckOutFailed",
"reason": "timeout",
"address": 42
"address": 42,
"duration": 42
}
],
"ignore": [
Expand Down
12 changes: 8 additions & 4 deletions .../resources/connection-monitoring-and-pooling/cmap-format/pool-clear-clears-waitqueue.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@
},
{
"type": "ConnectionCheckedOut",
"address": 42
"address": 42,
"duration": 42
},
{
"type": "ConnectionCheckOutStarted",
Expand All @@ -76,17 +77,20 @@
{
"type": "ConnectionCheckOutFailed",
"reason": "connectionError",
"address": 42
"address": 42,
"duration": 42
},
{
"type": "ConnectionCheckOutFailed",
"reason": "connectionError",
"address": 42
"address": 42,
"duration": 42
},
{
"type": "ConnectionCheckOutFailed",
"reason": "connectionError",
"address": 42
"address": 42,
"duration": 42
}
],
"ignore": [
Expand Down
7 changes: 5 additions & 2 deletions ...re/src/test/resources/connection-monitoring-and-pooling/cmap-format/pool-clear-ready.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@
{
"type": "ConnectionCheckedOut",
"address": 42,
"connectionId": 42
"connectionId": 42,
"duration": 42
},
{
"type": "ConnectionPoolCleared",
Expand All @@ -49,6 +50,7 @@
{
"type": "ConnectionCheckOutFailed",
"address": 42,
"duration": 42,
"reason": "connectionError"
},
{
Expand All @@ -57,7 +59,8 @@
},
{
"type": "ConnectionCheckedOut",
"address": 42
"address": 42,
"duration": 42
}
],
"ignore": [
Expand Down
6 changes: 4 additions & 2 deletions driver-core/src/test/resources/connection-monitoring-and-pooling/cmap-format/pool-ready.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@
{
"type": "ConnectionCheckOutFailed",
"reason": "connectionError",
"address": 42
"address": 42,
"duration": 42
},
{
"type": "ConnectionPoolReady",
Expand All @@ -47,7 +48,8 @@
},
{
"type": "ConnectionCheckedOut",
"address": 42
"address": 42,
"duration": 42
}
],
"ignore": [
Expand Down
6 changes: 4 additions & 2 deletions .../src/test/resources/connection-monitoring-and-pooling/cmap-format/wait-queue-timeout.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@
{
"type": "ConnectionCheckedOut",
"connectionId": 42,
"address": 42
"address": 42,
"duration": 42
},
{
"type": "ConnectionCheckOutStarted",
Expand All @@ -57,7 +58,8 @@
{
"type": "ConnectionCheckOutFailed",
"reason": "timeout",
"address": 42
"address": 42,
"duration": 42
},
{
"type": "ConnectionCheckedIn",
Expand Down
58 changes: 58 additions & 0 deletions driver-core/src/test/unit/com/mongodb/internal/connection/AbstractConnectionPoolTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 +78,14 @@
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicLong;
import java.util.stream.Collectors;

import static com.mongodb.assertions.Assertions.assertFalse;
import static com.mongodb.internal.thread.InterruptionUtil.interruptAndCreateMongoInterruptedException;
import static java.lang.String.format;
import static java.util.Arrays.asList;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.junit.Assume.assumeFalse;
import static org.junit.Assume.assumeNotNull;
Expand Down Expand Up @@ -285,40 +288,59 @@ public void shouldPassAllOutcomes() throws Exception {
BsonDocument expectedEvent = cur.asDocument();
String type = expectedEvent.getString("type").getValue();
if (type.equals("ConnectionPoolCreated")) {
assertHasOnlySupportedKeys(expectedEvent, "type", "address", "options");
ConnectionPoolCreatedEvent actualEvent = getNextEvent(actualEventsIterator, ConnectionPoolCreatedEvent.class);
assertAddressMatch(expectedEvent, actualEvent.getServerId().getAddress());
assertEquals(settings, actualEvent.getSettings());
} else if (type.equals("ConnectionPoolCleared")) {
assertHasOnlySupportedKeys(expectedEvent, "type", "address");
ConnectionPoolClearedEvent actualEvent = getNextEvent(actualEventsIterator, ConnectionPoolClearedEvent.class);
assertAddressMatch(expectedEvent, actualEvent.getServerId().getAddress());
} else if (type.equals("ConnectionPoolReady")) {
assertHasOnlySupportedKeys(expectedEvent, "type", "address");
ConnectionPoolReadyEvent actualEvent = getNextEvent(actualEventsIterator, ConnectionPoolReadyEvent.class);
assertAddressMatch(expectedEvent, actualEvent.getServerId().getAddress());
} else if (type.equals("ConnectionPoolClosed")) {
assertHasOnlySupportedKeys(expectedEvent, "type", "address");
ConnectionPoolClosedEvent actualEvent = getNextEvent(actualEventsIterator, ConnectionPoolClosedEvent.class);
assertAddressMatch(expectedEvent, actualEvent.getServerId().getAddress());
} else if (type.equals("ConnectionCreated")) {
assertHasOnlySupportedKeys(expectedEvent, "type", "address", "connectionId");
ConnectionCreatedEvent actualEvent = getNextEvent(actualEventsIterator, ConnectionCreatedEvent.class);
assertAddressMatch(expectedEvent, actualEvent.getConnectionId().getServerId().getAddress());
assertConnectionIdMatch(expectedEvent, actualEvent.getConnectionId());
} else if (type.equals("ConnectionReady")) {
assertHasOnlySupportedKeys(expectedEvent, "type", "address", "connectionId", "duration");
ConnectionReadyEvent actualEvent = getNextEvent(actualEventsIterator, ConnectionReadyEvent.class);
assertAddressMatch(expectedEvent, actualEvent.getConnectionId().getServerId().getAddress());
assertConnectionIdMatch(expectedEvent, actualEvent.getConnectionId());
assertDurationMatch(expectedEvent, actualEvent);
} else if (type.equals("ConnectionClosed")) {
assertHasOnlySupportedKeys(expectedEvent, "type", "address", "connectionId", "reason");
ConnectionClosedEvent actualEvent = getNextEvent(actualEventsIterator, ConnectionClosedEvent.class);
assertAddressMatch(expectedEvent, actualEvent.getConnectionId().getServerId().getAddress());
assertConnectionIdMatch(expectedEvent, actualEvent.getConnectionId());
assertReasonMatch(expectedEvent, actualEvent);
} else if (type.equals("ConnectionCheckOutStarted")) {
assertHasOnlySupportedKeys(expectedEvent, "type", "address");
ConnectionCheckOutStartedEvent actualEvent = getNextEvent(actualEventsIterator, ConnectionCheckOutStartedEvent.class);
assertAddressMatch(expectedEvent, actualEvent.getServerId().getAddress());
} else if (type.equals("ConnectionCheckOutFailed")) {
assertHasOnlySupportedKeys(expectedEvent, "type", "address", "reason", "duration");
ConnectionCheckOutFailedEvent actualEvent = getNextEvent(actualEventsIterator, ConnectionCheckOutFailedEvent.class);
assertAddressMatch(expectedEvent, actualEvent.getServerId().getAddress());
assertReasonMatch(expectedEvent, actualEvent);
assertDurationMatch(expectedEvent, actualEvent);
} else if (type.equals("ConnectionCheckedOut")) {
assertHasOnlySupportedKeys(expectedEvent, "type", "address", "connectionId", "duration");
ConnectionCheckedOutEvent actualEvent = getNextEvent(actualEventsIterator, ConnectionCheckedOutEvent.class);
assertAddressMatch(expectedEvent, actualEvent.getConnectionId().getServerId().getAddress());
assertConnectionIdMatch(expectedEvent, actualEvent.getConnectionId());
assertDurationMatch(expectedEvent, actualEvent);
} else if (type.equals("ConnectionCheckedIn")) {
assertHasOnlySupportedKeys(expectedEvent, "type", "address", "connectionId");
ConnectionCheckedInEvent actualEvent = getNextEvent(actualEventsIterator, ConnectionCheckedInEvent.class);
assertAddressMatch(expectedEvent, actualEvent.getConnectionId().getServerId().getAddress());
assertConnectionIdMatch(expectedEvent, actualEvent.getConnectionId());
} else {
throw new UnsupportedOperationException("Unsupported event type " + type);
Expand All @@ -327,6 +349,16 @@ public void shouldPassAllOutcomes() throws Exception {
}
}

private static void assertHasOnlySupportedKeys(final BsonDocument document, final String... supportedKeys) {
List<String> supportedKeysList = asList(supportedKeys);
List<String> unsupportedKeys = document.keySet().stream()
.filter(key -> !supportedKeysList.contains(key))
.collect(Collectors.toList());
if (!unsupportedKeys.isEmpty()) {
fail(format("The runner encountered not yet supported keys %s in %s", unsupportedKeys, document));
}
}

private void assertReasonMatch(final BsonDocument expectedEvent, final ConnectionClosedEvent connectionClosedEvent) {
if (!expectedEvent.containsKey("reason")) {
return;
Expand Down Expand Up @@ -400,6 +432,32 @@ private void assertConnectionIdMatch(final BsonDocument expectedEvent, final Con
}
}

private static void assertDurationMatch(final BsonDocument expectedEvent, final ConnectionReadyEvent actualEvent) {
assertDurationMatch(expectedEvent, actualEvent.getElapsedTime(TimeUnit.MILLISECONDS));
}

private static void assertDurationMatch(final BsonDocument expectedEvent, final ConnectionCheckOutFailedEvent actualEvent) {
assertDurationMatch(expectedEvent, actualEvent.getElapsedTime(TimeUnit.MILLISECONDS));
}

private static void assertDurationMatch(final BsonDocument expectedEvent, final ConnectionCheckedOutEvent actualEvent) {
assertDurationMatch(expectedEvent, actualEvent.getElapsedTime(TimeUnit.MILLISECONDS));
}

private static void assertDurationMatch(final BsonDocument expectedEvent, final long actualDurationMillis) {
String durationKey = "duration";
if (expectedEvent.isNumber(durationKey)) {
assertTrue("actualDurationMillis must not be negative", actualDurationMillis >= 0);
long expectedDurationMillis = expectedEvent.getNumber(durationKey).longValue();
if (expectedDurationMillis != ANY_INT) {
fail(format("Unsupported duration value %d. Pay attention to the expected value unit when supporting the value",
expectedDurationMillis));
}
} else if (expectedEvent.containsKey(durationKey)) {
fail(format("Unsupported value %s", expectedEvent.get(durationKey)));
}
}

private long adjustedConnectionIdLocalValue(final long connectionIdLocalValue) {
if (pool instanceof ConnectionIdAdjustingConnectionPool) {
return ((ConnectionIdAdjustingConnectionPool) pool).adjustedConnectionIdLocalValue(connectionIdLocalValue);
Expand Down

0 comments on commit f9edd86

Please sign in to comment.