Skip to content

Add support for batch loading of a Map of key-value pairs. #166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 12, 2024
Merged

Add support for batch loading of a Map of key-value pairs. #166

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
22413be
`DataLoader` and `CompletableFutureKit`: add support for `loadMany` g…
Hc747-ATL Dec 12, 2024
09a6874
Merge branch 'graphql-java:master' into master
Hc747 Dec 12, 2024
2f437a7
`DataLoader` and `CompletableFutureKit`: add test cases for `loadMan…
Hc747-ATL Dec 12, 2024
d3c13c5
Merge remote-tracking branch 'origin/master'
Hc747-ATL Dec 12, 2024
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
DataLoader and CompletableFutureKit: add test cases for `loadMany… 
…` given a Map of keys and context objects.
  • Loading branch information
@Hc747-ATL
Hc747-ATL committed Dec 12, 2024
commit 2f437a75dac6a68de201e66d5f4f294e8a6b8589
56 changes: 43 additions & 13 deletions src/test/java/org/dataloader/DataLoaderBatchLoaderEnvironmentTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,7 @@

import org.junit.jupiter.api.Test;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.*;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.stream.Collectors;
Expand Down Expand Up @@ -50,10 +47,14 @@ public void context_is_passed_to_batch_loader_function() {
loader.load("A");
loader.load("B");
loader.loadMany(asList("C", "D"));
Map<String, ?> keysAndContexts = new LinkedHashMap<>();
keysAndContexts.put("E", null);
keysAndContexts.put("F", null);
loader.loadMany(keysAndContexts);

List<String> results = loader.dispatchAndJoin();

assertThat(results, equalTo(asList("A-ctx", "B-ctx", "C-ctx", "D-ctx")));
assertThat(results, equalTo(asList("A-ctx", "B-ctx", "C-ctx", "D-ctx", "E-ctx", "F-ctx")));
}

@Test
Expand All @@ -66,10 +67,14 @@ public void key_contexts_are_passed_to_batch_loader_function() {
loader.load("A", "aCtx");
loader.load("B", "bCtx");
loader.loadMany(asList("C", "D"), asList("cCtx", "dCtx"));
Map<String, String> keysAndContexts = new LinkedHashMap<>();
keysAndContexts.put("E", "eCtx");
keysAndContexts.put("F", "fCtx");
loader.loadMany(keysAndContexts);
Comment on lines +70 to +73
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Used LinkedHashMap because it is null safe and retains ordering (so the test(s) should not be flaky).

List<String> results = loader.dispatchAndJoin();

assertThat(results, equalTo(asList("A-ctx-m:aCtx-l:aCtx", "B-ctx-m:bCtx-l:bCtx", "C-ctx-m:cCtx-l:cCtx", "D-ctx-m:dCtx-l:dCtx")));
assertThat(results, equalTo(asList("A-ctx-m:aCtx-l:aCtx", "B-ctx-m:bCtx-l:bCtx", "C-ctx-m:cCtx-l:cCtx", "D-ctx-m:dCtx-l:dCtx", "E-ctx-m:eCtx-l:eCtx", "F-ctx-m:fCtx-l:fCtx")));
}

@Test
Expand All @@ -82,12 +87,17 @@ public void key_contexts_are_passed_to_batch_loader_function_when_batching_disab

CompletableFuture<String> aLoad = loader.load("A", "aCtx");
CompletableFuture<String> bLoad = loader.load("B", "bCtx");
CompletableFuture<List<String>> canDLoad = loader.loadMany(asList("C", "D"), asList("cCtx", "dCtx"));
CompletableFuture<List<String>> cAndDLoad = loader.loadMany(asList("C", "D"), asList("cCtx", "dCtx"));
Map<String, String> keysAndContexts = new LinkedHashMap<>();
keysAndContexts.put("E", "eCtx");
keysAndContexts.put("F", "fCtx");
CompletableFuture<Map<String, String>> eAndFLoad = loader.loadMany(keysAndContexts);

List<String> results = new ArrayList<>(asList(aLoad.join(), bLoad.join()));
results.addAll(canDLoad.join());
results.addAll(cAndDLoad.join());
results.addAll(eAndFLoad.join().values());

assertThat(results, equalTo(asList("A-ctx-m:aCtx-l:aCtx", "B-ctx-m:bCtx-l:bCtx", "C-ctx-m:cCtx-l:cCtx", "D-ctx-m:dCtx-l:dCtx")));
assertThat(results, equalTo(asList("A-ctx-m:aCtx-l:aCtx", "B-ctx-m:bCtx-l:bCtx", "C-ctx-m:cCtx-l:cCtx", "D-ctx-m:dCtx-l:dCtx", "E-ctx-m:eCtx-l:eCtx", "F-ctx-m:fCtx-l:fCtx")));
}

@Test
Expand All @@ -101,9 +111,14 @@ public void missing_key_contexts_are_passed_to_batch_loader_function() {
loader.load("B");
loader.loadMany(asList("C", "D"), singletonList("cCtx"));

Map<String, String> keysAndContexts = new LinkedHashMap<>();
keysAndContexts.put("E", "eCtx");
keysAndContexts.put("F", null);
loader.loadMany(keysAndContexts);

List<String> results = loader.dispatchAndJoin();

assertThat(results, equalTo(asList("A-ctx-m:aCtx-l:aCtx", "B-ctx-m:null-l:null", "C-ctx-m:cCtx-l:cCtx", "D-ctx-m:null-l:null")));
assertThat(results, equalTo(asList("A-ctx-m:aCtx-l:aCtx", "B-ctx-m:null-l:null", "C-ctx-m:cCtx-l:cCtx", "D-ctx-m:null-l:null", "E-ctx-m:eCtx-l:eCtx", "F-ctx-m:null-l:null")));
}

@Test
Expand All @@ -125,9 +140,14 @@ public void context_is_passed_to_map_batch_loader_function() {
loader.load("B");
loader.loadMany(asList("C", "D"), singletonList("cCtx"));

Map<String, String> keysAndContexts = new LinkedHashMap<>();
keysAndContexts.put("E", "eCtx");
keysAndContexts.put("F", null);
loader.loadMany(keysAndContexts);

List<String> results = loader.dispatchAndJoin();

assertThat(results, equalTo(asList("A-ctx-aCtx", "B-ctx-null", "C-ctx-cCtx", "D-ctx-null")));
assertThat(results, equalTo(asList("A-ctx-aCtx", "B-ctx-null", "C-ctx-cCtx", "D-ctx-null", "E-ctx-eCtx", "F-ctx-null")));
}

@Test
Expand All @@ -142,9 +162,14 @@ public void null_is_passed_as_context_if_you_do_nothing() {
loader.load("B");
loader.loadMany(asList("C", "D"));

Map<String, String> keysAndContexts = new LinkedHashMap<>();
keysAndContexts.put("E", null);
keysAndContexts.put("F", null);
loader.loadMany(keysAndContexts);

List<String> results = loader.dispatchAndJoin();

assertThat(results, equalTo(asList("A-null", "B-null", "C-null", "D-null")));
assertThat(results, equalTo(asList("A-null", "B-null", "C-null", "D-null", "E-null", "F-null")));
}

@Test
Expand All @@ -160,9 +185,14 @@ public void null_is_passed_as_context_to_map_loader_if_you_do_nothing() {
loader.load("B");
loader.loadMany(asList("C", "D"));

Map<String, String> keysAndContexts = new LinkedHashMap<>();
keysAndContexts.put("E", null);
keysAndContexts.put("F", null);
loader.loadMany(keysAndContexts);

List<String> results = loader.dispatchAndJoin();

assertThat(results, equalTo(asList("A-null", "B-null", "C-null", "D-null")));
assertThat(results, equalTo(asList("A-null", "B-null", "C-null", "D-null", "E-null", "F-null")));
}

@Test
Expand Down
12 changes: 7 additions & 5 deletions src/test/java/org/dataloader/DataLoaderStatsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CompletableFuture;

import static java.util.Arrays.asList;
Expand Down Expand Up @@ -118,19 +119,20 @@ public void stats_are_collected_with_caching_disabled() {
loader.load("A");
loader.load("B");
loader.loadMany(asList("C", "D"));
loader.loadMany(Map.of("E", "E", "F", "F"));

Statistics stats = loader.getStatistics();
assertThat(stats.getLoadCount(), equalTo(4L));
assertThat(stats.getLoadCount(), equalTo(6L));
assertThat(stats.getBatchInvokeCount(), equalTo(0L));
assertThat(stats.getBatchLoadCount(), equalTo(0L));
assertThat(stats.getCacheHitCount(), equalTo(0L));

loader.dispatch();

stats = loader.getStatistics();
assertThat(stats.getLoadCount(), equalTo(4L));
assertThat(stats.getLoadCount(), equalTo(6L));
assertThat(stats.getBatchInvokeCount(), equalTo(1L));
assertThat(stats.getBatchLoadCount(), equalTo(4L));
assertThat(stats.getBatchLoadCount(), equalTo(6L));
assertThat(stats.getCacheHitCount(), equalTo(0L));

loader.load("A");
Expand All @@ -139,9 +141,9 @@ public void stats_are_collected_with_caching_disabled() {
loader.dispatch();

stats = loader.getStatistics();
assertThat(stats.getLoadCount(), equalTo(6L));
assertThat(stats.getLoadCount(), equalTo(8L));
assertThat(stats.getBatchInvokeCount(), equalTo(2L));
assertThat(stats.getBatchLoadCount(), equalTo(6L));
assertThat(stats.getBatchLoadCount(), equalTo(8L));
assertThat(stats.getCacheHitCount(), equalTo(0L));
}

Expand Down
93 changes: 74 additions & 19 deletions src/test/java/org/dataloader/DataLoaderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,24 +35,19 @@
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.*;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionStage;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import static java.util.Arrays.asList;
import static java.util.Collections.emptyList;
import static java.util.Collections.singletonList;
import static java.util.Collections.*;
import static java.util.concurrent.CompletableFuture.*;
import static org.awaitility.Awaitility.await;
import static org.dataloader.DataLoaderFactory.newDataLoader;
Expand All @@ -66,10 +61,7 @@
import static org.dataloader.fixtures.TestKit.listFrom;
import static org.dataloader.impl.CompletableFutureKit.cause;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.empty;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.instanceOf;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.*;
import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.junit.jupiter.api.Assertions.fail;

Expand Down Expand Up @@ -116,19 +108,25 @@ public void basic_map_batch_loading() {
};
DataLoader<String, String> loader = DataLoaderFactory.newMappedDataLoader(evensOnlyMappedBatchLoader);

final List<String> keys = asList("C", "D");
final Map<String, ?> keysAndContexts = new LinkedHashMap<>();
keysAndContexts.put("E", null);
keysAndContexts.put("F", null);

loader.load("A");
loader.load("B");
loader.loadMany(asList("C", "D"));
loader.loadMany(keys);
loader.loadMany(keysAndContexts);

List<String> results = loader.dispatchAndJoin();

assertThat(results.size(), equalTo(4));
assertThat(results, equalTo(asList("A", null, "C", null)));
assertThat(results.size(), equalTo(6));
assertThat(results, equalTo(asList("A", null, "C", null, "E", null)));
}

@ParameterizedTest
@MethodSource("dataLoaderFactories")
public void should_Support_loading_multiple_keys_in_one_call(TestDataLoaderFactory factory) {
public void should_Support_loading_multiple_keys_in_one_call_via_list(TestDataLoaderFactory factory) {
AtomicBoolean success = new AtomicBoolean();
DataLoader<Integer, Integer> identityLoader = factory.idLoader(new DataLoaderOptions(), new ArrayList<>());

Expand All @@ -142,6 +140,26 @@ public void should_Support_loading_multiple_keys_in_one_call(TestDataLoaderFacto
assertThat(futureAll.toCompletableFuture().join(), equalTo(asList(1, 2)));
}

@ParameterizedTest
@MethodSource("dataLoaderFactories")
public void should_Support_loading_multiple_keys_in_one_call_via_map(TestDataLoaderFactory factory) {
AtomicBoolean success = new AtomicBoolean();
DataLoader<Integer, Integer> identityLoader = factory.idLoader(new DataLoaderOptions(), new ArrayList<>());

final Map<Integer, ?> keysAndContexts = new LinkedHashMap<>();
keysAndContexts.put(1, null);
keysAndContexts.put(2, null);

CompletionStage<Map<Integer, Integer>> futureAll = identityLoader.loadMany(keysAndContexts);
futureAll.thenAccept(promisedValues -> {
assertThat(promisedValues.size(), is(2));
success.set(true);
});
identityLoader.dispatch();
await().untilAtomic(success, is(true));
assertThat(futureAll.toCompletableFuture().join(), equalTo(Map.of(1, 1, 2, 2)));
}

@ParameterizedTest
@MethodSource("dataLoaderFactories")
public void should_Resolve_to_empty_list_when_no_keys_supplied(TestDataLoaderFactory factory) {
Expand All @@ -159,7 +177,22 @@ public void should_Resolve_to_empty_list_when_no_keys_supplied(TestDataLoaderFac

@ParameterizedTest
@MethodSource("dataLoaderFactories")
public void should_Return_zero_entries_dispatched_when_no_keys_supplied(TestDataLoaderFactory factory) {
public void should_Resolve_to_empty_map_when_no_keys_supplied(TestDataLoaderFactory factory) {
AtomicBoolean success = new AtomicBoolean();
DataLoader<Integer, Integer> identityLoader = factory.idLoader(new DataLoaderOptions(), new ArrayList<>());
CompletableFuture<Map<Integer, Integer>> futureEmpty = identityLoader.loadMany(emptyMap());
futureEmpty.thenAccept(promisedValues -> {
assertThat(promisedValues.size(), is(0));
success.set(true);
});
identityLoader.dispatch();
await().untilAtomic(success, is(true));
assertThat(futureEmpty.join(), anEmptyMap());
}

@ParameterizedTest
@MethodSource("dataLoaderFactories")
public void should_Return_zero_entries_dispatched_when_no_keys_supplied_via_list(TestDataLoaderFactory factory) {
AtomicBoolean success = new AtomicBoolean();
DataLoader<Integer, Integer> identityLoader = factory.idLoader(new DataLoaderOptions(), new ArrayList<>());
CompletableFuture<List<Integer>> futureEmpty = identityLoader.loadMany(emptyList());
Expand All @@ -172,6 +205,21 @@ public void should_Return_zero_entries_dispatched_when_no_keys_supplied(TestData
assertThat(dispatchResult.getKeysCount(), equalTo(0));
}

@ParameterizedTest
@MethodSource("dataLoaderFactories")
public void should_Return_zero_entries_dispatched_when_no_keys_supplied_via_map(TestDataLoaderFactory factory) {
AtomicBoolean success = new AtomicBoolean();
DataLoader<Integer, Integer> identityLoader = factory.idLoader(new DataLoaderOptions(), new ArrayList<>());
CompletableFuture<Map<Integer, Integer>> futureEmpty = identityLoader.loadMany(emptyMap());
futureEmpty.thenAccept(promisedValues -> {
assertThat(promisedValues.size(), is(0));
success.set(true);
});
DispatchResult<Integer> dispatchResult = identityLoader.dispatchWithCounts();
await().untilAtomic(success, is(true));
assertThat(dispatchResult.getKeysCount(), equalTo(0));
}

@ParameterizedTest
@MethodSource("dataLoaderFactories")
public void should_Batch_multiple_requests(TestDataLoaderFactory factory) throws ExecutionException, InterruptedException {
Expand Down Expand Up @@ -286,10 +334,17 @@ public void should_Cache_on_redispatch(TestDataLoaderFactory factory) throws Exe
CompletableFuture<List<String>> future2 = identityLoader.loadMany(asList("A", "B"));
identityLoader.dispatch();

await().until(() -> future1.isDone() && future2.isDone());
Map<String, ?> keysAndContexts = new LinkedHashMap<>();
keysAndContexts.put("A", null);
keysAndContexts.put("C", null);
CompletableFuture<Map<String, String>> future3 = identityLoader.loadMany(keysAndContexts);
identityLoader.dispatch();

await().until(() -> future1.isDone() && future2.isDone() && future3.isDone());
assertThat(future1.get(), equalTo("A"));
assertThat(future2.get(), equalTo(asList("A", "B")));
assertThat(loadCalls, equalTo(asList(singletonList("A"), singletonList("B"))));
assertThat(future3.get(), equalTo(keysAndContexts.entrySet().stream().collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getKey))));
assertThat(loadCalls, equalTo(asList(singletonList("A"), singletonList("B"), singletonList("C"))));
}

@ParameterizedTest
Expand Down