reaktiv-devtools/io.github.syrou.reaktiv.devtools.protocol

Package-level declarations

Types

data class ChurnEntry(val composable: String, val statesRead: List<String>, val changeEvents: Int)

@Serializable

data class ClientInfo(val clientId: String, val clientName: String, val platform: String, val role: ClientRole, val publisherClientId: String? = null, val connectedAt: Long, val isGhost: Boolean = false)

ClientRole

@Serializable

enum ClientRole : Enum<ClientRole>

CurlFormatter

object CurlFormatter

DeviceLogEntry

@Serializable

data class ~~DeviceLogEntry~~(val level: String, val category: String, val message: String, val timestampMs: Long)

DevToolsMessage

@Serializable

sealed class DevToolsMessage

DevTools network protocol messages.

DevToolsProtocol

object DevToolsProtocol

DispatchStats

data class DispatchStats(val processedActions: Int, val avgQueueWaitMs: Long, val maxQueueWaitMs: Long, val maxQueueDepth: Int, val totalProcessMs: Long)

Finding

data class Finding(val severity: FindingSeverity, val category: String, val title: String, val detail: String, val timestampMs: Long? = null, val sourceFile: String? = null, val lineNumber: Int? = null, val githubUrl: String? = null, val advice: FindingAdvice? = null, val culprits: List<String> = emptyList(), val stacks: List<FindingStack> = emptyList())

FindingAdvice

data class FindingAdvice(val meaning: String, val impact: String, val fix: String)

FindingSeverity

enum FindingSeverity : Enum<FindingSeverity>

FindingStack

data class FindingStack(val label: String, val stack: String)

GhostSessionExport

typealias GhostSessionExport = SessionExport

GhostSessionFormat

typealias GhostSessionFormat = SessionExportFormat

MethodStats

data class MethodStats(val logicClass: String, val methodName: String, val calls: Int, val finished: Int, val failures: Int, val totalMs: Long, val maxMs: Long, val threads: Set<String> = emptySet(), val dispatchers: Set<String> = emptySet(), val maxConcurrent: Int = 0, val peakThreads: Set<String> = emptySet(), val sourceFile: String? = null, val lineNumber: Int? = null, val githubSourceUrl: String? = null, val failureType: String? = null, val failureMessage: String? = null)

ModuleSizeStats

data class ModuleSizeStats(val moduleName: String, val currentBytes: Int, val maxBytes: Int, val firstBytes: Int, val samples: Int, val growthStreak: Int, val topGrowingField: String? = null, val topGrowingFieldGrowthBytes: Int = 0)

NavigationAttempt

data class NavigationAttempt(val timestampMs: Long, val name: String, val target: String, val outcome: String?, val durationMs: Long?, val isGuard: Boolean)

What a navigation attempt or guard evaluation did.

NavigationEntrySnapshot

data class NavigationEntrySnapshot(val path: String, val params: Map<String, String>)

One entry in a captured back stack.

NavigationSnapshot

data class NavigationSnapshot(val moduleKey: String, val backStack: List<NavigationEntrySnapshot>, val currentPath: String?, val graphChain: List<String>, val isCurrentModal: Boolean, val isBootstrapping: Boolean, val isEvaluating: Boolean, val modalContextPaths: List<String>)

The navigation position at a point in a session, read out of a captured state tree.

SpanKind

enum SpanKind : Enum<SpanKind>

StallGroup

data class ~~StallGroup~~(val stack: String?, val count: Int, val worstMs: Long)

StateSizeTracker

class StateSizeTracker

ThreadStats

data class ThreadStats(val thread: String, val calls: Int, val busyMs: Long, val maxConcurrent: Int, val contenders: Set<String> = emptySet())

Properties

CONGESTION_PEAK_THRESHOLD

const val CONGESTION_PEAK_THRESHOLD: Int = 3

DISPATCH_QUEUE_WAIT_WARN_MS

const val DISPATCH_QUEUE_WAIT_WARN_MS: Long = 100

DISPATCH_TRACE_CLASS

const val DISPATCH_TRACE_CLASS: String

FINDING_CHURN_WARN_EVENTS

const val FINDING_CHURN_WARN_EVENTS: Int = 50

FINDING_QUEUE_WAIT_WARN_MS

const val ~~FINDING_QUEUE_WAIT_WARN_MS~~: Long

FINDING_REDUCER_WARN_MS

const val FINDING_REDUCER_WARN_MS: Long = 8

FINDING_STORM_EVENTS

const val FINDING_STORM_EVENTS: Int = 20

FINDING_STORM_WINDOW_MS

const val FINDING_STORM_WINDOW_MS: Long = 1000

GUARD_TRACE_CLASS

const val GUARD_TRACE_CLASS: String

Mirrors the value reaktiv-navigation emits for guard spans.

kind

val LogicMethodStart.kind: SpanKind

val MethodStats.kind: SpanKind

NAVIGATION_TRACE_CLASS

const val NAVIGATION_TRACE_CLASS: String

Mirrors the value reaktiv-navigation emits for the span around a navigate call.

PERFORMANCE_FINDING_CATEGORIES

val PERFORMANCE_FINDING_CATEGORIES: Set<String>

PHASE_TRACE_CLASS

const val PHASE_TRACE_CLASS: String

REDACTION_TRACE_CLASS

const val REDACTION_TRACE_CLASS: String

SIZE_GROWTH_PERCENT_THRESHOLD

const val SIZE_GROWTH_PERCENT_THRESHOLD: Int = 50

SIZE_GROWTH_STREAK_THRESHOLD

const val SIZE_GROWTH_STREAK_THRESHOLD: Int = 10

STALL_TRACE_CLASS

const val STALL_TRACE_CLASS: String

SYNTHETIC_TRACE_CLASSES

val SYNTHETIC_TRACE_CLASSES: Set<String>

Functions

aggregateChurn

fun aggregateChurn(actions: List<CapturedAction>, reads: List<StateRead>): List<ChurnEntry>

aggregateDispatchStats

fun aggregateDispatchStats(started: List<LogicMethodStart>, completed: List<LogicMethodCompleted>, failed: List<LogicMethodFailed>): DispatchStats?

aggregateLogicStats

fun aggregateLogicStats(started: List<LogicMethodStart>, completed: List<LogicMethodCompleted>, failed: List<LogicMethodFailed>): List<MethodStats>

aggregateStalls

fun ~~aggregateStalls~~(started: List<LogicMethodStart>, completed: List<LogicMethodCompleted>): List<StallGroup>

aggregateThreadStats

fun aggregateThreadStats(started: List<LogicMethodStart>, completed: List<LogicMethodCompleted>, failed: List<LogicMethodFailed>): List<ThreadStats>

asClipboardText

fun Finding.asClipboardText(): String

buildNavigationLog

fun buildNavigationLog(starts: List<LogicMethodStart>, completions: List<LogicMethodCompleted>): List<NavigationAttempt>

Pairs navigation and guard spans with their verdicts, newest last.

computeFindings

fun computeFindings(starts: List<LogicMethodStart>, completions: List<LogicMethodCompleted>, sizes: List<ModuleSizeStats> = emptyList(), churn: List<ChurnEntry> = emptyList(), network: List<NetworkRequestCapture> = emptyList(), failures: List<LogicMethodFailed> = emptyList()): List<Finding>

isMainThread

fun isMainThread(thread: String): Boolean

parseNavigationState

fun parseNavigationState(stateJson: String): NavigationSnapshot?

Reads the navigation position out of a full state tree, or returns null when the tree holds no navigation module.

stallCulprits

fun ~~stallCulprits~~(started: List<LogicMethodStart>, completed: List<LogicMethodCompleted>, failed: List<LogicMethodFailed>): List<MethodStats>