Don't send touch move to renderer while scrolling

content/browser/renderer_host/render_widget_host_unittest.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "base/basictypes.h"
+#include "base/command_line.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/shared_memory.h"
 #include "base/timer.h"
 #include "content/browser/browser_thread_impl.h"
 #include "content/browser/renderer_host/backing_store.h"
 #include "content/browser/renderer_host/gesture_event_filter.h"
 #include "content/browser/renderer_host/overscroll_controller.h"
 #include "content/browser/renderer_host/overscroll_controller_delegate.h"
 #include "content/browser/renderer_host/render_widget_host_delegate.h"
 #include "content/browser/renderer_host/tap_suppression_controller.h"
 #include "content/browser/renderer_host/tap_suppression_controller_client.h"
 #include "content/browser/renderer_host/test_render_view_host.h"
 #include "content/browser/renderer_host/touch_event_queue.h"
 #include "content/common/input_messages.h"
 #include "content/common/view_messages.h"
 #include "content/port/browser/render_widget_host_view_port.h"
 #include "content/public/browser/notification_details.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
 #include "content/public/browser/notification_source.h"
 #include "content/public/browser/notification_types.h"
+#include "content/public/common/content_switches.h"
 #include "content/public/test/mock_render_process_host.h"
 #include "content/public/test/test_browser_context.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "ui/base/keycodes/keyboard_codes.h"
 #include "ui/gfx/canvas.h"
 #include "ui/gfx/screen.h"
 
 #if defined(USE_AURA)
 #include "content/browser/renderer_host/render_widget_host_view_aura.h"
 #include "ui/aura/env.h"
@@ skipping 3633 matching lines @@
   EXPECT_EQ(OVERSCROLL_NONE, host_->overscroll_mode());
   EXPECT_EQ(OVERSCROLL_NONE, host_->overscroll_delegate()->current_mode());
   EXPECT_EQ(1U, host_->GestureEventLastQueueEventSize());
   EXPECT_EQ(0U, host_->GestureEventDebouncingQueueSize());
   EXPECT_EQ(1U, process_->sink().message_count());
 }
 
 // Tests that when touch-events are dispatched to the renderer, the overscroll
 // gesture deals with them correctly.
 TEST_F(RenderWidgetHostTest, OverscrollWithTouchEvents) {
+  // The event flow in this test is not the same if touch-cancel-on-scroll is
+  // enabled. So disable touch-cancel-on-scroll for this test.
+  CommandLine::ForCurrentProcess()->AppendSwitchASCII(
+      switches::kTouchCancelOnScroll, "0");
   host_->SetupForOverscrollControllerTest();
   host_->set_debounce_interval_time_ms(10);
   host_->OnMessageReceived(ViewHostMsg_HasTouchEventHandlers(0, true));
   process_->sink().ClearMessages();
   view_->set_bounds(gfx::Rect(0, 0, 400, 200));
   view_->Show();
 
   // The test sends an intermingled sequence of touch and gesture events.
 
   PressTouchPoint(0, 1);
@@ skipping 538 matching lines @@
   EXPECT_EQ(OVERSCROLL_EAST, host_->overscroll_delegate()->current_mode());
   EXPECT_EQ(OVERSCROLL_NONE, host_->overscroll_delegate()->completed_mode());
 
   SimulateGestureEvent(WebInputEvent::GestureScrollEnd,
                        WebGestureEvent::Touchscreen);
   EXPECT_EQ(OVERSCROLL_NONE, host_->overscroll_delegate()->current_mode());
   EXPECT_EQ(OVERSCROLL_EAST, host_->overscroll_delegate()->completed_mode());
   process_->sink().ClearMessages();
 }
 
+// Tests that when scroll starts, fake touch cancel is sent to renderer and
+// no touch events are sent to renderer during scrolling.
+TEST_F(RenderWidgetHostTest, TouchCancelOnScroll) {
+  CommandLine::ForCurrentProcess()->AppendSwitchASCII(
+      switches::kTouchCancelOnScroll, "1");
+  host_->OnMessageReceived(ViewHostMsg_HasTouchEventHandlers(0, true));
+  host_->set_debounce_interval_time_ms(0);
+  process_->sink().ClearMessages();
+  view_->set_bounds(gfx::Rect(0, 0, 400, 200));
+  view_->Show();
+
+  PressTouchPoint(0, 1);
+  if (host_->ShouldForwardTouchEvent())

[sadrul, 2013/06/20 08:51:27]

Use EXPECT to verify the expectation, since the state of the host_ should be
known here.

[Yufeng Shen (Slow to review), 2013/06/20 17:56:45]

Done.

+    SendTouchEvent();
+  EXPECT_EQ(1U, process_->sink().message_count());
+  process_->sink().ClearMessages();
+  SendInputEventACK(WebInputEvent::TouchStart,
+                    INPUT_EVENT_ACK_STATE_NOT_CONSUMED);
+
+  MoveTouchPoint(0, 20, 5);
+  if (host_->ShouldForwardTouchEvent())
+    SendTouchEvent();
+  EXPECT_EQ(1U, process_->sink().message_count());
+  process_->sink().ClearMessages();
+  SendInputEventACK(WebInputEvent::TouchMove,
+                    INPUT_EVENT_ACK_STATE_NOT_CONSUMED);
+
+  // GestureScrollBegin does not trigger touch cancel.
+  SimulateGestureEvent(WebInputEvent::GestureScrollBegin,
+                       WebGestureEvent::Touchscreen);
+  EXPECT_FALSE(host_->is_scroll_update_in_progress());
+  EXPECT_EQ(1U, process_->sink().message_count());
+  SendInputEventACK(WebInputEvent::GestureScrollBegin,
+                    INPUT_EVENT_ACK_STATE_NOT_CONSUMED);
+  process_->sink().ClearMessages();
+
+  // Touch event keeps coming.
+  MoveTouchPoint(0, 30, 5);
+  if (host_->ShouldForwardTouchEvent())
+    SendTouchEvent();
+  EXPECT_EQ(1U, process_->sink().message_count());
+  process_->sink().ClearMessages();
+
+  // GestureScrollUpdate triggers touch cancel.
+  SimulateGestureScrollUpdateEvent(20, 4, 0);
+  EXPECT_TRUE(host_->is_scroll_update_in_progress());
+  // TouchCancel & GestureScrollUpdate are sent.
+  EXPECT_EQ(2U, process_->sink().message_count());
+  EXPECT_EQ(GetInputEventFromMessage(*process_->sink().GetMessageAt(0))->type,
+            WebInputEvent::TouchCancel);
+  EXPECT_EQ(GetInputEventFromMessage(*process_->sink().GetMessageAt(1))->type,
+            WebInputEvent::GestureScrollUpdate);
+  EXPECT_EQ(1U, host_->GestureEventLastQueueEventSize());
+  // Touch event queue should remain empty since we don't want to process
+  // acked touch cancel.
+  EXPECT_EQ(0U, host_->TouchEventQueueSize());
+
+  SendInputEventACK(WebInputEvent::GestureScrollUpdate,
+                    INPUT_EVENT_ACK_STATE_NOT_CONSUMED);
+  process_->sink().ClearMessages();
+
+  // Touch move event should not reach the renderer when scroll update is in
+  // progress.
+  MoveTouchPoint(0, 65, 10);
+  if (host_->ShouldForwardTouchEvent())
+    SendTouchEvent();
+  EXPECT_EQ(0U, process_->sink().message_count());
+  process_->sink().ClearMessages();
+
+  SimulateGestureEvent(WebKit::WebInputEvent::GestureScrollEnd,
+                       WebGestureEvent::Touchscreen);
+  EXPECT_FALSE(host_->is_scroll_update_in_progress());
+  EXPECT_EQ(1U, process_->sink().message_count());
+  process_->sink().ClearMessages();
+  SendInputEventACK(WebInputEvent::GestureScrollEnd,
+                    INPUT_EVENT_ACK_STATE_NOT_CONSUMED);
+
+  // Now touch events should come through to renderer.
+  MoveTouchPoint(0, 80, 10);
+  if (host_->ShouldForwardTouchEvent())
+    SendTouchEvent();
+  EXPECT_EQ(1U, process_->sink().message_count());
+  EXPECT_EQ(GetInputEventFromMessage(*process_->sink().GetMessageAt(0))->type,
+            WebInputEvent::TouchMove);
+  process_->sink().ClearMessages();
+}
 }  // namespace content