'use strict'; /*! * Module dependencies. */ const EventEmitter = require('events').EventEmitter; const Schema = require('./schema'); const Collection = require('./driver').get().Collection; const STATES = require('./connectionstate'); const MongooseError = require('./error'); const PromiseProvider = require('./promise_provider'); const get = require('./helpers/get'); const mongodb = require('mongodb'); const utils = require('./utils'); const parseConnectionString = require('mongodb-core').parseConnectionString; /*! * A list of authentication mechanisms that don't require a password for authentication. * This is used by the authMechanismDoesNotRequirePassword method. * * @api private */ const noPasswordAuthMechanisms = [ 'MONGODB-X509' ]; /** * Connection constructor * * For practical reasons, a Connection equals a Db. * * @param {Mongoose} base a mongoose instance * @inherits NodeJS EventEmitter http://nodejs.org/api/events.html#events_class_events_eventemitter * @event `connecting`: Emitted when `connection.openUri()` is executed on this connection. * @event `connected`: Emitted when this connection successfully connects to the db. May be emitted _multiple_ times in `reconnected` scenarios. * @event `open`: Emitted after we `connected` and `onOpen` is executed on all of this connections models. * @event `disconnecting`: Emitted when `connection.close()` was executed. * @event `disconnected`: Emitted after getting disconnected from the db. * @event `close`: Emitted after we `disconnected` and `onClose` executed on all of this connections models. * @event `reconnected`: Emitted after we `connected` and subsequently `disconnected`, followed by successfully another successfull connection. * @event `error`: Emitted when an error occurs on this connection. * @event `fullsetup`: Emitted in a replica-set scenario, when primary and at least one seconaries specified in the connection string are connected. * @event `all`: Emitted in a replica-set scenario, when all nodes specified in the connection string are connected. * @api public */ function Connection(base) { this.base = base; this.collections = {}; this.models = {}; this.config = {autoIndex: true}; this.replica = false; this.options = null; this.otherDbs = []; // FIXME: To be replaced with relatedDbs this.relatedDbs = {}; // Hashmap of other dbs that share underlying connection this.states = STATES; this._readyState = STATES.disconnected; this._closeCalled = false; this._hasOpened = false; this.$internalEmitter = new EventEmitter(); this.$internalEmitter.setMaxListeners(0); } /*! * Inherit from EventEmitter */ Connection.prototype.__proto__ = EventEmitter.prototype; /** * Connection ready state * * - 0 = disconnected * - 1 = connected * - 2 = connecting * - 3 = disconnecting * * Each state change emits its associated event name. * * ####Example * * conn.on('connected', callback); * conn.on('disconnected', callback); * * @property readyState * @memberOf Connection * @instance * @api public */ Object.defineProperty(Connection.prototype, 'readyState', { get: function() { return this._readyState; }, set: function(val) { if (!(val in STATES)) { throw new Error('Invalid connection state: ' + val); } if (this._readyState !== val) { this._readyState = val; // [legacy] loop over the otherDbs on this connection and change their state for (let i = 0; i < this.otherDbs.length; i++) { this.otherDbs[i].readyState = val; } // loop over relatedDbs on this connection and change their state for (const k in this.relatedDbs) { this.relatedDbs[k].readyState = val; } if (STATES.connected === val) { this._hasOpened = true; } this.emit(STATES[val]); } } }); /** * A hash of the collections associated with this connection * * @property collections * @memberOf Connection * @instance * @api public */ Connection.prototype.collections; /** * The name of the database this connection points to. * * ####Example * * mongoose.createConnection('mongodb://localhost:27017/mydb').name; // "mydb" * * @property name * @memberOf Connection * @instance * @api public */ Connection.prototype.name; /** * The host name portion of the URI. If multiple hosts, such as a replica set, * this will contain the first host name in the URI * * ####Example * * mongoose.createConnection('mongodb://localhost:27017/mydb').host; // "localhost" * * @property host * @memberOf Connection * @instance * @api public */ Object.defineProperty(Connection.prototype, 'host', { configurable: true, enumerable: true, writable: true }); /** * The port portion of the URI. If multiple hosts, such as a replica set, * this will contain the port from the first host name in the URI. * * ####Example * * mongoose.createConnection('mongodb://localhost:27017/mydb').port; // 27017 * * @property port * @memberOf Connection * @instance * @api public */ Object.defineProperty(Connection.prototype, 'port', { configurable: true, enumerable: true, writable: true }); /** * The username specified in the URI * * ####Example * * mongoose.createConnection('mongodb://val:psw@localhost:27017/mydb').user; // "val" * * @property user * @memberOf Connection * @instance * @api public */ Object.defineProperty(Connection.prototype, 'user', { configurable: true, enumerable: true, writable: true }); /** * The password specified in the URI * * ####Example * * mongoose.createConnection('mongodb://val:psw@localhost:27017/mydb').pass; // "psw" * * @property pass * @memberOf Connection * @instance * @api public */ Object.defineProperty(Connection.prototype, 'pass', { configurable: true, enumerable: true, writable: true }); /** * The mongodb.Db instance, set when the connection is opened * * @property db * @memberOf Connection * @instance * @api public */ Connection.prototype.db; /** * A hash of the global options that are associated with this connection * * @property config * @memberOf Connection * @instance * @api public */ Connection.prototype.config; /** * Helper for `createCollection()`. Will explicitly create the given collection * with specified options. Used to create [capped collections](https://docs.mongodb.com/manual/core/capped-collections/) * and [views](https://docs.mongodb.com/manual/core/views/) from mongoose. * * Options are passed down without modification to the [MongoDB driver's `createCollection()` function](http://mongodb.github.io/node-mongodb-native/2.2/api/Db.html#createCollection) * * @method createCollection * @param {string} collection The collection to create * @param {Object} [options] see [MongoDB driver docs](http://mongodb.github.io/node-mongodb-native/2.2/api/Db.html#createCollection) * @param {Function} [callback] * @return {Promise} * @api public */ Connection.prototype.createCollection = _wrapConnHelper(function createCollection(collection, options, cb) { if (typeof options === 'function') { cb = options; options = {}; } this.db.createCollection(collection, options, cb); }); /** * _Requires MongoDB >= 3.6.0._ Starts a [MongoDB session](https://docs.mongodb.com/manual/release-notes/3.6/#client-sessions) * for benefits like causal consistency, [retryable writes](https://docs.mongodb.com/manual/core/retryable-writes/), * and [transactions](http://thecodebarbarian.com/a-node-js-perspective-on-mongodb-4-transactions.html). * * ####Example: * * const session = await conn.startSession(); * let doc = await Person.findOne({ name: 'Ned Stark' }, null, { session }); * await doc.remove(); * // `doc` will always be null, even if reading from a replica set * // secondary. Without causal consistency, it is possible to * // get a doc back from the below query if the query reads from a * // secondary that is experiencing replication lag. * doc = await Person.findOne({ name: 'Ned Stark' }, null, { session, readPreference: 'secondary' }); * * * @method startSession * @param {Object} [options] see the [mongodb driver options](http://mongodb.github.io/node-mongodb-native/3.0/api/MongoClient.html#startSession) * @param {Boolean} [options.causalConsistency=true] set to false to disable causal consistency * @param {Function} [callback] * @return {Promise} promise that resolves to a MongoDB driver `ClientSession` * @api public */ Connection.prototype.startSession = _wrapConnHelper(function startSession(options, cb) { if (typeof options === 'function') { cb = options; options = null; } const session = this.client.startSession(options); cb(null, session); }); /** * Helper for `dropCollection()`. Will delete the given collection, including * all documents and indexes. * * @method dropCollection * @param {string} collection The collection to delete * @param {Function} [callback] * @return {Promise} * @api public */ Connection.prototype.dropCollection = _wrapConnHelper(function dropCollection(collection, cb) { this.db.dropCollection(collection, cb); }); /** * Helper for `dropDatabase()`. Deletes the given database, including all * collections, documents, and indexes. * * @method dropDatabase * @param {Function} [callback] * @return {Promise} * @api public */ Connection.prototype.dropDatabase = _wrapConnHelper(function dropDatabase(cb) { this.$internalEmitter.emit('dropDatabase'); this.db.dropDatabase(cb); }); /*! * ignore */ function _wrapConnHelper(fn) { return function() { const cb = arguments.length > 0 ? arguments[arguments.length - 1] : null; const argsWithoutCb = typeof cb === 'function' ? Array.prototype.slice.call(arguments, 0, arguments.length - 1) : Array.prototype.slice.call(arguments); return utils.promiseOrCallback(cb, cb => { if (this.readyState !== STATES.connected) { this.once('open', function() { fn.apply(this, argsWithoutCb.concat([cb])); }); } else { fn.apply(this, argsWithoutCb.concat([cb])); } }); }; } /** * error * * Graceful error handling, passes error to callback * if available, else emits error on the connection. * * @param {Error} err * @param {Function} callback optional * @api private */ Connection.prototype.error = function(err, callback) { if (callback) { callback(err); return null; } if (this.listeners('error').length > 0) { this.emit('error', err); } return Promise.reject(err); }; /** * Called when the connection is opened * * @api private */ Connection.prototype.onOpen = function() { this.readyState = STATES.connected; // avoid having the collection subscribe to our event emitter // to prevent 0.3 warning for (const i in this.collections) { if (utils.object.hasOwnProperty(this.collections, i)) { this.collections[i].onOpen(); } } this.emit('open'); }; /** * Opens the connection with a URI using `MongoClient.connect()`. * * @param {String} uri The URI to connect with. * @param {Object} [options] Passed on to http://mongodb.github.io/node-mongodb-native/2.2/api/MongoClient.html#connect * @param {Function} [callback] * @returns {Connection} this * @api private */ Connection.prototype.openUri = function(uri, options, callback) { this.readyState = STATES.connecting; this._closeCalled = false; if (typeof options === 'function') { callback = options; options = null; } if (['string', 'number'].indexOf(typeof options) !== -1) { throw new MongooseError('Mongoose 5.x no longer supports ' + '`mongoose.connect(host, dbname, port)` or ' + '`mongoose.createConnection(host, dbname, port)`. See ' + 'http://mongoosejs.com/docs/connections.html for supported connection syntax'); } if (typeof uri !== 'string') { throw new MongooseError('The `uri` parameter to `openUri()` must be a ' + `string, got "${typeof uri}". Make sure the first parameter to ` + '`mongoose.connect()` or `mongoose.createConnection()` is a string.'); } const Promise = PromiseProvider.get(); const _this = this; if (options) { options = utils.clone(options); const autoIndex = options.config && options.config.autoIndex != null ? options.config.autoIndex : options.autoIndex; if (autoIndex != null) { this.config.autoIndex = autoIndex !== false; delete options.config; delete options.autoIndex; } if ('autoCreate' in options) { this.config.autoCreate = !!options.autoCreate; delete options.autoCreate; } if ('useCreateIndex' in options) { this.config.useCreateIndex = !!options.useCreateIndex; delete options.useCreateIndex; } if ('useFindAndModify' in options) { this.config.useFindAndModify = !!options.useFindAndModify; delete options.useFindAndModify; } // Backwards compat if (options.user || options.pass) { options.auth = options.auth || {}; options.auth.user = options.user; options.auth.password = options.pass; this.user = options.user; this.pass = options.pass; } delete options.user; delete options.pass; if (options.bufferCommands != null) { options.bufferMaxEntries = 0; this.config.bufferCommands = options.bufferCommands; delete options.bufferCommands; } if (options.useMongoClient != null) { handleUseMongoClient(options); } } else { options = {}; } this._connectionOptions = options; const dbName = options.dbName; if (dbName != null) { this.$dbName = dbName; } delete options.dbName; if (!('promiseLibrary' in options)) { options.promiseLibrary = PromiseProvider.get(); } if (!('useNewUrlParser' in options)) { if ('useNewUrlParser' in this.base.options) { options.useNewUrlParser = this.base.options.useNewUrlParser; } else { options.useNewUrlParser = false; } } const parsePromise = new Promise((resolve, reject) => { parseConnectionString(uri, options, (err, parsed) => { if (err) { return reject(err); } this.name = dbName != null ? dbName : get(parsed, 'auth.db', null); this.host = get(parsed, 'hosts.0.host', 'localhost'); this.port = get(parsed, 'hosts.0.port', 27017); this.user = this.user || get(parsed, 'auth.username'); this.pass = this.pass || get(parsed, 'auth.password'); resolve(); }); }); const promise = new Promise((resolve, reject) => { const client = new mongodb.MongoClient(uri, options); _this.client = client; client.connect(function(error) { if (error) { _this.readyState = STATES.disconnected; return reject(error); } const db = dbName != null ? client.db(dbName) : client.db(); _this.db = db; // Backwards compat for mongoose 4.x db.on('reconnect', function() { _this.readyState = STATES.connected; _this.emit('reconnect'); _this.emit('reconnected'); }); db.s.topology.on('reconnectFailed', function() { _this.emit('reconnectFailed'); }); db.s.topology.on('left', function(data) { _this.emit('left', data); }); db.s.topology.on('joined', function(data) { _this.emit('joined', data); }); db.s.topology.on('fullsetup', function(data) { _this.emit('fullsetup', data); }); db.on('close', function() { // Implicitly emits 'disconnected' _this.readyState = STATES.disconnected; }); client.on('left', function() { if (_this.readyState === STATES.connected && get(db, 's.topology.s.coreTopology.s.replicaSetState.topologyType') === 'ReplicaSetNoPrimary') { _this.readyState = STATES.disconnected; } }); db.on('timeout', function() { _this.emit('timeout'); }); delete _this.then; delete _this.catch; _this.readyState = STATES.connected; for (const i in _this.collections) { if (utils.object.hasOwnProperty(_this.collections, i)) { _this.collections[i].onOpen(); } } resolve(_this); _this.emit('open'); }); }); this.$initialConnection = Promise.all([promise, parsePromise]). then(res => res[0]). catch(err => { if (this.listeners('error').length > 0) { process.nextTick(() => this.emit('error', err)); return; } throw err; }); this.then = function(resolve, reject) { return this.$initialConnection.then(resolve, reject); }; this.catch = function(reject) { return this.$initialConnection.catch(reject); }; if (callback != null) { this.$initialConnection = this.$initialConnection.then( () => callback(null, this), err => callback(err) ); } return this; }; /*! * ignore */ const handleUseMongoClient = function handleUseMongoClient(options) { console.warn('WARNING: The `useMongoClient` option is no longer ' + 'necessary in mongoose 5.x, please remove it.'); const stack = new Error().stack; console.warn(stack.substr(stack.indexOf('\n') + 1)); delete options.useMongoClient; }; /** * Closes the connection * * @param {Boolean} [force] optional * @param {Function} [callback] optional * @return {Connection} self * @api public */ Connection.prototype.close = function(force, callback) { if (typeof force === 'function') { callback = force; force = false; } this.$wasForceClosed = !!force; return utils.promiseOrCallback(callback, cb => { this._close(force, cb); }); }; /** * Handles closing the connection * * @param {Boolean} force * @param {Function} callback * @api private */ Connection.prototype._close = function(force, callback) { const _this = this; this._closeCalled = true; switch (this.readyState) { case 0: // disconnected callback(); break; case 1: // connected this.readyState = STATES.disconnecting; this.doClose(force, function(err) { if (err) { return callback(err); } _this.onClose(force); callback(null); }); break; case 2: // connecting this.once('open', function() { _this.close(callback); }); break; case 3: // disconnecting this.once('close', function() { callback(); }); break; } return this; }; /** * Called when the connection closes * * @api private */ Connection.prototype.onClose = function(force) { this.readyState = STATES.disconnected; // avoid having the collection subscribe to our event emitter // to prevent 0.3 warning for (const i in this.collections) { if (utils.object.hasOwnProperty(this.collections, i)) { this.collections[i].onClose(force); } } this.emit('close', force); }; /** * Retrieves a collection, creating it if not cached. * * Not typically needed by applications. Just talk to your collection through your model. * * @param {String} name of the collection * @param {Object} [options] optional collection options * @return {Collection} collection instance * @api public */ Connection.prototype.collection = function(name, options) { options = options ? utils.clone(options) : {}; options.$wasForceClosed = this.$wasForceClosed; if (!(name in this.collections)) { this.collections[name] = new Collection(name, this, options); } return this.collections[name]; }; /** * Defines or retrieves a model. * * var mongoose = require('mongoose'); * var db = mongoose.createConnection(..); * db.model('Venue', new Schema(..)); * var Ticket = db.model('Ticket', new Schema(..)); * var Venue = db.model('Venue'); * * _When no `collection` argument is passed, Mongoose produces a collection name by passing the model `name` to the [utils.toCollectionName](#utils_exports.toCollectionName) method. This method pluralizes the name. If you don't like this behavior, either pass a collection name or set your schemas collection name option._ * * ####Example: * * var schema = new Schema({ name: String }, { collection: 'actor' }); * * // or * * schema.set('collection', 'actor'); * * // or * * var collectionName = 'actor' * var M = conn.model('Actor', schema, collectionName) * * @param {String|Function} name the model name or class extending Model * @param {Schema} [schema] a schema. necessary when defining a model * @param {String} [collection] name of mongodb collection (optional) if not given it will be induced from model name * @see Mongoose#model #index_Mongoose-model * @return {Model} The compiled model * @api public */ Connection.prototype.model = function(name, schema, collection) { if (!(this instanceof Connection)) { throw new MongooseError('`connection.model()` should not be run with ' + '`new`. If you are doing `new db.model(foo)(bar)`, use ' + '`db.model(foo)(bar)` instead'); } let fn; if (typeof name === 'function') { fn = name; name = fn.name; } // collection name discovery if (typeof schema === 'string') { collection = schema; schema = false; } if (utils.isObject(schema) && !schema.instanceOfSchema) { schema = new Schema(schema); } if (schema && !schema.instanceOfSchema) { throw new Error('The 2nd parameter to `mongoose.model()` should be a ' + 'schema or a POJO'); } if (this.models[name] && !collection) { // model exists but we are not subclassing with custom collection if (schema && schema.instanceOfSchema && schema !== this.models[name].schema) { throw new MongooseError.OverwriteModelError(name); } return this.models[name]; } const opts = {cache: false, connection: this}; let model; if (schema && schema.instanceOfSchema) { // compile a model model = this.base.model(fn || name, schema, collection, opts); // only the first model with this name is cached to allow // for one-offs with custom collection names etc. if (!this.models[name]) { this.models[name] = model; } // Errors handled internally, so safe to ignore error model.init(function $modelInitNoop() {}); return model; } if (this.models[name] && collection) { // subclassing current model with alternate collection model = this.models[name]; schema = model.prototype.schema; const sub = model.__subclass(this, schema, collection); // do not cache the sub model return sub; } // lookup model in mongoose module model = this.base.models[name]; if (!model) { throw new MongooseError.MissingSchemaError(name); } if (this === model.prototype.db && (!collection || collection === model.collection.name)) { // model already uses this connection. // only the first model with this name is cached to allow // for one-offs with custom collection names etc. if (!this.models[name]) { this.models[name] = model; } return model; } this.models[name] = model.__subclass(this, schema, collection); return this.models[name]; }; /** * Removes the model named `name` from this connection, if it exists. You can * use this function to clean up any models you created in your tests to * prevent OverwriteModelErrors. * * ####Example: * * conn.model('User', new Schema({ name: String })); * console.log(conn.model('User')); // Model object * conn.deleteModel('User'); * console.log(conn.model('User')); // undefined * * // Usually useful in a Mocha `afterEach()` hook * afterEach(function() { * conn.deleteModel(/.+/); // Delete every model * }); * * @api public * @param {String|RegExp} name if string, the name of the model to remove. If regexp, removes all models whose name matches the regexp. * @return {Connection} this */ Connection.prototype.deleteModel = function(name) { if (typeof name === 'string') { const model = this.model(name); if (model == null) { return this; } delete this.models[name]; delete this.collections[model.collection.name]; delete this.base.modelSchemas[name]; } else if (name instanceof RegExp) { const pattern = name; const names = this.modelNames(); for (const name of names) { if (pattern.test(name)) { this.deleteModel(name); } } } else { throw new Error('First parameter to `deleteModel()` must be a string ' + 'or regexp, got "' + name + '"'); } return this; }; /** * Returns an array of model names created on this connection. * @api public * @return {Array} */ Connection.prototype.modelNames = function() { return Object.keys(this.models); }; /** * @brief Returns if the connection requires authentication after it is opened. Generally if a * username and password are both provided than authentication is needed, but in some cases a * password is not required. * @api private * @return {Boolean} true if the connection should be authenticated after it is opened, otherwise false. */ Connection.prototype.shouldAuthenticate = function() { return this.user != null && (this.pass != null || this.authMechanismDoesNotRequirePassword()); }; /** * @brief Returns a boolean value that specifies if the current authentication mechanism needs a * password to authenticate according to the auth objects passed into the openUri methods. * @api private * @return {Boolean} true if the authentication mechanism specified in the options object requires * a password, otherwise false. */ Connection.prototype.authMechanismDoesNotRequirePassword = function() { if (this.options && this.options.auth) { return noPasswordAuthMechanisms.indexOf(this.options.auth.authMechanism) >= 0; } return true; }; /** * @brief Returns a boolean value that specifies if the provided objects object provides enough * data to authenticate with. Generally this is true if the username and password are both specified * but in some authentication methods, a password is not required for authentication so only a username * is required. * @param {Object} [options] the options object passed into the openUri methods. * @api private * @return {Boolean} true if the provided options object provides enough data to authenticate with, * otherwise false. */ Connection.prototype.optionsProvideAuthenticationData = function(options) { return (options) && (options.user) && ((options.pass) || this.authMechanismDoesNotRequirePassword()); }; /** * Switches to a different database using the same connection pool. * * Returns a new connection object, with the new db. * * @method useDb * @memberOf Connection * @param {String} name The database name * @return {Connection} New Connection Object * @api public */ /*! * Module exports. */ Connection.STATES = STATES; module.exports = Connection;