feat(paywalls): add web_view component schema

alexrepty · alexrepty · commit 9e93b6c45b2e · 2026-06-26T12:40:55.000+02:00
Introduces the Paywalls V2 `web_view` component (`WebViewComponent`) and registers it in the `PaywallComponent` sealed hierarchy / serializer. Adds the minimal cross-module `when` branches required for the project to compile now that the sealed type has a new member (StyleFactory returns no style yet; image pre-download and unsupported-condition checks treat it as a leaf / traverse its fallback).

No rendering, CSP, messaging, or pre-warming yet — those land in later PRs in the stack.

Recommended labels: pr:other
diff --git a/purchases/src/main/kotlin/com/revenuecat/purchases/paywalls/components/PaywallComponent.kt b/purchases/src/main/kotlin/com/revenuecat/purchases/paywalls/components/PaywallComponent.kt
@@ -57,6 +57,7 @@ internal class PaywallComponentSerializer : KSerializer<PaywallComponent> {
             "tabs" -> jsonDecoder.json.decodeFromJsonElement<TabsComponent>(json)
             "video" -> jsonDecoder.json.decodeFromJsonElement<VideoComponent>(json)
             "countdown" -> jsonDecoder.json.decodeFromJsonElement<CountdownComponent>(json)
+            "web_view" -> jsonDecoder.json.decodeFromJsonElement<WebViewComponent>(json)
             "fallback_header" -> FallbackHeaderComponent
             else -> json["fallback"]
                 ?.let { it as? JsonObject }
diff --git a/purchases/src/main/kotlin/com/revenuecat/purchases/paywalls/components/WebViewComponent.kt b/purchases/src/main/kotlin/com/revenuecat/purchases/paywalls/components/WebViewComponent.kt
@@ -0,0 +1,43 @@
+package com.revenuecat.purchases.paywalls.components
+
+import androidx.compose.runtime.Immutable
+import com.revenuecat.purchases.InternalRevenueCatAPI
+import com.revenuecat.purchases.paywalls.components.properties.Size
+import com.revenuecat.purchases.paywalls.components.properties.SizeConstraint
+import com.revenuecat.purchases.paywalls.components.properties.SizeConstraint.Fill
+import dev.drewhamilton.poko.Poko
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+
+/**
+ * A Paywalls V2 component that renders generic hosted web content (a web bundle entrypoint) inside a
+ * web view.
+ *
+ * Only [protocolVersion] `1` is currently supported. When [protocolVersion] is present the SDK
+ * isolates the web content from external sources (see the content blocking applied in the UI module):
+ * the bundle must be fully self-contained.
+ *
+ * Any schema-declared `capabilities` are intentionally ignored for v1.
+ */
+@InternalRevenueCatAPI
+@Poko
+@Serializable
+@SerialName("web_view")
+@Immutable
+public class WebViewComponent(
+    @get:JvmSynthetic
+    public val url: String,
+    @get:JvmSynthetic
+    public val id: String? = null,
+    @get:JvmSynthetic
+    public val name: String? = null,
+    @get:JvmSynthetic
+    public val visible: Boolean? = null,
+    @SerialName("protocol_version")
+    @get:JvmSynthetic
+    public val protocolVersion: Int? = null,
+    @get:JvmSynthetic
+    public val size: Size = Size(width = Fill, height = SizeConstraint.Fit),
+    @get:JvmSynthetic
+    public val fallback: StackComponent? = null,
+) : PaywallComponent
diff --git a/purchases/src/main/kotlin/com/revenuecat/purchases/utils/PaywallComponentFilterExtension.kt b/purchases/src/main/kotlin/com/revenuecat/purchases/utils/PaywallComponentFilterExtension.kt
@@ -20,6 +20,7 @@ import com.revenuecat.purchases.paywalls.components.TabsComponent
 import com.revenuecat.purchases.paywalls.components.TextComponent
 import com.revenuecat.purchases.paywalls.components.TimelineComponent
 import com.revenuecat.purchases.paywalls.components.VideoComponent
+import com.revenuecat.purchases.paywalls.components.WebViewComponent
 
 /**
  * Returns all PaywallComponent that satisfy the predicate.
@@ -67,6 +68,10 @@ internal fun PaywallComponent.filter(predicate: (PaywallComponent) -> Boolean):
                 current.fallback?.let { queue.add(it) }
             }
 
+            is WebViewComponent -> {
+                current.fallback?.let { queue.add(it) }
+            }
+
             is FallbackHeaderComponent,
             is VideoComponent,
             is TabControlToggleComponent,
diff --git a/purchases/src/main/kotlin/com/revenuecat/purchases/utils/PaywallComponentsImagePreDownloader.kt b/purchases/src/main/kotlin/com/revenuecat/purchases/utils/PaywallComponentsImagePreDownloader.kt
@@ -26,6 +26,7 @@ import com.revenuecat.purchases.paywalls.components.TabsComponent
 import com.revenuecat.purchases.paywalls.components.TextComponent
 import com.revenuecat.purchases.paywalls.components.TimelineComponent
 import com.revenuecat.purchases.paywalls.components.VideoComponent
+import com.revenuecat.purchases.paywalls.components.WebViewComponent
 import com.revenuecat.purchases.paywalls.components.common.Background
 import com.revenuecat.purchases.paywalls.components.common.ComponentOverride
 import com.revenuecat.purchases.paywalls.components.common.PaywallComponentsConfig
@@ -106,6 +107,7 @@ internal class PaywallComponentsImagePreDownloader(
                     is TabControlToggleComponent,
                     is TextComponent,
                     is TimelineComponent,
+                    is WebViewComponent,
                     -> emptySet()
                 }
             }
diff --git a/purchases/src/test/java/com/revenuecat/purchases/paywalls/components/WebViewComponentTests.kt b/purchases/src/test/java/com/revenuecat/purchases/paywalls/components/WebViewComponentTests.kt
@@ -0,0 +1,139 @@
+package com.revenuecat.purchases.paywalls.components
+
+import com.revenuecat.purchases.JsonTools
+import com.revenuecat.purchases.paywalls.components.properties.Size
+import com.revenuecat.purchases.paywalls.components.properties.SizeConstraint
+import org.assertj.core.api.Assertions.assertThat
+import org.intellij.lang.annotations.Language
+import org.junit.Test
+import kotlin.test.assertEquals
+
+class WebViewComponentTests {
+
+    @Language("json")
+    private val fullJson = """
+        {
+          "id": "promo_web_view",
+          "type": "web_view",
+          "protocol_version": 1,
+          "url": "https://assets.pawwalls.com/web_bundles/123/index.html",
+          "size": {
+            "width": { "type": "fill" },
+            "height": { "type": "fit" }
+          },
+          "visible": true,
+          "name": "Promo web component",
+          "fallback": {
+            "id": "promo_web_view_fallback",
+            "type": "stack",
+            "components": [
+              { "type": "stack", "components": [] }
+            ],
+            "size": {
+              "width": { "type": "fill" },
+              "height": { "type": "fit" }
+            },
+            "dimension": {
+              "type": "vertical",
+              "alignment": "center",
+              "distribution": "start"
+            },
+            "padding": { "top": 0, "bottom": 0, "leading": 0, "trailing": 0 },
+            "margin": { "top": 0, "bottom": 0, "leading": 0, "trailing": 0 }
+          }
+        }
+        """
+
+    @Test
+    fun `deserializes full Khepri schema`() {
+        val actual = JsonTools.json.decodeFromString<PaywallComponent>(fullJson)
+
+        assertThat(actual).isInstanceOf(WebViewComponent::class.java)
+        val webView = actual as WebViewComponent
+
+        assertThat(webView.id).isEqualTo("promo_web_view")
+        assertThat(webView.name).isEqualTo("Promo web component")
+        assertThat(webView.visible).isTrue()
+        assertThat(webView.protocolVersion).isEqualTo(1)
+        assertThat(webView.url).isEqualTo("https://assets.pawwalls.com/web_bundles/123/index.html")
+        assertThat(webView.size).isEqualTo(Size(width = SizeConstraint.Fill, height = SizeConstraint.Fit))
+
+        // The fallback is decoded as a normal Stack, and its children are not stripped.
+        val fallback = webView.fallback
+        assertThat(fallback).isNotNull
+        assertThat(fallback!!.components).hasSize(1)
+        assertThat(fallback.components.first()).isInstanceOf(StackComponent::class.java)
+    }
+
+    @Test
+    fun `ignores capabilities declared by the schema`() {
+        // v1 isolates entirely from external sources via a fixed CSP, so any schema-declared
+        // capabilities are decoded-and-ignored rather than failing to parse.
+        @Language("json")
+        val json = """
+            {
+              "type": "web_view",
+              "url": "https://paywalls.revenuecat.com/index.html",
+              "capabilities": {
+                "network_access": { "allowed_domains": ["api.segment.io"] },
+                "camera": true,
+                "microphone": true,
+                "clipboard_write": true,
+                "clipboard_read": true,
+                "geolocation": true
+              }
+            }
+            """
+
+        val actual = JsonTools.json.decodeFromString<PaywallComponent>(json)
+
+        assertEquals(
+            WebViewComponent(url = "https://paywalls.revenuecat.com/index.html"),
+            actual,
+        )
+    }
+
+    @Test
+    fun `deserializes template url correctly`() {
+        @Language("json")
+        val templateJson = """
+            {
+              "type": "web_view",
+              "protocol_version": 1,
+              "url": "https://paywalls.revenuecat.com/{{ custom.animal }}.html"
+            }
+            """
+
+        val actual = JsonTools.json.decodeFromString<PaywallComponent>(templateJson)
+
+        assertEquals(
+            WebViewComponent(
+                url = "https://paywalls.revenuecat.com/{{ custom.animal }}.html",
+                protocolVersion = 1,
+            ),
+            actual,
+        )
+    }
+
+    @Test
+    fun `deserializes minimal shape with defaults for missing optional fields`() {
+        // Older/partial configs may omit protocol_version, size and fallback. These should still
+        // decode without crashing, using defaults.
+        @Language("json")
+        val minimalJson = """
+            {
+              "type": "web_view",
+              "url": "https://paywalls.revenuecat.com/index.html"
+            }
+            """
+
+        val actual = JsonTools.json.decodeFromString<PaywallComponent>(minimalJson)
+
+        assertEquals(
+            WebViewComponent(url = "https://paywalls.revenuecat.com/index.html"),
+            actual,
+        )
+        assertThat((actual as WebViewComponent).fallback).isNull()
+        assertThat(actual.protocolVersion).isNull()
+    }
+}
diff --git a/ui/revenuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/components/style/StyleFactory.kt b/ui/revenuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/components/style/StyleFactory.kt
@@ -27,6 +27,7 @@ import com.revenuecat.purchases.paywalls.components.TabsComponent
 import com.revenuecat.purchases.paywalls.components.TextComponent
 import com.revenuecat.purchases.paywalls.components.TimelineComponent
 import com.revenuecat.purchases.paywalls.components.VideoComponent
+import com.revenuecat.purchases.paywalls.components.WebViewComponent
 import com.revenuecat.purchases.paywalls.components.common.Background
 import com.revenuecat.purchases.paywalls.components.common.LocaleId
 import com.revenuecat.purchases.paywalls.components.common.LocalizationKey
@@ -573,6 +574,7 @@ internal class StyleFactory(
             is TabsComponent -> createTabsComponentStyle(component)
             is VideoComponent -> createVideoComponentStyle(component)
             is FallbackHeaderComponent -> Result.Success(null)
+            is WebViewComponent -> Result.Success(null)
             is CountdownComponent -> createCountdownComponentStyle(
                 component,
             )
diff --git a/ui/revenuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/helpers/OfferingToStateMapper.kt b/ui/revenuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/helpers/OfferingToStateMapper.kt
@@ -25,6 +25,7 @@ import com.revenuecat.purchases.paywalls.components.TabsComponent
 import com.revenuecat.purchases.paywalls.components.TextComponent
 import com.revenuecat.purchases.paywalls.components.TimelineComponent
 import com.revenuecat.purchases.paywalls.components.VideoComponent
+import com.revenuecat.purchases.paywalls.components.WebViewComponent
 import com.revenuecat.purchases.paywalls.components.common.ComponentOverride
 import com.revenuecat.purchases.paywalls.components.common.LocalizationData
 import com.revenuecat.purchases.paywalls.components.common.LocalizationKey
@@ -516,6 +517,7 @@ internal fun PaywallComponent.containsUnsupportedCondition(): Boolean = when (th
     is TabControlToggleComponent -> false
     is TabControlComponent -> false
     is FallbackHeaderComponent -> false
+    is WebViewComponent -> fallback?.containsUnsupportedCondition() == true
 }
 
 @JvmSynthetic
diff --git a/ui/revenuecatui/src/test/kotlin/com/revenuecat/purchases/ui/revenuecatui/components/tabs/TabsComponentViewTests.kt b/ui/revenuecatui/src/test/kotlin/com/revenuecat/purchases/ui/revenuecatui/components/tabs/TabsComponentViewTests.kt
@@ -39,6 +39,7 @@ import com.revenuecat.purchases.paywalls.components.TabsComponent
 import com.revenuecat.purchases.paywalls.components.TextComponent
 import com.revenuecat.purchases.paywalls.components.TimelineComponent
 import com.revenuecat.purchases.paywalls.components.VideoComponent
+import com.revenuecat.purchases.paywalls.components.WebViewComponent
 import com.revenuecat.purchases.paywalls.components.common.Background
 import com.revenuecat.purchases.paywalls.components.common.ComponentOverride
 import com.revenuecat.purchases.paywalls.components.common.ComponentsConfig
@@ -1298,7 +1299,8 @@ class TabsComponentViewTests {
                 is IconComponent,
                 is TextComponent,
                 is VideoComponent,
-                    -> {
+                is WebViewComponent,
+                -> {
                     // These don't have child components.
                 }
             }
