Add AdditionalSuppressionNames configuration option (#1231)

scordio · web-flow · commit de6b68041c97 · 2025-07-23T16:27:57.000Z
Prior to this change, NullAway could be skipped only with an explicit `@SuppressWarnings("NullAway")` annotation. However, existing inspections like `DataFlowIssue` by JetBrains imply that NullAway should be skipped too. With this change, NullAway can be configured to back off when additional names are present, via the `SuppressionNameAliases` configuration option. * Closes #1230
diff --git a/nullaway/src/main/java/com/uber/nullaway/Config.java b/nullaway/src/main/java/com/uber/nullaway/Config.java
@@ -240,6 +240,13 @@ public interface Config {
    */
   @Nullable String getCastToNonNullMethod();
 
+  /**
+   * Gets the suppression name aliases.
+   *
+   * @return the name aliases that should be honored as part of a @SuppressWarnings annotation.
+   */
+  Set<String> getSuppressionNameAliases();
+
   /**
    * Gets an optional comment to add to auto-fix suppressions.
    *
diff --git a/nullaway/src/main/java/com/uber/nullaway/DummyOptionsConfig.java b/nullaway/src/main/java/com/uber/nullaway/DummyOptionsConfig.java
@@ -179,6 +179,11 @@ public Set<String> getOptionalClassPaths() {
     throw new IllegalStateException(ERROR_MESSAGE);
   }
 
+  @Override
+  public Set<String> getSuppressionNameAliases() {
+    throw new IllegalStateException(ERROR_MESSAGE);
+  }
+
   @Override
   public String getAutofixSuppressionComment() {
     throw new IllegalStateException(ERROR_MESSAGE);
diff --git a/nullaway/src/main/java/com/uber/nullaway/ErrorProneCLIFlagsConfig.java b/nullaway/src/main/java/com/uber/nullaway/ErrorProneCLIFlagsConfig.java
@@ -79,6 +79,7 @@ final class ErrorProneCLIFlagsConfig implements Config {
   static final String FL_OPTIONAL_CLASS_PATHS =
       EP_FL_NAMESPACE + ":CheckOptionalEmptinessCustomClasses";
   static final String FL_SUPPRESS_COMMENT = EP_FL_NAMESPACE + ":AutoFixSuppressionComment";
+  static final String FL_SUPPRESS_NAMES = EP_FL_NAMESPACE + ":SuppressionNameAliases";
 
   static final String FL_SKIP_LIBRARY_MODELS = EP_FL_NAMESPACE + ":IgnoreLibraryModelsFor";
 
@@ -228,6 +229,7 @@ final class ErrorProneCLIFlagsConfig implements Config {
   private final ImmutableSet<String> contractAnnotations;
   private final @Nullable String castToNonNullMethod;
   private final String autofixSuppressionComment;
+  private final ImmutableSet<String> suppressionNameAliases;
   private final ImmutableSet<String> skippedLibraryModels;
   private final ImmutableSet<String> extraFuturesClasses;
 
@@ -313,6 +315,7 @@ final class ErrorProneCLIFlagsConfig implements Config {
       throw new IllegalStateException(
           "Invalid -XepOpt:" + FL_SUPPRESS_COMMENT + " value. Comment must be single line.");
     }
+    suppressionNameAliases = getFlagStringSet(flags, FL_SUPPRESS_NAMES);
     skippedLibraryModels = getFlagStringSet(flags, FL_SKIP_LIBRARY_MODELS);
     extraFuturesClasses = getFlagStringSet(flags, FL_EXTRA_FUTURES);
 
@@ -534,6 +537,11 @@ public boolean assertsEnabled() {
     return castToNonNullMethod;
   }
 
+  @Override
+  public ImmutableSet<String> getSuppressionNameAliases() {
+    return suppressionNameAliases;
+  }
+
   @Override
   public String getAutofixSuppressionComment() {
     if (autofixSuppressionComment.trim().length() > 0) {
diff --git a/nullaway/src/main/java/com/uber/nullaway/NullAway.java b/nullaway/src/main/java/com/uber/nullaway/NullAway.java
@@ -23,7 +23,6 @@
 package com.uber.nullaway;
 
 import static com.google.errorprone.BugPattern.SeverityLevel.WARNING;
-import static com.sun.source.tree.Tree.Kind.IDENTIFIER;
 import static com.sun.source.tree.Tree.Kind.OTHER;
 import static com.uber.nullaway.ASTHelpersBackports.hasDirectAnnotationWithSimpleName;
 import static com.uber.nullaway.ASTHelpersBackports.isStatic;
@@ -306,7 +305,14 @@ public NullAway(ErrorProneFlags flags) {
     config = new ErrorProneCLIFlagsConfig(flags);
     handler = Handlers.buildDefault(config);
     nonAnnotatedMethod = this::isMethodUnannotated;
-    errorBuilder = new ErrorBuilder(config, canonicalName(), allNames());
+    Set<String> allSuppressionNames =
+        config.getSuppressionNameAliases().isEmpty()
+            ? allNames()
+            : ImmutableSet.<String>builder()
+                .addAll(allNames())
+                .addAll(config.getSuppressionNameAliases())
+                .build();
+    errorBuilder = new ErrorBuilder(config, canonicalName(), allSuppressionNames);
   }
 
   private boolean isMethodUnannotated(MethodInvocationNode invocationNode) {
diff --git a/nullaway/src/test/java/com/uber/nullaway/SuppressionNameAliasesTests.java b/nullaway/src/test/java/com/uber/nullaway/SuppressionNameAliasesTests.java
@@ -0,0 +1,37 @@
+package com.uber.nullaway;
+
+import java.util.Arrays;
+import org.junit.Test;
+
+public class SuppressionNameAliasesTests extends NullAwayTestsBase {
+
+  @Test
+  public void additionalSuppressionNamesTest() {
+    makeTestHelperWithArgs(
+            Arrays.asList(
+                "-d",
+                temporaryFolder.getRoot().getAbsolutePath(),
+                "-XepOpt:NullAway:AnnotatedPackages=com.uber",
+                "-XepOpt:NullAway:SuppressionNameAliases=Foo,Bar"))
+        .addSourceLines(
+            "Test.java",
+            "package com.uber;",
+            "import org.jspecify.annotations.Nullable;",
+            "class Test {",
+            "  @SuppressWarnings(\"Foo\")",
+            "  void foo(@Nullable Object o) {",
+            "    o.getClass();",
+            "  }",
+            "  @SuppressWarnings(\"Bar\")",
+            "  void bar(@Nullable Object o) {",
+            "    o.getClass();",
+            "  }",
+            "  @SuppressWarnings(\"Baz\")",
+            "  void baz(@Nullable Object o) {",
+            "    // BUG: Diagnostic contains: dereferenced expression o is @Nullable",
+            "    o.getClass();",
+            "  }",
+            "}")
+        .doTest();
+  }
+}
