Touch gestures for System Tray/ IME/ Stylus/ Notifications

ash/system/tray/system_tray_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 "ash/system/tray/system_tray.h"
 
 #include <string>
 #include <vector>
 
 #include "ash/accelerators/accelerator_controller.h"
 #include "ash/accessibility_delegate.h"
 #include "ash/public/cpp/shell_window_ids.h"
 #include "ash/root_window_controller.h"
 #include "ash/shelf/shelf.h"
 #include "ash/shelf/shelf_widget.h"
 #include "ash/shell.h"
 #include "ash/system/status_area_widget.h"
 #include "ash/system/tray/system_tray_bubble.h"
 #include "ash/system/tray/system_tray_item.h"
 #include "ash/system/tray/tray_constants.h"
+#include "ash/system/tray_drag_controller.h"
 #include "ash/system/web_notification/web_notification_tray.h"
 #include "ash/test/ash_test_base.h"
 #include "ash/test/status_area_widget_test_helper.h"
 #include "ash/test/test_system_tray_item.h"
 #include "ash/wm/maximize_mode/maximize_mode_controller.h"
 #include "ash/wm/window_util.h"
 #include "base/memory/ptr_util.h"
 #include "base/run_loop.h"
 #include "base/test/histogram_tester.h"
 #include "ui/base/ui_base_types.h"
@@ skipping 25 matching lines @@
   DISALLOW_COPY_AND_ASSIGN(ModalWidgetDelegate);
 };
 
 }  // namespace
 
 class SystemTrayTest : public AshTestBase {
  public:
   SystemTrayTest() {}
   ~SystemTrayTest() override {}
 
-  // Swiping on the system tray and ends with finger released.
+  // Swiping on the system tray and ends with finger released. Note, |start| is
+  // based on the system tray or system tray bubble's coordinate space.
   void SendGestureEvent(gfx::Point& start,
                         float delta,
                         bool is_fling,
                         float velocity_y) {
     SystemTray* system_tray = GetPrimarySystemTray();
     base::TimeTicks timestamp = base::TimeTicks::Now();
     SendScrollStartAndUpdate(start, delta, timestamp);
 
     ui::GestureEventDetails details =
         is_fling
             ? ui::GestureEventDetails(ui::ET_SCROLL_FLING_START, 0, velocity_y)
             : ui::GestureEventDetails(ui::ET_GESTURE_SCROLL_END);
     ui::GestureEvent event = ui::GestureEvent(start.x(), start.y() + delta,
                                               ui::EF_NONE, timestamp, details);
-    system_tray->OnGestureEvent(&event);
+    ui::Event::DispatcherApi dispatch_helper(&event);

[msw, 2017/07/14 02:00:46]

Can you extract a helper function for the three similar blocks of code? It might
make sense to refactor a bit too, maybe like this?
void DispatchGestureEvent(ui::GestureEvent event, bool send_to_bubble) {
  SystemTray* tray = GetPrimarySystemTray();
  auto* target = to_bubble ? tray->GetSystemBubble()->bubble_view() : tray;
  ui::Event::DispatcherApi(&event).set_target(target);
  target->OnGestureEvent(&event);
}    

[minch1, 2017/07/14 19:45:17]

Done.

+    if (is_on_bubble_) {
+      dispatch_helper.set_target(system_tray->GetSystemBubble()->bubble_view());
+      system_tray->GetSystemBubble()->bubble_view()->OnGestureEvent(&event);
+    } else {
+      dispatch_helper.set_target(system_tray);
+      system_tray->OnGestureEvent(&event);
+    }
   }
 
   // Swiping on the system tray without releasing the finger.
   void SendScrollStartAndUpdate(gfx::Point& start,
                                 float delta,
                                 base::TimeTicks& timestamp) {
     SystemTray* system_tray = GetPrimarySystemTray();
-    ui::GestureEventDetails begin_details(ui::ET_GESTURE_SCROLL_BEGIN);
+    ui::GestureEventDetails begin_details(ui::ET_GESTURE_SCROLL_BEGIN, 0,
+                                          scroll_y_hint_);
     ui::GestureEvent begin_event = ui::GestureEvent(
         start.x(), start.y(), ui::EF_NONE, timestamp, begin_details);
-    system_tray->OnGestureEvent(&begin_event);
+
+    ui::Event::DispatcherApi begin_dispatch_helper(&begin_event);
+    if (is_on_bubble_) {
+      begin_dispatch_helper.set_target(
+          system_tray->GetSystemBubble()->bubble_view());
+      system_tray->GetSystemBubble()->bubble_view()->OnGestureEvent(
+          &begin_event);
+    } else {
+      begin_dispatch_helper.set_target(system_tray);
+      system_tray->OnGestureEvent(&begin_event);
+    }
 
     ui::GestureEventDetails update_details(ui::ET_GESTURE_SCROLL_UPDATE, 0,
                                            delta);
     timestamp += base::TimeDelta::FromMilliseconds(100);
     ui::GestureEvent update_event = ui::GestureEvent(
         start.x(), start.y() + delta, ui::EF_NONE, timestamp, update_details);
-    system_tray->OnGestureEvent(&update_event);
+
+    ui::Event::DispatcherApi update_dispatch_helper(&update_event);
+    if (is_on_bubble_) {
+      update_dispatch_helper.set_target(
+          system_tray->GetSystemBubble()->bubble_view());
+      system_tray->GetSystemBubble()->bubble_view()->OnGestureEvent(
+          &update_event);
+    } else {
+      update_dispatch_helper.set_target(system_tray);
+      system_tray->OnGestureEvent(&update_event);
+    }
   }
 
   // Open the default system tray bubble to get the height of the bubble and
   // then close it.
   float GetSystemBubbleHeight() {
     SystemTray* system_tray = GetPrimarySystemTray();
     system_tray->ShowDefaultView(BUBBLE_CREATE_NEW);
     gfx::Rect bounds = GetSystemBubbleBoundsInScreen();
     system_tray->CloseSystemBubble();
     return bounds.height();
   }
 
   gfx::Rect GetSystemBubbleBoundsInScreen() {
     return GetPrimarySystemTray()
         ->GetSystemBubble()
         ->bubble_view()
         ->GetWidget()
         ->GetWindowBoundsInScreen();
   }
 
+  void set_scroll_y_hint(float scroll_y_hint) {
+    scroll_y_hint_ = scroll_y_hint;
+  }
+
+  void set_is_on_bubble(bool is_on_bubble) { is_on_bubble_ = is_on_bubble; }
+
  private:
+  // Distance that caused the scroll to start, which can be used to indicate the
+  // scroll direction.
+  float scroll_y_hint_ = -1.f;

[msw, 2017/07/14 02:00:45]

I think these two members might be better off as arguments to SendGestureEvent,
with default values, so we don't always have to specify their values. I'm a bit
on the fence, but they seem more like gesture event parameters than test class
stateful members. WDYT?

[minch1, 2017/07/14 19:45:17]

Personally, I prefer to make them as the arguments of SendGestureEvent with
default values. Since, there are just like |start| or |is_fling| in
SendGestureEvent. Why I did it like this originally is because don't want to
change so many callers' argument. But if with default values, I think we don't
need to do that.

+
+  // True if the dragging is triggered on the system tray bubble, otherwise
+  // false.

[msw, 2017/07/14 02:00:45]

nit: s/false/the dragging is triggered on the tray button's background view/ (or
similar)

[minch1, 2017/07/14 19:45:17]

Done.

+  bool is_on_bubble_ = false;

[msw, 2017/07/14 02:00:45]

nit: maybe rename this to something like |target_bubble_| or |drag_on_bubble_|

[minch1, 2017/07/14 19:45:17]

Done.

+
   DISALLOW_COPY_AND_ASSIGN(SystemTrayTest);
 };
 
 // Swiping on the overlap area of shelf and system tray bubble during the
 // animation should close the bubble.
 TEST_F(SystemTrayTest, SwipingOnShelfDuringAnimation) {
   Shelf* shelf = GetPrimaryShelf();
   SystemTray* system_tray = GetPrimarySystemTray();
   gfx::Point start = system_tray->GetLocalBounds().CenterPoint();
   shelf->SetAlignment(SHELF_ALIGNMENT_BOTTOM);
@@ skipping 26 matching lines @@
 
   // Dragging the shelf during up animation should close the bubble.
   if (current_bounds.y() != original_bounds.y()) {
     generator.GestureScrollSequence(point_on_shelf_start, point_on_shelf_end,
                                     base::TimeDelta::FromMilliseconds(100), 5);
     EXPECT_FALSE(system_tray->HasSystemBubble());
   }
 
   // Fling down on the shelf with a velocity that exceeds |kFlingVelocity|.
   EXPECT_FALSE(system_tray->HasSystemBubble());
-  SendGestureEvent(start, delta, true, SystemTray::kFlingVelocity + 1);
+  SendGestureEvent(start, delta, true, TrayDragController::kFlingVelocity + 1);
   current_bounds = GetSystemBubbleBoundsInScreen();
   EXPECT_TRUE(system_tray->HasSystemBubble());
 
   // Dragging the shelf during down animation should close the bubble.
   if (current_bounds.y() != original_bounds.y()) {
     generator.GestureScrollSequence(point_on_shelf_start, point_on_shelf_end,
                                     base::TimeDelta::FromMilliseconds(100), 5);
     EXPECT_FALSE(system_tray->HasSystemBubble());
   }
 }
 
 // Swiping on the system tray ends with fling event.
 TEST_F(SystemTrayTest, FlingOnSystemTray) {
   Shelf* shelf = GetPrimaryShelf();
   SystemTray* system_tray = GetPrimarySystemTray();
-  gfx::Point start = system_tray->GetBoundsInScreen().CenterPoint();
+  gfx::Point start = system_tray->GetLocalBounds().CenterPoint();
   shelf->SetAlignment(SHELF_ALIGNMENT_BOTTOM);
   Shell::Get()->maximize_mode_controller()->EnableMaximizeModeWindowManager(
       true);
 
   // Fling up on the system tray should show the bubble if the |velocity_y| is
   // larger than |kFlingVelocity| and the dragging amount is larger than one
   // third of the height of the bubble.
   float delta = -GetSystemBubbleHeight();
-  SendGestureEvent(start, delta, true, -(SystemTray::kFlingVelocity + 1));
+  SendGestureEvent(start, delta, true,
+                   -(TrayDragController::kFlingVelocity + 1));
   EXPECT_TRUE(system_tray->HasSystemBubble());
   system_tray->CloseSystemBubble();
 
   // Fling up on the system tray should show the bubble if the |velocity_y| is
   // larger than |kFlingVelocity| even the dragging amount is less than one
   // third of the height of the bubble.
   delta /= 4;
-  SendGestureEvent(start, delta, true, -(SystemTray::kFlingVelocity + 1));
+  SendGestureEvent(start, delta, true,
+                   -(TrayDragController::kFlingVelocity + 1));
   EXPECT_TRUE(system_tray->HasSystemBubble());
   system_tray->CloseSystemBubble();
 
   // Fling up on the system tray should show the bubble if the |velocity_y| is
   // less than |kFlingVelocity| but the dragging amount if larger than one third
   // of the height of the bubble.
   delta = -GetSystemBubbleHeight();
-  SendGestureEvent(start, delta, true, -(SystemTray::kFlingVelocity - 1));
+  SendGestureEvent(start, delta, true,
+                   -(TrayDragController::kFlingVelocity - 1));
   EXPECT_TRUE(system_tray->HasSystemBubble());
   system_tray->CloseSystemBubble();
 
   // Fling up on the system tray should close the bubble if the |velocity_y|
   // is less than |kFlingVelocity| and the dragging amount is less than one
   // third of the height of the bubble.
   delta /= 4;
-  SendGestureEvent(start, delta, true, -(SystemTray::kFlingVelocity - 1));
+  SendGestureEvent(start, delta, true,
+                   -(TrayDragController::kFlingVelocity - 1));
   EXPECT_FALSE(system_tray->HasSystemBubble());
 
   // Fling down on the system tray should close the bubble if the |velocity_y|
   // is larger than kFLingVelocity.
-  SendGestureEvent(start, delta, true, SystemTray::kFlingVelocity + 1);
+  SendGestureEvent(start, delta, true, TrayDragController::kFlingVelocity + 1);
   EXPECT_FALSE(system_tray->HasSystemBubble());
 
   // Fling down on the system tray should close the bubble if the |velocity_y|
   // is larger than |kFlingVelocity| even the dragging amount is larger than one
   // third of the height of the bubble.
   delta = -GetSystemBubbleHeight();
-  SendGestureEvent(start, delta, true, SystemTray::kFlingVelocity + 1);
+  SendGestureEvent(start, delta, true, TrayDragController::kFlingVelocity + 1);
   EXPECT_FALSE(system_tray->HasSystemBubble());
 
   // Fling down on the system tray should open the bubble if the |velocity_y| is
   // less than |kFlingVelocity| but the dragging amount exceed one third of the
   // height of the bubble.
-  SendGestureEvent(start, delta, true, SystemTray::kFlingVelocity - 1);
+  SendGestureEvent(start, delta, true, TrayDragController::kFlingVelocity - 1);
   EXPECT_TRUE(system_tray->HasSystemBubble());
   system_tray->CloseSystemBubble();
 
   // Fling down on the system tray should close the bubble if the |velocity_y|
   // is less than |kFlingVelocity| and the dragging amount is less than one
   // third of the height of the bubble.
   delta /= 4;
-  SendGestureEvent(start, delta, true, SystemTray::kFlingVelocity - 1);
+  SendGestureEvent(start, delta, true, TrayDragController::kFlingVelocity - 1);
   EXPECT_FALSE(system_tray->HasSystemBubble());
 }
 
 // Touch outside the system tray bubble during swiping should close the bubble.
 TEST_F(SystemTrayTest, TapOutsideCloseBubble) {
   Shelf* shelf = GetPrimaryShelf();
   SystemTray* system_tray = GetPrimarySystemTray();
   gfx::Point start = system_tray->GetLocalBounds().CenterPoint();
   shelf->SetAlignment(SHELF_ALIGNMENT_BOTTOM);
 
@@ skipping 53 matching lines @@
   shelf->SetAlignment(SHELF_ALIGNMENT_LEFT);
   SendGestureEvent(start, delta, false, 0);
   EXPECT_FALSE(system_tray->HasSystemBubble());
 
   // Swiping up on system tray should not show the system tray bubble if the
   // shelf is right alignment.
   shelf->SetAlignment(SHELF_ALIGNMENT_RIGHT);
   SendGestureEvent(start, delta, false, 0);
   EXPECT_FALSE(system_tray->HasSystemBubble());
 
-  // Swiping down on the shelf should not show the system tray bubble.
+  // Beginning to scroll downward on the shelf should not show the system tray
+  // bubble.

[msw, 2017/07/14 02:00:46]

nit: "bubble, even if the drag then moves upwards."

[minch1, 2017/07/14 19:45:17]

Done.

   shelf->SetAlignment(SHELF_ALIGNMENT_BOTTOM);
-  delta = -delta;
+  set_scroll_y_hint(1.0);
   SendGestureEvent(start, delta, false, 0);
   EXPECT_FALSE(system_tray->HasSystemBubble());
 }
 
+// Swiping on opened system tray bubble.
+TEST_F(SystemTrayTest, SwipingOnSystemTrayBubble) {
+  Shelf* shelf = GetPrimaryShelf();
+  SystemTray* system_tray = GetPrimarySystemTray();
+  shelf->SetAlignment(SHELF_ALIGNMENT_BOTTOM);
+  set_is_on_bubble(true);
+
+  // Beginning to scroll downward and then swiping down more than one third of
+  // the bubble's height should close the bubble.

[msw, 2017/07/14 02:00:45]

Thanks for adding the comment about maximize mode below, but it would be good to
append something similar here, like "This only takes effect in maximize mode."

[minch1, 2017/07/14 19:45:17]

Done.

+  Shell::Get()->maximize_mode_controller()->EnableMaximizeModeWindowManager(
+      true);
+  system_tray->ShowDefaultView(BUBBLE_CREATE_NEW);
+  gfx::Rect bounds =
+      system_tray->GetSystemBubble()->bubble_view()->GetLocalBounds();
+  float delta = bounds.height() / 2;
+  gfx::Point start(bounds.x() + 5, bounds.y() + 5);
+  set_scroll_y_hint(1.0);
+  SendGestureEvent(start, delta, false, 0);
+  EXPECT_FALSE(system_tray->HasSystemBubble());
+
+  // Beginning to scroll upward and then swiping down more than one third of the
+  // bubble's height should also close the bubble.
+  system_tray->ShowDefaultView(BUBBLE_CREATE_NEW);
+  set_scroll_y_hint(-1.0);
+  SendGestureEvent(start, delta, false, 0);
+  EXPECT_FALSE(system_tray->HasSystemBubble());
+
+  // Swiping on the bubble has no effect if it is not in maximize mode.
+  Shell::Get()->maximize_mode_controller()->EnableMaximizeModeWindowManager(
+      false);
+  system_tray->ShowDefaultView(BUBBLE_CREATE_NEW);
+  set_scroll_y_hint(-1.0);
+  SendGestureEvent(start, delta, false, 0);
+  EXPECT_TRUE(system_tray->HasSystemBubble());
+}
+
 // Verifies only the visible default views are recorded in the
 // "Ash.SystemMenu.DefaultView.VisibleItems" histogram.
 TEST_F(SystemTrayTest, OnlyVisibleItemsRecorded) {
   SystemTray* tray = GetPrimarySystemTray();
   ASSERT_TRUE(tray->GetWidget());
 
   TestSystemTrayItem* test_item = new TestSystemTrayItem();
   tray->AddTrayItem(base::WrapUnique(test_item));
 
   base::HistogramTester histogram_tester;
@@ skipping 515 matching lines @@
 
   EXPECT_EQ(0, notification_tray->tray_bubble_height_for_test());
 }
 
 TEST_F(SystemTrayTest, SeparatorThickness) {
   EXPECT_EQ(kSeparatorWidth, views::Separator::kThickness);
 }
 
 }  // namespace test
 }  // namespace ash