-
Notifications
You must be signed in to change notification settings - Fork 388
/
web-channel.js
358 lines (320 loc) · 9.89 KB
/
web-channel.js
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
/* 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/. */
// @flow
import type { SymbolTableAsTuple } from '../profile-logic/symbol-store-db';
import type {
Milliseconds,
MixedObject,
ExternalMarkersData,
} from 'firefox-profiler/types';
/**
* This file is in charge of handling the message managing between profiler.firefox.com
* and the browser internals. This is done through a WebChannel mechanism. This mechanism
* allows us to safely send messages between the browser and an allowed domain.
*/
export type MessageToBrowser = {|
requestId: number,
|} & Request;
export type Request =
| StatusQueryRequest
| EnableMenuButtonRequest
| GetProfileRequest
| GetExternalMarkersRequest
| GetExternalPowerTracksRequest
| GetSymbolTableRequest
| QuerySymbolicationApiRequest;
type StatusQueryRequest = {| type: 'STATUS_QUERY' |};
type EnableMenuButtonRequest = {| type: 'ENABLE_MENU_BUTTON' |};
type GetProfileRequest = {| type: 'GET_PROFILE' |};
type GetExternalMarkersRequest = {|
type: 'GET_EXTERNAL_MARKERS',
startTime: Milliseconds,
endTime: Milliseconds,
|};
type GetExternalPowerTracksRequest = {|
type: 'GET_EXTERNAL_POWER_TRACKS',
startTime: Milliseconds,
endTime: Milliseconds,
|};
type GetSymbolTableRequest = {|
type: 'GET_SYMBOL_TABLE',
debugName: string,
breakpadId: string,
|};
type QuerySymbolicationApiRequest = {|
type: 'QUERY_SYMBOLICATION_API',
path: string,
requestJson: string,
|};
export type MessageFromBrowser<R: ResponseFromBrowser> =
| OutOfBandErrorMessageFromBrowser
| ErrorResponseMessageFromBrowser
| SuccessResponseMessageFromBrowser<R>;
type OutOfBandErrorMessageFromBrowser = {|
errno: number,
error: string,
|};
type ErrorResponseMessageFromBrowser = {|
type: 'ERROR_RESPONSE',
requestId: number,
error: string,
|};
type SuccessResponseMessageFromBrowser<R: ResponseFromBrowser> = {
type: 'SUCCESS_RESPONSE',
requestId: number,
response: R,
};
export type ResponseFromBrowser =
| StatusQueryResponse
| EnableMenuButtonResponse
| GetProfileResponse
| GetExternalMarkersResponse
| GetExternalPowerTracksResponse
| GetSymbolTableResponse
| QuerySymbolicationApiResponse;
type StatusQueryResponse = {|
menuButtonIsEnabled: boolean,
// The version indicates which message types are supported by the browser.
// No version:
// Shipped in Firefox 76.
// Supports the following message types:
// - STATUS_QUERY
// - ENABLE_MENU_BUTTON
// Version 1:
// Shipped in Firefox 93.
// Adds support for the following message types:
// - GET_PROFILE
// - GET_SYMBOL_TABLE
// - QUERY_SYMBOLICATION_API
// Version 2:
// Shipped in Firefox 121.
// Adds support for the following message types:
// - GET_EXTERNAL_POWER_TRACKS
// Version 3:
// Shipped in Firefox 125.
// Adds support for the following message types:
// - GET_EXTERNAL_MARKERS
version?: number,
|};
type EnableMenuButtonResponse = void;
type GetProfileResponse = ArrayBuffer | MixedObject;
type GetExternalMarkersResponse = ExternalMarkersData;
type GetExternalPowerTracksResponse = MixedObject[];
type GetSymbolTableResponse = SymbolTableAsTuple;
type QuerySymbolicationApiResponse = string;
// Manually declare all pairs of request + response for Flow.
/* eslint-disable no-redeclare */
declare function _sendMessageWithResponse(
StatusQueryRequest
): Promise<StatusQueryResponse>;
declare function _sendMessageWithResponse(
EnableMenuButtonRequest
): Promise<EnableMenuButtonResponse>;
declare function _sendMessageWithResponse(
GetProfileRequest
): Promise<GetProfileResponse>;
declare function _sendMessageWithResponse(
GetExternalMarkersRequest
): Promise<GetExternalMarkersResponse>;
declare function _sendMessageWithResponse(
GetExternalPowerTracksRequest
): Promise<GetExternalPowerTracksResponse>;
declare function _sendMessageWithResponse(
GetSymbolTableRequest
): Promise<GetSymbolTableResponse>;
declare function _sendMessageWithResponse(
QuerySymbolicationApiRequest
): Promise<QuerySymbolicationApiResponse>;
/* eslint-enable no-redeclare */
/**
* Ask the browser if the menu button is enabled.
*/
export async function queryIsMenuButtonEnabled(): Promise<boolean> {
const response = await _sendMessageWithResponse({
type: 'STATUS_QUERY',
});
return response.menuButtonIsEnabled;
}
/**
* Enable the profiler menu button.
*/
export async function enableMenuButton(): Promise<void> {
await _sendMessageWithResponse({
type: 'ENABLE_MENU_BUTTON',
});
// The response does not return any additional information other than we know
// the request was handled.
}
/**
* Ask the browser for the web channel version.
*/
export async function queryWebChannelVersionViaWebChannel(): Promise<number> {
const response = await _sendMessageWithResponse({
type: 'STATUS_QUERY',
});
return response.version || 0;
}
export async function getSymbolTableViaWebChannel(
debugName: string,
breakpadId: string
): Promise<SymbolTableAsTuple> {
return _sendMessageWithResponse({
type: 'GET_SYMBOL_TABLE',
debugName,
breakpadId,
});
}
export async function getProfileViaWebChannel(): Promise<
ArrayBuffer | MixedObject,
> {
return _sendMessageWithResponse({
type: 'GET_PROFILE',
});
}
export async function getExternalMarkersViaWebChannel(
startTime: Milliseconds,
endTime: Milliseconds
): Promise<ExternalMarkersData> {
return _sendMessageWithResponse({
type: 'GET_EXTERNAL_MARKERS',
startTime,
endTime,
});
}
export async function getExternalPowerTracksViaWebChannel(
startTime: Milliseconds,
endTime: Milliseconds
): Promise<MixedObject[]> {
return _sendMessageWithResponse({
type: 'GET_EXTERNAL_POWER_TRACKS',
startTime,
endTime,
});
}
export async function querySymbolicationApiViaWebChannel(
path: string,
requestJson: string
): Promise<string> {
return _sendMessageWithResponse({
type: 'QUERY_SYMBOLICATION_API',
path,
requestJson,
});
}
/**
* -----------------------------------------------------------------------------
*
* Everything below here is implementation logic for handling messages with from
* the WebChannel mechanism.
*/
const LOG_STYLE = 'font-weight: bold; color: #0a6';
/**
* Send a message to the browser through the WebChannel.
*/
function _sendMessage(message: MessageToBrowser) {
if (process.env.NODE_ENV === 'development') {
console.log(`[webchannel] %csending "${message.type}"`, LOG_STYLE, message);
}
window.dispatchEvent(
new CustomEvent('WebChannelMessageToChrome', {
detail: JSON.stringify({
id: 'profiler.firefox.com',
message,
}),
})
);
}
let _requestId = 0;
export class WebChannelError extends Error {
name = 'WebChannelError';
errno: number;
constructor(rawError: OutOfBandErrorMessageFromBrowser) {
super(`${rawError.error} (errno: ${rawError.errno})`);
this.errno = rawError.errno;
}
}
// eslint-disable-next-line no-redeclare
function _sendMessageWithResponse(
Request: Request
): Promise<ResponseFromBrowser> {
const requestId = _requestId++;
const type = Request.type;
return new Promise((resolve, reject) => {
function listener(event) {
const { id, message } = event.detail;
// Don't trust the message too much, and do some checking for known properties.
if (
id === 'profiler.firefox.com' &&
message &&
typeof message === 'object'
) {
_fixupOldResponseMessageIfNeeded(message);
// Make the type system assume that we have the right message.
const messageFromBrowser: MessageFromBrowser<ResponseFromBrowser> =
(message: any);
if (messageFromBrowser.type) {
if (messageFromBrowser.requestId === requestId) {
if (process.env.NODE_ENV === 'development') {
console.log(
`[webchannel] %creceived response to "${type}"`,
LOG_STYLE,
messageFromBrowser
);
}
window.removeEventListener(
'WebChannelMessageToContent',
listener,
true
);
if (messageFromBrowser.type === 'SUCCESS_RESPONSE') {
resolve(messageFromBrowser.response);
} else {
reject(new Error(messageFromBrowser.error));
}
}
} else if (typeof messageFromBrowser.error === 'string') {
// There was some kind of error with the message. This is expected for older
// versions of Firefox that don't have this WebChannel set up yet, or
// if the about:config preference points to a different URL.
console.error(
`[webchannel] %c${messageFromBrowser.error}`,
LOG_STYLE
);
window.removeEventListener(
'WebChannelMessageToContent',
listener,
true
);
reject(new WebChannelError(messageFromBrowser));
}
} else {
reject(new Error('A malformed WebChannel event was received.'));
console.error(
`[webchannel] %cmalformed event received`,
LOG_STYLE,
event
);
}
}
window.addEventListener('WebChannelMessageToContent', listener, true);
// Add the requestId to the message.
_sendMessage(
({
requestId,
...Request,
}: any)
);
});
}
// This can be removed once the oldest supported Firefox ESR version is 93 or newer.
function _fixupOldResponseMessageIfNeeded(message: MixedObject) {
if (message.type === 'STATUS_RESPONSE') {
const { menuButtonIsEnabled } = message;
message.type = 'SUCCESS_RESPONSE';
message.response = { menuButtonIsEnabled };
} else if (message.type === 'ENABLE_MENU_BUTTON_DONE') {
message.type = 'SUCCESS_RESPONSE';
message.response = undefined;
}
}