main.com.uber.rib.core.RibEvents.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rib-base Show documentation
RIBs is the cross-platform architecture behind many mobile apps at Uber. This framework is designed for mobile apps with a large number of engineers and nested states.
There is a newer version: 0.16.3
Show newest version
/*
 * Copyright (C) 2017. Uber Technologies
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.uber.rib.core

import androidx.annotation.VisibleForTesting
import io.reactivex.Observable
import kotlinx.coroutines.channels.BufferOverflow
import kotlinx.coroutines.flow.MutableSharedFlow
import kotlinx.coroutines.rx2.asObservable

public object RibEvents {

  private val mutableRouterEvents =
    MutableSharedFlow(0, 1, BufferOverflow.DROP_OLDEST)
  private val mutableRibDurationEvents =
    MutableSharedFlow(0, 1, BufferOverflow.DROP_OLDEST)

  @JvmStatic
  public val routerEvents: Observable = mutableRouterEvents.asObservable()

  @JvmStatic
  public val ribActionEvents: Observable = mutableRibDurationEvents.asObservable()

  /** Indicates if [ribActionEvents] will be emitting. */
  public var areRibActionEmissionsAllowed: Boolean = false
    @VisibleForTesting internal set

  /**
   * To be called before start observing/collecting on [ribActionEvents] (usually at your earliest
   * application point)
   */
  @JvmStatic
  public fun enableRibActionEmissions() {
    this.areRibActionEmissionsAllowed = true
  }

  /**
   * @param eventType [RibEventType]
   * @param child [Router]
   * @param parent [Router] and null for the root ribs that are directly attached to
   *   RibActivity/Fragment
   */
  @JvmStatic
  public fun emitRouterEvent(eventType: RibEventType, child: Router<*>, parent: Router<*>?) {
    mutableRouterEvents.tryEmit(RibRouterEvent(eventType, child, parent))
  }

  /**
   * Calls related RIB action (e.g. didBecomeActive) and emits emission of ATTACHED/DETACHED events
   * for each [RibActionEmitter] (e.g. Concrete Interactor, Presenter, Router, Worker).
   *
   * @param ribActionEmitter The related Rib Action emitter class
   * @param ribActionEmitterType The RIB component type (e.g. Interactor, Router, Presenter, Worker)
   * @param ribEventType RIB event type (e.g. ATTACH/DETACH)
   * @param ribAction The related RIB action type. e.g. didBecomeActive, willLoad, etc
   */
  internal inline fun triggerRibActionAndEmitEvents(
    ribActionEmitter: RibActionEmitter,
    ribActionEmitterType: RibActionEmitterType,
    ribEventType: RibEventType,
    ribAction: () -> Unit,
  ) {
    emitRibEventActionIfNeeded(
      ribActionEmitter,
      ribActionEmitterType,
      ribEventType,
      RibActionState.STARTED,
    )
    ribAction()
    emitRibEventActionIfNeeded(
      ribActionEmitter,
      ribActionEmitterType,
      ribEventType,
      RibActionState.COMPLETED,
    )
  }

  /**
   * Emits ATTACHED/DETACHED events for each RIB component.
   *
   * @param ribActionEmitter The related Rib Action emitter class
   * @param ribActionEmitterType The RIB component type (e.g. Interactor, Router, Presenter)
   * @param ribEventType RIB event type (e.g. ATTACH/DETACH)
   * @param ribActionState: RIB action state (STARTED/COMPLETED). For example prior and after call
   *   of Interactor.didBecomeActive
   */
  private fun emitRibEventActionIfNeeded(
    ribActionEmitter: RibActionEmitter,
    ribActionEmitterType: RibActionEmitterType,
    ribEventType: RibEventType,
    ribActionState: RibActionState,
  ) {
    if (!areRibActionEmissionsAllowed) {
      // Unless specified explicitly via [RibEvents.enableRibActionEmissions()] there is no need
      // to create unnecessary objects if there is no intention on observing/collecting RibAction
      // events
      return
    }

    val ribActionInfo =
      RibActionInfo(
        ribActionEmitter.javaClass.name,
        ribActionEmitterType,
        ribEventType,
        ribActionState,
        Thread.currentThread().name,
      )
    mutableRibDurationEvents.tryEmit(ribActionInfo)
  }
}

/** Holds relevant RIB event information */
public data class RibActionInfo(
  /** Related RIB Action concrete class name */
  val ribActionEmitterName: String,

  /** The current RIB event type being bound (e.g. INTERACTOR/PRESENTER/ROUTER/WORKER) */
  val ribActionEmitterType: RibActionEmitterType,

  /**
   * Represents the RIB event type (ATTACHED/DETACHED).
   *
   * For example for interactor:
   * - Interactor.didBecomeActive -> ATTACHED
   * - Interactor.willResignActive -> DETACHED
   *
   * For Worker:
   * - Worker.onStart() -> ATTACHED
   * - Worker.onStop() -> DETACHED
   */
  val ribEventType: RibEventType,

  /** RIB Action state (e.g. event to be called before/after didBecomeActive, willLoad, etc) */
  val ribActionState: RibActionState,

  /** Original caller thread where the RIB action happens */
  val originalCallerThreadName: String,
)

/**
 * Contract for all related Rib Action Types (Interactor, Presenter, Router, Worker) where will be
 * emitting via [ribActionEvents] observable
 */
public interface RibActionEmitter

public enum class RibActionEmitterType {
  ROUTER,
  PRESENTER,
  INTERACTOR,
  DEPRECATED_WORKER,
}

/** Represents status for each RibAction */
public enum class RibActionState {
  STARTED,
  COMPLETED,
}