Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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. */
Expand Down Expand Up @@ -151,24 +149,3 @@ public class SentryBackStackEntry(
public fun interface BackStackEntryMapper<T : Any> {
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<T : Any>(
private val currentMapper: () -> BackStackEntryMapper<T>,
) {
fun map(backStackEntry: T): SentryBackStackEntry? = Snapshot.withoutReadObservation {
currentMapper().map(backStackEntry)
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -144,37 +146,3 @@ internal fun <T : Any> 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<T : Any>(private val backStack: List<T>) {

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
}
}
Original file line number Diff line number Diff line change
@@ -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
}
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -144,7 +146,7 @@ internal class BackStackConverter<T : Any>(
) {

private val activeContainers = IdentityHashMap<Any, Unit>()
private var remainingValues = MAX_ARGUMENT_COUNT
private var remainingValues = MAX_ARGUMENT_VALUES
private var remainingCharacters = MAX_ARGUMENT_CHARACTERS
private var dropReason: ArgumentDropReason? = null

Expand Down Expand Up @@ -289,44 +291,6 @@ internal class BackStackConverter<T : Any>(

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."
Expand Down
Original file line number Diff line number Diff line change
@@ -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<T : Any>(private val backStack: List<T>) {

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
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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<T : Any>(
private val currentMapper: () -> BackStackEntryMapper<T>,
) {
fun map(backStackEntry: T): SentryBackStackEntry? = Snapshot.withoutReadObservation {
currentMapper().map(backStackEntry)
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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 {
Expand Down
Loading