Serialization of Type Change Suggestions for Type Violations.

nullaway/src/main/java/com/uber/nullaway/Config.java

@@ -39,8 +39,10 @@ public interface Config {
   boolean serializationIsActive();
 
   /**
-   * Getter method for {@link FixSerializationConfig}. Fix Serialization feature must be activated,
-   * otherwise calling this method will fail the execution.
+   * Getter method for {@link FixSerializationConfig}.
+   *
+   * <p>Fix Serialization feature must be activated, otherwise calling this method will fail the
+   * execution.
    *
    * @return {@link FixSerializationConfig} instance in Config.
    */

nullaway/src/main/java/com/uber/nullaway/ErrorBuilder.java

@@ -52,7 +52,7 @@
 import com.sun.tools.javac.tree.JCTree.JCCompilationUnit;
 import com.sun.tools.javac.util.DiagnosticSource;
 import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition;
-import com.uber.nullaway.fixserialization.SerializationHandler;
+import com.uber.nullaway.fixserialization.SerializationService;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Set;
@@ -137,9 +137,9 @@ public Description createErrorDescription(
 
     if (config.serializationIsActive()) {
       if (nonNullTarget != null) {
-        SerializationHandler.serializeFixSuggestion(config, state, nonNullTarget, errorMessage);
+        SerializationService.serializeFixSuggestion(config, state, nonNullTarget, errorMessage);
       }
-      SerializationHandler.serializeReportingError(config, state, errorMessage);
+      SerializationService.serializeReportingError(config, state, errorMessage);
     }
 
     // #letbuildersbuild
@@ -369,7 +369,7 @@ void reportInitializerError(
       // separately
       nonNullFields.forEach(
           symbol ->
-              SerializationHandler.serializeFixSuggestion(config, state, symbol, errorMessage));
+              SerializationService.serializeFixSuggestion(config, state, symbol, errorMessage));
     }
   }
 

nullaway/src/main/java/com/uber/nullaway/NullAway.java

@@ -1514,15 +1514,12 @@ private void checkFieldInitialization(ClassTree tree, VisitorState state) {
     }
     for (Element constructorElement : errorFieldsForInitializer.keySet()) {
       ImmutableList<Symbol> fieldSymbols =
-          ImmutableList.<Symbol>builder()
-              .addAll(
-                  errorFieldsForInitializer
-                      .get(constructorElement)
-                      .stream()
-                      .map(
-                          element -> ASTHelpers.getSymbol(getTreesInstance(state).getTree(element)))
-                      .collect(Collectors.toList()))
-              .build();
+          errorFieldsForInitializer
+              .get(constructorElement)
+              .stream()
+              .map(element -> ASTHelpers.getSymbol(getTreesInstance(state).getTree(element)))
+              .collect(ImmutableList.toImmutableList());
+
       errorBuilder.reportInitializerError(
           (Symbol.MethodSymbol) constructorElement,
           errMsgForInitializer(errorFieldsForInitializer.get(constructorElement), state),

nullaway/src/main/java/com/uber/nullaway/fixserialization/SerializationHandler.java → nullaway/src/main/java/com/uber/nullaway/fixserialization/SerializationService.java

@@ -36,7 +36,7 @@
 import com.uber.nullaway.fixserialization.out.SuggestedFixInfo;
 
 /** A facade class to interact with fix serialization package. */
-public class SerializationHandler {
+public class SerializationService {
 
   /**
    * Serializes the suggested type change of an element in the source code that can resolve the

nullaway/src/main/java/com/uber/nullaway/fixserialization/XMLUtil.java

@@ -43,11 +43,12 @@
 public class XMLUtil {
 
   /**
-   * Helper method for reading attributes of node located at /key_1/key_2/.../key_n from a {@link
-   * Document}.
+   * Helper method for reading attributes of node located at /key_1/key_2/.../key_n (in the form of
+   * {@code Xpath} query) from a {@link Document}.
    *
    * @param doc XML object to read values from.
-   * @param key Key to locate the value, can be nested (e.g. /key1/key2:.../key_n).
+   * @param key Key to locate the value, can be nested in the form of {@code Xpath} query (e.g.
+   *     /key1/key2:.../key_n).
    * @param klass Class type of the value in doc.
    * @return The value in the specified keychain cast to the class type given in parameter.
    */
@@ -67,11 +68,12 @@ public static <T> DefaultXMLValueProvider<T> getValueFromAttribute(
   }
 
   /**
-   * Helper method for reading value of a node located at /key_1/key_2:.../key_n from a {@link
-   * Document}.
+   * Helper method for reading value of a node located at /key_1/key_2/.../key_n (in the form of
+   * {@code Xpath} query) from a {@link Document}.
    *
    * @param doc XML object to read values from.
-   * @param key Key to locate the value, can be nested (e.g. /key1/key2:.../key_n).
+   * @param key Key to locate the value, can be nested in the form of {@code Xpath} query (e.g.
+   *     /key1/key2/.../key_n).
    * @param klass Class type of the value in doc.
    * @return The value in the specified keychain cast to the class type given in parameter.
    */

nullaway/src/main/java/com/uber/nullaway/fixserialization/location/MethodParameterLocation.java

@@ -42,8 +42,8 @@ public MethodParameterLocation(Symbol target) {
     Symbol cursor = target;
     // Look for the enclosing method.
     while (cursor != null
-        && (cursor.getKind() != ElementKind.CONSTRUCTOR
-            && cursor.getKind() != ElementKind.METHOD)) {
+        && cursor.getKind() != ElementKind.CONSTRUCTOR
+        && cursor.getKind() != ElementKind.METHOD) {
       cursor = cursor.owner;
     }
     Preconditions.checkNotNull(cursor);

nullaway/src/test/java/com/uber/nullaway/NullAwaySerializationTest.java

@@ -158,27 +158,27 @@ public void add_nullable_param_simple() {
                 "-XepOpt:NullAway:SerializeFixMetadata=true",
                 "-XepOpt:NullAway:FixSerializationConfigPath=" + configPath))
         .addSourceLines(
-            "com/uber/android/Super.java",
+            "com/uber/android/Test.java",
             "package com.uber;",
             "import javax.annotation.Nullable;",
             "import javax.annotation.Nonnull;",
-            "public class Super {",
-            "   Object test(int i, Object h) {",
+            "public class Test {",
+            "   Object run(int i, Object h) {",
             "     return h;",
             "   }",
             "   Object test_param(@Nullable String o) {",
-            "   // BUG: Diagnostic contains: passing @Nullable",
-            "     return test(0, o);",
+            "     // BUG: Diagnostic contains: passing @Nullable",
+            "     return run(0, o);",
             "   }",
             "}")
         .setExpectedFixes(
             new FixDisplay(
                 "javax.annotation.Nullable",
-                "test(int,java.lang.Object)",
+                "run(int,java.lang.Object)",
                 "h",
                 "PARAMETER",
-                "com.uber.Super",
-                "com/uber/android/Super.java"))
+                "com.uber.Test",
+                "com/uber/android/Test.java"))
         .doTest();
   }
 
@@ -289,7 +289,7 @@ public void add_nullable_param_generics() {
             "import java.util.ArrayList;",
             "public class Child extends Super<String>{",
             "   public void newSideEffect(ArrayList<String> op) {",
-            "   // BUG: Diagnostic contains: passing @Nullable",
+            "     // BUG: Diagnostic contains: passing @Nullable",
             "     newStatement(null, op, true, true);",
             "   }",
             "}")

nullaway/src/test/java/com/uber/nullaway/tools/SerializationTestHelper.java

@@ -97,20 +97,24 @@ private void compareFixes(FixDisplay[] outputFixDisplays) {
     if (notFound.size() == 0 && output.size() == 0) {
       return;
     }
+    StringBuilder errorMessage = new StringBuilder();
     if (notFound.size() != 0) {
-      fail(
-          notFound.size()
-              + " expected fix suggestions were NOT found:"
-              + "\n"
-              + notFound.stream().map(FixDisplay::toString).collect(Collectors.toList())
-              + "\n");
+      errorMessage
+          .append(notFound.size())
+          .append(" expected fix suggestions were NOT found:")
+          .append("\n")
+          .append(notFound.stream().map(FixDisplay::toString).collect(Collectors.toList()))
+          .append("\n");
     }
-    fail(
-        output.size()
-            + " unexpected fix(s) suggestions were found:"
-            + "\n"
-            + output.stream().map(FixDisplay::toString).collect(Collectors.toList())
-            + "\n");
+    if (output.size() != 0) {
+      errorMessage
+          .append(output.size())
+          .append(" unexpected fix(s) suggestions were found:")
+          .append("\n")
+          .append(output.stream().map(FixDisplay::toString).collect(Collectors.toList()))
+          .append("\n");
+    }
+    fail(errorMessage.toString());
   }
 
   private FixDisplay[] readOutputFixes() {
@@ -123,7 +127,7 @@ private FixDisplay[] readOutputFixes() {
         fail(
             "Expected header of fixes.tsv to be: "
                 + SuggestedFixInfo.header()
-                + "\bBut found: "
+                + "\nBut found: "
                 + header);
       }
       String line = reader.readLine();
@@ -137,8 +141,7 @@ private FixDisplay[] readOutputFixes() {
       }
       reader.close();
     } catch (IOException e) {
-      e.printStackTrace();
-      throw new RuntimeException("Error happened in reading the fixDisplays.");
+      throw new RuntimeException("Error happened in reading the fixDisplays.", e);
     }
     return fixDisplays.toArray(new FixDisplay[0]);
   }