-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
record-array-manager.js
354 lines (295 loc) · 9.73 KB
/
record-array-manager.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
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
/**
@module @ember-data/store
*/
import { A } from '@ember/array';
import { assert } from '@ember/debug';
import { get, set } from '@ember/object';
import { assign } from '@ember/polyfills';
import { run as emberRunloop } from '@ember/runloop';
import { AdapterPopulatedRecordArray, RecordArray } from './record-arrays';
import { internalModelFactoryFor } from './store/internal-model-factory';
const emberRun = emberRunloop.backburner;
/**
@class RecordArrayManager
@private
*/
export default class RecordArrayManager {
constructor(options) {
this.store = options.store;
this.isDestroying = false;
this.isDestroyed = false;
this._liveRecordArrays = Object.create(null);
this._pending = Object.create(null);
this._adapterPopulatedRecordArrays = [];
}
recordDidChange(internalModel) {
let modelName = internalModel.modelName;
if (internalModel._pendingRecordArrayManagerFlush) {
return;
}
internalModel._pendingRecordArrayManagerFlush = true;
let pending = this._pending;
let models = (pending[modelName] = pending[modelName] || []);
if (models.push(internalModel) !== 1) {
return;
}
emberRun.schedule('actions', this, this._flush);
}
_flushPendingInternalModelsForModelName(modelName, internalModels) {
let modelsToRemove = [];
for (let j = 0; j < internalModels.length; j++) {
let internalModel = internalModels[j];
// mark internalModels, so they can once again be processed by the
// recordArrayManager
internalModel._pendingRecordArrayManagerFlush = false;
// build up a set of models to ensure we have purged correctly;
if (internalModel.isHiddenFromRecordArrays()) {
modelsToRemove.push(internalModel);
}
}
let array = this._liveRecordArrays[modelName];
if (array) {
// TODO: skip if it only changed
// process liveRecordArrays
updateLiveRecordArray(array, internalModels);
}
// process adapterPopulatedRecordArrays
if (modelsToRemove.length > 0) {
removeFromAdapterPopulatedRecordArrays(modelsToRemove);
}
}
_flush() {
let pending = this._pending;
this._pending = Object.create(null);
for (let modelName in pending) {
this._flushPendingInternalModelsForModelName(modelName, pending[modelName]);
}
}
_syncLiveRecordArray(array, modelName) {
assert(
`recordArrayManger.syncLiveRecordArray expects modelName not modelClass as the second param`,
typeof modelName === 'string'
);
let pending = this._pending[modelName];
let hasPendingChanges = Array.isArray(pending);
let hasNoPotentialDeletions = !hasPendingChanges || pending.length === 0;
let map = internalModelFactoryFor(this.store).modelMapFor(modelName);
let hasNoInsertionsOrRemovals = get(map, 'length') === get(array, 'length');
/*
Ideally the recordArrayManager has knowledge of the changes to be applied to
liveRecordArrays, and is capable of strategically flushing those changes and applying
small diffs if desired. However, until we've refactored recordArrayManager, this dirty
check prevents us from unnecessarily wiping out live record arrays returned by peekAll.
*/
if (hasNoPotentialDeletions && hasNoInsertionsOrRemovals) {
return;
}
if (hasPendingChanges) {
this._flushPendingInternalModelsForModelName(modelName, pending);
delete this._pending[modelName];
}
let internalModels = this._visibleInternalModelsByType(modelName);
let modelsToAdd = [];
for (let i = 0; i < internalModels.length; i++) {
let internalModel = internalModels[i];
let recordArrays = internalModel._recordArrays;
if (recordArrays.has(array) === false) {
recordArrays.add(array);
modelsToAdd.push(internalModel);
}
}
if (modelsToAdd.length) {
array._pushInternalModels(modelsToAdd);
}
}
_didUpdateAll(modelName) {
let recordArray = this._liveRecordArrays[modelName];
if (recordArray) {
set(recordArray, 'isUpdating', false);
}
}
/**
Get the `RecordArray` for a modelName, which contains all loaded records of
given modelName.
@method liveRecordArrayFor
@param {String} modelName
@return {RecordArray}
*/
liveRecordArrayFor(modelName) {
assert(
`recordArrayManger.liveRecordArrayFor expects modelName not modelClass as the param`,
typeof modelName === 'string'
);
let array = this._liveRecordArrays[modelName];
if (array) {
// if the array already exists, synchronize
this._syncLiveRecordArray(array, modelName);
} else {
// if the array is being newly created merely create it with its initial
// content already set. This prevents unneeded change events.
let internalModels = this._visibleInternalModelsByType(modelName);
array = this.createRecordArray(modelName, internalModels);
this._liveRecordArrays[modelName] = array;
}
return array;
}
_visibleInternalModelsByType(modelName) {
let all = internalModelFactoryFor(this.store).modelMapFor(modelName)._models;
let visible = [];
for (let i = 0; i < all.length; i++) {
let model = all[i];
if (model.isHiddenFromRecordArrays() === false) {
visible.push(model);
}
}
return visible;
}
/**
Create a `RecordArray` for a modelName.
@method createRecordArray
@param {String} modelName
@param {Array} _content (optional|private)
@return {RecordArray}
*/
createRecordArray(modelName, content) {
assert(
`recordArrayManger.createRecordArray expects modelName not modelClass as the param`,
typeof modelName === 'string'
);
let array = RecordArray.create({
modelName,
content: A(content || []),
store: this.store,
isLoaded: true,
manager: this,
});
if (Array.isArray(content)) {
associateWithRecordArray(content, array);
}
return array;
}
/**
Create a `AdapterPopulatedRecordArray` for a modelName with given query.
@method createAdapterPopulatedRecordArray
@param {String} modelName
@param {Object} query
@return {AdapterPopulatedRecordArray}
*/
createAdapterPopulatedRecordArray(modelName, query, internalModels, payload) {
assert(
`recordArrayManger.createAdapterPopulatedRecordArray expects modelName not modelClass as the first param, received ${modelName}`,
typeof modelName === 'string'
);
let array;
if (Array.isArray(internalModels)) {
array = AdapterPopulatedRecordArray.create({
modelName,
query: query,
content: A(internalModels),
store: this.store,
manager: this,
isLoaded: true,
isUpdating: false,
meta: assign({}, payload.meta),
links: assign({}, payload.links),
});
associateWithRecordArray(internalModels, array);
} else {
array = AdapterPopulatedRecordArray.create({
modelName,
query: query,
content: A(),
store: this.store,
manager: this,
});
}
this._adapterPopulatedRecordArrays.push(array);
return array;
}
/**
Unregister a RecordArray.
So manager will not update this array.
@method unregisterRecordArray
@param {RecordArray} array
*/
unregisterRecordArray(array) {
let modelName = array.modelName;
// remove from adapter populated record array
let removedFromAdapterPopulated = remove(this._adapterPopulatedRecordArrays, array);
if (!removedFromAdapterPopulated) {
let liveRecordArrayForType = this._liveRecordArrays[modelName];
// unregister live record array
if (liveRecordArrayForType) {
if (array === liveRecordArrayForType) {
delete this._liveRecordArrays[modelName];
}
}
}
}
_associateWithRecordArray(internalModels, array) {
associateWithRecordArray(internalModels, array);
}
willDestroy() {
Object.keys(this._liveRecordArrays).forEach(modelName => this._liveRecordArrays[modelName].destroy());
this._adapterPopulatedRecordArrays.forEach(destroy);
this.isDestroyed = true;
}
destroy() {
this.isDestroying = true;
emberRun.schedule('actions', this, this.willDestroy);
}
}
function destroy(entry) {
entry.destroy();
}
function remove(array, item) {
let index = array.indexOf(item);
if (index !== -1) {
array.splice(index, 1);
return true;
}
return false;
}
function updateLiveRecordArray(array, internalModels) {
let modelsToAdd = [];
let modelsToRemove = [];
for (let i = 0; i < internalModels.length; i++) {
let internalModel = internalModels[i];
let isDeleted = internalModel.isHiddenFromRecordArrays();
let recordArrays = internalModel._recordArrays;
if (!isDeleted && !internalModel.isEmpty()) {
if (!recordArrays.has(array)) {
modelsToAdd.push(internalModel);
recordArrays.add(array);
}
}
if (isDeleted) {
modelsToRemove.push(internalModel);
recordArrays.delete(array);
}
}
if (modelsToAdd.length > 0) {
array._pushInternalModels(modelsToAdd);
}
if (modelsToRemove.length > 0) {
array._removeInternalModels(modelsToRemove);
}
}
function removeFromAdapterPopulatedRecordArrays(internalModels) {
for (let i = 0; i < internalModels.length; i++) {
removeFromAll(internalModels[i]);
}
}
function removeFromAll(internalModel) {
const recordArrays = internalModel._recordArrays;
recordArrays.forEach(function(recordArray) {
recordArray._removeInternalModels([internalModel]);
});
recordArrays.clear();
}
export function associateWithRecordArray(internalModels, array) {
for (let i = 0, l = internalModels.length; i < l; i++) {
let internalModel = internalModels[i];
internalModel._recordArrays.add(array);
}
}