feat: SDK-4210: Standardize BACKGROUND_THREADING feature flag key naming (#2598)

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

Author: abdulraqeeb33

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/features/FeatureFlag.kt

@@ -20,8 +20,23 @@ internal enum class FeatureActivationMode {
  */
 internal enum class FeatureFlag(
     val key: String,
-    val activationMode: FeatureActivationMode,
+    val activationMode: FeatureActivationMode
 ) {
     // Threading mode is selected once per app startup to avoid mixed-mode behavior mid-session.
-    BACKGROUND_THREADING("BACKGROUND_THREADING", FeatureActivationMode.APP_STARTUP),
+    //
+    // Naming convention:
+    //   SDK_<MMmmpp>_<FEATURE_DESCRIPTION>
+    //
+    // Example:
+    //   SDK_050800_BACKGROUND_THREADING
+    //
+    SDK_050800_BACKGROUND_THREADING(
+        "SDK_050800_BACKGROUND_THREADING",
+        FeatureActivationMode.APP_STARTUP
+    ),
+    ;
+
+    fun isEnabledIn(enabledKeys: Set<String>): Boolean {
+        return enabledKeys.contains(key)
+    }
 }

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/features/FeatureManager.kt

@@ -75,7 +75,7 @@ internal class FeatureManager(
         val nextStates = featureStates.toMutableMap()
 
         for (feature in FeatureFlag.entries) {
-            val desiredState = enabledFeatureKeys.contains(feature.key)
+            val desiredState = feature.isEnabledIn(enabledFeatureKeys)
             when (feature.activationMode) {
                 FeatureActivationMode.IMMEDIATE -> {
                     nextStates[feature] = desiredState
@@ -108,7 +108,7 @@ internal class FeatureManager(
         enabled: Boolean,
     ) {
         when (feature) {
-            FeatureFlag.BACKGROUND_THREADING ->
+            FeatureFlag.SDK_050800_BACKGROUND_THREADING ->
                 ThreadingMode.updateUseBackgroundThreading(
                     enabled = enabled,
                     source = "FeatureManager:${feature.activationMode}"

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/startup/StartupService.kt

@@ -19,7 +19,7 @@ internal class StartupService(
         val useBackgroundThreading =
             try {
                 val featureManager = services.getService<IFeatureManager>()
-                featureManager.isEnabled(FeatureFlag.BACKGROUND_THREADING)
+                featureManager.isEnabled(FeatureFlag.SDK_050800_BACKGROUND_THREADING)
             } catch (t: Throwable) {
                 Logging.warn("OneSignal: Failed to resolve BACKGROUND_THREADING in StartupService. Falling back to legacy thread.", t)
                 false

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/crash/OneSignalCrashUploaderWrapper.kt

@@ -50,7 +50,7 @@ internal class OneSignalCrashUploaderWrapper(
     @Suppress("TooGenericExceptionCaught")
     override fun start() {
         if (!OtelSdkSupport.isSupported) return
-        if (featureManager.isEnabled(FeatureFlag.BACKGROUND_THREADING)) {
+        if (featureManager.isEnabled(FeatureFlag.SDK_050800_BACKGROUND_THREADING)) {
             OneSignalDispatchers.launchOnIO {
                 try {
                     uploader.start()

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/internal/OneSignalImp.kt

@@ -180,7 +180,7 @@ internal class OneSignalImp(
             }
 
             return try {
-                featureManager.isEnabled(FeatureFlag.BACKGROUND_THREADING)
+                featureManager.isEnabled(FeatureFlag.SDK_050800_BACKGROUND_THREADING)
             } catch (t: Throwable) {
                 Logging.warn("OneSignal: Failed to resolve BACKGROUND_THREADING feature, defaulting to legacy mode.", t)
                 false

OneSignalSDK/onesignal/core/src/test/java/com/onesignal/core/internal/features/FeatureFlagTests.kt

@@ -0,0 +1,18 @@
+package com.onesignal.core.internal.features
+
+import io.kotest.core.spec.style.FunSpec
+import io.kotest.matchers.shouldBe
+
+class FeatureFlagTests : FunSpec({
+    test("feature flags use SDK_050800 style key naming") {
+        val keyPattern = Regex("^SDK_[0-9]{6}_[A-Z0-9_]+$")
+
+        FeatureFlag.entries.forEach { feature ->
+            keyPattern.matches(feature.key) shouldBe true
+        }
+    }
+
+    test("BACKGROUND_THREADING uses the expected canonical key") {
+        FeatureFlag.SDK_050800_BACKGROUND_THREADING.key shouldBe "SDK_050800_BACKGROUND_THREADING"
+    }
+})

OneSignalSDK/onesignal/core/src/test/java/com/onesignal/core/internal/features/FeatureManagerTests.kt

@@ -19,7 +19,7 @@ class FeatureManagerTests : FunSpec({
     test("initial state should enable BACKGROUND_THREADING when feature is present") {
         // Given
         val initialModel = mockk<ConfigModel>()
-        every { initialModel.features } returns listOf(FeatureFlag.BACKGROUND_THREADING.key)
+        every { initialModel.features } returns listOf(FeatureFlag.SDK_050800_BACKGROUND_THREADING.key)
         val configModelStore = mockk<ConfigModelStore>()
         every { configModelStore.model } returns initialModel
         every { configModelStore.subscribe(any()) } just runs
@@ -28,7 +28,7 @@ class FeatureManagerTests : FunSpec({
         val manager = FeatureManager(configModelStore)
 
         // Then
-        manager.isEnabled(FeatureFlag.BACKGROUND_THREADING) shouldBe true
+        manager.isEnabled(FeatureFlag.SDK_050800_BACKGROUND_THREADING) shouldBe true
         ThreadingMode.useBackgroundThreading shouldBe true
     }
 
@@ -42,13 +42,13 @@ class FeatureManagerTests : FunSpec({
         val manager = FeatureManager(configModelStore)
 
         val updatedModel = mockk<ConfigModel>()
-        every { updatedModel.features } returns listOf(FeatureFlag.BACKGROUND_THREADING.key)
+        every { updatedModel.features } returns listOf(FeatureFlag.SDK_050800_BACKGROUND_THREADING.key)
 
         // When
         manager.onModelReplaced(updatedModel, ModelChangeTags.HYDRATE)
 
         // Then
-        manager.isEnabled(FeatureFlag.BACKGROUND_THREADING) shouldBe false
+        manager.isEnabled(FeatureFlag.SDK_050800_BACKGROUND_THREADING) shouldBe false
         ThreadingMode.useBackgroundThreading shouldBe false
     }
 
@@ -61,7 +61,7 @@ class FeatureManagerTests : FunSpec({
         every { configModelStore.subscribe(any()) } just runs
         val manager = FeatureManager(configModelStore)
 
-        every { model.features } returns listOf(FeatureFlag.BACKGROUND_THREADING.key)
+        every { model.features } returns listOf(FeatureFlag.SDK_050800_BACKGROUND_THREADING.key)
 
         // When
         manager.onModelUpdated(
@@ -72,14 +72,14 @@ class FeatureManagerTests : FunSpec({
         )
 
         // Then
-        manager.isEnabled(FeatureFlag.BACKGROUND_THREADING) shouldBe false
+        manager.isEnabled(FeatureFlag.SDK_050800_BACKGROUND_THREADING) shouldBe false
         ThreadingMode.useBackgroundThreading shouldBe false
     }
 
     test("onModelUpdated should keep startup mode when initial mode is enabled") {
         // Given
         val model = mockk<ConfigModel>()
-        every { model.features } returns listOf(FeatureFlag.BACKGROUND_THREADING.key)
+        every { model.features } returns listOf(FeatureFlag.SDK_050800_BACKGROUND_THREADING.key)
         val configModelStore = mockk<ConfigModelStore>()
         every { configModelStore.model } returns model
         every { configModelStore.subscribe(any()) } just runs
@@ -96,7 +96,7 @@ class FeatureManagerTests : FunSpec({
         )
 
         // Then
-        manager.isEnabled(FeatureFlag.BACKGROUND_THREADING) shouldBe true
+        manager.isEnabled(FeatureFlag.SDK_050800_BACKGROUND_THREADING) shouldBe true
         ThreadingMode.useBackgroundThreading shouldBe true
     }
 })

OneSignalSDK/onesignal/core/src/test/java/com/onesignal/core/internal/startup/StartupServiceTests.kt

@@ -26,7 +26,7 @@ class StartupServiceTests : FunSpec({
         backgroundThreadingEnabled: Boolean = true,
     ): ServiceProvider {
         val featureManager = mockk<IFeatureManager>()
-        every { featureManager.isEnabled(FeatureFlag.BACKGROUND_THREADING) } returns backgroundThreadingEnabled
+        every { featureManager.isEnabled(FeatureFlag.SDK_050800_BACKGROUND_THREADING) } returns backgroundThreadingEnabled
 
         val serviceBuilder = ServiceBuilder()
         serviceBuilder.register(featureManager).provides<IFeatureManager>()

OneSignalSDK/onesignal/core/src/test/java/com/onesignal/debug/internal/crash/OneSignalCrashUploaderWrapperTest.kt

@@ -41,7 +41,7 @@ class OneSignalCrashUploaderWrapperTest : FunSpec({
 
     fun mockFeatureManager(backgroundThreadingEnabled: Boolean = true): IFeatureManager {
         val featureManager = mockk<IFeatureManager>()
-        every { featureManager.isEnabled(FeatureFlag.BACKGROUND_THREADING) } returns backgroundThreadingEnabled
+        every { featureManager.isEnabled(FeatureFlag.SDK_050800_BACKGROUND_THREADING) } returns backgroundThreadingEnabled
         return featureManager
     }