Adopt jspecify + NullAway null-checking on fdb-record-layer-core

fdb-record-layer-core/fdb-record-layer-core.gradle

@@ -25,6 +25,7 @@ import de.undercouch.gradle.tasks.download.Verify
 plugins {
     id 'java-test-fixtures'
     alias(libs.plugins.shadow)
+    alias(libs.plugins.errorprone)
 }
 apply from: rootProject.file('gradle/proto.gradle')
 apply from: rootProject.file('gradle/publishing.gradle')
@@ -37,9 +38,13 @@ dependencies {
     implementation(libs.slf4j.api)
     implementation(libs.guava)
     compileOnly(libs.jsr305)
+    compileOnly(libs.jspecify)
     compileOnly(libs.autoService)
     annotationProcessor(libs.autoService)
 
+    errorprone(libs.errorprone.core)
+    errorprone(libs.nullaway)
+
     testImplementation project(':fdb-test-utils')
     // Guardiann structural-invariant assertions + SIFT dataset loaders/paths live in fdb-extensions' testFixtures
     // (GuardiannStructureAsserts, VecsDatasetLoaders, SiftTestHelpers, PrimaryKeyAndVector), reused by the vector-index
@@ -48,6 +53,7 @@ dependencies {
     testImplementation(libs.bundles.test.impl)
     testRuntimeOnly(libs.bundles.test.runtime)
     testCompileOnly(libs.bundles.test.compileOnly)
+    testCompileOnly(libs.jspecify)
     testImplementation(libs.jcommander)
     testImplementation(libs.apache.commonsMath3)
     testImplementation(libs.junit.platform)
@@ -67,6 +73,7 @@ dependencies {
     testFixturesImplementation(libs.snakeyaml)
     testFixturesImplementation(libs.protobuf.util)
     testFixturesCompileOnly(libs.jsr305)
+    testFixturesCompileOnly(libs.jspecify)
     testFixturesAnnotationProcessor(libs.autoService)
 }
 
@@ -76,6 +83,38 @@ sourceSets {
     }
 }
 
+// jspecify + NullAway, scoped to this module. See @NullMarked package-info.java files under
+// com.apple.foundationdb.record (this module's single root package). Protobuf-generated
+// metadata/plan-serialization code that lives in its own dedicated generated-only subpackage is
+// carved out via UnannotatedSubPackages -- this also covers three test-sourceSet-only proto
+// packages (record.evolution, record.vector, record.slidingwindowvector) that contain no
+// hand-written sources in any source set. A larger set of generated proto outer classes are
+// instead emitted directly into packages that also contain hand-annotated source
+// (com.apple.foundationdb.record, com.apple.foundationdb.record.metadata, and
+// com.apple.foundationdb.record.provider.foundationdb.keyspace), so package-level exclusion
+// would also blind NullAway to the hand-written classes they share a package with; those are
+// carved out individually via ExcludedClasses instead (this list is tied 1:1 to the module's
+// main-sourceSet protos: record_metadata.proto, record_cursor.proto, index_build.proto,
+// record_metadata_options.proto, record_planner_config.proto, pending_writes_queue.proto,
+// time_window_leaderboard.proto, resolver_state.proto, record_sorting.proto,
+// string_interning_data.proto, tuple_fields.proto, keyspace.proto; the 14 testFixtures-only
+// test_records_*.proto files; and the ~65 test-sourceSet-only test_records_*.proto /
+// expression_tests.proto files whose java_package (or, absent an override, package) resolves to
+// com.apple.foundationdb.record or com.apple.foundationdb.record.metadata -- revisit if those
+// java_outer_classname/java_package values change).
+tasks.withType(JavaCompile).configureEach {
+    options.compilerArgs += ['-Xmaxerrs', '100000']
+    options.errorprone {
+        disableAllChecks = true
+        error("NullAway")
+        option("NullAway:AnnotatedPackages", "com.apple.foundationdb.record")
+        option("NullAway:UnannotatedSubPackages", "com.apple.foundationdb.record.planprotos,com.apple.foundationdb.record.expressions,com.apple.foundationdb.record.query.plan.cascades.events.eventprotos,com.apple.foundationdb.record.evolution,com.apple.foundationdb.record.vector,com.apple.foundationdb.record.slidingwindowvector")
+        option("NullAway:ExcludedClasses", "com.apple.foundationdb.record.RecordMetaDataProto,com.apple.foundationdb.record.RecordCursorProto,com.apple.foundationdb.record.IndexBuildProto,com.apple.foundationdb.record.RecordMetaDataOptionsProto,com.apple.foundationdb.record.RecordPlannerConfigurationProto,com.apple.foundationdb.record.PendingWritesQueueProto,com.apple.foundationdb.record.TimeWindowLeaderboardProto,com.apple.foundationdb.record.ResolverStateProto,com.apple.foundationdb.record.RecordSortingProto,com.apple.foundationdb.record.StringInterningProto,com.apple.foundationdb.record.TupleFieldsProto,com.apple.foundationdb.record.provider.foundationdb.keyspace.KeySpaceProto,com.apple.foundationdb.record.TestRecords1Proto,com.apple.foundationdb.record.TestRecords3Proto,com.apple.foundationdb.record.TestRecords4Proto,com.apple.foundationdb.record.TestRecords4WrapperProto,com.apple.foundationdb.record.TestRecords5Proto,com.apple.foundationdb.record.TestRecordsBytesProto,com.apple.foundationdb.record.TestRecordsEnumProto,com.apple.foundationdb.record.TestRecordsGroupedParentChildProto,com.apple.foundationdb.record.TestRecordsJoinIndexProto,com.apple.foundationdb.record.TestRecordsMultiProto,com.apple.foundationdb.record.TestRecordsTextProto,com.apple.foundationdb.record.TestRecordsTupleFieldsProto,com.apple.foundationdb.record.TestRecordsWithHeaderProto,com.apple.foundationdb.record.TestRecordsWithUnionProto,com.apple.foundationdb.record.metadata.ExpressionTestsProto,com.apple.foundationdb.record.PendingWritesQueueTestProto,com.apple.foundationdb.record.TestDataTypesProto,com.apple.foundationdb.record.TestHierarchiesProto,com.apple.foundationdb.record.TestNoIndexesProto,com.apple.foundationdb.record.TestNoRecordTypesProto,com.apple.foundationdb.record.TestNoUnionEvolvedIllegalProto,com.apple.foundationdb.record.TestNoUnionEvolvedProto,com.apple.foundationdb.record.TestNoUnionEvolvedRenamedRecordTypeProto,com.apple.foundationdb.record.TestNoUnionProto,com.apple.foundationdb.record.TestRecords1EvolvedAgainProto,com.apple.foundationdb.record.TestRecords1EvolvedProto,com.apple.foundationdb.record.TestRecords1EvolvedWithMapProto,com.apple.foundationdb.record.TestRecords2Proto,com.apple.foundationdb.record.TestRecords6Proto,com.apple.foundationdb.record.TestRecords7Proto,com.apple.foundationdb.record.TestRecords8Proto,com.apple.foundationdb.record.TestRecordsBadUnion1Proto,com.apple.foundationdb.record.TestRecordsBadUnion2Proto,com.apple.foundationdb.record.TestRecordsBitmapProto,com.apple.foundationdb.record.TestRecordsChained1Proto,com.apple.foundationdb.record.TestRecordsChained2Proto,com.apple.foundationdb.record.TestRecordsDoubleNestedProto,com.apple.foundationdb.record.TestRecordsDoublyImportedMapHelperProto,com.apple.foundationdb.record.TestRecordsDoublyImportedMapProto,com.apple.foundationdb.record.TestRecordsDuplicateUnionFields,com.apple.foundationdb.record.TestRecordsDuplicateUnionFieldsReordered,com.apple.foundationdb.record.TestRecordsIdenticalTypesProto,com.apple.foundationdb.record.TestRecordsImplicitUsageNoUnionProto,com.apple.foundationdb.record.TestRecordsImplicitUsageProto,com.apple.foundationdb.record.TestRecordsImportedAndNewProto,com.apple.foundationdb.record.TestRecordsImportedMapProto,com.apple.foundationdb.record.TestRecordsImportFlatProto,com.apple.foundationdb.record.TestRecordsImportProto,com.apple.foundationdb.record.TestRecordsIndexCompatProto,com.apple.foundationdb.record.TestRecordsIndexFilteringProto,com.apple.foundationdb.record.TestRecordsLeaderboardProto,com.apple.foundationdb.record.TestRecordsMapsProto,com.apple.foundationdb.record.TestRecordsMarkedUnmarkedProto,com.apple.foundationdb.record.TestRecordsMultidimensionalProto,com.apple.foundationdb.record.TestRecordsNameClashProto,com.apple.foundationdb.record.TestRecordsNestedAsRecord,com.apple.foundationdb.record.TestRecordsNestedMapProto,com.apple.foundationdb.record.TestRecordsNoPrimaryKeyProto,com.apple.foundationdb.record.TestRecordsNulls2Proto,com.apple.foundationdb.record.TestRecordsNulls3ExplicitProto,com.apple.foundationdb.record.TestRecordsNulls3Proto,com.apple.foundationdb.record.TestRecordsOneOfProto,com.apple.foundationdb.record.TestRecordsParentChildRelationshipProto,com.apple.foundationdb.record.TestRecordsRankProto,com.apple.foundationdb.record.TestRecordsSwapProto,com.apple.foundationdb.record.TestRecordsTransformProto,com.apple.foundationdb.record.TestRecordsUnionMissingRecordProto,com.apple.foundationdb.record.TestRecordsUnionWithImportedNestedProto,com.apple.foundationdb.record.TestRecordsUnionWithNestedProto,com.apple.foundationdb.record.TestRecordsUnsigned1Proto,com.apple.foundationdb.record.TestRecordsUnsigned2Proto,com.apple.foundationdb.record.TestRecordsUnsigned3Proto,com.apple.foundationdb.record.TestRecordsUnsigned4Proto,com.apple.foundationdb.record.TestRecordsUnsigned5Proto,com.apple.foundationdb.record.TestRecordsUuidProto,com.apple.foundationdb.record.TestRequiredNestedRecordProto,com.apple.foundationdb.record.TestTwoUnionsProto,com.apple.foundationdb.record.TestUnionDefaultNameProto,com.apple.foundationdb.record.TypeTestProto")
+        option("NullAway:JSpecifyMode", "true")
+        option("NullAway:AcknowledgeRestrictiveAnnotations", "true")
+    }
+}
+
 // SIFT-small dataset (10k x 128-dim), used by GuardiannVectorIndexConcurrentMergeTest for a realistic
 // concurrent insert-vs-index-merge stress test. Mirrors fdb-extensions' siftsmall wiring: downloaded once
 // into the shared, clean-surviving asset cache (project.ext.downloadsDirectory), checksum-verified, and

fdb-record-layer-core/src/main/java/com/apple/foundationdb/record/AggregateFunctionNotSupportedException.java

@@ -20,15 +20,14 @@
 
 package com.apple.foundationdb.record;
 
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
+import org.jspecify.annotations.Nullable;
 
 /**
  * Exception thrown when an aggregate function is not supported.
  */
 @SuppressWarnings("serial")
 public class AggregateFunctionNotSupportedException extends RecordCoreException {
-    public AggregateFunctionNotSupportedException(@Nonnull String msg, @Nullable Object... keyValues) {
+    public AggregateFunctionNotSupportedException(String msg, @Nullable Object... keyValues) {
         super(msg, keyValues);
     }
 }

fdb-record-layer-core/src/main/java/com/apple/foundationdb/record/AsyncLoadingCache.java

@@ -25,7 +25,6 @@
 import com.google.common.cache.Cache;
 import com.google.common.cache.CacheBuilder;
 
-import javax.annotation.Nonnull;
 import java.time.Duration;
 import java.util.Optional;
 import java.util.concurrent.CompletableFuture;
@@ -52,12 +51,10 @@ public class AsyncLoadingCache<K, V> {
      */
     public static final long UNLIMITED = Long.MAX_VALUE;
 
-    @Nonnull
     private final Cache<K, Optional<V>> cache;
     private final long refreshTimeMillis;
     private final long deadlineTimeMillis;
     private final long maxSize;
-    @Nonnull
     private final ScheduledExecutorService scheduledExecutor;
 
     /**
@@ -68,7 +65,7 @@ public class AsyncLoadingCache<K, V> {
      * @param maxSize the maximum number of elements in the cache
      * @param scheduledExecutor a scheduled executor used to manage asynchronous deadlines
      */
-    public AsyncLoadingCache(long refreshTimeMillis, long deadlineTimeMillis, long maxSize, @Nonnull ScheduledExecutorService scheduledExecutor) {
+    public AsyncLoadingCache(long refreshTimeMillis, long deadlineTimeMillis, long maxSize, ScheduledExecutorService scheduledExecutor) {
         this.refreshTimeMillis = refreshTimeMillis;
         this.deadlineTimeMillis = deadlineTimeMillis;
         this.maxSize = maxSize;
@@ -95,8 +92,7 @@ public AsyncLoadingCache(long refreshTimeMillis, long deadlineTimeMillis, long m
      * @return a future containing either the cached value or the result from the supplier
      */
     @SuppressWarnings("squid:S2789") // comparison of null and optional used to differentiate absence of key and presence of null
-    @Nonnull
-    public CompletableFuture<V> orElseGet(@Nonnull K key, @Nonnull Supplier<CompletableFuture<V>> supplier) {
+    public CompletableFuture<V> orElseGet(K key, Supplier<CompletableFuture<V>> supplier) {
         try {
             Optional<V> cachedValue = cache.getIfPresent(key);
             if (cachedValue == null) {

fdb-record-layer-core/src/main/java/com/apple/foundationdb/record/Bindings.java

@@ -26,8 +26,7 @@
 import com.google.common.base.Verify;
 import com.google.common.collect.ImmutableList;
 
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
+import org.jspecify.annotations.Nullable;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -58,26 +57,25 @@ public enum Internal {
             this.value = value;
         }
 
-        public static boolean isInternal(@Nonnull String name) {
+        public static boolean isInternal(String name) {
             return name.startsWith(PREFIX);
         }
 
-        public boolean isOfType(@Nonnull String name) {
+        public boolean isOfType(String name) {
             return name.startsWith(value);
         }
 
-        public String bindingName(@Nonnull String suffix) {
+        public String bindingName(String suffix) {
             return value + suffix;
         }
 
-        public String identifier(@Nonnull String bindingName) {
+        public String identifier(String bindingName) {
             Verify.verify(bindingName.startsWith(value));
             return bindingName.substring(value.length());
         }
 
-        @Nonnull
         @SuppressWarnings("unused")
-        public PBindingKind toProto(@Nonnull final PlanSerializationContext serializationContext) {
+        public PBindingKind toProto(final PlanSerializationContext serializationContext) {
             switch (this) {
                 case IN:
                     return PBindingKind.IN;
@@ -92,9 +90,8 @@ public PBindingKind toProto(@Nonnull final PlanSerializationContext serializatio
             }
         }
 
-        @Nonnull
         @SuppressWarnings("unused")
-        public static Internal fromProto(@Nonnull final PlanSerializationContext serializationContext, @Nonnull final PBindingKind bindingKindProto) {
+        public static Internal fromProto(final PlanSerializationContext serializationContext, final PBindingKind bindingKindProto) {
             switch (bindingKindProto) {
                 case IN:
                     return IN;
@@ -110,7 +107,6 @@ public static Internal fromProto(@Nonnull final PlanSerializationContext seriali
         }
     }
 
-    @Nonnull
     private final Map<String, Object> values;
     @Nullable
     private final Bindings parent;
@@ -127,7 +123,7 @@ public Bindings() {
     }
 
     @Nullable
-    public Object get(@Nonnull String name) {
+    public Object get(String name) {
         if (values.containsKey(name)) {
             return values.get(name);
         } else if (parent != null) {
@@ -137,7 +133,7 @@ public Object get(@Nonnull String name) {
         }
     }
 
-    public boolean containsBinding(@Nonnull String name) {
+    public boolean containsBinding(String name) {
         if (values.containsKey(name)) {
             return true;
         } else if (parent != null) {
@@ -155,7 +151,6 @@ public Builder childBuilder() {
         return new Builder(this);
     }
 
-    @Nonnull
     public List<Map.Entry<String, Object>> asMappingList() {
         final ImmutableList.Builder<Map.Entry<String, Object>> resultBuilder = ImmutableList.builder();
         values.forEach((key, value) -> resultBuilder.add(Pair.of(key, value)));
@@ -177,7 +172,6 @@ public String toString() {
      * </code></pre>
      */
     public static class Builder {
-        @Nonnull
         private final Bindings bindings;
         private boolean built;
 
@@ -186,11 +180,11 @@ private Builder(@Nullable Bindings parent) {
         }
 
         @Nullable
-        public Object get(@Nonnull String name) {
+        public Object get(String name) {
             return bindings.get(name);
         }
 
-        public Builder set(@Nonnull String name, @Nullable Object value) {
+        public Builder set(String name, @Nullable Object value) {
             if (built) {
                 throw new RecordCoreException("Cannot change bindings after building");
             }
@@ -201,7 +195,6 @@ public Builder set(@Nonnull String name, @Nullable Object value) {
             return this;
         }
 
-        @Nonnull
         public Bindings build() {
             built = true;
             return bindings;

fdb-record-layer-core/src/main/java/com/apple/foundationdb/record/ByteArrayContinuation.java

@@ -25,33 +25,29 @@
 import com.google.protobuf.ByteString;
 import com.google.protobuf.ZeroCopyByteString;
 
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
+import org.jspecify.annotations.Nullable;
 import java.nio.ByteBuffer;
 
 /**
  * A shim to wrap old-style byte array continuations.
  */
 @API(API.Status.EXPERIMENTAL)
 public class ByteArrayContinuation implements RecordCursorContinuation {
-    @Nonnull
     private final byte[] bytes;
     @Nullable
     private ByteString byteString;
 
-    private ByteArrayContinuation(@Nonnull final byte[] bytes) {
+    private ByteArrayContinuation(final byte[] bytes) {
         this.bytes = bytes;
     }
 
-    @Nonnull
     @Override
     @SpotBugsSuppressWarnings("EI")
     public byte[] toBytes() {
         return bytes;
     }
 
     @Override
-    @Nonnull
     public ByteString toByteString() {
         if (byteString == null) {
             byteString = ZeroCopyByteString.wrap(bytes);
@@ -71,7 +67,7 @@ public boolean isEnd() {
      * @param bytes a nullable byte array representing a serialized continuation
      * @return a {@code RecordCursorContinuation} as described above
      */
-    @Nonnull
+    @SuppressWarnings("NullAway") // NullAway does not track the null-check above for byte[] type parameters
     public static RecordCursorContinuation fromNullable(@Nullable final byte[] bytes) {
         if (bytes == null) {
             return RecordCursorEndContinuation.END;
@@ -85,7 +81,6 @@ public static RecordCursorContinuation fromNullable(@Nullable final byte[] bytes
      * @param a an integer
      * @return a {@code ByteArrayContinuation} wrapping a byte array of the given integer
      */
-    @Nonnull
     public static RecordCursorContinuation fromInt(int a) {
         return new ByteArrayContinuation(ByteBuffer.allocate(Integer.BYTES).putInt(a).array());
     }

fdb-record-layer-core/src/main/java/com/apple/foundationdb/record/ByteScanLimiter.java

@@ -22,8 +22,6 @@
 
 import com.apple.foundationdb.annotation.API;
 
-import javax.annotation.Nonnull;
-
 /**
  * Track the number of bytes scanned up to some limit, after which record scans should not be allowed.
  *
@@ -36,7 +34,6 @@ public interface ByteScanLimiter {
      * {@link #hasBytesRemaining()} and {@link #registerScannedBytes(long)}.
      * @return a new {@code ByteScanLimiter} with this limiter's original limit
      */
-    @Nonnull
     ByteScanLimiter reset();
 
     /**

fdb-record-layer-core/src/main/java/com/apple/foundationdb/record/ByteScanLimiterFactory.java

@@ -22,7 +22,6 @@
 
 import com.apple.foundationdb.annotation.API;
 
-import javax.annotation.Nonnull;
 import java.util.concurrent.atomic.AtomicLong;
 
 /**
@@ -78,7 +77,6 @@ private Enforcing(long limit) {
         }
 
         @Override
-        @Nonnull
         public ByteScanLimiter reset() {
             return new Enforcing(originalLimit);
         }
@@ -122,7 +120,6 @@ private static class Tracking implements ByteScanLimiter {
         private final AtomicLong bytesScanned = new AtomicLong();
 
         @Override
-        @Nonnull
         public ByteScanLimiter reset() {
             return new Tracking();
         }
@@ -163,7 +160,6 @@ public String toString() {
      */
     private static class Untracked implements ByteScanLimiter {
         @Override
-        @Nonnull
         public ByteScanLimiter reset() {
             return this;
         }

fdb-record-layer-core/src/main/java/com/apple/foundationdb/record/EndpointType.java

@@ -22,8 +22,6 @@
 
 import com.apple.foundationdb.annotation.API;
 
-import javax.annotation.Nonnull;
-
 /**
  * The type of one of the endpoints of a {@link TupleRange}.
  * <p>
@@ -41,7 +39,6 @@ public enum EndpointType {
     PREFIX_STRING,
     CONTINUATION;
 
-    @Nonnull
     public String toString(boolean high) {
         switch (this) {
             case TREE_START: