summaryrefslogtreecommitdiffstats
path: root/toolkit/components/telemetry/tests/unit/test_UtilityScalars.js
blob: b6c0842910b0a1eaf53607d81ca2c0571a6ac029 (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
/* Any copyright is dedicated to the Public Domain.
   http://creativecommons.org/publicdomain/zero/1.0/
*/

const { TelemetryController } = ChromeUtils.importESModule(
  "resource://gre/modules/TelemetryController.sys.mjs"
);
const { ContentTaskUtils } = ChromeUtils.importESModule(
  "resource://testing-common/ContentTaskUtils.sys.mjs"
);

const UTILITY_ONLY_UINT_SCALAR = "telemetry.test.utility_only_uint";

const utilityProcessTest = () => {
  return Cc["@mozilla.org/utility-process-test;1"].createInstance(
    Ci.nsIUtilityProcessTest
  );
};

/**
 * This function waits until utility scalars are reported into the
 * scalar snapshot.
 */
async function waitForUtilityScalars() {
  await ContentTaskUtils.waitForCondition(() => {
    const scalars = Telemetry.getSnapshotForScalars("main", false);
    return Object.keys(scalars).includes("utility");
  }, "Waiting for utility scalars to have been set");
}

async function waitForUtilityValue() {
  await ContentTaskUtils.waitForCondition(() => {
    return (
      UTILITY_ONLY_UINT_SCALAR in
      Telemetry.getSnapshotForScalars("main", false).utility
    );
  }, "Waiting for utility uint value");
}

add_setup(async function setup_telemetry_utility() {
  info("Start a UtilityProcess");
  await utilityProcessTest().startProcess();

  do_get_profile(true);
  await TelemetryController.testSetup();
});

add_task(async function test_scalars_in_utility_process() {
  Telemetry.clearScalars();
  await utilityProcessTest().testTelemetryProbes();

  // Once scalars are set by the utility process, they don't immediately get
  // sent to the parent process. Wait for the Telemetry IPC Timer to trigger
  // and batch send the data back to the parent process.
  await waitForUtilityScalars();
  await waitForUtilityValue();

  Assert.equal(
    Telemetry.getSnapshotForScalars("main", false).utility[
      UTILITY_ONLY_UINT_SCALAR
    ],
    42,
    `${UTILITY_ONLY_UINT_SCALAR} must have the correct value (utility process).`
  );
});