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 @@ [](https://maven-badges.herokuapp.com/maven-central/com.graphql-java/graphql-java/) [](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
* 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