feat(analytics, ATT): allow use of AnalyticsWithoutAdIdSupport pod

.spellcheck.dict.txt

@@ -8,6 +8,8 @@ APIs
 APIs.
 APNs
 async
+ATT
+ATT-compatible
 auth
 Auth
 authenticator
@@ -46,6 +48,7 @@ Fastlane
 FCM
 firebase
 Firebase
+firebase-ios-sdk
 Firestore
 GDPR
 globals
@@ -55,6 +58,7 @@ Hesp
 Homebrew
 HTTP
 HTTPS
+IDFA
 installable
 Interstitials
 interstitials

docs/analytics/usage/index.md

@@ -132,6 +132,27 @@ import analytics from '@react-native-firebase/analytics';
 const appInstanceId = await analytics().getAppInstanceId();
 ```
 
+# Disable Ad Id usage on iOS
+
+Apple has a strict ban on the usage of Ad Ids ("IDFA") in Kids Category apps. They will not accept any app
+in the Kids category if the app accesses the IDFA iOS symbols.
+
+Additionally, apps must implement Apples "App Tracking Transparency" (or "ATT") requirements if they access IDFA symbols.
+However, if an app does not use IDFA and otherwise handles data in an ATT-compatible way, it eliminates this ATT requirement.
+
+If avoiding the usage of IDFA is a requirement for your app, you must use firebase-ios-sdk 7.11.0 or greater, then you may define a variable in your Podfile like this:
+
+```ruby
+$RNFirebaseAnalyticsWithoutAdIdSupport = true
+```
+
+During `pod install`, using that variable installs a new
+["Analytics With No Ad Ids"](https://firebase.google.com/support/release-notes/ios#version_7110_-_april_20_2021)
+pod the firebase-ios-sdk team has created, and allows both the use of Firebase Analytics in Kids Category apps,
+and use of Firebase Analytics without needing the App Tracking Transparency handling (assuming no other parts
+of your app handle data in a way that requires ATT)
+
+Note that for obvious reasons, configuring Firebase Analytics for use without IDFA is incompatible with AdMob
 # firebase.json
 
 ## Disable Auto-Initialization

packages/admob/RNFBAdMob.podspec

@@ -37,6 +37,11 @@ Pod::Spec.new do |s|
     firebase_sdk_version = $FirebaseSDKVersion
   end
 
+  if defined?($RNFirebaseAnalyticsWithoutAdIdSupport)
+    # Trying to use AdMob *and* AnalyticsWIthoutAdIdSupport is not a valid combination
+    raise "#{s.name} and Firebase/AnalyticsWithoutAdIdSupport are not compatible. Ad Ids are required for #{s.name}"
+  end
+
   # Firebase dependencies
   s.dependency          'Firebase/AdMob', firebase_sdk_version
 

packages/analytics/RNFBAnalytics.podspec

@@ -34,7 +34,20 @@ Pod::Spec.new do |s|
   end
 
   # Firebase dependencies
-  s.dependency          'Firebase/Analytics', firebase_sdk_version
+  if defined?($RNFirebaseAnalyticsWithoutAdIdSupport)
+    Pod::UI.puts "#{s.name}: Using Firebase/AnalyticsWithoutAdIdSupport pod in place of default Firebase/Analytics"
+
+    # Releasing as non-breaking change as it is optional but it raises minimum requirements, validate just in case
+    if (Gem::Version.new(firebase_sdk_version) < Gem::Version.new("7.11.0"))
+      raise "Firebase/AnalyticsWithoutAdIdSupport requires firebase-ios-sdk 7.11.0 or greater."
+    end
+
+    s.dependency          'Firebase/AnalyticsWithoutAdIdSupport', firebase_sdk_version
+  else
+    Pod::UI.puts "#{s.name}: Using default Firebase/Analytics with Ad Ids. May require App Tracking Transparency. Not allowed for Kids apps."
+    Pod::UI.puts "#{s.name}: You may set variable `$RNFirebaseAnalyticsWithoutAdIdSupport=true` in Podfile to use analytics without ad ids."
+    s.dependency          'Firebase/Analytics', firebase_sdk_version
+  end
 
   if defined?($RNFirebaseAsStaticFramework)
     Pod::UI.puts "#{s.name}: Using overridden static_framework value of '#{$RNFirebaseAsStaticFramework}'"

packages/app/package.json

@@ -62,7 +62,7 @@
   },
   "sdkVersions": {
     "ios": {
-      "firebase": "7.10.0"
+      "firebase": "7.11.0"
     },
     "android": {
       "minSdk": 16,

tests/ios/Podfile

@@ -7,6 +7,14 @@ $FirebaseSDKVersion = appPackage['sdkVersions']['ios']['firebase']
 Pod::UI.puts "react-native-firebase/tests: Using Firebase SDK version '#{$FirebaseSDKVersion}'"
 #$RNFirebaseAsStaticFramework = false # toggle this to true (and set 'use_frameworks!' below to test static frameworks)
 
+# Toggle this to true for the no-ad-tracking Analytics subspec. Useful at minimum for Kids category apps.
+# See: https://firebase.google.com/support/release-notes/ios#analytics - requires firebase-ios-sdk 7.11.0+
+#$RNFirebaseAnalyticsWithoutAdIdSupport = true # toggle this to true for the no-ad-tracking Analytics subspec
+
+# This is needed to reduce flakiness where leveldb is transitively included by database, and packed as framework
+# from the pre-compiled firestore-ios-sdk-frameworks
+$FirebaseFirestoreExcludeLeveldb = true
+
 # Versions used below, for quick reference / outdated+upgrade checks
 $iOSMinimumDeployVersion = '10.0'
 
@@ -28,7 +36,6 @@ target 'testing' do
   )
 
   # Use pre-compiled firestore frameworks to optimize compile time. But make sure there are not leveldb conflicts.
-  $FirebaseFirestoreExcludeLeveldb = true
   pod 'FirebaseFirestore', :git => 'https://github.com/invertase/firestore-ios-sdk-frameworks.git', :tag => $FirebaseSDKVersion
 
   # Enables Flipper.