Merge pull request #302 from mfikria/feature/fix-email-duplicated-invites

Implement dot notation email validation for gmail

Author: maxceem

config/default.json

@@ -59,5 +59,6 @@
   "inviteEmailSectionTitle": "Project Invitation",
   "connectUrl":"https://connect.topcoder-dev.com",
   "accountsAppUrl": "https://accounts.topcoder-dev.com",
-  "MAX_REVISION_NUMBER": 100
+  "MAX_REVISION_NUMBER": 100,
+  "UNIQUE_GMAIL_VALIDATION": true
 }

src/routes/projectMemberInvites/create.js

@@ -28,6 +28,30 @@ const addMemberValidations = {
   },
 };
 
+/**
+ * Helper method to check the uniqueness of two emails
+ *
+ * @param {String} email1    first email to compare
+ * @param {String} email2    second email to compare
+ * @param {Object} options  the options
+ *
+ * @returns {Boolean} true if two emails are same
+ */
+const compareEmail = (email1, email2, options = { UNIQUE_GMAIL_VALIDATION: false }) => {
+  if (options.UNIQUE_GMAIL_VALIDATION) {
+    // email is gmail
+    const emailSplit = /(^[\w.+-]+)(@gmail\.com|@googlemail\.com)$/g.exec(_.toLower(email1));
+    if (emailSplit) {
+      const address = emailSplit[1].replace('.', '');
+      const emailDomain = emailSplit[2].replace('.', '\\.');
+      const regexAddress = address.split('').join('\\.?');
+      const regex = new RegExp(`${regexAddress}${emailDomain}`);
+      return regex.test(_.toLower(email2));
+    }
+  }
+  return _.toLower(email1) === _.toLower(email2);
+};
+
 /**
  * Helper method to build promises for creating new invites in DB
  *
@@ -68,7 +92,8 @@ const buildCreateInvitePromises = (req, invite, invites, data, failed) => {
         });
         // non-existent users we will invite them by email only
         const nonExistentUserEmails = invite.emails.filter(inviteEmail =>
-          !_.find(existentUsers, { email: inviteEmail }),
+          !_.find(existentUsers, existentUser =>
+            compareEmail(existentUser.email, inviteEmail, { UNIQUE_GMAIL_VALIDATION: false })),
         );
 
         // remove invites for users that are invited already
@@ -84,7 +109,8 @@ const buildCreateInvitePromises = (req, invite, invites, data, failed) => {
 
         // remove invites for users that are invited already
         _.remove(nonExistentUserEmails, email =>
-          _.some(invites, i => _.toLower(i.email) === _.toLower(email)));
+          _.some(invites, i =>
+            compareEmail(i.email, email, { UNIQUE_GMAIL_VALIDATION: config.get('UNIQUE_GMAIL_VALIDATION') })));
         nonExistentUserEmails.forEach((email) => {
           const dataNew = _.clone(data);
 

src/routes/projectMemberInvites/create.spec.js

@@ -87,7 +87,7 @@ describe('Project Member Invite create', () => {
                 }),
                 models.ProjectMemberInvite.create({
                   projectId: project1.id,
-                  email: 'duplicate_lowercase@gmail.com',
+                  email: 'duplicate_lowercase@test.com',
                   role: PROJECT_MEMBER_ROLE.MANAGER,
                   status: INVITE_STATUS.PENDING,
                   createdBy: 1,
@@ -97,7 +97,27 @@ describe('Project Member Invite create', () => {
                 }),
                 models.ProjectMemberInvite.create({
                   projectId: project1.id,
-                  email: 'DUPLICATE_UPPERCASE@gmail.com',
+                  email: 'DUPLICATE_UPPERCASE@test.com',
+                  role: PROJECT_MEMBER_ROLE.MANAGER,
+                  status: INVITE_STATUS.PENDING,
+                  createdBy: 1,
+                  updatedBy: 1,
+                  createdAt: '2016-06-30 00:33:07+00',
+                  updatedAt: '2016-06-30 00:33:07+00',
+                }),
+                models.ProjectMemberInvite.create({
+                  projectId: project1.id,
+                  email: 'with.dot@gmail.com',
+                  role: PROJECT_MEMBER_ROLE.MANAGER,
+                  status: INVITE_STATUS.PENDING,
+                  createdBy: 1,
+                  updatedBy: 1,
+                  createdAt: '2016-06-30 00:33:07+00',
+                  updatedAt: '2016-06-30 00:33:07+00',
+                }),
+                models.ProjectMemberInvite.create({
+                  projectId: project1.id,
+                  email: 'withoutdot@gmail.com',
                   role: PROJECT_MEMBER_ROLE.MANAGER,
                   status: INVITE_STATUS.PENDING,
                   createdBy: 1,
@@ -664,33 +684,14 @@ describe('Project Member Invite create', () => {
     });
 
     it('should return 201 and empty response when trying add already invited member by lowercase email', (done) => {
-      const mockHttpClient = _.merge(testUtil.mockHttpClient, {
-        get: () => Promise.resolve({
-          status: 200,
-          data: {
-            id: 'requesterId',
-            version: 'v3',
-            result: {
-              success: true,
-              status: 200,
-              content: {
-                success: [{
-                  roleName: USER_ROLE.COPILOT,
-                }],
-              },
-            },
-          },
-        }),
-      });
-      sandbox.stub(util, 'getHttpClient', () => mockHttpClient);
       request(server)
         .post(`/v4/projects/${project1.id}/members/invite`)
         .set({
           Authorization: `Bearer ${testUtil.jwts.copilot}`,
         })
         .send({
           param: {
-            emails: ['DUPLICATE_LOWERCASE@gmail.com'],
+            emails: ['DUPLICATE_LOWERCASE@test.com'],
             role: 'customer',
           },
         })
@@ -703,40 +704,20 @@ describe('Project Member Invite create', () => {
             const resJson = res.body.result.content.success;
             should.exist(resJson);
             resJson.length.should.equal(0);
-            server.services.pubsub.publish.neverCalledWith('project.member.invite.created').should.be.true;
             done();
           }
         });
     });
 
     it('should return 201 and empty response when trying add already invited member by uppercase email', (done) => {
-      const mockHttpClient = _.merge(testUtil.mockHttpClient, {
-        get: () => Promise.resolve({
-          status: 200,
-          data: {
-            id: 'requesterId',
-            version: 'v3',
-            result: {
-              success: true,
-              status: 200,
-              content: {
-                success: [{
-                  roleName: USER_ROLE.COPILOT,
-                }],
-              },
-            },
-          },
-        }),
-      });
-      sandbox.stub(util, 'getHttpClient', () => mockHttpClient);
       request(server)
         .post(`/v4/projects/${project1.id}/members/invite`)
         .set({
           Authorization: `Bearer ${testUtil.jwts.copilot}`,
         })
         .send({
           param: {
-            emails: ['duplicate_uppercase@gmail.com'],
+            emails: ['duplicate_uppercase@test.com'],
             role: 'customer',
           },
         })
@@ -749,12 +730,65 @@ describe('Project Member Invite create', () => {
             const resJson = res.body.result.content.success;
             should.exist(resJson);
             resJson.length.should.equal(0);
-            server.services.pubsub.publish.neverCalledWith('project.member.invite.created').should.be.true;
             done();
           }
         });
     });
 
+    it('should return 201 and empty response when trying add already invited member by gmail email with dot',
+      (done) => {
+        request(server)
+          .post(`/v4/projects/${project1.id}/members/invite`)
+          .set({
+            Authorization: `Bearer ${testUtil.jwts.copilot}`,
+          })
+          .send({
+            param: {
+              emails: ['WITHdot@gmail.com'],
+              role: 'customer',
+            },
+          })
+          .expect('Content-Type', /json/)
+          .expect(201)
+          .end((err, res) => {
+            if (err) {
+              done(err);
+            } else {
+              const resJson = res.body.result.content.success;
+              should.exist(resJson);
+              resJson.length.should.equal(0);
+              done();
+            }
+          });
+      });
+
+    it('should return 201 and empty response when trying add already invited member by gmail email without dot',
+      (done) => {
+        request(server)
+          .post(`/v4/projects/${project1.id}/members/invite`)
+          .set({
+            Authorization: `Bearer ${testUtil.jwts.copilot}`,
+          })
+          .send({
+            param: {
+              emails: ['WITHOUT.dot@gmail.com'],
+              role: 'customer',
+            },
+          })
+          .expect('Content-Type', /json/)
+          .expect(201)
+          .end((err, res) => {
+            if (err) {
+              done(err);
+            } else {
+              const resJson = res.body.result.content.success;
+              should.exist(resJson);
+              resJson.length.should.equal(0);
+              done();
+            }
+          });
+      });
+
     describe('Bus api', () => {
       let createEventSpy;