-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathpatchset.patch
11633 lines (11223 loc) · 526 KB
/
patchset.patch
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
# HG changeset patch
# User RealDolos <[email protected]>
# Date 1517405006 -3600
# Wed Jan 31 14:23:26 2018 +0100
# Node ID 533807979becdb02dc086494a3973f27e63a1a32
# Parent 2667f0b010c959940d7a12b4311d54a6abd74ac5
Readd DeferredSave.jsm
e.g. DTA compat
Backed out changeset c6099f497e32
diff --git a/toolkit/mozapps/extensions/DeferredSave.jsm b/toolkit/mozapps/extensions/DeferredSave.jsm
new file mode 100644
--- /dev/null
+++ b/toolkit/mozapps/extensions/DeferredSave.jsm
@@ -0,0 +1,299 @@
+/* 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";
+
+const Cu = Components.utils;
+const Cc = Components.classes;
+const Ci = Components.interfaces;
+
+Cu.import("resource://gre/modules/osfile.jsm");
+/* globals OS*/
+Cu.import("resource://gre/modules/PromiseUtils.jsm");
+
+// Make it possible to mock out timers for testing
+var MakeTimer = () => Cc["@mozilla.org/timer;1"].createInstance(Ci.nsITimer);
+
+this.EXPORTED_SYMBOLS = ["DeferredSave"];
+
+// If delay parameter is not provided, default is 50 milliseconds.
+const DEFAULT_SAVE_DELAY_MS = 50;
+
+Cu.import("resource://gre/modules/Log.jsm");
+// Configure a logger at the parent 'DeferredSave' level to format
+// messages for all the modules under DeferredSave.*
+const DEFERREDSAVE_PARENT_LOGGER_ID = "DeferredSave";
+var parentLogger = Log.repository.getLogger(DEFERREDSAVE_PARENT_LOGGER_ID);
+parentLogger.level = Log.Level.Warn;
+var formatter = new Log.BasicFormatter();
+// Set parent logger (and its children) to append to
+// the Javascript section of the Browser Console
+parentLogger.addAppender(new Log.ConsoleAppender(formatter));
+// Set parent logger (and its children) to
+// also append to standard out
+parentLogger.addAppender(new Log.DumpAppender(formatter));
+
+// Provide the ability to enable/disable logging
+// messages at runtime.
+// If the "extensions.logging.enabled" preference is
+// missing or 'false', messages at the WARNING and higher
+// severity should be logged to the JS console and standard error.
+// If "extensions.logging.enabled" is set to 'true', messages
+// at DEBUG and higher should go to JS console and standard error.
+Cu.import("resource://gre/modules/Services.jsm");
+
+Cu.import("resource://gre/modules/XPCOMUtils.jsm");
+
+XPCOMUtils.defineLazyModuleGetter(this, "AsyncShutdown",
+ "resource://gre/modules/AsyncShutdown.jsm");
+
+const PREF_LOGGING_ENABLED = "extensions.logging.enabled";
+const NS_PREFBRANCH_PREFCHANGE_TOPIC_ID = "nsPref:changed";
+
+/**
+* Preference listener which listens for a change in the
+* "extensions.logging.enabled" preference and changes the logging level of the
+* parent 'addons' level logger accordingly.
+*/
+var PrefObserver = {
+ init() {
+ Services.prefs.addObserver(PREF_LOGGING_ENABLED, this);
+ Services.obs.addObserver(this, "xpcom-shutdown");
+ this.observe(null, NS_PREFBRANCH_PREFCHANGE_TOPIC_ID, PREF_LOGGING_ENABLED);
+ },
+
+ observe(aSubject, aTopic, aData) {
+ if (aTopic == "xpcom-shutdown") {
+ Services.prefs.removeObserver(PREF_LOGGING_ENABLED, this);
+ Services.obs.removeObserver(this, "xpcom-shutdown");
+ } else if (aTopic == NS_PREFBRANCH_PREFCHANGE_TOPIC_ID) {
+ let debugLogEnabled = Services.prefs.getBoolPref(PREF_LOGGING_ENABLED, false);
+ if (debugLogEnabled) {
+ parentLogger.level = Log.Level.Debug;
+ } else {
+ parentLogger.level = Log.Level.Warn;
+ }
+ }
+ }
+};
+
+PrefObserver.init();
+
+/**
+ * A module to manage deferred, asynchronous writing of data files
+ * to disk. Writing is deferred by waiting for a specified delay after
+ * a request to save the data, before beginning to write. If more than
+ * one save request is received during the delay, all requests are
+ * fulfilled by a single write.
+ *
+ * @constructor
+ * @param {string} aPath
+ * String representing the full path of the file where the data
+ * is to be written.
+ * @param {function} aDataProvider
+ * Callback function that takes no argument and returns the data to
+ * be written. If aDataProvider returns an ArrayBufferView, the
+ * bytes it contains are written to the file as is.
+ * If aDataProvider returns a String the data are UTF-8 encoded
+ * and then written to the file.
+ * @param {object | integer} [aOptions]
+ * The delay in milliseconds between the first saveChanges() call
+ * that marks the data as needing to be saved, and when the DeferredSave
+ * begins writing the data to disk. Default 50 milliseconds.
+ *
+ * Or, an options object containing:
+ * - delay: A delay in milliseconds.
+ * - finalizeAt: An AsyncShutdown blocker during which to
+ * finalize any pending writes.
+ */
+this.DeferredSave = function(aPath, aDataProvider, aOptions = {}) {
+ if (typeof aOptions == "number") {
+ aOptions = {delay: aOptions};
+ }
+
+ // Create a new logger (child of 'DeferredSave' logger)
+ // for use by this particular instance of DeferredSave object
+ let leafName = OS.Path.basename(aPath);
+ let logger_id = DEFERREDSAVE_PARENT_LOGGER_ID + "." + leafName;
+ this.logger = Log.repository.getLogger(logger_id);
+
+ // @type {Deferred|null}, null when no data needs to be written
+ // @resolves with the result of OS.File.writeAtomic when all writes complete
+ // @rejects with the error from OS.File.writeAtomic if the write fails,
+ // or with the error from aDataProvider() if that throws.
+ this._pending = null;
+
+ // @type {Promise}, completes when the in-progress write (if any) completes,
+ // kept as a resolved promise at other times to simplify logic.
+ // Because _deferredSave() always uses _writing.then() to execute
+ // its next action, we don't need a special case for whether a write
+ // is in progress - if the previous write is complete (and the _writing
+ // promise is already resolved/rejected), _writing.then() starts
+ // the next action immediately.
+ //
+ // @resolves with the result of OS.File.writeAtomic
+ // @rejects with the error from OS.File.writeAtomic
+ this._writing = Promise.resolve(0);
+
+ // Are we currently waiting for a write to complete
+ this.writeInProgress = false;
+
+ this._path = aPath;
+ this._dataProvider = aDataProvider;
+
+ this._timer = null;
+
+ // Some counters for telemetry
+ // The total number of times the file was written
+ this.totalSaves = 0;
+
+ // The number of times the data became dirty while
+ // another save was in progress
+ this.overlappedSaves = 0;
+
+ // Error returned by the most recent write (if any)
+ this._lastError = null;
+
+ if (aOptions.delay && (aOptions.delay > 0))
+ this._delay = aOptions.delay;
+ else
+ this._delay = DEFAULT_SAVE_DELAY_MS;
+
+ this._finalizeAt = aOptions.finalizeAt || AsyncShutdown.profileBeforeChange;
+ this._finalize = this._finalize.bind(this);
+ this._finalizeAt.addBlocker(`DeferredSave: writing data to ${aPath}`,
+ this._finalize);
+};
+
+this.DeferredSave.prototype = {
+ get dirty() {
+ return this._pending || this.writeInProgress;
+ },
+
+ get lastError() {
+ return this._lastError;
+ },
+
+ get path() {
+ return this._path;
+ },
+
+ // Start the pending timer if data is dirty
+ _startTimer() {
+ if (!this._pending) {
+ return;
+ }
+
+ this.logger.debug("Starting timer");
+ if (!this._timer)
+ this._timer = MakeTimer();
+ this._timer.initWithCallback(() => this._timerCallback(),
+ this._delay, Ci.nsITimer.TYPE_ONE_SHOT);
+ },
+
+ /**
+ * Mark the current stored data dirty, and schedule a flush to disk
+ * @return A Promise<integer> that will be resolved after the data is written to disk;
+ * the promise is resolved with the number of bytes written.
+ */
+ saveChanges() {
+ this.logger.debug("Save changes");
+ if (!this._pending) {
+ if (this.writeInProgress) {
+ this.logger.debug("Data changed while write in progress");
+ this.overlappedSaves++;
+ }
+ this._pending = PromiseUtils.defer();
+ // Wait until the most recent write completes or fails (if it hasn't already)
+ // and then restart our timer
+ this._writing.then(count => this._startTimer(), error => this._startTimer());
+ }
+ return this._pending.promise;
+ },
+
+ _timerCallback() {
+ Services.tm.idleDispatchToMainThread(() => this._deferredSave());
+ },
+
+ _deferredSave() {
+ let pending = this._pending;
+ this._pending = null;
+ let writing = this._writing;
+ this._writing = pending.promise;
+
+ // In either the success or the exception handling case, we don't need to handle
+ // the error from _writing here; it's already being handled in another then()
+ let toSave = null;
+ try {
+ toSave = this._dataProvider();
+ } catch (e) {
+ this.logger.error("Deferred save dataProvider failed", e);
+ writing.catch(error => {})
+ .then(count => {
+ pending.reject(e);
+ });
+ return;
+ }
+
+ writing.catch(error => { return 0; })
+ .then(count => {
+ this.logger.debug("Starting write");
+ this.totalSaves++;
+ this.writeInProgress = true;
+
+ OS.File.writeAtomic(this._path, toSave, {tmpPath: this._path + ".tmp"})
+ .then(
+ result => {
+ this._lastError = null;
+ this.writeInProgress = false;
+ this.logger.debug("Write succeeded");
+ pending.resolve(result);
+ },
+ error => {
+ this._lastError = error;
+ this.writeInProgress = false;
+ this.logger.warn("Write failed", error);
+ pending.reject(error);
+ });
+ });
+ },
+
+ /**
+ * Immediately save the dirty data to disk, skipping
+ * the delay of normal operation. Note that the write
+ * still happens asynchronously in the worker
+ * thread from OS.File.
+ *
+ * There are four possible situations:
+ * 1) Nothing to flush
+ * 2) Data is not currently being written, in-memory copy is dirty
+ * 3) Data is currently being written, in-memory copy is clean
+ * 4) Data is being written and in-memory copy is dirty
+ *
+ * @return Promise<integer> that will resolve when all in-memory data
+ * has finished being flushed, returning the number of bytes
+ * written. If all in-memory data is clean, completes with the
+ * result of the most recent write.
+ */
+ flush() {
+ // If we have pending changes, cancel our timer and set up the write
+ // immediately (_deferredSave queues the write for after the most
+ // recent write completes, if it hasn't already)
+ if (this._pending) {
+ this.logger.debug("Flush called while data is dirty");
+ if (this._timer) {
+ this._timer.cancel();
+ this._timer = null;
+ }
+ this._deferredSave();
+ }
+
+ return this._writing;
+ },
+
+ _finalize() {
+ return this.flush().catch(Cu.reportError);
+ },
+
+};
diff --git a/toolkit/mozapps/extensions/moz.build b/toolkit/mozapps/extensions/moz.build
--- a/toolkit/mozapps/extensions/moz.build
+++ b/toolkit/mozapps/extensions/moz.build
@@ -35,16 +35,17 @@ EXTRA_COMPONENTS += [
EXTRA_PP_COMPONENTS += [
'extensions.manifest',
]
EXTRA_JS_MODULES += [
'AddonManager.jsm',
'ChromeManifestParser.jsm',
+ 'DeferredSave.jsm',
'LightweightThemeManager.jsm',
]
JAR_MANIFESTS += ['jar.mn']
EXPORTS.mozilla += [
'AddonContentPolicy.h',
'AddonManagerStartup.h',
diff --git a/toolkit/mozapps/extensions/test/xpcshell/test_DeferredSave.js b/toolkit/mozapps/extensions/test/xpcshell/test_DeferredSave.js
new file mode 100644
--- /dev/null
+++ b/toolkit/mozapps/extensions/test/xpcshell/test_DeferredSave.js
@@ -0,0 +1,545 @@
+/* Any copyright is dedicated to the Public Domain.
+ * http://creativecommons.org/publicdomain/zero/1.0/
+ */
+
+// Test behaviour of module to perform deferred save of data
+// files to disk
+
+"use strict";
+
+const testFile = gProfD.clone();
+testFile.append("DeferredSaveTest");
+
+Components.utils.import("resource://gre/modules/Promise.jsm");
+
+var DSContext = Components.utils.import("resource://gre/modules/DeferredSave.jsm", {});
+var DeferredSave = DSContext.DeferredSave;
+
+// Test wrapper to let us do promise/task based testing of DeferredSave
+function DeferredSaveTester(aDataProvider) {
+ let tester = {
+ // Deferred for the promise returned by the mock writeAtomic
+ waDeferred: null,
+
+ // The most recent data "written" by the mock OS.File.writeAtomic
+ writtenData: undefined,
+
+ dataToSave: "Data to save",
+
+ save: (aData, aWriteHandler) => {
+ tester.writeHandler = aWriteHandler || writer;
+ tester.dataToSave = aData;
+ return tester.saver.saveChanges();
+ },
+
+ flush: (aWriteHandler) => {
+ tester.writeHandler = aWriteHandler || writer;
+ return tester.saver.flush();
+ },
+
+ get lastError() {
+ return tester.saver.lastError;
+ }
+ };
+
+ // Default write handler for most cases where the test case doesn't need
+ // to do anything while the write is in progress; just completes the write
+ // on the next event loop
+ function writer(aTester) {
+ do_print("default write callback");
+ let length = aTester.writtenData.length;
+ do_execute_soon(() => aTester.waDeferred.resolve(length));
+ }
+
+ if (!aDataProvider)
+ aDataProvider = () => tester.dataToSave;
+
+ tester.saver = new DeferredSave(testFile.path, aDataProvider);
+
+ // Install a mock for OS.File.writeAtomic to let us control the async
+ // behaviour of the promise
+ DSContext.OS.File.writeAtomic = function mock_writeAtomic(aFile, aData, aOptions) {
+ do_print("writeAtomic: " + aFile + " data: '" + aData + "', " + aOptions.toSource());
+ tester.writtenData = aData;
+ tester.waDeferred = Promise.defer();
+ tester.writeHandler(tester);
+ return tester.waDeferred.promise;
+ };
+
+ return tester;
+}
+
+/**
+ * Install a mock nsITimer factory that triggers on the next spin of
+ * the event loop after it is scheduled
+ */
+function setQuickMockTimer() {
+ let quickTimer = {
+ initWithCallback(aFunction, aDelay, aType) {
+ do_print("Starting quick timer, delay = " + aDelay);
+ do_execute_soon(aFunction);
+ },
+ cancel() {
+ do_throw("Attempted to cancel a quickMockTimer");
+ }
+ };
+ DSContext.MakeTimer = () => {
+ do_print("Creating quick timer");
+ return quickTimer;
+ };
+}
+
+/**
+ * Install a mock nsITimer factory in DeferredSave.jsm, returning a promise that resolves
+ * when the client code sets the timer. Test cases can use this to wait for client code to
+ * be ready for a timer event, and then signal the event by calling mockTimer.callback().
+ * This could use some enhancement; clients can re-use the returned timer,
+ * but with this implementation it's not possible for the test to wait for
+ * a second call to initWithCallback() on the re-used timer.
+ * @return Promise{mockTimer} that resolves when initWithCallback()
+ * is called
+ */
+function setPromiseMockTimer() {
+ return new Promise(resolve => {
+ let mockTimer = {
+ callback: null,
+ delay: null,
+ type: null,
+ isCancelled: false,
+
+ initWithCallback(aFunction, aDelay, aType) {
+ do_print("Starting timer, delay = " + aDelay);
+ this.callback = aFunction;
+ this.delay = aDelay;
+ this.type = aType;
+ // cancelled timers can be re-used
+ this.isCancelled = false;
+ resolve(this);
+ },
+ cancel() {
+ do_print("Cancelled mock timer");
+ this.callback = null;
+ this.delay = null;
+ this.type = null;
+ this.isCancelled = true;
+ // If initWithCallback was never called, resolve to let tests check for cancel
+ resolve(this);
+ }
+ };
+ DSContext.MakeTimer = () => {
+ do_print("Creating mock timer");
+ return mockTimer;
+ };
+ });
+}
+
+/**
+ * Return a Promise<null> that resolves after the specified number of milliseconds
+ */
+function delay(aDelayMS) {
+ return new Promise(resolve => {
+ do_timeout(aDelayMS, () => resolve(null));
+ });
+}
+
+// Modify set data once, ask for save, make sure it saves cleanly
+add_task(async function test_basic_save_succeeds() {
+ setQuickMockTimer();
+ let tester = DeferredSaveTester();
+ let data = "Test 1 Data";
+
+ await tester.save(data);
+ do_check_eq(tester.writtenData, data);
+ do_check_eq(1, tester.saver.totalSaves);
+});
+
+// Two saves called during the same event loop, both with callbacks
+// Make sure we save only the second version of the data
+add_task(async function test_two_saves() {
+ setQuickMockTimer();
+ let tester = DeferredSaveTester();
+ let firstCallback_happened = false;
+ let firstData = "Test first save";
+ let secondData = "Test second save";
+
+ // first save should not resolve until after the second one is called,
+ // so we can't just yield this promise
+ tester.save(firstData).then(count => {
+ do_check_eq(secondData, tester.writtenData);
+ do_check_false(firstCallback_happened);
+ firstCallback_happened = true;
+ }, do_report_unexpected_exception);
+
+ await tester.save(secondData);
+ do_check_true(firstCallback_happened);
+ do_check_eq(secondData, tester.writtenData);
+ do_check_eq(1, tester.saver.totalSaves);
+});
+
+// Two saves called with a delay in between, both with callbacks
+// Make sure we save the second version of the data
+add_task(async function test_two_saves_delay() {
+ let timerPromise = setPromiseMockTimer();
+ let tester = DeferredSaveTester();
+ let firstCallback_happened = false;
+ let delayDone = false;
+
+ let firstData = "First data to save with delay";
+ let secondData = "Modified data to save with delay";
+
+ tester.save(firstData).then(count => {
+ do_check_false(firstCallback_happened);
+ do_check_true(delayDone);
+ do_check_eq(secondData, tester.writtenData);
+ firstCallback_happened = true;
+ }, do_report_unexpected_exception);
+
+ // Wait a short time to let async events possibly spawned by the
+ // first tester.save() to run
+ await delay(2);
+ delayDone = true;
+ // request to save modified data
+ let saving = tester.save(secondData);
+ // Yield to wait for client code to set the timer
+ let activeTimer = await timerPromise;
+ // and then trigger it
+ activeTimer.callback();
+ // now wait for the DeferredSave to finish saving
+ await saving;
+ do_check_true(firstCallback_happened);
+ do_check_eq(secondData, tester.writtenData);
+ do_check_eq(1, tester.saver.totalSaves);
+ do_check_eq(0, tester.saver.overlappedSaves);
+});
+
+// Test case where OS.File immediately reports an error when the write begins
+// Also check that the "error" getter correctly returns the error
+// Then do a write that succeeds, and make sure the error is cleared
+add_task(async function test_error_immediate() {
+ let tester = DeferredSaveTester();
+ let testError = new Error("Forced failure");
+ function writeFail(aTester) {
+ aTester.waDeferred.reject(testError);
+ }
+
+ setQuickMockTimer();
+ await tester.save("test_error_immediate", writeFail).then(
+ count => do_throw("Did not get expected error"),
+ error => do_check_eq(testError.message, error.message)
+ );
+ do_check_eq(testError, tester.lastError);
+
+ // This write should succeed and clear the error
+ await tester.save("test_error_immediate succeeds");
+ do_check_eq(null, tester.lastError);
+ // The failed save attempt counts in our total
+ do_check_eq(2, tester.saver.totalSaves);
+});
+
+// Save one set of changes, then while the write is in progress, modify the
+// data two more times. Test that we re-write the dirty data exactly once
+// after the first write succeeds
+add_task(async function dirty_while_writing() {
+ let tester = DeferredSaveTester();
+ let firstData = "First data";
+ let secondData = "Second data";
+ let thirdData = "Third data";
+ let firstCallback_happened = false;
+ let secondCallback_happened = false;
+ let writer = await new Promise(resolve => {
+
+ function writeCallback(aTester) {
+ resolve(aTester.waDeferred);
+ }
+
+ setQuickMockTimer();
+ do_print("First save");
+ tester.save(firstData, writeCallback).then(
+ count => {
+ do_check_false(firstCallback_happened);
+ do_check_false(secondCallback_happened);
+ do_check_eq(tester.writtenData, firstData);
+ firstCallback_happened = true;
+ }, do_report_unexpected_exception);
+
+ do_print("waiting for writer");
+ });
+ do_print("Write started");
+
+ // Delay a bit, modify the data and call saveChanges, delay a bit more,
+ // modify the data and call saveChanges again, another delay,
+ // then complete the in-progress write
+ await delay(1);
+
+ tester.save(secondData).then(
+ count => {
+ do_check_true(firstCallback_happened);
+ do_check_false(secondCallback_happened);
+ do_check_eq(tester.writtenData, thirdData);
+ secondCallback_happened = true;
+ }, do_report_unexpected_exception);
+
+ // wait and then do the third change
+ await delay(1);
+ let thirdWrite = tester.save(thirdData);
+
+ // wait a bit more and then finally finish the first write
+ await delay(1);
+ writer.resolve(firstData.length);
+
+ // Now let everything else finish
+ await thirdWrite;
+ do_check_true(firstCallback_happened);
+ do_check_true(secondCallback_happened);
+ do_check_eq(tester.writtenData, thirdData);
+ do_check_eq(2, tester.saver.totalSaves);
+ do_check_eq(1, tester.saver.overlappedSaves);
+});
+
+// A write callback for the OS.File.writeAtomic mock that rejects write attempts
+function disabled_write_callback(aTester) {
+ do_throw("Should not have written during clean flush");
+}
+
+// special write callback that disables itself to make sure
+// we don't try to write twice
+function write_then_disable(aTester) {
+ do_print("write_then_disable");
+ let length = aTester.writtenData.length;
+ aTester.writeHandler = disabled_write_callback;
+ do_execute_soon(() => aTester.waDeferred.resolve(length));
+}
+
+// Flush tests. First, do an ordinary clean save and then call flush;
+// there should not be another save
+add_task(async function flush_after_save() {
+ setQuickMockTimer();
+ let tester = DeferredSaveTester();
+ let dataToSave = "Flush after save";
+
+ await tester.save(dataToSave);
+ await tester.flush(disabled_write_callback);
+ do_check_eq(1, tester.saver.totalSaves);
+});
+
+// Flush while a write is in progress, but the in-memory data is clean
+add_task(async function flush_during_write() {
+ let tester = DeferredSaveTester();
+ let dataToSave = "Flush during write";
+ let firstCallback_happened = false;
+ let writer = await new Promise(resolve => {
+
+ function writeCallback(aTester) {
+ resolve(aTester.waDeferred);
+ }
+
+ setQuickMockTimer();
+ tester.save(dataToSave, writeCallback).then(
+ count => {
+ do_check_false(firstCallback_happened);
+ firstCallback_happened = true;
+ }, do_report_unexpected_exception);
+
+ });
+
+ // call flush with the write callback disabled, delay a bit more, complete in-progress write
+ let flushing = tester.flush(disabled_write_callback);
+ await delay(2);
+ writer.resolve(dataToSave.length);
+
+ // now wait for the flush to finish
+ await flushing;
+ do_check_true(firstCallback_happened);
+ do_check_eq(1, tester.saver.totalSaves);
+});
+
+// Flush while dirty but write not in progress
+// The data written should be the value at the time
+// flush() is called, even if it is changed later
+add_task(async function flush_while_dirty() {
+ let timerPromise = setPromiseMockTimer();
+ let tester = DeferredSaveTester();
+ let firstData = "Flush while dirty, valid data";
+ let firstCallback_happened = false;
+
+ tester.save(firstData, write_then_disable).then(
+ count => {
+ do_check_false(firstCallback_happened);
+ firstCallback_happened = true;
+ do_check_eq(tester.writtenData, firstData);
+ }, do_report_unexpected_exception);
+
+ // Wait for the timer to be set, but don't trigger it so the write won't start
+ let activeTimer = await timerPromise;
+
+ let flushing = tester.flush();
+
+ // Make sure the timer was cancelled
+ do_check_true(activeTimer.isCancelled);
+
+ // Also make sure that data changed after the flush call
+ // (even without a saveChanges() call) doesn't get written
+ tester.dataToSave = "Flush while dirty, invalid data";
+
+ await flushing;
+ do_check_true(firstCallback_happened);
+ do_check_eq(tester.writtenData, firstData);
+ do_check_eq(1, tester.saver.totalSaves);
+});
+
+// And the grand finale - modify the data, start writing,
+// modify the data again so we're in progress and dirty,
+// then flush, then modify the data again
+// Data for the second write should be taken at the time
+// flush() is called, even if it is modified later
+add_task(async function flush_writing_dirty() {
+ let timerPromise = setPromiseMockTimer();
+ let tester = DeferredSaveTester();
+ let firstData = "Flush first pass data";
+ let secondData = "Flush second pass data";
+ let firstCallback_happened = false;
+ let secondCallback_happened = false;
+ let writeStarted = Promise.defer();
+
+ function writeCallback(aTester) {
+ writeStarted.resolve(aTester.waDeferred);
+ }
+
+ tester.save(firstData, writeCallback).then(
+ count => {
+ do_check_false(firstCallback_happened);
+ do_check_eq(tester.writtenData, firstData);
+ firstCallback_happened = true;
+ }, do_report_unexpected_exception);
+
+ // Trigger the timer callback as soon as the DeferredSave sets it
+ let activeTimer = await timerPromise;
+ activeTimer.callback();
+ let writer = await writeStarted.promise;
+ // the first write has started
+
+ // dirty the data and request another save
+ // after the second save completes, there should not be another write
+ tester.save(secondData, write_then_disable).then(
+ count => {
+ do_check_true(firstCallback_happened);
+ do_check_false(secondCallback_happened);
+ do_check_eq(tester.writtenData, secondData);
+ secondCallback_happened = true;
+ }, do_report_unexpected_exception);
+
+ let flushing = tester.flush(write_then_disable);
+ // Flush should have cancelled our timer
+ do_check_true(activeTimer.isCancelled);
+ tester.dataToSave = "Flush, invalid data: changed late";
+ // complete the first write
+ writer.resolve(firstData.length);
+ // now wait for the second write / flush to complete
+ await flushing;
+ do_check_true(firstCallback_happened);
+ do_check_true(secondCallback_happened);
+ do_check_eq(tester.writtenData, secondData);
+ do_check_eq(2, tester.saver.totalSaves);
+ do_check_eq(1, tester.saver.overlappedSaves);
+});
+
+// A data provider callback that throws an error the first
+// time it is called, and a different error the second time
+// so that tests can (a) make sure the promise is rejected
+// with the error and (b) make sure the provider is only
+// called once in case of error
+const expectedDataError = "Failed to serialize data";
+var badDataError = null;
+function badDataProvider() {
+ let err = new Error(badDataError);
+ badDataError = "badDataProvider called twice";
+ throw err;
+}
+
+// Handle cases where data provider throws
+// First, throws during a normal save
+add_task(async function data_throw() {
+ setQuickMockTimer();
+ badDataError = expectedDataError;
+ let tester = DeferredSaveTester(badDataProvider);
+ await tester.save("data_throw").then(
+ count => do_throw("Expected serialization failure"),
+ error => do_check_eq(error.message, expectedDataError));
+});
+
+// Now, throws during flush
+add_task(async function data_throw_during_flush() {
+ badDataError = expectedDataError;
+ let tester = DeferredSaveTester(badDataProvider);
+ let firstCallback_happened = false;
+
+ setPromiseMockTimer();
+ // Write callback should never be called
+ tester.save("data_throw_during_flush", disabled_write_callback).then(
+ count => do_throw("Expected serialization failure"),
+ error => {
+ do_check_false(firstCallback_happened);
+ do_check_eq(error.message, expectedDataError);
+ firstCallback_happened = true;
+ });
+
+ // flush() will cancel the timer
+ await tester.flush(disabled_write_callback).then(
+ count => do_throw("Expected serialization failure"),
+ error => do_check_eq(error.message, expectedDataError)
+ );
+
+ do_check_true(firstCallback_happened);
+});
+
+// Try to reproduce race condition. The observed sequence of events:
+// saveChanges
+// start writing
+// saveChanges
+// finish writing (need to restart delayed timer)
+// saveChanges
+// flush
+// write starts
+// actually restart timer for delayed write
+// write completes
+// delayed timer goes off, throws error because DeferredSave has been torn down
+add_task(async function delay_flush_race() {
+ let timerPromise = setPromiseMockTimer();
+ let tester = DeferredSaveTester();
+ let firstData = "First save";
+ let secondData = "Second save";
+ let thirdData = "Third save";
+ let writeStarted = Promise.defer();
+
+ function writeCallback(aTester) {
+ writeStarted.resolve(aTester.waDeferred);
+ }
+
+ // This promise won't resolve until after writeStarted
+ let firstSave = tester.save(firstData, writeCallback);
+ (await timerPromise).callback();
+
+ let writer = await writeStarted.promise;
+ // the first write has started
+
+ // dirty the data and request another save
+ let secondSave = tester.save(secondData);
+
+ // complete the first write
+ writer.resolve(firstData.length);
+ await firstSave;
+ do_check_eq(tester.writtenData, firstData);
+
+ tester.save(thirdData);
+ let flushing = tester.flush();
+
+ await secondSave;
+ do_check_eq(tester.writtenData, thirdData);
+
+ await flushing;
+ do_check_eq(tester.writtenData, thirdData);
+
+ // Our DeferredSave should not have a _timer here; if it
+ // does, the bug caused a reschedule
+ do_check_eq(null, tester.saver._timer);
+});
diff --git a/toolkit/mozapps/extensions/test/xpcshell/xpcshell.ini b/toolkit/mozapps/extensions/test/xpcshell/xpcshell.ini
--- a/toolkit/mozapps/extensions/test/xpcshell/xpcshell.ini
+++ b/toolkit/mozapps/extensions/test/xpcshell/xpcshell.ini
@@ -12,16 +12,17 @@ support-files =
[test_addonStartup.js]
[test_asyncBlocklistLoad.js]
tags = blocklist
[test_blocklist_gfx.js]
tags = blocklist
[test_cache_certdb.js]
run-if = addon_signing
[test_cacheflush.js]
+[test_DeferredSave.js]
[test_gmpProvider.js]
skip-if = appname != "firefox"
[test_invalid_install_rdf.js]
[test_isReady.js]
[test_pluginInfoURL.js]
tags = blocklist
[test_provider_markSafe.js]
[test_provider_shutdown.js]
# HG changeset patch
# User RealDolos <[email protected]>
# Date 1517409436 -3600
# Wed Jan 31 15:37:16 2018 +0100
# Node ID b8488b438fb75bcd1e50faa150dcad2989b86010
# Parent 533807979becdb02dc086494a3973f27e63a1a32
Make prefwindows work again
diff --git a/toolkit/content/jar.mn b/toolkit/content/jar.mn
--- a/toolkit/content/jar.mn
+++ b/toolkit/content/jar.mn
@@ -80,16 +80,17 @@ toolkit.jar:
content/global/bindings/general.xml (widgets/general.xml)
content/global/bindings/groupbox.xml (widgets/groupbox.xml)
content/global/bindings/listbox.xml (widgets/listbox.xml)
content/global/bindings/menu.xml (widgets/menu.xml)
content/global/bindings/menulist.xml (widgets/menulist.xml)
content/global/bindings/notification.xml (widgets/notification.xml)
content/global/bindings/numberbox.xml (widgets/numberbox.xml)
content/global/bindings/popup.xml (widgets/popup.xml)
+* content/global/bindings/preferences.xml (widgets/preferences.xml)
content/global/bindings/progressmeter.xml (widgets/progressmeter.xml)
content/global/bindings/radio.xml (widgets/radio.xml)
content/global/bindings/remote-browser.xml (widgets/remote-browser.xml)
content/global/bindings/resizer.xml (widgets/resizer.xml)
content/global/bindings/richlistbox.xml (widgets/richlistbox.xml)
content/global/bindings/scale.xml (widgets/scale.xml)
content/global/bindings/scrollbar.xml (widgets/scrollbar.xml)
content/global/bindings/scrollbox.xml (widgets/scrollbox.xml)
diff --git a/toolkit/content/xul.css b/toolkit/content/xul.css
--- a/toolkit/content/xul.css
+++ b/toolkit/content/xul.css
@@ -946,16 +946,66 @@ wizardpage {
.wizard-header {
-moz-binding: url("chrome://global/content/bindings/wizard.xml#wizard-header");
}
.wizard-buttons {
-moz-binding: url("chrome://global/content/bindings/wizard.xml#wizard-buttons");
}
+/********** preferences ********/
+
+prefwindow,
+prefwindow:root /* override :root from above */ {
+ -moz-binding: url("chrome://global/content/bindings/preferences.xml#prefwindow");
+ -moz-box-orient: vertical;
+}
+
+prefpane {
+ -moz-binding: url("chrome://global/content/bindings/preferences.xml#prefpane");
+ -moz-box-orient: vertical;
+}
+
+prefwindow > .paneDeckContainer {
+ overflow: hidden;
+}
+
+prefpane > .content-box {
+ overflow: hidden;
+}
+
+prefwindow[type="child"] > .paneDeckContainer {
+ overflow: -moz-hidden-unscrollable;
+}
+
+prefwindow[type="child"] > prefpane > .content-box {
+ -moz-box-flex: 1;
+ overflow: -moz-hidden-unscrollable;
+}
+
+preferences {
+ -moz-binding: url("chrome://global/content/bindings/preferences.xml#preferences");
+ visibility: collapse;
+}
+
+preference {
+ -moz-binding: url("chrome://global/content/bindings/preferences.xml#preference");
+ visibility: collapse;
+}
+
+radio[pane] {
+ -moz-binding: url("chrome://global/content/bindings/preferences.xml#panebutton") !important;
+ -moz-box-orient: vertical;
+ -moz-box-align: center;
+}
+
+prefwindow[chromehidden~="toolbar"] .chromeclass-toolbar {
+ display: none;
+}
+
/********** Rich Listbox ********/