summaryrefslogtreecommitdiffstats
path: root/browser/base/content/test/protectionsUI/browser_protectionsUI_email_trackers_subview.js
blob: 6b97b83087196a78831962a200ff810e539f7820 (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
/* Any copyright is dedicated to the Public Domain.
 * http://creativecommons.org/publicdomain/zero/1.0/ */

"use strict";

/**
 * Bug 1819662 - Testing the tracking category of the protection panel shows the
 *               email tracker domain if the email tracking protection is
 *               enabled
 */

const { PermissionTestUtils } = ChromeUtils.importESModule(
  "resource://testing-common/PermissionTestUtils.sys.mjs"
);

const TEST_PAGE =
  "https://www.example.com/browser/browser/base/content/test/protectionsUI/emailTrackingPage.html";
const TEST_TRACKER_PAGE = "https://itisatracker.org/";

const TP_PREF = "privacy.trackingprotection.enabled";
const EMAIL_TP_PREF = "privacy.trackingprotection.emailtracking.enabled";

/**
 * A helper function to check whether or not an element has "notFound" class.
 *
 * @param {String} id The id of the testing element.
 * @returns {Boolean} true when the element has "notFound" class.
 */
function notFound(id) {
  return document.getElementById(id).classList.contains("notFound");
}

/**
 * A helper function to test the protection UI tracker category.
 *
 * @param {Boolean} blocked - true if the email tracking protection is enabled.
 */
async function assertSitesListed(blocked) {
  let tab = await BrowserTestUtils.openNewForegroundTab({
    url: TEST_PAGE,
    gBrowser,
  });

  await openProtectionsPanel();

  let categoryItem = document.getElementById(
    "protections-popup-category-trackers"
  );

  if (!blocked) {
    // The tracker category should have the 'notFound' class to indicate that
    // no tracker was blocked in the page.
    ok(
      notFound("protections-popup-category-trackers"),
      "Tracker category is not found"
    );

    ok(
      !BrowserTestUtils.is_visible(categoryItem),
      "TP category item is not visible"
    );
    BrowserTestUtils.removeTab(tab);

    return;
  }

  // Testing if the tracker category is visible.

  // Explicitly waiting for the category item becoming visible.
  await BrowserTestUtils.waitForMutationCondition(categoryItem, {}, () =>
    BrowserTestUtils.is_visible(categoryItem)
  );

  ok(BrowserTestUtils.is_visible(categoryItem), "TP category item is visible");

  // Click the tracker category and wait until the tracker view is shown.
  let trackersView = document.getElementById("protections-popup-trackersView");
  let viewShown = BrowserTestUtils.waitForEvent(trackersView, "ViewShown");
  categoryItem.click();
  await viewShown;

  ok(true, "Trackers view was shown");

  // Ensure the email tracker is listed on the tracker list.
  let listItems = Array.from(
    trackersView.querySelectorAll(".protections-popup-list-item")
  );
  is(listItems.length, 1, "We have 1 trackers in the list");

  let listItem = listItems.find(
    item =>
      item.querySelector("label").value == "https://email-tracking.example.org"
  );
  ok(listItem, "Has an item for email-tracking.example.org");
  ok(BrowserTestUtils.is_visible(listItem), "List item is visible");

  // Back to the popup main view.
  let mainView = document.getElementById("protections-popup-mainView");
  viewShown = BrowserTestUtils.waitForEvent(mainView, "ViewShown");
  let backButton = trackersView.querySelector(".subviewbutton-back");
  backButton.click();
  await viewShown;

  ok(true, "Main view was shown");

  // Add an iframe to a tracker domain and wait until the content event files.
  let contentBlockingEventPromise = waitForContentBlockingEvent(1);
  await SpecialPowers.spawn(
    tab.linkedBrowser,
    [TEST_TRACKER_PAGE],
    test_url => {
      let ifr = content.document.createElement("iframe");

      content.document.body.appendChild(ifr);
      ifr.src = test_url;
    }
  );
  await contentBlockingEventPromise;

  // Click the tracker category again.
  viewShown = BrowserTestUtils.waitForEvent(trackersView, "ViewShown");
  categoryItem.click();
  await viewShown;

  // Ensure both the email tracker and the tracker are listed on the tracker
  // list.
  listItems = Array.from(
    trackersView.querySelectorAll(".protections-popup-list-item")
  );
  is(listItems.length, 2, "We have 2 trackers in the list");

  listItem = listItems.find(
    item =>
      item.querySelector("label").value == "https://email-tracking.example.org"
  );
  ok(listItem, "Has an item for email-tracking.example.org");
  ok(BrowserTestUtils.is_visible(listItem), "List item is visible");

  listItem = listItems.find(
    item => item.querySelector("label").value == "https://itisatracker.org"
  );
  ok(listItem, "Has an item for itisatracker.org");
  ok(BrowserTestUtils.is_visible(listItem), "List item is visible");

  BrowserTestUtils.removeTab(tab);
}

add_setup(async function () {
  Services.prefs.setBoolPref(TP_PREF, true);

  await UrlClassifierTestUtils.addTestTrackers();

  registerCleanupFunction(() => {
    Services.prefs.clearUserPref(TP_PREF);
    UrlClassifierTestUtils.cleanupTestTrackers();
  });
});

add_task(async function testTrackersSubView() {
  info("Testing trackers subview with TP disabled.");
  Services.prefs.setBoolPref(EMAIL_TP_PREF, false);
  await assertSitesListed(false);
  info("Testing trackers subview with TP enabled.");
  Services.prefs.setBoolPref(EMAIL_TP_PREF, true);
  await assertSitesListed(true);
  info("Testing trackers subview with TP enabled and a CB exception.");
  let uri = Services.io.newURI("https://www.example.com");
  PermissionTestUtils.add(
    uri,
    "trackingprotection",
    Services.perms.ALLOW_ACTION
  );
  await assertSitesListed(false);
  info("Testing trackers subview with TP enabled and a CB exception removed.");
  PermissionTestUtils.remove(uri, "trackingprotection");
  await assertSitesListed(true);

  Services.prefs.clearUserPref(EMAIL_TP_PREF);
});