summaryrefslogtreecommitdiffstats
path: root/devtools/client/netmonitor/test/browser_net_telemetry_persist_toggle_changed.js
blob: 7a8aa956d44fb9095e63d28dc88b8e77bd2dcf3b (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
/* Any copyright is dedicated to the Public Domain.
   http://creativecommons.org/publicdomain/zero/1.0/ */

"use strict";

/**
 * Tests the log persistence telemetry event
 */
const { TelemetryTestUtils } = ChromeUtils.importESModule(
  "resource://testing-common/TelemetryTestUtils.sys.mjs"
);

function togglePersistLogsOption(monitor) {
  clickSettingsMenuItem(monitor, "persist-logs");
}

function ensurePersistLogsCheckedState(monitor, isChecked) {
  openSettingsMenu(monitor);
  const persistNode = getSettingsMenuItem(monitor, "persist-logs");
  return !!persistNode?.getAttribute("aria-checked") === isChecked;
}

add_task(async function () {
  const { monitor } = await initNetMonitor(SINGLE_GET_URL, { requestCount: 1 });
  info("Starting test... ");

  const { store, windowRequire } = monitor.panelWin;
  const Actions = windowRequire("devtools/client/netmonitor/src/actions/index");

  store.dispatch(Actions.batchEnable(false));

  await waitForAllNetworkUpdateEvents();

  // Clear all events
  Services.telemetry.clearEvents();

  // Ensure no events have been logged
  TelemetryTestUtils.assertNumberOfEvents(0);

  // Click on the toggle - "true" and make sure it was set to correct value
  let onPersistChanged = monitor.panelWin.api.once(TEST_EVENTS.PERSIST_CHANGED);
  togglePersistLogsOption(monitor);
  await waitUntil(() => ensurePersistLogsCheckedState(monitor, true));
  await onPersistChanged;

  // Click a second time - "false" and make sure it was set to correct value
  onPersistChanged = monitor.panelWin.api.once(TEST_EVENTS.PERSIST_CHANGED);
  togglePersistLogsOption(monitor);
  await waitUntil(() => ensurePersistLogsCheckedState(monitor, false));
  await onPersistChanged;

  const expectedEvents = [
    {
      category: "devtools.main",
      method: "persist_changed",
      object: "netmonitor",
      value: "true",
    },
    {
      category: "devtools.main",
      method: "persist_changed",
      object: "netmonitor",
      value: "false",
    },
  ];

  const filter = {
    category: "devtools.main",
    method: "persist_changed",
    object: "netmonitor",
  };

  await waitForAllNetworkUpdateEvents();
  // Will compare filtered events to event list above
  await TelemetryTestUtils.assertEvents(expectedEvents, filter);

  // Set Persist log preference back to false
  Services.prefs.setBoolPref("devtools.netmonitor.persistlog", false);

  return teardown(monitor);
});