From 123745ca4fcb100f8c4e096c0a0d4bfc36f5e781 Mon Sep 17 00:00:00 2001 From: Adam Brown Date: Fri, 20 Nov 2026 12:00:35 +0100 Subject: [PATCH] ref(nav3): Extract back stack helpers and argument limits --- .../navigation3/BackStackEntryMapper.kt | 23 ---------- .../compose/navigation3/SentryNavEffect.kt | 36 +-------------- .../internal/backstack/ArgumentConstraints.kt | 45 +++++++++++++++++++ .../internal/backstack/BackStackConverter.kt | 44 ++---------------- .../internal/backstack/BackStackKey.kt | 35 +++++++++++++++ .../internal/backstack/BackStackObserver.kt | 2 - .../backstack/CoordinatedBackStackObserver.kt | 1 - .../ForwardingBackStackEntryMapper.kt | 26 +++++++++++ .../backstack/BackStackConverterTest.kt | 1 - .../backstack}/BackStackKeyTest.kt | 2 +- .../backstack/BackStackObserverTest.kt | 1 - .../CoordinatedBackStackObserverTest.kt | 1 - .../ForwardingBackStackEntryMapperTest.kt | 4 +- 13 files changed, 116 insertions(+), 105 deletions(-) create mode 100644 sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/ArgumentConstraints.kt create mode 100644 sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackKey.kt create mode 100644 sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/ForwardingBackStackEntryMapper.kt rename sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/{ => internal/backstack}/BackStackKeyTest.kt (97%) rename sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/{ => internal/backstack}/ForwardingBackStackEntryMapperTest.kt (91%) diff --git a/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/BackStackEntryMapper.kt b/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/BackStackEntryMapper.kt index 4653debb3f4..f2af4c27fe3 100644 --- a/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/BackStackEntryMapper.kt +++ b/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/BackStackEntryMapper.kt @@ -1,7 +1,5 @@ package io.sentry.compose.navigation3 -import androidx.compose.runtime.snapshots.Snapshot -import io.sentry.compose.navigation3.internal.backstack.BackStackObserver import org.jetbrains.annotations.ApiStatus /** Info about a given back stack entry, suitable for display in Sentry. */ @@ -151,24 +149,3 @@ public class SentryBackStackEntry( public fun interface BackStackEntryMapper { public fun map(backStackEntry: T): SentryBackStackEntry? } - -/** - * A Compose-compatible version of [BackStackEntryMapper] that generates [SentryBackStackEntry]s by - * forwarding the request to the host app mapper in effect at the time [map] is called. - * - * Dynamically determining the current mapper lets us separate two concerns: - * - * 1. the lifetime of a consumer that tracks navigation state over time (e.g., [BackStackObserver]); - * and - * 2. the lifetime of the mapper used to generate `SentryBackStackEntry`s. - * - * Without that separation, a long-lived consumer would have to choose between holding stale mapping - * logic or recreating its own state whenever the mapper changed. - */ -internal class ForwardingBackStackEntryMapper( - private val currentMapper: () -> BackStackEntryMapper, -) { - fun map(backStackEntry: T): SentryBackStackEntry? = Snapshot.withoutReadObservation { - currentMapper().map(backStackEntry) - } -} diff --git a/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/SentryNavEffect.kt b/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/SentryNavEffect.kt index a00dfafeb9c..0646c13ad90 100644 --- a/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/SentryNavEffect.kt +++ b/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/SentryNavEffect.kt @@ -9,7 +9,9 @@ import androidx.lifecycle.compose.LocalLifecycleOwner import io.sentry.IScopes import io.sentry.ScopesAdapter import io.sentry.SentryOptions +import io.sentry.compose.navigation3.internal.backstack.BackStackKey import io.sentry.compose.navigation3.internal.backstack.CoordinatedBackStackObserver +import io.sentry.compose.navigation3.internal.backstack.ForwardingBackStackEntryMapper import io.sentry.compose.navigation3.internal.backstack.defaultNavLeaseCoordinator import io.sentry.compose.navigation3.internal.lifecycle.NavLeaseCoordinator import io.sentry.compose.navigation3.internal.lifecycle.NavRootInfo @@ -144,37 +146,3 @@ internal fun SentryNavEffect( onDispose {} } } - -/** - * A key for distinguishing back stacks over time. - * - * Lets `*Effect`s restart when either the identity of a stack entry changes or the stack's entries - * are reordered. - */ -internal class BackStackKey(private val backStack: List) { - - override fun equals(other: Any?): Boolean { - // Use of identity rather than structural equality frees us from entries' equals() and - // hashCode() implementations, which are provided by the host app and may be incomplete, - // expensive, or incorrect for our purposes. - if (this === other) { - return true - } - if (other !is BackStackKey<*>) { - return false - } - if (backStack.size != other.backStack.size) { - return false - } - - return backStack.indices.all { index -> backStack[index] === other.backStack[index] } - } - - override fun hashCode(): Int { - var result = backStack.size - for (entry in backStack) { - result = 31 * result + System.identityHashCode(entry) - } - return result - } -} diff --git a/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/ArgumentConstraints.kt b/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/ArgumentConstraints.kt new file mode 100644 index 00000000000..42b428c7108 --- /dev/null +++ b/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/ArgumentConstraints.kt @@ -0,0 +1,45 @@ +package io.sentry.compose.navigation3.internal.backstack + +internal object ArgumentConstraints { + + /** + * Max combined length of map keys and text values visited in one back stack update. + * + * If exceeded, the entry that overflows loses its arguments, as do older entries; newer entries + * are preserved. + * + * Caps payload size in the presence of large individual arguments. + */ + const val MAX_ARGUMENT_CHARACTERS = 4_096 + + /** + * Max depth of an argument value within one back stack entry. Root arguments have depth 1; each + * nested map or list adds one level. + * + * For instance, `mapOf("id" to 123)` reaches a depth of 1; `mapOf("items" to listOf("apple", + * "banana"))` reaches a depth of 2. + * + * If exceeded, all arguments for that back stack entry are dropped. + */ + const val MAX_ARGUMENT_DEPTH = 10 + + /** + * Max number of argument values visited in one back stack update. Each scalar or nested container + * counts as one value; map keys and each entry's root argument map are excluded. + * + * For instance, `mapOf("id" to 123)` consumes 1 value; `mapOf("profile" to mapOf("id" to 123, + * "name" to "Ada"))` consumes 3 values. + * + * If exceeded, the entry that overflows loses its arguments, as do older entries; newer entries + * are preserved. + * + * For instance, suppose we have the following back stack: + * + * - /Checkout -> Top of the stack and processed first + * - /ProductDetail -> Processed second and exceeds the `MAX_ARGUMENT_VALUES` budget + * - /Home + * + * Then /ProductDetail and /Home will have no arguments, but /Checkout will. + */ + const val MAX_ARGUMENT_VALUES = 200 +} diff --git a/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackConverter.kt b/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackConverter.kt index 4e9966bad3a..d20ba285fd1 100644 --- a/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackConverter.kt +++ b/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackConverter.kt @@ -3,8 +3,10 @@ package io.sentry.compose.navigation3.internal.backstack import io.sentry.ILogger import io.sentry.SentryLevel.WARNING import io.sentry.compose.navigation3.BackStackEntryMapper -import io.sentry.compose.navigation3.ForwardingBackStackEntryMapper import io.sentry.compose.navigation3.SentryBackStackEntry +import io.sentry.compose.navigation3.internal.backstack.ArgumentConstraints.MAX_ARGUMENT_CHARACTERS +import io.sentry.compose.navigation3.internal.backstack.ArgumentConstraints.MAX_ARGUMENT_DEPTH +import io.sentry.compose.navigation3.internal.backstack.ArgumentConstraints.MAX_ARGUMENT_VALUES import io.sentry.compose.navigation3.internal.backstack.ArgumentDropReason.Companion.ARGUMENT_DROP_REASON_KEY import io.sentry.compose.navigation3.internal.backstack.NormalizedSentryBackStackEntry.Companion.UNKNOWN_ENTRY_NAME import io.sentry.util.ExceptionUtils @@ -144,7 +146,7 @@ internal class BackStackConverter( ) { private val activeContainers = IdentityHashMap() - private var remainingValues = MAX_ARGUMENT_COUNT + private var remainingValues = MAX_ARGUMENT_VALUES private var remainingCharacters = MAX_ARGUMENT_CHARACTERS private var dropReason: ArgumentDropReason? = null @@ -289,44 +291,6 @@ internal class BackStackConverter( private companion object { - /** - * Max nesting depth allowed while sanitizing a single argument value for a given back stack - * entry. - * - * For instance, `mapOf("id" to 123)` has a depth of 1; `mapOf("items" to listOf("apple", - * "banana"))` has a depth of 2. - * - * If exceeded, all arguments for that back stack entry are dropped. - */ - private const val MAX_ARGUMENT_DEPTH = 10 - - /** - * Max number of argument values visited while sanitizing all entries in a given back stack - * update. - * - * For instance, `mapOf("id" to 123)` consumes 1 value; `mapOf("profile" to mapOf("id" to 123, - * "name" to "Ada"))` consumes 3 values. - * - * If exceeded, the entry that overflows loses its arguments, as do older entries; newer - * entries are preserved. - * - * For instance, suppose we have the following back stack: - * - * - /Checkout -> Top of the stack and processed first - * - /ProductDetail -> Processed second and overflows the `MAX_ARGUMENT_VALUES` budget - * - /Home - * - * Then /ProductDetail and /Home will have no arguments, but /Checkout will. - */ - private const val MAX_ARGUMENT_COUNT = 200 - - /** - * Max number of characters visited while sanitizing all entries in a given back stack update. - * - * Caps payload size in the presence of large individual arguments. - */ - private const val MAX_ARGUMENT_CHARACTERS = 4_096 - private const val MAX_CHARACTER_WARNING = "Nav3 arguments exceeded the maximum total character count for one backstack update. Skipping " + "arguments for this and older captured entries." diff --git a/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackKey.kt b/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackKey.kt new file mode 100644 index 00000000000..79528abccc7 --- /dev/null +++ b/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackKey.kt @@ -0,0 +1,35 @@ +package io.sentry.compose.navigation3.internal.backstack + +/** + * A key for distinguishing back stacks over time. + * + * Lets `*Effect`s restart when either the identity of a stack entry changes or the stack's entries + * are reordered. + */ +internal class BackStackKey(private val backStack: List) { + + override fun equals(other: Any?): Boolean { + // Use of identity rather than structural equality frees us from entries' equals() and + // hashCode() implementations, which are provided by the host app and may be incomplete, + // expensive, or incorrect for our purposes. + if (this === other) { + return true + } + if (other !is BackStackKey<*>) { + return false + } + if (backStack.size != other.backStack.size) { + return false + } + + return backStack.indices.all { index -> backStack[index] === other.backStack[index] } + } + + override fun hashCode(): Int { + var result = backStack.size + for (entry in backStack) { + result = 31 * result + System.identityHashCode(entry) + } + return result + } +} diff --git a/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackObserver.kt b/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackObserver.kt index 1ff3911032e..8cf28a3a3fd 100644 --- a/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackObserver.kt +++ b/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackObserver.kt @@ -5,9 +5,7 @@ import io.sentry.Hint import io.sentry.SentryIntegrationPackageStorage import io.sentry.SentryLevel.INFO import io.sentry.SentryOptions -import io.sentry.compose.navigation3.BackStackKey import io.sentry.compose.navigation3.BuildConfig -import io.sentry.compose.navigation3.ForwardingBackStackEntryMapper import io.sentry.compose.navigation3.SentryNavEffect import io.sentry.compose.navigation3.SentryNavOptions import io.sentry.compose.navigation3.internal.backstack.BackStackConverter.RetentionPolicy diff --git a/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/CoordinatedBackStackObserver.kt b/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/CoordinatedBackStackObserver.kt index 7479a1981cf..a7d30a998f3 100644 --- a/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/CoordinatedBackStackObserver.kt +++ b/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/CoordinatedBackStackObserver.kt @@ -3,7 +3,6 @@ package io.sentry.compose.navigation3.internal.backstack import androidx.lifecycle.LifecycleEventObserver import io.sentry.IScope import io.sentry.IScopes -import io.sentry.compose.navigation3.ForwardingBackStackEntryMapper import io.sentry.compose.navigation3.SentryNavOptions import io.sentry.compose.navigation3.internal.lifecycle.NavLeaseCoordinator import io.sentry.compose.navigation3.internal.lifecycle.NavRootInfo diff --git a/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/ForwardingBackStackEntryMapper.kt b/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/ForwardingBackStackEntryMapper.kt new file mode 100644 index 00000000000..3891b03bbf6 --- /dev/null +++ b/sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/internal/backstack/ForwardingBackStackEntryMapper.kt @@ -0,0 +1,26 @@ +package io.sentry.compose.navigation3.internal.backstack + +import androidx.compose.runtime.snapshots.Snapshot +import io.sentry.compose.navigation3.BackStackEntryMapper +import io.sentry.compose.navigation3.SentryBackStackEntry + +/** + * A Compose-compatible version of [BackStackEntryMapper] that generates [SentryBackStackEntry]s by + * forwarding the request to the host app mapper in effect at the time [map] is called. + * + * Dynamically determining the current mapper lets us separate two concerns: + * + * 1. the lifetime of a consumer that tracks navigation state over time (e.g., [BackStackObserver]); + * and + * 2. the lifetime of the mapper used to generate `SentryBackStackEntry`s. + * + * Without that separation, a long-lived consumer would have to choose between holding stale mapping + * logic or recreating its own state whenever the mapper changed. + */ +internal class ForwardingBackStackEntryMapper( + private val currentMapper: () -> BackStackEntryMapper, +) { + fun map(backStackEntry: T): SentryBackStackEntry? = Snapshot.withoutReadObservation { + currentMapper().map(backStackEntry) + } +} diff --git a/sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackConverterTest.kt b/sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackConverterTest.kt index 40f1430ccb4..9799eee8357 100644 --- a/sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackConverterTest.kt +++ b/sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackConverterTest.kt @@ -4,7 +4,6 @@ import com.google.common.truth.Truth.assertThat import io.sentry.ILogger import io.sentry.SentryLevel.WARNING import io.sentry.compose.navigation3.BackStackEntryMapper -import io.sentry.compose.navigation3.ForwardingBackStackEntryMapper import io.sentry.compose.navigation3.SentryBackStackEntry import io.sentry.compose.navigation3.internal.backstack.ArgumentDropReason.Companion.ARGUMENT_DROP_REASON_KEY import io.sentry.compose.navigation3.internal.backstack.BackStackConverter.RetentionPolicy diff --git a/sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/BackStackKeyTest.kt b/sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackKeyTest.kt similarity index 97% rename from sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/BackStackKeyTest.kt rename to sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackKeyTest.kt index 16ec65cc4af..fa7ade0a143 100644 --- a/sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/BackStackKeyTest.kt +++ b/sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackKeyTest.kt @@ -1,4 +1,4 @@ -package io.sentry.compose.navigation3 +package io.sentry.compose.navigation3.internal.backstack import com.google.common.truth.Truth.assertThat import org.junit.Test diff --git a/sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackObserverTest.kt b/sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackObserverTest.kt index f68eac8ccfa..250a0c0ab08 100644 --- a/sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackObserverTest.kt +++ b/sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/internal/backstack/BackStackObserverTest.kt @@ -19,7 +19,6 @@ import io.sentry.SentryTracer import io.sentry.TransactionContext import io.sentry.TransactionOptions import io.sentry.compose.navigation3.BackStackEntryMapper -import io.sentry.compose.navigation3.ForwardingBackStackEntryMapper import io.sentry.compose.navigation3.SentryBackStackEntry import io.sentry.compose.navigation3.SentryNavOptions import io.sentry.compose.navigation3.internal.backstack.ArgumentDropReason.Companion.ARGUMENT_DROP_REASON_KEY diff --git a/sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/internal/backstack/CoordinatedBackStackObserverTest.kt b/sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/internal/backstack/CoordinatedBackStackObserverTest.kt index 600e3b5e0d7..c0054136029 100644 --- a/sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/internal/backstack/CoordinatedBackStackObserverTest.kt +++ b/sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/internal/backstack/CoordinatedBackStackObserverTest.kt @@ -17,7 +17,6 @@ import io.sentry.SpanContext import io.sentry.TransactionContext import io.sentry.TransactionOptions import io.sentry.compose.navigation3.BackStackEntryMapper -import io.sentry.compose.navigation3.ForwardingBackStackEntryMapper import io.sentry.compose.navigation3.SentryBackStackEntry import io.sentry.compose.navigation3.SentryNavOptions import io.sentry.compose.navigation3.internal.lifecycle.INavStatePublisher diff --git a/sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/ForwardingBackStackEntryMapperTest.kt b/sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/internal/backstack/ForwardingBackStackEntryMapperTest.kt similarity index 91% rename from sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/ForwardingBackStackEntryMapperTest.kt rename to sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/internal/backstack/ForwardingBackStackEntryMapperTest.kt index 35f1df879ba..6f56285b496 100644 --- a/sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/ForwardingBackStackEntryMapperTest.kt +++ b/sentry-android-navigation3/src/test/kotlin/io/sentry/compose/navigation3/internal/backstack/ForwardingBackStackEntryMapperTest.kt @@ -1,8 +1,10 @@ -package io.sentry.compose.navigation3 +package io.sentry.compose.navigation3.internal.backstack import androidx.compose.runtime.mutableStateOf import androidx.compose.runtime.snapshots.Snapshot import com.google.common.truth.Truth.assertThat +import io.sentry.compose.navigation3.BackStackEntryMapper +import io.sentry.compose.navigation3.SentryBackStackEntry import org.junit.Test class ForwardingBackStackEntryMapperTest {