forked from Automattic/mongoose
/
model.js
860 lines (724 loc) · 19.5 KB
/
model.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
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
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
/**
* Module dependencies.
*/
var Document = require('./document')
, MongooseArray = require('./types/array')
, DocumentArray = require('./types/documentarray')
, MongooseBuffer = require('./types/buffer')
, MongooseError = require('./error')
, Query = require('./query')
, utils = require('./utils')
, EventEmitter = utils.EventEmitter
, merge = utils.merge
, Promise = require('./promise');
/**
* Model constructor
*
* @param {Object} values to set
* @api public
*/
function Model (doc) {
Document.call(this, doc);
};
/**
* Inherits from Document.
*/
Model.prototype.__proto__ = Document.prototype;
/**
* Connection the model uses. Set by the Connection or if absent set to the
* default mongoose connection;
*
* @api public
*/
Model.prototype.db;
/**
* Collection the model uses. Set by Mongoose instance
*
* @api public
*/
Model.prototype.collection;
/**
* Model name.
*
* @api public
*/
Model.prototype.modelName;
/**
* Returns what paths can be populated
*
* @param {query} query object
* @return {Object] population paths
* @api private
*/
Model.prototype.getPopulationKeys = function (query) {
var paths = {};
if (query && query.options.populate) {
for (var name in query.options.populate) {
var schema = this.schema.path(name);
if (!schema) {
// if the path is not recognized, it's potentially embedded docs
// walk path atoms from right to left to find a matching path
var pieces = name.split('.')
, len = pieces.length;
for (var i = pieces.length; i > 0; i--) {
var path = pieces.slice(0, i).join('.')
, pathSchema = this.schema.path(path);
// loop until we find an array schema
if (pathSchema && pathSchema.caster) {
if (!paths[path]) {
paths[path] = query.options.populate[name];
paths[path].sub = {};
}
paths[path].sub[pieces.slice(i).join('.')] = 1;
break;
}
}
} else {
paths[name] = query.options.populate[name];
}
}
}
return paths;
};
/**
* Populates an object
*
* @param {SchemaType} schema type for the oid
* @param {Object} object id or array of object ids
* @param {Array} fields to select
* @param {Function} callback
* @api private
*/
Model.prototype.populate = function (schema, oid, fields, fn) {
if (Array.isArray(oid)) {
if (oid.length) {
var total = oid.length
, model = this.model(schema.caster.options.ref)
, arr = []
oid.forEach(function (id, i) {
// TODO: optimize with $in and an array ObjectId
model.findById(id, fields, function (err, obj) {
if (err) return fn(err);
arr[i] = obj;
--total || fn(null, arr);
});
});
} else {
fn(null, oid);
}
} else {
this.model(schema.options.ref).findById(oid, fields, fn)
}
};
/**
* Performs auto-population of relations.
*
* @param {Object} document returned by mongo
* @param {Query} query that originated the initialization
* @param {Function} callback
* @api private
*/
Model.prototype.init = function (doc, query, fn) {
if ('function' == typeof query) {
fn = query;
query = null;
}
var populate = this.getPopulationKeys(query)
, self = this;
if (!Object.keys(populate).length) {
// if no population from other models is necessary
return Document.prototype.init.call(this, doc, fn);
}
function error (err) {
if (fn.run) return;
fn.run = true;
fn(err);
}
function init (obj, prefix, fn) {
prefix = prefix || '';
var keys = Object.keys(obj)
, len = keys.length;
function next () {
if (--len < 0) return fn();
var i = keys[len]
, path = prefix + i
, schema = self.schema.path(path);
if (!schema && obj[i] && obj[i].constructor == Object) {
// assume nested object
init(obj[i], path + '.', next);
} else {
if (obj[i] && schema && populate[path]) {
if (populate[path].sub) {
var total = 0;
obj[i].forEach(function (subobj) {
for (var key in populate[path].sub) {
if (subobj[key]) {
(function (key) {
total++;
self.populate(
schema.schema.path(key)
, subobj[key]
, populate[path]
, function (err, doc) {
if (err) return error(err);
subobj[key] = doc;
--total || next();
}
);
})(key);
}
}
});
} else {
self.populate(schema, obj[i], populate[path], function (err, doc) {
if (err) return error(err);
obj[i] = doc;
next();
});
}
} else {
next();
}
}
};
next();
};
init(doc, '', function (err) {
if (err) return fn(err);
Document.prototype.init.call(self, doc, fn);
});
return this;
};
function makeSaveHandler(promise, self) {
return function (err) {
if (err) return promise.error(err);
promise.complete(self);
self.emit('save', self);
promise = null;
self = null;
};
};
/**
* Saves this document.
*
* @see Model#registerHooks
* @param {Function} fn
* @api public
*/
Model.prototype.save = function (fn) {
var promise = new Promise(fn)
, options = {}
, self = this
, complete = makeSaveHandler(promise, self);
if (this.options.safe) {
options.safe = true;
}
if (this.isNew) {
// send entire doc
this.collection.insert(this.toObject(), options, complete);
this.isNew = false;
// clear atomics
this._dirty().forEach(function (dirt) {
var type = dirt.value;
if (type && type._path && type.doAtomics) {
type._atomics = {};
}
});
} else {
// optimization, _delta() clears atomics too
var delta = this._delta();
if (Object.keys(delta).length) {
this.collection.update({ _id: this._doc._id }, delta, options, complete);
} else {
complete(null);
}
}
// Clear 'modify'('dirty') cache
this._activePaths.clear('modify');
this.schema.requiredPaths.forEach(function (path) {
self._activePaths.require(path);
});
};
/**
* Returns the dirty paths / vals
*
* @api private
*/
Model.prototype._dirty = function () {
var self = this;
return this._activePaths.map('modify', function (path) {
return { path: path
, value: self.getValue(path)
, schema: self._path(path) };
});
}
/**
* Produces a special query document of the modified properties.
* @api private
*/
Model.prototype._delta = function () {
// send delta
var self = this
, delta
, useSet = this.options['use$SetOnSave'];
return this._dirty().reduce(function (delta, data) {
var type = data.value
, schema = data.schema
, atomics, val, obj;
if (type === null || type === undefined) {
if (!('$set' in delta))
delta['$set'] = {};
delta['$set'][data.path] = type;
} else if (type._path && type.doAtomics) {
// a MongooseArray or MongooseNumber
atomics = type._atomics;
var ops = Object.keys(atomics)
, i = ops.length
, op;
while (i--) {
op = ops[i]
if (op === '$pushAll' || op === '$pullAll') {
if (atomics[op].length === 1) {
val = atomics[op][0];
delete atomics[op];
op = op.replace('All', '');
atomics[op] = val;
}
}
val = atomics[op];
obj = delta[op] = delta[op] || {};
if (op === '$pull' || op === '$push') {
if (val.constructor !== Object) {
if (Array.isArray(val)) val = [val];
// TODO Should we place pull and push casting into the pull and push methods?
val = schema.cast(val)[0];
}
}
obj[data.path] = val.toObject
? val.toObject() // If the value is an array
: Array.isArray(val)
? val.map(function (mem) {
return mem.toObject
? mem.toObject()
: mem.valueOf
? mem.valueOf()
: mem;
})
: val.valueOf
? val.valueOf() // Numbers
: val;
}
type._atomics = {};
} else {
// normalize MongooseArray or MongooseNumber
if (type instanceof MongooseArray ||
type instanceof MongooseBuffer) {
type = type.toObject();
} else if (type._path)
type = type.valueOf();
if (useSet) {
if (!('$set' in delta))
delta['$set'] = {};
delta['$set'][data.path] = type;
} else
delta[data.path] = type;
}
return delta;
}, {});
}
/**
* Remove the document
*
* @param {Function} callback
* @api public
*/
Model.prototype.remove = function (fn) {
if (this.removing || this.removed)
return this;
if (!this.removing) {
var promise = this.removing = new Promise(fn)
, self = this;
this.collection.remove({ _id: this._doc._id }, function (err) {
if (err) return promise.error(err);
promise.complete();
self.emit('remove');
});
}
return this;
};
/**
* Register hooks override
*
* @api private
*/
Model.prototype.registerHooks = function () {
// make sure to pass along all the errors from subdocuments
this.pre('save', function (next) {
// we keep the error semaphore to make sure we don't
// call `save` unnecessarily (we only need 1 error)
var subdocs = 0
, error = false
, self = this;
var arrays = this._activePaths
.map('init', 'modify', function (i) {
return self.getValue(i);
})
.filter(function (val) {
return (val && val instanceof DocumentArray && val.length);
});
if (!arrays.length)
return next();
arrays.forEach(function (array) {
subdocs += array.length;
array.forEach(function (value) {
if (!error)
value.save(function (err) {
if (!error) {
if (err) {
error = true;
next(err);
} else
--subdocs || next();
}
});
});
});
}, function (err) {
this.db.emit('error', err);
});
Document.prototype.registerHooks.call(this);
};
/**
* Shortcut to access another model.
*
* @param {String} model name
*/
Model.prototype.model = function (name) {
return this.db.model(name);
};
/**
* Access the options defined in the schema
*
* @api private
*/
Model.prototype.__defineGetter__('options', function () {
return this.schema ? this.schema.options : {};
});
/**
* Give the constructor the ability to emit events.
*/
for (var i in EventEmitter.prototype)
Model[i] = EventEmitter.prototype[i];
/**
* Called when the model compiles
*
* @api private
*/
Model.init = function () {
// build indexes
var self = this
, indexes = this.schema.indexes
, count = indexes.length;
indexes.forEach(function (index) {
self.collection.ensureIndex(index[0], index[1], function (err) {
if (err) return self.db.emit('error', err);
--count || self.emit('index');
});
});
};
/**
* Document schema
*
* @api public
*/
Model.schema;
/**
* Database instance the model uses.
*
* @api public
*/
Model.db;
/**
* Collection the model uses.
*
* @api public
*/
Model.collection;
/**
* Define properties that access the prototype.
*/
['db', 'collection', 'schema', 'options'].forEach(function(prop){
Model.__defineGetter__(prop, function(){
return this.prototype[prop];
});
});
/**
* Module exports.
*/
module.exports = exports = Model;
Model.remove = function (conditions, callback) {
if ('function' === typeof conditions) {
callback = conditions;
conditions = {};
}
var query = new Query(conditions).bind(this, 'remove');
if ('undefined' === typeof callback)
return query;
this._applyNamedScope(query);
return query.remove(callback);
};
/**
* Finds documents
*
* Examples:
* // retrieve only certain keys
* MyModel.find({ name: /john/i }, ['name', 'friends'], function () { })
*
* // pass options
* MyModel.find({ name: /john/i }, [], { skip: 10 } )
*
* @param {Object} conditions
* @param {Object/Function} (optional) fields to hydrate or callback
* @param {Function} callback
* @api public
*/
Model.find = function (conditions, fields, options, callback) {
if ('function' == typeof conditions) {
callback = conditions;
conditions = {};
fields = null;
options = null;
} else if ('function' == typeof fields) {
callback = fields;
fields = null;
options = null;
} else if ('function' == typeof options) {
callback = options;
options = null;
}
var query = new Query(conditions, options).select(fields).bind(this, 'find');
if ('undefined' === typeof callback)
return query;
this._applyNamedScope(query);
return query.find(callback);
};
/**
* Merges the current named scope query into `query`.
*
* @param {Query} query
* @api private
*/
Model._applyNamedScope = function (query) {
var cQuery = this._cumulativeQuery;
if (cQuery) {
merge(query._conditions, cQuery._conditions);
if (query._fields && cQuery._fields)
merge(query._fields, cQuery._fields);
if (query.options && cQuery.options)
merge(query.options, cQuery.options);
delete this._cumulativeQuery;
}
return query;
}
/**
* Finds by id
*
* @param {ObjectId/Object} objectid, or a value that can be casted to it
* @api public
*/
Model.findById = function (id, fields, options, callback) {
return this.findOne({ _id: id }, fields, options, callback);
};
/**
* Finds one document
*
* @param {Object} conditions
* @param {Object/Function} (optional) fields to hydrate or callback
* @param {Function} callback
* @api public
*/
Model.findOne = function (conditions, fields, options, callback) {
if ('function' == typeof options) {
// TODO Handle all 3 of the following scenarios
// Hint: Only some of these scenarios are possible if cQuery is present
// Scenario: findOne(conditions, fields, callback);
// Scenario: findOne(fields, options, callback);
// Scenario: findOne(conditions, options, callback);
callback = options;
options = null;
} else if ('function' == typeof fields) {
// TODO Handle all 2 of the following scenarios
// Scenario: findOne(conditions, callback)
// Scenario: findOne(fields, callback)
// Scenario: findOne(options, callback);
callback = fields;
fields = null;
options = null;
} else if ('function' == typeof conditions) {
callback = conditions;
conditions = {};
fields = null;
options = null;
}
var query = new Query(conditions, options).select(fields).bind(this, 'findOne');
if ('undefined' == typeof callback)
return query;
this._applyNamedScope(query);
return query.findOne(callback);
};
/**
* Counts documents
*
* @param {Object} conditions
* @param {Function} optional callback
* @api public
*/
Model.count = function (conditions, callback) {
var query = new Query(conditions).bind(this, 'count');
if ('undefined' == typeof callback)
return query;
this._applyNamedScope(query);
return query.count(callback);
};
Model.distinct = function (field, conditions, callback) {
var query = new Query(conditions).bind(this, 'distinct');
if ('undefined' == typeof callback) {
query._distinctArg = field;
return query;
}
this._applyNamedScope(query);
return query.distinct(field, callback);
};
/**
* `where` enables a very nice sugary api for doing your queries.
* For example, instead of writing:
* User.find({age: {$gte: 21, $lte: 65}}, callback);
* we can instead write more readably:
* User.where('age').gte(21).lte(65);
* Moreover, you can also chain a bunch of these together like:
* User
* .where('age').gte(21).lte(65)
* .where('name', /^b/i) // All names that begin where b or B
* .where('friends').slice(10);
* @param {String} path
* @param {Object} val (optional)
* @return {Query}
* @api public
*/
Model.where = function (path, val) {
var q = new Query().bind(this, 'find');
return q.where.apply(q, arguments);
};
/**
* Sometimes you need to query for things in mongodb using a JavaScript
* expression. You can do so via find({$where: javascript}), or you can
* use the mongoose shortcut method $where via a Query chain or from
* your mongoose Model.
*
* @param {String|Function} js is a javascript string or anonymous function
* @return {Query}
* @api public
*/
Model.$where = function () {
var q = new Query().bind(this, 'find');
return q.$where.apply(q, arguments);
};
/**
* Shortcut for creating a new Document that is automatically saved
* to the db if valid.
*
* @param {Object} doc
* @param {Function} callback
* @api public
*/
Model.create = function (doc, fn) {
var args = utils.args(arguments)
, lastArg = args[args.length-1]
, docs = []
, count;
if (typeof lastArg === 'function') {
fn = args.pop();
}
count = args.length;
var self = this;
args.forEach(function (arg, i) {
var doc = new self(arg);
docs[i] = doc;
doc.save(function (err) {
if (err) return fn(err);
--count || fn.apply(null, [null].concat(docs));
});
});
};
/**
* Updates documents.
*
* Examples:
*
* MyModel.update({ age: { $gt: 18 } }, { oldEnough: true }, fn);
* MyModel.update({ name: 'Tobi' }, { ferret: true }, { multi: true }, fn);
*
* Valid options:
* - safe (boolean) safe mode (defaults to value set in schema (false))
* - upsert (boolean) whether to create the doc if it doesn't match (false)
* - multi (boolean) whether multiple documents should be update (false)
*
* @param {Object} conditions
* @param {Object] doc
* @param {Object} options
* @param {Function} callback
* @return {Query}
* @api public
*/
Model.update = function (conditions, doc, options, callback) {
if (arguments.length < 4) {
if ('function' === typeof options) {
// Scenario: update(conditions, doc, callback)
callback = options;
options = null;
} else if ('function' === typeof doc) {
// Scenario: update(doc, callback);
callback = doc;
doc = conditions;
conditions = {};
options = null;
}
}
var query = new Query(conditions, options).bind(this, 'update', doc);
if ('undefined' == typeof callback)
return query;
this._applyNamedScope(query);
return query.update(doc, callback);
};
/**
* Compiler utility.
*
* @param {String} model name
* @param {Schema} schema object
* @param {String} collection name
* @param {Connection} connection to use
* @param {Mongoose} mongoose instance
* @api private
*/
Model.compile = function (name, schema, collectionName, connection, base) {
// generate new class
function model () {
Model.apply(this, arguments);
};
model.modelName = name;
model.__proto__ = Model;
model.prototype.__proto__ = Model.prototype;
model.prototype.base = base;
model.prototype.schema = schema;
model.prototype.db = connection;
model.prototype.collection = connection.collection(collectionName);
// apply methods
for (var i in schema.methods)
model.prototype[i] = schema.methods[i];
// apply statics
for (var i in schema.statics)
model[i] = schema.statics[i];
// apply named scopes
if (schema.namedScopes) schema.namedScopes.compile(model);
return model;
};