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

// Tests the object_expanded telemetry event.

"use strict";

const TEST_URI = `data:text/html,<!DOCTYPE html><meta charset=utf8><script>
  console.log("test message", [1,2,3]);
</script>`;

const ALL_CHANNELS = Ci.nsITelemetry.DATASET_ALL_CHANNELS;

add_task(async function () {
  // Let's reset the counts.
  Services.telemetry.clearEvents();

  // Ensure no events have been logged
  const snapshot = Services.telemetry.snapshotEvents(ALL_CHANNELS, true);
  ok(!snapshot.parent, "No events have been logged for the main process");

  const hud = await openNewTabAndConsole(TEST_URI);

  const message = await waitFor(() =>
    findConsoleAPIMessage(hud, "test message")
  );

  info("Click on the arrow icon to expand the node");
  const arrowIcon = message.querySelector(".arrow");
  arrowIcon.click();

  // let's wait until we have 2 arrows (i.e. the object was expanded)
  await waitFor(() => message.querySelectorAll(".arrow").length === 2);

  let events = getObjectExpandedEventsExtra();
  is(events.length, 1, "There was 1 event logged");
  const [event] = events;
  ok(event.session_id > 0, "There is a valid session_id in the logged event");

  info("Click on the second arrow icon to expand the prototype node");
  const secondArrowIcon = message.querySelectorAll(".arrow")[1];
  secondArrowIcon.click();
  // let's wait until we have more than 2 arrows displayed, i.e. the prototype node was
  // expanded.
  await waitFor(() => message.querySelectorAll(".arrow").length > 2);

  events = getObjectExpandedEventsExtra();
  is(events.length, 1, "There was an event logged when expanding a child node");

  info("Click the first arrow to collapse the object");
  arrowIcon.click();
  // Let's wait until there's only one arrow visible, i.e. the node is collapsed.
  await waitFor(() => message.querySelectorAll(".arrow").length === 1);

  ok(!snapshot.parent, "There was no event logged when collapsing the node");
});

function getObjectExpandedEventsExtra() {
  // Retrieve and clear telemetry events.
  const snapshot = Services.telemetry.snapshotEvents(ALL_CHANNELS, true);

  const events = snapshot.parent.filter(
    event =>
      event[1] === "devtools.main" &&
      event[2] === "object_expanded" &&
      event[3] === "webconsole"
  );

  // Since we already know we have the correct event, we only return the `extra` field
  // that was passed to it (which is event[5] here).
  return events.map(event => event[5]);
}