From f1f26748615c7c9d406e1d3d605e2987e1134ee7 Mon Sep 17 00:00:00 2001
From: Russell Wheatley <russellwheatley85@gmail.com>
Date: Wed, 28 Sep 2022 11:44:00 +0100
Subject: [PATCH] feat(firebase_app_check): provide `androidDebugProvider`
 boolean for android debug provider & update app check example app (#9412)

---
 .../firebase_app_check/android/build.gradle   |  6 ++---
 .../FlutterFirebaseAppCheckPlugin.java        | 15 ++++++++++---
 .../example/android/app/build.gradle          |  7 +++---
 .../android/app/src/main/AndroidManifest.xml  |  4 +++-
 .../example/android/build.gradle              |  8 +++----
 .../firebase_app_check/example/lib/main.dart  | 22 +++++++++++++++++++
 .../firebase_app_check/example/pubspec.yaml   |  9 +++++++-
 .../lib/src/firebase_app_check.dart           | 10 +++++++--
 .../test/firebase_app_check_test.dart         |  6 ++++-
 .../method_channel_firebase_app_check.dart    |  9 +++++++-
 ...platform_interface_firebase_app_check.dart |  3 ++-
 ...ethod_channel_firebase_app_check_test.dart | 10 +++++++--
 .../lib/firebase_app_check_web.dart           |  3 ++-
 tests/android/build.gradle                    |  2 +-
 .../firebase_app_check_e2e.dart               |  1 +
 15 files changed, 91 insertions(+), 24 deletions(-)

diff --git a/packages/firebase_app_check/firebase_app_check/android/build.gradle b/packages/firebase_app_check/firebase_app_check/android/build.gradle
index 12ac2b323518..4faee6c89be5 100644
--- a/packages/firebase_app_check/firebase_app_check/android/build.gradle
+++ b/packages/firebase_app_check/firebase_app_check/android/build.gradle
@@ -51,9 +51,9 @@ android {
     api firebaseCoreProject
     implementation platform("com.google.firebase:firebase-bom:${getRootProjectExtOrCoreProperty("FirebaseSDKVersion", firebaseCoreProject)}")
     // TODO: Since App Check is a beta SDK it's not available in the Firebase Android BoM so we need to specify an exact version here.
-    implementation 'com.google.firebase:firebase-appcheck-safetynet:16.0.0-beta04'
-    implementation 'com.google.firebase:firebase-appcheck-debug:16.0.0-beta04'
-    implementation 'androidx.annotation:annotation:1.1.0'
+    implementation 'com.google.firebase:firebase-appcheck-safetynet:16.0.2'
+    implementation 'com.google.firebase:firebase-appcheck-debug:16.0.2'
+    implementation 'androidx.annotation:annotation:1.5.0'
   }
 }
 
diff --git a/packages/firebase_app_check/firebase_app_check/android/src/main/java/io/flutter/plugins/firebase/appcheck/FlutterFirebaseAppCheckPlugin.java b/packages/firebase_app_check/firebase_app_check/android/src/main/java/io/flutter/plugins/firebase/appcheck/FlutterFirebaseAppCheckPlugin.java
index 2bb8010eb5d6..10ce58329f32 100644
--- a/packages/firebase_app_check/firebase_app_check/android/src/main/java/io/flutter/plugins/firebase/appcheck/FlutterFirebaseAppCheckPlugin.java
+++ b/packages/firebase_app_check/firebase_app_check/android/src/main/java/io/flutter/plugins/firebase/appcheck/FlutterFirebaseAppCheckPlugin.java
@@ -14,6 +14,7 @@
 import com.google.firebase.FirebaseApp;
 import com.google.firebase.appcheck.AppCheckTokenResult;
 import com.google.firebase.appcheck.FirebaseAppCheck;
+import com.google.firebase.appcheck.debug.DebugAppCheckProviderFactory;
 import com.google.firebase.appcheck.safetynet.SafetyNetAppCheckProviderFactory;
 import io.flutter.embedding.engine.plugins.FlutterPlugin;
 import io.flutter.plugin.common.BinaryMessenger;
@@ -77,9 +78,17 @@ private Task<Void> activate(Map<String, Object> arguments) {
     cachedThreadPool.execute(
         () -> {
           try {
-            FirebaseAppCheck firebaseAppCheck = getAppCheck(arguments);
-            firebaseAppCheck.installAppCheckProviderFactory(
-                SafetyNetAppCheckProviderFactory.getInstance());
+            Boolean debug = (Boolean) arguments.get("androidDebugProvider");
+
+            if (Boolean.TRUE.equals(debug)) {
+              FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
+              firebaseAppCheck.installAppCheckProviderFactory(
+                  DebugAppCheckProviderFactory.getInstance());
+            } else {
+              FirebaseAppCheck firebaseAppCheck = getAppCheck(arguments);
+              firebaseAppCheck.installAppCheckProviderFactory(
+                  SafetyNetAppCheckProviderFactory.getInstance());
+            }
             taskCompletionSource.setResult(null);
           } catch (Exception e) {
             taskCompletionSource.setException(e);
diff --git a/packages/firebase_app_check/firebase_app_check/example/android/app/build.gradle b/packages/firebase_app_check/firebase_app_check/example/android/app/build.gradle
index 4711e57e8d13..ec48ab8fa507 100644
--- a/packages/firebase_app_check/firebase_app_check/example/android/app/build.gradle
+++ b/packages/firebase_app_check/firebase_app_check/example/android/app/build.gradle
@@ -28,15 +28,16 @@ apply plugin: 'com.google.gms.google-services'
 apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
 
 android {
-    compileSdkVersion 30
+    compileSdkVersion 33
 
     defaultConfig {
         // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
         applicationId "io.flutter.plugins.firebase.appcheck.example"
-        minSdkVersion 16
-        targetSdkVersion 30
+        minSdkVersion 19
+        targetSdkVersion 33
         versionCode flutterVersionCode.toInteger()
         versionName flutterVersionName
+        multiDexEnabled true
     }
 
     buildTypes {
diff --git a/packages/firebase_app_check/firebase_app_check/example/android/app/src/main/AndroidManifest.xml b/packages/firebase_app_check/firebase_app_check/example/android/app/src/main/AndroidManifest.xml
index 7a4e2a00194c..b0578ac80d68 100644
--- a/packages/firebase_app_check/firebase_app_check/example/android/app/src/main/AndroidManifest.xml
+++ b/packages/firebase_app_check/firebase_app_check/example/android/app/src/main/AndroidManifest.xml
@@ -9,7 +9,9 @@
             android:theme="@style/LaunchTheme"
             android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
             android:hardwareAccelerated="true"
-            android:windowSoftInputMode="adjustResize">
+            android:windowSoftInputMode="adjustResize"
+            android:exported="true"
+          >
             <!-- Specifies an Android theme to apply to this Activity as soon as
                  the Android process has started. This theme is visible to the user
                  while the Flutter UI initializes. After that, this theme continues
diff --git a/packages/firebase_app_check/firebase_app_check/example/android/build.gradle b/packages/firebase_app_check/firebase_app_check/example/android/build.gradle
index df146989f8eb..c613764dffda 100644
--- a/packages/firebase_app_check/firebase_app_check/example/android/build.gradle
+++ b/packages/firebase_app_check/firebase_app_check/example/android/build.gradle
@@ -1,13 +1,13 @@
 buildscript {
     repositories {
         google()
-        jcenter()
+        mavenCentral()
     }
 
     dependencies {
-        classpath 'com.android.tools.build:gradle:4.1.2'
+        classpath 'com.android.tools.build:gradle:4.1.3'
         // START: FlutterFire Configuration
-        classpath 'com.google.gms:google-services:4.3.10'
+        classpath 'com.google.gms:google-services:4.3.13'
         // END: FlutterFire Configuration
     }
 }
@@ -15,7 +15,7 @@ buildscript {
 allprojects {
     repositories {
         google()
-        jcenter()
+        mavenCentral()
     }
 }
 
diff --git a/packages/firebase_app_check/firebase_app_check/example/lib/main.dart b/packages/firebase_app_check/firebase_app_check/example/lib/main.dart
index 4eda7e7a0fb5..a10d7c2d6ba5 100644
--- a/packages/firebase_app_check/firebase_app_check/example/lib/main.dart
+++ b/packages/firebase_app_check/firebase_app_check/example/lib/main.dart
@@ -2,6 +2,7 @@ import 'package:firebase_app_check/firebase_app_check.dart';
 import 'package:firebase_core/firebase_core.dart';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
+import 'package:cloud_firestore/cloud_firestore.dart';
 
 import 'firebase_options.dart';
 
@@ -17,6 +18,7 @@ Future<void> main() async {
       // Your personal reCaptcha public key goes here:
       .activate(
     webRecaptchaSiteKey: kWebRecaptchaSiteKey,
+    androidDebugProvider: true,
   );
 
   runApp(MyApp());
@@ -79,6 +81,25 @@ class _FirebaseAppCheck extends State<FirebaseAppCheckExample> {
       body: Center(
         child: Column(
           children: [
+            ElevatedButton(
+              onPressed: () async {
+                // Use this button to check whether the request was validated on the Firebase console
+                // Gets first document in collection
+                final result = await FirebaseFirestore.instance
+                    .collection('flutter-tests')
+                    .limit(1)
+                    .get();
+
+                if (result.docs.isNotEmpty) {
+                  setMessage('Document found');
+                } else {
+                  setMessage(
+                    'Document not found, please add a document to the collection',
+                  );
+                }
+              },
+              child: const Text('Test App Check validates requests'),
+            ),
             ElevatedButton(
               onPressed: () async {
                 if (kIsWeb) {
@@ -88,6 +109,7 @@ class _FirebaseAppCheck extends State<FirebaseAppCheckExample> {
                 }
                 await appCheck.activate(
                   webRecaptchaSiteKey: kWebRecaptchaSiteKey,
+                  androidDebugProvider: true,
                 );
                 setMessage('activated!!');
               },
diff --git a/packages/firebase_app_check/firebase_app_check/example/pubspec.yaml b/packages/firebase_app_check/firebase_app_check/example/pubspec.yaml
index 053646a5b585..fe05279cabfa 100644
--- a/packages/firebase_app_check/firebase_app_check/example/pubspec.yaml
+++ b/packages/firebase_app_check/firebase_app_check/example/pubspec.yaml
@@ -9,6 +9,8 @@ environment:
   sdk: ">=2.16.0 <3.0.0"
 
 dependencies:
+  cloud_firestore:
+    path: ../../../cloud_firestore/cloud_firestore
   cupertino_icons: ^0.1.2
   firebase_app_check:
     path: ../
@@ -18,6 +20,12 @@ dependencies:
     sdk: flutter
 
 dependency_overrides:
+  cloud_firestore:
+    path: ../../../cloud_firestore/cloud_firestore
+  cloud_firestore_platform_interface:
+    path: ../../../cloud_firestore/cloud_firestore_platform_interface
+  cloud_firestore_web:
+    path: ../../../cloud_firestore/cloud_firestore_web
   firebase_app_check_platform_interface:
     path: ../../../firebase_app_check/firebase_app_check_platform_interface
   firebase_app_check_web:
@@ -28,6 +36,5 @@ dependency_overrides:
     path: ../../../firebase_core/firebase_core_platform_interface
   firebase_core_web:
     path: ../../../firebase_core/firebase_core_web
-
 flutter:
   uses-material-design: true
diff --git a/packages/firebase_app_check/firebase_app_check/lib/src/firebase_app_check.dart b/packages/firebase_app_check/firebase_app_check/lib/src/firebase_app_check.dart
index fbb76b1f5d61..12abdca99bed 100644
--- a/packages/firebase_app_check/firebase_app_check/lib/src/firebase_app_check.dart
+++ b/packages/firebase_app_check/firebase_app_check/lib/src/firebase_app_check.dart
@@ -52,8 +52,14 @@ class FirebaseAppCheck extends FirebasePluginPlatform {
   /// On web, provide the reCAPTCHA v3 Site Key which can be found in the
   /// Firebase Console. For more information, see
   /// [the Firebase Documentation](https://firebase.google.com/docs/app-check/web).
-  Future<void> activate({String? webRecaptchaSiteKey}) {
-    return _delegate.activate(webRecaptchaSiteKey: webRecaptchaSiteKey);
+  ///
+  /// On Android, you may set androidDebugProvider to "true" to use the debug provider
+  /// For more information, see [the Firebase Documentation](https://firebase.google.com/docs/app-check/android/debug-provider)
+  Future<void> activate(
+      {String? webRecaptchaSiteKey, bool? androidDebugProvider = false}) {
+    return _delegate.activate(
+        webRecaptchaSiteKey: webRecaptchaSiteKey,
+        androidDebugProvider: androidDebugProvider);
   }
 
   /// Get the current App Check token.
diff --git a/packages/firebase_app_check/firebase_app_check/test/firebase_app_check_test.dart b/packages/firebase_app_check/firebase_app_check/test/firebase_app_check_test.dart
index 9537b66a7187..cfaa26c94c15 100755
--- a/packages/firebase_app_check/firebase_app_check/test/firebase_app_check_test.dart
+++ b/packages/firebase_app_check/firebase_app_check/test/firebase_app_check_test.dart
@@ -55,7 +55,10 @@ void main() {
 
     group('activate', () {
       test('successful call', () async {
-        await appCheck.activate(webRecaptchaSiteKey: 'key');
+        await appCheck.activate(
+          webRecaptchaSiteKey: 'key',
+          androidDebugProvider: true,
+        );
 
         expect(
           methodCallLog,
@@ -64,6 +67,7 @@ void main() {
               'FirebaseAppCheck#activate',
               arguments: <String, dynamic>{
                 'appName': defaultFirebaseAppName,
+                'androidDebugProvider': true,
               },
             )
           ],
diff --git a/packages/firebase_app_check/firebase_app_check_platform_interface/lib/src/method_channel/method_channel_firebase_app_check.dart b/packages/firebase_app_check/firebase_app_check_platform_interface/lib/src/method_channel/method_channel_firebase_app_check.dart
index 134fc9c0e041..1c82f9bd6962 100644
--- a/packages/firebase_app_check/firebase_app_check_platform_interface/lib/src/method_channel/method_channel_firebase_app_check.dart
+++ b/packages/firebase_app_check/firebase_app_check_platform_interface/lib/src/method_channel/method_channel_firebase_app_check.dart
@@ -3,8 +3,10 @@
 // found in the LICENSE file.
 
 import 'dart:async';
+import 'dart:io';
 
 import 'package:firebase_core/firebase_core.dart';
+import 'package:flutter/foundation.dart';
 import 'package:flutter/services.dart';
 
 import '../../firebase_app_check_platform_interface.dart';
@@ -69,10 +71,15 @@ class MethodChannelFirebaseAppCheck extends FirebaseAppCheckPlatform {
   }
 
   @override
-  Future<void> activate({String? webRecaptchaSiteKey}) async {
+  Future<void> activate({
+    String? webRecaptchaSiteKey,
+    bool? androidDebugProvider,
+  }) async {
     try {
       await channel.invokeMethod<void>('FirebaseAppCheck#activate', {
         'appName': app.name,
+        if (Platform.isAndroid || kDebugMode)
+          'androidDebugProvider': androidDebugProvider,
       });
     } on PlatformException catch (e, s) {
       throw platformExceptionToFirebaseException(e, s);
diff --git a/packages/firebase_app_check/firebase_app_check_platform_interface/lib/src/platform_interface/platform_interface_firebase_app_check.dart b/packages/firebase_app_check/firebase_app_check_platform_interface/lib/src/platform_interface/platform_interface_firebase_app_check.dart
index 5b5ab2e44b04..d7847556ce81 100644
--- a/packages/firebase_app_check/firebase_app_check_platform_interface/lib/src/platform_interface/platform_interface_firebase_app_check.dart
+++ b/packages/firebase_app_check/firebase_app_check_platform_interface/lib/src/platform_interface/platform_interface_firebase_app_check.dart
@@ -58,7 +58,8 @@ abstract class FirebaseAppCheckPlatform extends PlatformInterface {
   /// On web, provide the reCAPTCHA v3 Site Key which can be found in the
   /// Firebase Console. For more information, see
   /// [the Firebase Documentation](https://firebase.google.com/docs/app-check/web?authuser=0).
-  Future<void> activate({String? webRecaptchaSiteKey}) {
+  Future<void> activate(
+      {String? webRecaptchaSiteKey, bool? androidDebugProvider}) {
     throw UnimplementedError('activate() is not implemented');
   }
 
diff --git a/packages/firebase_app_check/firebase_app_check_platform_interface/test/method_channel_tests/method_channel_firebase_app_check_test.dart b/packages/firebase_app_check/firebase_app_check_platform_interface/test/method_channel_tests/method_channel_firebase_app_check_test.dart
index 04ba11f7c726..77a371007fde 100644
--- a/packages/firebase_app_check/firebase_app_check_platform_interface/test/method_channel_tests/method_channel_firebase_app_check_test.dart
+++ b/packages/firebase_app_check/firebase_app_check_platform_interface/test/method_channel_tests/method_channel_firebase_app_check_test.dart
@@ -67,13 +67,19 @@ void main() {
     });
 
     test('activate', () async {
-      await appCheck.activate(webRecaptchaSiteKey: 'test-key');
+      await appCheck.activate(
+        webRecaptchaSiteKey: 'test-key',
+        androidDebugProvider: true,
+      );
       expect(
         methodCallLogger,
         <Matcher>[
           isMethodCall(
             'FirebaseAppCheck#activate',
-            arguments: {'appName': defaultFirebaseAppName},
+            arguments: {
+              'appName': defaultFirebaseAppName,
+              'androidDebugProvider': true
+            },
           ),
         ],
       );
diff --git a/packages/firebase_app_check/firebase_app_check_web/lib/firebase_app_check_web.dart b/packages/firebase_app_check/firebase_app_check_web/lib/firebase_app_check_web.dart
index 1b846a97a272..16fd45e1c7d8 100644
--- a/packages/firebase_app_check/firebase_app_check_web/lib/firebase_app_check_web.dart
+++ b/packages/firebase_app_check/firebase_app_check_web/lib/firebase_app_check_web.dart
@@ -60,7 +60,8 @@ class FirebaseAppCheckWeb extends FirebaseAppCheckPlatform {
   }
 
   @override
-  Future<void> activate({String? webRecaptchaSiteKey}) async {
+  Future<void> activate(
+      {String? webRecaptchaSiteKey, bool? androidDebugProvider}) async {
     // activate API no longer exists, recaptcha key has to be passed on initialization of app-check instance.
     return convertWebExceptions<Future<void>>(() async {
       _webAppCheck ??= app_check_interop.getAppCheckInstance(
diff --git a/tests/android/build.gradle b/tests/android/build.gradle
index 551c25383e42..9fb08b6a24e4 100644
--- a/tests/android/build.gradle
+++ b/tests/android/build.gradle
@@ -1,5 +1,5 @@
 buildscript {
-    ext.kotlin_version = '1.5.20'
+    ext.kotlin_version = '1.7.10'
     repositories {
         google()
         mavenCentral()
diff --git a/tests/test_driver/firebase_app_check/firebase_app_check_e2e.dart b/tests/test_driver/firebase_app_check/firebase_app_check_e2e.dart
index 4a69808107b5..c89ba8c4ab93 100644
--- a/tests/test_driver/firebase_app_check/firebase_app_check_e2e.dart
+++ b/tests/test_driver/firebase_app_check/firebase_app_check_e2e.dart
@@ -23,6 +23,7 @@ void setupTests() {
         await expectLater(
           FirebaseAppCheck.instance.activate(
             webRecaptchaSiteKey: '6Lemcn0dAAAAABLkf6aiiHvpGD6x-zF3nOSDU2M8',
+            androidDebugProvider: true,
           ),
           completes,
         );