Encode json payload as string instead of byte[] (#1014)

* Encode json payload as string instead of byte[]

Author: rlazo

transport/transport-backend-cct/src/main/java/com/google/android/datatransport/cct/CctTransportBackend.java

@@ -53,6 +53,7 @@
 import java.nio.ByteBuffer;
 import java.nio.channels.Channels;
 import java.nio.channels.WritableByteChannel;
+import java.nio.charset.Charset;
 import java.util.ArrayList;
 import java.util.Calendar;
 import java.util.HashMap;
@@ -211,7 +212,8 @@ private BatchedLogRequest getRequestBody(BackendRequest backendRequest) {
         if (encoding.equals(Encoding.of("proto"))) {
           event = LogEvent.protoBuilder(encodedPayload.getBytes());
         } else if (encoding.equals(Encoding.of("json"))) {
-          event = LogEvent.jsonBuilder(encodedPayload.getBytes());
+          event =
+              LogEvent.jsonBuilder(new String(encodedPayload.getBytes(), Charset.forName("UTF-8")));
         } else {
           Logging.w(LOG_TAG, "Received event of unsupported encoding %s. Skipping...", encoding);
           continue;

transport/transport-backend-cct/src/main/java/com/google/android/datatransport/cct/internal/LogEvent.java

@@ -33,7 +33,7 @@ public abstract class LogEvent {
 
   @SuppressWarnings("mutable")
   @Nullable
-  public abstract byte[] getSourceExtensionJsonProto3Bytes();
+  public abstract String getSourceExtensionJsonProto3();
 
   public abstract long getTimezoneOffsetSeconds();
 
@@ -46,8 +46,8 @@ public static Builder protoBuilder(@NonNull byte[] sourceExtension) {
   }
 
   @NonNull
-  public static Builder jsonBuilder(@NonNull byte[] sourceJsonExtension) {
-    return builder().setSourceExtensionJsonProto3Bytes(sourceJsonExtension);
+  public static Builder jsonBuilder(@NonNull String sourceJsonExtension) {
+    return builder().setSourceExtensionJsonProto3(sourceJsonExtension);
   }
 
   private static Builder builder() {
@@ -69,7 +69,7 @@ public abstract static class Builder {
     abstract Builder setSourceExtension(@Nullable byte[] value);
 
     @NonNull
-    abstract Builder setSourceExtensionJsonProto3Bytes(@Nullable byte[] value);
+    abstract Builder setSourceExtensionJsonProto3(@Nullable String value);
 
     @NonNull
     public abstract Builder setTimezoneOffsetSeconds(long value);

transport/transport-backend-cct/src/main/java/com/google/android/datatransport/cct/internal/LogEventEncoder.java

@@ -34,9 +34,8 @@ public void encode(
     if (obj.getSourceExtension() != null) {
       objectEncoderContext.add("sourceExtension", obj.getSourceExtension());
     }
-    if (obj.getSourceExtensionJsonProto3Bytes() != null) {
-      objectEncoderContext.add(
-          "sourceExtensionJsonProto3", obj.getSourceExtensionJsonProto3Bytes());
+    if (obj.getSourceExtensionJsonProto3() != null) {
+      objectEncoderContext.add("sourceExtensionJsonProto3", obj.getSourceExtensionJsonProto3());
     }
     if (obj.getEventCode() != Integer.MIN_VALUE) {
       objectEncoderContext.add("eventCode", obj.getEventCode());

transport/transport-backend-cct/src/test/java/com/google/android/datatransport/cct/CctTransportBackendTest.java

@@ -65,7 +65,7 @@ public class CctTransportBackendTest {
       ByteString.copyFrom("TelemetryData".getBytes(Charset.defaultCharset()));
   private static final String PAYLOAD_BYTE64 = "VGVsZW1ldHJ5RGF0YQ==";
   private static final String JSON_PAYLOAD = "{\"hello\": false}";
-  private static final String JSON_PAYLOAD_BYTE64 = "eyJoZWxsbyI6IGZhbHNlfQ==";
+  private static final String JSON_PAYLOAD_ESCAPED = "{\\\"hello\\\": false}";
   private static final int CODE = 5;
   private static final String TEST_NAME = "hello";
   private static final Encoding PROTOBUF_ENCODING = Encoding.of("proto");
@@ -185,7 +185,7 @@ public void testCCTSuccessLoggingRequest() {
                 matchingJsonPath(
                     String.format(
                         "$[?(@.logRequest[0].logEvent[1].sourceExtensionJsonProto3 == \"%s\")]",
-                        JSON_PAYLOAD_BYTE64))));
+                        JSON_PAYLOAD_ESCAPED))));
 
     assertEquals(BackendResponse.ok(3), response);
   }

transport/transport-backend-cct/src/test/java/com/google/android/datatransport/cct/internal/LogRequestTest.java

@@ -60,18 +60,13 @@ public void testBuildNetworkConnectionInfo_mobileSubtypeOnly() {
 
   @Test
   public void testBuildLogEvent_missingFields() {
-    Assert.assertThrows(
-        IllegalStateException.class, () -> LogEvent.jsonBuilder(EMPTY_BYTE_ARRAY).build());
+    Assert.assertThrows(IllegalStateException.class, () -> LogEvent.jsonBuilder("").build());
     Assert.assertThrows(
         IllegalStateException.class,
         () -> LogEvent.protoBuilder(EMPTY_BYTE_ARRAY).setEventTimeMs(4500).build());
     Assert.assertThrows(
         IllegalStateException.class,
-        () ->
-            LogEvent.jsonBuilder(EMPTY_BYTE_ARRAY)
-                .setEventTimeMs(4500)
-                .setEventUptimeMs(10000)
-                .build());
+        () -> LogEvent.jsonBuilder("").setEventTimeMs(4500).setEventUptimeMs(10000).build());
   }
 
   @Test
@@ -83,27 +78,26 @@ public void testBuildLogEvent_withSourceExtension() {
             .setEventUptimeMs(10000)
             .setTimezoneOffsetSeconds(29L)
             .build();
-    assertThat(event.getSourceExtensionJsonProto3Bytes()).isNull();
+    assertThat(event.getSourceExtensionJsonProto3()).isNull();
     assertThat(event.getSourceExtension()).isEqualTo(sourceExtension);
   }
 
   @Test
   public void testBuildLogEvent_withJsonSourceExtension() {
-    byte[] sourceExtension = "myJsonExtension".getBytes(Charset.forName("UTF-8"));
     LogEvent event =
-        LogEvent.jsonBuilder(sourceExtension)
+        LogEvent.jsonBuilder("myJsonExtension")
             .setEventTimeMs(4500)
             .setEventUptimeMs(10000)
             .setTimezoneOffsetSeconds(29L)
             .build();
     assertThat(event.getSourceExtension()).isNull();
-    assertThat(event.getSourceExtensionJsonProto3Bytes()).isEqualTo(sourceExtension);
+    assertThat(event.getSourceExtensionJsonProto3()).isEqualTo("myJsonExtension");
   }
 
   @Test
   public void testBuildLogEvent_withNetworkConnectionInfo() {
     assertThat(
-            LogEvent.jsonBuilder(EMPTY_BYTE_ARRAY)
+            LogEvent.jsonBuilder("")
                 .setEventTimeMs(4500)
                 .setEventUptimeMs(10000)
                 .setTimezoneOffsetSeconds(29L)
@@ -262,6 +256,6 @@ public void testLogRequest_jsontToProto()
                             .build())
                     .build())
             .build();
-    assertThat(expectedProto).isEqualTo(parsedProtoBatchedLogRequest);
+    assertThat(parsedProtoBatchedLogRequest).isEqualTo(expectedProto);
   }
 }