Skip to content

Commit 55dd69d

Browse files
authored
Merge branch 'master' into zmoore/dispatch-strategy
2 parents e81ea3c + 918203c commit 55dd69d

File tree

12 files changed

+273
-118
lines changed

12 files changed

+273
-118
lines changed

build.gradle

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,20 @@ plugins {
1111
id 'maven-publish'
1212
id 'signing'
1313
id 'groovy'
14-
id 'biz.aQute.bnd.builder' version '6.2.0'
14+
id 'biz.aQute.bnd.builder' version '7.1.0'
1515
id 'io.github.gradle-nexus.publish-plugin' version '2.0.0'
1616
id 'com.github.ben-manes.versions' version '0.53.0'
1717
id "me.champeau.jmh" version "0.7.3"
1818
id "net.ltgt.errorprone" version '4.3.0'
19-
id "io.github.reyerizo.gradle.jcstress" version "0.8.15"
19+
id "io.github.reyerizo.gradle.jcstress" version "0.9.0"
2020

2121
// Kotlin just for tests - not production code
22-
id 'org.jetbrains.kotlin.jvm' version '2.2.20'
22+
id 'org.jetbrains.kotlin.jvm' version '2.2.21'
2323
}
2424

2525
java {
2626
toolchain {
27-
languageVersion = JavaLanguageVersion.of(17)
27+
languageVersion = JavaLanguageVersion.of(21)
2828
}
2929
}
3030

@@ -81,13 +81,15 @@ repositories {
8181

8282
jar {
8383
manifest {
84-
attributes('Automatic-Module-Name': 'org.dataloader',
85-
'-exportcontents': 'org.dataloader.*',
86-
'-removeheaders': 'Private-Package')
84+
attributes('Automatic-Module-Name': 'org.dataloader')
8785
}
88-
bnd('''
86+
bundle {
87+
bnd('''
88+
-exportcontents: org.dataloader.*
89+
-removeheaders: Private-Package
8990
Import-Package: org.jspecify.annotations;resolution:=optional,*
9091
''')
92+
}
9193
}
9294

9395
dependencies {
@@ -99,7 +101,7 @@ dependencies {
99101
jmh 'org.openjdk.jmh:jmh-generator-annprocess:1.37'
100102

101103
errorprone 'com.uber.nullaway:nullaway:0.12.10'
102-
errorprone 'com.google.errorprone:error_prone_core:2.42.0'
104+
errorprone 'com.google.errorprone:error_prone_core:2.43.0'
103105

104106
// just tests
105107
testImplementation 'org.jetbrains.kotlin:kotlin-stdlib-jdk8'
@@ -141,10 +143,7 @@ task javadocJar(type: Jar, dependsOn: javadoc) {
141143
from javadoc.destinationDir
142144
}
143145

144-
artifacts {
145-
archives sourcesJar
146-
archives javadocJar
147-
}
146+
148147

149148
testing {
150149
suites {
@@ -177,9 +176,9 @@ publishing {
177176
publications {
178177
graphqlJava(MavenPublication) {
179178
from components.java
180-
groupId 'com.graphql-java'
181-
artifactId 'java-dataloader'
182-
version project.version
179+
groupId = 'com.graphql-java'
180+
artifactId = 'java-dataloader'
181+
version = project.version
183182

184183
artifact sourcesJar
185184
artifact javadocJar
@@ -237,7 +236,7 @@ nexusPublishing {
237236
}
238237

239238
signing {
240-
required { !project.hasProperty('publishToMavenLocal') }
239+
required = { !project.hasProperty('publishToMavenLocal') }
241240
def signingKey = System.env.MAVEN_CENTRAL_PGP_KEY
242241
useInMemoryPgpKeys(signingKey, "")
243242
sign publishing.publications

gradle/wrapper/gradle-wrapper.jar

-15.6 KB
Binary file not shown.

gradle/wrapper/gradle-wrapper.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
distributionBase=GRADLE_USER_HOME
22
distributionPath=wrapper/dists
3-
distributionUrl=https\://services.gradle.org/distributions/gradle-8.11.1-bin.zip
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-9.2.0-bin.zip
44
networkTimeout=10000
55
validateDistributionUrl=true
66
zipStoreBase=GRADLE_USER_HOME

gradlew

Lines changed: 31 additions & 13 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gradlew.bat

Lines changed: 21 additions & 16 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/main/java/org/dataloader/CacheMap.java

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,13 @@
2828
* CacheMap is used by data loaders that use caching promises to values aka {@link CompletableFuture}<V>. A better name for this
2929
* class might have been FutureCache but that is history now.
3030
* <p>
31-
* The default implementation used by the data loader is based on a {@link java.util.LinkedHashMap}.
31+
* The default implementation used by the data loader is based on a {@link java.util.concurrent.ConcurrentHashMap} because
32+
* the data loader code requires the cache to prove atomic writes especially the {@link #putIfAbsentAtomically(Object, CompletableFuture)}
33+
* method.
34+
* <p>
35+
* The data loader code using a Compare and Swap (CAS) algorithm to decide if a cache entry is present or not. If you write your
36+
* own {@link CacheMap} implementation then you MUST provide atomic writes in this method to ensure that the same promise for a key is
37+
* returned always.
3238
* <p>
3339
* This is really a cache of completed {@link CompletableFuture}&lt;V&gt; values in memory. It is used, when caching is enabled, to
3440
* give back the same future to any code that may call it. If you need a cache of the underlying values that is possible external to the JVM
@@ -42,7 +48,7 @@
4248
*/
4349
@PublicSpi
4450
@NullMarked
45-
public interface CacheMap<K, V> {
51+
public interface CacheMap<K,V> {
4652

4753
/**
4854
* Creates a new cache map, using the default implementation that is based on a {@link java.util.LinkedHashMap}.
@@ -84,14 +90,21 @@ static <K, V> CacheMap<K, V> simpleMap() {
8490
Collection<CompletableFuture<V>> getAll();
8591

8692
/**
87-
* Creates a new cache map entry with the specified key and value, or updates the value if the key already exists.
93+
* Atomically creates a new cache map entry with the specified key and value, or updates the value if the key already exists.
94+
* <p>
95+
* The data loader code using a Compare and Swap (CAS) algorithm to decide if a cache entry is present or not. If you write your
96+
* own {@link CacheMap} implementation then you MUST provide atomic writes in this method to ensure that the same promise for a key is
97+
* returned always.
98+
* <p>
99+
* The default implementation of this method uses {@link java.util.concurrent.ConcurrentHashMap} has its implementation so these CAS
100+
* writes work as expected.
88101
*
89102
* @param key the key to cache
90103
* @param value the value to cache
91104
*
92-
* @return the cache map for fluent coding
105+
* @return atomically the previous value for the key or null if the value is not present.
93106
*/
94-
CompletableFuture<V> putIfAbsentAtomically(K key, CompletableFuture<V> value);
107+
@Nullable CompletableFuture<V> putIfAbsentAtomically(K key, CompletableFuture<V> value);
95108

96109
/**
97110
* Deletes the entry with the specified key from the cache map, if it exists.
@@ -114,7 +127,7 @@ static <K, V> CacheMap<K, V> simpleMap() {
114127
* and intended for testing and debugging.
115128
* If a cache doesn't support it, it can throw an Exception.
116129
*
117-
* @return
130+
* @return the size of the cache
118131
*/
119132
int size();
120133
}

src/main/java/org/dataloader/DataLoader.java

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -160,21 +160,6 @@ public Duration getTimeSinceDispatch() {
160160
return Duration.between(helper.getLastDispatchTime(), helper.now());
161161
}
162162

163-
/**
164-
* Requests to load the data with the specified key asynchronously, and returns a future of the resulting value.
165-
* <p>
166-
* If batching is enabled (the default), you'll have to call {@link DataLoader#dispatch()} at a later stage to
167-
* start batch execution. If you forget this call the future will never be completed (unless already completed,
168-
* and returned from cache).
169-
*
170-
* @param key the key to load
171-
*
172-
* @return the future of the value
173-
*/
174-
public CompletableFuture<V> load(K key) {
175-
return load(key, null);
176-
}
177-
178163
/**
179164
* This will return an optional promise to a value previously loaded via a {@link #load(Object)} call or empty if not call has been made for that key.
180165
* <p>
@@ -213,6 +198,24 @@ public Optional<CompletableFuture<V>> getIfCompleted(K key) {
213198
}
214199

215200

201+
private CompletableFuture<V> loadImpl(@NonNull K key, @Nullable Object keyContext) {
202+
return helper.load(nonNull(key), keyContext);
203+
}
204+
205+
/**
206+
* Requests to load the data with the specified key asynchronously, and returns a future of the resulting value.
207+
* <p>
208+
* If batching is enabled (the default), you'll have to call {@link DataLoader#dispatch()} at a later stage to
209+
* start batch execution. If you forget this call the future will never be completed (unless already completed,
210+
* and returned from cache).
211+
*
212+
* @param key the key to load
213+
* @return the future of the value
214+
*/
215+
public CompletableFuture<V> load(K key) {
216+
return loadImpl(key, null);
217+
}
218+
216219
/**
217220
* Requests to load the data with the specified key asynchronously, and returns a future of the resulting value.
218221
* <p>
@@ -232,10 +235,6 @@ public CompletableFuture<V> load(@NonNull K key, @Nullable Object keyContext) {
232235
return loadImpl(key, keyContext);
233236
}
234237

235-
private CompletableFuture<V> loadImpl(@NonNull K key, @Nullable Object keyContext) {
236-
return helper.load(nonNull(key), keyContext);
237-
}
238-
239238
/**
240239
* Requests to load the list of data provided by the specified keys asynchronously, and returns a composite future
241240
* of the resulting values.

0 commit comments

Comments
 (0)