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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
|
/* 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/. */
import { addDebuggerToGlobal } from "resource://gre/modules/jsdebugger.sys.mjs";
import { ContentProcessDomain } from "chrome://remote/content/cdp/domains/ContentProcessDomain.sys.mjs";
const lazy = {};
ChromeUtils.defineESModuleGetters(lazy, {
executeSoon: "chrome://remote/content/shared/Sync.sys.mjs",
isChromeFrame: "chrome://remote/content/shared/Stack.sys.mjs",
ExecutionContext:
"chrome://remote/content/cdp/domains/content/runtime/ExecutionContext.sys.mjs",
});
ChromeUtils.defineLazyGetter(lazy, "ConsoleAPIStorage", () => {
return Cc["@mozilla.org/consoleAPI-storage;1"].getService(
Ci.nsIConsoleAPIStorage
);
});
// Import the `Debugger` constructor in the current scope
// eslint-disable-next-line mozilla/reject-globalThis-modification
addDebuggerToGlobal(globalThis);
const CONSOLE_API_LEVEL_MAP = {
warn: "warning",
};
// Bug 1786299: Puppeteer needs specific error messages.
const ERROR_CONTEXT_NOT_FOUND = "Cannot find context with specified id";
class SetMap extends Map {
constructor() {
super();
this._count = 1;
}
// Every key in the map is associated with a Set.
// The first time `key` is used `obj.set(key, value)` maps `key` to
// to `Set(value)`. Subsequent calls add more values to the Set for `key`.
// Note that `obj.get(key)` will return undefined if there's no such key,
// as in a regular Map.
set(key, value) {
const innerSet = this.get(key);
if (innerSet) {
innerSet.add(value);
} else {
super.set(key, new Set([value]));
}
this._count++;
return this;
}
// used as ExecutionContext id
get count() {
return this._count;
}
}
export class Runtime extends ContentProcessDomain {
constructor(session) {
super(session);
this.enabled = false;
// Map of all the ExecutionContext instances:
// [id (Number) => ExecutionContext instance]
this.contexts = new Map();
// [innerWindowId (Number) => Set of ExecutionContext instances]
this.innerWindowIdToContexts = new SetMap();
this._onContextCreated = this._onContextCreated.bind(this);
this._onContextDestroyed = this._onContextDestroyed.bind(this);
// TODO Bug 1602083
this.session.contextObserver.on("context-created", this._onContextCreated);
this.session.contextObserver.on(
"context-destroyed",
this._onContextDestroyed
);
}
destructor() {
this.disable();
this.session.contextObserver.off("context-created", this._onContextCreated);
this.session.contextObserver.off(
"context-destroyed",
this._onContextDestroyed
);
super.destructor();
}
// commands
async enable() {
if (!this.enabled) {
this.enabled = true;
Services.console.registerListener(this);
this.onConsoleLogEvent = this.onConsoleLogEvent.bind(this);
lazy.ConsoleAPIStorage.addLogEventListener(
this.onConsoleLogEvent,
Cc["@mozilla.org/systemprincipal;1"].createInstance(Ci.nsIPrincipal)
);
// Spin the event loop in order to send the `executionContextCreated` event right
// after we replied to `enable` request.
lazy.executeSoon(() => {
this._onContextCreated("context-created", {
windowId: this.content.windowGlobalChild.innerWindowId,
window: this.content,
isDefault: true,
});
for (const message of lazy.ConsoleAPIStorage.getEvents()) {
this.onConsoleLogEvent(message);
}
});
}
}
disable() {
if (this.enabled) {
this.enabled = false;
Services.console.unregisterListener(this);
lazy.ConsoleAPIStorage.removeLogEventListener(this.onConsoleLogEvent);
}
}
releaseObject(options = {}) {
const { objectId } = options;
let context = null;
for (const ctx of this.contexts.values()) {
if (ctx.hasRemoteObject(objectId)) {
context = ctx;
break;
}
}
if (!context) {
throw new Error(ERROR_CONTEXT_NOT_FOUND);
}
context.releaseObject(objectId);
}
/**
* Calls function with given declaration on the given object.
*
* Object group of the result is inherited from the target object.
*
* @param {object} options
* @param {string} options.functionDeclaration
* Declaration of the function to call.
* @param {Array.<object>=} options.arguments
* Call arguments. All call arguments must belong to the same
* JavaScript world as the target object.
* @param {boolean=} options.awaitPromise
* Whether execution should `await` for resulting value
* and return once awaited promise is resolved.
* @param {number=} options.executionContextId
* Specifies execution context which global object will be used
* to call function on. Either executionContextId or objectId
* should be specified.
* @param {string=} options.objectId
* Identifier of the object to call function on.
* Either objectId or executionContextId should be specified.
* @param {boolean=} options.returnByValue
* Whether the result is expected to be a JSON object
* which should be sent by value.
*
* @returns {Object<RemoteObject, ExceptionDetails>}
*/
callFunctionOn(options = {}) {
if (typeof options.functionDeclaration != "string") {
throw new TypeError("functionDeclaration: string value expected");
}
if (
typeof options.arguments != "undefined" &&
!Array.isArray(options.arguments)
) {
throw new TypeError("arguments: array value expected");
}
if (!["undefined", "boolean"].includes(typeof options.awaitPromise)) {
throw new TypeError("awaitPromise: boolean value expected");
}
if (!["undefined", "number"].includes(typeof options.executionContextId)) {
throw new TypeError("executionContextId: number value expected");
}
if (!["undefined", "string"].includes(typeof options.objectId)) {
throw new TypeError("objectId: string value expected");
}
if (!["undefined", "boolean"].includes(typeof options.returnByValue)) {
throw new TypeError("returnByValue: boolean value expected");
}
if (
typeof options.executionContextId == "undefined" &&
typeof options.objectId == "undefined"
) {
throw new Error(
"Either objectId or executionContextId must be specified"
);
}
let context = null;
// When an `objectId` is passed, we want to execute the function of a given object
// So we first have to find its ExecutionContext
if (options.objectId) {
for (const ctx of this.contexts.values()) {
if (ctx.hasRemoteObject(options.objectId)) {
context = ctx;
break;
}
}
} else {
context = this.contexts.get(options.executionContextId);
}
if (!context) {
throw new Error(ERROR_CONTEXT_NOT_FOUND);
}
return context.callFunctionOn(
options.functionDeclaration,
options.arguments,
options.returnByValue,
options.awaitPromise,
options.objectId
);
}
/**
* Evaluate expression on global object.
*
* @param {object} options
* @param {string} options.expression
* Expression to evaluate.
* @param {boolean=} options.awaitPromise
* Whether execution should `await` for resulting value
* and return once awaited promise is resolved.
* @param {number=} options.contextId
* Specifies in which execution context to perform evaluation.
* If the parameter is omitted the evaluation will be performed
* in the context of the inspected page.
* @param {boolean=} options.returnByValue
* Whether the result is expected to be a JSON object
* that should be sent by value. Defaults to false.
* @param {boolean=} options.userGesture [unsupported]
* Whether execution should be treated as initiated by user in the UI.
*
* @returns {Object<RemoteObject, exceptionDetails>}
* The evaluation result, and optionally exception details.
*/
evaluate(options = {}) {
const {
expression,
awaitPromise = false,
contextId,
returnByValue = false,
} = options;
if (typeof expression != "string") {
throw new Error("expression: string value expected");
}
if (!["undefined", "boolean"].includes(typeof options.awaitPromise)) {
throw new TypeError("awaitPromise: boolean value expected");
}
if (typeof returnByValue != "boolean") {
throw new Error("returnByValue: boolean value expected");
}
let context;
if (typeof contextId != "undefined") {
context = this.contexts.get(contextId);
if (!context) {
throw new Error(ERROR_CONTEXT_NOT_FOUND);
}
} else {
context = this._getDefaultContextForWindow();
}
return context.evaluate(expression, awaitPromise, returnByValue);
}
getProperties(options = {}) {
const { objectId, ownProperties } = options;
for (const ctx of this.contexts.values()) {
const debuggerObj = ctx.getRemoteObject(objectId);
if (debuggerObj) {
return ctx.getProperties({ objectId, ownProperties });
}
}
return null;
}
/**
* Internal methods: the following methods are not part of CDP;
* note the _ prefix.
*/
get _debugger() {
if (this.__debugger) {
return this.__debugger;
}
this.__debugger = new Debugger();
return this.__debugger;
}
_buildExceptionStackTrace(stack) {
const callFrames = [];
while (
stack &&
stack.source !== "debugger eval code" &&
!stack.source.startsWith("chrome://")
) {
callFrames.push({
functionName: stack.functionDisplayName,
scriptId: stack.sourceId.toString(),
url: stack.source,
lineNumber: stack.line - 1,
columnNumber: stack.column - 1,
});
stack = stack.parent || stack.asyncParent;
}
return {
callFrames,
};
}
_buildConsoleStackTrace(stack = []) {
const callFrames = stack
.filter(frame => !lazy.isChromeFrame(frame))
.map(frame => {
return {
functionName: frame.functionName,
scriptId: frame.sourceId.toString(),
url: frame.filename,
lineNumber: frame.lineNumber - 1,
columnNumber: frame.columnNumber - 1,
};
});
return {
callFrames,
};
}
_getRemoteObject(objectId) {
for (const ctx of this.contexts.values()) {
const debuggerObj = ctx.getRemoteObject(objectId);
if (debuggerObj) {
return debuggerObj;
}
}
return null;
}
_serializeRemoteObject(debuggerObj, executionContextId) {
const ctx = this.contexts.get(executionContextId);
return ctx._toRemoteObject(debuggerObj);
}
_getRemoteObjectByNodeId(nodeId, executionContextId) {
let debuggerObj = null;
if (typeof executionContextId != "undefined") {
const ctx = this.contexts.get(executionContextId);
debuggerObj = ctx.getRemoteObjectByNodeId(nodeId);
} else {
for (const ctx of this.contexts.values()) {
const obj = ctx.getRemoteObjectByNodeId(nodeId);
if (obj) {
debuggerObj = obj;
break;
}
}
}
return debuggerObj;
}
_setRemoteObject(debuggerObj, context) {
return context.setRemoteObject(debuggerObj);
}
_getDefaultContextForWindow(innerWindowId) {
if (!innerWindowId) {
innerWindowId = this.content.windowGlobalChild.innerWindowId;
}
const curContexts = this.innerWindowIdToContexts.get(innerWindowId);
if (curContexts) {
for (const ctx of curContexts) {
if (ctx.isDefault) {
return ctx;
}
}
}
return null;
}
_getContextsForFrame(frameId) {
const frameContexts = [];
for (const ctx of this.contexts.values()) {
if (ctx.frameId == frameId) {
frameContexts.push(ctx);
}
}
return frameContexts;
}
_emitConsoleAPICalled(payload) {
// Filter out messages that aren't coming from a valid inner window, or from
// a different browser tab. Also messages of type "time", which are not
// getting reported by Chrome.
const curBrowserId = this.session.browsingContext.browserId;
const win = Services.wm.getCurrentInnerWindowWithId(payload.innerWindowId);
if (
!win ||
BrowsingContext.getFromWindow(win).browserId != curBrowserId ||
payload.type === "time"
) {
return;
}
const context = this._getDefaultContextForWindow();
this.emit("Runtime.consoleAPICalled", {
args: payload.arguments.map(arg => context._toRemoteObject(arg)),
executionContextId: context?.id || 0,
timestamp: payload.timestamp,
type: payload.type,
stackTrace: this._buildConsoleStackTrace(payload.stack),
});
}
_emitExceptionThrown(payload) {
// Filter out messages that aren't coming from a valid inner window, or from
// a different browser tab. Also messages of type "time", which are not
// getting reported by Chrome.
const curBrowserId = this.session.browsingContext.browserId;
const win = Services.wm.getCurrentInnerWindowWithId(payload.innerWindowId);
if (!win || BrowsingContext.getFromWindow(win).browserId != curBrowserId) {
return;
}
const context = this._getDefaultContextForWindow();
this.emit("Runtime.exceptionThrown", {
timestamp: payload.timestamp,
exceptionDetails: {
// Temporary placeholder to return a number.
exceptionId: 0,
text: payload.text,
lineNumber: payload.lineNumber,
columnNumber: payload.columnNumber,
url: payload.url,
stackTrace: this._buildExceptionStackTrace(payload.stack),
executionContextId: context?.id || undefined,
},
});
}
/**
* Helper method in order to instantiate the ExecutionContext for a given
* DOM Window as well as emitting the related
* `Runtime.executionContextCreated` event
*
* @param {string} name
* Event name
* @param {object=} options
* @param {number} options.windowId
* The inner window id of the newly instantiated document.
* @param {Window} options.window
* The window object of the newly instantiated document.
* @param {string=} options.contextName
* Human-readable name to describe the execution context.
* @param {boolean=} options.isDefault
* Whether the execution context is the default one.
* @param {string=} options.contextType
* "default" or "isolated"
*
* @returns {number} ID of created context
*
*/
_onContextCreated(name, options = {}) {
const {
windowId,
window,
contextName = "",
isDefault = true,
contextType = "default",
} = options;
if (windowId === undefined) {
throw new Error("windowId is required");
}
// allow only one default context per inner window
if (isDefault && this.innerWindowIdToContexts.has(windowId)) {
for (const ctx of this.innerWindowIdToContexts.get(windowId)) {
if (ctx.isDefault) {
return null;
}
}
}
const context = new lazy.ExecutionContext(
this._debugger,
window,
this.innerWindowIdToContexts.count,
isDefault
);
this.contexts.set(context.id, context);
this.innerWindowIdToContexts.set(windowId, context);
if (this.enabled) {
this.emit("Runtime.executionContextCreated", {
context: {
id: context.id,
origin: window.origin,
name: contextName,
auxData: {
isDefault,
frameId: context.frameId,
type: contextType,
},
},
});
}
return context.id;
}
/**
* Helper method to destroy the ExecutionContext of the given id. Also emit
* the related `Runtime.executionContextDestroyed` and
* `Runtime.executionContextsCleared` events.
* ContextObserver will call this method with either `id` or `frameId` argument
* being set.
*
* @param {string} name
* Event name
* @param {object=} options
* @param {number} options.id
* The execution context id to destroy.
* @param {number} options.windowId
* The inner-window id of the execution context to destroy.
* @param {number} options.frameId
* The frame id of execution context to destroy.
* Either `id` or `frameId` or `windowId` is passed.
*/
_onContextDestroyed(name, { id, frameId, windowId }) {
let contexts;
if ([id, frameId, windowId].filter(id => !!id).length > 1) {
throw new Error("Expects only *one* of id, frameId, windowId");
}
if (id) {
contexts = [this.contexts.get(id)];
} else if (frameId) {
contexts = this._getContextsForFrame(frameId);
} else {
contexts = this.innerWindowIdToContexts.get(windowId) || [];
}
for (const ctx of contexts) {
const isFrame = !!BrowsingContext.get(ctx.frameId).parent;
ctx.destructor();
this.contexts.delete(ctx.id);
this.innerWindowIdToContexts.get(ctx.windowId).delete(ctx);
if (this.enabled) {
this.emit("Runtime.executionContextDestroyed", {
executionContextId: ctx.id,
});
}
if (this.innerWindowIdToContexts.get(ctx.windowId).size == 0) {
this.innerWindowIdToContexts.delete(ctx.windowId);
// Only emit when all the exeuction contexts were cleared for the
// current browser / target, which means it should only be emitted
// for a top-level browsing context reference.
if (this.enabled && !isFrame) {
this.emit("Runtime.executionContextsCleared");
}
}
}
}
onConsoleLogEvent(message) {
// From sendConsoleAPIMessage (toolkit/modules/Console.sys.mjs)
this._emitConsoleAPICalled({
arguments: message.arguments,
innerWindowId: message.innerID,
stack: message.stacktrace,
timestamp: message.timeStamp,
type: CONSOLE_API_LEVEL_MAP[message.level] || message.level,
});
}
// nsIObserver
/**
* Takes a console message belonging to the current window and emits a
* "exceptionThrown" event if it's a Javascript error, otherwise a
* "consoleAPICalled" event.
*
* @param {nsIConsoleMessage} subject
* Console message.
*/
observe(subject) {
if (subject instanceof Ci.nsIScriptError && subject.hasException) {
let entry = fromScriptError(subject);
this._emitExceptionThrown(entry);
}
}
// XPCOM
get QueryInterface() {
return ChromeUtils.generateQI(["nsIConsoleListener"]);
}
}
function fromScriptError(error) {
// From dom/bindings/nsIScriptError.idl
return {
innerWindowId: error.innerWindowID,
columnNumber: error.columnNumber - 1,
lineNumber: error.lineNumber - 1,
stack: error.stack,
text: error.errorMessage,
timestamp: error.timeStamp,
url: error.sourceName,
};
}
|