Improve XRay implementation #614

lucasnlm · 2023-09-06T21:33:22Z

Description:
This PR adds setup(), XRayConfig to RIBs XRay to allow setup it without rely on the existing toggle() function.

Problem it fixes
The current toggle() function may be problematic because it changes a static boolean. Example: depending on where XRay is enabled or if it's as debug in a RIB used twice, it will enabled and disable immediately.

XRayConfig adds the ability to enable XRay without change the Views alpha. The alpha change may be problematic when we have many RIBs attached due to the overlapping.

CLAassistant · 2023-09-06T21:33:28Z

All committers have signed the CLA.

lucasnlm · 2023-09-06T21:34:08Z

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

    this.view = view
    if (XRay.isEnabled()) {
-      XRay.apply(this, view)
+      XRay.apply(getName(), view)


Change this because it was leaking a this reference to a static function.

lucasnlm · 2023-09-06T21:34:53Z

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

 /** Utility class that shows riblets name in its background. */
 class XRay private constructor() {
-  private var isEnabled = false
-  private var textPaint: Paint? = null


Changed textPaint to a lazy val.

If it's all static info, why not immediately initialize it?

Paint is a big object. I rather initialize it only if needed. WDYT?

BTW, XRay is called in every ViewRouter constructor. So, I will initialize Paint every time. Even if we don't want to use XRay.

@lucasnlm but this is a singleton object, right? So it will really only initialize once. There's only one instance of the XRay class, or am I misunderstanding it?

"I rather initialize it only if needed. WDYT?"
Ok this makes sense.

lucasnlm · 2023-09-06T21:36:05Z

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

+    }
+
+    /** Toggles state of XRay. */
+    public fun toggle() {


toggle is still here to keep compatibility.

If so, I suggest we deprecate it.
Is there a substituting method?

lucasnlm · 2023-09-06T21:36:56Z

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

     */
    @JvmStatic
-    fun apply(viewRouter: ViewRouter<*, *>, view: View) {
+    internal fun apply(routerName: String, view: View) {


viewRouter was used only to get its name.

Good change

psteiger · 2023-09-11T23:09:07Z

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

 /** Utility class that shows riblets name in its background. */
 class XRay private constructor() {
-  private var isEnabled = false
-  private var textPaint: Paint? = null


If it's all static info, why not immediately initialize it?

psteiger · 2023-09-11T23:09:50Z

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

     */
    @JvmStatic
-    fun apply(viewRouter: ViewRouter<*, *>, view: View) {
+    internal fun apply(routerName: String, view: View) {


Good change

psteiger · 2023-09-11T23:11:11Z

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

  companion object {
    private val INSTANCE = XRay()


Consider changing the class to an object, if it's supposed to be a singleton after all. Then we can get rid of companion object

Makes sense! I will do that.

psteiger · 2023-09-11T23:12:00Z

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

+    }
+
+    /** Toggles state of XRay. */
+    public fun toggle() {


If so, I suggest we deprecate it.
Is there a substituting method?

psteiger · 2023-09-11T23:13:34Z

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

+/**
+ * Configuration for XRay.
+ *
+ * @property enabled `true` to enable XRay. By default it is disabled.
+ * @property alphaEnabled `true` to enable alpha changes when XRay is enabled.
+ */
+public data class XRayConfig(
+  val enabled: Boolean = false,
+  val alphaEnabled: Boolean = true,
+)


This is so simple IMO it should live on XRay.kt file at the top level. No need for a new file

psteiger · 2023-09-12T00:55:51Z

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

    @JvmStatic
-    fun toggle() {
-      INSTANCE.isEnabled = !INSTANCE.isEnabled
+    public fun setup(config: XRayConfig) {


Do we need thread-safety? If so, we must instead provide a way to atomically "read and write" -- an .update { } function, as below:

INSTANCE = AtomicReference<XRayConfig>(XRayConfig()) inline fun update(function: (current: T) -> T) { INSTANCE.getAndUpdate(function) }

I think we don´t need thread-safety. At least I never had thread issues with XRay.
Is it ok for you if we let it as is?

Yes it's ok, was just wondering.

psteiger

I'd probably not make Paint lazy, as the XRay object itself will only be initialized first time it is called anyway, so by lazy in its property for those purposes feels redundant

Stamped though

psteiger · 2023-09-22T00:08:15Z

@lucasnlm please build a version of RIBs with your change and make sure it works as expected using our apps, if so we can go ahead with landing

lucasnlm · 2023-09-23T15:14:32Z

@psteiger How can I do that?

psteiger · 2023-10-06T22:39:50Z

@lucasnlm I tagged on in internal comms with smoke test instructions

lucasnlm · 2023-10-12T02:48:56Z

@lucasnlm I tagged on in internal comms with smoke test instructions

I hope to test it this week. Thanks for the reminder.

Improve XRay implementation

94b59b1

lucasnlm commented Sep 6, 2023

View reviewed changes

lucasnlm added 4 commits September 6, 2023 18:46

Fix lint and add UBER License header

3054784

Update UBER License header

4516ba4

Fix format

a332eff

Fix format

160f0b7

lucasnlm marked this pull request as ready for review September 6, 2023 22:50

Update UBER License header

7574b86

psteiger requested changes Sep 11, 2023

View reviewed changes

psteiger reviewed Sep 12, 2023

View reviewed changes

lucasnlm added 2 commits September 12, 2023 20:20

Apply code review requests by @psteiger

39d3ae0

Fix format

3a4b8d1

psteiger approved these changes Sep 13, 2023

View reviewed changes

lucasnlm added 2 commits September 19, 2023 22:49

Remove lazy init

c738a5f

Fix format

b9acc28

Improve XRay implementation #614

Are you sure you want to change the base?

Improve XRay implementation #614

Uh oh!

Conversation

lucasnlm commented Sep 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CLAassistant commented Sep 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

psteiger left a comment

Choose a reason for hiding this comment

Uh oh!

psteiger commented Sep 22, 2023

Uh oh!

lucasnlm commented Sep 23, 2023

Uh oh!

psteiger commented Oct 6, 2023

Uh oh!

lucasnlm commented Oct 12, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lucasnlm commented Sep 6, 2023 •

edited

Loading

CLAassistant commented Sep 6, 2023 •

edited

Loading