refactor(workflows): give ui_config its own independent read path

Adds UiConfigProvider (reads the ui_config topic through RemoteConfigManager's
topic() facade) and a symmetric read path — PurchasesOrchestrator.getUiConfig /
Purchases.awaitGetUiConfig — mirroring getWorkflow/awaitGetWorkflow. Fully
standalone: nothing consumes it yet, WorkflowManager and PublishedWorkflow are
untouched.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

Author: vegaro

purchases/src/defaults/kotlin/com/revenuecat/purchases/Purchases.kt

@@ -425,6 +425,16 @@ public class Purchases internal constructor(
         )
     }
 
+    @InternalRevenueCatAPI
+    @JvmSynthetic
+    @Throws(PurchasesException::class)
+    public suspend fun awaitGetUiConfig(): UiConfig = suspendCoroutine { continuation ->
+        purchasesOrchestrator.getUiConfig(
+            onSuccess = continuation::resume,
+            onError = { continuation.resumeWithException(PurchasesException(it)) },
+        )
+    }
+
     @InternalRevenueCatAPI
     public fun workflowIdForOfferingId(offeringId: String): String? =
         purchasesOrchestrator.workflowIdForOfferingId(offeringId)

purchases/src/main/kotlin/com/revenuecat/purchases/PurchasesFactory.kt

@@ -40,6 +40,7 @@ import com.revenuecat.purchases.common.offlineentitlements.PurchasedProductsFetc
 import com.revenuecat.purchases.common.remoteconfig.RemoteConfigBlobStore
 import com.revenuecat.purchases.common.remoteconfig.RemoteConfigDiskCache
 import com.revenuecat.purchases.common.remoteconfig.RemoteConfigManager
+import com.revenuecat.purchases.common.remoteconfig.UiConfigProvider
 import com.revenuecat.purchases.common.verification.SignatureVerificationMode
 import com.revenuecat.purchases.common.verification.SigningManager
 import com.revenuecat.purchases.common.warnLog
@@ -286,6 +287,8 @@ internal class PurchasesFactory(
                 null
             }
 
+            val uiConfigProvider = remoteConfigManager?.let { UiConfigProvider(it) }
+
             val identityManager = IdentityManager(
                 cache,
                 subscriberAttributesCache,
@@ -492,6 +495,7 @@ internal class PurchasesFactory(
                 workflowManager = workflowManager,
                 fileRepository = fileRepository,
                 remoteConfigManager = remoteConfigManager,
+                uiConfigProvider = uiConfigProvider,
             )
 
             return Purchases(purchasesOrchestrator)

purchases/src/main/kotlin/com/revenuecat/purchases/PurchasesOrchestrator.kt

@@ -48,6 +48,7 @@ import com.revenuecat.purchases.common.log
 import com.revenuecat.purchases.common.offerings.OfferingsManager
 import com.revenuecat.purchases.common.offlineentitlements.OfflineEntitlementsManager
 import com.revenuecat.purchases.common.remoteconfig.RemoteConfigManager
+import com.revenuecat.purchases.common.remoteconfig.UiConfigProvider
 import com.revenuecat.purchases.common.sha1
 import com.revenuecat.purchases.common.subscriberattributes.SubscriberAttributeKey
 import com.revenuecat.purchases.common.verboseLog
@@ -106,6 +107,11 @@ import com.revenuecat.purchases.utils.Result
 import com.revenuecat.purchases.utils.isAndroidNOrNewer
 import com.revenuecat.purchases.virtualcurrencies.VirtualCurrencies
 import com.revenuecat.purchases.virtualcurrencies.VirtualCurrencyManager
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.SupervisorJob
+import kotlinx.coroutines.cancel
+import kotlinx.coroutines.launch
 import java.net.URL
 import java.util.Collections
 import java.util.Date
@@ -162,10 +168,13 @@ internal class PurchasesOrchestrator(
     private val backupManager: BackupManager = BackupManager(application),
     val fileRepository: FileRepository = DefaultFileRepository(application),
     private val remoteConfigManager: RemoteConfigManager? = null,
+    private val uiConfigProvider: UiConfigProvider? = null,
     @OptIn(ExperimentalPreviewRevenueCatPurchasesAPI::class)
     val adTracker: AdTracker = AdTracker(adEventsManager),
 ) : LifecycleDelegate, CustomActivityLifecycleHandler {
 
+    private val uiConfigScope: CoroutineScope = CoroutineScope(SupervisorJob() + Dispatchers.IO)
+
     internal var state: PurchasesState
         get() = purchasesStateCache.purchasesState
         set(value) {
@@ -619,6 +628,44 @@ internal class PurchasesOrchestrator(
     fun workflowIdForOfferingId(offeringId: String): String? =
         workflowManager?.workflowIdForOfferingId(offeringId)
 
+    fun getUiConfig(
+        onSuccess: (UiConfig) -> Unit,
+        onError: (PurchasesError) -> Unit,
+    ) {
+        if (appConfig.uiPreviewMode) {
+            dispatch {
+                onError(
+                    PurchasesError(
+                        PurchasesErrorCode.ConfigurationError,
+                        "UI config cannot be fetched in UI preview mode.",
+                    ),
+                )
+            }
+            return
+        }
+        if (uiConfigProvider == null) {
+            dispatch {
+                onError(
+                    PurchasesError(
+                        PurchasesErrorCode.ConfigurationError,
+                        "UI config is not enabled.",
+                    ),
+                )
+            }
+            return
+        }
+        uiConfigScope.launch {
+            try {
+                val uiConfig = uiConfigProvider.getUiConfig()
+                dispatch { onSuccess(uiConfig) }
+            } catch (@Suppress("TooGenericExceptionCaught") e: Exception) {
+                dispatch {
+                    onError(PurchasesError(PurchasesErrorCode.UnknownError, "Failed to fetch UI config: ${e.message}"))
+                }
+            }
+        }
+    }
+
     fun getProducts(
         productIds: List<String>,
         type: ProductType? = null,
@@ -852,6 +899,7 @@ internal class PurchasesOrchestrator(
         }
         this.backend.close()
         this.remoteConfigManager?.close()
+        this.uiConfigScope.cancel()
         this.workflowManager?.close()
 
         billing.close()

purchases/src/main/kotlin/com/revenuecat/purchases/common/remoteconfig/UiConfigProvider.kt

@@ -0,0 +1,30 @@
+package com.revenuecat.purchases.common.remoteconfig
+
+import com.revenuecat.purchases.InternalRevenueCatAPI
+import com.revenuecat.purchases.JsonTools
+import com.revenuecat.purchases.UiConfig
+import kotlinx.serialization.json.JsonObject
+import kotlinx.serialization.json.decodeFromJsonElement
+
+/**
+ * The topic-specific front door for `ui_config`: three independently-updated parts — `app`, `localizations`,
+ * `variable_config` — that together deserialize as one [UiConfig], the same shape the legacy offerings response
+ * sends pre-assembled in a single JSON object. Each part is inline item metadata (no blob), so it's read straight
+ * off the topic's item index. A part with no body (topic absent or item absent) is simply omitted, so [UiConfig]'s
+ * own field defaults fill the gap.
+ */
+@OptIn(InternalRevenueCatAPI::class)
+internal class UiConfigProvider(
+    private val manager: RemoteConfigManager,
+) {
+
+    suspend fun getUiConfig(): UiConfig {
+        val topic = manager.topic(RemoteConfigTopic.UiConfig)
+        val parts = PART_KEYS.mapNotNull { key -> topic?.get(key)?.let { key to it.metadata } }.toMap()
+        return JsonTools.json.decodeFromJsonElement(JsonObject(parts))
+    }
+
+    private companion object {
+        private val PART_KEYS = listOf("app", "localizations", "variable_config")
+    }
+}

purchases/src/test/java/com/revenuecat/purchases/BasePurchasesTest.kt

@@ -29,6 +29,7 @@ import com.revenuecat.purchases.common.offerings.OfferingsManager
 import com.revenuecat.purchases.common.remoteconfig.RemoteConfigManager
 import com.revenuecat.purchases.common.workflows.WorkflowManager
 import com.revenuecat.purchases.common.offlineentitlements.OfflineEntitlementsManager
+import com.revenuecat.purchases.common.remoteconfig.UiConfigProvider
 import com.revenuecat.purchases.deeplinks.WebPurchaseRedemptionHelper
 import com.revenuecat.purchases.google.toInAppStoreProduct
 import com.revenuecat.purchases.google.toStoreTransaction
@@ -95,6 +96,7 @@ internal open class BasePurchasesTest {
     internal val mockPurchaseParamsValidator = mockk<PurchaseParamsValidator>()
     internal val mockWorkflowManager = mockk<WorkflowManager>(relaxed = true)
     internal val mockRemoteConfigManager = mockk<RemoteConfigManager>(relaxed = true)
+    internal val mockUiConfigProvider = mockk<UiConfigProvider>(relaxed = true)
     private val mockBlockstoreHelper = mockk<BlockstoreHelper>()
     private val purchasesStateProvider = PurchasesStateCache(PurchasesState())
 
@@ -513,6 +515,7 @@ internal open class BasePurchasesTest {
             purchaseParamsValidator = mockPurchaseParamsValidator,
             workflowManager = mockWorkflowManager,
             remoteConfigManager = mockRemoteConfigManager,
+            uiConfigProvider = mockUiConfigProvider,
         )
 
         purchases = Purchases(

purchases/src/test/java/com/revenuecat/purchases/PurchasesCommonTest.kt

@@ -5,6 +5,7 @@
 
 package com.revenuecat.purchases
 
+import android.os.Looper
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import com.android.billingclient.api.BillingClient
 import com.android.billingclient.api.BillingResult
@@ -41,6 +42,8 @@ import com.revenuecat.purchases.utils.stubPricingPhase
 import com.revenuecat.purchases.utils.stubStoreProduct
 import com.revenuecat.purchases.utils.stubSubscriptionOption
 import io.mockk.Runs
+import io.mockk.coEvery
+import io.mockk.coVerify
 import io.mockk.every
 import io.mockk.just
 import io.mockk.mockk
@@ -55,8 +58,11 @@ import org.junit.Assert.fail
 import org.junit.Test
 import org.junit.runner.RunWith
 import org.robolectric.annotation.Config
+import org.robolectric.Shadows.shadowOf
 import java.util.Collections.emptyList
 import java.util.Date
+import java.util.concurrent.CountDownLatch
+import java.util.concurrent.TimeUnit
 import kotlin.time.Duration.Companion.milliseconds
 
 @RunWith(AndroidJUnit4::class)
@@ -71,6 +77,7 @@ internal class PurchasesCommonTest: BasePurchasesTest() {
     private val subPurchaseToken = "token_sub"
 
     private val initiationSource = PostReceiptInitiationSource.PURCHASE
+    private val defaultTimeout = 2000L
 
     @After
     fun removeMocks() {
@@ -2913,6 +2920,79 @@ internal class PurchasesCommonTest: BasePurchasesTest() {
 
     // endregion
 
+    // region getUiConfig
+
+    @Test
+    fun `getUiConfig delivers the provider's result to the caller`() {
+        val expected = UiConfig()
+        coEvery { mockUiConfigProvider.getUiConfig() } returns expected
+
+        var received: UiConfig? = null
+        var receivedError: PurchasesError? = null
+        val latch = CountDownLatch(1)
+        purchases.purchasesOrchestrator.getUiConfig(
+            onSuccess = { received = it; latch.countDown() },
+            onError = { receivedError = it; latch.countDown() },
+        )
+
+        awaitMainLooperCallback(latch)
+        assertThat(received).isEqualTo(expected)
+        assertThat(receivedError).isNull()
+    }
+
+    @Test
+    fun `getUiConfig delivers a failure as an error to the caller`() {
+        coEvery { mockUiConfigProvider.getUiConfig() } throws RuntimeException("boom")
+
+        var received: UiConfig? = null
+        var receivedError: PurchasesError? = null
+        val latch = CountDownLatch(1)
+        purchases.purchasesOrchestrator.getUiConfig(
+            onSuccess = { received = it; latch.countDown() },
+            onError = { receivedError = it; latch.countDown() },
+        )
+
+        awaitMainLooperCallback(latch)
+        assertThat(receivedError).isNotNull
+        assertThat(received).isNull()
+    }
+
+    /**
+     * `getUiConfig` delivers through `uiConfigScope` (a real `Dispatchers.IO` coroutine), then posts the
+     * callback to the main-thread handler. Robolectric's main looper is paused by default, so the posted
+     * callback sits queued until idled; poll-idle it while waiting on [latch] so we pick the callback up as
+     * soon as the background coroutine posts it, instead of guessing a fixed delay.
+     */
+    private fun awaitMainLooperCallback(latch: CountDownLatch) {
+        val deadline = System.currentTimeMillis() + defaultTimeout
+        while (latch.count > 0 && System.currentTimeMillis() < deadline) {
+            shadowOf(Looper.getMainLooper()).idle()
+            latch.await(10, TimeUnit.MILLISECONDS)
+        }
+        assertThat(latch.await(0, TimeUnit.MILLISECONDS)).isTrue()
+    }
+
+    @Test
+    fun `getUiConfig returns ConfigurationError and never calls the provider when uiPreviewMode is true`() {
+        buildPurchases(anonymous = true, uiPreviewMode = true)
+
+        var received: UiConfig? = null
+        var receivedError: PurchasesError? = null
+        purchases.purchasesOrchestrator.getUiConfig(
+            onSuccess = { received = it },
+            onError = { receivedError = it },
+        )
+
+        assertThat(receivedError).isNotNull
+        assertThat(receivedError!!.code).isEqualTo(PurchasesErrorCode.ConfigurationError)
+        assertThat(received).isNull()
+        coVerify(exactly = 0) {
+            mockUiConfigProvider.getUiConfig()
+        }
+    }
+
+    // endregion
+
     // region queryPurchases
 
     @Test

ui/revenuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/data/MockPurchasesType.kt

@@ -7,6 +7,7 @@ import com.revenuecat.purchases.Offerings
 import com.revenuecat.purchases.PurchaseParams
 import com.revenuecat.purchases.PurchaseResult
 import com.revenuecat.purchases.PurchasesAreCompletedBy
+import com.revenuecat.purchases.UiConfig
 import com.revenuecat.purchases.common.events.FeatureEvent
 import com.revenuecat.purchases.common.workflows.WorkflowDataResult
 import com.revenuecat.purchases.customercenter.CustomerCenterConfigData
@@ -65,5 +66,9 @@ internal class MockPurchasesType(
         throw NotImplementedError("Mock implementation for previews only")
     }
 
+    override suspend fun awaitGetUiConfig(): UiConfig {
+        throw NotImplementedError("Mock implementation for previews only")
+    }
+
     override fun workflowIdForOfferingId(offeringId: String): String? = null
 }

ui/revenuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/data/PurchasesType.kt

@@ -10,6 +10,7 @@ import com.revenuecat.purchases.PurchaseResult
 import com.revenuecat.purchases.Purchases
 import com.revenuecat.purchases.PurchasesAreCompletedBy
 import com.revenuecat.purchases.PurchasesException
+import com.revenuecat.purchases.UiConfig
 import com.revenuecat.purchases.awaitCreateSupportTicket
 import com.revenuecat.purchases.awaitCustomerCenterConfigData
 import com.revenuecat.purchases.awaitCustomerInfo
@@ -69,6 +70,9 @@ internal interface PurchasesType {
     @Throws(PurchasesException::class)
     suspend fun awaitGetWorkflow(workflowId: String): WorkflowDataResult
 
+    @Throws(PurchasesException::class)
+    suspend fun awaitGetUiConfig(): UiConfig
+
     fun workflowIdForOfferingId(offeringId: String): String?
 
     val useWorkflows: Boolean
@@ -146,6 +150,9 @@ internal class PurchasesImpl(private val purchases: Purchases = Purchases.shared
         return purchases.awaitGetWorkflow(workflowId)
     }
 
+    @Throws(PurchasesException::class)
+    override suspend fun awaitGetUiConfig(): UiConfig = purchases.awaitGetUiConfig()
+
     @OptIn(InternalRevenueCatAPI::class)
     override fun workflowIdForOfferingId(offeringId: String): String? =
         purchases.workflowIdForOfferingId(offeringId)

ui/revenuecatui/src/test/kotlin/com/revenuecat/purchases/ui/revenuecatui/data/MockPurchasesType.kt

@@ -7,6 +7,7 @@ import com.revenuecat.purchases.Offerings
 import com.revenuecat.purchases.PurchaseParams
 import com.revenuecat.purchases.PurchaseResult
 import com.revenuecat.purchases.PurchasesAreCompletedBy
+import com.revenuecat.purchases.UiConfig
 import com.revenuecat.purchases.common.events.FeatureEvent
 import com.revenuecat.purchases.common.workflows.WorkflowDataResult
 import com.revenuecat.purchases.customercenter.CustomerCenterConfigData
@@ -62,5 +63,9 @@ internal class MockPurchasesType(
         throw NotImplementedError("Mock implementation")
     }
 
+    override suspend fun awaitGetUiConfig(): UiConfig {
+        throw NotImplementedError("Mock implementation")
+    }
+
     override fun workflowIdForOfferingId(offeringId: String): String? = null
 }