fix: [SDK-5167] split FID census into flag= and reg= (#2733)

Co-authored-by: AR Abdul Azeez <abdul@onesignal.com>
Co-authored-by: Cursor <cursoragent@cursor.com>

Author: 3 people

OneSignalSDK/onesignal/core/consumer-rules.pro

@@ -37,3 +37,12 @@
 
 # Fallback "misconfigured" managers are reflectively constructed when an optional module is absent.
 -keepclassmembers @com.onesignal.core.internal.minification.KeepStub class * { <init>(...); }
+
+# FidEnv looks these up by name. Core has no compile-time call, so R8 would strip them.
+-keepclassmembers class com.google.firebase.messaging.FirebaseMessaging {
+    *** register();
+}
+-keepclassmembers class com.google.firebase.FirebaseApp {
+    *** getApps(android.content.Context);
+    *** getName();
+}

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/device/impl/FidEnv.kt

@@ -18,6 +18,7 @@ internal data class FidEnvSnapshot(
     val googleServices: Boolean,
     val agpVersion: String?,
     val fidFlag: Boolean,
+    val fidRegisterApi: Boolean,
     val defaultFirebaseApp: Boolean,
     val firebaseInitProvider: Boolean,
     val minSdk: Int?,
@@ -29,6 +30,7 @@ internal data class FidEnvSnapshot(
             "gs=${googleServices.toBit()}",
             "agp=${agpVersion.sanitized()}",
             "flag=${fidFlag.toBit()}",
+            "reg=${fidRegisterApi.toBit()}",
             "def=${defaultFirebaseApp.toBit()}",
             "prov=${firebaseInitProvider.toBit()}",
             "min=${minSdk?.toString() ?: "-"}",
@@ -69,6 +71,16 @@ internal fun dashboardSenderForCensus(
 ): String? =
     if (hydrated && senderAppId == appId) sender else null
 
+@Suppress("TooGenericExceptionCaught")
+internal fun hasPublicNoArgMethod(className: String, methodName: String): Boolean {
+    return try {
+        Class.forName(className).getMethod(methodName)
+        true
+    } catch (_: Throwable) {
+        false
+    }
+}
+
 internal class AndroidFidEnvReader(
     private val context: Context,
 ) {
@@ -89,7 +101,8 @@ internal class AndroidFidEnvReader(
         return FidEnvSnapshot(
             googleServices = !googleAppId.isNullOrBlank(),
             agpVersion = readApkEntry(AGP_METADATA_PATH)?.let { parseAgpVersion(it) },
-            fidFlag = AndroidUtils.getManifestMetaBoolean(context, FID_FLAG),
+            fidFlag = fidFlagFromMetadata(),
+            fidRegisterApi = hasFirebaseMessagingRegisterApi(),
             defaultFirebaseApp = false,
             firebaseInitProvider = hasFirebaseInitProvider(),
             minSdk = minSdk(),
@@ -127,6 +140,24 @@ internal class AndroidFidEnvReader(
         }
     }
 
+    // 25.1+ exposes register(); older libraries ignore the metadata and keep getToken().
+    private fun hasFirebaseMessagingRegisterApi(): Boolean =
+        hasPublicNoArgMethod(FIREBASE_MESSAGING, "register")
+
+    @Suppress("TooGenericExceptionCaught")
+    private fun fidFlagFromMetadata(): Boolean {
+        return try {
+            val meta =
+                context.packageManager.getApplicationInfo(
+                    context.packageName,
+                    PackageManager.GET_META_DATA,
+                ).metaData ?: return false
+            meta.containsKey(FID_FLAG) && meta.getBoolean(FID_FLAG)
+        } catch (_: Throwable) {
+            false
+        }
+    }
+
     @Suppress("TooGenericExceptionCaught", "UNCHECKED_CAST")
     private fun hasDefaultFirebaseApp(): Boolean {
         return try {
@@ -170,6 +201,7 @@ internal class AndroidFidEnvReader(
         private const val FIREBASE_INIT_PROVIDER = "com.google.firebase.provider.FirebaseInitProvider"
         private const val AGP_METADATA_PATH = "META-INF/com/android/build/gradle/app-metadata.properties"
         private const val FIREBASE_APP = "com.google.firebase.FirebaseApp"
+        private const val FIREBASE_MESSAGING = "com.google.firebase.messaging.FirebaseMessaging"
         private const val DEFAULT_APP_NAME = "[DEFAULT]"
     }
 }

OneSignalSDK/onesignal/core/src/test/java/com/onesignal/core/internal/device/FidEnvReaderTests.kt

@@ -2,6 +2,7 @@ package com.onesignal.core.internal.device
 
 import android.content.Context
 import android.os.Build
+import android.os.Bundle
 import androidx.test.core.app.ApplicationProvider
 import br.com.colman.kotest.android.extensions.robolectric.RobolectricTest
 import com.onesignal.common.AndroidUtils
@@ -34,6 +35,7 @@ class FidEnvReaderTests : FunSpec({
 
         snapshot.googleServices shouldBe false
         snapshot.fidFlag shouldBe false
+        snapshot.fidRegisterApi shouldBe false
         snapshot.defaultFirebaseApp shouldBe false
         snapshot.firebaseInitProvider shouldBe false
         snapshot.senderMatch shouldBe null
@@ -42,11 +44,20 @@ class FidEnvReaderTests : FunSpec({
         snapshot.agpVersion shouldBe null
     }
 
+    test("manifest flag and register API are reported independently") {
+        val info = context.applicationInfo
+        if (info.metaData == null) info.metaData = Bundle()
+        info.metaData.putBoolean("firebase_messaging_installation_id_enabled", true)
+
+        val snapshot = AndroidFidEnvReader(context).collect(null)
+        snapshot.fidFlag shouldBe true
+        snapshot.fidRegisterApi shouldBe false
+    }
+
     test("gs and sender match follow google-services string resources") {
         mockkObject(AndroidUtils)
         every { AndroidUtils.getResourceString(context, "google_app_id", null) } returns "1:388536902528:android:abc"
         every { AndroidUtils.getResourceString(context, "gcm_defaultSenderId", null) } returns "388536902528"
-        every { AndroidUtils.getManifestMetaBoolean(context, any()) } returns false
 
         val snapshot = AndroidFidEnvReader(context).collect("388536902528")
 
@@ -58,7 +69,6 @@ class FidEnvReaderTests : FunSpec({
         mockkObject(AndroidUtils)
         every { AndroidUtils.getResourceString(context, "google_app_id", null) } returns "1:1:android:abc"
         every { AndroidUtils.getResourceString(context, "gcm_defaultSenderId", null) } returns "111"
-        every { AndroidUtils.getManifestMetaBoolean(context, any()) } returns false
 
         val snapshot = AndroidFidEnvReader(context).collect("999")
 

OneSignalSDK/onesignal/core/src/test/java/com/onesignal/core/internal/device/FidEnvTests.kt

@@ -2,6 +2,7 @@ package com.onesignal.core.internal.device
 
 import com.onesignal.core.internal.device.impl.FidEnvSnapshot
 import com.onesignal.core.internal.device.impl.dashboardSenderForCensus
+import com.onesignal.core.internal.device.impl.hasPublicNoArgMethod
 import com.onesignal.core.internal.device.impl.parseAgpVersion
 import com.onesignal.core.internal.device.impl.sanitizeToken
 import com.onesignal.core.internal.device.impl.senderMatch
@@ -15,14 +16,15 @@ class FidEnvTests : FunSpec({
                 googleServices = true,
                 agpVersion = "8.8.2",
                 fidFlag = false,
+                fidRegisterApi = true,
                 defaultFirebaseApp = true,
                 firebaseInitProvider = true,
                 minSdk = 24,
                 targetSdk = 35,
                 senderMatch = true,
             ).toHeaderValue()
 
-        header shouldBe "gs=1;agp=8.8.2;flag=0;def=1;prov=1;min=24;tgt=35;snd=1"
+        header shouldBe "gs=1;agp=8.8.2;flag=0;reg=1;def=1;prov=1;min=24;tgt=35;snd=1"
     }
 
     test("header uses dashes for unknown optional fields") {
@@ -31,14 +33,15 @@ class FidEnvTests : FunSpec({
                 googleServices = false,
                 agpVersion = null,
                 fidFlag = false,
+                fidRegisterApi = false,
                 defaultFirebaseApp = false,
                 firebaseInitProvider = false,
                 minSdk = null,
                 targetSdk = null,
                 senderMatch = null,
             ).toHeaderValue()
 
-        header shouldBe "gs=0;agp=-;flag=0;def=0;prov=0;min=-;tgt=-;snd=-"
+        header shouldBe "gs=0;agp=-;flag=0;reg=0;def=0;prov=0;min=-;tgt=-;snd=-"
     }
 
     test("sanitizeToken strips header-unsafe characters and caps length") {
@@ -96,4 +99,25 @@ class FidEnvTests : FunSpec({
             sender = "111",
         ) shouldBe "111"
     }
+
+    test("hasPublicNoArgMethod is true when the class exposes the method") {
+        hasPublicNoArgMethod(DummyWithRegister::class.java.name, "register") shouldBe true
+    }
+
+    test("hasPublicNoArgMethod is false when the class or method is missing") {
+        hasPublicNoArgMethod(DummyWithoutRegister::class.java.name, "register") shouldBe false
+        hasPublicNoArgMethod(DummyWithRegisterArg::class.java.name, "register") shouldBe false
+        hasPublicNoArgMethod("com.onesignal.missing.FirebaseMessaging", "register") shouldBe false
+    }
 })
+
+private class DummyWithRegister {
+    fun register() {}
+}
+
+private class DummyWithRegisterArg {
+    @Suppress("UNUSED_PARAMETER")
+    fun register(unused: String) {}
+}
+
+private class DummyWithoutRegister

OneSignalSDK/onesignal/core/src/test/java/com/onesignal/core/internal/http/HttpClientTests.kt

@@ -320,6 +320,6 @@ internal class FakeFidEnv(
     override fun headerValue(): String = value
 
     companion object {
-        const val VALUE = "gs=0;agp=8.8.2;flag=0;def=0;prov=0;min=21;tgt=34;snd=-"
+        const val VALUE = "gs=0;agp=8.8.2;flag=0;reg=0;def=0;prov=0;min=21;tgt=34;snd=-"
     }
 }