summaryrefslogtreecommitdiffstats
path: root/browser/components/extensions/test/browser/browser_ext_pageAction_telemetry.js
blob: b891aae9b909285a461233bf3110de85baa7e835 (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
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
"use strict";

const HISTOGRAM = "WEBEXT_PAGEACTION_POPUP_OPEN_MS";
const HISTOGRAM_KEYED = "WEBEXT_PAGEACTION_POPUP_OPEN_MS_BY_ADDONID";

const EXTENSION_ID1 = "@test-extension1";
const EXTENSION_ID2 = "@test-extension2";

function snapshotCountsSum(snapshot) {
  return Object.values(snapshot.values).reduce((a, b) => a + b, 0);
}

function histogramCountsSum(histogram) {
  return snapshotCountsSum(histogram.snapshot());
}

add_task(async function testPageActionTelemetry() {
  let extensionOptions = {
    manifest: {
      page_action: {
        default_popup: "popup.html",
        browser_style: true,
      },
    },
    background: function () {
      browser.tabs.query({ active: true, currentWindow: true }, tabs => {
        const tabId = tabs[0].id;

        browser.pageAction.show(tabId).then(() => {
          browser.test.sendMessage("action-shown");
        });
      });
    },

    files: {
      "popup.html": `<!DOCTYPE html><html><head><meta charset="utf-8"></head><body><div></div></body></html>`,
    },
  };
  let extension1 = ExtensionTestUtils.loadExtension({
    ...extensionOptions,
    manifest: {
      ...extensionOptions.manifest,
      browser_specific_settings: {
        gecko: { id: EXTENSION_ID1 },
      },
    },
  });
  let extension2 = ExtensionTestUtils.loadExtension({
    ...extensionOptions,
    manifest: {
      ...extensionOptions.manifest,
      browser_specific_settings: {
        gecko: { id: EXTENSION_ID2 },
      },
    },
  });

  let histogram = Services.telemetry.getHistogramById(HISTOGRAM);
  let histogramKeyed =
    Services.telemetry.getKeyedHistogramById(HISTOGRAM_KEYED);

  histogram.clear();
  histogramKeyed.clear();

  is(
    histogramCountsSum(histogram),
    0,
    `No data recorded for histogram: ${HISTOGRAM}.`
  );
  is(
    Object.keys(histogramKeyed).length,
    0,
    `No data recorded for histogram: ${HISTOGRAM_KEYED}.`
  );

  await extension1.startup();
  await extension1.awaitMessage("action-shown");
  await extension2.startup();
  await extension2.awaitMessage("action-shown");

  is(
    histogramCountsSum(histogram),
    0,
    `No data recorded for histogram after PageAction shown: ${HISTOGRAM}.`
  );
  is(
    Object.keys(histogramKeyed).length,
    0,
    `No data recorded for histogram after PageAction shown: ${HISTOGRAM_KEYED}.`
  );

  clickPageAction(extension1, window);
  await awaitExtensionPanel(extension1);

  is(
    histogramCountsSum(histogram),
    1,
    `Data recorded for first extension for histogram: ${HISTOGRAM}.`
  );
  let keyedSnapshot = histogramKeyed.snapshot();
  Assert.deepEqual(
    Object.keys(keyedSnapshot),
    [EXTENSION_ID1],
    `Data recorded for first extension histogram: ${HISTOGRAM_KEYED}.`
  );
  is(
    snapshotCountsSum(keyedSnapshot[EXTENSION_ID1]),
    1,
    `Data recorded for first extension for histogram: ${HISTOGRAM_KEYED}.`
  );

  await closePageAction(extension1, window);

  clickPageAction(extension2, window);
  await awaitExtensionPanel(extension2);

  is(
    histogramCountsSum(histogram),
    2,
    `Data recorded for second extension for histogram: ${HISTOGRAM}.`
  );
  keyedSnapshot = histogramKeyed.snapshot();
  Assert.deepEqual(
    Object.keys(keyedSnapshot).sort(),
    [EXTENSION_ID1, EXTENSION_ID2],
    `Data recorded for second extension histogram: ${HISTOGRAM_KEYED}.`
  );
  is(
    snapshotCountsSum(keyedSnapshot[EXTENSION_ID2]),
    1,
    `Data recorded for second extension for histogram: ${HISTOGRAM_KEYED}.`
  );
  is(
    snapshotCountsSum(keyedSnapshot[EXTENSION_ID1]),
    1,
    `Data recorded for first extension should not change for histogram: ${HISTOGRAM_KEYED}.`
  );

  await closePageAction(extension2, window);

  clickPageAction(extension2, window);
  await awaitExtensionPanel(extension2);

  is(
    histogramCountsSum(histogram),
    3,
    `Data recorded for second opening of popup for histogram: ${HISTOGRAM}.`
  );
  keyedSnapshot = histogramKeyed.snapshot();
  is(
    snapshotCountsSum(keyedSnapshot[EXTENSION_ID2]),
    2,
    `Data recorded for second opening of popup for histogram: ${HISTOGRAM_KEYED}.`
  );
  is(
    snapshotCountsSum(keyedSnapshot[EXTENSION_ID1]),
    1,
    `Data recorded for first extension should not change for histogram: ${HISTOGRAM_KEYED}.`
  );

  await closePageAction(extension2, window);

  clickPageAction(extension1, window);
  await awaitExtensionPanel(extension1);

  is(
    histogramCountsSum(histogram),
    4,
    `Data recorded for second opening of popup for histogram: ${HISTOGRAM}.`
  );
  keyedSnapshot = histogramKeyed.snapshot();
  is(
    snapshotCountsSum(keyedSnapshot[EXTENSION_ID1]),
    2,
    `Data recorded for second opening of popup for histogram: ${HISTOGRAM_KEYED}.`
  );
  is(
    snapshotCountsSum(keyedSnapshot[EXTENSION_ID1]),
    2,
    `Data recorded for second extension should not change for histogram: ${HISTOGRAM_KEYED}.`
  );

  await closePageAction(extension1, window);

  await extension1.unload();
  await extension2.unload();
});