aboutsummaryrefslogtreecommitdiff
path: root/contexts/data/lib/closure-library/closure/goog/disposable/disposable_test.html
blob: 3d638a1098eae08fca2f66b45c0db32e7ebee5e3 (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
<!DOCTYPE html>
<html>
<!--
Copyright 2008 The Closure Library Authors. All Rights Reserved.

Use of this source code is governed by the Apache License, Version 2.0.
See the COPYING file for details.
-->
<!-- Author:  attila@google.com (Attila Bodis) -->
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
  <title>Closure Unit Tests - goog.Disposable</title>
  <script src="../base.js"></script>
  <script>
    goog.require('goog.Disposable');
    goog.require('goog.testing.jsunit');
    goog.require('goog.testing.recordFunction');
  </script>
</head>
<body>
  <div id="someElement">Hello!</div>
  <script>
    var d1, d2;

    // Sample subclass of goog.Disposable.

    function DisposableTest() {
      goog.Disposable.call(this);
      this.element = document.getElementById('someElement');
    }
    goog.inherits(DisposableTest, goog.Disposable);

    DisposableTest.prototype.disposeInternal = function() {
      DisposableTest.superClass_.disposeInternal.call(this);
      delete this.element;
    };

    // Class that doesn't inherit from goog.Disposable, but implements the
    // disposable interface via duck typing.

    function DisposableDuck() {
      this.element = document.getElementById('someElement');
    }

    DisposableDuck.prototype.dispose = function() {
      delete this.element;
    };

    // Class which calls dispose recursively.

    function RecursiveDisposable() {
      this.disposedCount = 0;
    }
    goog.inherits(RecursiveDisposable, goog.Disposable);

    RecursiveDisposable.prototype.disposeInternal = function() {
      ++this.disposedCount;
      assertEquals('Disposed too many times', 1, this.disposedCount);
      this.dispose();
    };

    // Test methods.

    function setUp() {
      d1 = new goog.Disposable();
      d2 = new DisposableTest();
    }

    function tearDown() {
      goog.Disposable.MONITORING_MODE = goog.Disposable.MonitoringMode.OFF;
      goog.Disposable.instances_ = {};
      d1.dispose();
      d2.dispose();
    }

    function testConstructor() {
      assertFalse(d1.isDisposed());
      assertFalse(d2.isDisposed());
      assertEquals(document.getElementById('someElement'), d2.element);
    }

    function testDispose() {
      assertFalse(d1.isDisposed());
      d1.dispose();
      assertTrue('goog.Disposable instance should have been disposed of',
          d1.isDisposed());

      assertFalse(d2.isDisposed());
      d2.dispose();
      assertTrue('goog.DisposableTest instance should have been disposed of',
          d2.isDisposed());
    }

    function testDisposeInternal() {
      assertNotUndefined(d2.element);
      d2.dispose();
      assertUndefined('goog.DisposableTest.prototype.disposeInternal should ' +
          'have deleted the element reference', d2.element);
    }

    function testDisposeAgain() {
      d2.dispose();
      assertUndefined('goog.DisposableTest.prototype.disposeInternal should ' +
          'have deleted the element reference', d2.element);
      // Manually reset the element to a non-null value, and call dispose().
      // Because the object is already marked disposed, disposeInternal won't
      // be called again.
      d2.element = document.getElementById('someElement');
      d2.dispose();
      assertNotUndefined('disposeInternal should not be called again if the ' +
          'object has already been marked disposed', d2.element);
    }

    function testDisposeWorksRecursively() {
      new RecursiveDisposable().dispose();
    }

    function testStaticDispose() {
      assertFalse(d1.isDisposed());
      goog.dispose(d1);
      assertTrue('goog.Disposable instance should have been disposed of',
          d1.isDisposed());

      assertFalse(d2.isDisposed());
      goog.dispose(d2);
      assertTrue('goog.DisposableTest instance should have been disposed of',
          d2.isDisposed());

      var duck = new DisposableDuck();
      assertNotUndefined(duck.element);
      goog.dispose(duck);
      assertUndefined('goog.dispose should have disposed of object that ' +
          'implements the disposable interface', duck.element);
    }

    function testStaticDisposeOnNonDisposableType() {
      // Call goog.dispose() with various types and make sure no errors are
      // thrown.
      goog.dispose(true);
      goog.dispose(false);
      goog.dispose(null);
      goog.dispose(undefined);
      goog.dispose('');
      goog.dispose([]);
      goog.dispose({});

      function A() {}
      goog.dispose(new A());
    }

    function testMonitoringFailure() {
      function BadDisposable() {};
      goog.inherits(BadDisposable, goog.Disposable);

      goog.Disposable.MONITORING_MODE =
          goog.Disposable.MonitoringMode.PERMANENT;

      var badDisposable = new BadDisposable;
      assertArrayEquals('no disposable objects registered', [],
          goog.Disposable.getUndisposedObjects());
      assertThrows('the base ctor should have been called',
          goog.bind(badDisposable.dispose, badDisposable));
    }

    function testGetUndisposedObjects() {
      goog.Disposable.MONITORING_MODE =
          goog.Disposable.MonitoringMode.PERMANENT;

      var d1 = new DisposableTest();
      var d2 = new DisposableTest();
      assertSameElements('the undisposed instances', [d1, d2],
          goog.Disposable.getUndisposedObjects());

      d1.dispose();
      assertSameElements('1 undisposed instance left', [d2],
          goog.Disposable.getUndisposedObjects());

      d1.dispose();
      assertSameElements('second disposal of the same object is no-op', [d2],
          goog.Disposable.getUndisposedObjects());

      d2.dispose();
      assertSameElements('all objects have been disposed of', [],
          goog.Disposable.getUndisposedObjects());
    }

    function testClearUndisposedObjects() {
      goog.Disposable.MONITORING_MODE =
          goog.Disposable.MonitoringMode.PERMANENT;

      var d1 = new DisposableTest();
      var d2 = new DisposableTest();
      d2.dispose();
      goog.Disposable.clearUndisposedObjects()
      assertSameElements('no undisposed object in the registry', [],
          goog.Disposable.getUndisposedObjects());

      assertThrows('disposal after clearUndisposedObjects()', function() {
        d1.dispose();
      });

      // d2 is already disposed of, the redisposal shouldn't throw error.
      d2.dispose();
    }

    function testRegisterDisposable() {
      var d1 = new DisposableTest();
      var d2 = new DisposableTest();

      d1.registerDisposable(d2);
      d1.dispose();

      assertTrue('d2 should be disposed when d1 is disposed', d2.isDisposed());
    }

    function testDisposeAll() {
      var d1 = new DisposableTest();
      var d2 = new DisposableTest();

      goog.disposeAll(d1, d2);

      assertTrue('d1 should be disposed', d1.isDisposed());
      assertTrue('d2 should be disposed', d2.isDisposed());
    }

    function testDisposeAllRecursive() {
      var d1 = new DisposableTest();
      var d2 = new DisposableTest();
      var d3 = new DisposableTest();
      var d4 = new DisposableTest();

      goog.disposeAll(d1, [[d2], d3, d4]);

      assertTrue('d1 should be disposed', d1.isDisposed());
      assertTrue('d2 should be disposed', d2.isDisposed());
      assertTrue('d3 should be disposed', d3.isDisposed());
      assertTrue('d4 should be disposed', d4.isDisposed());
    }

    function testCreationStack() {
      if (!new Error().stack)
        return;
      goog.Disposable.MONITORING_MODE =
          goog.Disposable.MonitoringMode.PERMANENT;
      var disposableStack = new DisposableTest().creationStack;
      // Check that the name of this test function occurs in the stack trace.
      assertNotEquals(-1, disposableStack.indexOf('testCreationStack'));
    }

    function testOnDisposeCallback() {
      var callback = goog.testing.recordFunction();
      d1.addOnDisposeCallback(callback);
      assertEquals('callback called too early', 0, callback.getCallCount());
      d1.dispose();
      assertEquals('callback should be called once on dispose',
          1, callback.getCallCount());
    }

    function testOnDisposeCallbackOrder() {
      var invocations = [];
      var callback = function(str) {
        invocations.push(str);
      };
      d1.addOnDisposeCallback(goog.partial(callback, 'a'));
      d1.addOnDisposeCallback(goog.partial(callback, 'b'));
      goog.dispose(d1);
      assertArrayEquals('callbacks should be called in chronological order',
          ['a', 'b'], invocations);
    }

    function testInteractiveMonitoring() {
      var d1 = new DisposableTest();
      goog.Disposable.MONITORING_MODE =
          goog.Disposable.MonitoringMode.INTERACTIVE;
      var d2 = new DisposableTest();

      assertSameElements('only 1 undisposed instance tracked', [d2],
          goog.Disposable.getUndisposedObjects());

      // No errors should be thrown.
      d1.dispose();

      assertSameElements('1 undisposed instance left', [d2],
          goog.Disposable.getUndisposedObjects());

      d2.dispose();
      assertSameElements('all disposed', [],
          goog.Disposable.getUndisposedObjects());
    }
  </script>
</body>
</html>