summaryrefslogtreecommitdiffstats
path: root/dom/base/test/test_domrequesthelper.xul
blob: 4365e4f0e9412d81dd0facc761a960781688ce6f (plain)
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
<?xml version="1.0"?>
<!--
  Any copyright is dedicated to the Public Domain.
  http://creativecommons.org/publicdomain/zero/1.0/
-->
<?xml-stylesheet href="chrome://global/skin" type="text/css"?>
<?xml-stylesheet href="chrome://mochikit/content/tests/SimpleTest/test.css" type="text/css"?>

<window title="DOMRequestHelper Test"
        xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"
        onload="start();">

  <script type="application/javascript"
          src="chrome://mochikit/content/tests/SimpleTest/SimpleTest.js"/>

  <script type="application/javascript">
  <![CDATA[
    const Cc = Components.classes;
    const Cu = Components.utils;
    const Ci = Components.interfaces;
    Cu.import("resource://gre/modules/DOMRequestHelper.jsm");
    let obs = Cc["@mozilla.org/observer-service;1"].
              getService(Ci.nsIObserverService);
    let ppmm = Cc["@mozilla.org/parentprocessmessagemanager;1"].
              getService(Ci.nsIMessageBroadcaster);

    function DummyHelperSubclass() {
      this.onuninit = null;
    }
    DummyHelperSubclass.prototype = {
      __proto__: DOMRequestIpcHelper.prototype,
      uninit: function() {
        if (typeof this.onuninit === "function") {
          this.onuninit();
        }
        this.onuninit = null;
      }
    };

    var dummy = new DummyHelperSubclass();
    var isDOMRequestHelperDestroyed = false;

    /**
     * Init & destroy.
     */
    function initDOMRequestHelperTest(aMessages) {
      // If we haven't initialized the DOMRequestHelper object, its private
      // properties will be undefined, but once destroyDOMRequestHelper is
      // called, they're set to null.
      var expectedPrivatePropertyValues =
        isDOMRequestHelperDestroyed ? null : undefined;

      is(dummy._requests, expectedPrivatePropertyValues, "Request is expected");
      is(dummy._messages, undefined, "Messages is undefined");
      is(dummy._window, expectedPrivatePropertyValues, "Window is expected");

      dummy.initDOMRequestHelper(window, aMessages);

      ok(dummy._window, "Window exists");
      is(dummy._window, window, "Correct window");
      if (aMessages) {
        is(typeof dummy._listeners, "object", "Listeners is an object");
      }
    }

    function destroyDOMRequestHelperTest() {
      dummy.destroyDOMRequestHelper();
      isDOMRequestHelperDestroyed = true;

      is(dummy._requests, null, "Request is null");
      is(dummy._messages, undefined, "Messages is undefined");
      is(dummy._window, null, "Window is null");
    }

    /**
     * Message listeners.
     */
    function checkMessageListeners(aExpectedListeners, aCount) {
      info("Checking message listeners\n" + "Expected listeners " +
           JSON.stringify(aExpectedListeners) + " \nExpected count " + aCount);
      let count = 0;
      Object.keys(dummy._listeners).forEach(function(name) {
        count++;
        is(aExpectedListeners[name].weakRef, dummy._listeners[name].weakRef,
           "Message found " + name + " - Same weakRef");
        is(aExpectedListeners[name].count, dummy._listeners[name].count,
           "Message found " + name + " - Same count");
      });
      is(aCount, count, "Correct number of listeners");
    }

    function addMessageListenersTest(aMessages, aExpectedListeners, aCount) {
      dummy.addMessageListeners(aMessages);
      info(JSON.stringify(dummy._listeners));
      checkMessageListeners(aExpectedListeners, aCount);
    }

    function removeMessageListenersTest(aMessages, aExpectedListeners, aCount) {
      dummy.removeMessageListeners(aMessages);
      checkMessageListeners(aExpectedListeners, aCount);
    }

    /**
     * Utility function to test window destruction behavior.  In general this
     * function does the following:
     *
     *  1) Create a new iframe
     *  2) Create a new DOMRequestHelper
     *  3) initDOMRequestHelper(), optionally with weak or strong listeners
     *  4) Optionally force a garbage collection to reap weak references
     *  5) Destroy the iframe triggering an inner-window-destroyed event
     *  6) Callback with a boolean indicating if DOMRequestHelper.uninit() was
     *     called.
     *
     * Example usage:
     *
     *    checkWindowDestruction({ messages: ["foo"], gc: true },
     *                           function(uninitCalled) {
     *      // expect uninitCalled === false since GC with only weak refs
     *    });
     */
    const TOPIC = "inner-window-destroyed";
    function checkWindowDestruction(aOptions, aCallback) {
      aOptions = aOptions || {};
      aOptions.messages = aOptions.messages || [];
      aOptions.gc = !!aOptions.gc;

      if (typeof aCallback !== "function") {
        aCallback = function() { };
      }

      let uninitCalled = false;

      // Use a secondary observer so we know when to expect the uninit().  We
      // can then reasonably expect uninitCalled to be set properly on the
      // next tick.
      let observer = {
        observe: function(aSubject, aTopic, aData) {
          if (aTopic !== TOPIC) {
            return;
          }
          obs.removeObserver(observer, TOPIC);
          setTimeout(function() {
            aCallback(uninitCalled);
          });
        }
      };

      let frame = document.createElement("iframe");
      frame.onload = function() {
        obs.addObserver(observer, TOPIC, false);
        // Create dummy DOMRequestHelper specific to checkWindowDestruction()
        let cwdDummy = new DummyHelperSubclass();
        cwdDummy.onuninit = function() {
          uninitCalled = true;

          if (!aOptions.messages || !aOptions.messages.length) {
            return;
          }

          // If all message listeners are removed, cwdDummy.receiveMessage
          // should never be called.
          ppmm.broadcastAsyncMessage(aOptions.messages[0].name);
        };

        // Test if we still receive messages from ppmm.
        cwdDummy.receiveMessage = function(aMessage) {
          ok(false, "cwdDummy.receiveMessage should NOT be called: " + aMessage.name);
        };

        cwdDummy.initDOMRequestHelper(frame.contentWindow, aOptions.messages);
        // Make sure to clear our strong ref here so that we can test our
        // weak reference listeners and observer.
        cwdDummy = null;
        if (aOptions.gc) {
          Cu.schedulePreciseGC(function() {
            SpecialPowers.DOMWindowUtils.cycleCollect();
            SpecialPowers.DOMWindowUtils.garbageCollect();
            SpecialPowers.DOMWindowUtils.garbageCollect();
            document.documentElement.removeChild(frame);
          });
          return;
        }
        document.documentElement.removeChild(frame);
      };
      document.documentElement.appendChild(frame);
    }

    /**
     * Test steps.
     */
    var tests = [
      function() {
        info("== InitDOMRequestHelper no messages");
        initDOMRequestHelperTest(null);
        next();
      },
      function() {
        info("== DestroyDOMRequestHelper");
        destroyDOMRequestHelperTest();
        next();
      },
      function() {
        info("== InitDOMRequestHelper empty array");
        initDOMRequestHelperTest([]);
        checkMessageListeners({}, 0);
        next();
      },
      function() {
        info("== DestroyDOMRequestHelper");
        destroyDOMRequestHelperTest();
        next();
      },
      function() {
        info("== InitDOMRequestHelper with strings array");
        initDOMRequestHelperTest(["name1", "nameN"]);
        checkMessageListeners({"name1": {weakRef: false, count: 1},
                               "nameN": {weakRef: false, count: 1}}, 2);
        next();
      },
      function() {
        info("== DestroyDOMRequestHelper");
        destroyDOMRequestHelperTest();
        next();
      },
      function() {
        info("== InitDOMRequestHelper with objects array");
        initDOMRequestHelperTest([{
          name: "name1",
          weakRef: false
        }, {
          name: "nameN",
          weakRef: true
        }]);
        checkMessageListeners({
          "name1": {weakRef: false, count: 1},
          "nameN": {weakRef: true,  count: 1}
        }, 2);
        next();
      },
      function() {
        info("== AddMessageListeners empty array");
        addMessageListenersTest([], {
        "name1": {weakRef: false, count: 1},
        "nameN": {weakRef: true,  count: 1}
        }, 2);
        next();
      },
      function() {
        info("== AddMessageListeners null");
        addMessageListenersTest(null, {
          "name1": {weakRef: false, count: 1},
          "nameN": {weakRef: true,  count: 1}
          }, 2);
        next();
      },
      function() {
        info("== AddMessageListeners new listener, string only");
        addMessageListenersTest("name2", {
          "name1": {weakRef: false, count: 1},
          "name2": {weakRef: false, count: 1},
          "nameN": {weakRef: true,  count: 1}
        }, 3);
        next();
      },
      function() {
        info("== AddMessageListeners new listeners, strings array");
        addMessageListenersTest(["name3", "name4"], {
          "name1": {weakRef: false, count: 1},
          "name2": {weakRef: false, count: 1},
          "name3": {weakRef: false, count: 1},
          "name4": {weakRef: false, count: 1},
          "nameN": {weakRef: true,  count: 1}
        }, 5);
        next();
      },
      function() {
        info("== AddMessageListeners new listeners, objects array");
        addMessageListenersTest([{
          name: "name5",
          weakRef: true
        }, {
          name: "name6",
          weakRef: false
        }], {
          "name1": {weakRef: false, count: 1},
          "name2": {weakRef: false, count: 1},
          "name3": {weakRef: false, count: 1},
          "name4": {weakRef: false, count: 1},
          "name5": {weakRef: true,  count: 1},
          "name6": {weakRef: false, count: 1},
          "nameN": {weakRef: true,  count: 1}
        }, 7);
        next();
      },
      function() {
        info("== RemoveMessageListeners, null");
        removeMessageListenersTest(null, {
          "name1": {weakRef: false, count: 1},
          "name2": {weakRef: false, count: 1},
          "name3": {weakRef: false, count: 1},
          "name4": {weakRef: false, count: 1},
          "name5": {weakRef: true,  count: 1},
          "name6": {weakRef: false, count: 1},
          "nameN": {weakRef: true,  count: 1}
        }, 7);
        next();
      },
      function() {
        info("== RemoveMessageListeners, one message");
        removeMessageListenersTest("name1", {
          "name2": {weakRef: false, count: 1},
          "name3": {weakRef: false, count: 1},
          "name4": {weakRef: false, count: 1},
          "name5": {weakRef: true,  count: 1},
          "name6": {weakRef: false, count: 1},
          "nameN": {weakRef: true,  count: 1}
        }, 6);
        next();
      },
      function() {
        info("== RemoveMessageListeners, array of messages");
        removeMessageListenersTest(["name2", "name3"], {
          "name4": {weakRef: false, count: 1},
          "name5": {weakRef: true,  count: 1},
          "name6": {weakRef: false, count: 1},
          "nameN": {weakRef: true,  count: 1}
        }, 4);
        next();
      },
      function() {
        info("== RemoveMessageListeners, unknown message");
        removeMessageListenersTest("unknown", {
          "name4": {weakRef: false, count: 1},
          "name5": {weakRef: true,  count: 1},
          "name6": {weakRef: false, count: 1},
          "nameN": {weakRef: true,  count: 1}
        }, 4);
        next();
      },
      function() {
        try {
          info("== AddMessageListeners, same message, same kind");
          addMessageListenersTest("name4", {
            "name4": {weakRef: false, count: 2},
            "name5": {weakRef: true,  count: 1},
            "name6": {weakRef: false, count: 1},
            "nameN": {weakRef: true,  count: 1}
          }, 4);
          next();
        } catch (ex) {
          ok(false, "Unexpected exception " + ex);
        }
      },
      function() {
        info("== AddMessageListeners, same message, different kind");
        try {
          addMessageListenersTest({name: "name4", weakRef: true}, {
            "name4": {weakRef: false, count: 2},
            "name5": {weakRef: true,  count: 1},
            "name6": {weakRef: false, count: 1},
            "nameN": {weakRef: true,  count: 1}
          }, 4);
          ok(false, "Should have thrown an exception");
        } catch (ex) {
          ok(true, "Expected exception");
          next();
        }
      },
      function() {
        info("== RemoveMessageListeners, message with two listeners");
        try {
          removeMessageListenersTest(["name4", "name5"], {
            "name4": {weakRef: false, count: 1},
            "name6": {weakRef: false, count: 1},
            "nameN": {weakRef: true,  count: 1}
          }, 3);
          next();
        } catch (ex) {
          ok(false, "Unexpected exception " + ex);
        }
      },
      function() {
        info("== Test createRequest()");
        ok(DOMRequest, "DOMRequest object exists");
        var req = dummy.createRequest();
        ok(req instanceof DOMRequest, "Returned a DOMRequest");
        next();
      },
      function() {
        info("== Test getRequestId(), removeRequest() and getRequest()");
        var req = dummy.createRequest();
        var id = dummy.getRequestId(req);
        is(typeof id, "string", "id is a string");
        var req_ = dummy.getRequest(id);
        is(req, req_, "Got correct request");
        dummy.removeRequest(id);
        req = dummy.getRequest(id);
        is(req, undefined, "No request");
        next();
      },
      function() {
        info("== Test createPromise()");
        ok(Promise, "Promise object exists");
        var promise = dummy.createPromise(function(resolve, reject) {
          resolve(true);
        });
        ok(promise instanceof Promise, "Returned a Promise");
        promise.then(next);
      },
      function() {
        info("== Test createPromiseWithId()");
        var _resolverId;
        var promise = dummy.createPromiseWithId(function(resolverId) {
          _resolverId = resolverId;
        });
        var resolver = dummy.getPromiseResolver(_resolverId);
        ok(promise instanceof Promise, "Returned a Promise");
        ok(typeof _resolverId === "string", "resolverId is a string");
        ok(resolver != null, "resolverId is a valid id");
        next();
      },
      function() {
        info("== Test getResolver()");
        var id;
        var resolver;
        var promise = dummy.createPromise(function(resolve, reject) {
          var r = { resolve: resolve, reject: reject };
          id = dummy.getPromiseResolverId(r);
          resolver = r;
          ok(typeof id === "string", "id is a string");
          r.resolve(true);
        }).then(function(unused) {
          var r = dummy.getPromiseResolver(id);
          ok(resolver === r, "Get succeeded");
          next();
        });
      },
      function() {
        info("== Test removeResolver");
        var id;
        var promise = dummy.createPromise(function(resolve, reject) {
          var r = { resolve: resolve, reject: reject };
          id = dummy.getPromiseResolverId(r);
          ok(typeof id === "string", "id is a string");

          var resolver = dummy.getPromiseResolver(id);
          info("Got resolver " + JSON.stringify(resolver));
          ok(resolver === r, "Resolver get succeeded");

          r.resolve(true);
        }).then(function(unused) {
          dummy.removePromiseResolver(id);
          var resolver = dummy.getPromiseResolver(id);
          ok(resolver === undefined, "removeResolver: get failed");
          next();
        });
      },
      function() {
        info("== Test takeResolver");
        var id;
        var resolver;
        var promise = dummy.createPromise(function(resolve, reject) {
          var r = { resolve: resolve, reject: reject };
          id = dummy.getPromiseResolverId(r);
          resolver = r;
          ok(typeof id === "string", "id is a string");

          var gotR = dummy.getPromiseResolver(id);
          ok(gotR === r, "resolver get succeeded");

          r.resolve(true);
        }).then(function(unused) {
          var r = dummy.takePromiseResolver(id);
          ok(resolver === r, "take should succeed");

          r = dummy.getPromiseResolver(id);
          ok(r === undefined, "takeResolver: get failed");
          next();
        });
      },
      function() {
        info("== Test window destroyed without messages and without GC");
        checkWindowDestruction({ gc: false }, function(uninitCalled) {
          ok(uninitCalled, "uninit() should have been called");
          next();
        });
      },
      function() {
        info("== Test window destroyed without messages and with GC");
        checkWindowDestruction({ gc: true }, function(uninitCalled) {
          ok(!uninitCalled, "uninit() should NOT have been called");
          next();
        });
      },
      function() {
        info("== Test window destroyed with weak messages and without GC");
        checkWindowDestruction({ messages: [{ name: "foo", weakRef: true }],
                                 gc: false }, function(uninitCalled) {
          ok(uninitCalled, "uninit() should have been called");
          next();
        });
      },
      function() {
        info("== Test window destroyed with weak messages and with GC");
        checkWindowDestruction({ messages: [{ name: "foo", weakRef: true }],
                                 gc: true }, function(uninitCalled) {
          ok(!uninitCalled, "uninit() should NOT have been called");
          next();
        });
      },
      function() {
        info("== Test window destroyed with strong messages and without GC");
        checkWindowDestruction({ messages: [{ name: "foo", weakRef: false }],
                                 gc: false }, function(uninitCalled) {
          ok(uninitCalled, "uninit() should have been called");
          next();
        });
      },
      function() {
        info("== Test window destroyed with strong messages and with GC");
        checkWindowDestruction({ messages: [{ name: "foo", weakRef: false }],
                                 gc: true }, function(uninitCalled) {
          ok(uninitCalled, "uninit() should have been called");
          next();
        });
      }
    ];

    function next() {
      if (!tests.length) {
        SimpleTest.finish();
        return;
      }

      var test = tests.shift();
      test();
    }

    function start() {
      SimpleTest.waitForExplicitFinish();
      next();
    }
  ]]>
  </script>

  <body xmlns="http://www.w3.org/1999/xhtml">
    <p id="display"></p>
    <div id="content" style="display: none"></div>
    <pre id="test"></pre>
  </body>
</window>