'use strict'; /*! * Module dependencies. */ const MongooseCollection = require('../../collection'); const MongooseError = require('../../error/mongooseError'); const Collection = require('mongodb').Collection; const ObjectId = require('./objectid'); const get = require('../../helpers/get'); const getConstructorName = require('../../helpers/getConstructorName'); const sliced = require('sliced'); const stream = require('stream'); const util = require('util'); /** * A [node-mongodb-native](https://github.com/mongodb/node-mongodb-native) collection implementation. * * All methods methods from the [node-mongodb-native](https://github.com/mongodb/node-mongodb-native) driver are copied and wrapped in queue management. * * @inherits Collection * @api private */ function NativeCollection(name, conn, options) { this.collection = null; this.Promise = options.Promise || Promise; this.modelName = options.modelName; delete options.modelName; this._closed = false; MongooseCollection.apply(this, arguments); } /*! * Inherit from abstract Collection. */ NativeCollection.prototype.__proto__ = MongooseCollection.prototype; /** * Called when the connection opens. * * @api private */ NativeCollection.prototype.onOpen = function() { const _this = this; // always get a new collection in case the user changed host:port // of parent db instance when re-opening the connection. if (!_this.opts.capped.size) { // non-capped callback(null, _this.conn.db.collection(_this.name)); return _this.collection; } if (_this.opts.autoCreate === false) { _this.collection = _this.conn.db.collection(_this.name); MongooseCollection.prototype.onOpen.call(_this); return _this.collection; } // capped return _this.conn.db.collection(_this.name, function(err, c) { if (err) return callback(err); // discover if this collection exists and if it is capped _this.conn.db.listCollections({ name: _this.name }).toArray(function(err, docs) { if (err) { return callback(err); } const doc = docs[0]; const exists = !!doc; if (exists) { if (doc.options && doc.options.capped) { callback(null, c); } else { const msg = 'A non-capped collection exists with the name: ' + _this.name + '\n\n' + ' To use this collection as a capped collection, please ' + 'first convert it.\n' + ' http://www.mongodb.org/display/DOCS/Capped+Collections#CappedCollections-Convertingacollectiontocapped'; err = new Error(msg); callback(err); } } else { // create const opts = Object.assign({}, _this.opts.capped); opts.capped = true; _this.conn.db.createCollection(_this.name, opts, callback); } }); }); function callback(err, collection) { if (err) { // likely a strict mode error _this.conn.emit('error', err); } else { _this.collection = collection; MongooseCollection.prototype.onOpen.call(_this); } } }; /** * Called when the connection closes * * @api private */ NativeCollection.prototype.onClose = function(force) { MongooseCollection.prototype.onClose.call(this, force); }; /*! * ignore */ const syncCollectionMethods = { watch: true }; /*! * Copy the collection methods and make them subject to queues */ function iter(i) { NativeCollection.prototype[i] = function() { const collection = this.collection; const args = Array.from(arguments); const _this = this; const debug = get(_this, 'conn.base.options.debug'); const lastArg = arguments[arguments.length - 1]; const opId = new ObjectId(); // If user force closed, queueing will hang forever. See #5664 if (this.conn.$wasForceClosed) { const error = new MongooseError('Connection was force closed'); if (args.length > 0 && typeof args[args.length - 1] === 'function') { args[args.length - 1](error); return; } else { throw error; } } let _args = args; let callback = null; if (this._shouldBufferCommands() && this.buffer) { if (syncCollectionMethods[i]) { throw new Error('Collection method ' + i + ' is synchronous'); } this.conn.emit('buffer', { _id: opId, modelName: _this.modelName, collectionName: _this.name, method: i, args: args }); let callback; let _args; let promise = null; let timeout = null; if (typeof lastArg === 'function') { callback = function collectionOperationCallback() { if (timeout != null) { clearTimeout(timeout); } return lastArg.apply(this, arguments); }; _args = args.slice(0, args.length - 1).concat([callback]); } else { promise = new this.Promise((resolve, reject) => { callback = function collectionOperationCallback(err, res) { if (timeout != null) { clearTimeout(timeout); } if (err != null) { return reject(err); } resolve(res); }; _args = args.concat([callback]); this.addQueue(i, _args); }); } const bufferTimeoutMS = this._getBufferTimeoutMS(); timeout = setTimeout(() => { const removed = this.removeQueue(i, _args); if (removed) { const message = 'Operation `' + this.name + '.' + i + '()` buffering timed out after ' + bufferTimeoutMS + 'ms'; const err = new MongooseError(message); this.conn.emit('buffer-end', { _id: opId, modelName: _this.modelName, collectionName: _this.name, method: i, error: err }); callback(err); } }, bufferTimeoutMS); if (typeof lastArg === 'function') { this.addQueue(i, _args); return; } return promise; } else if (!syncCollectionMethods[i] && typeof lastArg === 'function') { callback = function collectionOperationCallback(err, res) { if (err != null) { _this.conn.emit('operation-end', { _id: opId, modelName: _this.modelName, collectionName: _this.name, method: i, error: err }); } else { _this.conn.emit('operation-end', { _id: opId, modelName: _this.modelName, collectionName: _this.name, method: i, result: res }); } return lastArg.apply(this, arguments); }; _args = args.slice(0, args.length - 1).concat([callback]); } if (debug) { if (typeof debug === 'function') { debug.apply(_this, [_this.name, i].concat(sliced(args, 0, args.length - 1))); } else if (debug instanceof stream.Writable) { this.$printToStream(_this.name, i, args, debug); } else { const color = debug.color == null ? true : debug.color; const shell = debug.shell == null ? false : debug.shell; this.$print(_this.name, i, args, color, shell); } } this.conn.emit('operation-start', { _id: opId, modelName: _this.modelName, collectionName: this.name, method: i, params: _args }); try { if (collection == null) { const message = 'Cannot call `' + this.name + '.' + i + '()` before initial connection ' + 'is complete if `bufferCommands = false`. Make sure you `await mongoose.connect()` if ' + 'you have `bufferCommands = false`.'; throw new MongooseError(message); } const ret = collection[i].apply(collection, _args); if (ret != null && typeof ret.then === 'function') { return ret.then( res => { this.conn.emit('operation-end', { _id: opId, modelName: this.modelName, collectionName: this.name, method: i, result: res }); return res; }, err => { this.conn.emit('operation-end', { _id: opId, modelName: this.modelName, collectionName: this.name, method: i, error: err }); throw err; } ); } return ret; } catch (error) { // Collection operation may throw because of max bson size, catch it here // See gh-3906 if (typeof callback === 'function') { callback(error); } else { this.conn.emit('operation-end', { _id: opId, modelName: _this.modelName, collectionName: this.name, method: i, error: error }); } if (typeof lastArg === 'function') { lastArg(error); } else { throw error; } } }; } for (const key of Object.keys(Collection.prototype)) { // Janky hack to work around gh-3005 until we can get rid of the mongoose // collection abstraction const descriptor = Object.getOwnPropertyDescriptor(Collection.prototype, key); // Skip properties with getters because they may throw errors (gh-8528) if (descriptor.get !== undefined) { continue; } if (typeof Collection.prototype[key] !== 'function') { continue; } iter(key); } /** * Debug print helper * * @api public * @method $print */ NativeCollection.prototype.$print = function(name, i, args, color, shell) { const moduleName = color ? '\x1B[0;36mMongoose:\x1B[0m ' : 'Mongoose: '; const functionCall = [name, i].join('.'); const _args = []; for (let j = args.length - 1; j >= 0; --j) { if (this.$format(args[j]) || _args.length) { _args.unshift(this.$format(args[j], color, shell)); } } const params = '(' + _args.join(', ') + ')'; console.info(moduleName + functionCall + params); }; /** * Debug print helper * * @api public * @method $print */ NativeCollection.prototype.$printToStream = function(name, i, args, stream) { const functionCall = [name, i].join('.'); const _args = []; for (let j = args.length - 1; j >= 0; --j) { if (this.$format(args[j]) || _args.length) { _args.unshift(this.$format(args[j])); } } const params = '(' + _args.join(', ') + ')'; stream.write(functionCall + params, 'utf8'); }; /** * Formatter for debug print args * * @api public * @method $format */ NativeCollection.prototype.$format = function(arg, color, shell) { const type = typeof arg; if (type === 'function' || type === 'undefined') return ''; return format(arg, false, color, shell); }; /*! * Debug print helper */ function inspectable(representation) { const ret = { inspect: function() { return representation; } }; if (util.inspect.custom) { ret[util.inspect.custom] = ret.inspect; } return ret; } function map(o) { return format(o, true); } function formatObjectId(x, key) { x[key] = inspectable('ObjectId("' + x[key].toHexString() + '")'); } function formatDate(x, key, shell) { if (shell) { x[key] = inspectable('ISODate("' + x[key].toUTCString() + '")'); } else { x[key] = inspectable('new Date("' + x[key].toUTCString() + '")'); } } function format(obj, sub, color, shell) { if (obj && typeof obj.toBSON === 'function') { obj = obj.toBSON(); } if (obj == null) { return obj; } const clone = require('../../helpers/clone'); let x = clone(obj, { transform: false }); const constructorName = getConstructorName(x); if (constructorName === 'Binary') { x = 'BinData(' + x.sub_type + ', "' + x.toString('base64') + '")'; } else if (constructorName === 'ObjectID') { x = inspectable('ObjectId("' + x.toHexString() + '")'); } else if (constructorName === 'Date') { x = inspectable('new Date("' + x.toUTCString() + '")'); } else if (constructorName === 'Object') { const keys = Object.keys(x); const numKeys = keys.length; let key; for (let i = 0; i < numKeys; ++i) { key = keys[i]; if (x[key]) { let error; if (typeof x[key].toBSON === 'function') { try { // `session.toBSON()` throws an error. This means we throw errors // in debug mode when using transactions, see gh-6712. As a // workaround, catch `toBSON()` errors, try to serialize without // `toBSON()`, and rethrow if serialization still fails. x[key] = x[key].toBSON(); } catch (_error) { error = _error; } } const _constructorName = getConstructorName(x[key]); if (_constructorName === 'Binary') { x[key] = 'BinData(' + x[key].sub_type + ', "' + x[key].buffer.toString('base64') + '")'; } else if (_constructorName === 'Object') { x[key] = format(x[key], true); } else if (_constructorName === 'ObjectID') { formatObjectId(x, key); } else if (_constructorName === 'Date') { formatDate(x, key, shell); } else if (_constructorName === 'ClientSession') { x[key] = inspectable('ClientSession("' + get(x[key], 'id.id.buffer', '').toString('hex') + '")'); } else if (Array.isArray(x[key])) { x[key] = x[key].map(map); } else if (error != null) { // If there was an error with `toBSON()` and the object wasn't // already converted to a string representation, rethrow it. // Open to better ideas on how to handle this. throw error; } } } } if (sub) { return x; } return util. inspect(x, false, 10, color). replace(/\n/g, ''). replace(/\s{2,}/g, ' '); } /** * Retrieves information about this collections indexes. * * @param {Function} callback * @method getIndexes * @api public */ NativeCollection.prototype.getIndexes = NativeCollection.prototype.indexInformation; /*! * Module exports. */ module.exports = NativeCollection;