summaryrefslogtreecommitdiffstats
path: root/dom/base/test/useractivation/test_useractivation_transient_consuming.html
blob: 4178d24477089edd30badc5bf4fc5fafc2f4023b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<!DOCTYPE HTML>
<html>
<head>
  <title>User activation test: consume transient flag</title>
  <script src="/tests/SimpleTest/SimpleTest.js"></script>
  <script src="/tests/SimpleTest/EventUtils.js"></script>
  <link rel="stylesheet" type="text/css" href="/tests/SimpleTest/test.css" />
</head>
<body>
<iframe></iframe>
<iframe></iframe>
<script>

SimpleTest.requestFlakyTimeout("Timeouts are needed to test transient user_activation");

let timeout = SpecialPowers.getIntPref("dom.user_activation.transient.timeout") + 1000;

function waitForEvent(aTarget, aEvent, aCallback) {
  return new Promise((aResolve) => {
    aTarget.addEventListener(aEvent, function listener(event) {
      aCallback(event);
      aResolve();
    }, { once: true });
  });
}

function doCheck(aDocument, aName, aHasBeenUserGestureActivated,
                 aHasValidTransientUserGestureActivation,
                 aLastUserGestureTimeStamp) {
  is(SpecialPowers.wrap(aDocument).hasBeenUserGestureActivated,
     aHasBeenUserGestureActivated,
     `check has-been-user-activated on the ${aName}`);
  is(SpecialPowers.wrap(aDocument).hasValidTransientUserGestureActivation,
     aHasValidTransientUserGestureActivation,
     `check has-valid-transient-user-activation on the ${aName}`);
  is(SpecialPowers.wrap(aDocument).lastUserGestureTimeStamp,
     aLastUserGestureTimeStamp,
     `check last-user-gesture-timestamp on the ${aName}`);
}

add_task(async function checkInitialStatus() {
  doCheck(document, "top-level document", false, false, 0);
  ok(!SpecialPowers.wrap(document).consumeTransientUserGestureActivation(),
     "consume transient-user-activation on top-level document");

  doCheck(frames[0].document, "first iframe", false, false, 0);
  ok(!SpecialPowers.wrap(frames[0].document).consumeTransientUserGestureActivation(),
     "consume transient-user-activation on first iframe");

  doCheck(frames[1].document, "second iframe", false, false, 0);
  ok(!SpecialPowers.wrap(frames[1].document).consumeTransientUserGestureActivation(),
     "consume transient-user-activation on second iframe");
});

add_task(async function consumeTransientUserActivation() {
  // Trigger user activation on the first iframe.
  SpecialPowers.wrap(frames[0].document).notifyUserGestureActivation();
  let lastTimeStampTop = SpecialPowers.wrap(document).lastUserGestureTimeStamp;
  let lastTimeStampFirst = SpecialPowers.wrap(frames[0].document).lastUserGestureTimeStamp;

  // Try to consume transient user activation.
  ok(!SpecialPowers.wrap(frames[1].document).consumeTransientUserGestureActivation(),
     "consume transient-user-activation on second iframe");
  ok(SpecialPowers.wrap(frames[0].document).consumeTransientUserGestureActivation(),
     "consume transient-user-activation on first iframe");
  // Consuming a transient-user-activation should affect all tree.
  ok(!SpecialPowers.wrap(document).consumeTransientUserGestureActivation(),
     "consume transient-user-activation on top-level document");

  // Check has-valid-transient-user-activation and should not affect
  // has-been-user-activated
  doCheck(document, "top-level document", true, false, lastTimeStampTop);
  doCheck(frames[0].document, "first iframe", true, false, lastTimeStampFirst);
  doCheck(frames[1].document, "second iframe", false, false, 0);
});

add_task(async function consumeTransientUserActivationTimeout() {
  // Trigger user activation on the first iframe.
  SpecialPowers.wrap(frames[0].document).notifyUserGestureActivation();

  // Should not able to consume successfully after timeout.
  await new Promise((aResolve) => {
    setTimeout(() => {
      ok(!SpecialPowers.wrap(document).consumeTransientUserGestureActivation(),
         "consume transient-user-activation on top-level document");
      ok(!SpecialPowers.wrap(frames[0].document).consumeTransientUserGestureActivation(),
         "consume transient-user-activation on first iframe");
      ok(!SpecialPowers.wrap(frames[1].document).consumeTransientUserGestureActivation(),
         "consume transient-user-activation on second iframe");
      aResolve();
    }, timeout);
  });

  // Trigger user activation again.
  SpecialPowers.wrap(frames[0].document).notifyUserGestureActivation();

  // Try to consume transient user activation.
  ok(!SpecialPowers.wrap(frames[1].document).consumeTransientUserGestureActivation(),
     "consume transient-user-activation on second iframe");
  ok(SpecialPowers.wrap(frames[0].document).consumeTransientUserGestureActivation(),
     "consume transient-user-activation on first iframe");
  // Consuming a transient-user-activation should affect all tree.
  ok(!SpecialPowers.wrap(document).consumeTransientUserGestureActivation(),
     "consume transient-user-activation on top-level document");
});

add_task(async function iframeNavigation() {
  // Trigger user activation on the first iframe.
  SpecialPowers.wrap(frames[0].document).notifyUserGestureActivation();

  // Navigate away from current page.
  frames[0].frameElement.src = "file_empty.html";
  await waitForEvent(frames[0].frameElement, "load", () => {});

  // Try to consume transient user activation.
  ok(!SpecialPowers.wrap(frames[1].document).consumeTransientUserGestureActivation(),
     "consume transient-user-activation on second iframe");
  ok(!SpecialPowers.wrap(frames[0].document).consumeTransientUserGestureActivation(),
     "consume transient-user-activation on first iframe");
  ok(SpecialPowers.wrap(document).consumeTransientUserGestureActivation(),
     "consume transient-user-activation on top-level document");
});

add_task(async function triggerUserActivationOnCrossOriginFrame() {
  // Reset the activation flag.
  SpecialPowers.wrap(document).clearUserGestureActivation();

  // load cross-origin test page on iframe.
  frames[0].frameElement.src = "https://example.com/tests/dom/base/test/useractivation/file_iframe_consume_user_activation.html";
  await waitForEvent(window, "message", (event) => {
    if (event.data === "done") {
      ok(!SpecialPowers.wrap(document).consumeTransientUserGestureActivation(),
         "consume transient-user-activation on top-level document");
      ok(!SpecialPowers.wrap(document).hasValidTransientUserGestureActivation,
         "check has-valid-transient-user-activation on the top-level document");
      ok(!SpecialPowers.wrap(frames[1].document).hasValidTransientUserGestureActivation,
         "check has-valid-transient-user-activation on the second iframe");
    } else {
      ok(false, "receive unexpected message: " + event.data);
    }
  });
});

add_task(async function endTests() {
  // Reset the activation flag in order not to interfere following test in the
  // verify mode which would run the test using same document couple times.
  SpecialPowers.wrap(document).clearUserGestureActivation();
});

</script>
</body>