fix(crashlytics): read firebase_crashlytics_collection_enabled from AndroidManifest.xml (#13217)

SelaseKay · web-flow · commit fa8d3205ad52 · 2024-08-27T14:52:15.000+02:00
* fix(crashlytics): read firebase_crashlytics_collection_enabled from AndroidManifest.xml

* tests: run is isCrashlyticsCollectionEnabled e2e for android platform only

* chore(crashlytics): refactor isCrashlyticsCollectionEnabled function
diff --git a/packages/firebase_crashlytics/firebase_crashlytics/android/src/main/java/io/flutter/plugins/firebase/crashlytics/FlutterFirebaseCrashlyticsPlugin.java b/packages/firebase_crashlytics/firebase_crashlytics/android/src/main/java/io/flutter/plugins/firebase/crashlytics/FlutterFirebaseCrashlyticsPlugin.java
@@ -6,6 +6,8 @@
 
 import android.content.Context;
 import android.content.SharedPreferences;
+import android.content.pm.ApplicationInfo;
+import android.content.pm.PackageManager;
 import android.os.Handler;
 import android.os.Looper;
 import android.util.Log;
@@ -16,6 +18,7 @@
 import com.google.firebase.FirebaseApp;
 import com.google.firebase.crashlytics.FirebaseCrashlytics;
 import com.google.firebase.crashlytics.FlutterFirebaseCrashlyticsInternal;
+import com.google.firebase.crashlytics.internal.Logger;
 import io.flutter.embedding.engine.plugins.FlutterPlugin;
 import io.flutter.plugin.common.BinaryMessenger;
 import io.flutter.plugin.common.MethodCall;
@@ -35,6 +38,9 @@ public class FlutterFirebaseCrashlyticsPlugin
   public static final String TAG = "FLTFirebaseCrashlytics";
   private MethodChannel channel;
 
+  private static final String FIREBASE_CRASHLYTICS_COLLECTION_ENABLED =
+      "firebase_crashlytics_collection_enabled";
+
   private void initInstance(BinaryMessenger messenger) {
     String channelName = "plugins.flutter.io/firebase_crashlytics";
     channel = new MethodChannel(messenger, channelName);
@@ -380,20 +386,42 @@ private boolean isCrashlyticsCollectionEnabled(FirebaseApp app) {
     SharedPreferences crashlyticsSharedPrefs =
         getCrashlyticsSharedPrefs(app.getApplicationContext());
 
-    if (crashlyticsSharedPrefs.contains("firebase_crashlytics_collection_enabled")) {
-      enabled = crashlyticsSharedPrefs.getBoolean("firebase_crashlytics_collection_enabled", true);
+    if (crashlyticsSharedPrefs.contains(FIREBASE_CRASHLYTICS_COLLECTION_ENABLED)) {
+      enabled = crashlyticsSharedPrefs.getBoolean(FIREBASE_CRASHLYTICS_COLLECTION_ENABLED, true);
     } else {
-      if (app.isDataCollectionDefaultEnabled()) {
-        FirebaseCrashlytics.getInstance().setCrashlyticsCollectionEnabled(true);
-        enabled = true;
-      } else {
-        enabled = false;
-      }
+
+      Boolean manifestEnabled =
+          readCrashlyticsDataCollectionEnabledFromManifest(app.getApplicationContext());
+
+      FirebaseCrashlytics.getInstance().setCrashlyticsCollectionEnabled(manifestEnabled);
+      enabled = manifestEnabled;
     }
 
     return enabled;
   }
 
+  private static Boolean readCrashlyticsDataCollectionEnabledFromManifest(
+      Context applicationContext) {
+    try {
+      final PackageManager packageManager = applicationContext.getPackageManager();
+      if (packageManager != null) {
+        final ApplicationInfo applicationInfo =
+            packageManager.getApplicationInfo(
+                applicationContext.getPackageName(), PackageManager.GET_META_DATA);
+        if (applicationInfo != null
+            && applicationInfo.metaData != null
+            && applicationInfo.metaData.containsKey(FIREBASE_CRASHLYTICS_COLLECTION_ENABLED)) {
+          return applicationInfo.metaData.getBoolean(FIREBASE_CRASHLYTICS_COLLECTION_ENABLED);
+        }
+      }
+    } catch (PackageManager.NameNotFoundException e) {
+      // This shouldn't happen since it's this app's package, but fall through to default
+      // if so.
+      Logger.getLogger().e("Could not read data collection permission from manifest", e);
+    }
+    return true;
+  }
+
   @Override
   public Task<Map<String, Object>> getPluginConstantsForFirebaseApp(FirebaseApp firebaseApp) {
     TaskCompletionSource<Map<String, Object>> taskCompletionSource = new TaskCompletionSource<>();
diff --git a/packages/firebase_crashlytics/firebase_crashlytics/example/ios/Flutter/AppFrameworkInfo.plist b/packages/firebase_crashlytics/firebase_crashlytics/example/ios/Flutter/AppFrameworkInfo.plist
@@ -21,6 +21,6 @@
   <key>CFBundleVersion</key>
   <string>1.0</string>
   <key>MinimumOSVersion</key>
-  <string>11.0</string>
+  <string>12.0</string>
 </dict>
 </plist>
diff --git a/packages/firebase_crashlytics/firebase_crashlytics/example/ios/Runner.xcodeproj/project.pbxproj b/packages/firebase_crashlytics/firebase_crashlytics/example/ios/Runner.xcodeproj/project.pbxproj
@@ -171,7 +171,7 @@
 		97C146E61CF9000F007C117D /* Project object */ = {
 			isa = PBXProject;
 			attributes = {
-				LastUpgradeCheck = 1430;
+				LastUpgradeCheck = 1510;
 				ORGANIZATIONNAME = "The Chromium Authors";
 				TargetAttributes = {
 					97C146ED1CF9000F007C117D = {
diff --git a/packages/firebase_crashlytics/firebase_crashlytics/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/packages/firebase_crashlytics/firebase_crashlytics/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1430"
+   LastUpgradeVersion = "1510"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
diff --git a/tests/android/app/src/main/AndroidManifest.xml b/tests/android/app/src/main/AndroidManifest.xml
@@ -4,6 +4,9 @@
         android:name="${applicationName}"
         android:icon="@mipmap/ic_launcher"
         android:usesCleartextTraffic="true">
+        <meta-data
+            android:name="firebase_crashlytics_collection_enabled"
+            android:value="false" />
         <activity
             android:name=".MainActivity"
             android:exported="true"
diff --git a/tests/integration_test/firebase_crashlytics/firebase_crashlytics_e2e_test.dart b/tests/integration_test/firebase_crashlytics/firebase_crashlytics_e2e_test.dart
@@ -21,6 +21,21 @@ void main() {
         );
       });
 
+      group(
+        'isCrashlyticsCollectionEnabled',
+        () {
+          test(
+              'checks isCrashlyticsCollectionEnabled value set from AndroidManifest.xml',
+              () async {
+            bool isCrashlyticsCollectionEnabled =
+                FirebaseCrashlytics.instance.isCrashlyticsCollectionEnabled;
+
+            expect(isCrashlyticsCollectionEnabled, false);
+          });
+        },
+        skip: kIsWeb || defaultTargetPlatform != TargetPlatform.android,
+      );
+
       group('checkForUnsentReports', () {
         test('should throw if automatic crash report is enabled', () async {
           await FirebaseCrashlytics.instance
