enabling ErrorProne and NullAway with initial fixes

google · Nov 19, 2024 · 46327df · 46327df
1 parent ea7d0fe
commit 46327df
Show file tree

Hide file tree

Showing 22 changed files with 3,646 additions and 86 deletions.
diff --git a/bunsen/bunsen-core/src/main/java/com/cerner/bunsen/definitions/StructureDefinitions.java b/bunsen/bunsen-core/src/main/java/com/cerner/bunsen/definitions/StructureDefinitions.java
@@ -323,7 +323,7 @@ private <T> List<StructureField<T>> elementToFields(
           //  we don't reset the stack, then we should handle null returns.
           T child = transform(visitor, element, structureDefinition, new ArrayDeque<>());
           Verify.verify(
-              child != null, "Unexpected null choice type {} for element {}", typeCode, element);
+              child != null, "Unexpected null choice type %s for element %s", typeCode, element);
           choiceTypes.put(typeCode, child);
         }
       }

diff --git a/doc/developers.md b/doc/developers.md
@@ -130,3 +130,18 @@ To regenerate this jar file:
 
     NOTE: Parquet tools will be replaced with parquet cli in the next release
     `apache-parquet-1.12.0`
+
+## Error Prone and NullAway
+We use [Error Prone](https://errorprone.info/index) and
+[NullAway](https://github.com/uber/NullAway) to catch common issues at build
+time, in particular `NullPointerException`s. These are enabled in
+[pom.xml](../pipelines/pom.xml) according to
+[installation instructions](https://errorprone.info/docs/installation#maven).
+An unfortunate side effect of this is that we need manually add all annotation
+processors that we care about as discussed
+[here](https://errorprone.info/docs/installation#using-error-prone-together-with-other-annotation-processors).
+
+Currently, these errors only appear as WARNING and are not blockers but please
+take a look at the new ones caused by your changes and fix them as we are trying
+to address all of these, gradually. You can enable Error Prone in your IDE too,
+see [here](https://errorprone.info/docs/installation#intellij-idea).
diff --git a/pipelines/batch/src/main/java/com/google/fhir/analytics/BulkExportUtil.java b/pipelines/batch/src/main/java/com/google/fhir/analytics/BulkExportUtil.java
@@ -21,9 +21,9 @@
 import com.google.fhir.analytics.model.BulkExportResponse;
 import java.io.IOException;
 import java.util.List;
-import javax.annotation.Nullable;
 import org.apache.commons.collections.CollectionUtils;
 import org.apache.http.HttpStatus;
+import org.jspecify.annotations.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 

diff --git a/pipelines/batch/src/main/java/com/google/fhir/analytics/FetchSearchPageFn.java b/pipelines/batch/src/main/java/com/google/fhir/analytics/FetchSearchPageFn.java
@@ -28,7 +28,6 @@
 import java.io.IOException;
 import java.sql.SQLException;
 import java.util.Set;
-import javax.annotation.Nullable;
 import javax.sql.DataSource;
 import org.apache.beam.sdk.metrics.Counter;
 import org.apache.beam.sdk.metrics.Metrics;
@@ -37,6 +36,7 @@
 import org.hl7.fhir.r4.model.Bundle;
 import org.hl7.fhir.r4.model.Bundle.BundleEntryComponent;
 import org.hl7.fhir.r4.model.Resource;
+import org.jspecify.annotations.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 

diff --git a/pipelines/batch/src/main/java/com/google/fhir/analytics/HapiRowDescriptor.java b/pipelines/batch/src/main/java/com/google/fhir/analytics/HapiRowDescriptor.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2023 Google LLC
+ * Copyright 2020-2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,10 +18,10 @@
 import com.google.auto.value.AutoValue;
 import java.io.Serializable;
 import java.util.List;
-import javax.annotation.Nullable;
 import lombok.Data;
 import org.apache.beam.sdk.coders.DefaultCoder;
 import org.apache.beam.sdk.coders.SerializableCoder;
+import org.jspecify.annotations.Nullable;
 
 @DefaultCoder(SerializableCoder.class)
 @AutoValue

diff --git a/pipelines/batch/src/main/java/com/google/fhir/analytics/ParquetMerger.java b/pipelines/batch/src/main/java/com/google/fhir/analytics/ParquetMerger.java
@@ -32,7 +32,6 @@
 import java.util.Iterator;
 import java.util.List;
 import java.util.Set;
-import javax.annotation.Nullable;
 import org.apache.avro.Schema;
 import org.apache.avro.generic.GenericRecord;
 import org.apache.beam.sdk.Pipeline;
@@ -56,6 +55,7 @@
 import org.apache.beam.sdk.values.TupleTag;
 import org.apache.parquet.hadoop.metadata.CompressionCodecName;
 import org.hl7.fhir.r4.model.codesystems.ActionType;
+import org.jspecify.annotations.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 

diff --git a/pipelines/batch/src/main/java/com/google/fhir/analytics/metrics/FlinkJobListener.java b/pipelines/batch/src/main/java/com/google/fhir/analytics/metrics/FlinkJobListener.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2023 Google LLC
+ * Copyright 2020-2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,11 +15,11 @@
  */
 package com.google.fhir.analytics.metrics;
 
-import javax.annotation.Nullable;
 import org.apache.beam.runners.flink.FlinkRunner;
 import org.apache.flink.api.common.JobExecutionResult;
 import org.apache.flink.core.execution.JobClient;
 import org.apache.flink.core.execution.JobListener;
+import org.jspecify.annotations.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 

diff --git a/pipelines/batch/src/main/java/com/google/fhir/analytics/metrics/PipelineMetricsProvider.java b/pipelines/batch/src/main/java/com/google/fhir/analytics/metrics/PipelineMetricsProvider.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2023 Google LLC
+ * Copyright 2020-2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,8 +15,8 @@
  */
 package com.google.fhir.analytics.metrics;
 
-import javax.annotation.Nullable;
 import org.apache.beam.sdk.PipelineRunner;
+import org.jspecify.annotations.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -41,8 +41,7 @@ public static PipelineMetrics getPipelineMetrics(Class<? extends PipelineRunner>
       return flinkPipelineMetrics;
     } else {
       logger.warn(
-          "Metrics is not supported for the pipeline runner {}",
-          pipelineRunner.getClass().getSimpleName());
+          "Metrics is not supported for the pipeline runner {}", pipelineRunner.getSimpleName());
       return null;
     }
   }

diff --git a/pipelines/batch/src/test/java/com/google/fhir/analytics/ReadJsonFromFileTest.java b/pipelines/batch/src/test/java/com/google/fhir/analytics/ReadJsonFromFileTest.java
@@ -27,13 +27,13 @@
 import java.nio.channels.ReadableByteChannel;
 import java.sql.SQLException;
 import java.util.Set;
-import javax.annotation.Nullable;
 import org.apache.beam.sdk.io.FileIO;
 import org.apache.beam.sdk.io.FileSystems;
 import org.apache.beam.sdk.io.fs.ResourceId;
 import org.apache.beam.sdk.options.PipelineOptionsFactory;
 import org.hl7.fhir.r4.model.Bundle;
 import org.hl7.fhir.r4.model.Observation;
+import org.jspecify.annotations.Nullable;
 import org.junit.After;
 import org.junit.Test;
 import org.junit.runner.RunWith;