Making transport schemas more testable (#575)

* Moving schema manager to separate file

Injecting sql queries for better testability

* Extracting index queries

* Removed migrations

* Fix schema manager

* Fixed tests

* Fixed instrumentation tests

* Java format

* Adding an "extras" column to transport databases (#578)

* Legacy Firelog backend impl (#610)

* Added tests for upgrade

* Added tests for nullability

* Modelling creates as migrations

* Review feedback

* Review feedbackwq

* Throwing exception

* added test

* java formatting

* Fixed tests

* Apis to wire in extras (#581)

* Review feedback

* Review feedback

* Apis to wire in extras

* 1

* Flg destination

* Tests

* Fixed test

* Review feedback

* Review feedback

* Added lflg transport

* Review feedback

Author: ashwinraghav

transport/transport-backend-cct/src/main/AndroidManifest.xml

@@ -26,7 +26,7 @@
             android:exported="false">
             <meta-data
                 android:name="backend:com.google.android.datatransport.cct.CctBackendFactory"
-                android:value="cct" />
+                android:value="cct,lflg" />
         </service>
     </application>
 </manifest>

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

@@ -0,0 +1,38 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.android.datatransport.cct;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.google.android.datatransport.runtime.Destination;
+
+public final class CCTDestination implements Destination {
+  static final String DESTINATION_NAME = "cct";
+  public static final CCTDestination INSTANCE = new CCTDestination();
+
+  private CCTDestination() {}
+
+  @NonNull
+  @Override
+  public String getName() {
+    return DESTINATION_NAME;
+  }
+
+  @Nullable
+  @Override
+  public byte[] getExtras() {
+    return null;
+  }
+}

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

@@ -15,41 +15,33 @@
 package com.google.android.datatransport.cct;
 
 import androidx.annotation.Keep;
-import androidx.annotation.VisibleForTesting;
 import com.google.android.datatransport.runtime.backends.BackendFactory;
 import com.google.android.datatransport.runtime.backends.CreationContext;
 import com.google.android.datatransport.runtime.backends.TransportBackend;
 
 @Keep
 public class CctBackendFactory implements BackendFactory {
-  private static final String URL =
-      mergeStrings("hts/frbslgiggolai.o/0clgbth", "tp:/ieaeogn.ogepscmvc/o/ac");
+  static final String CCT_URL =
+      StringMerger.mergeStrings("hts/frbslgiggolai.o/0clgbth", "tp:/ieaeogn.ogepscmvc/o/ac");
+
+  static final String LFLG_URL =
+      StringMerger.mergeStrings(
+          "hts/frbslgigp.ogepscmv/ieo/eaylg", "tp:/ieaeogn-agolai.o/1frlglgc/o");
 
   @Override
   public TransportBackend create(CreationContext creationContext) {
+    final String url;
+    // Since legacy flg and clearcut APIs are identical, they share the same backend.
+    if (creationContext.getBackendName().equals(LegacyFlgDestination.DESTINATION_NAME)) {
+      url = LFLG_URL;
+    } else {
+      url = CCT_URL;
+    }
+
     return new CctTransportBackend(
         creationContext.getApplicationContext(),
-        URL,
+        url,
         creationContext.getWallClock(),
         creationContext.getMonotonicClock());
   }
-
-  @VisibleForTesting
-  static String mergeStrings(String part1, String part2) {
-    int sizeDiff = part1.length() - part2.length();
-    if (sizeDiff < 0 || sizeDiff > 1) {
-      throw new IllegalArgumentException("Invalid input received");
-    }
-
-    StringBuilder url = new StringBuilder(part1.length() + part2.length());
-
-    for (int i = 0; i < part1.length(); i++) {
-      url.append(part1.charAt(i));
-      if (part2.length() > i) {
-        url.append(part2.charAt(i));
-      }
-    }
-
-    return url.toString();
-  }
 }

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

@@ -65,6 +65,7 @@ final class CctTransportBackend implements TransportBackend {
   private static final String CONTENT_ENCODING_HEADER_KEY = "Content-Encoding";
   private static final String GZIP_CONTENT_ENCODING = "gzip";
   private static final String CONTENT_TYPE_HEADER_KEY = "Content-Type";
+  static final String API_KEY_HEADER_KEY = "X-Goog-Api-Key";
   private static final String PROTOBUF_CONTENT_TYPE = "application/x-protobuf";
 
   @VisibleForTesting static final String KEY_NETWORK_TYPE = "net-type";
@@ -81,7 +82,7 @@ final class CctTransportBackend implements TransportBackend {
   private static final String KEY_TIMEZONE_OFFSET = "tz-offset";
 
   private final ConnectivityManager connectivityManager;
-  private final URL endPoint;
+  final URL endPoint;
   private final Clock uptimeClock;
   private final Clock wallTimeClock;
   private final int readTimeout;
@@ -211,7 +212,7 @@ private BatchedLogRequest getRequestBody(BackendRequest backendRequest) {
     return batchedRequestBuilder.build();
   }
 
-  private BackendResponse doSend(BatchedLogRequest requestBody) throws IOException {
+  private BackendResponse doSend(BatchedLogRequest requestBody, String apiKey) throws IOException {
     HttpURLConnection connection = (HttpURLConnection) endPoint.openConnection();
     connection.setConnectTimeout(CONNECTION_TIME_OUT);
     connection.setReadTimeout(readTimeout);
@@ -223,6 +224,10 @@ private BackendResponse doSend(BatchedLogRequest requestBody) throws IOException
     connection.setRequestProperty(CONTENT_ENCODING_HEADER_KEY, GZIP_CONTENT_ENCODING);
     connection.setRequestProperty(CONTENT_TYPE_HEADER_KEY, PROTOBUF_CONTENT_TYPE);
 
+    if (apiKey != null) {
+      connection.setRequestProperty(API_KEY_HEADER_KEY, apiKey);
+    }
+
     WritableByteChannel channel = Channels.newChannel(connection.getOutputStream());
     try {
       ByteArrayOutputStream output = new ByteArrayOutputStream();
@@ -263,8 +268,14 @@ private BackendResponse doSend(BatchedLogRequest requestBody) throws IOException
   @Override
   public BackendResponse send(BackendRequest request) {
     BatchedLogRequest requestBody = getRequestBody(request);
+    // CCT backend supports 2 different endpoints
+    // We route to CCT backend if extras are null and to LegacyFlg otherwise.
+    // This (anti-) pattern should not be required for other backends
+    final String apiKey =
+        request.getExtras() == null ? null : LegacyFlgDestination.decodeExtras(request.getExtras());
+
     try {
-      return doSend(requestBody);
+      return doSend(requestBody, apiKey);
     } catch (IOException e) {
       LOGGER.log(Level.SEVERE, "Could not make request to the backend", e);
       return BackendResponse.transientError();

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

@@ -0,0 +1,69 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.android.datatransport.cct;
+
+import androidx.annotation.NonNull;
+import com.google.android.datatransport.runtime.Destination;
+import java.io.UnsupportedEncodingException;
+
+public class LegacyFlgDestination implements Destination {
+  static final String DESTINATION_NAME = "lflg";
+  private static final String DEFAULT_API_KEY =
+      StringMerger.mergeStrings("AzSCki82AwsLzKd5O8zo", "IayckHiZRO1EFl1aGoK");
+
+  public static final LegacyFlgDestination DEFAULT_INSTANCE =
+      new LegacyFlgDestination(DEFAULT_API_KEY);
+
+  private final String apiKey;
+
+  private LegacyFlgDestination(String apiKey) {
+    this.apiKey = apiKey;
+  }
+
+  @NonNull
+  String getAPIKey() {
+    return apiKey;
+  }
+
+  @NonNull
+  @Override
+  public String getName() {
+    return DESTINATION_NAME;
+  }
+
+  @NonNull
+  @Override
+  public byte[] getExtras() {
+    return encodeString(apiKey);
+  }
+
+  @NonNull
+  static byte[] encodeString(@NonNull String s) {
+    try {
+      return s.getBytes("UTF-8");
+    } catch (UnsupportedEncodingException e) {
+      throw new IllegalStateException("UTF-8 encoding not found.");
+    }
+  }
+
+  @NonNull
+  static String decodeExtras(@NonNull byte[] a) {
+    try {
+      return new String(a, "UTF-8");
+    } catch (UnsupportedEncodingException e) {
+      throw new IllegalStateException("UTF-8 encoding not found.");
+    }
+  }
+}

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

@@ -0,0 +1,35 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.android.datatransport.cct;
+
+public final class StringMerger {
+  static String mergeStrings(String part1, String part2) {
+    int sizeDiff = part1.length() - part2.length();
+    if (sizeDiff < 0 || sizeDiff > 1) {
+      throw new IllegalArgumentException("Invalid input received");
+    }
+
+    StringBuilder url = new StringBuilder(part1.length() + part2.length());
+
+    for (int i = 0; i < part1.length(); i++) {
+      url.append(part1.charAt(i));
+      if (part2.length() > i) {
+        url.append(part2.charAt(i));
+      }
+    }
+
+    return url.toString();
+  }
+}

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

@@ -14,34 +14,61 @@
 
 package com.google.android.datatransport.cct;
 
+import static com.google.android.datatransport.cct.CctBackendFactory.CCT_URL;
+import static com.google.android.datatransport.cct.CctBackendFactory.LFLG_URL;
 import static com.google.common.truth.Truth.assertThat;
-import static org.junit.Assert.assertThrows;
 
+import com.google.android.datatransport.runtime.backends.CreationContext;
+import com.google.android.datatransport.runtime.time.TestClock;
+import java.net.MalformedURLException;
+import java.net.URL;
 import org.junit.Test;
 import org.junit.runner.RunWith;
-import org.junit.runners.JUnit4;
+import org.robolectric.RobolectricTestRunner;
+import org.robolectric.RuntimeEnvironment;
 
-@RunWith(JUnit4.class)
+@RunWith(RobolectricTestRunner.class)
 public class CctBackendFactoryTest {
+  private static final long INITIAL_WALL_TIME = 200L;
+  private static final long INITIAL_UPTIME = 10L;
+  private TestClock wallClock = new TestClock(INITIAL_WALL_TIME);
+  private TestClock uptimeClock = new TestClock(INITIAL_UPTIME);
+
   @Test
-  public void mergeStrings_whenPartsAreUnequalLength() {
-    String part1 = "hts/eapecm";
-    String part2 = "tp:/xml.o";
-    assertThat(CctBackendFactory.mergeStrings(part1, part2)).isEqualTo("https://example.com");
+  public void create_returnCCTBackend_WhenBackendNameIsCCT() throws MalformedURLException {
+    CctBackendFactory cctBackendFactory = new CctBackendFactory();
+    CreationContext creationContext =
+        CreationContext.create(
+            RuntimeEnvironment.application,
+            wallClock,
+            uptimeClock,
+            CCTDestination.DESTINATION_NAME);
+
+    CctTransportBackend backend = (CctTransportBackend) cctBackendFactory.create(creationContext);
+    assertThat(backend.endPoint).isEqualTo(new URL(CCT_URL));
   }
 
   @Test
-  public void mergeStrings_whenPartsAreEqualLength() {
-    String part1 = "hts/eape.o";
-    String part2 = "tp:/xmlscm";
-    assertThat(CctBackendFactory.mergeStrings(part1, part2)).isEqualTo("https://examples.com");
+  public void create_returnCCTBackend_WhenNoBackendIsSpecified() throws MalformedURLException {
+    CctBackendFactory cctBackendFactory = new CctBackendFactory();
+    CreationContext creationContext =
+        CreationContext.create(RuntimeEnvironment.application, wallClock, uptimeClock);
+
+    CctTransportBackend backend = (CctTransportBackend) cctBackendFactory.create(creationContext);
+    assertThat(backend.endPoint).isEqualTo(new URL(CCT_URL));
   }
 
   @Test
-  public void mergeStrings_whenPart2IsLongerThanPart1() {
-    String part1 = "135";
-    String part2 = "2467";
-    assertThrows(
-        IllegalArgumentException.class, () -> CctBackendFactory.mergeStrings(part1, part2));
+  public void create_returnCCTBackend_WhenBackendNameIslflg() throws MalformedURLException {
+    CctBackendFactory cctBackendFactory = new CctBackendFactory();
+    CreationContext creationContext =
+        CreationContext.create(
+            RuntimeEnvironment.application,
+            wallClock,
+            uptimeClock,
+            LegacyFlgDestination.DESTINATION_NAME);
+
+    CctTransportBackend backend = (CctTransportBackend) cctBackendFactory.create(creationContext);
+    assertThat(backend.endPoint).isEqualTo(new URL(LFLG_URL));
   }
 }