Merge pull request #427 from topcoder-platform/dev

Production release 2.4.16

Author: RishiRajSahu

config/custom-environment-variables.json

@@ -61,5 +61,6 @@
       "REG_STATS": "LOOKER_API_REG_STATS_QUERY_ID",
       "BUDGET": "LOOKER_API_BUDGET_QUERY_ID"
     }
-  }
+  },
+  "DEFAULT_M2M_USERID": "DEFAULT_M2M_USERID"
 }

config/default.json

@@ -71,5 +71,6 @@
       "REG_STATS": 1234,
       "BUDGET": 123
     }
-  }
+  },
+  "DEFAULT_M2M_USERID": -101
 }

package.json

@@ -62,6 +62,7 @@
     "pg": "^4.5.5",
     "pg-native": "^1.10.1",
     "sequelize": "^3.23.0",
+    "jsonpath": "^1.0.2",
     "tc-core-library-js": "appirio-tech/tc-core-library-js.git#v2.6",
     "traverse": "^0.6.6",
     "urlencode": "^1.1.0"

src/models/project.js

@@ -1,7 +1,7 @@
 /* eslint-disable valid-jsdoc */
 
 import _ from 'lodash';
-import { PROJECT_STATUS } from '../constants';
+import { PROJECT_STATUS, INVITE_STATUS } from '../constants';
 
 module.exports = function defineProject(sequelize, DataTypes) {
   const Project = sequelize.define('Project', {
@@ -76,7 +76,7 @@ module.exports = function defineProject(sequelize, DataTypes) {
         Project.hasMany(models.ProjectMember, { as: 'members', foreignKey: 'projectId' });
         Project.hasMany(models.ProjectAttachment, { as: 'attachments', foreignKey: 'projectId' });
         Project.hasMany(models.ProjectPhase, { as: 'phases', foreignKey: 'projectId' });
-        Project.hasMany(models.ProjectMemberInvite, { as: 'memberInvites', foreignKey: 'projectId' });
+        Project.hasMany(models.ProjectMemberInvite, { as: 'invites', foreignKey: 'projectId' });
         Project.hasMany(models.ScopeChangeRequest, { as: 'scopeChangeRequests', foreignKey: 'projectId' });
         Project.hasMany(models.WorkStream, { as: 'workStreams', foreignKey: 'projectId' });
       },
@@ -188,6 +188,10 @@ module.exports = function defineProject(sequelize, DataTypes) {
               model: models.PhaseProduct,
               as: 'products',
             }],
+          }, {
+            model: models.ProjectMemberInvite,
+            as: 'invites',
+            where: { status: INVITE_STATUS.PENDING },
           }],
         });
       },

src/permissions/index.js

@@ -21,7 +21,9 @@ module.exports = () => {
   Authorizer.setPolicy('project.view', projectView);
   Authorizer.setPolicy('project.edit', projectEdit);
   Authorizer.setPolicy('project.delete', projectDelete);
+  Authorizer.setPolicy('project.getMember', projectView);
   Authorizer.setPolicy('project.addMember', projectView);
+  Authorizer.setPolicy('project.listMembers', projectView);
   Authorizer.setPolicy('project.removeMember', projectMemberDelete);
   Authorizer.setPolicy('project.addAttachment', projectEdit);
   Authorizer.setPolicy('project.updateAttachment', projectAttachmentUpdate);
@@ -85,6 +87,7 @@ module.exports = () => {
   Authorizer.setPolicy('projectMemberInvite.create', projectView);
   Authorizer.setPolicy('projectMemberInvite.put', true);
   Authorizer.setPolicy('projectMemberInvite.get', true);
+  Authorizer.setPolicy('projectMemberInvite.list', projectView);
 
   Authorizer.setPolicy('form.create', projectAdmin);
   Authorizer.setPolicy('form.edit', projectAdmin);

src/routes/index.js

@@ -34,6 +34,18 @@ router.all(
   ),
 );
 
+router.all(
+  RegExp(`\\/${apiVersion}\\/.*`), (req, res, next) => {
+    // if it is an M2M call, hard code user id to a deafult value to avoid errors
+    // Ideally, the m2m token should have unique userId, which may not be an actual user, as well
+    const isMachineToken = _.get(req, 'authUser.isMachine', false);
+    if (req.authUser && !req.authUser.userId && isMachineToken) {
+      req.authUser.userId = config.DEFAULT_M2M_USERID;
+    }
+    return next();
+  },
+);
+
 router.route('/v4/projects/metadata/projectTemplates')
   .get(require('./projectTemplates/list'));
 router.route('/v4/projects/metadata/projectTemplates/:templateId(\\d+)')
@@ -107,9 +119,11 @@ router.route('/v4/projects/:projectId(\\d+)/scopeChangeRequests/:requestId(\\d+)
   // .delete(require('./scopeChangeRequests/delete'));
 
 router.route('/v4/projects/:projectId(\\d+)/members')
+  .get(require('./projectMembers/list'))
   .post(require('./projectMembers/create'));
 
 router.route('/v4/projects/:projectId(\\d+)/members/:id(\\d+)')
+  .get(require('./projectMembers/get'))
   .delete(require('./projectMembers/delete'))
   .patch(require('./projectMembers/update'));
 
@@ -217,6 +231,9 @@ router.route('/v4/timelines/metadata/milestoneTemplates/:milestoneTemplateId(\\d
   .patch(require('./milestoneTemplates/update'))
   .delete(require('./milestoneTemplates/delete'));
 
+router.route('/v4/projects/:projectId(\\d+)/members/invites')
+  .get(require('./projectMemberInvites/list'));
+
 router.route('/v4/projects/:projectId(\\d+)/members/invite')
   .post(require('./projectMemberInvites/create'))
   .put(require('./projectMemberInvites/update'))

src/routes/projectMemberInvites/create.js

@@ -1,5 +1,4 @@
 
-
 import validate from 'express-validation';
 import _ from 'lodash';
 import Joi from 'joi';
@@ -235,6 +234,8 @@ module.exports = [
   (req, res, next) => {
     let failed = [];
     const invite = req.body.param;
+    // let us request user fields during creating, probably this should be move to GET by ID endpoint instead
+    const fields = req.query.fields ? req.query.fields.split(',') : null;
 
     if (!invite.userIds && !invite.emails) {
       const err = new Error('Either userIds or emails are required');
@@ -340,16 +341,26 @@ module.exports = [
                   sendInviteEmail(req, projectId, v);
                 }
               });
-              return values;
+              return values.map(value => value.get({ plain: true }));
             }); // models.sequelize.Promise.all
         }); // models.ProjectMemberInvite.getPendingInvitesForProject
     })
+    .then(values => (
+      // populate successful invites with user details if required
+      util.getObjectsWithMemberDetails(values, fields, req)
+        .catch((err) => {
+          req.log.error('Cannot get user details for invites.');
+          req.log.debug('Error during getting user details for invites', err);
+        })
+    ))
     .then((values) => {
       const success = _.assign({}, { success: values });
       if (failed.length) {
-        res.status(403).json(util.wrapResponse(req.id, _.assign({}, success, { failed }), null, 403));
+        res.status(403).json(util.wrapResponse(req.id,
+          util.maskInviteEmails('$.email', _.assign({}, success, { failed }), req), null, 403));
       } else {
-        res.status(201).json(util.wrapResponse(req.id, success, null, 201));
+        res.status(201).json(util.wrapResponse(req.id,
+          util.maskInviteEmails('$.success[?(@.email)]', success, req), null, 201));
       }
     })
     .catch(err => next(err));

src/routes/projectMemberInvites/create.spec.js

@@ -353,6 +353,8 @@ describe('Project Member Invite create', () => {
             should.exist(resJson);
             resJson.role.should.equal('customer');
             resJson.projectId.should.equal(project2.id);
+            // temporary disable this feature, because it has some side effects
+            // resJson.email.should.equal('he**o@wo**d.com'); // email is masked
             resJson.email.should.equal('[email protected]');
             server.services.pubsub.publish.calledWith('project.member.invite.created').should.be.true;
             done();
@@ -407,6 +409,8 @@ describe('Project Member Invite create', () => {
             resJson.role.should.equal('customer');
             resJson.projectId.should.equal(project2.id);
             resJson.userId.should.equal(12345);
+            // temporary disable this feature, because it has some side effects
+            // resJson.email.should.equal('he**o@wo**d.com'); // email is masked
             resJson.email.should.equal('[email protected]');
             server.services.pubsub.publish.calledWith('project.member.invite.created').should.be.true;
             done();
@@ -848,7 +852,7 @@ describe('Project Member Invite create', () => {
           } else {
             const resJson = res.body.result.content.failed;
             should.exist(resJson);
-            resJson[0].email.should.equal('[email protected]');
+            resJson[0].email.should.equal('[email protected]'); // email is masked
             resJson[0].message.should.equal('User with such email is already invited to this project.');
             resJson.length.should.equal(1);
             done();

src/routes/projectMemberInvites/get.js

@@ -1,6 +1,6 @@
-
-
 import _ from 'lodash';
+import Joi from 'joi';
+import validate from 'express-validation';
 import { middleware as tcMiddleware } from 'tc-core-library-js';
 import models from '../../models';
 import util from '../../util';
@@ -9,27 +9,50 @@ import util from '../../util';
  * API to update invite member to project.
  *
  */
+const schema = {
+  query: {
+    fields: Joi.string().optional(),
+  },
+};
 const permissions = tcMiddleware.permissions;
 
 module.exports = [
-  // handles request validations
+  validate(schema),
   permissions('projectMemberInvite.get'),
-  (req, res, next) => {
-    const projectId = _.parseInt(req.params.projectId);
-    const currentUserId = req.authUser.userId;
-    let invite;
-    return models.ProjectMemberInvite.getPendingInviteByEmailOrUserId(projectId, req.authUser.email, currentUserId)
-        .then((_invite) => {
-          invite = _invite;
-          if (!invite) {
-                // check there is an existing invite for the user with status PENDING
-                // handle 404
-            const err = new Error('invite not found for project id ' +
-                        `${projectId}, userId ${currentUserId}, email ${req.authUser.email}`);
-            err.status = 404;
-            return next(err);
-          }
-          return res.json(util.wrapResponse(req.id, invite));
-        });
+  async (req, res, next) => {
+    try {
+      const projectId = _.parseInt(req.params.projectId);
+      const currentUserId = req.authUser.userId;
+      const invite = await models.ProjectMemberInvite.getPendingInviteByEmailOrUserId(
+        projectId, req.authUser.email, currentUserId,
+      );
+      if (!invite) {
+        // check there is an existing invite for the user with status PENDING
+        // handle 404
+        const err = new Error(
+          'invite not found for project id ' +
+          `${projectId}, userId ${currentUserId}, email ${req.authUser.email}`,
+        );
+        err.status = 404;
+        throw err;
+      }
+
+      let fields = null;
+      if (req.query.fields) {
+        fields = req.query.fields.split(',');
+      }
+      let inviteWithDetails;
+      try {
+        [inviteWithDetails] = await util.getObjectsWithMemberDetails([invite], fields, req);
+      } catch (err) {
+        inviteWithDetails = invite;
+        req.log.error('Cannot get user details for invite.');
+        req.log.debug('Error during getting user details for invite.', err);
+      }
+
+      return res.json(util.wrapResponse(req.id, inviteWithDetails));
+    } catch (err) {
+      return next(err);
+    }
   },
 ];

src/routes/projectMemberInvites/list.js

@@ -0,0 +1,44 @@
+import _ from 'lodash';
+import Joi from 'joi';
+import validate from 'express-validation';
+import { middleware as tcMiddleware } from 'tc-core-library-js';
+import models from '../../models';
+import util from '../../util';
+
+/**
+ * API to list all project member invites.
+ *
+ */
+const permissions = tcMiddleware.permissions;
+
+const schema = {
+  query: {
+    fields: Joi.string().optional(),
+  },
+};
+
+module.exports = [
+  validate(schema),
+  permissions('projectMemberInvite.list'),
+  async (req, res, next) => {
+    try {
+      let fields = null;
+      if (req.query.fields) {
+        fields = req.query.fields.split(',');
+      }
+      const projectId = _.parseInt(req.params.projectId);
+      const invites = await models.ProjectMemberInvite.getPendingAndReguestedInvitesForProject(projectId);
+      let invitesWithDetails;
+      try {
+        invitesWithDetails = await util.getObjectsWithMemberDetails(invites, fields, req);
+      } catch (err) {
+        invitesWithDetails = invites;
+        req.log.error('Cannot get user details for invites.');
+        req.log.debug('Error during getting user details for invites', err);
+      }
+      return res.json(util.wrapResponse(req.id, util.maskInviteEmails('$[*].email', invitesWithDetails, req)));
+    } catch (err) {
+      return next(err);
+    }
+  },
+];