Support @OnDataRendered callback in RecyclerBinder

Summary:
Execute onDataRendered callbacks if

1. The view is finished drawing (no pending updates)
2. The view is detached from window
3. The view's visibility is GONE
4. The view has been mounted then unmounted (mMountedView == null)

If the view isn't mounted yet or has pending updates, we wait for ViewGroup#dispatchDraw to been called, and PostDispatchDraw will trigger onDataRendered callbacks.

Reviewed By: astreet

Differential Revision: D8780857

fbshipit-source-id: 976f2077e676690ece20968ec46e0b0d3834b744

litho-it/src/test/java/com/facebook/litho/widget/RecyclerBinderTest.java

@@ -32,6 +32,7 @@
 import static org.mockito.Mockito.when;
 
 import android.content.Context;
+import android.graphics.Canvas;
 import android.os.Looper;
 import android.support.v7.widget.LinearLayoutManager;
 import android.support.v7.widget.OrientationHelper;
@@ -3122,6 +3123,265 @@ public void testOnDataBoundInsertAsyncLessThanViewport() {
     verify(changeSetCompleteCallback).onDataBound();
   }
 
+  @Test
+  public void testOnDataRenderedWithMountAfterInsert() {
+    final ChangeSetCompleteCallback changeSetCompleteCallback =
+        mock(ChangeSetCompleteCallback.class);
+    final RecyclerBinder recyclerBinder =
+        new RecyclerBinder.Builder().rangeRatio(RANGE_RATIO).build(mComponentContext);
+    final ArrayList<RenderInfo> renderInfos = new ArrayList<>();
+    for (int i = 0; i < 5; i++) {
+      final Component component =
+          TestDrawableComponent.create(mComponentContext).widthPx(100).heightPx(100).build();
+      renderInfos.add(ComponentRenderInfo.create().component(component).build());
+    }
+
+    recyclerBinder.insertRangeAt(0, renderInfos);
+    recyclerBinder.notifyChangeSetComplete(changeSetCompleteCallback);
+
+    // Mount view after insertions
+    final LithoRecylerView recyclerView = new LithoRecylerView(RuntimeEnvironment.application);
+    recyclerBinder.mount(recyclerView);
+
+    // Simulate calling ViewGroup#dispatchDraw(Canvas).
+    recyclerView.dispatchDraw(mock(Canvas.class));
+
+    verify(changeSetCompleteCallback).onDataRendered();
+  }
+
+  @Test
+  public void testOnDataRenderedWithMountAfterInsertAsync() {
+    final ChangeSetCompleteCallback changeSetCompleteCallback =
+        mock(ChangeSetCompleteCallback.class);
+    final RecyclerBinder recyclerBinder =
+        new RecyclerBinder.Builder().rangeRatio(RANGE_RATIO).build(mComponentContext);
+    final ArrayList<RenderInfo> renderInfos = new ArrayList<>();
+    for (int i = 0; i < 5; i++) {
+      final Component component =
+          TestDrawableComponent.create(mComponentContext).widthPx(100).heightPx(100).build();
+      renderInfos.add(ComponentRenderInfo.create().component(component).build());
+    }
+
+    recyclerBinder.insertRangeAtAsync(0, renderInfos);
+    recyclerBinder.notifyChangeSetComplete(changeSetCompleteCallback);
+
+    // Mount view after insertions
+    final LithoRecylerView recyclerView = new LithoRecylerView(RuntimeEnvironment.application);
+    recyclerBinder.mount(recyclerView);
+
+    recyclerBinder.measure(
+        new Size(), makeSizeSpec(1000, EXACTLY), makeSizeSpec(1000, EXACTLY), null);
+
+    // Simulate calling ViewGroup#dispatchDraw(Canvas).
+    recyclerView.dispatchDraw(mock(Canvas.class));
+
+    verify(changeSetCompleteCallback).onDataRendered();
+  }
+
+  @Test
+  public void testOnDataRenderedWithMountUnMountBeforeInsert() {
+    final ChangeSetCompleteCallback changeSetCompleteCallback =
+        mock(ChangeSetCompleteCallback.class);
+    final RecyclerBinder recyclerBinder =
+        new RecyclerBinder.Builder().rangeRatio(RANGE_RATIO).build(mComponentContext);
+    final ArrayList<RenderInfo> renderInfos = new ArrayList<>();
+    for (int i = 0; i < 5; i++) {
+      final Component component =
+          TestDrawableComponent.create(mComponentContext).widthPx(100).heightPx(100).build();
+      renderInfos.add(ComponentRenderInfo.create().component(component).build());
+    }
+
+    // mount() and unmount() are called prior to data insertions.
+    final RecyclerView recyclerView = mock(LithoRecylerView.class);
+    recyclerBinder.mount(recyclerView);
+    recyclerBinder.unmount(recyclerView);
+
+    recyclerBinder.insertRangeAt(0, renderInfos);
+    recyclerBinder.notifyChangeSetComplete(changeSetCompleteCallback);
+
+    verify(changeSetCompleteCallback).onDataRendered();
+  }
+
+  @Test
+  public void testOnDataRenderedWithNoPendingUpdate() {
+    final ChangeSetCompleteCallback changeSetCompleteCallback =
+        mock(ChangeSetCompleteCallback.class);
+    final RecyclerBinder recyclerBinder =
+        new RecyclerBinder.Builder().rangeRatio(RANGE_RATIO).build(mComponentContext);
+    final ArrayList<RenderInfo> renderInfos = new ArrayList<>();
+    for (int i = 0; i < 5; i++) {
+      final Component component =
+          TestDrawableComponent.create(mComponentContext).widthPx(100).heightPx(100).build();
+      renderInfos.add(ComponentRenderInfo.create().component(component).build());
+    }
+
+    final RecyclerView recyclerView = mock(LithoRecylerView.class);
+    when(recyclerView.hasPendingAdapterUpdates()).thenReturn(false);
+    when(recyclerView.isAttachedToWindow()).thenReturn(true);
+    when(recyclerView.getVisibility()).thenReturn(View.VISIBLE);
+    recyclerBinder.mount(recyclerView);
+
+    recyclerBinder.insertRangeAt(0, renderInfos);
+    recyclerBinder.notifyChangeSetComplete(changeSetCompleteCallback);
+
+    verify(changeSetCompleteCallback).onDataRendered();
+  }
+
+  @Test
+  public void testOnDataRenderedWithViewDetachedFromWindow() {
+    final ChangeSetCompleteCallback changeSetCompleteCallback =
+        mock(ChangeSetCompleteCallback.class);
+    final RecyclerBinder recyclerBinder =
+        new RecyclerBinder.Builder().rangeRatio(RANGE_RATIO).build(mComponentContext);
+    final ArrayList<RenderInfo> renderInfos = new ArrayList<>();
+    for (int i = 0; i < 5; i++) {
+      final Component component =
+          TestDrawableComponent.create(mComponentContext).widthPx(100).heightPx(100).build();
+      renderInfos.add(ComponentRenderInfo.create().component(component).build());
+    }
+
+    final RecyclerView recyclerView = mock(LithoRecylerView.class);
+    when(recyclerView.hasPendingAdapterUpdates()).thenReturn(true);
+    when(recyclerView.isAttachedToWindow()).thenReturn(false);
+    when(recyclerView.getVisibility()).thenReturn(View.VISIBLE);
+    recyclerBinder.mount(recyclerView);
+
+    recyclerBinder.insertRangeAt(0, renderInfos);
+    recyclerBinder.notifyChangeSetComplete(changeSetCompleteCallback);
+
+    verify(changeSetCompleteCallback).onDataRendered();
+  }
+
+  @Test
+  public void testOnDataRenderedWithViewVisibilityIsGone() {
+    final ChangeSetCompleteCallback changeSetCompleteCallback =
+        mock(ChangeSetCompleteCallback.class);
+    final RecyclerBinder recyclerBinder =
+        new RecyclerBinder.Builder().rangeRatio(RANGE_RATIO).build(mComponentContext);
+    final ArrayList<RenderInfo> renderInfos = new ArrayList<>();
+    for (int i = 0; i < 5; i++) {
+      final Component component =
+          TestDrawableComponent.create(mComponentContext).widthPx(100).heightPx(100).build();
+      renderInfos.add(ComponentRenderInfo.create().component(component).build());
+    }
+
+    final RecyclerView recyclerView = mock(LithoRecylerView.class);
+    when(recyclerView.hasPendingAdapterUpdates()).thenReturn(true);
+    when(recyclerView.isAttachedToWindow()).thenReturn(true);
+    when(recyclerView.getVisibility()).thenReturn(View.GONE);
+    recyclerBinder.mount(recyclerView);
+
+    recyclerBinder.insertRangeAt(0, renderInfos);
+    recyclerBinder.notifyChangeSetComplete(changeSetCompleteCallback);
+
+    verify(changeSetCompleteCallback).onDataRendered();
+  }
+
+  @Test
+  public void testOnDataRenderedWithMultipleUpdates() {
+    final ChangeSetCompleteCallback changeSetCompleteCallback1 =
+        mock(ChangeSetCompleteCallback.class);
+    final ChangeSetCompleteCallback changeSetCompleteCallback2 =
+        mock(ChangeSetCompleteCallback.class);
+    final RecyclerBinder recyclerBinder =
+        new RecyclerBinder.Builder().rangeRatio(RANGE_RATIO).build(mComponentContext);
+    final ArrayList<RenderInfo> renderInfos1 = new ArrayList<>();
+    final ArrayList<RenderInfo> renderInfos2 = new ArrayList<>();
+    for (int i = 0; i < 5; i++) {
+      final Component component =
+          TestDrawableComponent.create(mComponentContext).widthPx(100).heightPx(100).build();
+      renderInfos1.add(ComponentRenderInfo.create().component(component).build());
+      renderInfos2.add(ComponentRenderInfo.create().component(component).build());
+    }
+
+    recyclerBinder.insertRangeAt(0, renderInfos1);
+    recyclerBinder.notifyChangeSetComplete(changeSetCompleteCallback1);
+    verify(changeSetCompleteCallback1, never()).onDataRendered();
+
+    recyclerBinder.insertRangeAt(0, renderInfos2);
+    recyclerBinder.notifyChangeSetComplete(changeSetCompleteCallback2);
+    verify(changeSetCompleteCallback2, never()).onDataRendered();
+
+    // Mount view after insertions
+    final LithoRecylerView recyclerView = new LithoRecylerView(RuntimeEnvironment.application);
+    recyclerBinder.mount(recyclerView);
+
+    // Simulate calling ViewGroup#dispatchDraw(Canvas).
+    recyclerView.dispatchDraw(mock(Canvas.class));
+
+    verify(changeSetCompleteCallback1).onDataRendered();
+    verify(changeSetCompleteCallback2).onDataRendered();
+  }
+
+  @Test
+  public void testOnDataRenderedWithMultipleAsyncUpdates() {
+    final ChangeSetCompleteCallback changeSetCompleteCallback1 =
+        mock(ChangeSetCompleteCallback.class);
+    final ChangeSetCompleteCallback changeSetCompleteCallback2 =
+        mock(ChangeSetCompleteCallback.class);
+    final RecyclerBinder recyclerBinder =
+        new RecyclerBinder.Builder().rangeRatio(RANGE_RATIO).build(mComponentContext);
+    final ArrayList<RenderInfo> renderInfos1 = new ArrayList<>();
+    final ArrayList<RenderInfo> renderInfos2 = new ArrayList<>();
+    for (int i = 0; i < 5; i++) {
+      final Component component =
+          TestDrawableComponent.create(mComponentContext).widthPx(100).heightPx(100).build();
+      renderInfos1.add(ComponentRenderInfo.create().component(component).build());
+      renderInfos2.add(ComponentRenderInfo.create().component(component).build());
+    }
+
+    recyclerBinder.insertRangeAtAsync(0, renderInfos1);
+    recyclerBinder.notifyChangeSetComplete(changeSetCompleteCallback1);
+    verify(changeSetCompleteCallback1, never()).onDataRendered();
+
+    recyclerBinder.insertRangeAtAsync(0, renderInfos2);
+    recyclerBinder.notifyChangeSetComplete(changeSetCompleteCallback2);
+    verify(changeSetCompleteCallback2, never()).onDataRendered();
+
+    // Mount view after insertions
+    final LithoRecylerView recyclerView = new LithoRecylerView(RuntimeEnvironment.application);
+    recyclerBinder.mount(recyclerView);
+
+    recyclerBinder.measure(
+        new Size(), makeSizeSpec(1000, EXACTLY), makeSizeSpec(1000, EXACTLY), null);
+
+    // Simulate calling ViewGroup#dispatchDraw(Canvas).
+    recyclerView.dispatchDraw(mock(Canvas.class));
+
+    verify(changeSetCompleteCallback1).onDataRendered();
+    verify(changeSetCompleteCallback2).onDataRendered();
+  }
+
+  @Test
+  public void testOnDataRenderedWithNoChanges() {
+    final ChangeSetCompleteCallback changeSetCompleteCallback =
+        mock(ChangeSetCompleteCallback.class);
+    final RecyclerBinder recyclerBinder =
+        new RecyclerBinder.Builder().rangeRatio(RANGE_RATIO).build(mComponentContext);
+    final ArrayList<RenderInfo> renderInfos = new ArrayList<>();
+    for (int i = 0; i < 5; i++) {
+      final Component component =
+          TestDrawableComponent.create(mComponentContext).widthPx(100).heightPx(100).build();
+      renderInfos.add(ComponentRenderInfo.create().component(component).build());
+    }
+
+    final RecyclerView recyclerView = mock(LithoRecylerView.class);
+    when(recyclerView.hasPendingAdapterUpdates()).thenReturn(true);
+    recyclerBinder.mount(recyclerView);
+
+    recyclerBinder.insertRangeAt(0, renderInfos);
+    recyclerBinder.notifyChangeSetComplete(changeSetCompleteCallback);
+
+    verify(changeSetCompleteCallback).onDataRendered();
+
+    reset(changeSetCompleteCallback);
+
+    // Call notifyChangeSetComplete with no actual data change.
+    recyclerBinder.notifyChangeSetComplete(changeSetCompleteCallback);
+
+    verify(changeSetCompleteCallback).onDataRendered();
+  }
+
   private RecyclerBinder createRecyclerBinderWithMockAdapter(RecyclerView.Adapter adapterMock) {
     return new RecyclerBinder.Builder()
         .rangeRatio(RANGE_RATIO)

litho-widget/src/main/java/com/facebook/litho/widget/HasPostDispatchDrawListener.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2014-present Facebook, Inc.
+ *
+ * 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.facebook.litho.widget;
+
+import android.support.annotation.Nullable;
+
+public interface HasPostDispatchDrawListener {
+
+  // Provide a listener that would call postDispatchDraw() when ViewGroup#dispachDraw() is called.
+  void setPostDispatchDrawListener(@Nullable PostDispatchDrawListener listener);
+}

litho-widget/src/main/java/com/facebook/litho/widget/LithoRecylerView.java

@@ -17,6 +17,7 @@
 package com.facebook.litho.widget;
 
 import android.content.Context;
+import android.graphics.Canvas;
 import android.support.annotation.Nullable;
 import android.support.v7.widget.RecyclerView;
 import android.util.AttributeSet;
@@ -26,9 +27,10 @@
  * Extension of {@link RecyclerView} that allows to add more features needed for @{@link
  * RecyclerSpec}
  */
-public class LithoRecylerView extends RecyclerView {
+public class LithoRecylerView extends RecyclerView implements HasPostDispatchDrawListener {
 
   private @Nullable TouchInterceptor mTouchInterceptor;
+  private @Nullable PostDispatchDrawListener mPostDispatchDrawListener;
 
   public LithoRecylerView(Context context) {
     this(context, null);
@@ -69,6 +71,20 @@ public boolean onInterceptTouchEvent(MotionEvent ev) {
     }
   }
 
+  @Override
+  protected void dispatchDraw(Canvas canvas) {
+    super.dispatchDraw(canvas);
+
+    if (mPostDispatchDrawListener != null) {
+      mPostDispatchDrawListener.postDispatchDraw();
+    }
+  }
+
+  @Override
+  public void setPostDispatchDrawListener(@Nullable PostDispatchDrawListener listener) {
+    mPostDispatchDrawListener = listener;
+  }
+
   /** Allows to override {@link #onInterceptTouchEvent(MotionEvent)} behavior */
   public interface TouchInterceptor {
 

litho-widget/src/main/java/com/facebook/litho/widget/PostDispatchDrawListener.java

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2014-present Facebook, Inc.
+ *
+ * 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.facebook.litho.widget;
+
+public interface PostDispatchDrawListener {
+
+  void postDispatchDraw();
+}