phase based wheel scroll latching for mac

content/browser/renderer_host/render_widget_host_view_mac_unittest.mm

 // 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 "content/browser/renderer_host/render_widget_host_view_mac.h"
 
 #include <Cocoa/Cocoa.h>
 #include <stddef.h>
 #include <stdint.h>
 #include <tuple>
 
 #include "base/command_line.h"
 #include "base/mac/scoped_nsautorelease_pool.h"
 #include "base/mac/sdk_forward_declarations.h"
 #include "base/macros.h"
 #include "base/run_loop.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/test/histogram_tester.h"
+#include "base/test/scoped_feature_list.h"
 #include "base/test/simple_test_tick_clock.h"
+#include "base/threading/thread_task_runner_handle.h"
 #include "content/browser/browser_thread_impl.h"
 #include "content/browser/compositor/test/no_transport_image_transport_factory.h"
 #include "content/browser/frame_host/render_widget_host_view_guest.h"
 #include "content/browser/gpu/compositor_util.h"
 #include "content/browser/renderer_host/render_widget_host_delegate.h"
 #include "content/browser/renderer_host/text_input_manager.h"
 #include "content/common/input_messages.h"
 #include "content/common/text_input_state.h"
 #include "content/common/view_messages.h"
 #include "content/public/browser/notification_types.h"
 #include "content/public/browser/render_widget_host_view_mac_delegate.h"
+#include "content/public/common/content_features.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 "content/public/test/test_utils.h"
 #include "content/test/test_render_view_host.h"
 #include "gpu/ipc/common/gpu_messages.h"
 #include "gpu/ipc/service/image_transport_surface.h"
 #include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "testing/gtest_mac.h"
 #import "third_party/ocmock/OCMock/OCMock.h"
 #import "third_party/ocmock/ocmock_extensions.h"
 #import "ui/base/test/scoped_fake_nswindow_focus.h"
 #include "ui/events/base_event_utils.h"
 #include "ui/events/blink/web_input_event_traits.h"
 #include "ui/events/test/cocoa_test_event_utils.h"
 #import "ui/gfx/test/ui_cocoa_test_helper.h"
 #include "ui/latency/latency_info.h"
 
 // Helper class with methods used to mock -[NSEvent phase], used by
 // |MockScrollWheelEventWithPhase()|.
 @interface MockPhaseMethods : NSObject {
 }
 
+- (NSEventPhase)phaseNone;
 - (NSEventPhase)phaseBegan;
 - (NSEventPhase)phaseChanged;
 - (NSEventPhase)phaseEnded;
 @end
 
 @implementation MockPhaseMethods
 
+- (NSEventPhase)phaseNone {
+  return NSEventPhaseNone;
+}
 - (NSEventPhase)phaseBegan {
   return NSEventPhaseBegan;
 }
 - (NSEventPhase)phaseChanged {
   return NSEventPhaseChanged;
 }
 - (NSEventPhase)phaseEnded {
   return NSEventPhaseEnded;
 }
 
@@ skipping 218 matching lines @@
   CGEventTimestamp timestamp = 0;
   CGEventSetTimestamp(cg_event, timestamp);
   NSEvent* event = [NSEvent eventWithCGEvent:cg_event];
   CFRelease(cg_event);
   method_setImplementation(
       class_getInstanceMethod([NSEvent class], @selector(phase)),
       [MockPhaseMethods instanceMethodForSelector:mockPhaseSelector]);
   return event;
 }
 
+NSEvent* MockScrollWheelEventWithMomentumPhase(SEL mockPhaseSelector,
+                                               int32_t delta) {
+  // Create a dum event with phaseNone. This is for resetting the phase info of

[tdresser, 2017/05/25 15:18:37]

dum -> dummy?

[sahel, 2017/05/25 16:00:04]

Done.

+  // CGEventRef.
+  MockScrollWheelEventWithPhase(@selector(phaseNone), 0);
+  CGEventRef cg_event1 = CGEventCreateScrollWheelEvent(

[tdresser, 2017/05/25 15:18:36]

Why event1 instead of just event? (and below with event1).

[sahel, 2017/05/25 16:00:04]

Done.

+      nullptr, kCGScrollEventUnitLine, 1, delta, 0);
+  CGEventTimestamp timestamp = 0;
+  CGEventSetTimestamp(cg_event1, timestamp);
+  // CGEventSetIntegerValueField(cg_event1, kCGScrollWheelEventMomentumPhase,
+  //                               cg_momentum_phase);

[tdresser, 2017/05/25 15:18:36]

Should these lines be removed?

[sahel, 2017/05/25 16:00:04]

Done, I am sorry for the sloppy unittest file, I didn't mean to upload this
version.

+  // CGEventSetFlags(cg_event1, static_cast<CGEventFlags>(0));
+  NSEvent* event1 = [NSEvent eventWithCGEvent:cg_event1];
+  CFRelease(cg_event1);
+  method_setImplementation(
+      class_getInstanceMethod([NSEvent class], @selector(momentumPhase)),
+      [MockPhaseMethods instanceMethodForSelector:mockPhaseSelector]);
+  return event1;
+}
+
 }  // namespace
 
 class RenderWidgetHostViewMacTest : public RenderViewHostImplTestHarness {
  public:
   RenderWidgetHostViewMacTest() : rwhv_mac_(nullptr), old_rwhv_(nullptr) {
     std::unique_ptr<base::SimpleTestTickClock> mock_clock(
         new base::SimpleTestTickClock());
     mock_clock->Advance(base::TimeDelta::FromMilliseconds(100));
     ui::SetEventTickClockForTesting(std::move(mock_clock));
   }
@@ skipping 991 matching lines @@
   EXPECT_FALSE([view->cocoa_view() isOpaque]);
   set_background = process_host->sink().GetUniqueMessageMatching(
       ViewMsg_SetBackgroundOpaque::ID);
   ASSERT_TRUE(set_background);
   ViewMsg_SetBackgroundOpaque::Read(set_background, &sent_background);
   EXPECT_FALSE(std::get<0>(sent_background));
 
   host->ShutdownAndDestroyWidget(true);
 }
 
+class RenderWidgetHostViewMacWithWheelScrollLatchingEnabledTest
+    : public RenderWidgetHostViewMacTest {
+ public:
+  RenderWidgetHostViewMacWithWheelScrollLatchingEnabledTest() {
+    feature_list_.InitFromCommandLine(
+        features::kTouchpadAndWheelScrollLatching.name, "");
+  }
+
+ private:
+  base::test::ScopedFeatureList feature_list_;
+};
+
+TEST_F(RenderWidgetHostViewMacWithWheelScrollLatchingEnabledTest,
+       WheelWithPhaseEndedIsNotForwardedImmediately) {

[tdresser, 2017/05/25 15:18:36]

Can you add a comment briefly explaining why it shouldn't be forwarded
immediately?

[sahel, 2017/05/25 16:00:04]

Done.

+  // Initialize the view associated with a MockRenderWidgetHostImpl, rather than
+  // the MockRenderProcessHost that is set up by the test harness which mocks
+  // out |OnMessageReceived()|.
+  TestBrowserContext browser_context;
+  MockRenderProcessHost* process_host =
+      new MockRenderProcessHost(&browser_context);
+  process_host->Init();
+  MockRenderWidgetHostDelegate delegate;
+  int32_t routing_id = process_host->GetNextRoutingID();
+  MockRenderWidgetHostImpl* host =
+      new MockRenderWidgetHostImpl(&delegate, process_host, routing_id);
+  RenderWidgetHostViewMac* view = new RenderWidgetHostViewMac(host, false);
+  process_host->sink().ClearMessages();
+
+  // Send an initial wheel event for scrolling by 3 lines.
+  NSEvent* wheelEvent1 =
+      MockScrollWheelEventWithPhase(@selector(phaseBegan), 3);
+  [view->cocoa_view() scrollWheel:wheelEvent1];
+  ASSERT_EQ(1U, process_host->sink().message_count());
+  process_host->sink().ClearMessages();
+
+  // Indicate that the wheel event was unhandled.
+  InputEventAck unhandled_ack(InputEventAckSource::COMPOSITOR_THREAD,
+                              blink::WebInputEvent::kMouseWheel,
+                              INPUT_EVENT_ACK_STATE_NOT_CONSUMED);
+  std::unique_ptr<IPC::Message> response1(
+      new InputHostMsg_HandleInputEvent_ACK(0, unhandled_ack));
+  host->OnMessageReceived(*response1);
+  ASSERT_EQ(2U, process_host->sink().message_count());
+  process_host->sink().ClearMessages();
+
+  // Send a wheel event with phaseEnded. When wheel scroll latching is enabled
+  // the evnet will be dropped and the mouse_wheel_end_dispatch_timer_ will

[tdresser, 2017/05/25 15:18:37]

evnet -> event

[sahel, 2017/05/25 16:00:04]

Done.

+  // start.
+  NSEvent* wheelEvent2 =
+      MockScrollWheelEventWithPhase(@selector(phaseEnded), 0);
+  [view->cocoa_view() scrollWheel:wheelEvent2];
+  ASSERT_EQ(0U, process_host->sink().message_count());
+  DCHECK(view->mouse_wheel_end_dispatch_timer_.IsRunning());
+  process_host->sink().ClearMessages();
+
+  host->ShutdownAndDestroyWidget(true);
+}
+
+TEST_F(RenderWidgetHostViewMacWithWheelScrollLatchingEnabledTest,
+       WheelWithMomentumPhaseBeganStopsTheWheelEndDispatchTimer) {
+  // Initialize the view associated with a MockRenderWidgetHostImpl, rather than
+  // the MockRenderProcessHost that is set up by the test harness which mocks
+  // out |OnMessageReceived()|.
+  TestBrowserContext browser_context;
+  MockRenderProcessHost* process_host =
+      new MockRenderProcessHost(&browser_context);
+  process_host->Init();
+  MockRenderWidgetHostDelegate delegate;
+  int32_t routing_id = process_host->GetNextRoutingID();
+  MockRenderWidgetHostImpl* host =
+      new MockRenderWidgetHostImpl(&delegate, process_host, routing_id);
+  RenderWidgetHostViewMac* view = new RenderWidgetHostViewMac(host, false);
+  process_host->sink().ClearMessages();
+
+  // Send an initial wheel event for scrolling by 3 lines.
+  NSEvent* wheelEvent1 =
+      MockScrollWheelEventWithPhase(@selector(phaseBegan), 3);
+  [view->cocoa_view() scrollWheel:wheelEvent1];
+  ASSERT_EQ(1U, process_host->sink().message_count());
+  process_host->sink().ClearMessages();
+
+  // Indicate that the wheel event was unhandled.
+  InputEventAck unhandled_ack(InputEventAckSource::COMPOSITOR_THREAD,
+                              blink::WebInputEvent::kMouseWheel,
+                              INPUT_EVENT_ACK_STATE_NOT_CONSUMED);
+  std::unique_ptr<IPC::Message> response1(
+      new InputHostMsg_HandleInputEvent_ACK(0, unhandled_ack));
+  host->OnMessageReceived(*response1);
+  ASSERT_EQ(2U, process_host->sink().message_count());
+  process_host->sink().ClearMessages();
+
+  // Send a wheel event with phaseEnded. When wheel scroll latching is enabled
+  // the evnet will be dropped and the mouse_wheel_end_dispatch_timer_ will

[tdresser, 2017/05/25 15:18:37]

evnet -> event

[sahel, 2017/05/25 16:00:04]

Done.

+  // start.
+  NSEvent* wheelEvent2 =
+      MockScrollWheelEventWithPhase(@selector(phaseEnded), 0);
+  [view->cocoa_view() scrollWheel:wheelEvent2];
+  ASSERT_EQ(0U, process_host->sink().message_count());
+  DCHECK(view->mouse_wheel_end_dispatch_timer_.IsRunning());
+  process_host->sink().ClearMessages();
+
+  // Send a wheel event with momentum phase started, this should stop the wheel
+  // end dispatch timer.
+  NSEvent* wheelEvent3 =
+      MockScrollWheelEventWithMomentumPhase(@selector(phaseBegan), 3);
+  ASSERT_TRUE(wheelEvent3);
+  [view->cocoa_view() scrollWheel:wheelEvent3];
+  ASSERT_EQ(1U, process_host->sink().message_count());
+  DCHECK(!view->mouse_wheel_end_dispatch_timer_.IsRunning());
+  process_host->sink().ClearMessages();
+
+  host->ShutdownAndDestroyWidget(true);
+}
+
+TEST_F(RenderWidgetHostViewMacWithWheelScrollLatchingEnabledTest,
+       WheelWithPhaseBeganDispatchesThePendingWheelEnd) {
+  // Initialize the view associated with a MockRenderWidgetHostImpl, rather than
+  // the MockRenderProcessHost that is set up by the test harness which mocks
+  // out |OnMessageReceived()|.
+  TestBrowserContext browser_context;
+  MockRenderProcessHost* process_host =
+      new MockRenderProcessHost(&browser_context);
+  process_host->Init();
+  MockRenderWidgetHostDelegate delegate;
+  int32_t routing_id = process_host->GetNextRoutingID();
+  MockRenderWidgetHostImpl* host =
+      new MockRenderWidgetHostImpl(&delegate, process_host, routing_id);
+  RenderWidgetHostViewMac* view = new RenderWidgetHostViewMac(host, false);
+  process_host->sink().ClearMessages();
+
+  // Send an initial wheel event for scrolling by 3 lines.
+  NSEvent* wheelEvent1 =
+      MockScrollWheelEventWithPhase(@selector(phaseBegan), 3);
+  [view->cocoa_view() scrollWheel:wheelEvent1];
+  ASSERT_EQ(1U, process_host->sink().message_count());
+  process_host->sink().ClearMessages();
+
+  // Indicate that the wheel event was unhandled.
+  InputEventAck unhandled_ack(InputEventAckSource::COMPOSITOR_THREAD,
+                              blink::WebInputEvent::kMouseWheel,
+                              INPUT_EVENT_ACK_STATE_NOT_CONSUMED);
+  std::unique_ptr<IPC::Message> response1(
+      new InputHostMsg_HandleInputEvent_ACK(0, unhandled_ack));
+  host->OnMessageReceived(*response1);
+  ASSERT_EQ(2U, process_host->sink().message_count());
+  process_host->sink().ClearMessages();
+
+  // Send a wheel event with phaseEnded. When wheel scroll latching is enabled
+  // the evnet will be dropped and the mouse_wheel_end_dispatch_timer_ will

[tdresser, 2017/05/25 15:18:36]

evnet -> event

[sahel, 2017/05/25 16:00:04]

Done.

+  // start.
+  NSEvent* wheelEvent2 =
+      MockScrollWheelEventWithPhase(@selector(phaseEnded), 0);
+  [view->cocoa_view() scrollWheel:wheelEvent2];
+  ASSERT_EQ(0U, process_host->sink().message_count());
+  DCHECK(view->mouse_wheel_end_dispatch_timer_.IsRunning());
+  process_host->sink().ClearMessages();
+
+  // Send a wheel event with phase started, this should stop the wheel end
+  // dispatch timer and dispatch the pending wheel end event for the previous
+  // scroll sequence.
+  NSEvent* wheelEvent3 =
+      MockScrollWheelEventWithPhase(@selector(phaseBegan), 3);
+  ASSERT_TRUE(wheelEvent3);
+  [view->cocoa_view() scrollWheel:wheelEvent3];
+  ASSERT_EQ(2U, process_host->sink().message_count());
+  DCHECK(!view->mouse_wheel_end_dispatch_timer_.IsRunning());
+  process_host->sink().ClearMessages();
+
+  host->ShutdownAndDestroyWidget(true);
+}
+
 class RenderWidgetHostViewMacPinchTest : public RenderWidgetHostViewMacTest {
  public:
   RenderWidgetHostViewMacPinchTest() : process_host_(nullptr) {}
 
   bool ZoomDisabledForPinchUpdateMessage() {
     const IPC::Message* message = nullptr;
     // The first message may be a PinchBegin. Go for the second message if
     // there are two.
     switch (process_host_->sink().message_count()) {
       case 1:
@@ skipping 515 matching lines @@
   // -performKeyEquivalent: now returns YES to prevent further propagation, and
   // the event is sent to the renderer.
   EXPECT_TRUE([window performKeyEquivalent:key_down]);
   EXPECT_EQ(2U, process_host->sink().message_count());
   EXPECT_EQ("RawKeyDown Char", GetInputMessageTypes(process_host));
 
   rwhv_mac_->release_pepper_fullscreen_window_for_testing();
 }
 
 }  // namespace content