fix:Serializing subreports to JSON only once even if the global repor…

…t is decorated.. Signed-off-by: Emmanuel Hugonnet <ehugonne@redhat.com>
RedHatInsights · Jul 21, 2023 · 5894e8c · 5894e8c
1 parent cf6ca7a
commit 5894e8c
Show file tree

Hide file tree

Showing 5 changed files with 66 additions and 6 deletions.
diff --git a/api/src/main/java/com/redhat/insights/AbstractTopLevelReportBase.java b/api/src/main/java/com/redhat/insights/AbstractTopLevelReportBase.java
@@ -4,6 +4,7 @@
 import com.fasterxml.jackson.databind.JsonSerializer;
 import com.redhat.insights.config.InsightsConfiguration;
 import com.redhat.insights.logging.InsightsLogger;
+import java.io.IOException;
 import java.lang.management.*;
 import java.net.InetAddress;
 import java.net.UnknownHostException;
@@ -80,6 +81,7 @@ public abstract class AbstractTopLevelReportBase implements InsightsReport {
   private final JsonSerializer<InsightsReport> serializer;
   private final InsightsLogger logger;
   private final InsightsConfiguration config;
+  private byte[] subReport;
 
   // Can't be set properly until after report has been generated
   private String idHash = "";
@@ -204,6 +206,19 @@ public void generateReport(Filtering masking) {
 
   protected abstract Package[] getPackages();
 
+  @Override
+  public byte[] getSubModulesReport() {
+    if (subReport == null) {
+      subReport = InsightsReport.super.getSubModulesReport();
+    }
+    return subReport;
+  }
+
+  @Override
+  public void close() throws IOException {
+    subReport = null;
+  }
+
   /**
    * This is the top-level name - implementors that may have to care about multi-tenancy should
    * handle that in product-specific code.

diff --git a/api/src/main/java/com/redhat/insights/InsightsReport.java b/api/src/main/java/com/redhat/insights/InsightsReport.java
@@ -3,8 +3,11 @@
 
 import static com.redhat.insights.InsightsErrorCode.ERROR_SERIALIZING_TO_JSON;
 
+import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.databind.JsonSerializer;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import java.io.ByteArrayOutputStream;
+import java.io.Closeable;
 import java.io.IOException;
 import java.util.Map;
 
@@ -13,7 +16,8 @@
  *
  * @see InsightsSubreport for runtime-specific sub-reports
  */
-public interface InsightsReport {
+public interface InsightsReport extends Closeable {
+  static final byte[] EMPTY_BYTE_ARRAY = new byte[0];
 
   Map<String, InsightsSubreport> getSubreports();
 
@@ -66,4 +70,34 @@ default String serialize() {
       throw new InsightsException(ERROR_SERIALIZING_TO_JSON, "JSON serialization exception", e);
     }
   }
+
+  /**
+   * Serializes this report to JSON for transport
+   *
+   * @return JSON serialized report
+   */
+  default byte[] getSubModulesReport() {
+    ObjectMapper mapper = ObjectMappers.createFor(this);
+
+    try (ByteArrayOutputStream out = new ByteArrayOutputStream();
+        JsonGenerator generator = mapper.writerWithDefaultPrettyPrinter().createGenerator(out)) {
+      generator.writeStartObject();
+      for (Map.Entry<String, InsightsSubreport> entry : getSubreports().entrySet()) {
+        generator.writeObjectField(entry.getKey(), entry.getValue());
+      }
+      generator.writeEndObject();
+      generator.flush();
+      byte[] report = out.toByteArray();
+      boolean notEmptyArray = report.length > 3;
+      if (notEmptyArray) {
+        byte[] finalReport = new byte[report.length - 1];
+        finalReport[0] = ',';
+        System.arraycopy(report, 1, finalReport, 1, report.length - 2);
+        return finalReport;
+      }
+      return EMPTY_BYTE_ARRAY;
+    } catch (IOException e) {
+      throw new InsightsException(ERROR_SERIALIZING_TO_JSON, "JSON serialization exception", e);
+    }
+  }
 }
diff --git a/api/src/main/java/com/redhat/insights/InsightsReportController.java b/api/src/main/java/com/redhat/insights/InsightsReportController.java
@@ -113,7 +113,15 @@ public void generate() {
             InsightsHttpClient httpClient = httpClientSupplier.get();
             if (httpClient.isReadyToSend()) {
               generateConnectReport();
-              httpClient.sendInsightsReport(getIdHash() + "_connect", report);
+              try {
+                httpClient.sendInsightsReport(getIdHash() + "_connect", report);
+              } finally {
+                try {
+                  report.close();
+                } catch (IOException ioex) {
+                  // Nothing to be done there
+                }
+              }
             } else {
               logger.debug("Insights is not configured to send: " + configuration);
             }

diff --git a/api/src/main/java/com/redhat/insights/InsightsReportSerializer.java b/api/src/main/java/com/redhat/insights/InsightsReportSerializer.java
@@ -5,7 +5,7 @@
 import com.fasterxml.jackson.databind.JsonSerializer;
 import com.fasterxml.jackson.databind.SerializerProvider;
 import java.io.IOException;
-import java.util.Map;
+import java.nio.charset.StandardCharsets;
 
 /** JSON serializer for an {@link InsightsReport} object. */
 public class InsightsReportSerializer extends JsonSerializer<InsightsReport> {
@@ -23,9 +23,8 @@ public void serialize(
     if (!insightsReport.getBasic().isEmpty()) {
       generator.writeObjectField("basic", insightsReport.getBasic());
     }
-    for (Map.Entry<String, InsightsSubreport> entry : insightsReport.getSubreports().entrySet()) {
-      generator.writeObjectField(entry.getKey(), entry.getValue());
-    }
+    byte[] subReport = insightsReport.getSubModulesReport();
+    generator.writeRaw(new String(subReport, StandardCharsets.UTF_8));
     generator.writeEndObject();
     generator.flush();
   }

diff --git a/api/src/main/java/com/redhat/insights/UpdateReportImpl.java b/api/src/main/java/com/redhat/insights/UpdateReportImpl.java
@@ -5,6 +5,7 @@
 import com.redhat.insights.jars.JarInfo;
 import com.redhat.insights.jars.JarInfoSubreport;
 import com.redhat.insights.logging.InsightsLogger;
+import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
@@ -77,4 +78,7 @@ public void decorate(String key, String value) {
     logger.debug(
         String.format("Attempt to add %s => %s to an update report. Ignored.", key, value));
   }
+
+  @Override
+  public void close() throws IOException {}
 }