Allow scroll events to open custom launcher pages.

chrome/browser/apps/custom_launcher_page_browsertest_views.cc

 // Copyright 2014 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 <string>
 
 #include "ash/shell.h"
 #include "base/command_line.h"
 #include "base/strings/utf_string_conversions.h"
 #include "chrome/browser/apps/app_browsertest_util.h"
 #include "chrome/browser/ui/app_list/app_list_service.h"
 #include "chrome/browser/ui/app_list/app_list_service_views.h"
 #include "chrome/browser/ui/app_list/app_list_shower_views.h"
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/web_contents.h"
 #include "extensions/common/extension.h"
 #include "extensions/common/switches.h"
 #include "extensions/test/extension_test_message_listener.h"
 #include "ui/app_list/app_list_switches.h"
 #include "ui/app_list/views/app_list_main_view.h"
 #include "ui/app_list/views/app_list_view.h"
 #include "ui/app_list/views/contents_view.h"
+#include "ui/events/test/event_generator.h"
 #include "ui/views/controls/webview/webview.h"
 
 namespace {
 
 // The path of the test application within the "platform_apps" directory.
 const char kCustomLauncherPagePath[] = "custom_launcher_page";
 
 // The app ID of the test application.
 const char kCustomLauncherPageID[] = "lmadimbbgapmngbiclpjjngmdickadpl";
 
@@ skipping 42 matching lines @@
     AppListServiceViews* service = static_cast<AppListServiceViews*>(
         AppListService::Get(chrome::HOST_DESKTOP_TYPE_NATIVE));
     // The app list should have loaded instantly since the profile is already
     // loaded.
     EXPECT_TRUE(service->IsAppListVisible());
     app_list_view = service->shower().app_list();
 #endif
     return app_list_view;
   }
 
+  // Set the active page on the app list, according to |state|. Does not wait
+  // for any animation or custom page to complete.
+  void SetActivePageAndVerify(app_list::AppListModel::State state) {
+    app_list::ContentsView* contents_view =
+        GetAppListView()->app_list_main_view()->contents_view();
+    contents_view->SetActivePage(contents_view->GetPageIndexForState(state));
+    EXPECT_TRUE(contents_view->IsStateActive(state));
+  }
+
+  void SetCustomLauncherPageEnabled(bool enabled) {
+    const base::string16 kLauncherPageDisableScript =
+        base::ASCIIToUTF16("disableCustomLauncherPage();");
+    const base::string16 kLauncherPageEnableScript =
+        base::ASCIIToUTF16("enableCustomLauncherPage();");
+
+    app_list::ContentsView* contents_view =
+        GetAppListView()->app_list_main_view()->contents_view();
+    views::WebView* custom_page_view =
+        static_cast<views::WebView*>(contents_view->custom_page_view());
+    content::RenderFrameHost* custom_page_frame =
+        custom_page_view->GetWebContents()->GetMainFrame();
+
+    const char* test_message =
+        enabled ? "launcherPageEnabled" : "launcherPageDisabled";
+
+    ExtensionTestMessageListener listener(test_message, false);
+    custom_page_frame->ExecuteJavaScript(enabled ? kLauncherPageEnableScript
+                                                 : kLauncherPageDisableScript);
+    listener.WaitUntilSatisfied();
+  }
+
  private:
   DISALLOW_COPY_AND_ASSIGN(CustomLauncherPageBrowserTest);
 };
 
 IN_PROC_BROWSER_TEST_F(CustomLauncherPageBrowserTest,
                        OpenLauncherAndSwitchToCustomPage) {
   LoadAndLaunchPlatformApp(kCustomLauncherPagePath, "Launched");
   app_list::AppListView* app_list_view = GetAppListView();
   app_list::ContentsView* contents_view =
       app_list_view->app_list_main_view()->contents_view();
@@ skipping 10 matching lines @@
   }
   {
     ExtensionTestMessageListener listener("onPageProgressAt0", false);
     contents_view->SetActivePage(contents_view->GetPageIndexForState(
         app_list::AppListModel::STATE_START));
 
     listener.WaitUntilSatisfied();
   }
 }
 
+// Test that the app list will switch to the custom launcher page by sending a
+// click inside the clickzone, or a mouse scroll event.
+IN_PROC_BROWSER_TEST_F(CustomLauncherPageBrowserTest,
+                       EventsActivateSwitchToCustomPage) {
+  LoadAndLaunchPlatformApp(kCustomLauncherPagePath, "Launched");
+  // Use an event generator to ensure targeting is correct.
+  app_list::AppListView* app_list_view = GetAppListView();
+  app_list::ContentsView* contents_view =
+      app_list_view->app_list_main_view()->contents_view();
+  gfx::NativeWindow window = app_list_view->GetWidget()->GetNativeWindow();
+  ui::test::EventGenerator event_generator(window->GetRootWindow(), window);
+  EXPECT_TRUE(
+      contents_view->IsStateActive(app_list::AppListModel::STATE_START));
+
+  // Find the clickzone.
+  gfx::Rect bounds = contents_view->GetCustomPageCollapsedBounds();
+  bounds.Intersect(contents_view->bounds());
+  gfx::Point point_in_clickzone = bounds.CenterPoint();

[calamity, 2015/02/17 00:54:09]

This returns coordinates in the contents view's coordinates. Aren't the events
generated relative to the widget? (I'm worried about the app list border
throwing off your coordinates by 12px or whatever it is)

[tapted, 2015/02/17 03:06:00]

Yep! Fixed. Darn border.

It's 31 pixels (border_image width of 54 minus internal margin of 23). collapsed
height = kCustomPageCollapsedHeight = 78 and since that's > 31*2 it wasn't
affecting things in the test. I've added in the extra conversions.

+
+  // First try clicking 10px above the clickzone.
+  gfx::Point point_above_clickzone = point_in_clickzone;
+  point_above_clickzone.set_y(bounds.y() - 10);
+
+  event_generator.MoveMouseRelativeTo(window, point_above_clickzone);
+  event_generator.ClickLeftButton();
+
+  // Should stay on the start page.
+  EXPECT_TRUE(
+      contents_view->IsStateActive(app_list::AppListModel::STATE_START));
+
+  // Now click in the clickzone.
+  event_generator.MoveMouseRelativeTo(window, point_in_clickzone);
+  // First, try disabling the custom page view. Click should do nothing.
+  SetCustomLauncherPageEnabled(false);
+  event_generator.ClickLeftButton();
+  EXPECT_TRUE(
+      contents_view->IsStateActive(app_list::AppListModel::STATE_START));
+  // Click again with it enabled. The active state should update immediately.
+  SetCustomLauncherPageEnabled(true);
+  event_generator.ClickLeftButton();
+  EXPECT_TRUE(contents_view->IsStateActive(
+      app_list::AppListModel::STATE_CUSTOM_LAUNCHER_PAGE));
+
+  // Back to the start page. And send a mouse wheel event.
+  SetActivePageAndVerify(app_list::AppListModel::STATE_START);
+  // Generate wheel events above the clickzone.
+  event_generator.MoveMouseRelativeTo(window, point_above_clickzone);
+  // Scrolling left, right or up should do nothing.
+  event_generator.MoveMouseWheel(-5, 0);
+  event_generator.MoveMouseWheel(5, 0);
+  event_generator.MoveMouseWheel(0, -5);
+  EXPECT_TRUE(
+      contents_view->IsStateActive(app_list::AppListModel::STATE_START));
+  // Scroll down to open launcher page.
+  event_generator.MoveMouseWheel(0, 5);
+  EXPECT_TRUE(contents_view->IsStateActive(
+      app_list::AppListModel::STATE_CUSTOM_LAUNCHER_PAGE));
+
+  // Constants for gesture/trackpad events.
+  const base::TimeDelta step_delay = base::TimeDelta::FromMilliseconds(300);
+  const int num_steps = 5;
+  const int num_fingers = 2;

[calamity, 2015/02/17 00:54:09]

kStepDelay etc?

[tapted, 2015/02/17 03:06:01]

Yeah I was doing that for ages, and it blew my mind when sky picked me up on it
:p. Style guide [1] says kFooStyle "for constants defined globally or within a
class." and "may optionally be used for compile-time constants of local scope".
So doing kStepDelay would be disobeying the style guide since it's local scope
and not compile-time. Then steps/fingers would be optional, but I went
hacker_style for consistency.

[1] go/cppguide?cl=head#Constant_Names

[calamity, 2015/02/17 05:19:29]

Everything I know is a lie.

+
+  // Gesture events need to be in screen coordinates.
+  views::View::ConvertPointToScreen(contents_view, &point_above_clickzone);
+  views::View::ConvertPointToScreen(contents_view, &point_in_clickzone);
+
+  // Back to the start page. And send a scroll gesture.
+  SetActivePageAndVerify(app_list::AppListModel::STATE_START);
+  // Going down should do nothing.
+  event_generator.GestureScrollSequence(
+      point_above_clickzone, point_in_clickzone, step_delay, num_steps);
+  EXPECT_TRUE(
+      contents_view->IsStateActive(app_list::AppListModel::STATE_START));
+  // Now go up - should change state.
+  event_generator.GestureScrollSequence(
+      point_in_clickzone, point_above_clickzone, step_delay, num_steps);
+  EXPECT_TRUE(contents_view->IsStateActive(
+      app_list::AppListModel::STATE_CUSTOM_LAUNCHER_PAGE));
+
+  // Back to the start page. And send a trackpad scroll event.
+  SetActivePageAndVerify(app_list::AppListModel::STATE_START);
+  // Going down left, right or up should do nothing.
+  event_generator.ScrollSequence(point_in_clickzone, step_delay, -5, 0,
+                                 num_steps, num_fingers);
+  event_generator.ScrollSequence(point_in_clickzone, step_delay, 5, 0,
+                                 num_steps, num_fingers);
+  event_generator.ScrollSequence(point_in_clickzone, step_delay, 0, -5,
+                                 num_steps, num_fingers);
+  EXPECT_TRUE(
+      contents_view->IsStateActive(app_list::AppListModel::STATE_START));
+  // Scroll up to open launcher page.
+  event_generator.ScrollSequence(point_in_clickzone, step_delay, 0, 5,
+                                 num_steps, num_fingers);
+  EXPECT_TRUE(contents_view->IsStateActive(
+      app_list::AppListModel::STATE_CUSTOM_LAUNCHER_PAGE));
+
+  // Back to the start page. And send a tap gesture.
+  SetActivePageAndVerify(app_list::AppListModel::STATE_START);
+  // Tapping outside the clickzone should do nothing.
+  event_generator.GestureTapAt(point_above_clickzone);
+  EXPECT_TRUE(
+      contents_view->IsStateActive(app_list::AppListModel::STATE_START));
+  // Now tap in the clickzone.
+  event_generator.GestureTapAt(point_in_clickzone);
+  EXPECT_TRUE(contents_view->IsStateActive(
+      app_list::AppListModel::STATE_CUSTOM_LAUNCHER_PAGE));
+}
+
 IN_PROC_BROWSER_TEST_F(CustomLauncherPageBrowserTest, LauncherPageSubpages) {
   LoadAndLaunchPlatformApp(kCustomLauncherPagePath, "Launched");
 
   app_list::AppListView* app_list_view = GetAppListView();
   app_list::AppListModel* model = app_list_view->app_list_main_view()->model();
   app_list::ContentsView* contents_view =
       app_list_view->app_list_main_view()->contents_view();
 
   ASSERT_TRUE(
       contents_view->IsStateActive(app_list::AppListModel::STATE_START));
@@ skipping 79 matching lines @@
 
     // The app list view will have changed on ChromeOS.
     app_list_view = GetAppListView();
     contents_view = app_list_view->app_list_main_view()->contents_view();
     EXPECT_TRUE(contents_view->IsStateActive(
         app_list::AppListModel::STATE_CUSTOM_LAUNCHER_PAGE));
   }
 }
 
 IN_PROC_BROWSER_TEST_F(CustomLauncherPageBrowserTest, LauncherPageSetEnabled) {
-  const base::string16 kLauncherPageDisableScript =
-      base::ASCIIToUTF16("disableCustomLauncherPage();");
-  const base::string16 kLauncherPageEnableScript =
-      base::ASCIIToUTF16("enableCustomLauncherPage();");
-
   LoadAndLaunchPlatformApp(kCustomLauncherPagePath, "Launched");
   app_list::AppListView* app_list_view = GetAppListView();
   app_list::AppListModel* model = app_list_view->app_list_main_view()->model();
   app_list::ContentsView* contents_view =
       app_list_view->app_list_main_view()->contents_view();
 
   views::WebView* custom_page_view =
       static_cast<views::WebView*>(contents_view->custom_page_view());
-
-  content::RenderFrameHost* custom_page_frame =
-      custom_page_view->GetWebContents()->GetMainFrame();
-  views::Widget* custom_page_click_zone =
-      app_list_view->app_list_main_view()->GetCustomPageClickzone();
-
   ASSERT_TRUE(
       contents_view->IsStateActive(app_list::AppListModel::STATE_START));
 
-  EXPECT_TRUE(custom_page_click_zone->GetLayer()->visible());
   EXPECT_TRUE(model->custom_launcher_page_enabled());
   EXPECT_TRUE(custom_page_view->visible());
-  {
-    ExtensionTestMessageListener listener("launcherPageDisabled", false);
-    custom_page_frame->ExecuteJavaScript(kLauncherPageDisableScript);
 
-    listener.WaitUntilSatisfied();
-    EXPECT_FALSE(custom_page_click_zone->GetLayer()->visible());
-    EXPECT_FALSE(model->custom_launcher_page_enabled());
-    EXPECT_FALSE(custom_page_view->visible());
-  }
+  SetCustomLauncherPageEnabled(false);
+  EXPECT_FALSE(model->custom_launcher_page_enabled());
+  EXPECT_FALSE(custom_page_view->visible());
 
-  {
-    ExtensionTestMessageListener listener("launcherPageEnabled", false);
-    custom_page_frame->ExecuteJavaScript(kLauncherPageEnableScript);
-
-    listener.WaitUntilSatisfied();
-    EXPECT_TRUE(custom_page_click_zone->GetLayer()->visible());
-    EXPECT_TRUE(model->custom_launcher_page_enabled());
-    EXPECT_TRUE(custom_page_view->visible());
-  }
+  SetCustomLauncherPageEnabled(true);
+  EXPECT_TRUE(model->custom_launcher_page_enabled());
+  EXPECT_TRUE(custom_page_view->visible());
 }