documentarray.js
15.6 KB
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
553
554
555
556
557
558
559
560
561
562
563
'use strict';
/*!
* Module dependencies.
*/
const ArrayType = require('./array');
const CastError = require('../error/cast');
const EventEmitter = require('events').EventEmitter;
const SchemaDocumentArrayOptions =
require('../options/SchemaDocumentArrayOptions');
const SchemaType = require('../schematype');
const ValidationError = require('../error/validation');
const discriminator = require('../helpers/model/discriminator');
const get = require('../helpers/get');
const handleIdOption = require('../helpers/schema/handleIdOption');
const util = require('util');
const utils = require('../utils');
const getConstructor = require('../helpers/discriminator/getConstructor');
const arrayPathSymbol = require('../helpers/symbols').arrayPathSymbol;
const documentArrayParent = require('../helpers/symbols').documentArrayParent;
let MongooseDocumentArray;
let Subdocument;
/**
* SubdocsArray SchemaType constructor
*
* @param {String} key
* @param {Schema} schema
* @param {Object} options
* @inherits SchemaArray
* @api public
*/
function DocumentArrayPath(key, schema, options, schemaOptions) {
if (schemaOptions != null && schemaOptions._id != null) {
schema = handleIdOption(schema, schemaOptions);
} else if (options != null && options._id != null) {
schema = handleIdOption(schema, options);
}
const EmbeddedDocument = _createConstructor(schema, options);
EmbeddedDocument.prototype.$basePath = key;
ArrayType.call(this, key, EmbeddedDocument, options);
this.schema = schema;
this.schemaOptions = schemaOptions || {};
this.$isMongooseDocumentArray = true;
this.Constructor = EmbeddedDocument;
EmbeddedDocument.base = schema.base;
const fn = this.defaultValue;
if (!('defaultValue' in this) || fn !== void 0) {
this.default(function() {
let arr = fn.call(this);
if (!Array.isArray(arr)) {
arr = [arr];
}
// Leave it up to `cast()` to convert this to a documentarray
return arr;
});
}
const parentSchemaType = this;
this.$embeddedSchemaType = new SchemaType(key + '.$', {
required: get(this, 'schemaOptions.required', false)
});
this.$embeddedSchemaType.cast = function(value, doc, init) {
return parentSchemaType.cast(value, doc, init)[0];
};
this.$embeddedSchemaType.$isMongooseDocumentArrayElement = true;
this.$embeddedSchemaType.caster = this.Constructor;
this.$embeddedSchemaType.schema = this.schema;
}
/**
* This schema type's name, to defend against minifiers that mangle
* function names.
*
* @api public
*/
DocumentArrayPath.schemaName = 'DocumentArray';
/**
* Options for all document arrays.
*
* - `castNonArrays`: `true` by default. If `false`, Mongoose will throw a CastError when a value isn't an array. If `true`, Mongoose will wrap the provided value in an array before casting.
*
* @api public
*/
DocumentArrayPath.options = { castNonArrays: true };
/*!
* Inherits from ArrayType.
*/
DocumentArrayPath.prototype = Object.create(ArrayType.prototype);
DocumentArrayPath.prototype.constructor = DocumentArrayPath;
DocumentArrayPath.prototype.OptionsConstructor = SchemaDocumentArrayOptions;
/*!
* Ignore
*/
function _createConstructor(schema, options, baseClass) {
Subdocument || (Subdocument = require('../types/embedded'));
// compile an embedded document for this schema
function EmbeddedDocument() {
Subdocument.apply(this, arguments);
this.$session(this.ownerDocument().$session());
}
const proto = baseClass != null ? baseClass.prototype : Subdocument.prototype;
EmbeddedDocument.prototype = Object.create(proto);
EmbeddedDocument.prototype.$__setSchema(schema);
EmbeddedDocument.schema = schema;
EmbeddedDocument.prototype.constructor = EmbeddedDocument;
EmbeddedDocument.$isArraySubdocument = true;
EmbeddedDocument.events = new EventEmitter();
// apply methods
for (const i in schema.methods) {
EmbeddedDocument.prototype[i] = schema.methods[i];
}
// apply statics
for (const i in schema.statics) {
EmbeddedDocument[i] = schema.statics[i];
}
for (const i in EventEmitter.prototype) {
EmbeddedDocument[i] = EventEmitter.prototype[i];
}
EmbeddedDocument.options = options;
return EmbeddedDocument;
}
/**
* Adds a discriminator to this document array.
*
* ####Example:
* const shapeSchema = Schema({ name: String }, { discriminatorKey: 'kind' });
* const schema = Schema({ shapes: [shapeSchema] });
*
* const docArrayPath = parentSchema.path('shapes');
* docArrayPath.discriminator('Circle', Schema({ radius: Number }));
*
* @param {String} name
* @param {Schema} schema fields to add to the schema for instances of this sub-class
* @param {String} [value] the string stored in the `discriminatorKey` property. If not specified, Mongoose uses the `name` parameter.
* @see discriminators /docs/discriminators.html
* @return {Function} the constructor Mongoose will use for creating instances of this discriminator model
* @api public
*/
DocumentArrayPath.prototype.discriminator = function(name, schema, tiedValue) {
if (typeof name === 'function') {
name = utils.getFunctionName(name);
}
schema = discriminator(this.casterConstructor, name, schema, tiedValue);
const EmbeddedDocument = _createConstructor(schema, null, this.casterConstructor);
EmbeddedDocument.baseCasterConstructor = this.casterConstructor;
try {
Object.defineProperty(EmbeddedDocument, 'name', {
value: name
});
} catch (error) {
// Ignore error, only happens on old versions of node
}
this.casterConstructor.discriminators[name] = EmbeddedDocument;
return this.casterConstructor.discriminators[name];
};
/**
* Performs local validations first, then validations on each embedded doc
*
* @api private
*/
DocumentArrayPath.prototype.doValidate = function(array, fn, scope, options) {
// lazy load
MongooseDocumentArray || (MongooseDocumentArray = require('../types/documentarray'));
const _this = this;
try {
SchemaType.prototype.doValidate.call(this, array, cb, scope);
} catch (err) {
err.$isArrayValidatorError = true;
return fn(err);
}
function cb(err) {
if (err) {
err.$isArrayValidatorError = true;
return fn(err);
}
let count = array && array.length;
let error;
if (!count) {
return fn();
}
if (options && options.updateValidator) {
return fn();
}
if (!array.isMongooseDocumentArray) {
array = new MongooseDocumentArray(array, _this.path, scope);
}
// handle sparse arrays, do not use array.forEach which does not
// iterate over sparse elements yet reports array.length including
// them :(
function callback(err) {
if (err != null) {
error = err;
if (!(error instanceof ValidationError)) {
error.$isArrayValidatorError = true;
}
}
--count || fn(error);
}
for (let i = 0, len = count; i < len; ++i) {
// sidestep sparse entries
let doc = array[i];
if (doc == null) {
--count || fn(error);
continue;
}
// If you set the array index directly, the doc might not yet be
// a full fledged mongoose subdoc, so make it into one.
if (!(doc instanceof Subdocument)) {
const Constructor = getConstructor(_this.casterConstructor, array[i]);
doc = array[i] = new Constructor(doc, array, undefined, undefined, i);
}
if (options != null && options.validateModifiedOnly && !doc.isModified()) {
--count || fn(error);
continue;
}
doc.$__validate(callback);
}
}
};
/**
* Performs local validations first, then validations on each embedded doc.
*
* ####Note:
*
* This method ignores the asynchronous validators.
*
* @return {MongooseError|undefined}
* @api private
*/
DocumentArrayPath.prototype.doValidateSync = function(array, scope, options) {
const schemaTypeError = SchemaType.prototype.doValidateSync.call(this, array, scope);
if (schemaTypeError != null) {
schemaTypeError.$isArrayValidatorError = true;
return schemaTypeError;
}
const count = array && array.length;
let resultError = null;
if (!count) {
return;
}
// handle sparse arrays, do not use array.forEach which does not
// iterate over sparse elements yet reports array.length including
// them :(
for (let i = 0, len = count; i < len; ++i) {
// sidestep sparse entries
let doc = array[i];
if (!doc) {
continue;
}
// If you set the array index directly, the doc might not yet be
// a full fledged mongoose subdoc, so make it into one.
if (!(doc instanceof Subdocument)) {
const Constructor = getConstructor(this.casterConstructor, array[i]);
doc = array[i] = new Constructor(doc, array, undefined, undefined, i);
}
if (options != null && options.validateModifiedOnly && !doc.isModified()) {
continue;
}
const subdocValidateError = doc.validateSync();
if (subdocValidateError && resultError == null) {
resultError = subdocValidateError;
}
}
return resultError;
};
/*!
* ignore
*/
DocumentArrayPath.prototype.getDefault = function(scope) {
let ret = typeof this.defaultValue === 'function'
? this.defaultValue.call(scope)
: this.defaultValue;
if (ret == null) {
return ret;
}
// lazy load
MongooseDocumentArray || (MongooseDocumentArray = require('../types/documentarray'));
if (!Array.isArray(ret)) {
ret = [ret];
}
ret = new MongooseDocumentArray(ret, this.path, scope);
for (let i = 0; i < ret.length; ++i) {
const Constructor = getConstructor(this.casterConstructor, ret[i]);
const _subdoc = new Constructor({}, ret, undefined,
undefined, i);
_subdoc.init(ret[i]);
_subdoc.isNew = true;
// Make sure all paths in the subdoc are set to `default` instead
// of `init` since we used `init`.
Object.assign(_subdoc.$__.activePaths.default, _subdoc.$__.activePaths.init);
_subdoc.$__.activePaths.init = {};
ret[i] = _subdoc;
}
return ret;
};
/**
* Casts contents
*
* @param {Object} value
* @param {Document} document that triggers the casting
* @api private
*/
DocumentArrayPath.prototype.cast = function(value, doc, init, prev, options) {
// lazy load
MongooseDocumentArray || (MongooseDocumentArray = require('../types/documentarray'));
// Skip casting if `value` is the same as the previous value, no need to cast. See gh-9266
if (value != null && value[arrayPathSymbol] != null && value === prev) {
return value;
}
let selected;
let subdoc;
const _opts = { transform: false, virtuals: false };
options = options || {};
if (!Array.isArray(value)) {
if (!init && !DocumentArrayPath.options.castNonArrays) {
throw new CastError('DocumentArray', util.inspect(value), this.path, null, this);
}
// gh-2442 mark whole array as modified if we're initializing a doc from
// the db and the path isn't an array in the document
if (!!doc && init) {
doc.markModified(this.path);
}
return this.cast([value], doc, init, prev, options);
}
if (!(value && value.isMongooseDocumentArray) &&
!options.skipDocumentArrayCast) {
value = new MongooseDocumentArray(value, this.path, doc);
} else if (value && value.isMongooseDocumentArray) {
// We need to create a new array, otherwise change tracking will
// update the old doc (gh-4449)
value = new MongooseDocumentArray(value, this.path, doc);
}
if (options.arrayPathIndex != null) {
value[arrayPathSymbol] = this.path + '.' + options.arrayPathIndex;
}
const len = value.length;
const initDocumentOptions = { skipId: true, willInit: true };
for (let i = 0; i < len; ++i) {
if (!value[i]) {
continue;
}
const Constructor = getConstructor(this.casterConstructor, value[i]);
// Check if the document has a different schema (re gh-3701)
if ((value[i].$__) &&
(!(value[i] instanceof Constructor) || value[i][documentArrayParent] !== doc)) {
value[i] = value[i].toObject({
transform: false,
// Special case: if different model, but same schema, apply virtuals
// re: gh-7898
virtuals: value[i].schema === Constructor.schema
});
}
if (value[i] instanceof Subdocument) {
// Might not have the correct index yet, so ensure it does.
if (value[i].__index == null) {
value[i].$setIndex(i);
}
} else if (value[i] != null) {
if (init) {
if (doc) {
selected || (selected = scopePaths(this, doc.$__.selected, init));
} else {
selected = true;
}
subdoc = new Constructor(null, value, initDocumentOptions, selected, i);
value[i] = subdoc.init(value[i]);
} else {
if (prev && typeof prev.id === 'function') {
subdoc = prev.id(value[i]._id);
}
if (prev && subdoc && utils.deepEqual(subdoc.toObject(_opts), value[i])) {
// handle resetting doc with existing id and same data
subdoc.set(value[i]);
// if set() is hooked it will have no return value
// see gh-746
value[i] = subdoc;
} else {
try {
subdoc = new Constructor(value[i], value, undefined,
undefined, i);
// if set() is hooked it will have no return value
// see gh-746
value[i] = subdoc;
} catch (error) {
const valueInErrorMessage = util.inspect(value[i]);
throw new CastError('embedded', valueInErrorMessage,
value[arrayPathSymbol], error, this);
}
}
}
}
}
return value;
};
/*!
* ignore
*/
DocumentArrayPath.prototype.clone = function() {
const options = Object.assign({}, this.options);
const schematype = new this.constructor(this.path, this.schema, options, this.schemaOptions);
schematype.validators = this.validators.slice();
if (this.requiredValidator !== undefined) {
schematype.requiredValidator = this.requiredValidator;
}
schematype.Constructor.discriminators = Object.assign({},
this.Constructor.discriminators);
return schematype;
};
/*!
* ignore
*/
DocumentArrayPath.prototype.applyGetters = function(value, scope) {
return SchemaType.prototype.applyGetters.call(this, value, scope);
};
/*!
* Scopes paths selected in a query to this array.
* Necessary for proper default application of subdocument values.
*
* @param {DocumentArrayPath} array - the array to scope `fields` paths
* @param {Object|undefined} fields - the root fields selected in the query
* @param {Boolean|undefined} init - if we are being created part of a query result
*/
function scopePaths(array, fields, init) {
if (!(init && fields)) {
return undefined;
}
const path = array.path + '.';
const keys = Object.keys(fields);
let i = keys.length;
const selected = {};
let hasKeys;
let key;
let sub;
while (i--) {
key = keys[i];
if (key.startsWith(path)) {
sub = key.substring(path.length);
if (sub === '$') {
continue;
}
if (sub.startsWith('$.')) {
sub = sub.substr(2);
}
hasKeys || (hasKeys = true);
selected[sub] = fields[key];
}
}
return hasKeys && selected || undefined;
}
/**
* Sets a default option for all DocumentArray instances.
*
* ####Example:
*
* // Make all numbers have option `min` equal to 0.
* mongoose.Schema.DocumentArray.set('_id', false);
*
* @param {String} option - The option you'd like to set the value for
* @param {*} value - value for option
* @return {undefined}
* @function set
* @static
* @api public
*/
DocumentArrayPath.defaultOptions = {};
DocumentArrayPath.set = SchemaType.set;
/*!
* Module exports.
*/
module.exports = DocumentArrayPath;