Merge pull request #964 from arkivanov/main-thread-check-setting

arkivanov · web-flow · commit 6b6a767219e9 · 2025-12-14T23:26:43.000Z
Added mainThreadCheckEnabled setting
diff --git a/decompose/api/android/decompose.api b/decompose/api/android/decompose.api
@@ -71,13 +71,15 @@ public final class com/arkivanov/decompose/DecomposeExperimentFlags {
 public final class com/arkivanov/decompose/DecomposeSettings {
 	public static final field Companion Lcom/arkivanov/decompose/DecomposeSettings$Companion;
 	public fun <init> ()V
-	public fun <init> (Z)V
-	public synthetic fun <init> (ZILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (ZZ)V
+	public synthetic fun <init> (ZZILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public final fun component1 ()Z
-	public final fun copy (Z)Lcom/arkivanov/decompose/DecomposeSettings;
-	public static synthetic fun copy$default (Lcom/arkivanov/decompose/DecomposeSettings;ZILjava/lang/Object;)Lcom/arkivanov/decompose/DecomposeSettings;
+	public final fun component2 ()Z
+	public final fun copy (ZZ)Lcom/arkivanov/decompose/DecomposeSettings;
+	public static synthetic fun copy$default (Lcom/arkivanov/decompose/DecomposeSettings;ZZILjava/lang/Object;)Lcom/arkivanov/decompose/DecomposeSettings;
 	public fun equals (Ljava/lang/Object;)Z
 	public final fun getDuplicateConfigurationsEnabled ()Z
+	public final fun getMainThreadCheckEnabled ()Z
 	public fun hashCode ()I
 	public fun toString ()Ljava/lang/String;
 }
diff --git a/decompose/api/decompose.klib.api b/decompose/api/decompose.klib.api
@@ -483,13 +483,16 @@ final class <#A: out kotlin/Any> com.arkivanov.decompose.router.pages/Pages { //
 }
 
 final class com.arkivanov.decompose/DecomposeSettings { // com.arkivanov.decompose/DecomposeSettings|null[0]
-    constructor <init>(kotlin/Boolean = ...) // com.arkivanov.decompose/DecomposeSettings.<init>|<init>(kotlin.Boolean){}[0]
+    constructor <init>(kotlin/Boolean = ..., kotlin/Boolean = ...) // com.arkivanov.decompose/DecomposeSettings.<init>|<init>(kotlin.Boolean;kotlin.Boolean){}[0]
 
     final val duplicateConfigurationsEnabled // com.arkivanov.decompose/DecomposeSettings.duplicateConfigurationsEnabled|{}duplicateConfigurationsEnabled[0]
         final fun <get-duplicateConfigurationsEnabled>(): kotlin/Boolean // com.arkivanov.decompose/DecomposeSettings.duplicateConfigurationsEnabled.<get-duplicateConfigurationsEnabled>|<get-duplicateConfigurationsEnabled>(){}[0]
+    final val mainThreadCheckEnabled // com.arkivanov.decompose/DecomposeSettings.mainThreadCheckEnabled|{}mainThreadCheckEnabled[0]
+        final fun <get-mainThreadCheckEnabled>(): kotlin/Boolean // com.arkivanov.decompose/DecomposeSettings.mainThreadCheckEnabled.<get-mainThreadCheckEnabled>|<get-mainThreadCheckEnabled>(){}[0]
 
     final fun component1(): kotlin/Boolean // com.arkivanov.decompose/DecomposeSettings.component1|component1(){}[0]
-    final fun copy(kotlin/Boolean = ...): com.arkivanov.decompose/DecomposeSettings // com.arkivanov.decompose/DecomposeSettings.copy|copy(kotlin.Boolean){}[0]
+    final fun component2(): kotlin/Boolean // com.arkivanov.decompose/DecomposeSettings.component2|component2(){}[0]
+    final fun copy(kotlin/Boolean = ..., kotlin/Boolean = ...): com.arkivanov.decompose/DecomposeSettings // com.arkivanov.decompose/DecomposeSettings.copy|copy(kotlin.Boolean;kotlin.Boolean){}[0]
     final fun equals(kotlin/Any?): kotlin/Boolean // com.arkivanov.decompose/DecomposeSettings.equals|equals(kotlin.Any?){}[0]
     final fun hashCode(): kotlin/Int // com.arkivanov.decompose/DecomposeSettings.hashCode|hashCode(){}[0]
     final fun toString(): kotlin/String // com.arkivanov.decompose/DecomposeSettings.toString|toString(){}[0]
diff --git a/decompose/api/jvm/decompose.api b/decompose/api/jvm/decompose.api
@@ -71,13 +71,15 @@ public final class com/arkivanov/decompose/DecomposeExperimentFlags {
 public final class com/arkivanov/decompose/DecomposeSettings {
 	public static final field Companion Lcom/arkivanov/decompose/DecomposeSettings$Companion;
 	public fun <init> ()V
-	public fun <init> (Z)V
-	public synthetic fun <init> (ZILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (ZZ)V
+	public synthetic fun <init> (ZZILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public final fun component1 ()Z
-	public final fun copy (Z)Lcom/arkivanov/decompose/DecomposeSettings;
-	public static synthetic fun copy$default (Lcom/arkivanov/decompose/DecomposeSettings;ZILjava/lang/Object;)Lcom/arkivanov/decompose/DecomposeSettings;
+	public final fun component2 ()Z
+	public final fun copy (ZZ)Lcom/arkivanov/decompose/DecomposeSettings;
+	public static synthetic fun copy$default (Lcom/arkivanov/decompose/DecomposeSettings;ZZILjava/lang/Object;)Lcom/arkivanov/decompose/DecomposeSettings;
 	public fun equals (Ljava/lang/Object;)Z
 	public final fun getDuplicateConfigurationsEnabled ()Z
+	public final fun getMainThreadCheckEnabled ()Z
 	public fun hashCode ()I
 	public fun toString ()Ljava/lang/String;
 }
diff --git a/decompose/src/androidMain/kotlin/com/arkivanov/decompose/mainthread/CheckMainThread.kt b/decompose/src/androidMain/kotlin/com/arkivanov/decompose/mainthread/CheckMainThread.kt
@@ -1,18 +1,19 @@
 package com.arkivanov.decompose.mainthread
 
 import android.os.Looper
+import com.arkivanov.decompose.DecomposeSettings
 import com.arkivanov.decompose.errorhandler.onDecomposeError
 
 private val mainThreadId: Long? by lazy {
     try {
         Looper.getMainLooper().thread.id
-    } catch (e: Exception) {
+    } catch (_: Exception) {
         null
     }
 }
 
 internal actual fun checkMainThread() {
-    if ((mainThreadId != null) && (Thread.currentThread().id != mainThreadId)) {
+    if (DecomposeSettings.settings.mainThreadCheckEnabled && (mainThreadId != null) && (Thread.currentThread().id != mainThreadId)) {
         onDecomposeError(NotOnMainThreadException(currentThreadName = Thread.currentThread().name))
     }
 }
diff --git a/decompose/src/commonMain/kotlin/com/arkivanov/decompose/DecomposeSettings.kt b/decompose/src/commonMain/kotlin/com/arkivanov/decompose/DecomposeSettings.kt
@@ -7,9 +7,13 @@ import kotlin.concurrent.Volatile
  *
  * @param duplicateConfigurationsEnabled controls whether duplicate configurations are enabled or not. Default value is `false`.
  * Excludes the `Child Items` navigation model, which doesn't support duplicate configurations.
+ * @param mainThreadCheckEnabled controls whether main thread checks are enabled or not.
+ * If enabled, Decompose will log an error if it detects access from a background thread when it was expected from the main thread.
+ * Default value is `true`.
  */
 data class DecomposeSettings(
     val duplicateConfigurationsEnabled: Boolean = false,
+    val mainThreadCheckEnabled: Boolean = true,
 ) {
 
     companion object {
diff --git a/decompose/src/darwinMain/kotlin/com/arkivanov/decompose/mainthread/CheckMainThread.kt b/decompose/src/darwinMain/kotlin/com/arkivanov/decompose/mainthread/CheckMainThread.kt
@@ -1,10 +1,11 @@
 package com.arkivanov.decompose.mainthread
 
+import com.arkivanov.decompose.DecomposeSettings
 import com.arkivanov.decompose.errorhandler.onDecomposeError
 import platform.Foundation.NSThread
 
 internal actual fun checkMainThread() {
-    if (!NSThread.isMainThread()) {
+    if (DecomposeSettings.settings.mainThreadCheckEnabled && !NSThread.isMainThread()) {
         onDecomposeError(NotOnMainThreadException(currentThreadName = NSThread.currentThread.description()))
     }
 }
diff --git a/decompose/src/jvmMain/kotlin/com/arkivanov/decompose/mainthread/CheckMainThread.kt b/decompose/src/jvmMain/kotlin/com/arkivanov/decompose/mainthread/CheckMainThread.kt
@@ -1,9 +1,10 @@
 package com.arkivanov.decompose.mainthread
 
+import com.arkivanov.decompose.DecomposeSettings
 import com.arkivanov.decompose.errorhandler.onDecomposeError
 
 internal actual fun checkMainThread() {
-    if (mainThreadChecker?.isMainThread() == false) {
+    if (DecomposeSettings.settings.mainThreadCheckEnabled && mainThreadChecker?.isMainThread() == false) {
         onDecomposeError(NotOnMainThreadException(currentThreadName = Thread.currentThread().name))
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,18 +1,19 @@`
`1`	`1`	`package com.arkivanov.decompose.mainthread`
`2`	`2`
`3`	`3`	`import android.os.Looper`
	`4`	`+import com.arkivanov.decompose.DecomposeSettings`
`4`	`5`	`import com.arkivanov.decompose.errorhandler.onDecomposeError`
`5`	`6`
`6`	`7`	`private val mainThreadId: Long? by lazy {`
`7`	`8`	`try {`
`8`	`9`	`Looper.getMainLooper().thread.id`
`9`		`- } catch (e: Exception) {`
	`10`	`+ } catch (_: Exception) {`
`10`	`11`	`null`
`11`	`12`	`}`
`12`	`13`	`}`
`13`	`14`
`14`	`15`	`internal actual fun checkMainThread() {`
`15`		`- if ((mainThreadId != null) && (Thread.currentThread().id != mainThreadId)) {`
	`16`	`+ if (DecomposeSettings.settings.mainThreadCheckEnabled && (mainThreadId != null) && (Thread.currentThread().id != mainThreadId)) {`
`16`	`17`	`onDecomposeError(NotOnMainThreadException(currentThreadName = Thread.currentThread().name))`
`17`	`18`	`}`
`18`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,11 @@`
`1`	`1`	`package com.arkivanov.decompose.mainthread`
`2`	`2`
	`3`	`+import com.arkivanov.decompose.DecomposeSettings`
`3`	`4`	`import com.arkivanov.decompose.errorhandler.onDecomposeError`
`4`	`5`	`import platform.Foundation.NSThread`
`5`	`6`
`6`	`7`	`internal actual fun checkMainThread() {`
`7`		`- if (!NSThread.isMainThread()) {`
	`8`	`+ if (DecomposeSettings.settings.mainThreadCheckEnabled && !NSThread.isMainThread()) {`
`8`	`9`	`onDecomposeError(NotOnMainThreadException(currentThreadName = NSThread.currentThread.description()))`
`9`	`10`	`}`
`10`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,10 @@`
`1`	`1`	`package com.arkivanov.decompose.mainthread`
`2`	`2`
	`3`	`+import com.arkivanov.decompose.DecomposeSettings`
`3`	`4`	`import com.arkivanov.decompose.errorhandler.onDecomposeError`
`4`	`5`
`5`	`6`	`internal actual fun checkMainThread() {`
`6`		`- if (mainThreadChecker?.isMainThread() == false) {`
	`7`	`+ if (DecomposeSettings.settings.mainThreadCheckEnabled && mainThreadChecker?.isMainThread() == false) {`
`7`	`8`	`onDecomposeError(NotOnMainThreadException(currentThreadName = Thread.currentThread().name))`
`8`	`9`	`}`
`9`	`10`	`}`