summaryrefslogtreecommitdiffstats
path: root/devtools/client/webconsole/test/browser/browser_jsterm_trace_command.js
blob: 2bd1149a498b1c8733c51c9a41679f7ef72459de (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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at <http://mozilla.org/MPL/2.0/>. */

// Tests the Javascript Tracing feature via the Web Console :trace command.

"use strict";

const TEST_URI = `data:text/html;charset=utf-8,<!DOCTYPE html>
<body>
  <div>
    <h1>Testing trace command</h1>
    <script>
    function main() {}
    function someNoise() {}
    </script>
  </div>
  <div><p></p></div>
</body>`;

add_task(async function testBasicRecord() {
  await pushPref("devtools.debugger.features.javascript-tracing", true);

  const hud = await openNewTabAndConsole(TEST_URI);
  ok(hud, "web console opened");

  info("Test unsupported param error message");
  let msg = await evaluateExpressionInConsole(
    hud,
    ":trace --unsupported-param",
    "console-api"
  );
  is(
    msg.textContent.trim(),
    ":trace command doesn't support 'unsupported-param' argument."
  );

  info("Test the help argument");
  msg = await evaluateExpressionInConsole(hud, ":trace --help", "console-api");
  ok(msg.textContent.includes("Toggles the JavaScript tracer"));

  info("Test toggling the tracer ON");
  // Pass `console-api` specific classname as the command results don't log anything.
  // Instead a JSTRACER_STATE resource logs a console-api message.
  msg = await evaluateExpressionInConsole(
    hud,
    ":trace --logMethod console --prefix foo --values --on-next-interaction",
    "console-api"
  );
  is(
    msg.textContent.trim(),
    "Waiting for next user interaction before tracing (next mousedown or keydown event)"
  );

  info("Trigger some code before the user interaction");
  await SpecialPowers.spawn(gBrowser.selectedBrowser, [], () => {
    content.wrappedJSObject.someNoise();
  });

  info("Simulate a user interaction by trigerring a key event on the page");
  await BrowserTestUtils.synthesizeKey("a", {}, gBrowser.selectedBrowser);

  info("Trigger some code to log some traces");
  await SpecialPowers.spawn(gBrowser.selectedBrowser, [], () => {
    content.wrappedJSObject.main("arg", 2);
  });

  info("Ensure a message notified about the tracer actual start");
  await waitFor(
    () => !!findConsoleAPIMessage(hud, `Started tracing to Web Console`)
  );

  // Assert that we also see the custom prefix, as well as function arguments
  await waitFor(
    () =>
      !!findTracerMessages(hud, `foo: ⟶ interpreter λ main("arg", 2)`).length
  );
  is(
    findTracerMessages(hud, `someNoise`).length,
    0,
    "The code running before the key press should not be traced"
  );

  // But now that the tracer is active, we will be able to log this call to someNoise
  await SpecialPowers.spawn(gBrowser.selectedBrowser, [], () => {
    content.wrappedJSObject.someNoise();
  });
  await waitFor(
    () => !!findTracerMessages(hud, `foo: ⟶ interpreter λ someNoise()`).length
  );

  info("Test toggling the tracer OFF");
  msg = await evaluateExpressionInConsole(hud, ":trace", "console-api");
  is(msg.textContent.trim(), "Stopped tracing");

  info("Clear past traces");
  hud.ui.clearOutput();
  await waitFor(
    () => !findTracerMessages(hud, `foo: ⟶ interpreter λ main("arg", 2)`).length
  );
  ok("Console was cleared");

  info("Trigger some code again");
  await SpecialPowers.spawn(gBrowser.selectedBrowser, [], () => {
    content.wrappedJSObject.main();
  });

  // Let some time for traces to appear
  await wait(1000);

  ok(
    !findTracerMessages(hud, `foo: ⟶ interpreter λ main("arg", 2)`).length,
    "We really stopped recording traces, and no trace appear in the console"
  );
});

add_task(async function testLimitedRecord() {
  await pushPref("devtools.debugger.features.javascript-tracing", true);

  const jsCode = `function foo1() {foo2()}; function foo2() {foo3()}; function foo3() {}; function bar() {}`;
  const hud = await openNewTabAndConsole(
    "data:text/html," + encodeURIComponent(`<script>${jsCode}</script>`)
  );
  ok(hud, "web console opened");

  info("Test toggling the tracer ON");
  // Pass `console-api` specific classname as the command results aren't logged as "result".
  // Instead the frontend log a message as a console API message.
  await evaluateExpressionInConsole(
    hud,
    ":trace --logMethod console --max-depth 1",
    "console-api"
  );

  info("Execute some code trigerring the tracer");
  await SpecialPowers.spawn(gBrowser.selectedBrowser, [], () => {
    content.wrappedJSObject.foo1();
  });

  await waitFor(() => !!findTracerMessages(hud, `λ foo1`).length);
  ok(true, "foo1 trace was printed to console");

  is(
    findTracerMessages(hud, `λ foo2`).length,
    0,
    "We only see the first function thanks to the depth limit"
  );

  info("Test toggling the tracer OFF");
  await evaluateExpressionInConsole(hud, ":trace", "console-api");

  info("Clear past traces");
  hud.ui.clearOutput();
  await waitFor(() => !findTracerMessages(hud, `λ foo1`).length);
  ok("Console was cleared");

  info("Re-enable the tracing, but with a max record limit");
  await evaluateExpressionInConsole(
    hud,
    ":trace --logMethod console --max-records 1",
    "console-api"
  );

  info("Trigger some code again");
  await SpecialPowers.spawn(gBrowser.selectedBrowser, [], () => {
    content.wrappedJSObject.foo1();
    content.wrappedJSObject.bar();
  });

  await waitFor(() => !!findTracerMessages(hud, `λ foo3`).length);
  await waitFor(() => !!findConsoleAPIMessage(hud, `Stopped tracing`));
  is(
    findTracerMessages(hud, `λ foo1`).length,
    1,
    "Found the whole depth for the first event loop 1/3"
  );
  is(
    findTracerMessages(hud, `λ foo2`).length,
    1,
    "Found the whole depth for the first event loop 2/3"
  );
  is(
    findTracerMessages(hud, `λ foo3`).length,
    1,
    "Found the whole depth for the first event loop 3/3"
  );
  is(
    findTracerMessages(hud, `λ bar`).length,
    0,
    "But the second event loop was ignored"
  );
  ok(
    !!findConsoleAPIMessage(
      hud,
      `Stopped tracing (reason: max-records)`,
      ".console-api"
    ),
    "And the tracer was automatically stopped"
  );

  info("Enable tracing one last time without any restriction");
  await evaluateExpressionInConsole(
    hud,
    ":trace --logMethod console",
    "console-api"
  );
  info("Trigger various code again");
  await SpecialPowers.spawn(gBrowser.selectedBrowser, [], () => {
    content.wrappedJSObject.foo1();
    content.wrappedJSObject.bar();
  });
  await waitFor(() => !!findTracerMessages(hud, `λ foo1`).length);
  await waitFor(() => !!findTracerMessages(hud, `λ foo2`).length);
  await waitFor(() => !!findTracerMessages(hud, `λ foo3`).length);
  await waitFor(() => !!findTracerMessages(hud, `λ bar`).length);
  ok(true, "All traces were printed to console");
});