JAVA-3142: Ability to optionally specify remote dcs for deterministic failovers when remote dcs are used in query plan #1896
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,184 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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.datastax.oss.driver.internal.core.loadbalancing; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.mockito.ArgumentMatchers.any; | ||
| import static org.mockito.ArgumentMatchers.eq; | ||
| import static org.mockito.Mockito.atLeast; | ||
| import static org.mockito.Mockito.never; | ||
| import static org.mockito.Mockito.spy; | ||
| import static org.mockito.Mockito.times; | ||
| import static org.mockito.Mockito.verify; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| import com.datastax.oss.driver.api.core.config.DefaultDriverOption; | ||
| import com.datastax.oss.driver.api.core.config.DriverExecutionProfile; | ||
| import com.datastax.oss.driver.api.core.metadata.Node; | ||
| import com.datastax.oss.driver.internal.core.metadata.DefaultNode; | ||
| import com.datastax.oss.driver.shaded.guava.common.collect.ImmutableList; | ||
| import com.datastax.oss.driver.shaded.guava.common.collect.ImmutableMap; | ||
| import com.datastax.oss.driver.shaded.guava.common.collect.ImmutableSet; | ||
| import java.util.Map; | ||
| import java.util.UUID; | ||
| import org.junit.Test; | ||
| import org.mockito.Mock; | ||
|
|
||
| public class BasicLoadBalancingPolicyPreferredRemoteDcsTest | ||
| extends BasicLoadBalancingPolicyDcFailoverTest { | ||
| @Mock protected DefaultNode node10; | ||
| @Mock protected DefaultNode node11; | ||
| @Mock protected DefaultNode node12; | ||
| @Mock protected DefaultNode node13; | ||
| @Mock protected DefaultNode node14; | ||
|
|
||
| @Override | ||
| @Test | ||
| public void should_prioritize_single_replica() { | ||
| when(request.getRoutingKeyspace()).thenReturn(KEYSPACE); | ||
| when(request.getRoutingKey()).thenReturn(ROUTING_KEY); | ||
| when(tokenMap.getReplicas(KEYSPACE, ROUTING_KEY)).thenReturn(ImmutableSet.of(node3)); | ||
|
|
||
| // node3 always first, round-robin on the rest | ||
| assertThat(policy.newQueryPlan(request, session)) | ||
| .containsExactly( | ||
| node3, node1, node2, node4, node5, node9, node10, node6, node7, node12, node13); | ||
| assertThat(policy.newQueryPlan(request, session)) | ||
| .containsExactly( | ||
| node3, node2, node4, node5, node1, node9, node10, node6, node7, node12, node13); | ||
| assertThat(policy.newQueryPlan(request, session)) | ||
| .containsExactly( | ||
| node3, node4, node5, node1, node2, node9, node10, node6, node7, node12, node13); | ||
| assertThat(policy.newQueryPlan(request, session)) | ||
| .containsExactly( | ||
| node3, node5, node1, node2, node4, node9, node10, node6, node7, node12, node13); | ||
|
|
||
| // Should not shuffle replicas since there is only one | ||
| verify(policy, never()).shuffleHead(any(), eq(1)); | ||
| // But should shuffle remote nodes | ||
| verify(policy, times(12)).shuffleHead(any(), eq(2)); | ||
| } | ||
|
|
||
| @Override | ||
| @Test | ||
| public void should_prioritize_and_shuffle_replicas() { | ||
| when(request.getRoutingKeyspace()).thenReturn(KEYSPACE); | ||
| when(request.getRoutingKey()).thenReturn(ROUTING_KEY); | ||
| when(tokenMap.getReplicas(KEYSPACE, ROUTING_KEY)) | ||
| .thenReturn(ImmutableSet.of(node1, node2, node3, node6, node9)); | ||
|
|
||
| // node 6 and 9 being in a remote DC, they don't get a boost for being a replica | ||
| assertThat(policy.newQueryPlan(request, session)) | ||
| .containsExactly( | ||
| node1, node2, node3, node4, node5, node9, node10, node6, node7, node12, node13); | ||
| assertThat(policy.newQueryPlan(request, session)) | ||
| .containsExactly( | ||
| node1, node2, node3, node5, node4, node9, node10, node6, node7, node12, node13); | ||
|
|
||
| // should shuffle replicas | ||
| verify(policy, times(2)).shuffleHead(any(), eq(3)); | ||
| // should shuffle remote nodes | ||
| verify(policy, times(6)).shuffleHead(any(), eq(2)); | ||
| // No power of two choices with only two replicas | ||
| verify(session, never()).getPools(); | ||
| } | ||
|
|
||
| @Override | ||
| protected void assertRoundRobinQueryPlans() { | ||
| for (int i = 0; i < 3; i++) { | ||
| assertThat(policy.newQueryPlan(request, session)) | ||
| .containsExactly( | ||
| node1, node2, node3, node4, node5, node9, node10, node6, node7, node12, node13); | ||
| assertThat(policy.newQueryPlan(request, session)) | ||
| .containsExactly( | ||
| node2, node3, node4, node5, node1, node9, node10, node6, node7, node12, node13); | ||
| assertThat(policy.newQueryPlan(request, session)) | ||
| .containsExactly( | ||
| node3, node4, node5, node1, node2, node9, node10, node6, node7, node12, node13); | ||
| assertThat(policy.newQueryPlan(request, session)) | ||
| .containsExactly( | ||
| node4, node5, node1, node2, node3, node9, node10, node6, node7, node12, node13); | ||
| assertThat(policy.newQueryPlan(request, session)) | ||
| .containsExactly( | ||
| node5, node1, node2, node3, node4, node9, node10, node6, node7, node12, node13); | ||
| } | ||
|
|
||
| verify(policy, atLeast(15)).shuffleHead(any(), eq(2)); | ||
| } | ||
|
|
||
| @Override | ||
| protected BasicLoadBalancingPolicy createAndInitPolicy() { | ||
| when(node4.getDatacenter()).thenReturn("dc1"); | ||
| when(node5.getDatacenter()).thenReturn("dc1"); | ||
| when(node6.getDatacenter()).thenReturn("dc2"); | ||
| when(node7.getDatacenter()).thenReturn("dc2"); | ||
| when(node8.getDatacenter()).thenReturn("dc2"); | ||
| when(node9.getDatacenter()).thenReturn("dc3"); | ||
| when(node10.getDatacenter()).thenReturn("dc3"); | ||
| when(node11.getDatacenter()).thenReturn("dc3"); | ||
| when(node12.getDatacenter()).thenReturn("dc4"); | ||
| when(node13.getDatacenter()).thenReturn("dc4"); | ||
| when(node14.getDatacenter()).thenReturn("dc4"); | ||
|
|
||
| // Accept 2 nodes per remote DC | ||
| when(defaultProfile.getInt( | ||
| DefaultDriverOption.LOAD_BALANCING_DC_FAILOVER_MAX_NODES_PER_REMOTE_DC)) | ||
| .thenReturn(2); | ||
| when(defaultProfile.getBoolean( | ||
| DefaultDriverOption.LOAD_BALANCING_DC_FAILOVER_ALLOW_FOR_LOCAL_CONSISTENCY_LEVELS)) | ||
| .thenReturn(false); | ||
|
|
||
| when(defaultProfile.getStringList( | ||
| DefaultDriverOption.LOAD_BALANCING_DC_FAILOVER_PREFERRED_REMOTE_DCS)) | ||
| .thenReturn(ImmutableList.of("dc3", "dc2")); | ||
|
|
||
| // Use a subclass to disable shuffling, we just spy to make sure that the shuffling method was | ||
| // called (makes tests easier) | ||
| BasicLoadBalancingPolicy policy = | ||
| spy( | ||
| new BasicLoadBalancingPolicy(context, DriverExecutionProfile.DEFAULT_NAME) { | ||
| @Override | ||
| protected void shuffleHead(Object[] currentNodes, int headLength) { | ||
| // nothing (keep in same order) | ||
| } | ||
| }); | ||
| Map<UUID, Node> nodes = | ||
| ImmutableMap.<UUID, Node>builder() | ||
| .put(UUID.randomUUID(), node1) | ||
| .put(UUID.randomUUID(), node2) | ||
| .put(UUID.randomUUID(), node3) | ||
| .put(UUID.randomUUID(), node4) | ||
| .put(UUID.randomUUID(), node5) | ||
| .put(UUID.randomUUID(), node6) | ||
| .put(UUID.randomUUID(), node7) | ||
| .put(UUID.randomUUID(), node8) | ||
| .put(UUID.randomUUID(), node9) | ||
| .put(UUID.randomUUID(), node10) | ||
| .put(UUID.randomUUID(), node11) | ||
| .put(UUID.randomUUID(), node12) | ||
| .put(UUID.randomUUID(), node13) | ||
| .put(UUID.randomUUID(), node14) | ||
| .build(); | ||
| policy.init(nodes, distanceReporter); | ||
| assertThat(policy.getLiveNodes().dc("dc1")).containsExactly(node1, node2, node3, node4, node5); | ||
| assertThat(policy.getLiveNodes().dc("dc2")).containsExactly(node6, node7); // only 2 allowed | ||
| assertThat(policy.getLiveNodes().dc("dc3")).containsExactly(node9, node10); // only 2 allowed | ||
| assertThat(policy.getLiveNodes().dc("dc4")).containsExactly(node12, node13); // only 2 allowed | ||
| return policy; | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @nitinitt . Thanks for this contribution, very useful.
While testing it on my side, I've stumbled upon this default (we use OptionsMap for configuring the driver, but I see the same default is in the
reference.conf). With this default, we never go tobuildRemoteQueryPlanAlland fall intobuildRemoteQueryPlanPreferred, which obviously cannot find nodes of the DC"".Was this set intentionally to default to a List with empty string for some reason?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @jahstreet
Is the code empty check: https://github.com/apache/cassandra-java-driver/pull/1896/files#diff-bbdb6181132c9a28e06a98058d5b3db08d3398ffb4233f242f8da44b26a9249bR333-R336
if (preferredRemoteDcs.isEmpty()) { return new CompositeQueryPlan(local, buildRemoteQueryPlanAll()); }not getting invoked?
Apologies for late reply, the intention was that the isEmpty() check prevents this condition.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I actually doesn't, cause there is an empty string in the array.