Enable semantic checking for @MustBeClosed with RefCounted holders an…

…d streams Signed-off-by: Andre Kurait <[email protected]>
opensearch-project · Apr 23, 2024 · 06d0417 · 06d0417
1 parent 103c6a0
commit 06d0417
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 0 deletions.
diff --git a/TrafficCapture/build.gradle b/TrafficCapture/build.gradle
@@ -12,6 +12,22 @@ allprojects {
 subprojects {
     apply plugin: 'java'
     apply plugin: 'maven-publish'
+
+    // TODO: Expand to do more static checking in more projects
+    if (project.name == "trafficReplayer" || project.name == "trafficCaptureProxyServer") {
+        dependencies {
+            annotationProcessor group: 'com.google.errorprone', name: 'error_prone_core', version: '2.26.1'
+        }
+        tasks.named('compileJava', JavaCompile) {
+            if (project.name == "trafficReplayer" || project.name == "trafficCaptureProxyServer") {
+                options.compilerArgs += [
+                        "-XDcompilePolicy=simple",
+                        "-Xplugin:ErrorProne -XepDisableAllChecks -Xep:MustBeClosed:ERROR -XepDisableWarningsInGeneratedCode",
+                ]
+            }
+        }
+    }
+
     task javadocJar(type: Jar, dependsOn: javadoc) {
         archiveClassifier.set('javadoc')
         from javadoc.destinationDir

diff --git a/...pture/trafficReplayer/src/main/java/org/opensearch/migrations/replay/util/NettyUtils.java b/...pture/trafficReplayer/src/main/java/org/opensearch/migrations/replay/util/NettyUtils.java
@@ -1,16 +1,19 @@
 package org.opensearch.migrations.replay.util;
 
+import com.google.errorprone.annotations.MustBeClosed;
 import io.netty.buffer.ByteBuf;
 import io.netty.buffer.Unpooled;
 import java.util.Collection;
 
 import java.util.stream.Stream;
 
 public final class NettyUtils {
+    @MustBeClosed
     public static Stream<ByteBuf> createCloseableByteBufStream(Stream<byte[]> byteArrStream) {
         return RefSafeStreamUtils.refSafeMap(byteArrStream, Unpooled::wrappedBuffer);
     }
 
+    @MustBeClosed
     public static Stream<ByteBuf> createCloseableByteBufStream(Collection<byte[]> byteArrCollection) {
         return createCloseableByteBufStream(byteArrCollection.stream());
     }

diff --git a/...re/trafficReplayer/src/main/java/org/opensearch/migrations/replay/util/RefSafeHolder.java b/...re/trafficReplayer/src/main/java/org/opensearch/migrations/replay/util/RefSafeHolder.java
@@ -1,5 +1,6 @@
 package org.opensearch.migrations.replay.util;
 
+import com.google.errorprone.annotations.MustBeClosed;
 import io.netty.util.ReferenceCountUtil;
 import javax.annotation.Nullable;
 
@@ -10,6 +11,7 @@ private RefSafeHolder(@Nullable T resource) {
         this.resource = resource;
     }
 
+    @MustBeClosed
     static public <T> RefSafeHolder<T> create(@Nullable T resource) {
         return new RefSafeHolder<>(resource);
     }

diff --git a/...afficReplayer/src/main/java/org/opensearch/migrations/replay/util/RefSafeStreamUtils.java b/...afficReplayer/src/main/java/org/opensearch/migrations/replay/util/RefSafeStreamUtils.java
@@ -1,12 +1,14 @@
 package org.opensearch.migrations.replay.util;
 
+import com.google.errorprone.annotations.MustBeClosed;
 import io.netty.util.ReferenceCounted;
 import java.util.ArrayDeque;
 import java.util.Deque;
 import java.util.function.Function;
 import java.util.stream.Stream;
 
 public final class RefSafeStreamUtils {
+    @MustBeClosed
     public static <T, R extends ReferenceCounted> Stream<R> refSafeMap(Stream<T> inputStream,
         Function<T, R> referenceTrackedMappingFunction) {
         final Deque<R> refCountedTracker = new ArrayDeque<>();