-
-
Notifications
You must be signed in to change notification settings - Fork 5
/
destroyable.js
203 lines (175 loc) · 5.93 KB
/
destroyable.js
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
import { DEBUG } from '@glimmer/env';
import { debugToString } from '@glimmer/util';
import { scheduleDestroy, scheduleDestroyed } from '@glimmer/global-context';
let DESTROYABLE_META = new WeakMap();
function push(collection, newItem) {
if (collection === null) {
return newItem;
} else if (Array.isArray(collection)) {
collection.push(newItem);
return collection;
} else {
return [collection, newItem];
}
}
function iterate(collection, fn) {
if (Array.isArray(collection)) {
for (let i = 0; i < collection.length; i++) {
fn(collection[i]);
}
} else if (collection !== null) {
fn(collection);
}
}
function remove(collection, item, message) {
if (DEBUG) {
let collectionIsItem = collection === item;
let collectionContainsItem = Array.isArray(collection) && collection.indexOf(item) !== -1;
if (!collectionIsItem && !collectionContainsItem) {
throw new Error(String(message));
}
}
if (Array.isArray(collection) && collection.length > 1) {
let index = collection.indexOf(item);
collection.splice(index, 1);
return collection;
} else {
return null;
}
}
function getDestroyableMeta(destroyable) {
let meta = DESTROYABLE_META.get(destroyable);
if (meta === undefined) {
meta = {
parents: null,
children: null,
eagerDestructors: null,
destructors: null,
state: 0
/* Live */
};
if (DEBUG) {
meta.source = destroyable;
}
DESTROYABLE_META.set(destroyable, meta);
}
return meta;
}
function associateDestroyableChild(parent, child) {
if (DEBUG && isDestroying(parent)) {
throw new Error('Attempted to associate a destroyable child with an object that is already destroying or destroyed');
}
let parentMeta = getDestroyableMeta(parent);
let childMeta = getDestroyableMeta(child);
parentMeta.children = push(parentMeta.children, child);
childMeta.parents = push(childMeta.parents, parent);
return child;
}
function registerDestructor(destroyable, destructor, eager = false) {
if (DEBUG && isDestroying(destroyable)) {
throw new Error('Attempted to register a destructor with an object that is already destroying or destroyed');
}
let meta = getDestroyableMeta(destroyable);
let destructorsKey = eager === true ? 'eagerDestructors' : 'destructors';
meta[destructorsKey] = push(meta[destructorsKey], destructor);
return destructor;
}
function unregisterDestructor(destroyable, destructor, eager = false) {
if (DEBUG && isDestroying(destroyable)) {
throw new Error('Attempted to unregister a destructor with an object that is already destroying or destroyed');
}
let meta = getDestroyableMeta(destroyable);
let destructorsKey = eager === true ? 'eagerDestructors' : 'destructors';
meta[destructorsKey] = remove(meta[destructorsKey], destructor, DEBUG && 'attempted to remove a destructor that was not registered with the destroyable');
} ////////////
function destroy(destroyable) {
let meta = getDestroyableMeta(destroyable);
if (meta.state >= 1
/* Destroying */
) return;
let {
parents,
children,
eagerDestructors,
destructors
} = meta;
meta.state = 1
/* Destroying */
;
iterate(children, destroy);
iterate(eagerDestructors, destructor => destructor(destroyable));
iterate(destructors, destructor => scheduleDestroy(destroyable, destructor));
scheduleDestroyed(() => {
iterate(parents, parent => removeChildFromParent(destroyable, parent));
meta.state = 2
/* Destroyed */
;
});
}
function removeChildFromParent(child, parent) {
let parentMeta = getDestroyableMeta(parent);
if (parentMeta.state === 0
/* Live */
) {
parentMeta.children = remove(parentMeta.children, child, DEBUG && "attempted to remove child from parent, but the parent's children did not contain the child. This is likely a bug with destructors.");
}
}
function destroyChildren(destroyable) {
let {
children
} = getDestroyableMeta(destroyable);
iterate(children, destroy);
}
function _hasDestroyableChildren(destroyable) {
let meta = DESTROYABLE_META.get(destroyable);
return meta === undefined ? false : meta.children !== null;
}
function isDestroying(destroyable) {
let meta = DESTROYABLE_META.get(destroyable);
return meta === undefined ? false : meta.state >= 1
/* Destroying */
;
}
function isDestroyed(destroyable) {
let meta = DESTROYABLE_META.get(destroyable);
return meta === undefined ? false : meta.state >= 2
/* Destroyed */
;
} ////////////
let enableDestroyableTracking;
let assertDestroyablesDestroyed;
if (DEBUG) {
let isTesting = false;
enableDestroyableTracking = () => {
if (isTesting) {
// Reset destroyable meta just in case, before throwing the error
DESTROYABLE_META = new WeakMap();
throw new Error('Attempted to start destroyable testing, but you did not end the previous destroyable test. Did you forget to call `assertDestroyablesDestroyed()`');
}
isTesting = true;
DESTROYABLE_META = new Map();
};
assertDestroyablesDestroyed = () => {
if (!isTesting) {
throw new Error('Attempted to assert destroyables destroyed, but you did not start a destroyable test. Did you forget to call `enableDestroyableTracking()`');
}
isTesting = false;
let map = DESTROYABLE_META;
DESTROYABLE_META = new WeakMap();
let undestroyed = [];
map.forEach(meta => {
if (meta.state !== 2
/* Destroyed */
) {
undestroyed.push(meta.source);
}
});
if (undestroyed.length > 0) {
let objectsToString = undestroyed.map(debugToString).join('\n ');
let error = new Error(`Some destroyables were not destroyed during this test:\n ${objectsToString}`);
error.destroyables = undestroyed;
throw error;
}
};
}
export { associateDestroyableChild, registerDestructor, unregisterDestructor, destroy, destroyChildren, _hasDestroyableChildren, isDestroying, isDestroyed, enableDestroyableTracking, assertDestroyablesDestroyed };