summaryrefslogtreecommitdiffstats
path: root/toolkit/components/extensions/test/mochitest/test_chrome_ext_contentscript_telemetry.html
blob: d2bb66d507a02d8851d5bdbed15b2905138b2f4b (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
<!DOCTYPE html>
<html>
<head>
  <title>Test for telemetry for content script injection</title>
  <script src="chrome://mochikit/content/tests/SimpleTest/SimpleTest.js"></script>
  <script src="chrome://mochikit/content/tests/SimpleTest/ExtensionTestUtils.js"></script>
  <script src="head.js"></script>
  <link rel="stylesheet" href="chrome://mochikit/contents/tests/SimpleTest/test.css"/>
</head>
<body>

<script>
"use strict";

const HISTOGRAM = "WEBEXT_CONTENT_SCRIPT_INJECTION_MS";
const GLEAN_METRIC_ID = "contentScriptInjection";

function assertHistogramSamplesCount(histogram, expectedSamplesCount, msg) {
  return is(
    Object.values(histogram.snapshot().values).reduce((a, b) => a + b, 0),
    expectedSamplesCount,
    msg
  );
}

add_task(async function test_contentscript_telemetry() {
  // Turn on telemetry and reset it to the previous state once the test is completed.
  const telemetryCanRecordBase = SpecialPowers.Services.telemetry.canRecordBase;
  SpecialPowers.Services.telemetry.canRecordBase = true;
  SimpleTest.registerCleanupFunction(() => {
    SpecialPowers.Services.telemetry.canRecordBase = telemetryCanRecordBase;
  });

  function background() {
    browser.test.onMessage.addListener(() => {
      browser.tabs.executeScript({code: 'browser.test.sendMessage("content-script-run");'});
    });
  }

  let extensionData = {
    manifest: {
      permissions: ["<all_urls>"],
    },
    background,
  };

  let tab = await AppTestDelegate.openNewForegroundTab(
    window,
    "https://example.com",
    true
  );

  let extension = ExtensionTestUtils.loadExtension(extensionData);

  await Services.fog.testFlushAllChildren();
  Services.fog.testResetFOG();

  is(
    Glean.extensionsTiming[GLEAN_METRIC_ID].testGetValue(),
    null,
    `No data recorded for Glean metric extensionsTiming.${GLEAN_METRIC_ID}`
  );

  let histogram = SpecialPowers.Services.telemetry.getHistogramById(HISTOGRAM);
  histogram.clear();
  assertHistogramSamplesCount(
    histogram,
    0,
    `No data recorded for histogram: ${HISTOGRAM}.`
  );

  await extension.startup();

  assertHistogramSamplesCount(
    histogram,
    0,
    `No data recorded for histogram: ${HISTOGRAM}.`
  );

  await Services.fog.testFlushAllChildren();
  is(
    Glean.extensionsTiming[GLEAN_METRIC_ID].testGetValue(),
    null,
    `No data recorded for Glean metric extensionsTiming.${GLEAN_METRIC_ID}`
  );

  extension.sendMessage();
  await extension.awaitMessage("content-script-run");

  await Services.fog.testFlushAllChildren();

  ok(
    Glean.extensionsTiming[GLEAN_METRIC_ID].testGetValue()?.sum > 0,
    `Data recorded for first extension on Glean metric extensionsTiming.${GLEAN_METRIC_ID}`
  );

  // Asserting the number of samples is the expected one (the histogram sum value
  // is intermittently set to 0 due to a sample being intermittently recorded for
  // the bucket 0 and would trigger an intermittent failure, see Bug 1864213).
  assertHistogramSamplesCount(
    histogram,
    1,
    `Data recorded for first extension for histogram: ${HISTOGRAM}.`
  );

  await AppTestDelegate.removeTab(window, tab);
  await extension.unload();
});
</script>

</body>
</html>