Expose ribActionEvents stream #599

FranAguilera · 2023-06-14T17:06:35Z

Description:
Expose ribActionEvents stream that emits state of each RIB "action" (e.g didBecomeActive, willLoad) For example:

Event to be emitted just before didBecomeActive
Interactor.didBecomeActive internal call
Even to be emitted after didBecomeActive call is completed

One example application of consuming these events is monitoring binding duration of Workers as shown in ApplicationLevelWorkerLogger from rib-workers demo app
...

WARNING: [RibEvents.enableRibActionEmissions] must be called at the earliest app scope before subscribing/collecting ribAction events. This is intentional in order to avoid unnecessary object creations for each RIB action in case no one is listening

Breaking changes:

Change	Notes
`WorkerBinder.initializeMonitoring`	Removed. Moving forward can use new flow API
`WorkerBinderListener`	Removed. Moving forward can use new flow API
`RibEvents`	Converted to Object, no need for Singleton from now on
`RibEvent`	Named to `RibRouterEvent`
`events` within `RibEvents`	Renamed `events` to `routerEvents`

Tests

JUnit tests
Manual validation on internal repo
Demo on rib-workers sample app

Related issue(s):

Provide a new RibActionEvent stream that will allow for monitoring/logging options for all RIB components (Interactor, Presenter, Router, Worker)

android/demos/rib-workers/src/main/kotlin/com/uber/rib/workers/root/logger/RibEventLogger.kt

android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/RibEvents.kt

psteiger · 2023-06-16T21:01:49Z

As discussed offline, we could have a DSL like:

inline fun record(startEvent: StartEvent, endEvent: EndEvent, block: () -> Unit) {
  // emit start event
  block()
  // emit end event
}

And in interactors (e.g.) we could have

fun didBecomeActive() {
  record(Interactor.Start, Interactor.Stop) {
      // code for didBecomeActive
  }
}

If we don't do the calculation on the record, and instead do it on consumer side, we can offload the calculation to a worker thread.

Also, we could have an atomic identifier for each record call, incremented at every call, making us sure that the 'end event' corresponds to a certain 'start event' (if needed)

...rib-workers/src/main/kotlin/com/uber/rib/workers/root/logger/ApplicationLevelWorkerLogger.kt

android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/RibEvents.kt

android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/Router.kt

- Use MainScope for ApplicationLevelWorkerLogger demo - Add thread name to always keep track of original caller thread name

android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/RibEvents.kt

...rib-workers/src/main/kotlin/com/uber/rib/workers/root/logger/ApplicationLevelWorkerLogger.kt

android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/RibEvents.kt

tyvsmith · 2023-06-22T01:11:13Z

android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/RibComponentType.kt


-fun interface BackendReporter {
-  fun report(genericMessage: String)
+public enum class RibComponentType {


Coroutine Worker? Why reserve for next release?

We may need to tweak a bit more RibCoroutine worker in order to provide accurate monitoring as mentioned by @psteiger earlier

Given there are barely any users internally of RibCoroutineWorker, I'm not concerned to leave these changes to be implemented on a separate PR

tyvsmith · 2023-06-22T01:20:43Z

android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/RibEvents.kt

+   * @param ribEventType RIB event type (e.g. ATTACH/DETACH)
+   */
+  internal inline fun <T : Any> triggerRibActionAndEmitEvents(
+    ribCallerClassType: T,


Can we lock this down more than T? With the use of lambda's, this, it, and T here it seems like the risk is high that we end up not tracking the correct class we're expecting.

Is there a common interface we can use here? If not, should we have one?

Good idea, let me explore

Added a "RibComponent" contract for these common components, still thinking a better naming for this

android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/RibEvents.kt

FranAguilera · 2023-06-22T16:11:29Z

android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/RibEvents.kt

-  internal inline fun <T : Any> triggerRibActionAndEmitEvents(
-    ribCallerClassType: T,
+  internal inline fun triggerRibActionAndEmitEvents(
+    ribComponent: RibComponent,
    ribComponentType: RibComponentType,


I would like to specify a property on the new RibComponent to be overriden, unfortunately given that Worker and RibCoroutineWorker are interfaces we cannot restrict visibility of those

android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/RibEvents.kt

tyvsmith · 2023-06-22T17:02:24Z

android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/Router.kt

@@ -34,7 +34,7 @@ protected constructor(
  public open val interactor: I,
  private val ribRefWatcher: RibRefWatcher,
  private val mainThread: Thread,
-) {
+) : RibComponent {


Probably too generic for a name for this set of callbacks. How about something more explicit around emitting callbacks around lifecycles, like RibEventEmitter?

Good idea, I like this better

Decided to go with RibActionEmitter to avoid confusion with existing RibEventType

FranAguilera marked this pull request as draft June 14, 2023 17:06

FranAguilera force-pushed the add_rib_monitoring branch 4 times, most recently from 2bb5dde to 6e1018b Compare June 14, 2023 20:21

Drafting monitoring option for RIBs

8587e79

FranAguilera force-pushed the add_rib_monitoring branch from 6e1018b to 8587e79 Compare June 14, 2023 20:30

FranAguilera added the Android Android related tickets label Jun 15, 2023

FranAguilera force-pushed the add_rib_monitoring branch 6 times, most recently from 9b2f281 to 2ac48ff Compare June 16, 2023 16:25

FranAguilera changed the title ~~Drafting monitoring option for RIBs~~ [Draft] Expose flow with RibEvent information duration Jun 16, 2023

psteiger reviewed Jun 16, 2023

View reviewed changes

android/demos/rib-workers/src/main/kotlin/com/uber/rib/workers/root/logger/RibEventLogger.kt Outdated Show resolved Hide resolved

FranAguilera requested a review from tyvsmith June 16, 2023 18:12

FranAguilera force-pushed the add_rib_monitoring branch 4 times, most recently from c7674d8 to 60a8308 Compare June 16, 2023 19:19

FranAguilera changed the title ~~[Draft] Expose flow with RibEvent information duration~~ [Draft] Expose flow with RibEventDuration information Jun 16, 2023

FranAguilera force-pushed the add_rib_monitoring branch 3 times, most recently from 29c7d6d to 715defd Compare June 16, 2023 19:57

Expose stream for RIB component duration info

66eac33

FranAguilera force-pushed the add_rib_monitoring branch from 715defd to 66eac33 Compare June 16, 2023 20:02

FranAguilera commented Jun 16, 2023

View reviewed changes

android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/RibEvents.kt Show resolved Hide resolved

FranAguilera commented Jun 16, 2023

View reviewed changes

android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/RibEvents.kt Outdated Show resolved Hide resolved

FranAguilera marked this pull request as ready for review June 21, 2023 16:57

FranAguilera commented Jun 21, 2023

View reviewed changes

...rib-workers/src/main/kotlin/com/uber/rib/workers/root/logger/ApplicationLevelWorkerLogger.kt Outdated Show resolved Hide resolved

FranAguilera requested review from psteiger and rysh88 June 21, 2023 17:08

psteiger reviewed Jun 21, 2023

View reviewed changes

Change actionBlock declaration order

747b831

- Use MainScope for ApplicationLevelWorkerLogger demo - Add thread name to always keep track of original caller thread name

FranAguilera commented Jun 21, 2023

View reviewed changes

android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/RibEvents.kt Show resolved Hide resolved

Update JUnit tests

5a42204

psteiger reviewed Jun 21, 2023

View reviewed changes

Apply PR feedback

7009b81

psteiger approved these changes Jun 21, 2023

View reviewed changes

tyvsmith reviewed Jun 22, 2023

View reviewed changes

android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/RibEvents.kt Show resolved Hide resolved

tyvsmith reviewed Jun 22, 2023

View reviewed changes

android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/RibEvents.kt Outdated Show resolved Hide resolved

tyvsmith reviewed Jun 22, 2023

View reviewed changes

android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/RibEvents.kt Show resolved Hide resolved

FranAguilera added 2 commits June 21, 2023 22:08

First proposal after PR feedback

2edee91

Rename startCapturingRibActionInfo

7f251b1

FranAguilera commented Jun 22, 2023

View reviewed changes

tyvsmith reviewed Jun 22, 2023

View reviewed changes

android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/RibEvents.kt Outdated Show resolved Hide resolved

tyvsmith reviewed Jun 22, 2023

View reviewed changes

FranAguilera added 3 commits June 22, 2023 10:24

PR feedback: Rename RibComponent and add switch method for RibEvents

8201984

Remove unnecessary comments for test method

2a5db8e

Rename RibEventEmitter to RibActionEmitter

3e7983a

FranAguilera requested a review from tyvsmith June 22, 2023 20:21

FranAguilera added 2 commits June 22, 2023 15:53

Open areRibActionEmissionsAllowed get visibility

ee3aff2

Remove disableRibActionEmissions and use internal setter

59014ba

FranAguilera force-pushed the add_rib_monitoring branch from ac3027f to 59014ba Compare June 23, 2023 15:39

tyvsmith approved these changes Jun 23, 2023

View reviewed changes

tyvsmith merged commit c1cf74c into uber:main Jun 23, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expose ribActionEvents stream #599

Expose ribActionEvents stream #599

FranAguilera commented Jun 14, 2023 •

edited

Loading

psteiger commented Jun 16, 2023 •

edited

Loading

tyvsmith Jun 22, 2023 •

edited

Loading

FranAguilera Jun 22, 2023

tyvsmith Jun 22, 2023

FranAguilera Jun 22, 2023

FranAguilera Jun 22, 2023 •

edited

Loading

FranAguilera Jun 22, 2023

tyvsmith Jun 22, 2023

FranAguilera Jun 22, 2023

FranAguilera Jun 22, 2023

Expose ribActionEvents stream #599

Expose ribActionEvents stream #599

Conversation

FranAguilera commented Jun 14, 2023 • edited Loading

psteiger commented Jun 16, 2023 • edited Loading

tyvsmith Jun 22, 2023 • edited Loading

Choose a reason for hiding this comment

FranAguilera Jun 22, 2023

Choose a reason for hiding this comment

tyvsmith Jun 22, 2023

Choose a reason for hiding this comment

FranAguilera Jun 22, 2023

Choose a reason for hiding this comment

FranAguilera Jun 22, 2023 • edited Loading

Choose a reason for hiding this comment

FranAguilera Jun 22, 2023

Choose a reason for hiding this comment

tyvsmith Jun 22, 2023

Choose a reason for hiding this comment

FranAguilera Jun 22, 2023

Choose a reason for hiding this comment

FranAguilera Jun 22, 2023

Choose a reason for hiding this comment

FranAguilera commented Jun 14, 2023 •

edited

Loading

psteiger commented Jun 16, 2023 •

edited

Loading

tyvsmith Jun 22, 2023 •

edited

Loading

FranAguilera Jun 22, 2023 •

edited

Loading