Surface synchronization: Throttle auto-resize renderer side

This is a short term fix until child-allocated LocalSurfaceIDs are implemented
for auto-resize.

Prior to surface synchronization, child renderers would allocate LocalSurfaceIds
for auto-resize. When the renderer receives a DidReceiveCompositorFrameAck
message then it knows the compositor has received the frame, and informs the
browser process which then resizes the associated aura window to match the
frame generated by the child. This ensured that the aura window would only be
resized to a size that had a surface.

With surface synchronization, every auto-resize resulted in a request for a
LocalSurfaceId from the parent. The parent would immediately resize the aura
window and embed the newly allocated LocalSurfaceId and then tell the child
about it. In the meantime, the child may auto-resize again. Surface
synchronization would block the parent on that LocalSurfaceId
that never resolves until the child makes another request. After the deadline
passes, the user sees flicker.

This CL does not address the root cause of the problem (allocating IDs for
surfaces that are never created), but it does significantly reduce the problem.

Instead of immediately informing the browser when an auto-resize happens in the
renderer. The ACK is posted as a task on the renderer's queue. The renderer may
auto-resize multiple times until that task is handled, and so we effectively
coalesce resize requests before making a request to the browser.

This significantly reduces flicker.

This is not the final state of auto-resize, though. In the future, the renderer
will immediately allocate a LocalSurfaceId and submit a CompositorFrame, and
then tell the browser about it to embed it. Occasionally, there will be a
conflict between browser and renderer changes, but this should be very rare.

Bug: 812127, 811181, 672962
Change-Id: I08839c4b498b68ba06bb5d818337738e191cf9be
Reviewed-on: https://chromium-review.googlesource.com/920341
Commit-Queue: Fady Samuel <fsamuel@chromium.org>
Reviewed-by: Antoine Labour <piman@chromium.org>
Cr-Commit-Position: refs/heads/master@{#537173}

content/renderer/render_view_impl.cc

@@ -1913,6 +1913,8 @@ void RenderViewImpl::OnDisableAutoResize(const gfx::Size& new_size) {
   if (!webview())
     return;
   auto_resize_mode_ = false;
+  auto_resize_ack_callback_.Cancel();
+  need_resize_ack_for_auto_resize_ = false;
   webview()->DisableAutoResizeMode();
 
   if (!new_size.IsEmpty()) {
@@ -1938,8 +1940,10 @@ void RenderViewImpl::OnSetLocalSurfaceIdForAutoResize(
     const content::ScreenInfo& screen_info,
     uint32_t content_source_id,
     const viz::LocalSurfaceId& local_surface_id) {
-  if (!auto_resize_mode_ || resize_or_repaint_ack_num_ != sequence_number)
+  if (!auto_resize_mode_ || resize_or_repaint_ack_num_ != sequence_number) {
+    DidResizeOrRepaintAck();
     return;
+  }
 
   SetLocalSurfaceIdForAutoResize(sequence_number, screen_info,
                                  content_source_id, local_surface_id);

content/renderer/render_widget.cc

@@ -848,8 +848,10 @@ void RenderWidget::OnSetLocalSurfaceIdForAutoResize(
     const content::ScreenInfo& screen_info,
     uint32_t content_source_id,
     const viz::LocalSurfaceId& local_surface_id) {
-  if (!auto_resize_mode_ || resize_or_repaint_ack_num_ != sequence_number)
+  if (!auto_resize_mode_ || resize_or_repaint_ack_num_ != sequence_number) {
+    DidResizeOrRepaintAck();
     return;
+  }
 
   SetLocalSurfaceIdForAutoResize(sequence_number, screen_info,
                                  content_source_id, local_surface_id);
@@ -2377,8 +2379,13 @@ void RenderWidget::DidAutoResize(const gfx::Size& new_size) {
       // on, that notification will not arrive here because the compositor is
       // deferring commits and thus submission of CompositorFrames.
       if (!size_.IsEmpty() && compositor_ &&
-          compositor_->IsSurfaceSynchronizationEnabled()) {
-        DidResizeOrRepaintAck();
+          compositor_->IsSurfaceSynchronizationEnabled() &&
+          !auto_resize_ack_callback_.callback()) {
+        auto_resize_ack_callback_.Reset(
+            base::BindOnce(&RenderWidget::DidResizeOrRepaintAck,
+                           weak_ptr_factory_.GetWeakPtr()));
+        base::ThreadTaskRunnerHandle::Get()->PostTask(
+            FROM_HERE, auto_resize_ack_callback_.callback());
       }
     }
   }

content/renderer/render_widget.h

@@ -15,6 +15,7 @@
 #include <vector>
 
 #include "base/callback.h"
+#include "base/cancelable_callback.h"
 #include "base/compiler_specific.h"
 #include "base/macros.h"
 #include "base/memory/ref_counted.h"
@@ -735,6 +736,11 @@ class CONTENT_EXPORT RenderWidget
   // The sequence number used for ViewHostMsg_UpdateRect.
   uint64_t resize_or_repaint_ack_num_ = 0;
 
+  // A pending ResizeOrRepaintAck callback in response to an auto-resize
+  // initiated by Blink. If auto-resize mode is canceled with an in-flight
+  // Ack, then the Ack will be canceled.
+  base::CancelableOnceClosure auto_resize_ack_callback_;
+
   // Set to true if we should ignore RenderWidget::Show calls.
   bool did_show_;