Implement a site engagement score based on time-on-site.

chrome/browser/engagement/site_engagement_service_browsertest.cc

Index: chrome/browser/engagement/site_engagement_service_browsertest.cc
diff --git a/chrome/browser/engagement/site_engagement_service_browsertest.cc b/chrome/browser/engagement/site_engagement_service_browsertest.cc
new file mode 100644
index 0000000000000000000000000000000000000000..11afd77636c7cb4ca8363569a77b55e798bb382a
--- /dev/null
+++ b/chrome/browser/engagement/site_engagement_service_browsertest.cc
@@ -0,0 +1,204 @@
+// Copyright 2015 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/command_line.h"
+#include "base/run_loop.h"
+#include "base/single_thread_task_runner.h"
+#include "base/task_runner.h"
+#include "base/test/simple_test_clock.h"
+#include "base/thread_task_runner_handle.h"
+#include "base/values.h"
+#include "chrome/browser/engagement/site_engagement_helper.h"
+#include "chrome/browser/engagement/site_engagement_service.h"
+#include "chrome/browser/engagement/site_engagement_service_factory.h"
+#include "chrome/browser/ui/browser.h"
+#include "chrome/browser/ui/tabs/tab_strip_model.h"
+#include "chrome/common/chrome_switches.h"
+#include "chrome/test/base/browser_with_test_window_test.h"
+#include "chrome/test/base/in_process_browser_test.h"
+#include "chrome/test/base/ui_test_utils.h"
+#include "content/public/test/browser_test_utils.h"
+#include "content/public/test/test_navigation_observer.h"
+#include "net/test/embedded_test_server/embedded_test_server.h"
+#include "testing/gtest/include/gtest/gtest.h"
+#include "ui/events/keycodes/keyboard_codes.h"
+
+class SiteEngagementServiceBrowserTest : public InProcessBrowserTest {
+ public:
+  void SetUpOnMainThread() override {
+    base::CommandLine::ForCurrentProcess()->AppendSwitch(
+        switches::kDisableSiteEngagementService);

[calamity, 2015/09/22 02:57:21]

Why is this necessary? It probably needs a comment.

[dominickn, 2015/09/23 00:06:44]

Done.

+    SiteEngagementHelper::SetSecondsBetweenUserInputCheck(10);

[calamity, 2015/09/22 02:57:21]

This time change doesn't affect anything at the moment right?

[dominickn, 2015/09/23 00:06:44]

With the mock timer in for the test, not any more.

+    SiteEngagementHelper::DisableCallbackRegistrationForTesting();

[calamity, 2015/09/22 02:57:21]

// This prevents other browser tests from generating spurious events on our web
contents.

(Is that right?)

[dominickn, 2015/09/23 00:06:44]

It was primarily to address the case where I'm running the tests on my machine,
and any input over the test window gets detected. Running the tests with xvfb
solves this, but I'd like to keep the safety measure there because I can foresee
it being an issue..

[calamity, 2015/09/24 03:50:53]

Acknowledged.

+
+    ASSERT_TRUE(embedded_test_server()->InitializeAndWaitUntilReady());
+    InProcessBrowserTest::SetUpOnMainThread();
+  }
+
+  void NavigateToURL(content::WebContents* web_contents, GURL url) {
+    content::TestNavigationObserver observer(web_contents, 1);
+    ui_test_utils::NavigateToURL(browser(), url);
+    observer.Wait();
+  }
+
+  SiteEngagementHelper* CreateHelper(content::WebContents* web_contents) {
+    SiteEngagementHelper::CreateForWebContents(web_contents);
+    SiteEngagementHelper* helper =
+      SiteEngagementHelper::FromWebContents(web_contents);
+    DCHECK(helper);
+    return helper;
+  }
+
+  void HandleKeyPress(SiteEngagementHelper* helper, ui::KeyboardCode key) {
+    content::NativeWebKeyboardEvent event;
+    event.windowsKeyCode = key;
+    event.type = blink::WebKeyboardEvent::RawKeyDown;
+    helper->tracker_->HandleKeyPressEvent(event);
+  }
+
+  void HandleMouseEvent(SiteEngagementHelper* helper,
+                        blink::WebMouseEvent::Button button,
+                        blink::WebInputEvent::Type type) {
+    blink::WebMouseEvent event;
+    event.button = button;
+    event.type = type;
+    helper->tracker_->HandleMouseEvent(event);
+  }
+};
+
+IN_PROC_BROWSER_TEST_F(SiteEngagementServiceBrowserTest,
+                       KeyPressEngagementAccumulation) {
+  GURL url("https://www.google.com/");
+  GURL url2("http://www.google.com/");
+  content::WebContents* web_contents =
+    browser()->tab_strip_model()->GetActiveWebContents();
+
+  SiteEngagementHelper* helper = CreateHelper(web_contents);
+  SiteEngagementService* service =
+    SiteEngagementServiceFactory::GetForProfile(browser()->profile());
+  DCHECK(service);
+
+  NavigateToURL(web_contents, url);
+  EXPECT_DOUBLE_EQ(0.5, service->GetScore(url));
+  EXPECT_EQ(0, service->GetScore(url2));
+
+  HandleKeyPress(helper, ui::VKEY_DOWN);
+
+  EXPECT_DOUBLE_EQ(0.55, service->GetScore(url));
+  EXPECT_EQ(0, service->GetScore(url2));
+
+  HandleKeyPress(helper, ui::VKEY_UP);
+  HandleKeyPress(helper, ui::VKEY_RETURN);
+  HandleKeyPress(helper, ui::VKEY_J);

[calamity, 2015/09/22 02:57:21]

There needs to be some test for the timer accumulation. You can pass a MockTimer
to the InputTracker to manually Fire the timer to trigger the score write.

It would also be good to write a test for when the timer is supposed to be
running (e.g show, hide, idling, after navigate, and various sequences of these)

[dominickn, 2015/09/23 00:06:44]

Done.

+
+  EXPECT_DOUBLE_EQ(0.7, service->GetScore(url));
+  EXPECT_EQ(0, service->GetScore(url2));
+
+  NavigateToURL(web_contents, url2);
+
+  EXPECT_DOUBLE_EQ(0.7, service->GetScore(url));
+  EXPECT_DOUBLE_EQ(0.5, service->GetScore(url2));
+  EXPECT_DOUBLE_EQ(1.2, service->GetTotalEngagementPoints());
+
+  HandleKeyPress(helper, ui::VKEY_K);
+  EXPECT_DOUBLE_EQ(0.7, service->GetScore(url));
+  EXPECT_DOUBLE_EQ(0.55, service->GetScore(url2));
+  EXPECT_DOUBLE_EQ(1.25, service->GetTotalEngagementPoints());
+}
+
+IN_PROC_BROWSER_TEST_F(SiteEngagementServiceBrowserTest,
+                       MouseEventEngagementAccumulation) {
+  GURL url("https://www.google.com/");
+  GURL url2("http://www.google.com/");
+  content::WebContents* web_contents =
+    browser()->tab_strip_model()->GetActiveWebContents();
+
+  SiteEngagementHelper* helper = CreateHelper(web_contents);
+  SiteEngagementService* service =
+    SiteEngagementServiceFactory::GetForProfile(browser()->profile());
+  DCHECK(service);
+
+  NavigateToURL(web_contents, url);
+  EXPECT_DOUBLE_EQ(0.5, service->GetScore(url));
+  EXPECT_EQ(0, service->GetScore(url2));
+
+  HandleMouseEvent(helper, blink::WebMouseEvent::ButtonLeft,
+                   blink::WebInputEvent::MouseDown);
+
+  EXPECT_DOUBLE_EQ(0.55, service->GetScore(url));
+  EXPECT_EQ(0, service->GetScore(url2));
+
+  HandleMouseEvent(helper, blink::WebMouseEvent::ButtonRight,
+                   blink::WebInputEvent::ContextMenu);
+  HandleMouseEvent(helper, blink::WebMouseEvent::ButtonMiddle,
+                   blink::WebInputEvent::MouseDown);
+  HandleMouseEvent(helper, blink::WebMouseEvent::ButtonNone,
+                   blink::WebInputEvent::MouseMove);
+
+  EXPECT_DOUBLE_EQ(0.7, service->GetScore(url));
+  EXPECT_EQ(0, service->GetScore(url2));
+
+  NavigateToURL(web_contents, url2);
+
+  EXPECT_DOUBLE_EQ(0.7, service->GetScore(url));
+  EXPECT_DOUBLE_EQ(0.5, service->GetScore(url2));
+  EXPECT_DOUBLE_EQ(1.2, service->GetTotalEngagementPoints());
+
+  HandleMouseEvent(helper, blink::WebMouseEvent::ButtonNone,
+                   blink::WebInputEvent::GestureScrollUpdate);
+  EXPECT_DOUBLE_EQ(0.7, service->GetScore(url));
+  EXPECT_DOUBLE_EQ(0.55, service->GetScore(url2));
+  EXPECT_DOUBLE_EQ(1.25, service->GetTotalEngagementPoints());
+}
+
+IN_PROC_BROWSER_TEST_F(SiteEngagementServiceBrowserTest,
+                       MixedInputEngagementAccumulation) {
+  GURL url("https://www.google.com/");
+  GURL url2("http://www.google.com/");
+  content::WebContents* web_contents =
+    browser()->tab_strip_model()->GetActiveWebContents();
+
+  SiteEngagementHelper* helper = CreateHelper(web_contents);
+  SiteEngagementService* service =
+    SiteEngagementServiceFactory::GetForProfile(browser()->profile());
+  DCHECK(service);
+
+  NavigateToURL(web_contents, url);
+  EXPECT_DOUBLE_EQ(0.5, service->GetScore(url));
+  EXPECT_EQ(0, service->GetScore(url2));
+
+  HandleKeyPress(helper, ui::VKEY_UP);
+  HandleKeyPress(helper, ui::VKEY_RETURN);
+  HandleKeyPress(helper, ui::VKEY_J);
+
+  HandleMouseEvent(helper, blink::WebMouseEvent::ButtonLeft,
+                   blink::WebInputEvent::MouseDown);
+
+  EXPECT_DOUBLE_EQ(0.7, service->GetScore(url));
+  EXPECT_EQ(0, service->GetScore(url2));
+
+  HandleMouseEvent(helper, blink::WebMouseEvent::ButtonRight,
+                   blink::WebInputEvent::ContextMenu);
+  HandleMouseEvent(helper, blink::WebMouseEvent::ButtonMiddle,
+                   blink::WebInputEvent::MouseDown);
+  HandleMouseEvent(helper, blink::WebMouseEvent::ButtonNone,
+                   blink::WebInputEvent::MouseMove);
+
+  EXPECT_DOUBLE_EQ(0.85, service->GetScore(url));
+  EXPECT_EQ(0, service->GetScore(url2));
+
+  NavigateToURL(web_contents, url2);
+
+  EXPECT_DOUBLE_EQ(0.85, service->GetScore(url));
+  EXPECT_DOUBLE_EQ(0.5, service->GetScore(url2));
+  EXPECT_DOUBLE_EQ(1.35, service->GetTotalEngagementPoints());
+
+  HandleMouseEvent(helper, blink::WebMouseEvent::ButtonNone,
+                   blink::WebInputEvent::GestureScrollUpdate);
+  HandleKeyPress(helper, ui::VKEY_DOWN);
+
+  EXPECT_DOUBLE_EQ(0.85, service->GetScore(url));
+  EXPECT_DOUBLE_EQ(0.6, service->GetScore(url2));
+  EXPECT_DOUBLE_EQ(1.45, service->GetTotalEngagementPoints());
+}