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
|
/* 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/. */
"use strict";
const {
TYPES: { SOURCE },
} = require("resource://devtools/server/actors/resources/index.js");
const Targets = require("resource://devtools/server/actors/targets/index.js");
const {
STATES: THREAD_STATES,
} = require("resource://devtools/server/actors/thread.js");
/**
* Start watching for all JS sources related to a given Target Actor.
* This will notify about existing sources, but also the ones created in future.
*
* @param TargetActor targetActor
* The target actor from which we should observe sources
* @param Object options
* Dictionary object with following attributes:
* - onAvailable: mandatory function
* This will be called for each resource.
*/
class SourceWatcher {
constructor() {
this.onNewSource = this.onNewSource.bind(this);
}
async watch(targetActor, { onAvailable }) {
// When debugging the whole browser, we instantiate both content process and browsing context targets.
// But sources will only be debugged the content process target, even browsing context sources.
if (
targetActor.sessionContext.type == "all" &&
targetActor.targetType === Targets.TYPES.FRAME &&
targetActor.typeName != "parentProcessTarget"
) {
return;
}
const { threadActor } = targetActor;
this.sourcesManager = targetActor.sourcesManager;
this.onAvailable = onAvailable;
// Disable `ThreadActor.newSource` RDP event in order to avoid unnecessary traffic
threadActor.disableNewSourceEvents();
threadActor.sourcesManager.on("newSource", this.onNewSource);
// If the thread actors isn't bootstraped yet,
// (this might be the case when this watcher is created on target creation)
// attach the thread actor automatically.
// Otherwise it would not notify about future sources.
// However, do not attach the thread actor for Workers. They use a codepath
// which releases the worker on `attach`. For them, the client will call `attach`. (bug 1691986)
// Content process targets don't have attach method or sequence.
// Instead their thread actor is instantiated immediately, when generating their
// form. Which is called immediately when we notify the target actor to the TargetList.
const isTargetCreation = threadActor.state == THREAD_STATES.DETACHED;
if (isTargetCreation && !targetActor.targetType.endsWith("worker")) {
await threadActor.attach({});
}
// Before fetching all sources, process existing ones.
// The ThreadActor is already up and running before this code runs
// and have sources already registered and for which newSource event already fired.
onAvailable(
threadActor.sourcesManager.iter().map(s => {
const resource = s.form();
resource.resourceType = SOURCE;
return resource;
})
);
// Requesting all sources should end up emitting newSource on threadActor.sourcesManager
threadActor.addAllSources();
}
/**
* Stop watching for sources
*/
destroy() {
if (this.sourcesManager) {
this.sourcesManager.off("newSource", this.onNewSource);
}
}
onNewSource(source) {
const resource = source.form();
resource.resourceType = SOURCE;
this.onAvailable([resource]);
}
}
module.exports = SourceWatcher;
|
