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
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
|
/* 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/. */
import { AppConstants } from "resource://gre/modules/AppConstants.sys.mjs";
import { XPCOMUtils } from "resource://gre/modules/XPCOMUtils.sys.mjs";
const lazy = {};
ChromeUtils.defineESModuleGetters(lazy, {
HiddenFrame: "resource://gre/modules/HiddenFrame.sys.mjs",
SpecialPowersSandbox: "resource://specialpowers/SpecialPowersSandbox.sys.mjs",
});
XPCOMUtils.defineLazyModuleGetters(lazy, {
ExtensionData: "resource://gre/modules/Extension.jsm",
ExtensionTestCommon: "resource://testing-common/ExtensionTestCommon.jsm",
PerTestCoverageUtils: "resource://testing-common/PerTestCoverageUtils.jsm",
ServiceWorkerCleanUp: "resource://gre/modules/ServiceWorkerCleanUp.jsm",
});
class SpecialPowersError extends Error {
get name() {
return "SpecialPowersError";
}
}
const PREF_TYPES = {
[Ci.nsIPrefBranch.PREF_INVALID]: "INVALID",
[Ci.nsIPrefBranch.PREF_INT]: "INT",
[Ci.nsIPrefBranch.PREF_BOOL]: "BOOL",
[Ci.nsIPrefBranch.PREF_STRING]: "CHAR",
number: "INT",
boolean: "BOOL",
string: "CHAR",
};
// We share a single preference environment stack between all
// SpecialPowers instances, across all processes.
let prefUndoStack = [];
let inPrefEnvOp = false;
let permissionUndoStack = [];
function doPrefEnvOp(fn) {
if (inPrefEnvOp) {
throw new Error(
"Reentrant preference environment operations not supported"
);
}
inPrefEnvOp = true;
try {
return fn();
} finally {
inPrefEnvOp = false;
}
}
async function createWindowlessBrowser({ isPrivate = false } = {}) {
const {
promiseDocumentLoaded,
promiseEvent,
promiseObserved,
} = ChromeUtils.import(
"resource://gre/modules/ExtensionUtils.jsm"
).ExtensionUtils;
let windowlessBrowser = Services.appShell.createWindowlessBrowser(true);
if (isPrivate) {
let loadContext = windowlessBrowser.docShell.QueryInterface(
Ci.nsILoadContext
);
loadContext.usePrivateBrowsing = true;
}
let chromeShell = windowlessBrowser.docShell.QueryInterface(
Ci.nsIWebNavigation
);
const system = Services.scriptSecurityManager.getSystemPrincipal();
chromeShell.createAboutBlankContentViewer(system, system);
windowlessBrowser.browsingContext.useGlobalHistory = false;
chromeShell.loadURI("chrome://extensions/content/dummy.xhtml", {
triggeringPrincipal: system,
});
await promiseObserved(
"chrome-document-global-created",
win => win.document == chromeShell.document
);
let chromeDoc = await promiseDocumentLoaded(chromeShell.document);
let browser = chromeDoc.createXULElement("browser");
browser.setAttribute("type", "content");
browser.setAttribute("disableglobalhistory", "true");
browser.setAttribute("remote", "true");
let promise = promiseEvent(browser, "XULFrameLoaderCreated");
chromeDoc.documentElement.appendChild(browser);
await promise;
return { windowlessBrowser, browser };
}
// Supplies the unique IDs for tasks created by SpecialPowers.spawn(),
// used to bounce assertion messages back down to the correct child.
let nextTaskID = 1;
// The default actor to send assertions to if a task originated in a
// window without a test harness.
let defaultAssertHandler;
export class SpecialPowersParent extends JSWindowActorParent {
constructor() {
super();
this._messageManager = Services.mm;
this._serviceWorkerListener = null;
this._observer = this.observe.bind(this);
this.didDestroy = this.uninit.bind(this);
this._registerObservers = {
_self: this,
_topics: [],
_add(topic) {
if (!this._topics.includes(topic)) {
this._topics.push(topic);
Services.obs.addObserver(this, topic);
}
},
observe(aSubject, aTopic, aData) {
var msg = { aData };
switch (aTopic) {
case "csp-on-violate-policy":
// the subject is either an nsIURI or an nsISupportsCString
let subject = null;
if (aSubject instanceof Ci.nsIURI) {
subject = aSubject.asciiSpec;
} else if (aSubject instanceof Ci.nsISupportsCString) {
subject = aSubject.data;
} else {
throw new Error("Subject must be nsIURI or nsISupportsCString");
}
msg = {
subject,
data: aData,
};
this._self.sendAsyncMessage("specialpowers-" + aTopic, msg);
return;
case "xfo-on-violate-policy":
let uriSpec = null;
if (aSubject instanceof Ci.nsIURI) {
uriSpec = aSubject.asciiSpec;
} else {
throw new Error("Subject must be nsIURI");
}
msg = {
subject: uriSpec,
data: aData,
};
this._self.sendAsyncMessage("specialpowers-" + aTopic, msg);
return;
default:
this._self.sendAsyncMessage("specialpowers-" + aTopic, msg);
}
},
};
this.init();
this._crashDumpDir = null;
this._processCrashObserversRegistered = false;
this._chromeScriptListeners = [];
this._extensions = new Map();
this._taskActors = new Map();
}
init() {
Services.obs.addObserver(this._observer, "http-on-modify-request");
// We would like to check that tests don't leave service workers around
// after they finish, but that information lives in the parent process.
// Ideally, we'd be able to tell the child processes whenever service
// workers are registered or unregistered so they would know at all times,
// but service worker lifetimes are complicated enough to make that
// difficult. For the time being, let the child process know when a test
// registers a service worker so it can ask, synchronously, at the end if
// the service worker had unregister called on it.
let swm = Cc["@mozilla.org/serviceworkers/manager;1"].getService(
Ci.nsIServiceWorkerManager
);
let self = this;
this._serviceWorkerListener = {
onRegister() {
self.onRegister();
},
onUnregister() {
// no-op
},
};
swm.addListener(this._serviceWorkerListener);
}
uninit() {
if (defaultAssertHandler === this) {
defaultAssertHandler = null;
}
var obs = Services.obs;
obs.removeObserver(this._observer, "http-on-modify-request");
this._registerObservers._topics.splice(0).forEach(element => {
obs.removeObserver(this._registerObservers, element);
});
this._removeProcessCrashObservers();
let swm = Cc["@mozilla.org/serviceworkers/manager;1"].getService(
Ci.nsIServiceWorkerManager
);
swm.removeListener(this._serviceWorkerListener);
}
observe(aSubject, aTopic, aData) {
function addDumpIDToMessage(propertyName) {
try {
var id = aSubject.getPropertyAsAString(propertyName);
} catch (ex) {
id = null;
}
if (id) {
message.dumpIDs.push({ id, extension: "dmp" });
message.dumpIDs.push({ id, extension: "extra" });
}
}
switch (aTopic) {
case "http-on-modify-request":
if (aSubject instanceof Ci.nsIChannel) {
let uri = aSubject.URI.spec;
this.sendAsyncMessage("specialpowers-http-notify-request", { uri });
}
break;
case "ipc:content-shutdown":
aSubject = aSubject.QueryInterface(Ci.nsIPropertyBag2);
if (!aSubject.hasKey("abnormal")) {
return; // This is a normal shutdown, ignore it
}
var message = { type: "crash-observed", dumpIDs: [] };
addDumpIDToMessage("dumpID");
this.sendAsyncMessage("SPProcessCrashService", message);
break;
}
}
_getCrashDumpDir() {
if (!this._crashDumpDir) {
this._crashDumpDir = Services.dirsvc.get("ProfD", Ci.nsIFile);
this._crashDumpDir.append("minidumps");
}
return this._crashDumpDir;
}
_getPendingCrashDumpDir() {
if (!this._pendingCrashDumpDir) {
this._pendingCrashDumpDir = Services.dirsvc.get("UAppData", Ci.nsIFile);
this._pendingCrashDumpDir.append("Crash Reports");
this._pendingCrashDumpDir.append("pending");
}
return this._pendingCrashDumpDir;
}
_deleteCrashDumpFiles(aFilenames) {
var crashDumpDir = this._getCrashDumpDir();
if (!crashDumpDir.exists()) {
return false;
}
var success = !!aFilenames.length;
aFilenames.forEach(function(crashFilename) {
var file = crashDumpDir.clone();
file.append(crashFilename);
if (file.exists()) {
file.remove(false);
} else {
success = false;
}
});
return success;
}
_findCrashDumpFiles(aToIgnore) {
var crashDumpDir = this._getCrashDumpDir();
var entries = crashDumpDir.exists() && crashDumpDir.directoryEntries;
if (!entries) {
return [];
}
var crashDumpFiles = [];
while (entries.hasMoreElements()) {
var file = entries.nextFile;
var path = String(file.path);
if (path.match(/\.(dmp|extra)$/) && !aToIgnore[path]) {
crashDumpFiles.push(path);
}
}
return crashDumpFiles.concat();
}
_deletePendingCrashDumpFiles() {
var crashDumpDir = this._getPendingCrashDumpDir();
var removed = false;
if (crashDumpDir.exists()) {
let entries = crashDumpDir.directoryEntries;
while (entries.hasMoreElements()) {
let file = entries.nextFile;
if (file.isFile()) {
file.remove(false);
removed = true;
}
}
}
return removed;
}
_addProcessCrashObservers() {
if (this._processCrashObserversRegistered) {
return;
}
Services.obs.addObserver(this._observer, "ipc:content-shutdown");
this._processCrashObserversRegistered = true;
}
_removeProcessCrashObservers() {
if (!this._processCrashObserversRegistered) {
return;
}
Services.obs.removeObserver(this._observer, "ipc:content-shutdown");
this._processCrashObserversRegistered = false;
}
onRegister() {
this.sendAsyncMessage("SPServiceWorkerRegistered", { registered: true });
}
_getURI(url) {
return Services.io.newURI(url);
}
_notifyCategoryAndObservers(subject, topic, data) {
const serviceMarker = "service,";
// First create observers from the category manager.
let observers = [];
for (let { value: contractID } of Services.catMan.enumerateCategory(
topic
)) {
let factoryFunction;
if (contractID.substring(0, serviceMarker.length) == serviceMarker) {
contractID = contractID.substring(serviceMarker.length);
factoryFunction = "getService";
} else {
factoryFunction = "createInstance";
}
try {
let handler = Cc[contractID][factoryFunction]();
if (handler) {
let observer = handler.QueryInterface(Ci.nsIObserver);
observers.push(observer);
}
} catch (e) {}
}
// Next enumerate the registered observers.
for (let observer of Services.obs.enumerateObservers(topic)) {
if (observer instanceof Ci.nsIObserver && !observers.includes(observer)) {
observers.push(observer);
}
}
observers.forEach(function(observer) {
try {
observer.observe(subject, topic, data);
} catch (e) {}
});
}
/*
Iterate through one atomic set of pref actions and perform sets/clears as appropriate.
All actions performed must modify the relevant pref.
Returns whether we need to wait for a refresh driver tick for the pref to
have effect. This is only needed for ui. and font. prefs, which affect the
look and feel code and have some change-coalescing going on.
*/
_applyPrefs(actions) {
let requiresRefresh = false;
for (let pref of actions) {
// This logic should match PrefRequiresRefresh in reftest.jsm
requiresRefresh =
requiresRefresh ||
pref.name == "layout.css.prefers-color-scheme.content-override" ||
pref.name.startsWith("ui.") ||
pref.name.startsWith("browser.display.") ||
pref.name.startsWith("font.");
if (pref.action == "set") {
this._setPref(pref.name, pref.type, pref.value, pref.iid);
} else if (pref.action == "clear") {
Services.prefs.clearUserPref(pref.name);
}
}
return requiresRefresh;
}
/**
* Take in a list of pref changes to make, pushes their current values
* onto the restore stack, and makes the changes. When the test
* finishes, these changes are reverted.
*
* |inPrefs| must be an object with up to two properties: "set" and "clear".
* pushPrefEnv will set prefs as indicated in |inPrefs.set| and will unset
* the prefs indicated in |inPrefs.clear|.
*
* For example, you might pass |inPrefs| as:
*
* inPrefs = {'set': [['foo.bar', 2], ['magic.pref', 'baz']],
* 'clear': [['clear.this'], ['also.this']] };
*
* Notice that |set| and |clear| are both an array of arrays. In |set|, each
* of the inner arrays must have the form [pref_name, value] or [pref_name,
* value, iid]. (The latter form is used for prefs with "complex" values.)
*
* In |clear|, each inner array should have the form [pref_name].
*
* If you set the same pref more than once (or both set and clear a pref),
* the behavior of this method is undefined.
*/
pushPrefEnv(inPrefs) {
return doPrefEnvOp(() => {
let pendingActions = [];
let cleanupActions = [];
for (let [action, prefs] of Object.entries(inPrefs)) {
for (let pref of prefs) {
let name = pref[0];
let value = null;
let iid = null;
let type = PREF_TYPES[Services.prefs.getPrefType(name)];
let originalValue = null;
if (pref.length == 3) {
value = pref[1];
iid = pref[2];
} else if (pref.length == 2) {
value = pref[1];
}
/* If pref is not found or invalid it doesn't exist. */
if (type !== "INVALID") {
if (
(Services.prefs.prefHasUserValue(name) && action == "clear") ||
action == "set"
) {
originalValue = this._getPref(name, type);
}
} else if (action == "set") {
/* name doesn't exist, so 'clear' is pointless */
if (iid) {
type = "COMPLEX";
}
}
if (type === "INVALID") {
type = PREF_TYPES[typeof value];
}
if (type === "INVALID") {
throw new Error("Unexpected preference type");
}
pendingActions.push({ action, type, name, value, iid });
/* Push original preference value or clear into cleanup array */
var cleanupTodo = { type, name, value: originalValue, iid };
if (originalValue == null) {
cleanupTodo.action = "clear";
} else {
cleanupTodo.action = "set";
}
cleanupActions.push(cleanupTodo);
}
}
prefUndoStack.push(cleanupActions);
let requiresRefresh = this._applyPrefs(pendingActions);
return { requiresRefresh };
});
}
async popPrefEnv() {
return doPrefEnvOp(() => {
let env = prefUndoStack.pop();
if (env) {
let requiresRefresh = this._applyPrefs(env);
return { popped: true, requiresRefresh };
}
return { popped: false, requiresRefresh: false };
});
}
flushPrefEnv() {
let requiresRefresh = false;
while (prefUndoStack.length) {
requiresRefresh |= this.popPrefEnv().requiresRefresh;
}
return { requiresRefresh };
}
_setPref(name, type, value, iid) {
switch (type) {
case "BOOL":
return Services.prefs.setBoolPref(name, value);
case "INT":
return Services.prefs.setIntPref(name, value);
case "CHAR":
return Services.prefs.setCharPref(name, value);
case "COMPLEX":
return Services.prefs.setComplexValue(name, iid, value);
}
throw new Error(`Unexpected preference type: ${type}`);
}
_getPref(name, type, defaultValue, iid) {
switch (type) {
case "BOOL":
if (defaultValue !== undefined) {
return Services.prefs.getBoolPref(name, defaultValue);
}
return Services.prefs.getBoolPref(name);
case "INT":
if (defaultValue !== undefined) {
return Services.prefs.getIntPref(name, defaultValue);
}
return Services.prefs.getIntPref(name);
case "CHAR":
if (defaultValue !== undefined) {
return Services.prefs.getCharPref(name, defaultValue);
}
return Services.prefs.getCharPref(name);
case "COMPLEX":
return Services.prefs.getComplexValue(name, iid);
}
throw new Error(`Unexpected preference type: ${type}`);
}
_toggleMuteAudio(aMuted) {
let browser = this.browsingContext.top.embedderElement;
if (aMuted) {
browser.mute();
} else {
browser.unmute();
}
}
_permOp(perm) {
switch (perm.op) {
case "add":
Services.perms.addFromPrincipal(
perm.principal,
perm.type,
perm.permission,
perm.expireType,
perm.expireTime
);
break;
case "remove":
Services.perms.removeFromPrincipal(perm.principal, perm.type);
break;
default:
throw new Error(`Unexpected permission op: ${perm.op}`);
}
}
pushPermissions(inPermissions) {
let pendingPermissions = [];
let cleanupPermissions = [];
for (let permission of inPermissions) {
let { principal } = permission;
if (principal.isSystemPrincipal) {
continue;
}
let originalValue = Services.perms.testPermissionFromPrincipal(
principal,
permission.type
);
let perm = permission.allow;
if (typeof perm === "boolean") {
perm = Ci.nsIPermissionManager[perm ? "ALLOW_ACTION" : "DENY_ACTION"];
}
if (permission.remove) {
perm = Ci.nsIPermissionManager.UNKNOWN_ACTION;
}
if (originalValue == perm) {
continue;
}
let todo = {
op: "add",
type: permission.type,
permission: perm,
value: perm,
principal,
expireType:
typeof permission.expireType === "number" ? permission.expireType : 0, // default: EXPIRE_NEVER
expireTime:
typeof permission.expireTime === "number" ? permission.expireTime : 0,
};
var cleanupTodo = Object.assign({}, todo);
if (permission.remove) {
todo.op = "remove";
}
pendingPermissions.push(todo);
if (originalValue == Ci.nsIPermissionManager.UNKNOWN_ACTION) {
cleanupTodo.op = "remove";
} else {
cleanupTodo.value = originalValue;
cleanupTodo.permission = originalValue;
}
cleanupPermissions.push(cleanupTodo);
}
permissionUndoStack.push(cleanupPermissions);
for (let perm of pendingPermissions) {
this._permOp(perm);
}
}
popPermissions() {
if (permissionUndoStack.length) {
for (let perm of permissionUndoStack.pop()) {
this._permOp(perm);
}
}
}
flushPermissions() {
while (permissionUndoStack.length) {
this.popPermissions();
}
}
_spawnChrome(task, args, caller, imports) {
let sb = new lazy.SpecialPowersSandbox(
null,
data => {
this.sendAsyncMessage("Assert", data);
},
{ imports }
);
for (let [global, prop] of Object.entries({
windowGlobalParent: "manager",
browsingContext: "browsingContext",
})) {
Object.defineProperty(sb.sandbox, global, {
get: () => {
return this[prop];
},
enumerable: true,
});
}
return sb.execute(task, args, caller);
}
/**
* messageManager callback function
* This will get requests from our API in the window and process them in chrome for it
**/
// eslint-disable-next-line complexity
async receiveMessage(aMessage) {
let startTime = Cu.now();
// Try block so we can use a finally statement to add a profiler marker
// despite all the return statements.
try {
// We explicitly return values in the below code so that this function
// doesn't trigger a flurry of warnings about "does not always return
// a value".
switch (aMessage.name) {
case "SPToggleMuteAudio":
return this._toggleMuteAudio(aMessage.data.mute);
case "Ping":
return undefined;
case "SpecialPowers.Quit":
if (
!AppConstants.RELEASE_OR_BETA &&
!AppConstants.DEBUG &&
!AppConstants.MOZ_CODE_COVERAGE &&
!AppConstants.ASAN &&
!AppConstants.TSAN
) {
if (Services.profiler.IsActive()) {
let filename = Services.env.get("MOZ_PROFILER_SHUTDOWN");
if (filename) {
await Services.profiler.dumpProfileToFileAsync(filename);
await Services.profiler.StopProfiler();
}
}
Cu.exitIfInAutomation();
} else {
Services.startup.quit(Ci.nsIAppStartup.eForceQuit);
}
return undefined;
case "EnsureFocus":
let bc = aMessage.data.browsingContext;
// Send a message to the child telling it to focus the window.
// If the message responds with a browsing context, then
// a child browsing context in a subframe should be focused.
// Iterate until nothing is returned and we get to the most
// deeply nested subframe that should be focused.
do {
let spParent = bc.currentWindowGlobal.getActor("SpecialPowers");
if (spParent) {
bc = await spParent.sendQuery("EnsureFocus", {
blurSubframe: aMessage.data.blurSubframe,
});
}
} while (bc && !aMessage.data.blurSubframe);
return undefined;
case "SpecialPowers.Focus":
if (this.manager.rootFrameLoader) {
this.manager.rootFrameLoader.ownerElement.focus();
}
return undefined;
case "SpecialPowers.CreateFiles":
return (async () => {
let filePaths = [];
if (!this._createdFiles) {
this._createdFiles = [];
}
let createdFiles = this._createdFiles;
let promises = [];
aMessage.data.forEach(function(request) {
const filePerms = 0o666;
let testFile = Services.dirsvc.get("ProfD", Ci.nsIFile);
if (request.name) {
testFile.appendRelativePath(request.name);
} else {
testFile.createUnique(Ci.nsIFile.NORMAL_FILE_TYPE, filePerms);
}
let outStream = Cc[
"@mozilla.org/network/file-output-stream;1"
].createInstance(Ci.nsIFileOutputStream);
outStream.init(
testFile,
0x02 | 0x08 | 0x20, // PR_WRONLY | PR_CREATE_FILE | PR_TRUNCATE
filePerms,
0
);
if (request.data) {
outStream.write(request.data, request.data.length);
}
outStream.close();
promises.push(
File.createFromFileName(testFile.path, request.options).then(
function(file) {
filePaths.push(file);
}
)
);
createdFiles.push(testFile);
});
await Promise.all(promises);
return filePaths;
})().catch(e => {
console.error(e);
return Promise.reject(String(e));
});
case "SpecialPowers.RemoveFiles":
if (this._createdFiles) {
this._createdFiles.forEach(function(testFile) {
try {
testFile.remove(false);
} catch (e) {}
});
this._createdFiles = null;
}
return undefined;
case "Wakeup":
return undefined;
case "EvictAllContentViewers":
this.browsingContext.top.sessionHistory.evictAllContentViewers();
return undefined;
case "PushPrefEnv":
return this.pushPrefEnv(aMessage.data);
case "PopPrefEnv":
return this.popPrefEnv();
case "FlushPrefEnv":
return this.flushPrefEnv();
case "PushPermissions":
return this.pushPermissions(aMessage.data);
case "PopPermissions":
return this.popPermissions();
case "FlushPermissions":
return this.flushPermissions();
case "SPPrefService": {
let prefs = Services.prefs;
let prefType = aMessage.json.prefType.toUpperCase();
let { prefName, prefValue, iid, defaultValue } = aMessage.json;
if (aMessage.json.op == "get") {
if (!prefName || !prefType) {
throw new SpecialPowersError(
"Invalid parameters for get in SPPrefService"
);
}
// return null if the pref doesn't exist
if (
defaultValue === undefined &&
prefs.getPrefType(prefName) == prefs.PREF_INVALID
) {
return null;
}
return this._getPref(prefName, prefType, defaultValue, iid);
} else if (aMessage.json.op == "set") {
if (!prefName || !prefType || prefValue === undefined) {
throw new SpecialPowersError(
"Invalid parameters for set in SPPrefService"
);
}
return this._setPref(prefName, prefType, prefValue, iid);
} else if (aMessage.json.op == "clear") {
if (!prefName) {
throw new SpecialPowersError(
"Invalid parameters for clear in SPPrefService"
);
}
prefs.clearUserPref(prefName);
} else {
throw new SpecialPowersError("Invalid operation for SPPrefService");
}
return undefined; // See comment at the beginning of this function.
}
case "SPProcessCrashService": {
switch (aMessage.json.op) {
case "register-observer":
this._addProcessCrashObservers();
break;
case "unregister-observer":
this._removeProcessCrashObservers();
break;
case "delete-crash-dump-files":
return this._deleteCrashDumpFiles(aMessage.json.filenames);
case "find-crash-dump-files":
return this._findCrashDumpFiles(
aMessage.json.crashDumpFilesToIgnore
);
case "delete-pending-crash-dump-files":
return this._deletePendingCrashDumpFiles();
default:
throw new SpecialPowersError(
"Invalid operation for SPProcessCrashService"
);
}
return undefined; // See comment at the beginning of this function.
}
case "SPProcessCrashManagerWait": {
let promises = aMessage.json.crashIds.map(crashId => {
return Services.crashmanager.ensureCrashIsPresent(crashId);
});
return Promise.all(promises);
}
case "SPPermissionManager": {
let msg = aMessage.data;
switch (msg.op) {
case "add":
case "remove":
this._permOp(msg);
break;
case "has":
let hasPerm = Services.perms.testPermissionFromPrincipal(
msg.principal,
msg.type
);
return hasPerm == Ci.nsIPermissionManager.ALLOW_ACTION;
case "test":
let testPerm = Services.perms.testPermissionFromPrincipal(
msg.principal,
msg.type
);
return testPerm == msg.value;
default:
throw new SpecialPowersError(
"Invalid operation for SPPermissionManager"
);
}
return undefined; // See comment at the beginning of this function.
}
case "SPObserverService": {
let topic = aMessage.json.observerTopic;
switch (aMessage.json.op) {
case "notify":
let data = aMessage.json.observerData;
Services.obs.notifyObservers(null, topic, data);
break;
case "add":
this._registerObservers._add(topic);
break;
default:
throw new SpecialPowersError(
"Invalid operation for SPObserverervice"
);
}
return undefined; // See comment at the beginning of this function.
}
case "SPLoadChromeScript": {
let id = aMessage.json.id;
let scriptName;
let jsScript = aMessage.json.function.body;
if (aMessage.json.url) {
scriptName = aMessage.json.url;
} else if (aMessage.json.function) {
scriptName =
aMessage.json.function.name ||
"<loadChromeScript anonymous function>";
} else {
throw new SpecialPowersError("SPLoadChromeScript: Invalid script");
}
// Setup a chrome sandbox that has access to sendAsyncMessage
// and {add,remove}MessageListener in order to communicate with
// the mochitest.
let sb = new lazy.SpecialPowersSandbox(
scriptName,
data => {
this.sendAsyncMessage("Assert", data);
},
aMessage.data
);
Object.assign(sb.sandbox, {
createWindowlessBrowser,
sendAsyncMessage: (name, message) => {
this.sendAsyncMessage("SPChromeScriptMessage", {
id,
name,
message,
});
},
addMessageListener: (name, listener) => {
this._chromeScriptListeners.push({ id, name, listener });
},
removeMessageListener: (name, listener) => {
let index = this._chromeScriptListeners.findIndex(function(obj) {
return (
obj.id == id && obj.name == name && obj.listener == listener
);
});
if (index >= 0) {
this._chromeScriptListeners.splice(index, 1);
}
},
actorParent: this.manager,
});
// Evaluate the chrome script
try {
Cu.evalInSandbox(jsScript, sb.sandbox, "1.8", scriptName, 1);
} catch (e) {
throw new SpecialPowersError(
"Error while executing chrome script '" +
scriptName +
"':\n" +
e +
"\n" +
e.fileName +
":" +
e.lineNumber
);
}
return undefined; // See comment at the beginning of this function.
}
case "SPChromeScriptMessage": {
let id = aMessage.json.id;
let name = aMessage.json.name;
let message = aMessage.json.message;
let result;
for (let listener of this._chromeScriptListeners) {
if (listener.name == name && listener.id == id) {
result = listener.listener(message);
}
}
return result;
}
case "SPImportInMainProcess": {
var message = { hadError: false, errorMessage: null };
try {
ChromeUtils.import(aMessage.data);
} catch (e) {
message.hadError = true;
message.errorMessage = e.toString();
}
return message;
}
case "SPCleanUpSTSData": {
let origin = aMessage.data.origin;
let uri = Services.io.newURI(origin);
let sss = Cc["@mozilla.org/ssservice;1"].getService(
Ci.nsISiteSecurityService
);
sss.resetState(uri);
return undefined;
}
case "SPRequestDumpCoverageCounters": {
return lazy.PerTestCoverageUtils.afterTest();
}
case "SPRequestResetCoverageCounters": {
return lazy.PerTestCoverageUtils.beforeTest();
}
case "SPCheckServiceWorkers": {
let swm = Cc["@mozilla.org/serviceworkers/manager;1"].getService(
Ci.nsIServiceWorkerManager
);
let regs = swm.getAllRegistrations();
// XXX This code is shared with specialpowers.js.
let workers = new Array(regs.length);
for (let i = 0; i < regs.length; ++i) {
let { scope, scriptSpec } = regs.queryElementAt(
i,
Ci.nsIServiceWorkerRegistrationInfo
);
workers[i] = { scope, scriptSpec };
}
return { workers };
}
case "SPLoadExtension": {
let id = aMessage.data.id;
let ext = aMessage.data.ext;
if (AppConstants.platform === "android") {
// Some extension APIs are partially implemented in Java, and the
// interface between the JS and Java side (GeckoViewWebExtension)
// expects extensions to be registered with the AddonManager.
//
// For simplicity, default to using an Addon Manager (if not null).
if (ext.useAddonManager === undefined) {
ext.useAddonManager = "android-only";
}
}
// delayedStartup is only supported in xpcshell
if (ext.delayedStartup !== undefined) {
throw new Error(
`delayedStartup is only supported in xpcshell, use "useAddonManager".`
);
}
let extension = lazy.ExtensionTestCommon.generate(ext);
let resultListener = (...args) => {
this.sendAsyncMessage("SPExtensionMessage", {
id,
type: "testResult",
args,
});
};
let messageListener = (...args) => {
args.shift();
this.sendAsyncMessage("SPExtensionMessage", {
id,
type: "testMessage",
args,
});
};
// Register pass/fail handlers.
extension.on("test-result", resultListener);
extension.on("test-eq", resultListener);
extension.on("test-log", resultListener);
extension.on("test-done", resultListener);
extension.on("test-message", messageListener);
this._extensions.set(id, extension);
return undefined;
}
case "SPStartupExtension": {
let id = aMessage.data.id;
// This is either an Extension, or (if useAddonManager is set) a MockExtension.
let extension = this._extensions.get(id);
extension.on("startup", (eventName, ext) => {
if (AppConstants.platform === "android") {
// We need a way to notify the embedding layer that a new extension
// has been installed, so that the java layer can be updated too.
Services.obs.notifyObservers(null, "testing-installed-addon", id);
}
// ext is always the "real" Extension object, even when "extension"
// is a MockExtension.
this.sendAsyncMessage("SPExtensionMessage", {
id,
type: "extensionSetId",
args: [ext.id, ext.uuid],
});
});
// Make sure the extension passes the packaging checks when
// they're run on a bare archive rather than a running instance,
// as the add-on manager runs them.
let extensionData = new lazy.ExtensionData(extension.rootURI);
return extensionData
.loadManifest()
.then(
() => {
return extensionData.initAllLocales().then(() => {
if (extensionData.errors.length) {
return Promise.reject(
"Extension contains packaging errors"
);
}
return undefined;
});
},
() => {
// loadManifest() will throw if we're loading an embedded
// extension, so don't worry about locale errors in that
// case.
}
)
.then(async () => {
// browser tests do not call startup in ExtensionXPCShellUtils or MockExtension,
// in that case we have an ID here and we need to set the override.
if (extension.id) {
await lazy.ExtensionTestCommon.setIncognitoOverride(extension);
}
return extension.startup().then(
() => {},
e => {
dump(`Extension startup failed: ${e}\n${e.stack}`);
throw e;
}
);
});
}
case "SPExtensionMessage": {
let id = aMessage.data.id;
let extension = this._extensions.get(id);
extension.testMessage(...aMessage.data.args);
return undefined;
}
case "SPExtensionGrantActiveTab": {
let { id, tabId } = aMessage.data;
let { tabManager } = this._extensions.get(id);
tabManager.addActiveTabPermission(tabManager.get(tabId).nativeTab);
return undefined;
}
case "SPUnloadExtension": {
let id = aMessage.data.id;
let extension = this._extensions.get(id);
this._extensions.delete(id);
return extension.shutdown().then(() => {
return extension._uninstallPromise;
});
}
case "SPExtensionTerminateBackground": {
let id = aMessage.data.id;
let args = aMessage.data.args;
let extension = this._extensions.get(id);
return extension.terminateBackground(...args);
}
case "SPExtensionWakeupBackground": {
let id = aMessage.data.id;
let extension = this._extensions.get(id);
return extension.wakeupBackground();
}
case "SetAsDefaultAssertHandler": {
defaultAssertHandler = this;
return undefined;
}
case "Spawn": {
// Use a different variable for the profiler marker start time
// so that a marker isn't added when we return, but instead when
// our promise resolves.
let spawnStartTime = startTime;
startTime = undefined;
let {
browsingContext,
task,
args,
caller,
hasHarness,
imports,
} = aMessage.data;
let spParent = browsingContext.currentWindowGlobal.getActor(
"SpecialPowers"
);
let taskId = nextTaskID++;
if (hasHarness) {
spParent._taskActors.set(taskId, this);
}
return spParent
.sendQuery("Spawn", { task, args, caller, taskId, imports })
.finally(() => {
ChromeUtils.addProfilerMarker(
"SpecialPowers",
{ startTime: spawnStartTime, category: "Test" },
aMessage.name
);
return spParent._taskActors.delete(taskId);
});
}
case "SpawnChrome": {
let { task, args, caller, imports } = aMessage.data;
return this._spawnChrome(task, args, caller, imports);
}
case "Snapshot": {
let {
browsingContext,
rect,
background,
resetScrollPosition,
} = aMessage.data;
return browsingContext.currentWindowGlobal
.drawSnapshot(rect, 1.0, background, resetScrollPosition)
.then(async image => {
let hiddenFrame = new lazy.HiddenFrame();
let win = await hiddenFrame.get();
let canvas = win.document.createElement("canvas");
canvas.width = image.width;
canvas.height = image.height;
const ctx = canvas.getContext("2d");
ctx.drawImage(image, 0, 0);
let data = ctx.getImageData(0, 0, image.width, image.height);
hiddenFrame.destroy();
return data;
});
}
case "SecurityState": {
let { browsingContext } = aMessage.data;
return browsingContext.secureBrowserUI.state;
}
case "ProxiedAssert": {
let { taskId, data } = aMessage.data;
let actor = this._taskActors.get(taskId) || defaultAssertHandler;
actor.sendAsyncMessage("Assert", data);
return undefined;
}
case "SPRemoveAllServiceWorkers": {
return lazy.ServiceWorkerCleanUp.removeAll();
}
case "SPRemoveServiceWorkerDataForExampleDomain": {
return lazy.ServiceWorkerCleanUp.removeFromHost("example.com");
}
case "SPGenerateMediaControlKeyTestEvent": {
// eslint-disable-next-line no-undef
MediaControlService.generateMediaControlKey(aMessage.data.event);
return undefined;
}
default:
throw new SpecialPowersError(
`Unrecognized Special Powers API: ${aMessage.name}`
);
}
// This should be unreachable. If it ever becomes reachable, ESLint
// will produce an error about inconsistent return values.
} finally {
if (startTime) {
ChromeUtils.addProfilerMarker(
"SpecialPowers",
{ startTime, category: "Test" },
aMessage.name
);
}
}
}
}
|