From b7284db83529d01a1754e3b3009ff108b4d1d52c Mon Sep 17 00:00:00 2001
From: Dave Tapuska <dtapuska@chromium.org>
Date: Thu, 5 Jul 2018 10:59:46 -0700
Subject: [PATCH] Add an API to query whether the window has seen a user
 gesture.

Add a variable on the navigator object to query whether the frame has
seen a user activation ever.

The postMessage part of the proposal will be done in a separate patch,
this change is limited to just adding the object definition and
exposing it on navigator.

https://github.com/dtapuska/useractivation
https://github.com/whatwg/html/issues/1983

BUG=846858

Change-Id: I6ca4c80f4096bfae9ca13b175b46df6b4486a6dd
---
 .../activation-api-click.tentative.html       | 34 +++++++++++
 ...ation-api-iframe-no-activate.tenative.html | 58 +++++++++++++++++++
 .../activation-api-iframe.tenative.html       | 52 +++++++++++++++++
 .../activation-api-setTimeout.tentative.html  | 36 ++++++++++++
 html/user-activation/resources/child-one.html | 20 +++++++
 html/user-activation/resources/child-two.html |  7 +++
 6 files changed, 207 insertions(+)
 create mode 100644 html/user-activation/activation-api-click.tentative.html
 create mode 100644 html/user-activation/activation-api-iframe-no-activate.tenative.html
 create mode 100644 html/user-activation/activation-api-iframe.tenative.html
 create mode 100644 html/user-activation/activation-api-setTimeout.tentative.html
 create mode 100644 html/user-activation/resources/child-one.html
 create mode 100644 html/user-activation/resources/child-two.html
diff --git a/html/user-activation/activation-api-click.tentative.html b/html/user-activation/activation-api-click.tentative.html
new file mode 100644
index 000000000000000..7f170a04ab1c207
--- /dev/null
+++ b/html/user-activation/activation-api-click.tentative.html
@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<!--
+   Tentative due to:
+    https://github.com/whatwg/html/issues/1983
+-->
+<html>
+<head>
+<script src="/resources/testharness.js"></script>
+<script src="/resources/testharnessreport.js"></script>
+<script src="/resources/testdriver.js"></script>
+<script src="/resources/testdriver-vendor.js"></script>
+</head>
+<body>
+  <h1>Clicking on document sets user activation</h1>
+  <p>Click anywhere in the document.</p>
+  <script>
+    async_test(function(t) {
+      assert_false(navigator.userActivation.hasBeenActive);
+      assert_false(navigator.userActivation.isActive);
+      window.addEventListener("click", t.step_func_done(event => {
+        assert_true(navigator.userActivation.hasBeenActive);
+        assert_true(navigator.userActivation.isActive);
+
+        // Opening a window should consume the activation.
+        var win = window.open('404.html');
+        win.close();
+        assert_true(navigator.userActivation.hasBeenActive);
+        assert_false(navigator.userActivation.isActive);
+      }));
+      test_driver.click(document.body);
+    }, "Values adjust on activity");
+  </script>
+</body>
+</html>
diff --git a/html/user-activation/activation-api-iframe-no-activate.tenative.html b/html/user-activation/activation-api-iframe-no-activate.tenative.html
new file mode 100644
index 000000000000000..8c7610e28b0be7c
--- /dev/null
+++ b/html/user-activation/activation-api-iframe-no-activate.tenative.html
@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+<!--
+   Tentative due to:
+    https://github.com/whatwg/html/issues/3739
+
+-->
+<html>
+<head>
+<script src="/resources/testharness.js"></script>
+<script src="/resources/testharnessreport.js"></script>
+<script src="/resources/testdriver.js"></script>
+<script src="/resources/testdriver-vendor.js"></script>
+</head>
+<body>
+  <h1>Clicking in parent frame does not propagate state to child</h1>
+  <ol id="instructions">
+    <li>Click this instruction text.
+  </ol>
+  <iframe id="child" width="200" height="200"></iframe>
+  <script>
+    async_test(function(t) {
+      var child = document.getElementById("child");
+      assert_false(navigator.userActivation.isActive);
+      assert_false(navigator.userActivation.hasBeenActive);
+      window.addEventListener("message", t.step_func(event => {
+        var msg = JSON.parse(event.data);
+        if (msg.type == 'child-one-loaded') {
+          // state should be false after load
+          assert_false(msg.isActive);
+          assert_false(msg.hasBeenActive);
+
+          // click in parent document
+          test_driver.click(document.getElementById('instructions'));
+        } else if (msg.type == 'child-one-report') {
+          // state should be false after asked to report
+          assert_false(msg.isActive);
+          assert_false(msg.hasBeenActive);
+          t.done();
+        }
+      }));
+      window.addEventListener("click", t.step_func(event => {
+          assert_true(navigator.userActivation.isActive);
+          assert_true(navigator.userActivation.hasBeenActive);
+
+          // Opening a window should consume the activation.
+          var win = window.open('404.html');
+          win.close();
+          assert_false(navigator.userActivation.isActive);
+          assert_true(navigator.userActivation.hasBeenActive);
+
+          // ask child to report their state
+          child.contentWindow.postMessage('report', '*');
+      }));
+      child.src = "resources/child-one.html";
+    }, "Values adjust on activity");
+  </script>
+</body>
+</html>
diff --git a/html/user-activation/activation-api-iframe.tenative.html b/html/user-activation/activation-api-iframe.tenative.html
new file mode 100644
index 000000000000000..2202048ae9166d0
--- /dev/null
+++ b/html/user-activation/activation-api-iframe.tenative.html
@@ -0,0 +1,52 @@
+<!DOCTYPE html>
+<!--
+   Tentative due to:
+    https://github.com/whatwg/html/issues/3739
+
+-->
+<html>
+<head>
+<script src="/resources/testharness.js"></script>
+<script src="/resources/testharnessreport.js"></script>
+<script src="/resources/testdriver.js"></script>
+<script src="/resources/testdriver-vendor.js"></script>
+</head>
+<body>
+  <h1>Clicking in iframe has activation state in child</h1>
+  <ol id="instructions">
+    <li>Click inside the red area.
+  </ol>
+  <iframe id="child" width="200" height="200"></iframe>
+  <script>
+    async_test(function(t) {
+      var child = document.getElementById("child");
+      assert_false(navigator.userActivation.isActive);
+      assert_false(navigator.userActivation.hasBeenActive);
+      window.addEventListener("message", t.step_func(event => {
+        var msg = JSON.parse(event.data);
+        if (msg.type == 'child-one-loaded') {
+          // values have false after load
+          assert_false(msg.isActive);
+          assert_false(msg.hasBeenActive);
+          test_driver.click(child);
+        } else if (msg.type == 'child-one-clicked') {
+          // values have activation state on click
+          assert_true(navigator.userActivation.isActive);
+          assert_true(navigator.userActivation.hasBeenActive);
+          assert_true(msg.isActive);
+          assert_true(msg.hasBeenActive);
+          child.src = "resources/child-two.html";
+        } else if (msg.type == 'child-two-loaded') {
+          // values are reset after navigation
+          assert_true(navigator.userActivation.isActive);
+          assert_true(navigator.userActivation.hasBeenActive);
+          assert_false(msg.isActive);
+          assert_false(msg.hasBeenActive);
+          t.done();
+        }
+      }));
+      child.src = "resources/child-one.html";
+    }, "Values adjust on activity");
+  </script>
+</body>
+</html>
diff --git a/html/user-activation/activation-api-setTimeout.tentative.html b/html/user-activation/activation-api-setTimeout.tentative.html
new file mode 100644
index 000000000000000..a8eba38c60eeef7
--- /dev/null
+++ b/html/user-activation/activation-api-setTimeout.tentative.html
@@ -0,0 +1,36 @@
+<!DOCTYPE html>
+<!--
+   Tentative due to:
+    https://github.com/whatwg/html/issues/1983
+-->
+<html>
+<head>
+<script src="/resources/testharness.js"></script>
+<script src="/resources/testharnessreport.js"></script>
+<script src="/resources/testdriver.js"></script>
+<script src="/resources/testdriver-vendor.js"></script>
+</head>
+<body>
+  <h1>Clicking on document sets user activation even after setTimeout</h1>
+  <p>Click anywhere in the document.</p>
+  <script>
+    async_test(function(t) {
+      assert_false(navigator.userActivation.hasBeenActive);
+      assert_false(navigator.userActivation.isActive);
+      window.addEventListener("click", event => {
+        t.step_timeout(() => {
+          assert_true(navigator.userActivation.hasBeenActive);
+          assert_true(navigator.userActivation.isActive);
+
+          // Opening a window should consume the activation.
+          window.open('404.html');
+          assert_true(navigator.userActivation.hasBeenActive);
+          assert_false(navigator.userActivation.isActive);
+          t.done();
+        }, 0);
+      });
+      test_driver.click(document.body);
+    }, "Values adjust on activity");
+  </script>
+</body>
+</html>
diff --git a/html/user-activation/resources/child-one.html b/html/user-activation/resources/child-one.html
new file mode 100644
index 000000000000000..9c99729b6a98022
--- /dev/null
+++ b/html/user-activation/resources/child-one.html
@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<body style="background: red;">
+  <script>
+  window.parent.postMessage(JSON.stringify({"type": "child-one-loaded", "isActive": navigator.userActivation.isActive,
+                                            "hasBeenActive": navigator.userActivation.hasBeenActive}), "*");
+
+  window.addEventListener("click", event => {
+      window.parent.postMessage(JSON.stringify({"type": "child-one-clicked", "isActive": navigator.userActivation.isActive,
+                                                "hasBeenActive": navigator.userActivation.hasBeenActive}), "*");
+  });
+
+  window.addEventListener("message", event => {
+      if (event.data == "report") {
+        window.parent.postMessage(JSON.stringify({"type": "child-one-report", "isActive": navigator.userActivation.isActive,
+                                                  "hasBeenActive": navigator.userActivation.hasBeenActive}), "*");
+      }
+  });
+
+</script>
+</body>
diff --git a/html/user-activation/resources/child-two.html b/html/user-activation/resources/child-two.html
new file mode 100644
index 000000000000000..7d48789878a902e
--- /dev/null
+++ b/html/user-activation/resources/child-two.html
@@ -0,0 +1,7 @@
+<!DOCTYPE html>
+<body style="background: red;">
+<script>
+  window.parent.postMessage(JSON.stringify({"type": "child-two-loaded", "isActive": navigator.userActivation.isActive,
+                                            "hasBeenActive": navigator.userActivation.hasBeenActive}), "*");
+</script>
+</body>
