keystone/lib/core/openDatabaseConnection.js

Web Application Framework and Admin GUI / Content Management System built on Express.js and Mongoose

var debug = require('debug')('keystone:core:openDatabaseConnection');

module.exports = function openDatabaseConnection (callback) {

	var keystone = this;
	var mongoConnectionOpen = false;

	// support replica sets for mongoose
	if (keystone.get('mongo replica set')) {

		if (keystone.get('logger')) {
			console.log('\nWarning: using the `mongo replica set` option has been deprecated and will be removed in'
				+ ' a future version.\nInstead set the `mongo` connection string with your host details, e.g.'
				+ ' mongodb://username:password@host:port,host:port,host:port/database and set any replica set options'
				+ ' in `mongo options`.\n\nRefer to https://mongodb.github.io/node-mongodb-native/driver-articles/mongoclient.html'
				+ ' for more details on the connection settings.');
		}

		debug('setting up mongo replica set');
		var replicaData = keystone.get('mongo replica set');
		var replica = '';

		var credentials = (replicaData.username && replicaData.password) ? replicaData.username + ':' + replicaData.password + '@' : '';

		replicaData.db.servers.forEach(function (server) {
			replica += 'mongodb://' + credentials + server.host + ':' + server.port + '/' + replicaData.db.name + ',';
		});

		var options = {
			auth: { authSource: replicaData.authSource },
			replset: {
				rs_name: replicaData.db.replicaSetOptions.rs_name,
				readPreference: replicaData.db.replicaSetOptions.readPreference,
			},
			useMongoClient: true,
		};

		debug('connecting to replica set');
		keystone.mongoose.connect(replica, options);

	} else {
		debug('connecting to mongo');
		keystone.initDatabaseConfig();
		var mongo_options = keystone.get('mongo options') || {};
		mongo_options.useMongoClient = true;
		keystone.mongoose.connect(keystone.get('mongo'), mongo_options);
	}

	keystone.mongoose.connection.on('error', function (err) {

		// The DB connection has been established previously and this a ValidationError caused by restrictions Mongoose is enforcing on the field value
		// We can ignore these here; they'll also be picked up by the 'error' event listener on the model; see /lib/list/register.js
		if (mongoConnectionOpen && err && err.name === 'ValidationError') return;

		// Alternatively, the error is legitimate; output it
		console.error('------------------------------------------------');
		console.error('Mongoose connection "error" event fired with:');
		console.error(err);

		// There's been an error establishing the initial connection, ie. Keystone is attempting to start
		if (!mongoConnectionOpen) {
			throw new Error('KeystoneJS (' + keystone.get('name') + ') failed to start - Check that you are running `mongod` in a separate process.');
		}

		// Otherwise rethrow the initial error
		throw err;

	}).once('open', function () {

		debug('mongo connection open');
		mongoConnectionOpen = true;

		var connected = function () {
			if (keystone.get('auto update')) {
				debug('applying auto update');
				keystone.applyUpdates(callback);
			} else {
				callback();
			}
		};

		if (keystone.sessionStorePromise) {
			keystone.sessionStorePromise.then(connected);
		} else {
			connected();
		}

	});

	return this;
};