fix(users): GitHub strategy missing email

UPGRADE.md

@@ -0,0 +1,12 @@
+<a name="0.5.0"></a>
+## 0.5.0 (TBD)
+
+* The Users collection's Email field index now uses the MongoDB [Sparse](https://docs.mongodb.org/manual/core/index-sparse/) option
+* The User model's Email field is not required, and there are scenarios where you will have User documents that don't contain the Email field. In this case, without the Sparse option, you will get a unique constraint index exception thrown when an additional User document is saved without this field.
+* If you are upgrading an existing MEANJS application, and have not changed this field, you will already have an existing index on the Email field of your Users collection. If this is the case, you will need to follow these steps for the `sparse` option to be applied.
+
+
+1. Run the upgrade script from the root of your MEANJS application to drop the index: `node scripts/upgrade-users-sparse-index`
+2. Restart your MEANJS application.
+
+When your application starts back up, Mongoose will rebuild your Email field's index; now with the `sparse` option applied to it.

gulpfile.js

@@ -372,7 +372,7 @@ gulp.task('test', function (done) {
 });
 
 gulp.task('test:server', function (done) {
-  runSequence('env:test', ['copyLocalEnvConfig', 'makeUploadsDir'], 'lint', 'mocha', done);
+  runSequence('env:test', ['copyLocalEnvConfig', 'makeUploadsDir', 'dropdb'], 'lint', 'mocha', done);
 });
 
 // Watch all server files for changes & run server tests (test:server) task on changes
@@ -381,7 +381,7 @@ gulp.task('test:server:watch', function (done) {
 });
 
 gulp.task('test:client', function (done) {
-  runSequence('env:test', 'lint', 'karma', done);
+  runSequence('env:test', 'lint', 'dropdb', 'karma', done);
 });
 
 gulp.task('test:e2e', function (done) {

modules/users/server/config/strategies/github.js

@@ -31,7 +31,7 @@ module.exports = function (config) {
       firstName: firstName,
       lastName: lastName,
       displayName: displayName,
-      email: profile.emails[0].value,
+      email: (profile.emails && profile.emails.length) ? profile.emails[0].value : undefined,
       username: profile.username,
       // jscs:disable requireCamelCaseOrUpperCaseIdentifiers
       profileImageURL: (providerData.avatar_url) ? providerData.avatar_url : undefined,

modules/users/server/models/user.server.model.js

@@ -46,7 +46,10 @@ var UserSchema = new Schema({
   },
   email: {
     type: String,
-    unique: true,
+    index: {
+      unique: true,
+      sparse: true // For this to work on a previously indexed field, the index must be dropped & the application restarted.
+    },
     lowercase: true,
     trim: true,
     default: '',

modules/users/tests/server/user.server.model.tests.js

@@ -193,6 +193,29 @@ describe('User Model Unit Tests:', function () {
 
     });
 
+    it('should not index missing email field, thus not enforce the model\'s unique index', function (done) {
+      var _user1 = new User(user1);
+      _user1.email = undefined;
+
+      var _user3 = new User(user3);
+      _user3.email = undefined;
+
+      _user1.save(function (err) {
+        should.not.exist(err);
+        _user3.save(function (err) {
+          should.not.exist(err);
+          _user3.remove(function (err) {
+            should.not.exist(err);
+            _user1.remove(function (err) {
+              should.not.exist(err);
+              done();
+            });
+          });
+        });
+      });
+
+    });
+
     it('should not save the password in plain text', function (done) {
       var _user1 = new User(user1);
       var passwordBeforeSave = _user1.password;

scripts/upgrade-users-sparse-index.js

@@ -0,0 +1,64 @@
+'use strict';
+// Set the Node ENV
+process.env.NODE_ENV = 'development';
+
+var chalk = require('chalk'),
+  mongoose = require('../config/lib/mongoose');
+
+mongoose.loadModels();
+
+var _indexToRemove = 'email_1',
+  errors = [],
+  processedCount = 0;
+
+mongoose.connect(function (db) {
+  // get a reference to the User collection
+  var userCollection = db.connections[0].collections.users;
+
+  console.log();
+  console.log(chalk.yellow('Removing index "' +
+    _indexToRemove + '" from the User collection.'));
+  console.log();
+
+  // Remove the index
+  userCollection.dropIndex(_indexToRemove, function (err, result) {
+    var message = 'Successfully removed the index "' + _indexToRemove + '".';
+
+    if (err) {
+      errors.push(err);
+      message = 'An error occured while removing the index "' + 
+        _indexToRemove + '".';
+
+      if (err.message.indexOf('index not found with name') !== -1) {
+        message = 'Index "' + _indexToRemove + '" could not be found.' +
+          '\r\nPlease double check the index name in your ' +
+          'mongodb User collection.';
+      }
+
+      reportAndExit(message);
+    } else {
+      reportAndExit(message);
+    }
+  });
+});
+
+function reportAndExit(message) {
+  if (errors.length) {
+    console.log(chalk.red(message));
+    console.log();
+
+    console.log(chalk.yellow('Errors:'));
+    for (var i = 0; i < errors.length; i++) {
+      console.log(chalk.red(errors[i]));
+
+      if (i === errors.length -1) {
+        process.exit(0);
+      }
+    }
+  } else {
+    console.log(chalk.green(message));
+    console.log(chalk.green('The next time your application starts, ' +
+      'Mongoose will rebuild the index "' + _indexToRemove + '".'));
+    process.exit(0);
+  }
+}