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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
/* Any copyright is dedicated to the Public Domain.
http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
const { addTracingListener, removeTracingListener, startTracing, stopTracing } =
ChromeUtils.import("resource://devtools/server/tracer/tracer.jsm");
add_task(async function () {
// Because this test uses evalInSandbox, we need to tweak the following prefs
Services.prefs.setBoolPref(
"security.allow_parent_unrestricted_js_loads",
true
);
registerCleanupFunction(() => {
Services.prefs.clearUserPref("security.allow_parent_unrestricted_js_loads");
});
});
add_task(async function testTracingContentGlobal() {
const toggles = [];
const frames = [];
const listener = {
onTracingToggled(state) {
toggles.push(state);
},
onTracingFrame(frameInfo) {
frames.push(frameInfo);
},
};
info("Register a tracing listener");
addTracingListener(listener);
const sandbox = Cu.Sandbox("https://example.com");
Cu.evalInSandbox("function bar() {}; function foo() {bar()};", sandbox);
info("Start tracing");
startTracing({ global: sandbox, prefix: "testContentPrefix" });
Assert.equal(toggles.length, 1);
Assert.equal(toggles[0], true);
info("Call some code");
sandbox.foo();
Assert.equal(frames.length, 2);
const lastFrame = frames.pop();
const beforeLastFrame = frames.pop();
Assert.equal(beforeLastFrame.depth, 0);
Assert.equal(beforeLastFrame.formatedDisplayName, "λ foo");
Assert.equal(beforeLastFrame.prefix, "testContentPrefix: ");
Assert.ok(beforeLastFrame.frame);
Assert.equal(lastFrame.depth, 1);
Assert.equal(lastFrame.formatedDisplayName, "λ bar");
Assert.equal(lastFrame.prefix, "testContentPrefix: ");
Assert.ok(lastFrame.frame);
info("Stop tracing");
stopTracing();
Assert.equal(toggles.length, 2);
Assert.equal(toggles[1], false);
info("Recall code after stop, no more traces are logged");
sandbox.foo();
Assert.equal(frames.length, 0);
info("Start tracing again, and recall code");
startTracing({ global: sandbox, prefix: "testContentPrefix" });
sandbox.foo();
info("New traces are logged");
Assert.equal(frames.length, 2);
info("Unregister the listener and recall code");
removeTracingListener(listener);
sandbox.foo();
info("No more traces are logged");
Assert.equal(frames.length, 2);
info("Stop tracing");
stopTracing();
});
add_task(async function testTracingJSMGlobal() {
// We have to register the listener code in a sandbox, i.e. in a distinct global
// so that we aren't creating traces when tracer calls it. (and cause infinite loops)
const systemPrincipal = Services.scriptSecurityManager.getSystemPrincipal();
const listenerSandbox = Cu.Sandbox(systemPrincipal);
Cu.evalInSandbox(
"new " +
function () {
globalThis.toggles = [];
globalThis.frames = [];
globalThis.listener = {
onTracingToggled(state) {
globalThis.toggles.push(state);
},
onTracingFrame(frameInfo) {
globalThis.frames.push(frameInfo);
},
};
},
listenerSandbox
);
info("Register a tracing listener");
addTracingListener(listenerSandbox.listener);
info("Start tracing");
startTracing({ global: null, prefix: "testPrefix" });
Assert.equal(listenerSandbox.toggles.length, 1);
Assert.equal(listenerSandbox.toggles[0], true);
info("Call some code");
function bar() {}
function foo() {
bar();
}
foo();
// Note that the tracer will record the two Assert.equal and the info calls.
// So only assert the last two frames.
const lastFrame = listenerSandbox.frames.at(-1);
const beforeLastFrame = listenerSandbox.frames.at(-2);
Assert.equal(beforeLastFrame.depth, 7);
Assert.equal(beforeLastFrame.formatedDisplayName, "λ foo");
Assert.equal(beforeLastFrame.prefix, "testPrefix: ");
Assert.ok(beforeLastFrame.frame);
Assert.equal(lastFrame.depth, 8);
Assert.equal(lastFrame.formatedDisplayName, "λ bar");
Assert.equal(lastFrame.prefix, "testPrefix: ");
Assert.ok(lastFrame.frame);
info("Stop tracing");
stopTracing();
Assert.equal(listenerSandbox.toggles.length, 2);
Assert.equal(listenerSandbox.toggles[1], false);
removeTracingListener(listenerSandbox.listener);
});
add_task(async function testTracingValues() {
// Test the `traceValues` flag
const sandbox = Cu.Sandbox("https://example.com");
Cu.evalInSandbox(
`function foo() { bar(-0, 1, ["array"], { attribute: 3 }, "4", BigInt(5), Symbol("6"), Infinity, undefined, null, false, NaN, function foo() {}, function () {}, class MyClass {}); }; function bar(a, b, c) {}`,
sandbox
);
// Pass an override method to catch all strings tentatively logged to stdout
const logs = [];
function loggingMethod(str) {
logs.push(str);
}
info("Start tracing");
startTracing({ global: sandbox, traceValues: true, loggingMethod });
info("Call some code");
sandbox.foo();
Assert.equal(logs.length, 3);
Assert.equal(logs[0], "Start tracing JavaScript\n");
Assert.stringContains(logs[1], "λ foo()");
Assert.stringContains(
logs[2],
`λ bar(-0, 1, Array(1), [object Object], "4", BigInt(5), Symbol(6), Infinity, undefined, null, false, NaN, function foo(), function anonymous(), class MyClass)`
);
info("Stop tracing");
stopTracing();
});
add_task(async function testTracingFunctionReturn() {
// Test the `traceFunctionReturn` flag
const sandbox = Cu.Sandbox("https://example.com");
Cu.evalInSandbox(
`function foo() { bar(); return 0 } function bar() { return "string" }; foo();`,
sandbox
);
// Pass an override method to catch all strings tentatively logged to stdout
const logs = [];
function loggingMethod(str) {
logs.push(str);
}
info("Start tracing");
startTracing({ global: sandbox, traceFunctionReturn: true, loggingMethod });
info("Call some code");
sandbox.foo();
Assert.equal(logs.length, 5);
Assert.equal(logs[0], "Start tracing JavaScript\n");
Assert.stringContains(logs[1], "λ foo");
Assert.stringContains(logs[2], "λ bar");
Assert.stringContains(logs[3], `λ bar return`);
Assert.stringContains(logs[4], "λ foo return");
info("Stop tracing");
stopTracing();
});
add_task(async function testTracingFunctionReturnAndValues() {
// Test the `traceFunctionReturn` and `traceValues` flag
const sandbox = Cu.Sandbox("https://example.com");
Cu.evalInSandbox(
`function foo() { bar(); second(); } function bar() { return "string" }; function second() { return null; }; foo();`,
sandbox
);
// Pass an override method to catch all strings tentatively logged to stdout
const logs = [];
function loggingMethod(str) {
logs.push(str);
}
info("Start tracing");
startTracing({
global: sandbox,
traceFunctionReturn: true,
traceValues: true,
loggingMethod,
});
info("Call some code");
sandbox.foo();
Assert.equal(logs.length, 7);
Assert.equal(logs[0], "Start tracing JavaScript\n");
Assert.stringContains(logs[1], "λ foo()");
Assert.stringContains(logs[2], "λ bar()");
Assert.stringContains(logs[3], `λ bar return "string"`);
Assert.stringContains(logs[4], "λ second()");
Assert.stringContains(logs[5], `λ second return null`);
Assert.stringContains(logs[6], "λ foo return undefined");
info("Stop tracing");
stopTracing();
});
|
