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
|
/* 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";
loader.lazyRequireGetter(
this,
"NetworkObserver",
"devtools/server/actors/network-monitor/network-observer",
true
);
loader.lazyRequireGetter(
this,
"NetworkEventActor",
"devtools/server/actors/network-monitor/network-event-actor",
true
);
class NetworkEventWatcher {
/**
* Start watching for all network events related to a given Watcher Actor.
*
* @param WatcherActor watcherActor
* The watcher actor in the parent process from which we should
* observe network events.
* @param Object options
* Dictionary object with following attributes:
* - onAvailable: mandatory function
* This will be called for each resource.
* - onUpdated: optional function
* This would be called multiple times for each resource.
*/
async watch(watcherActor, { onAvailable, onUpdated }) {
this.networkEvents = new Map();
this.watcherActor = watcherActor;
this.onNetworkEventAvailable = onAvailable;
this.onNetworkEventUpdated = onUpdated;
this.listener = new NetworkObserver(
{ browserId: watcherActor.browserId },
{ onNetworkEvent: this.onNetworkEvent.bind(this) }
);
this.listener.init();
}
/**
* Gets the throttle settings
*
* @return {*} data
*
*/
getThrottleData() {
return this.listener.throttleData;
}
/**
* Sets the throttle data
*
* @param {*} data
*
*/
setThrottleData(data) {
this.listener.throttleData = data;
}
/**
* Block requests based on the filters
* @param {Object} filters
*/
blockRequest(filters) {
this.listener.blockRequest(filters);
}
/**
* Unblock requests based on the fitlers
* @param {Object} filters
*/
unblockRequest(filters) {
this.listener.unblockRequest(filters);
}
/**
* Calls the listener to set blocked urls
*
* @param {Array} urls
* The urls to block
*/
setBlockedUrls(urls) {
this.listener.setBlockedUrls(urls);
}
/**
* Calls the listener to get the blocked urls
*
* @return {Array} urls
* The blocked urls
*/
getBlockedUrls() {
return this.listener.getBlockedUrls();
}
onNetworkEvent(event) {
const { channelId } = event;
if (this.networkEvents.has(channelId)) {
throw new Error(
`Got notified about channel ${channelId} more than once.`
);
}
const actor = new NetworkEventActor(
this,
{
onNetworkEventUpdate: this.onNetworkEventUpdate.bind(this),
onNetworkEventDestroy: this.onNetworkEventDestroy.bind(this),
},
event
);
this.watcherActor.manage(actor);
const resource = actor.asResource();
this.networkEvents.set(resource.resourceId, {
resourceId: resource.resourceId,
resourceType: resource.resourceType,
isBlocked: !!resource.blockedReason,
types: [],
resourceUpdates: {},
});
this.onNetworkEventAvailable([resource]);
return actor;
}
onNetworkEventUpdate(updateResource) {
const networkEvent = this.networkEvents.get(updateResource.resourceId);
if (!networkEvent) {
return;
}
const {
resourceId,
resourceType,
resourceUpdates,
types,
isBlocked,
} = networkEvent;
switch (updateResource.updateType) {
case "responseStart":
resourceUpdates.httpVersion = updateResource.httpVersion;
resourceUpdates.status = updateResource.status;
resourceUpdates.statusText = updateResource.statusText;
resourceUpdates.remoteAddress = updateResource.remoteAddress;
resourceUpdates.remotePort = updateResource.remotePort;
// The mimetype is only set when then the contentType is available
// in the _onResponseHeader and not for cached/service worker requests
// in _httpResponseExaminer.
resourceUpdates.mimeType = updateResource.mimeType;
resourceUpdates.waitingTime = updateResource.waitingTime;
break;
case "responseContent":
resourceUpdates.contentSize = updateResource.contentSize;
resourceUpdates.transferredSize = updateResource.transferredSize;
resourceUpdates.mimeType = updateResource.mimeType;
resourceUpdates.blockingExtension = updateResource.blockingExtension;
resourceUpdates.blockedReason = updateResource.blockedReason;
break;
case "eventTimings":
resourceUpdates.totalTime = updateResource.totalTime;
break;
case "securityInfo":
resourceUpdates.securityState = updateResource.state;
resourceUpdates.isRacing = updateResource.isRacing;
break;
}
resourceUpdates[`${updateResource.updateType}Available`] = true;
types.push(updateResource.updateType);
if (isBlocked) {
// Blocked requests
if (
!types.includes("requestHeaders") ||
!types.includes("requestCookies")
) {
return;
}
} else if (
// Un-blocked requests
!types.includes("requestHeaders") ||
!types.includes("requestCookies") ||
!types.includes("eventTimings") ||
!types.includes("responseContent")
) {
return;
}
this.onNetworkEventUpdated([
{
resourceType,
resourceId,
resourceUpdates,
},
]);
}
onNetworkEventDestroy(channelId) {
if (this.networkEvents.has(channelId)) {
this.networkEvents.delete(channelId);
}
}
/**
* Stop watching for network event related to a given Watcher Actor.
*
* @param WatcherActor watcherActor
* The watcher actor from which we should stop observing network events
*/
destroy(watcherActor) {
if (this.listener) {
this.listener.destroy();
}
}
}
module.exports = NetworkEventWatcher;
|
