Skip to content

If caching is off AND batching is off - ValueCache should not be used #276

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

Open
bbakerman wants to merge 1 commit into
base: master
Choose a base branch
from
+65 −5
Open

If caching is off AND batching is off - ValueCache should not be used #276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/main/java/org/dataloader/DataLoaderHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ CompletableFuture<V> load(K key, Object loadContext) {
} else {
stats.incrementBatchLoadCountBy(1, new IncrementBatchLoadCountByStatisticsContext<>(key, loadContext));
// immediate execution of batch function
loadCallFuture = invokeLoaderImmediately(key, loadContext, true);
loadCallFuture = invokeLoaderImmediately(key, loadContext, loaderOptions.cachingEnabled());
if (futureCachingEnabled) {
CompletableFuture<V> cachedFuture = futureCache.putIfAbsentAtomically(cacheKey, loadCallFuture);
if (cachedFuture != null) {
Expand Down Expand Up @@ -228,6 +228,7 @@ DispatchResult<V> dispatch() {
boolean batchingEnabled = loaderOptions.batchingEnabled();

LoaderQueueEntry<K, V> loaderQueueEntryHead;
//noinspection ConditionalBreakInInfiniteLoop
while (true) {
loaderQueueEntryHead = loaderQueue.get();
if (loaderQueue.compareAndSet(loaderQueueEntryHead, null)) {
Expand All @@ -244,7 +245,7 @@ DispatchResult<V> dispatch() {
int queueSize = loaderQueueEntryHead.queueSize;
// we copy the pre-loaded set of futures ready for dispatch
Object[] keysArray = new Object[queueSize];
CompletableFuture[] queuedFuturesArray = new CompletableFuture[queueSize];
CompletableFuture<V>[] queuedFuturesArray = new CompletableFuture[queueSize];
Object[] callContextsArray = new Object[queueSize];
int index = queueSize - 1;
while (loaderQueueEntryHead != null) {
Expand Down
31 changes: 28 additions & 3 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 @@ -18,6 +18,7 @@

import org.awaitility.Duration;
import org.dataloader.fixtures.CustomCacheMap;
import org.dataloader.fixtures.CustomValueCache;
import org.dataloader.fixtures.JsonObject;
import org.dataloader.fixtures.User;
import org.dataloader.fixtures.UserManager;
Expand Down Expand Up @@ -70,6 +71,8 @@
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.instanceOf;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.not;
import static org.hamcrest.Matchers.sameInstance;
import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
Expand Down Expand Up @@ -1009,16 +1012,27 @@ public void should_degrade_gracefully_if_cache_get_throws(TestDataLoaderFactory
@MethodSource("org.dataloader.fixtures.parameterized.TestDataLoaderFactories#get")
public void batching_disabled_should_dispatch_immediately(TestDataLoaderFactory factory) {
List<Collection<String>> loadCalls = new ArrayList<>();
DataLoaderOptions options = newOptions().setBatchingEnabled(false).build();

CacheMap<String, String> cacheMap = CacheMap.simpleMap();
CustomValueCache valueCache = new CustomValueCache();

DataLoaderOptions options = newOptions().setBatchingEnabled(false)
.setCacheMap(cacheMap).setValueCache(valueCache).build();
DataLoader<String, String> identityLoader = factory.idLoader(options, loadCalls);

CompletableFuture<String> fa = identityLoader.load("A");
CompletableFuture<String> fb = identityLoader.load("B");

assertThat(cacheMap.size(), equalTo(2));
assertThat(valueCache.asMap().size(), equalTo(2));

// caching is on still
CompletableFuture<String> fa1 = identityLoader.load("A");
CompletableFuture<String> fb1 = identityLoader.load("B");

assertThat(fa, sameInstance(fa1));
assertThat(fb, sameInstance(fb1));

List<String> values = CompletableFutureKit.allOf(asList(fa, fb, fa1, fb1)).join();

assertThat(fa.join(), equalTo("A"));
Expand All @@ -1038,16 +1052,27 @@ public void batching_disabled_should_dispatch_immediately(TestDataLoaderFactory
@MethodSource("org.dataloader.fixtures.parameterized.TestDataLoaderFactories#get")
public void batching_disabled_and_caching_disabled_should_dispatch_immediately_and_forget(TestDataLoaderFactory factory) {
List<Collection<String>> loadCalls = new ArrayList<>();
DataLoaderOptions options = newOptions().setBatchingEnabled(false).setCachingEnabled(false).build();

CacheMap<String, String> cacheMap = CacheMap.simpleMap();
CustomValueCache valueCache = new CustomValueCache();

DataLoaderOptions options = newOptions().setBatchingEnabled(false).setCachingEnabled(false)
.setCacheMap(cacheMap).setValueCache(valueCache).build();
DataLoader<String, String> identityLoader = factory.idLoader(options, loadCalls);

CompletableFuture<String> fa = identityLoader.load("A");
CompletableFuture<String> fb = identityLoader.load("B");

// caching is off
// caching is off - it should not go to the Value cache nor the future cache
assertThat(cacheMap.size(), equalTo(0));
assertThat(valueCache.asMap().size(), equalTo(0));

CompletableFuture<String> fa1 = identityLoader.load("A");
CompletableFuture<String> fb1 = identityLoader.load("B");

assertThat(fa, not(sameInstance(fa1)));
assertThat(fb, not(sameInstance(fb1)));

List<String> values = CompletableFutureKit.allOf(asList(fa, fb, fa1, fb1)).join();

assertThat(fa.join(), equalTo("A"));
Expand Down
34 changes: 34 additions & 0 deletions src/test/java/org/dataloader/DataLoaderValueCacheTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,6 +379,40 @@ public CompletableFuture<Object> get(String key) {
assertTrue(customValueCache.asMap().isEmpty());
}

@ParameterizedTest
@MethodSource("org.dataloader.fixtures.parameterized.TestDataLoaderFactories#get")
public void if_caching_is_off_and_batching_is_off_its_never_hit(TestDataLoaderFactory factory) {
AtomicInteger getCalls = new AtomicInteger();
CustomValueCache customValueCache = new CustomValueCache() {

@Override
public CompletableFuture<Object> get(String key) {
getCalls.incrementAndGet();
return super.get(key);
}
};

List<Collection<String>> loadCalls = new ArrayList<>();
DataLoaderOptions options = newOptions().setValueCache(customValueCache).setCachingEnabled(false).setBatchingEnabled(false).build();
DataLoader<String, String> identityLoader = factory.idLoader(options, loadCalls);

CompletableFuture<String> fA = identityLoader.load("a");
CompletableFuture<String> fB = identityLoader.load("b");
CompletableFuture<String> fC = identityLoader.load("missC");
CompletableFuture<String> fD = identityLoader.load("missD");

await().until(identityLoader.dispatch()::isDone);

assertThat(fA.join(), equalTo("a"));
assertThat(fB.join(), equalTo("b"));
assertThat(fC.join(), equalTo("missC"));
assertThat(fD.join(), equalTo("missD"));

assertThat(loadCalls, equalTo(asList(singletonList("a"), singletonList("b"), singletonList("missC"), singletonList("missD"))));
assertThat(getCalls.get(), equalTo(0));
assertTrue(customValueCache.asMap().isEmpty());
}

@ParameterizedTest
@MethodSource("org.dataloader.fixtures.parameterized.TestDataLoaderFactories#get")
public void if_everything_is_cached_no_batching_happens(TestDataLoaderFactory factory) {
Expand Down