diff --git a/.github/workflows/master.yml b/.github/workflows/master.yml index 3be85c96..9f7f9deb 100644 --- a/.github/workflows/master.yml +++ b/.github/workflows/master.yml @@ -16,7 +16,7 @@ jobs: steps: - uses: actions/checkout@v5 - - uses: gradle/actions/wrapper-validation@v5 + - uses: gradle/actions/wrapper-validation@v6.4.0 - name: Set up JDK 21 uses: actions/setup-java@v5 with: @@ -26,7 +26,7 @@ jobs: # Configure Gradle for optimal use in GiHub Actions, including caching of downloaded dependencies. # See: https://github.com/gradle/actions/blob/main/setup-gradle/README.md - name: Setup Gradle - uses: gradle/actions/setup-gradle@v5 + uses: gradle/actions/setup-gradle@v6.4.0 - name: build test and publish run: ./gradlew assemble && ./gradlew check --info && ./gradlew jcstress && ./gradlew publishToSonatype closeAndReleaseSonatypeStagingRepository -x check --info --stacktrace env: diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml index 41a1e883..a9f4563c 100644 --- a/.github/workflows/pull_request.yml +++ b/.github/workflows/pull_request.yml @@ -14,7 +14,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v5 - - uses: gradle/actions/wrapper-validation@v5 + - uses: gradle/actions/wrapper-validation@v6.4.0 - name: Set up JDK 21 uses: actions/setup-java@v5 with: @@ -24,7 +24,7 @@ jobs: # Configure Gradle for optimal use in GiHub Actions, including caching of downloaded dependencies. # See: https://github.com/gradle/actions/blob/main/setup-gradle/README.md - name: Setup Gradle - uses: gradle/actions/setup-gradle@v5 + uses: gradle/actions/setup-gradle@v6.4.0 - name: build and test run: ./gradlew assemble && ./gradlew check --info --stacktrace && ./gradlew jcstress env: diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index ba437442..6b82e779 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -20,7 +20,7 @@ jobs: steps: - uses: actions/checkout@v5 - - uses: gradle/actions/wrapper-validation@v5 + - uses: gradle/actions/wrapper-validation@v6.4.0 - name: Set up JDK 21 uses: actions/setup-java@v5 with: @@ -30,7 +30,7 @@ jobs: # Configure Gradle for optimal use in GiHub Actions, including caching of downloaded dependencies. # See: https://github.com/gradle/actions/blob/main/setup-gradle/README.md - name: Setup Gradle - uses: gradle/actions/setup-gradle@v5 + uses: gradle/actions/setup-gradle@v6.4.0 - name: build test and publish run: ./gradlew assemble && ./gradlew check --info && ./gradlew publishToSonatype closeAndReleaseSonatypeStagingRepository -x check --info --stacktrace env: diff --git a/README.md b/README.md index a53e7668..7f7661e9 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,9 @@ [![Latest Snapshot](https://img.shields.io/maven-central/v/com.graphql-java/java-dataloader?label=maven-central%20snapshot&versionPrefix=0)](https://maven-badges.herokuapp.com/maven-central/com.graphql-java/graphql-java/) [![Apache licensed](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/graphql-java/java-dataloader/blob/master/LICENSE) -This small and simple utility library is a pure Java 11 port of [Facebook DataLoader](https://github.com/facebook/dataloader). +This small and simple utility library is a pure Java port of [Facebook DataLoader](https://github.com/facebook/dataloader). + +The current development version requires Java 17 or later to run. It can serve as integral part of your application's data layer to provide a consistent API over various back-ends and reduce message communication overhead through batching and caching. @@ -16,7 +18,7 @@ are resolved independently and, with a true graph of objects, you may be fetchin A naive implementation of graphql data fetchers can easily lead to the dreaded "n+1" fetch problem. Most of the code is ported directly from Facebook's reference implementation, with one IMPORTANT adaptation to make -it work for Java 11. ([more on this below](#manual-dispatching)). +it work for Java. ([more on this below](#manual-dispatching)). Before reading on, be sure to take a short dive into the [original documentation](https://github.com/facebook/dataloader/blob/master/README.md) provided by Lee Byron (@leebyron) @@ -74,7 +76,7 @@ dependencies { ### Building -To build from source use the Gradle wrapper: +Building from source uses a JDK 21 toolchain. Use the Gradle wrapper: ``` ./gradlew clean build @@ -834,10 +836,10 @@ This library was originally written for use within a [VertX world](http://vertx. itself. All the heavy lifting has been done by this project : [vertx-dataloader](https://github.com/engagingspaces/vertx-dataloader) including the extensive testing (which itself came from Facebook). -This particular port was done to reduce the dependency on Vertx and to write a pure Java 11 implementation with no dependencies and also +This particular port was done to reduce the dependency on Vertx and to write a pure Java implementation with no dependencies and also to use the more normative Java CompletableFuture. -[vertx-core](http://vertx.io/docs/vertx-core/java/) is not a lightweight library by any means so having a pure Java 11 implementation is +[vertx-core](http://vertx.io/docs/vertx-core/java/) is not a lightweight library by any means so having a pure Java implementation is very desirable. diff --git a/build.gradle b/build.gradle index 7d2c8060..d6d08e44 100644 --- a/build.gradle +++ b/build.gradle @@ -11,11 +11,11 @@ plugins { id 'maven-publish' id 'signing' id 'groovy' - id 'biz.aQute.bnd.builder' version '7.1.0' + id 'biz.aQute.bnd.builder' version '7.3.0' id 'io.github.gradle-nexus.publish-plugin' version '2.0.0' - id 'com.github.ben-manes.versions' version '0.53.0' + id 'com.github.ben-manes.versions' version '0.54.0' id "me.champeau.jmh" version "0.7.3" - id "net.ltgt.errorprone" version '4.3.0' + id "net.ltgt.errorprone" version '5.1.0' id "io.github.reyerizo.gradle.jcstress" version "0.9.0" // Kotlin just for tests - not production code @@ -32,7 +32,7 @@ kotlin { compilerOptions { apiVersion = KotlinVersion.KOTLIN_2_0 languageVersion = KotlinVersion.KOTLIN_2_0 - jvmTarget = JvmTarget.JVM_11 + jvmTarget = JvmTarget.JVM_17 javaParameters = true freeCompilerArgs = [ '-Xemit-jvm-type-annotations', @@ -59,7 +59,7 @@ def getDevelopmentVersion() { def releaseVersion = System.env.RELEASE_VERSION version = releaseVersion ? releaseVersion : getDevelopmentVersion() group = 'com.graphql-java' -description = 'A pure Java 11 port of Facebook Dataloader' +description = 'A pure Java 17 port of Facebook Dataloader' gradle.buildFinished { buildResult -> println "*******************************" @@ -108,7 +108,7 @@ dependencies { } tasks.withType(JavaCompile) { - options.release = 11 + options.release = 17 options.errorprone { disableAllChecks = true check("NullAway", CheckSeverity.ERROR) @@ -187,7 +187,7 @@ publishing { asNode().children().last() + { resolveStrategy = Closure.DELEGATE_FIRST name 'java-dataloader' - description 'A pure Java 11 port of Facebook Dataloader' + description project.description url 'https://github.com/graphql-java/java-dataloader' inceptionYear '2017' diff --git a/settings.gradle b/settings.gradle index 4dfab7ac..b36f217d 100644 --- a/settings.gradle +++ b/settings.gradle @@ -1,5 +1,5 @@ plugins { - id 'com.gradle.develocity' version '4.3' + id 'com.gradle.develocity' version '4.4.3' id 'org.gradle.toolchains.foojay-resolver-convention' version '1.0.0' } diff --git a/src/jmh/java/performance/ScheduledDataLoaderRegistryDispatchPerformance.java b/src/jmh/java/performance/ScheduledDataLoaderRegistryDispatchPerformance.java new file mode 100644 index 00000000..a1a0a3bf --- /dev/null +++ b/src/jmh/java/performance/ScheduledDataLoaderRegistryDispatchPerformance.java @@ -0,0 +1,91 @@ +package performance; + +import org.dataloader.BatchLoader; +import org.dataloader.DataLoader; +import org.dataloader.DataLoaderFactory; +import org.dataloader.DataLoaderOptions; +import org.dataloader.registries.DispatchPredicate; +import org.dataloader.registries.ScheduledDataLoaderRegistry; +import org.openjdk.jmh.annotations.Benchmark; +import org.openjdk.jmh.annotations.BenchmarkMode; +import org.openjdk.jmh.annotations.Fork; +import org.openjdk.jmh.annotations.Measurement; +import org.openjdk.jmh.annotations.Mode; +import org.openjdk.jmh.annotations.OutputTimeUnit; +import org.openjdk.jmh.annotations.Param; +import org.openjdk.jmh.annotations.Scope; +import org.openjdk.jmh.annotations.Setup; +import org.openjdk.jmh.annotations.State; +import org.openjdk.jmh.annotations.TearDown; +import org.openjdk.jmh.annotations.Warmup; + +import java.time.Duration; +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ScheduledThreadPoolExecutor; +import java.util.concurrent.TimeUnit; + +/** + * A ticker-mode {@link ScheduledDataLoaderRegistry} set up the way a GraphQL server builds one per request: every + * data loader the application defines is registered, but a request only queues keys on a few of them, while + * graphql-java's per-level dispatch calls {@link ScheduledDataLoaderRegistry#dispatchAll()} many times. + *

+ * The tick is an hour so that the scheduled ticker never runs during a measurement. + */ +@State(Scope.Benchmark) +@Warmup(iterations = 3, time = 2) +@Measurement(iterations = 5, time = 2) +@Fork(2) +@BenchmarkMode(Mode.AverageTime) +@OutputTimeUnit(TimeUnit.NANOSECONDS) +public class ScheduledDataLoaderRegistryDispatchPerformance { + + @Param({"20", "200"}) + int registeredLoaders; + + @Param({"0", "5"}) + int loadersWithQueuedKeys; + + ScheduledThreadPoolExecutor executor; + ScheduledDataLoaderRegistry registry; + List> queuedLoaders; + + @Setup + public void setup() { + executor = new ScheduledThreadPoolExecutor(1); + ScheduledDataLoaderRegistry.Builder builder = ScheduledDataLoaderRegistry.newScheduledRegistry() + .scheduledExecutorService(executor) + .tickerMode(true) + .schedule(Duration.ofHours(1)) + .dispatchPredicate(DispatchPredicate.DISPATCH_NEVER); + BatchLoader echo = CompletableFuture::completedFuture; + DataLoaderOptions uncached = DataLoaderOptions.newOptions().setCachingEnabled(false).build(); + List> loaders = new ArrayList<>(); + for (int i = 0; i < registeredLoaders; i++) { + DataLoader loader = DataLoaderFactory.newDataLoader("loader-" + i, echo, uncached); + loaders.add(loader); + builder.register("loader-" + i, loader, DispatchPredicate.DISPATCH_ALWAYS); + } + registry = builder.build(); + // spread across the registry rather than the first few entries + queuedLoaders = new ArrayList<>(); + for (int i = 0; i < loadersWithQueuedKeys; i++) { + queuedLoaders.add(loaders.get(i * registeredLoaders / loadersWithQueuedKeys)); + } + } + + @TearDown + public void tearDown() { + registry.close(); + executor.shutdownNow(); + } + + @Benchmark + public int dispatchAll() { + for (DataLoader loader : queuedLoaders) { + loader.load(1); + } + return registry.dispatchAllWithCount(); + } +} diff --git a/src/main/java/org/dataloader/registries/ScheduledDataLoaderRegistry.java b/src/main/java/org/dataloader/registries/ScheduledDataLoaderRegistry.java index 4f62378d..ca4e24aa 100644 --- a/src/main/java/org/dataloader/registries/ScheduledDataLoaderRegistry.java +++ b/src/main/java/org/dataloader/registries/ScheduledDataLoaderRegistry.java @@ -15,6 +15,7 @@ import java.util.concurrent.Executors; import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; import static org.dataloader.impl.Assertions.nonNull; @@ -33,6 +34,8 @@ * no rescheduling will occur, and you will need to call dispatch again to restart the process. *

* However, when {@link #tickerMode} is true, the registry will always reschedule continuously after the first ever call to {@link #dispatchAll()}. + * A single task per registry re-runs the dispatch of all data loaders every {@link #getScheduleDuration()}, however + * often {@link #dispatchAll()} or {@link #rescheduleNow()} is called. *

* This will allow you to chain together {@link DataLoader} load calls like this : *

{@code
@@ -67,6 +70,7 @@ public class ScheduledDataLoaderRegistry extends DataLoaderRegistry implements A
     private final Duration schedule;
     private final boolean tickerMode;
     private volatile boolean closed;
+    private final AtomicBoolean tickScheduled = new AtomicBoolean();
 
     private ScheduledDataLoaderRegistry(Builder builder) {
         super(builder.dataLoaders, builder.instrumentation);
@@ -178,6 +182,9 @@ public void dispatchAll() {
 
     @Override
     public int dispatchAllWithCount() {
+        if (tickerMode) {
+            return dispatchQueuedAndTick();
+        }
         int sum = 0;
         for (Map.Entry> entry : dataLoaders.entrySet()) {
             DataLoader dataLoader = entry.getValue();
@@ -187,6 +194,26 @@ public int dispatchAllWithCount() {
         return sum;
     }
 
+    /**
+     * Ticker mode only dispatches the {@link DataLoader}s that have keys queued. Dispatching an empty
+     * {@link DataLoader} only refreshes its last dispatch time and calls the dispatch instrumentation, and a
+     * registry typically holds many more {@link DataLoader}s than a single dispatch has work for. A key queued
+     * after the {@link DataLoader#dispatchDepth()} check is dispatched by the next tick, as is a key queued just
+     * after a dispatch.
+     */
+    private int dispatchQueuedAndTick() {
+        // armed before dispatching so that a data loader or predicate throwing cannot stop the ticker
+        scheduleTick();
+        int sum = 0;
+        for (Map.Entry> entry : dataLoaders.entrySet()) {
+            DataLoader dataLoader = entry.getValue();
+            if (dataLoader.dispatchDepth() > 0 && shouldDispatch(entry.getKey(), dataLoader)) {
+                sum += dataLoader.dispatchWithCounts().getKeysCount();
+            }
+        }
+        return sum;
+    }
+
 
     /**
      * This will immediately dispatch the {@link DataLoader}s in the registry
@@ -214,7 +241,11 @@ public int dispatchAllWithCountImmediately() {
      * a pre-check of the predicate like {@link #dispatchAll()} would
      */
     public void rescheduleNow() {
-        dataLoaders.forEach(this::reschedule);
+        if (tickerMode) {
+            scheduleTick();
+        } else {
+            dataLoaders.forEach(this::reschedule);
+        }
     }
 
     /**
@@ -246,12 +277,32 @@ private int dispatchOrReschedule(String key, DataLoader dataLoader) {
         if (shouldDispatch) {
             sum = dataLoader.dispatchWithCounts().getKeysCount();
         }
-        if (tickerMode || !shouldDispatch) {
+        if (tickerMode) {
+            scheduleTick();
+        } else if (!shouldDispatch) {
             reschedule(key, dataLoader);
         }
         return sum;
     }
 
+    /**
+     * In ticker mode a single task per registry re-runs {@link #dispatchAllWithCount()} every {@link #schedule},
+     * however often {@link #dispatchAll()} is called. Scheduling a task per data loader on every
+     * {@link #dispatchAll()} call would grow the executor queue by the number of registered data loaders on each call.
+     */
+    private void scheduleTick() {
+        if (!closed && tickScheduled.compareAndSet(false, true)) {
+            scheduledExecutorService.schedule(this::tick, schedule.toMillis(), TimeUnit.MILLISECONDS);
+        }
+    }
+
+    private void tick() {
+        tickScheduled.set(false);
+        // re-arm before dispatching so that a data loader throwing on dispatch cannot stop the ticker
+        scheduleTick();
+        dispatchAllWithCount();
+    }
+
     /**
      * By default, this will create use a {@link Executors#newSingleThreadScheduledExecutor()}
      * and a schedule duration of 10 milliseconds.
@@ -349,7 +400,7 @@ public Builder dispatchPredicate(DispatchPredicate dispatchPredicate) {
         /**
          * This sets ticker mode on the registry.  When ticker mode is true the registry will
          * continuously reschedule the data loaders for possible dispatching after the first call
-         * to dispatchAll.
+         * to dispatchAll, using a single scheduled task per registry.
          *
          * @param tickerMode true or false
          * @return this builder for a fluent pattern
diff --git a/src/test/java/org/dataloader/registries/ScheduledDataLoaderRegistryTest.java b/src/test/java/org/dataloader/registries/ScheduledDataLoaderRegistryTest.java
index e89939ca..59f46d96 100644
--- a/src/test/java/org/dataloader/registries/ScheduledDataLoaderRegistryTest.java
+++ b/src/test/java/org/dataloader/registries/ScheduledDataLoaderRegistryTest.java
@@ -15,6 +15,8 @@
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.Executors;
 import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.ScheduledThreadPoolExecutor;
+import java.util.concurrent.TimeUnit;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.concurrent.atomic.AtomicInteger;
 
@@ -22,6 +24,7 @@
 import static java.util.Collections.singletonList;
 import static org.awaitility.Awaitility.await;
 import static org.awaitility.Duration.TWO_SECONDS;
+import static org.dataloader.fixtures.TestKit.idLoader;
 import static org.dataloader.fixtures.TestKit.snooze;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.equalTo;
@@ -350,6 +353,109 @@ public void chain_data_loaders_will_hang_if_not_in_ticker_mode(TestDataLoaderFac
         registry.close();
     }
 
+    @Test
+    public void ticker_mode_keeps_one_pending_task_however_often_dispatch_all_is_called() {
+        ScheduledThreadPoolExecutor executor = new ScheduledThreadPoolExecutor(1);
+        // a tick that never fires during the test, so the queue is only inspected between ticks
+        ScheduledDataLoaderRegistry registry = tickerRegistry(executor, Duration.ofHours(1), 20, alwaysDispatch);
+
+        for (int i = 0; i < 50; i++) {
+            registry.dispatchAll();
+        }
+
+        assertThat(executor.getQueue().size(), equalTo(1));
+        registry.close();
+        executor.shutdownNow();
+    }
+
+    @Test
+    public void ticker_mode_reschedule_now_keeps_one_pending_task() {
+        ScheduledThreadPoolExecutor executor = new ScheduledThreadPoolExecutor(1);
+        ScheduledDataLoaderRegistry registry = tickerRegistry(executor, Duration.ofHours(1), 20, alwaysDispatch);
+        registry.dispatchAll();
+
+        for (int i = 0; i < 50; i++) {
+            registry.rescheduleNow();
+        }
+
+        assertThat(executor.getQueue().size(), equalTo(1));
+        registry.close();
+        executor.shutdownNow();
+    }
+
+    @Test
+    public void ticker_mode_dispatch_all_only_visits_data_loaders_with_queued_keys() {
+        ScheduledThreadPoolExecutor executor = new ScheduledThreadPoolExecutor(1);
+        List visited = new ArrayList<>();
+        DispatchPredicate recordingPredicate = (key, dl) -> {
+            visited.add(key);
+            return true;
+        };
+        ScheduledDataLoaderRegistry registry = tickerRegistry(executor, Duration.ofHours(1), 20, recordingPredicate);
+        DataLoader loader = registry.getDataLoader("loader-7");
+        CompletableFuture queued = loader.load("queued");
+
+        int dispatched = registry.dispatchAllWithCount();
+
+        assertThat(dispatched, equalTo(1));
+        assertThat(queued.getNow(null), equalTo("queued"));
+        assertThat(visited, equalTo(singletonList("loader-7")));
+        assertThat(executor.getQueue().size(), equalTo(1));
+        registry.close();
+        executor.shutdownNow();
+    }
+
+    @Test
+    public void ticker_mode_keeps_ticking_after_a_dispatch_predicate_throws() throws Exception {
+        ScheduledThreadPoolExecutor executor = new ScheduledThreadPoolExecutor(1);
+        AtomicBoolean throwOnNextCheck = new AtomicBoolean();
+        DispatchPredicate throwingOnce = (key, dl) -> {
+            if (throwOnNextCheck.getAndSet(false)) {
+                throw new IllegalStateException("predicate failure");
+            }
+            return true;
+        };
+        ScheduledDataLoaderRegistry registry = tickerRegistry(executor, Duration.ofMillis(10), 1, throwingOnce);
+        registry.dispatchAll();
+        throwOnNextCheck.set(true);
+
+        DataLoader loader = registry.getDataLoader("loader-0");
+        CompletableFuture late = loader.load("late");
+
+        assertThat(late.get(2, TimeUnit.SECONDS), equalTo("late"));
+        registry.close();
+        executor.shutdownNow();
+    }
+
+    @Test
+    public void close_stops_the_ticker_but_dispatch_all_still_dispatches() throws Exception {
+        ScheduledThreadPoolExecutor executor = new ScheduledThreadPoolExecutor(1);
+        ScheduledDataLoaderRegistry registry = tickerRegistry(executor, Duration.ofMillis(10), 1, alwaysDispatch);
+        registry.dispatchAll();
+        registry.close();
+        await().atMost(TWO_SECONDS).until(() -> executor.getQueue().isEmpty());
+
+        DataLoader loader = registry.getDataLoader("loader-0");
+        CompletableFuture afterClose = loader.load("after-close");
+        registry.dispatchAll();
+
+        assertThat(afterClose.getNow(null), equalTo("after-close"));
+        assertThat(executor.getQueue().size(), equalTo(0));
+        executor.shutdownNow();
+    }
+
+    private ScheduledDataLoaderRegistry tickerRegistry(ScheduledExecutorService executor, Duration schedule, int loaderCount, DispatchPredicate loaderPredicate) {
+        ScheduledDataLoaderRegistry.Builder builder = ScheduledDataLoaderRegistry.newScheduledRegistry()
+                .scheduledExecutorService(executor)
+                .tickerMode(true)
+                .schedule(schedule)
+                .dispatchPredicate(neverDispatch);
+        for (int i = 0; i < loaderCount; i++) {
+            builder.register("loader-" + i, idLoader("loader-" + i), loaderPredicate);
+        }
+        return builder.build();
+    }
+
     @Test
     public void executors_are_shutdown() {
         ScheduledDataLoaderRegistry registry = ScheduledDataLoaderRegistry.newScheduledRegistry().build();