Raise non-fatal error if node called outside main thread

libraries/rib-base/src/main/java/com/badoo/ribs/core/Node.kt

@@ -1,6 +1,7 @@
 package com.badoo.ribs.core
 
 import android.os.Bundle
+import android.os.Looper
 import androidx.annotation.CallSuper
 import androidx.annotation.MainThread
 import androidx.annotation.VisibleForTesting
@@ -48,6 +49,7 @@ open class Node<V : RibView> @VisibleForTesting internal constructor(
  val buildParams: BuildParams<*>,
  private val viewFactory: ViewFactory<V>?,
  private val retainedInstanceStore: RetainedInstanceStore,
+ private val isOnMainThreadFunc: () -> Boolean,
  plugins: List<Plugin> = emptyList()
 ) : Rib, LifecycleOwner {
 
@@ -59,7 +61,13 @@ open class Node<V : RibView> @VisibleForTesting internal constructor(
  buildParams: BuildParams<*>,
  viewFactory: ViewFactory<V>?,
  plugins: List<Plugin> = emptyList()
- ) : this(buildParams, viewFactory, RetainedInstanceStore, plugins)
+ ) : this(
+ buildParams = buildParams,
+ viewFactory = viewFactory,
+ retainedInstanceStore = RetainedInstanceStore,
+ isOnMainThreadFunc = { Looper.getMainLooper() == Looper.myLooper() },
+ plugins = plugins
+ )
 
  final override val node: Node<V>
  get() = this
@@ -131,27 +139,32 @@ open class Node<V : RibView> @VisibleForTesting internal constructor(
  get() = isAttachedToView && !isPendingViewDetach && !isPendingDetach
 
  init {
+ verifyMainThread { "init" }
  this.plugins.filterIsInstance<NodeAware>().forEach { it.init(this) }
  }
 
  internal fun onBuildFinished() {
+ verifyMainThread { "onBuildFinished" }
  plugins.filterIsInstance<NodeLifecycleAware>().forEach { it.onBuild() }
  parent?.onChildBuilt(this)
  }
 
  private fun onChildBuilt(child: Node<*>) {
+ verifyMainThread { "onChildBuilt" }
  plugins.filterIsInstance<SubtreeChangeAware>().forEach { it.onChildBuilt(child) }
  }
 
  @CallSuper
  open fun onCreate() {
+ verifyMainThread { "onCreate" }
  plugins
  .filterIsInstance<NodeLifecycleAware>()
  .forEach { it.onCreate(lifecycleManager.ribLifecycle.lifecycle) }
  lifecycleManager.onCreate()
  }
 
  fun onCreateView(parentView: RibView): V? {
+ verifyMainThread { "onCreateView" }
  if (isRoot) rootHost = parentView
  if (view == null && viewFactory != null) {
  val viewLifecycle = lifecycleManager.initializeViewLifecycle()
@@ -174,6 +187,7 @@ open class Node<V : RibView> @VisibleForTesting internal constructor(
  }
 
  fun onAttachToView() {
+ verifyMainThread { "onAttachToView" }
  onAttachToViewChecks()
  isAttachedToView = true
  lifecycleManager.onAttachToView()
@@ -194,6 +208,7 @@ open class Node<V : RibView> @VisibleForTesting internal constructor(
  }
 
  fun onDetachFromView(): V? {
+ verifyMainThread { "onDetachFromView" }
  if (isAttachedToView) {
  val view = view
  saveViewState()
@@ -209,6 +224,7 @@ open class Node<V : RibView> @VisibleForTesting internal constructor(
  }
 
  open fun onDestroy(isRecreating: Boolean) {
+ verifyMainThread { "onDestroy" }
  if (view != null) {
  RIBs.errorHandler.handleNonFatalError(
  "View was not detached before node detach!",
@@ -236,6 +252,7 @@ open class Node<V : RibView> @VisibleForTesting internal constructor(
  */
  @MainThread
  fun attachChildNode(child: Node<*>) {
+ verifyMainThread { "attachChildNode" }
  verifyNotRoot(child)
  _children.add(child)
  lifecycleManager.onAttachChild(child)
@@ -246,6 +263,7 @@ open class Node<V : RibView> @VisibleForTesting internal constructor(
  }
 
  internal fun onAttachFinished() {
+ verifyMainThread { "onAttachFinished" }
  plugins.filterIsInstance<NodeLifecycleAware>().forEach { it.onAttach() }
  }
 
@@ -263,6 +281,7 @@ open class Node<V : RibView> @VisibleForTesting internal constructor(
  }
 
  fun attachChildView(child: Node<*>) {
+ verifyMainThread { "attachChildView" }
  attachChildView(child, child, true)
  }
 
@@ -281,6 +300,7 @@ open class Node<V : RibView> @VisibleForTesting internal constructor(
  }
 
  fun detachChildView(child: Node<*>) {
+ verifyMainThread { "detachChildView" }
  detachChildView(child, child, true)
  }
 
@@ -308,6 +328,7 @@ open class Node<V : RibView> @VisibleForTesting internal constructor(
  */
  @MainThread
  fun detachChildNode(child: Node<*>, isRecreating: Boolean) {
+ verifyMainThread { "detachChildNode" }
  plugins.filterIsInstance<SubtreeChangeAware>().forEach { it.onChildDetached(child) }
  _children.remove(child)
  child.onDestroy(isRecreating)
@@ -325,6 +346,7 @@ open class Node<V : RibView> @VisibleForTesting internal constructor(
  * To be called from the hosting environment (Activity, Fragment, etc.)
  */
  fun onStart() {
+ verifyMainThread { "onStart" }
  lifecycleManager.onStartExternal()
  plugins.filterIsInstance<AndroidLifecycleAware>().forEach { it.onStart() }
  }
@@ -333,6 +355,7 @@ open class Node<V : RibView> @VisibleForTesting internal constructor(
  * To be called from the hosting environment (Activity, Fragment, etc.)
  */
  fun onStop() {
+ verifyMainThread { "onStop" }
  lifecycleManager.onStopExternal()
  plugins.filterIsInstance<AndroidLifecycleAware>().forEach { it.onStop() }
  }
@@ -341,6 +364,7 @@ open class Node<V : RibView> @VisibleForTesting internal constructor(
  * To be called from the hosting environment (Activity, Fragment, etc.)
  */
  fun onResume() {
+ verifyMainThread { "onResume" }
  lifecycleManager.onResumeExternal()
  plugins.filterIsInstance<AndroidLifecycleAware>().forEach { it.onResume() }
  }
@@ -349,12 +373,14 @@ open class Node<V : RibView> @VisibleForTesting internal constructor(
  * To be called from the hosting environment (Activity, Fragment, etc.)
  */
  fun onPause() {
+ verifyMainThread { "onPause" }
  lifecycleManager.onPauseExternal()
  plugins.filterIsInstance<AndroidLifecycleAware>().forEach { it.onPause() }
  }
 
  @CallSuper
  open fun handleBackPress(): Boolean {
+ verifyMainThread { "handleBackPress" }
  val subtreeHandlers = plugins.filterIsInstance<SubtreeBackPressHandler>()
  val handlers = plugins.filterIsInstance<BackPressHandler>()
 
@@ -365,6 +391,7 @@ open class Node<V : RibView> @VisibleForTesting internal constructor(
  }
 
  fun upNavigation() {
+ verifyMainThread { "upNavigation" }
  when {
  isRoot -> integrationPoint.handleUpNavigation()
 
@@ -389,18 +416,21 @@ open class Node<V : RibView> @VisibleForTesting internal constructor(
  .any { it.handleBackPress() }
 
  open fun onSaveInstanceState(outState: Bundle) {
+ verifyMainThread { "onSaveInstanceState" }
  outState.putSerializable(Identifier.KEY_UUID, identifier.uuid)
  plugins.filterIsInstance<SavesInstanceState>().forEach { it.onSaveInstanceState(outState) }
  saveViewState()
  outState.putBundle(KEY_VIEW_STATE, savedViewState)
  }
 
  fun saveViewState() {
+ verifyMainThread { "saveViewState" }
  val view = view ?: return
  savedViewState = Bundle().also { view.saveInstanceState(it) }
  }
 
  fun onLowMemory() {
+ verifyMainThread { "onLowMemory" }
  plugins.filterIsInstance<SystemAware>().forEach { it.onLowMemory() }
  }
 
@@ -444,4 +474,15 @@ open class Node<V : RibView> @VisibleForTesting internal constructor(
 
  return found
  }
+
+ private inline fun verifyMainThread(functionName: () -> String) {
+ if (!isOnMainThreadFunc()) {
+ RIBs.errorHandler.handleNonFatalError(
+ "Node interacted with outside main thread. " +
+ "Node: ${javaClass.name}, " +
+ "method: ${functionName()}, " +
+ "thread: ${Thread.currentThread().name}"
+ )
+ }
+ }
 }

libraries/rib-base/src/test/java/com/badoo/ribs/clienthelper/childaware/ChildAwareImplTest.kt

@@ -12,6 +12,7 @@ import com.badoo.ribs.core.modality.BuildContext
 import com.badoo.ribs.core.modality.BuildParams
 import com.badoo.ribs.core.view.RibView
 import com.badoo.ribs.routing.Routing
+import com.badoo.ribs.store.RetainedInstanceStore
 import kotlinx.parcelize.Parcelize
 import org.junit.Assert.assertEquals
 import org.junit.Assert.assertNull
@@ -25,6 +26,8 @@ class ChildAwareImplTest {
  Node<RibView>(
  buildParams = BuildParams(payload = null, buildContext = buildContext),
  viewFactory = null,
+ retainedInstanceStore = RetainedInstanceStore,
+ isOnMainThreadFunc = { true },
  plugins = listOf(registry),
  )
  }.apply {
@@ -269,6 +272,8 @@ class ChildAwareImplTest {
  ) : Node<RibView>(
  buildParams = BuildParams(payload = null, buildContext = buildContext),
  viewFactory = null,
+ retainedInstanceStore = RetainedInstanceStore,
+ isOnMainThreadFunc = { true },
  ), Child1 {
  override fun toString(): String = "${this::class.simpleName}@${hashCode()}"
  }
@@ -279,6 +284,8 @@ class ChildAwareImplTest {
  ) : Node<RibView>(
  buildParams = BuildParams(payload = null, buildContext = buildContext),
  viewFactory = null,
+ retainedInstanceStore = RetainedInstanceStore,
+ isOnMainThreadFunc = { true },
  ), Child2 {
  override fun toString(): String = "${this::class.simpleName}@${hashCode()}"
  }
@@ -289,6 +296,8 @@ class ChildAwareImplTest {
  ) : Node<RibView>(
  buildParams = BuildParams(payload = null, buildContext = buildContext),
  viewFactory = null,
+ retainedInstanceStore = RetainedInstanceStore,
+ isOnMainThreadFunc = { true },
  ), Child3 {
  override fun toString(): String = "${this::class.simpleName}@${hashCode()}"
  }

libraries/rib-base/src/test/java/com/badoo/ribs/core/NodeTest.kt

@@ -89,11 +89,13 @@ class NodeTest {
  private fun createNode(
  buildParams: BuildParams<Nothing?> = testBuildParams(),
  viewFactory: TestViewFactory? = [email protected],
+ isOnMainThread: Boolean = true,
  plugins: List<Plugin> = emptyList()
  ): Node<TestView> = Node(
  buildParams = buildParams,
  viewFactory = viewFactory,
  plugins = plugins,
+ isOnMainThreadFunc = { isOnMainThread },
  retainedInstanceStore = retainedInstanceStore
  )
 
@@ -334,7 +336,10 @@ class NodeTest {
  directChild.attachChildNode(grandChild)
  node.attachChildNode(directChild)
 
- assertEquals(Lifecycle.State.CREATED, grandChild.lifecycleManager.externalLifecycle.currentState)
+ assertEquals(
+ Lifecycle.State.CREATED,
+ grandChild.lifecycleManager.externalLifecycle.currentState
+ )
  }
 
  @Test
@@ -365,7 +370,10 @@ class NodeTest {
  directChild.attachChildNode(grandChild)
  node.attachChildNode(directChild)
 
- assertEquals(Lifecycle.State.STARTED, grandChild.lifecycleManager.externalLifecycle.currentState)
+ assertEquals(
+ Lifecycle.State.STARTED,
+ grandChild.lifecycleManager.externalLifecycle.currentState
+ )
  }
 
  @Test
@@ -399,7 +407,10 @@ class NodeTest {
  directChild.attachChildNode(grandChild)
  node.attachChildNode(directChild)
 
- assertEquals(Lifecycle.State.RESUMED, grandChild.lifecycleManager.externalLifecycle.currentState)
+ assertEquals(
+ Lifecycle.State.RESUMED,
+ grandChild.lifecycleManager.externalLifecycle.currentState
+ )
  }
 
  @Ignore("This should be reworked to match new mechanism")
@@ -604,4 +615,21 @@ class NodeTest {
 
  verify(retainedInstanceStore, never()).removeAll(node.identifier)
  }
+
+ @Test
+ fun `WHEN node created outside main thread THEN error is raised`() {
+ val errorHandler = mock<RIBs.ErrorHandler>()
+ RIBs.clearErrorHandler()
+ RIBs.errorHandler = errorHandler
+
+ node = createNode(viewFactory = viewFactory, isOnMainThread = false)
+
+ verify(errorHandler).handleNonFatalError(
+ errorMessage = "Node interacted with outside main thread. " +
+ "Node: com.badoo.ribs.core.Node, " +
+ "method: init, " +
+ "thread: SDK 32 Main Thread",
+ throwable = null
+ )
+ }
 }

libraries/rib-base/src/test/java/com/badoo/ribs/core/helper/TestNode.kt

@@ -5,6 +5,7 @@ import com.badoo.ribs.core.modality.BuildParams
 import com.badoo.ribs.core.plugin.Plugin
 import com.badoo.ribs.core.view.ViewFactory
 import com.badoo.ribs.routing.router.Router
+import com.badoo.ribs.store.RetainedInstanceStore
 import org.mockito.kotlin.mock
 
 open class TestNode(
@@ -15,6 +16,8 @@ open class TestNode(
 ) : Node<TestView>(
  buildParams = buildParams,
  viewFactory = viewFactory,
+ retainedInstanceStore = RetainedInstanceStore,
+ isOnMainThreadFunc = { true },
  plugins = plugins + listOf(router)
 ), TestRib {
 

libraries/rib-base/src/test/java/com/badoo/ribs/core/helper/connectable/ConnectableTestNode.kt

@@ -11,6 +11,7 @@ import com.badoo.ribs.core.modality.AncestryInfo
 import com.badoo.ribs.core.modality.BuildParams
 import com.badoo.ribs.core.plugin.Plugin
 import com.badoo.ribs.routing.Routing
+import com.badoo.ribs.store.RetainedInstanceStore
 
 class ConnectableTestNode(
  buildParams: BuildParams<*>? = null,
@@ -20,6 +21,8 @@ class ConnectableTestNode(
 ) : Node<Nothing>(
  buildParams = buildParams ?: getDefaultBuildParams(parent),
  viewFactory = null,
+ retainedInstanceStore = RetainedInstanceStore,
+ isOnMainThreadFunc = { true },
  plugins = plugins
 ), ConnectableTestRib, Connectable<Input, Output> by connector {