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
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
|
/* 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/. */
/**
* This file contains the shared types for the performance-new client.
*/
import {
Reducer as ReduxReducer,
Store as ReduxStore,
} from "resource://devtools/client/shared/vendor/redux.js";
export interface PanelWindow {
gToolbox?: any;
gStore?: Store;
gInit(
perfFront: PerfFront,
traits: RootTraits,
pageContext: PageContext,
openAboutProfiling: () => void
): Promise<void>;
gDestroy(): void;
gIsPanelDestroyed?: boolean;
}
/**
* TS-TODO - Stub.
*/
export interface Target {
// TODO
client: any;
}
/**
* TS-TODO - Stub.
*/
export interface Toolbox {
target: Target;
}
/**
* TS-TODO - Stub.
*/
export interface Commands {
client: any;
targetCommand: {
targetFront: {
getTrait: (
traitName: string
) => unknown;
};
};
}
/**
* TS-TODO - Stub.
*/
export interface PerfFront {
startProfiler: (options: RecordingSettings) => Promise<boolean>;
getProfileAndStopProfiler: () => Promise<any>;
stopProfilerAndDiscardProfile: () => Promise<void>;
getSymbolTable: (
path: string,
breakpadId: string
) => Promise<[number[], number[], number[]]>;
isActive: () => Promise<boolean>;
isSupportedPlatform: () => Promise<boolean>;
on: (type: string, listener: () => void) => void;
off: (type: string, listener: () => void) => void;
destroy: () => void;
getSupportedFeatures: () => Promise<string[]>;
}
/**
* TS-TODO - Stub
*/
export interface PreferenceFront {
clearUserPref: (prefName: string) => Promise<void>;
getStringPref: (prefName: string) => Promise<string>;
setStringPref: (prefName: string, value: string) => Promise<void>;
getCharPref: (prefName: string) => Promise<string>;
setCharPref: (prefName: string, value: string) => Promise<void>;
getIntPref: (prefName: string) => Promise<number>;
setIntPref: (prefName: string, value: number) => Promise<void>;
}
export interface RootTraits {
// There are no traits used by the performance front end at the moment.
}
export type RecordingState =
// The initial state before we've queried the PerfActor
| "not-yet-known"
// The profiler is available, we haven't started recording yet.
| "available-to-record"
// An async request has been sent to start the profiler.
| "request-to-start-recording"
// An async request has been sent to get the profile and stop the profiler.
| "request-to-get-profile-and-stop-profiler"
// An async request has been sent to stop the profiler.
| "request-to-stop-profiler"
// The profiler notified us that our request to start it actually started
// it, or it was already started.
| "recording";
// We are currently migrating to a new UX workflow with about:profiling.
// This type provides an easy way to change the implementation based
// on context.
export type PageContext =
| "devtools"
| "devtools-remote"
| "aboutlogging"
| "aboutprofiling"
| "aboutprofiling-remote";
export type PrefPostfix = "" | ".remote";
export interface State {
recordingState: RecordingState;
recordingUnexpectedlyStopped: boolean;
isSupportedPlatform: boolean | null;
recordingSettings: RecordingSettings;
initializedValues: InitializedValues | null;
promptEnvRestart: null | string;
}
export type Selector<T> = (state: State) => T;
export type ThunkDispatch = <Returns>(action: ThunkAction<Returns>) => Returns;
export type PlainDispatch = (action: Action) => Action;
export type GetState = () => State;
export type SymbolTableAsTuple = [Uint32Array, Uint32Array, Uint8Array];
/**
* The `dispatch` function can accept either a plain action or a thunk action.
* This is similar to a type `(action: Action | ThunkAction) => any` except this
* allows to type the return value as well.
*/
export type Dispatch = PlainDispatch & ThunkDispatch;
export type ThunkAction<Returns> = ({
dispatch,
getState,
}: {
dispatch: Dispatch;
getState: GetState;
}) => Returns;
export interface Library {
start: number;
end: number;
offset: number;
name: string;
path: string;
debugName: string;
debugPath: string;
breakpadId: string;
arch: string;
}
/**
* Only provide types for the GeckoProfile as much as we need it. There is no
* reason to maintain a full type definition here.
*/
export interface MinimallyTypedGeckoProfile {
libs: Library[];
processes: MinimallyTypedGeckoProfile[];
}
export type GetSymbolTableCallback = (
debugName: string,
breakpadId: string
) => Promise<SymbolTableAsTuple>;
export interface SymbolicationService {
getSymbolTable: GetSymbolTableCallback;
querySymbolicationApi: (path: string, requestJson: string) => Promise<string>;
}
export type ReceiveProfile = (
geckoProfile: MinimallyTypedGeckoProfile,
profilerViewMode: ProfilerViewMode | undefined,
getSymbolTableCallback: GetSymbolTableCallback
) => void;
/**
* This is the type signature for a function to restart the browser with a given
* environment variable. Currently only implemented for the popup.
*/
export type RestartBrowserWithEnvironmentVariable = (
envName: string,
value: string
) => void;
/**
* This is the type signature for the event listener that's called once the
* profile has been obtained.
*/
export type OnProfileReceived = (profile: MinimallyTypedGeckoProfile) => void;
/**
* This is the type signature for a function to query the browser for the
* ID of the active tab.
*/
export type GetActiveBrowserID = () => number;
/**
* This interface is injected into profiler.firefox.com
*/
interface GeckoProfilerFrameScriptInterface {
getProfile: () => Promise<MinimallyTypedGeckoProfile>;
getSymbolTable: GetSymbolTableCallback;
}
export interface RecordingSettings {
presetName: string;
entries: number;
interval: number; // in milliseconds
features: string[];
threads: string[];
objdirs: string[];
// The duration is currently not wired up to the UI yet. See Bug 1587165.
duration?: number;
}
/**
* A Redux Reducer that knows about the performance-new client's Actions.
*/
export type Reducer<S> = (state: S | undefined, action: Action) => S;
export interface InitializedValues {
// The current list of presets, loaded in from a JSM.
presets: Presets;
// Determine the current page context.
pageContext: PageContext;
// The list of profiler features that the current target supports.
supportedFeatures: string[];
// Allow about:profiling to switch back to the remote devtools panel.
openRemoteDevTools?: () => void;
}
/**
* Export a store that is opinionated about our State definition, and the union
* of all Actions, as well as specific Dispatch behavior.
*/
export type Store = ReduxStore<State, Action>;
export type Action =
| {
type: "REPORT_PROFILER_READY";
isActive: boolean;
}
| {
type: "REPORT_PROFILER_STARTED";
}
| {
type: "REPORT_PROFILER_STOPPED";
}
| {
type: "REQUESTING_TO_START_RECORDING";
}
| {
type: "REQUESTING_TO_STOP_RECORDING";
}
| {
type: "REQUESTING_PROFILE";
}
| {
type: "OBTAINED_PROFILE";
}
| {
type: "CHANGE_INTERVAL";
interval: number;
}
| {
type: "CHANGE_ENTRIES";
entries: number;
}
| {
type: "CHANGE_FEATURES";
features: string[];
promptEnvRestart: string | null;
}
| {
type: "CHANGE_THREADS";
threads: string[];
}
| {
type: "CHANGE_OBJDIRS";
objdirs: string[];
}
| {
type: "INITIALIZE_STORE";
isSupportedPlatform: boolean;
presets: Presets;
pageContext: PageContext;
openRemoteDevTools?: () => void;
supportedFeatures: string[];
}
| {
type: "CHANGE_PRESET";
presetName: string;
preset: PresetDefinition | undefined;
}
| {
type: "UPDATE_SETTINGS_FROM_PREFERENCES";
recordingSettingsFromPreferences: RecordingSettings;
};
export interface InitializeStoreValues {
isSupportedPlatform: boolean;
presets: Presets;
pageContext: PageContext;
supportedFeatures: string[];
openRemoteDevTools?: () => void;
}
export type PopupBackgroundFeatures = { [feature: string]: boolean };
// TS-TODO - Stub
export interface ContentFrameMessageManager {
addMessageListener: (event: string, listener: (event: any) => void) => void;
addEventListener: (event: string, listener: (event: any) => void) => void;
sendAsyncMessage: (name: string, data: any) => void;
}
/**
* This interface serves as documentation for all of the prefs used by the
* performance-new client. Each preference access string access can be coerced to
* one of the properties of this interface.
*/
export interface PerformancePref {
/**
* The recording preferences by default are controlled by different presets.
* This pref stores that preset.
*/
Preset: "devtools.performance.recording.preset";
/**
* Stores the total number of entries to be used in the profile buffer.
*/
Entries: "devtools.performance.recording.entries";
/**
* The recording interval, stored in microseconds. Note that the StartProfiler
* interface uses milliseconds, but this lets us store higher precision numbers
* inside of an integer preference store.
*/
Interval: "devtools.performance.recording.interval";
/**
* The features enabled for the profiler, stored as a comma-separated list.
*/
Features: "devtools.performance.recording.features";
/**
* The threads to profile, stored as a comma-separated list.
*/
Threads: "devtools.performance.recording.threads";
/**
* The location of the objdirs to use, stored as a comma-separated list.
*/
ObjDirs: "devtools.performance.recording.objdirs";
/**
* The duration of the profiling window to use in seconds. Setting this to 0
* will cause no profile window to be used, and the values will naturally roll
* off from the profiling buffer.
*
* This is currently not hooked up to any UI. See Bug 1587165.
*/
Duration: "devtools.performance.recording.duration";
/**
* Normally this defaults to https://profiler.firefox.com, but this can be overridden
* to point the profiler to a different URL, such as http://localhost:4242/ for
* local development workflows.
*/
UIBaseUrl: "devtools.performance.recording.ui-base-url";
/**
* This pref allows tests to override the /from-browser in order to more easily
* test the profile injection mechanism.
*/
UIBaseUrlPathPref: "devtools.performance.recording.ui-base-url-path";
/**
* This controls whether we enable the active tab view when capturing in web
* developer preset.
* We're not enabling the active-tab view in all environments until we
* iron out all its issues.
*/
UIEnableActiveTabView: "devtools.performance.recording.active-tab-view.enabled";
/**
* The profiler popup has some introductory text explaining what it is the first
* time that you open it. After that, it is not displayed by default.
*/
PopupIntroDisplayed: "devtools.performance.popup.intro-displayed";
/**
* This preference is used outside of the performance-new type system
* (in DevToolsStartup). It toggles the availability of the profiler menu
* button in the customization palette.
*/
PopupFeatureFlag: "devtools.performance.popup.feature-flag";
}
/* The next 2 types bring some duplication from gecko.d.ts, but this is simpler
* this way. */
/**
* This is a function called by a preference observer.
*/
export type PrefObserverFunction = (
aSubject: nsIPrefBranch,
aTopic: "nsPref:changed",
aData: string
) => unknown;
/**
* This is the type of an observer we can pass to Service.prefs.addObserver and
* Service.prefs.removeObserver.
*/
export type PrefObserver =
| PrefObserverFunction
| { observe: PrefObserverFunction };
/**
* Scale a number value.
*/
export type NumberScaler = (value: number) => number;
/**
* A collection of functions to scale numbers.
*/
export interface ScaleFunctions {
fromFractionToValue: NumberScaler;
fromValueToFraction: NumberScaler;
fromFractionToSingleDigitValue: NumberScaler;
steps: number;
}
/**
* View mode for the Firefox Profiler front-end timeline.
* `undefined` is defaulted to full automatically.
*/
export type ProfilerViewMode = "full" | "active-tab" | "origins";
export interface PresetDefinition {
entries: number;
interval: number;
features: string[];
threads: string[];
duration: number;
profilerViewMode?: ProfilerViewMode;
l10nIds: {
popup: {
label: string;
description: string;
};
devtools: {
label: string;
description: string;
};
};
}
export interface Presets {
[presetName: string]: PresetDefinition;
}
// Should be kept in sync with the types in https://github.com/firefox-devtools/profiler/blob/main/src/app-logic/web-channel.js .
// Compatibility is handled as follows:
// - The front-end needs to worry about compatibility and handle older browser versions.
// - The browser can require the latest front-end version and does not need to keep any legacy functionality for older front-end versions.
type MessageFromFrontend = {
requestId: number;
} & RequestFromFrontend;
export type RequestFromFrontend =
| StatusQueryRequest
| EnableMenuButtonRequest
| GetProfileRequest
| GetExternalPowerTracksRequest
| GetSymbolTableRequest
| QuerySymbolicationApiRequest;
type StatusQueryRequest = { type: "STATUS_QUERY" };
type EnableMenuButtonRequest = { type: "ENABLE_MENU_BUTTON" };
type GetProfileRequest = { type: "GET_PROFILE" };
type GetExternalPowerTracksRequest = {
type: "GET_EXTERNAL_POWER_TRACKS",
startTime: number,
endTime: number,
};
type GetSymbolTableRequest = {
type: "GET_SYMBOL_TABLE";
debugName: string;
breakpadId: string;
};
type QuerySymbolicationApiRequest = {
type: "QUERY_SYMBOLICATION_API";
path: string;
requestJson: string;
};
export type MessageToFrontend<R> =
| OutOfBandErrorMessageToFrontend
| ErrorResponseMessageToFrontend
| SuccessResponseMessageToFrontend<R>;
type OutOfBandErrorMessageToFrontend = {
errno: number;
error: string;
};
type ErrorResponseMessageToFrontend = {
type: "ERROR_RESPONSE";
requestId: number;
error: string;
};
type SuccessResponseMessageToFrontend<R> = {
type: "SUCCESS_RESPONSE";
requestId: number;
response: R;
};
export type ResponseToFrontend =
| StatusQueryResponse
| EnableMenuButtonResponse
| GetProfileResponse
| 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: number;
};
type EnableMenuButtonResponse = void;
type GetProfileResponse = ArrayBuffer | MinimallyTypedGeckoProfile;
type GetExternalPowerTracksResponse = Array<object>;
type GetSymbolTableResponse = SymbolTableAsTuple;
type QuerySymbolicationApiResponse = string;
/**
* This represents an event channel that can talk to a content page on the web.
* This interface is a manually typed version of toolkit/modules/WebChannel.sys.mjs
* and is opinionated about the types of messages we can send with it.
*
* The definition is here rather than gecko.d.ts because it was simpler than getting
* generics working with the ChromeUtils.import machinery.
*/
export class ProfilerWebChannel {
constructor(id: string, url: MockedExports.nsIURI);
send: (
message: MessageToFrontend<ResponseToFrontend>,
target: MockedExports.WebChannelTarget
) => void;
listen: (
handler: (
idle: string,
message: MessageFromFrontend,
target: MockedExports.WebChannelTarget
) => void
) => void;
}
/**
* The per-tab information that is stored when a new profile is captured
* and a profiler tab is opened, to serve the correct profile to the tab
* that sends the WebChannel message.
*/
export type ProfilerBrowserInfo = {
profileCaptureResult: ProfileCaptureResult;
symbolicationService: SymbolicationService;
};
export type ProfileCaptureResult =
| {
type: "SUCCESS";
profile: MinimallyTypedGeckoProfile | ArrayBuffer;
}
| {
type: "ERROR";
error: Error;
};
/**
* Describes all of the profiling features that can be turned on and
* off in about:profiling.
*/
export interface FeatureDescription {
// The name of the feature as shown in the UI.
name: string;
// The key value of the feature, this will be stored in prefs, and used in the
// nsiProfiler interface.
value: string;
// The full description of the preset, this will need to be localized.
title: string;
// This will give the user a hint that it's recommended on.
recommended?: boolean;
// This will give the user a hint that it's an experimental feature.
experimental?: boolean;
// This will give a reason if the feature is disabled.
disabledReason?: string;
}
// The key has the shape `${debugName}:${breakpadId}`.
export type LibInfoMapKey = string;
// This is a subset of the full Library struct.
export type LibInfoMapValue = {
name: string;
path: string;
debugName: string;
debugPath: string;
breakpadId: string;
arch: string;
};
export type SymbolicationWorkerInitialMessage = {
request: SymbolicationWorkerRequest;
// A map that allows looking up library info based on debugName + breakpadId.
// This is rather redundant at the moment, but it will make more sense once
// we can request symbols for multiple different libraries with one worker
// message.
libInfoMap: Map<LibInfoMapKey, LibInfoMapValue>;
// An array of objdir paths on the host machine that should be searched for
// relevant build artifacts.
objdirs: string[];
// The profiler-get-symbols wasm module.
module: WebAssembly.Module;
};
export type SymbolicationWorkerRequest =
| {
type: "GET_SYMBOL_TABLE";
// The debugName of the binary whose symbols should be obtained.
debugName: string;
// The breakpadId for the binary whose symbols should be obtained.
breakpadId: string;
}
| {
type: "QUERY_SYMBOLICATION_API";
// The API entry path, such as "/symbolicate/v5".
path: string;
// The payload JSON, as a string.
requestJson: string;
};
export type SymbolicationWorkerError = {
name: string;
message: string;
fileName?: string;
lineNumber?: number;
};
export type SymbolicationWorkerReplyData<R> =
| {
result: R;
}
| {
error: SymbolicationWorkerError;
};
// This type is used in the symbolication worker for the return type of the
// FileAndPathHelper's readFile method.
// FIXME: Or rather, this type *would* be used if the worker code was checked
// by TypeScript.
export interface FileHandle {
// Return the length of the file in bytes.
getLength: () => number;
// Synchronously read the bytes at offset `offset` into the array `dest`.
readBytesInto: (dest: Uint8Array, offset: number) => void;
// Called when the file is no longer needed, to allow closing the file.
drop: () => void;
}
|