Integrate AppCheckProviders with Firebase Components. (#4436)

* Integrate `SafetyNetAppCheckProvider` with Firebase Components.

* Suppress warning.

* Integrate DebugAppCheckProvider with Firebase Components.

* Add unit tests for the new registrars.

* Integrate `PlayIntegrityAppCheckProvider` with Firebase Components.

Author: rosalyntan

appcheck/firebase-appcheck-debug-testing/src/main/AndroidManifest.xml

@@ -17,4 +17,11 @@
     package="com.google.firebase.appcheck.debug.testing">
   <!--Although the *SdkVersion is captured in gradle build files, this is required for non gradle builds-->
   <!--<uses-sdk android:minSdkVersion="16"/>-->
+  <application>
+    <service android:name="com.google.firebase.components.ComponentDiscoveryService"
+        android:exported="false">
+      <meta-data android:name="com.google.firebase.components:com.google.firebase.appcheck.debug.testing.FirebaseAppCheckDebugTestingRegistrar"
+          android:value="com.google.firebase.components.ComponentRegistrar" />
+    </service>
+  </application>
 </manifest>

appcheck/firebase-appcheck-debug-testing/src/main/java/com/google/firebase/appcheck/debug/testing/DebugAppCheckTestHelper.java

@@ -15,13 +15,10 @@
 package com.google.firebase.appcheck.debug.testing;
 
 import androidx.annotation.NonNull;
-import androidx.annotation.VisibleForTesting;
-import androidx.test.platform.app.InstrumentationRegistry;
 import com.google.firebase.FirebaseApp;
 import com.google.firebase.appcheck.AppCheckProviderFactory;
 import com.google.firebase.appcheck.FirebaseAppCheck;
 import com.google.firebase.appcheck.debug.DebugAppCheckProviderFactory;
-import com.google.firebase.appcheck.debug.DebugAppCheckProviderFactoryHelper;
 import com.google.firebase.appcheck.internal.DefaultFirebaseAppCheck;
 
 /**
@@ -66,28 +63,16 @@
  * </pre>
  */
 public final class DebugAppCheckTestHelper {
-  private static final String DEBUG_SECRET_KEY = "firebaseAppCheckDebugSecret";
-
-  private final String debugSecret;
-
   /**
-   * Creates a {@link DebugAppCheckTestHelper} instance with the debug secret obtained from {@link
-   * InstrumentationRegistry} arguments.
+   * Creates a {@link DebugAppCheckTestHelper} instance with a debug secret obtained from {@link
+   * androidx.test.platform.app.InstrumentationRegistry} arguments.
    */
   @NonNull
   public static DebugAppCheckTestHelper fromInstrumentationArgs() {
-    String debugSecret = InstrumentationRegistry.getArguments().getString(DEBUG_SECRET_KEY);
-    return new DebugAppCheckTestHelper(debugSecret);
+    return new DebugAppCheckTestHelper();
   }
 
-  @VisibleForTesting
-  static DebugAppCheckTestHelper fromString(String debugSecret) {
-    return new DebugAppCheckTestHelper(debugSecret);
-  }
-
-  private DebugAppCheckTestHelper(String debugSecret) {
-    this.debugSecret = debugSecret;
-  }
+  private DebugAppCheckTestHelper() {}
 
   /**
    * Installs a {@link DebugAppCheckProviderFactory} to the default {@link FirebaseApp} and runs the
@@ -109,8 +94,7 @@ public <E extends Throwable> void withDebugProvider(
         (DefaultFirebaseAppCheck) FirebaseAppCheck.getInstance(firebaseApp);
     AppCheckProviderFactory currentAppCheckProviderFactory =
         firebaseAppCheck.getInstalledAppCheckProviderFactory();
-    firebaseAppCheck.installAppCheckProviderFactory(
-        DebugAppCheckProviderFactoryHelper.createDebugAppCheckProviderFactory(debugSecret));
+    firebaseAppCheck.installAppCheckProviderFactory(DebugAppCheckProviderFactory.getInstance());
     try {
       runnable.run();
     } catch (Throwable throwable) {

appcheck/firebase-appcheck-debug-testing/src/main/java/com/google/firebase/appcheck/debug/testing/DebugSecretProvider.java

@@ -0,0 +1,35 @@
+// Copyright 2022 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.firebase.appcheck.debug.testing;
+
+import androidx.test.platform.app.InstrumentationRegistry;
+import com.google.firebase.appcheck.debug.InternalDebugSecretProvider;
+
+/** @hide */
+public class DebugSecretProvider implements InternalDebugSecretProvider {
+  private static final String DEBUG_SECRET_KEY = "firebaseAppCheckDebugSecret";
+
+  DebugSecretProvider() {}
+
+  /**
+   * Returns a debug secret from {@link InstrumentationRegistry} arguments to be used with the
+   * {@link com.google.firebase.appcheck.debug.internal.DebugAppCheckProvider} in continuous
+   * integration testing flows.
+   */
+  @Override
+  public String getDebugSecret() {
+    return InstrumentationRegistry.getArguments().getString(DEBUG_SECRET_KEY);
+  }
+}

appcheck/firebase-appcheck-debug-testing/src/main/java/com/google/firebase/appcheck/debug/testing/FirebaseAppCheckDebugTestingRegistrar.java

@@ -0,0 +1,45 @@
+// Copyright 2022 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.firebase.appcheck.debug.testing;
+
+import com.google.android.gms.common.annotation.KeepForSdk;
+import com.google.firebase.appcheck.debug.BuildConfig;
+import com.google.firebase.appcheck.debug.InternalDebugSecretProvider;
+import com.google.firebase.components.Component;
+import com.google.firebase.components.ComponentRegistrar;
+import com.google.firebase.platforminfo.LibraryVersionComponent;
+import java.util.Arrays;
+import java.util.List;
+
+/**
+ * {@link ComponentRegistrar} for setting up FirebaseAppCheck debug testing's dependency injections
+ * in Firebase Android Components.
+ *
+ * @hide
+ */
+@KeepForSdk
+public class FirebaseAppCheckDebugTestingRegistrar implements ComponentRegistrar {
+  private static final String LIBRARY_NAME = "fire-app-check-debug-testing";
+
+  @Override
+  public List<Component<?>> getComponents() {
+    return Arrays.asList(
+        Component.builder(DebugSecretProvider.class, (InternalDebugSecretProvider.class))
+            .name(LIBRARY_NAME)
+            .factory((container) -> new DebugSecretProvider())
+            .build(),
+        LibraryVersionComponent.create(LIBRARY_NAME, BuildConfig.VERSION_NAME));
+  }
+}

appcheck/firebase-appcheck-debug-testing/src/test/java/com/google/firebase/appcheck/debug/testing/DebugAppCheckTestHelperTest.java

@@ -35,10 +35,9 @@ public class DebugAppCheckTestHelperTest {
   private static final String PROJECT_ID = "projectId";
   private static final String APP_ID = "appId";
   private static final String OTHER_FIREBASE_APP_NAME = "otherFirebaseAppName";
-  private static final String DEBUG_SECRET = "debugSecret";
 
   private final DebugAppCheckTestHelper debugAppCheckTestHelper =
-      DebugAppCheckTestHelper.fromString(DEBUG_SECRET);
+      DebugAppCheckTestHelper.fromInstrumentationArgs();
 
   @Before
   public void setUp() {

appcheck/firebase-appcheck-debug-testing/src/test/java/com/google/firebase/appcheck/debug/testing/FirebaseAppCheckDebugTestingRegistrarTest.java

@@ -0,0 +1,38 @@
+// Copyright 2022 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.firebase.appcheck.debug.testing;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import com.google.firebase.components.Component;
+import java.util.List;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.robolectric.RobolectricTestRunner;
+
+/** Tests for {@link FirebaseAppCheckDebugTestingRegistrar}. */
+@RunWith(RobolectricTestRunner.class)
+public class FirebaseAppCheckDebugTestingRegistrarTest {
+  @Test
+  public void testGetComponents() {
+    FirebaseAppCheckDebugTestingRegistrar registrar = new FirebaseAppCheckDebugTestingRegistrar();
+    List<Component<?>> components = registrar.getComponents();
+    assertThat(components).isNotEmpty();
+    assertThat(components).hasSize(2);
+    Component<?> appCheckDebugTestingComponent = components.get(0);
+    assertThat(appCheckDebugTestingComponent.getDependencies()).isEmpty();
+    assertThat(appCheckDebugTestingComponent.isLazy()).isTrue();
+  }
+}

appcheck/firebase-appcheck-debug/src/main/java/com/google/firebase/appcheck/debug/DebugAppCheckProviderFactory.java

@@ -27,20 +27,7 @@ public class DebugAppCheckProviderFactory implements AppCheckProviderFactory {
 
   private static final DebugAppCheckProviderFactory instance = new DebugAppCheckProviderFactory();
 
-  private String debugSecret;
-
-  private DebugAppCheckProviderFactory() {
-    this.debugSecret = null;
-  }
-
-  /**
-   * This constructor is package-private in order to prevent debug secrets from being hard-coded in
-   * application logic. This constructor is used by the firebase-appcheck-debug-testing SDK, to
-   * inject debug secrets in integration tests.
-   */
-  DebugAppCheckProviderFactory(String debugSecret) {
-    this.debugSecret = debugSecret;
-  }
+  private DebugAppCheckProviderFactory() {}
 
   /**
    * Gets an instance of this class for installation into a {@link
@@ -55,7 +42,8 @@ public static DebugAppCheckProviderFactory getInstance() {
 
   @NonNull
   @Override
+  @SuppressWarnings("FirebaseUseExplicitDependencies")
   public AppCheckProvider create(@NonNull FirebaseApp firebaseApp) {
-    return new DebugAppCheckProvider(firebaseApp, debugSecret);
+    return firebaseApp.get(DebugAppCheckProvider.class);
   }
 }

appcheck/firebase-appcheck-debug/src/main/java/com/google/firebase/appcheck/debug/FirebaseAppCheckDebugRegistrar.java

@@ -15,8 +15,11 @@
 package com.google.firebase.appcheck.debug;
 
 import com.google.android.gms.common.annotation.KeepForSdk;
+import com.google.firebase.FirebaseApp;
+import com.google.firebase.appcheck.debug.internal.DebugAppCheckProvider;
 import com.google.firebase.components.Component;
 import com.google.firebase.components.ComponentRegistrar;
+import com.google.firebase.components.Dependency;
 import com.google.firebase.platforminfo.LibraryVersionComponent;
 import java.util.Arrays;
 import java.util.List;
@@ -33,6 +36,17 @@ public class FirebaseAppCheckDebugRegistrar implements ComponentRegistrar {
 
   @Override
   public List<Component<?>> getComponents() {
-    return Arrays.asList(LibraryVersionComponent.create(LIBRARY_NAME, BuildConfig.VERSION_NAME));
+    return Arrays.asList(
+        Component.builder(DebugAppCheckProvider.class)
+            .name(LIBRARY_NAME)
+            .add(Dependency.required(FirebaseApp.class))
+            .add(Dependency.optionalProvider(InternalDebugSecretProvider.class))
+            .factory(
+                (container) ->
+                    new DebugAppCheckProvider(
+                        container.get(FirebaseApp.class),
+                        container.getProvider(InternalDebugSecretProvider.class)))
+            .build(),
+        LibraryVersionComponent.create(LIBRARY_NAME, BuildConfig.VERSION_NAME));
   }
 }

appcheck/firebase-appcheck-debug-testing/src/main/java/com/google/firebase/appcheck/debug/DebugAppCheckProviderFactoryHelper.java renamed to appcheck/firebase-appcheck-debug/src/main/java/com/google/firebase/appcheck/debug/InternalDebugSecretProvider.java

@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2022 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -14,19 +14,15 @@
 
 package com.google.firebase.appcheck.debug;
 
-import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 
 /**
- * Helper class used by {@link com.google.firebase.appcheck.debug.testing.DebugAppCheckTestHelper}
- * in order to access the package-private {@link DebugAppCheckProviderFactory} constructor that
- * takes in a debug secret.
+ * An interface for obtaining a debug secret to be used with {@link
+ * com.google.firebase.appcheck.debug.internal.DebugAppCheckProvider}.
  *
  * @hide
  */
-public class DebugAppCheckProviderFactoryHelper {
-  @NonNull
-  public static DebugAppCheckProviderFactory createDebugAppCheckProviderFactory(
-      @NonNull String debugSecret) {
-    return new DebugAppCheckProviderFactory(debugSecret);
-  }
+public interface InternalDebugSecretProvider {
+  @Nullable
+  String getDebugSecret();
 }

appcheck/firebase-appcheck-debug/src/main/java/com/google/firebase/appcheck/debug/internal/DebugAppCheckProvider.java

@@ -19,17 +19,18 @@
 import android.annotation.SuppressLint;
 import android.util.Log;
 import androidx.annotation.NonNull;
-import androidx.annotation.Nullable;
 import androidx.annotation.VisibleForTesting;
 import com.google.android.gms.tasks.Task;
 import com.google.android.gms.tasks.TaskCompletionSource;
 import com.google.android.gms.tasks.Tasks;
 import com.google.firebase.FirebaseApp;
 import com.google.firebase.appcheck.AppCheckProvider;
 import com.google.firebase.appcheck.AppCheckToken;
+import com.google.firebase.appcheck.debug.InternalDebugSecretProvider;
 import com.google.firebase.appcheck.internal.DefaultAppCheckToken;
 import com.google.firebase.appcheck.internal.NetworkClient;
 import com.google.firebase.appcheck.internal.RetryManager;
+import com.google.firebase.inject.Provider;
 import java.util.UUID;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
@@ -46,11 +47,18 @@ public class DebugAppCheckProvider implements AppCheckProvider {
 
   // TODO(b/258273630): Migrate to go/firebase-android-executors
   @SuppressLint("ThreadPoolCreation")
-  public DebugAppCheckProvider(@NonNull FirebaseApp firebaseApp, @Nullable String debugSecret) {
+  public DebugAppCheckProvider(
+      @NonNull FirebaseApp firebaseApp,
+      @NonNull Provider<InternalDebugSecretProvider> debugSecretProvider) {
     checkNotNull(firebaseApp);
     this.networkClient = new NetworkClient(firebaseApp);
     this.backgroundExecutor = Executors.newCachedThreadPool();
     this.retryManager = new RetryManager();
+
+    String debugSecret = null;
+    if (debugSecretProvider.get() != null) {
+      debugSecret = debugSecretProvider.get().getDebugSecret();
+    }
     this.debugSecretTask =
         debugSecret == null
             ? determineDebugSecret(firebaseApp, this.backgroundExecutor)