summaryrefslogtreecommitdiffstats
path: root/toolkit/components/cookiebanners/test/browser/browser_bannerClicking_stopExecuteAfterSeveralAttempt.js
blob: 6e3a6f19fef2385d6b25dd503d21cbfc10913bb0 (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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
/* Any copyright is dedicated to the Public Domain.
   http://creativecommons.org/publicdomain/zero/1.0/ */

"use strict";

let { ForgetAboutSite } = ChromeUtils.importESModule(
  "resource://gre/modules/ForgetAboutSite.sys.mjs"
);

add_setup(async function () {
  await clickTestSetup();

  // Set the pref to enable stopping executing cookie banner handling after
  // several tries.
  await SpecialPowers.pushPrefEnv({
    set: [
      ["cookiebanners.bannerClicking.maxTriesPerSiteAndSession", 1],
      ["cookiebanners.service.mode", Ci.nsICookieBannerService.MODE_REJECT],
    ],
  });

  // Clean the records.
  Services.cookieBanners.removeAllExecutedRecords(false);
  Services.cookieBanners.removeAllExecutedRecords(true);
});

// Ensure the banner clicking doesn't execute at the second load if the
// stopExecuteAfterAttempt feature is enabled.
add_task(async function testStopExecuteAfterOneAttempt() {
  await SpecialPowers.pushPrefEnv({
    set: [
      ["cookiebanners.service.mode", Ci.nsICookieBannerService.MODE_REJECT],
      [
        "cookiebanners.service.mode.privateBrowsing",
        Ci.nsICookieBannerService.MODE_REJECT,
      ],
      ["cookiebanners.bannerClicking.maxTriesPerSiteAndSession", 1],
    ],
  });

  insertTestClickRules();

  // Open the domain and ensure the banner is clicked.
  await openPageAndVerify({
    win: window,
    domain: TEST_DOMAIN_A,
    testURL: TEST_PAGE_A,
    visible: false,
    expected: "OptOut",
  });

  // Open the domain again and the banner shouldn't be hidden nor the banner is
  // clicked.
  await openPageAndVerify({
    win: window,
    domain: TEST_DOMAIN_A,
    testURL: TEST_PAGE_A,
    visible: true,
    expected: "NoClick",
  });

  // Clear the record for the normal window.
  Services.cookieBanners.removeAllExecutedRecords(false);

  // Open the domain again after clearing the record and ensure the banner is
  // clicked.
  await openPageAndVerify({
    win: window,
    domain: TEST_DOMAIN_A,
    testURL: TEST_PAGE_A,
    visible: false,
    expected: "OptOut",
  });

  // Test in the private browsing mode.
  let pbmWindow = await BrowserTestUtils.openNewBrowserWindow({
    private: true,
  });

  // Open the domain in PBM and ensure the banner is clicked.
  await openPageAndVerify({
    win: pbmWindow,
    domain: TEST_DOMAIN_A,
    testURL: TEST_PAGE_A,
    visible: false,
    expected: "OptOut",
  });

  // Open the domain in PBM again and the banner shouldn't be hidden nor the
  // banner is clicked.
  await openPageAndVerify({
    win: pbmWindow,
    domain: TEST_DOMAIN_A,
    testURL: TEST_PAGE_A,
    visible: true,
    expected: "NoClick",
  });

  // Clear the record for the private window.
  Services.cookieBanners.removeAllExecutedRecords(true);

  // Open the domain again in PBM after clearing the record, and ensure the
  // banner is clicked.
  await openPageAndVerify({
    win: pbmWindow,
    domain: TEST_DOMAIN_A,
    testURL: TEST_PAGE_A,
    visible: false,
    expected: "OptOut",
  });

  await BrowserTestUtils.closeWindow(pbmWindow);

  // Clean the records.
  Services.cookieBanners.removeAllExecutedRecords(false);
  Services.cookieBanners.removeAllExecutedRecords(true);
});

// Ensure the banner clicking doesn't execute after several attempts if the
// stopExecuteAfterAttempt feature is enabled.
add_task(async function testStopExecuteAfterSeveralAttempts() {
  await SpecialPowers.pushPrefEnv({
    set: [
      ["cookiebanners.service.mode", Ci.nsICookieBannerService.MODE_REJECT],
      [
        "cookiebanners.service.mode.privateBrowsing",
        Ci.nsICookieBannerService.MODE_REJECT,
      ],
      ["cookiebanners.bannerClicking.maxTriesPerSiteAndSession", 2],
    ],
  });

  insertTestClickRules();

  // Open the domain and ensure the banner is clicked.
  await openPageAndVerify({
    win: window,
    domain: TEST_DOMAIN_A,
    testURL: TEST_PAGE_A,
    visible: false,
    expected: "OptOut",
  });

  // Open the domain in the second time and the banner should be clicked,
  await openPageAndVerify({
    win: window,
    domain: TEST_DOMAIN_A,
    testURL: TEST_PAGE_A,
    visible: false,
    expected: "OptOut",
  });

  // Open the domain in the third time, the the banner shouldn't be hidden nor
  // the banner is clicked.
  await openPageAndVerify({
    win: window,
    domain: TEST_DOMAIN_A,
    testURL: TEST_PAGE_A,
    visible: true,
    expected: "NoClick",
  });

  // Test in the private browsing mode.
  let pbmWindow = await BrowserTestUtils.openNewBrowserWindow({
    private: true,
  });

  // Open the domain in PBM and ensure the banner is clicked.
  await openPageAndVerify({
    win: pbmWindow,
    domain: TEST_DOMAIN_A,
    testURL: TEST_PAGE_A,
    visible: false,
    expected: "OptOut",
  });

  // Open the domain in the second time and the banner should be clicked,
  await openPageAndVerify({
    win: pbmWindow,
    domain: TEST_DOMAIN_A,
    testURL: TEST_PAGE_A,
    visible: false,
    expected: "OptOut",
  });

  // Open the domain in PBM third time and the banner shouldn't be hidden nor
  // the banner is clicked.
  await openPageAndVerify({
    win: pbmWindow,
    domain: TEST_DOMAIN_A,
    testURL: TEST_PAGE_A,
    visible: true,
    expected: "NoClick",
  });

  await BrowserTestUtils.closeWindow(pbmWindow);

  // Clean the records.
  Services.cookieBanners.removeAllExecutedRecords(false);
  Services.cookieBanners.removeAllExecutedRecords(true);
});

// Ensure that ForgetAboutSite clears the handled record properly.
add_task(async function testForgetAboutSiteWithStopExecuteAfterOneAttempt() {
  await SpecialPowers.pushPrefEnv({
    set: [
      ["cookiebanners.service.mode", Ci.nsICookieBannerService.MODE_REJECT],
      ["cookiebanners.bannerClicking.maxTriesPerSiteAndSession", 1],
    ],
  });

  insertTestClickRules();

  // Open the domain and ensure the banner is clicked.
  await openPageAndVerify({
    win: window,
    domain: TEST_DOMAIN_A,
    testURL: TEST_PAGE_A,
    visible: false,
    expected: "OptOut",
  });

  // Open the domain again and the banner shouldn't be hidden nor the banner is
  // clicked.
  await openPageAndVerify({
    win: window,
    domain: TEST_DOMAIN_A,
    testURL: TEST_PAGE_A,
    visible: true,
    expected: "NoClick",
  });

  // Call ForgetAboutSite for the domain.
  await ForgetAboutSite.removeDataFromDomain(TEST_DOMAIN_A);

  // Open the domain again after ForgetAboutSite and the clicking should work
  // again.
  await openPageAndVerify({
    win: window,
    domain: TEST_DOMAIN_A,
    testURL: TEST_PAGE_A,
    visible: false,
    expected: "OptOut",
  });

  // Clean the records.
  Services.cookieBanners.removeAllExecutedRecords(false);
  Services.cookieBanners.removeAllExecutedRecords(true);
});

// Ensure the ClearDataService clears the handled record properly.
add_task(async function testClearDataServiceWithStopExecuteAfterOneAttempt() {
  await SpecialPowers.pushPrefEnv({
    set: [
      ["cookiebanners.service.mode", Ci.nsICookieBannerService.MODE_REJECT],
      ["cookiebanners.bannerClicking.maxTriesPerSiteAndSession", 1],
    ],
  });

  insertTestClickRules();

  // Open the domain initially and ensure the banner is clicked.
  await openPageAndVerify({
    win: window,
    domain: TEST_DOMAIN_A,
    testURL: TEST_PAGE_A,
    visible: false,
    expected: "OptOut",
  });

  // Invoke deleteDataFromBaseDomain.
  await new Promise(aResolve => {
    Services.clearData.deleteDataFromBaseDomain(
      TEST_DOMAIN_A,
      true /* user request */,
      Ci.nsIClearDataService.CLEAR_COOKIE_BANNER_EXECUTED_RECORD,
      aResolve
    );
  });

  // Ensure the record is cleared. The banner clicking should work after clean.
  await openPageAndVerify({
    win: window,
    domain: TEST_DOMAIN_A,
    testURL: TEST_PAGE_A,
    visible: false,
    expected: "OptOut",
  });

  // Invoke deleteDataFromHost.
  await new Promise(aResolve => {
    Services.clearData.deleteDataFromHost(
      TEST_DOMAIN_A,
      true /* user request */,
      Ci.nsIClearDataService.CLEAR_COOKIE_BANNER_EXECUTED_RECORD,
      aResolve
    );
  });

  // Ensure the record is cleared. The banner clicking should work after clean.
  await openPageAndVerify({
    win: window,
    domain: TEST_DOMAIN_A,
    testURL: TEST_PAGE_A,
    visible: false,
    expected: "OptOut",
  });

  // Invoke deleteDataFromPrincipal.
  let principal =
    Services.scriptSecurityManager.createContentPrincipalFromOrigin(
      "https://" + TEST_DOMAIN_A
    );
  await new Promise(aResolve => {
    Services.clearData.deleteDataFromPrincipal(
      principal,
      true /* user request */,
      Ci.nsIClearDataService.CLEAR_COOKIE_BANNER_EXECUTED_RECORD,
      aResolve
    );
  });

  // Ensure the record is cleared. The banner clicking should work after clean.
  await openPageAndVerify({
    win: window,
    domain: TEST_DOMAIN_A,
    testURL: TEST_PAGE_A,
    visible: false,
    expected: "OptOut",
  });

  // Invoke deleteData.
  await new Promise(aResolve => {
    Services.clearData.deleteData(
      Ci.nsIClearDataService.CLEAR_COOKIE_BANNER_EXECUTED_RECORD,
      aResolve
    );
  });

  // Ensure the record is cleared. The banner clicking should work after clean.
  await openPageAndVerify({
    win: window,
    domain: TEST_DOMAIN_A,
    testURL: TEST_PAGE_A,
    visible: false,
    expected: "OptOut",
  });

  // Clean the records.
  Services.cookieBanners.removeAllExecutedRecords(false);
  Services.cookieBanners.removeAllExecutedRecords(true);
});