reaktiv-introspection/io.github.syrou.reaktiv.introspection

Package-level declarations

Types

@Serializable

data class ClientMetadata(val appVersion: String? = null, val osVersion: String? = null, val reaktivVersion: String? = null, val locale: String? = null)

CrashHandler

actual class CrashHandler(platformContext: PlatformContext, sessionCapture: SessionCapture)

Platform-specific crash handler that captures session data on uncaught exceptions.

expect class CrashHandler(platformContext: PlatformContext, sessionCapture: SessionCapture)

Platform-specific crash handler that captures session data on uncaught exceptions.

actual class CrashHandler(platformContext: PlatformContext, sessionCapture: SessionCapture)

Platform-specific crash handler that captures session data on uncaught exceptions.

actual class CrashHandler(platformContext: PlatformContext, sessionCapture: SessionCapture)

Platform-specific crash handler that captures session data on uncaught exceptions.

actual class CrashHandler(platformContext: PlatformContext, sessionCapture: SessionCapture)

Platform-specific crash handler that captures session data on uncaught exceptions.

actual class CrashHandler(platformContext: PlatformContext, sessionCapture: SessionCapture)

Platform-specific crash handler that captures session data on uncaught exceptions.

actual class CrashHandler(platformContext: PlatformContext, sessionCapture: SessionCapture)

Platform-specific crash handler that captures session data on uncaught exceptions.

actual class CrashHandler(platformContext: PlatformContext, sessionCapture: SessionCapture)

Platform-specific crash handler that captures session data on uncaught exceptions.

DispatchTracingInstrumentation

class DispatchTracingInstrumentation : DispatchInstrumentation

IntrospectionConfig

data class IntrospectionConfig(val clientId: String = Uuid.random().toString(), val clientName: String = "Client-", val platform: String, val enabled: Boolean = true, val autoStart: Boolean = true, val installCrashHandler: Boolean = true, val installStallWatchdog: Boolean = true, val stallThresholdMs: Long = 300, val clientMetadata: ClientMetadata? = null, val redactor: StateRedactor? = null, val maxActions: Int? = null, val maxLogicEvents: Int? = null, val redactSensitiveKeys: Boolean = true, val installLogicTracing: Boolean = true, val sensitiveKeys: Set<String> = DEFAULT_SENSITIVE_KEYS)

Configuration for introspection identity and behavior.

PlatformContext

actual class PlatformContext

Platform-specific context wrapper.

expect class PlatformContext

Platform-specific context wrapper.

actual class PlatformContext

Platform-specific context wrapper.

actual class PlatformContext

Platform-specific context wrapper.

actual class PlatformContext

Platform-specific context wrapper.

RedactionFallbacks

object RedactionFallbacks

SessionFileExport

actual class SessionFileExport(platformContext: PlatformContext)

Platform-specific session file export.

expect class SessionFileExport(platformContext: PlatformContext)

Platform-specific session file export.

actual class SessionFileExport(platformContext: PlatformContext)

Platform-specific session file export.

actual class SessionFileExport(platformContext: PlatformContext)

Platform-specific session file export.

actual class SessionFileExport(platformContext: PlatformContext)

Platform-specific session file export.

actual class SessionFileExport(platformContext: PlatformContext)

Platform-specific session file export.

actual class SessionFileExport(platformContext: PlatformContext)

Platform-specific session file export.

actual class SessionFileExport(platformContext: PlatformContext)

Platform-specific session file export.

StallWatchdog

class StallWatchdog(scope: CoroutineScope, thresholdMs: Long = 300, heartbeatMs: Long = 100, monitoredDispatcher: CoroutineDispatcher? = null, stackCapturer: () -> String?? = null)

StateRedactor

fun interface StateRedactor

WireBudget

object WireBudget

Size budgets for anything assembled into a single DevTools message.

Properties

CLASS_DISCRIMINATOR_KEY

const val CLASS_DISCRIMINATOR_KEY: String

The key kotlinx.serialization writes the concrete type into for polymorphic values.

DEFAULT_SENSITIVE_KEYS

val ~~DEFAULT_SENSITIVE_KEYS~~: Set<String>

REDACTED_PLACEHOLDER

const val REDACTED_PLACEHOLDER: String

Functions

approximateWireBytes

fun NetworkRequestCapture.approximateWireBytes(): Int

Rough serialized size of this exchange, used to decide where to cut a batch.

browserIntrospectionConfig

fun browserIntrospectionConfig(appVersion: String? = null): IntrospectionConfig

decodeSessionBytes

suspend fun decodeSessionBytes(data: ByteArray): String

Returns the session JSON held in data, inflating it first when it is gzipped.

decodeSessionPayload

suspend fun decodeSessionPayload(payload: String): String

Reverses encodeSessionPayload, passing plain JSON through untouched.

encodeSessionPayload

suspend fun encodeSessionPayload(json: String): String

Encodes session JSON for transport as base64 of its gzipped bytes.

gzipCompress

expect suspend fun gzipCompress(data: ByteArray): ByteArray

Gzip codec used for session exports.

actual suspend fun gzipCompress(data: ByteArray): ByteArray

Gzip codec used for session exports.

actual suspend fun gzipCompress(data: ByteArray): ByteArray

Gzip codec used for session exports.

actual suspend fun gzipCompress(data: ByteArray): ByteArray

Gzip codec used for session exports.

gzipDecompress

expect suspend fun gzipDecompress(data: ByteArray): ByteArray

Inflates bytes produced by gzipCompress.

actual suspend fun gzipDecompress(data: ByteArray): ByteArray

Inflates bytes produced by gzipCompress.

actual suspend fun gzipDecompress(data: ByteArray): ByteArray

Inflates bytes produced by gzipCompress.

actual suspend fun gzipDecompress(data: ByteArray): ByteArray

Inflates bytes produced by gzipCompress.

isGzip

fun isGzip(data: ByteArray): Boolean

True when data starts with the gzip magic number.

isPlainSessionJson

fun isPlainSessionJson(payload: String): Boolean

True when payload looks like plain JSON rather than an encoded session.

restoreRedactedModuleElement

fun restoreRedactedModuleElement(json: Json, element: JsonObject): JsonObject

sensitiveKeyRedactor

fun ~~sensitiveKeyRedactor~~(keys: Set<String> = CoreSensitiveKeys, mask: String = REDACTED_PLACEHOLDER, discriminator: String = CLASS_DISCRIMINATOR_KEY): StateRedactor