/
documentarray.js
410 lines (349 loc) · 11.3 KB
/
documentarray.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
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
'use strict';
/*!
* Module dependencies.
*/
const CoreMongooseArray = require('./core_array');
const Document = require('../document');
const ObjectId = require('./objectid');
const castObjectId = require('../cast/objectid');
const getDiscriminatorByValue = require('../queryhelpers').getDiscriminatorByValue;
const internalToObjectOptions = require('../options').internalToObjectOptions;
const util = require('util');
const utils = require('../utils');
const arrayAtomicsSymbol = require('../helpers/symbols').arrayAtomicsSymbol;
const arrayParentSymbol = require('../helpers/symbols').arrayParentSymbol;
const arrayPathSymbol = require('../helpers/symbols').arrayPathSymbol;
const arraySchemaSymbol = require('../helpers/symbols').arraySchemaSymbol;
const documentArrayParent = require('../helpers/symbols').documentArrayParent;
const _basePush = Array.prototype.push;
class CoreDocumentArray extends CoreMongooseArray {
get isMongooseDocumentArray() {
return true;
}
/*!
* ignore
*/
toBSON() {
return this.toObject(internalToObjectOptions);
}
/**
* Overrides MongooseArray#cast
*
* @method _cast
* @api private
* @receiver MongooseDocumentArray
*/
_cast(value, index) {
let Constructor = this[arraySchemaSymbol].casterConstructor;
const isInstance = Constructor.$isMongooseDocumentArray ?
value && value.isMongooseDocumentArray :
value instanceof Constructor;
if (isInstance ||
// Hack re: #5001, see #5005
(value && value.constructor && value.constructor.baseCasterConstructor === Constructor)) {
if (!(value[documentArrayParent] && value.__parentArray)) {
// value may have been created using array.create()
value[documentArrayParent] = this[arrayParentSymbol];
value.__parentArray = this;
}
value.$setIndex(index);
return value;
}
if (value === undefined || value === null) {
return null;
}
// handle cast('string') or cast(ObjectId) etc.
// only objects are permitted so we can safely assume that
// non-objects are to be interpreted as _id
if (Buffer.isBuffer(value) ||
value instanceof ObjectId || !utils.isObject(value)) {
value = {_id: value};
}
if (value &&
Constructor.discriminators &&
Constructor.schema &&
Constructor.schema.options &&
Constructor.schema.options.discriminatorKey) {
if (typeof value[Constructor.schema.options.discriminatorKey] === 'string' &&
Constructor.discriminators[value[Constructor.schema.options.discriminatorKey]]) {
Constructor = Constructor.discriminators[value[Constructor.schema.options.discriminatorKey]];
} else {
const constructorByValue = getDiscriminatorByValue(Constructor, value[Constructor.schema.options.discriminatorKey]);
if (constructorByValue) {
Constructor = constructorByValue;
}
}
}
if (Constructor.$isMongooseDocumentArray) {
return Constructor.cast(value, this, undefined, undefined, index);
}
return new Constructor(value, this, undefined, undefined, index);
}
/**
* Searches array items for the first document with a matching _id.
*
* ####Example:
*
* var embeddedDoc = m.array.id(some_id);
*
* @return {EmbeddedDocument|null} the subdocument or null if not found.
* @param {ObjectId|String|Number|Buffer} id
* @TODO cast to the _id based on schema for proper comparison
* @method id
* @api public
* @receiver MongooseDocumentArray
*/
id(id) {
let casted;
let sid;
let _id;
try {
casted = castObjectId(id).toString();
} catch (e) {
casted = null;
}
for (let i = 0, l = this.length; i < l; i++) {
if (!this[i]) {
continue;
}
_id = this[i].get('_id');
if (_id === null || typeof _id === 'undefined') {
continue;
} else if (_id instanceof Document) {
sid || (sid = String(id));
if (sid == _id._id) {
return this[i];
}
} else if (!(id instanceof ObjectId) && !(_id instanceof ObjectId)) {
if (utils.deepEqual(id, _id)) {
return this[i];
}
} else if (casted == _id) {
return this[i];
}
}
return null;
}
/**
* Returns a native js Array of plain js objects
*
* ####NOTE:
*
* _Each sub-document is converted to a plain object by calling its `#toObject` method._
*
* @param {Object} [options] optional options to pass to each documents `toObject` method call during conversion
* @return {Array}
* @method toObject
* @api public
* @receiver MongooseDocumentArray
*/
toObject(options) {
// `[].concat` coerces the return value into a vanilla JS array, rather
// than a Mongoose array.
return [].concat(this.map(function(doc) {
if (doc == null) {
return null;
}
if (typeof doc.toObject !== 'function') {
return doc;
}
return doc.toObject(options);
}));
}
slice() {
const arr = super.slice.apply(this, arguments);
arr[arrayParentSymbol] = this[arrayParentSymbol];
arr[arrayPathSymbol] = this[arrayPathSymbol];
return arr;
}
/**
* Wraps [`Array#push`](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array/push) with proper change tracking.
*
* @param {Object} [args...]
* @api public
* @method push
* @memberOf MongooseDocumentArray
*/
push() {
const ret = super.push.apply(this, arguments);
_updateParentPopulated(this);
return ret;
}
/**
* Pulls items from the array atomically.
*
* @param {Object} [args...]
* @api public
* @method pull
* @memberOf MongooseDocumentArray
*/
pull() {
const ret = super.pull.apply(this, arguments);
_updateParentPopulated(this);
return ret;
}
/**
* Wraps [`Array#shift`](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array/unshift) with proper change tracking.
*/
shift() {
const ret = super.shift.apply(this, arguments);
_updateParentPopulated(this);
return ret;
}
/**
* Wraps [`Array#splice`](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array/splice) with proper change tracking and casting.
*/
splice() {
const ret = super.splice.apply(this, arguments);
_updateParentPopulated(this);
return ret;
}
/**
* Helper for console.log
*
* @method inspect
* @api public
* @receiver MongooseDocumentArray
*/
inspect() {
return this.toObject();
}
/**
* Creates a subdocument casted to this schema.
*
* This is the same subdocument constructor used for casting.
*
* @param {Object} obj the value to cast to this arrays SubDocument schema
* @method create
* @api public
* @receiver MongooseDocumentArray
*/
create(obj) {
let Constructor = this[arraySchemaSymbol].casterConstructor;
if (obj &&
Constructor.discriminators &&
Constructor.schema &&
Constructor.schema.options &&
Constructor.schema.options.discriminatorKey) {
if (typeof obj[Constructor.schema.options.discriminatorKey] === 'string' &&
Constructor.discriminators[obj[Constructor.schema.options.discriminatorKey]]) {
Constructor = Constructor.discriminators[obj[Constructor.schema.options.discriminatorKey]];
} else {
const constructorByValue = getDiscriminatorByValue(Constructor, obj[Constructor.schema.options.discriminatorKey]);
if (constructorByValue) {
Constructor = constructorByValue;
}
}
}
return new Constructor(obj, this);
}
/*!
* ignore
*/
notify(event) {
const _this = this;
return function notify(val, _arr) {
_arr = _arr || _this;
let i = _arr.length;
while (i--) {
if (_arr[i] == null) {
continue;
}
switch (event) {
// only swap for save event for now, we may change this to all event types later
case 'save':
val = _this[i];
break;
default:
// NO-OP
break;
}
if (_arr[i].isMongooseArray) {
notify(val, _arr[i]);
} else if (_arr[i]) {
_arr[i].emit(event, val);
}
}
};
}
}
if (util.inspect.custom) {
CoreDocumentArray.prototype[util.inspect.custom] =
CoreDocumentArray.prototype.inspect;
}
/*!
* If this is a document array, each element may contain single
* populated paths, so we need to modify the top-level document's
* populated cache. See gh-8247, gh-8265.
*/
function _updateParentPopulated(arr) {
const parent = arr[arrayParentSymbol];
if (parent.$__.populated != null) {
const populatedPaths = Object.keys(parent.$__.populated).
filter(p => p.startsWith(arr[arrayPathSymbol] + '.'));
for (const path of populatedPaths) {
const remnant = path.slice((arr[arrayPathSymbol] + '.').length);
if (!Array.isArray(parent.$__.populated[path].value)) {
continue;
}
parent.$__.populated[path].value = arr.map(val => val.populated(remnant));
}
}
}
/**
* DocumentArray constructor
*
* @param {Array} values
* @param {String} path the path to this array
* @param {Document} doc parent document
* @api private
* @return {MongooseDocumentArray}
* @inherits MongooseArray
* @see http://bit.ly/f6CnZU
*/
function MongooseDocumentArray(values, path, doc) {
// TODO: replace this with `new CoreDocumentArray().concat()` when we remove
// support for node 4.x and 5.x, see https://i.imgur.com/UAAHk4S.png
const arr = new CoreDocumentArray();
arr[arrayAtomicsSymbol] = {};
arr[arraySchemaSymbol] = void 0;
if (Array.isArray(values)) {
if (values instanceof CoreDocumentArray &&
values[arrayPathSymbol] === path &&
values[arrayParentSymbol] === doc) {
arr[arrayAtomicsSymbol] = Object.assign({}, values[arrayAtomicsSymbol]);
}
values.forEach(v => {
_basePush.call(arr, v);
});
}
arr[arrayPathSymbol] = path;
// Because doc comes from the context of another function, doc === global
// can happen if there was a null somewhere up the chain (see #3020 && #3034)
// RB Jun 17, 2015 updated to check for presence of expected paths instead
// to make more proof against unusual node environments
if (doc && doc instanceof Document) {
arr[arrayParentSymbol] = doc;
arr[arraySchemaSymbol] = doc.schema.path(path);
// `schema.path()` doesn't drill into nested arrays properly yet, see
// gh-6398, gh-6602. This is a workaround because nested arrays are
// always plain non-document arrays, so once you get to a document array
// nesting is done. Matryoshka code.
while (arr != null &&
arr[arraySchemaSymbol] != null &&
arr[arraySchemaSymbol].$isMongooseArray &&
!arr[arraySchemaSymbol].$isMongooseDocumentArray) {
arr[arraySchemaSymbol] = arr[arraySchemaSymbol].casterConstructor;
}
// Tricky but this may be a document array embedded in a normal array,
// in which case `path` would point to the embedded array. See #6405, #6398
if (arr[arraySchemaSymbol] && !arr[arraySchemaSymbol].$isMongooseDocumentArray) {
arr[arraySchemaSymbol] = arr[arraySchemaSymbol].casterConstructor;
}
}
return arr;
}
/*!
* Module exports.
*/
module.exports = MongooseDocumentArray;