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
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
const {
createCommandsForTab,
STUBS_UPDATE_ENV,
getCleanedPacket,
getSerializedPacket,
getStubFile,
writeStubsToFile,
} = require(`${CHROME_URL_ROOT}stub-generator-helpers`);
const TEST_URI =
"https://example.com/browser/devtools/client/webconsole/test/browser/stub-generators/test-network-event.html";
const STUB_FILE = "networkEvent.js";
add_task(async function () {
const isStubsUpdate = Services.env.get(STUBS_UPDATE_ENV) == "true";
info(`${isStubsUpdate ? "Update" : "Check"} ${STUB_FILE}`);
const generatedStubs = await generateNetworkEventStubs();
if (isStubsUpdate) {
await writeStubsToFile(STUB_FILE, generatedStubs, true);
ok(true, `${STUB_FILE} was updated`);
return;
}
const existingStubs = getStubFile(STUB_FILE);
const FAILURE_MSG =
"The network event stubs file needs to be updated by running `" +
`mach test ${getCurrentTestFilePath()} --headless --setenv WEBCONSOLE_STUBS_UPDATE=true` +
"`";
if (generatedStubs.size !== existingStubs.stubPackets.size) {
ok(false, FAILURE_MSG);
return;
}
let failed = false;
for (const [key, packet] of generatedStubs) {
// const existingPacket = existingStubs.stubPackets.get(key);
const packetStr = getSerializedPacket(packet, {
sortKeys: true,
replaceActorIds: true,
});
const existingPacketStr = getSerializedPacket(
existingStubs.stubPackets.get(key),
{ sortKeys: true, replaceActorIds: true }
);
is(packetStr, existingPacketStr, `"${key}" packet has expected value`);
failed = failed || packetStr !== existingPacketStr;
}
if (failed) {
ok(false, FAILURE_MSG);
} else {
ok(true, "Stubs are up to date");
}
});
async function generateNetworkEventStubs() {
const stubs = new Map();
const tab = await addTab(TEST_URI);
const commands = await createCommandsForTab(tab);
await commands.targetCommand.startListening();
const resourceCommand = commands.resourceCommand;
const stacktraces = new Map();
let addNetworkStub = function () {};
let addNetworkUpdateStub = function () {};
const onAvailable = resources => {
for (const resource of resources) {
if (resource.resourceType == resourceCommand.TYPES.NETWORK_EVENT) {
if (stacktraces.has(resource.channelId)) {
const { stacktraceAvailable, lastFrame } = stacktraces.get(
resource.channelId
);
resource.cause.stacktraceAvailable = stacktraceAvailable;
resource.cause.lastFrame = lastFrame;
stacktraces.delete(resource.channelId);
}
addNetworkStub(resource);
continue;
}
if (
resource.resourceType == resourceCommand.TYPES.NETWORK_EVENT_STACKTRACE
) {
stacktraces.set(resource.channelId, resource);
}
}
};
const onUpdated = updates => {
for (const { resource } of updates) {
addNetworkUpdateStub(resource);
}
};
await resourceCommand.watchResources(
[
resourceCommand.TYPES.NETWORK_EVENT_STACKTRACE,
resourceCommand.TYPES.NETWORK_EVENT,
],
{
onAvailable,
onUpdated,
}
);
for (const [key, code] of getCommands()) {
const networkEventDone = new Promise(resolve => {
addNetworkStub = resource => {
stubs.set(key, getCleanedPacket(key, getOrderedResource(resource)));
resolve();
};
});
const networkEventUpdateDone = new Promise(resolve => {
addNetworkUpdateStub = resource => {
const updateKey = `${key} update`;
stubs.set(key, getCleanedPacket(key, getOrderedResource(resource)));
stubs.set(
updateKey,
// We cannot ensure the form of the resource, some properties
// might be in another order than in the original resource.
// Hand-picking only what we need should prevent this.
getCleanedPacket(updateKey, getOrderedResource(resource))
);
resolve();
};
});
await SpecialPowers.spawn(
gBrowser.selectedBrowser,
[code],
function (subCode) {
const script = content.document.createElement("script");
script.append(
content.document.createTextNode(
`function triggerPacket() {${subCode}}`
)
);
content.document.body.append(script);
content.wrappedJSObject.triggerPacket();
script.remove();
}
);
await Promise.all([networkEventDone, networkEventUpdateDone]);
}
resourceCommand.unwatchResources(
[
resourceCommand.TYPES.NETWORK_EVENT_STACKTRACE,
resourceCommand.TYPES.NETWORK_EVENT,
],
{
onAvailable,
onUpdated,
}
);
await commands.destroy();
return stubs;
}
// Ensures the order of the resource properties
function getOrderedResource(resource) {
return {
resourceType: resource.resourceType,
timeStamp: resource.timeStamp,
actor: resource.actor,
startedDateTime: resource.startedDateTime,
method: resource.method,
url: resource.url,
isXHR: resource.isXHR,
cause: resource.cause,
httpVersion: resource.httpVersion,
status: resource.status,
statusText: resource.statusText,
headersSize: resource.headersSize,
remoteAddress: resource.remoteAddress,
remotePort: resource.remotePort,
mimeType: resource.mimeType,
waitingTime: resource.waitingTime,
contentSize: resource.contentSize,
transferredSize: resource.transferredSize,
timings: resource.timings,
private: resource.private,
fromCache: resource.fromCache,
fromServiceWorker: resource.fromServiceWorker,
isThirdPartyTrackingResource: resource.isThirdPartyTrackingResource,
referrerPolicy: resource.referrerPolicy,
blockedReason: resource.blockedReason,
blockingExtension: resource.blockingExtension,
channelId: resource.channelId,
totalTime: resource.totalTime,
securityState: resource.securityState,
responseCache: resource.responseCache,
isRacing: resource.isRacing,
};
}
function getCommands() {
const networkEvent = new Map();
networkEvent.set(
"GET request",
`
let i = document.createElement("img");
i.src = "/inexistent.html";
`
);
networkEvent.set(
"XHR GET request",
`
const xhr = new XMLHttpRequest();
xhr.open("GET", "/inexistent.html");
xhr.send();
`
);
networkEvent.set(
"XHR POST request",
`
const xhr = new XMLHttpRequest();
xhr.open("POST", "/inexistent.html");
xhr.send();
`
);
return networkEvent;
}
|
