feat: project members endpoint with additional fields

Added endpoint for getting project members with ability to get additional data form member service and pre-populate the member list.

ref: Winner submission from challenge 30107353 - "Topcoder Project Service - Project Members Traits"

Author: maxceem

src/permissions/index.js

@@ -22,6 +22,7 @@ module.exports = () => {
   Authorizer.setPolicy('project.edit', projectEdit);
   Authorizer.setPolicy('project.delete', projectDelete);
   Authorizer.setPolicy('project.addMember', projectView);
+  Authorizer.setPolicy('project.getMember', projectView);
   Authorizer.setPolicy('project.removeMember', projectMemberDelete);
   Authorizer.setPolicy('project.addAttachment', projectEdit);
   Authorizer.setPolicy('project.updateAttachment', projectAttachmentUpdate);

src/routes/index.js

@@ -119,6 +119,7 @@ router.route('/v4/projects/:projectId(\\d+)/scopeChangeRequests/:requestId(\\d+)
   // .delete(require('./scopeChangeRequests/delete'));
 
 router.route('/v4/projects/:projectId(\\d+)/members')
+  .get(require('./projectMembers/get'))
   .post(require('./projectMembers/create'));
 
 router.route('/v4/projects/:projectId(\\d+)/members/:id(\\d+)')

src/routes/projectMembers/get.js

@@ -0,0 +1,116 @@
+/* eslint-disable max-len */
+import _ from 'lodash';
+import { middleware as tcMiddleware } from 'tc-core-library-js';
+import util from '../../util';
+
+/**
+ * API to add a project member.
+ * add members directly (only managers and copilots)
+ * user being added is current user
+ */
+const permissions = tcMiddleware.permissions;
+
+
+module.exports = [
+  // handles request validations
+  // validate(createProjectMemberValidations),
+  permissions('project.getMember'),
+  async (req, res) => {
+    let members = req.context.currentProjectMembers;
+
+
+    if (members.length && _.get(req, 'query.fields')) {
+      const fields = req.query.fields.split(',');
+
+      const ModelFields = ['id', 'userId', 'role', 'isPrimary', 'deletedAt', 'createdAt', 'updatedAt', 'deletedBy', 'createdBy', 'updatedBy'];
+
+      const modelFields = _.intersection(ModelFields, fields);
+      const hasUserIdField = _.indexOf(fields, 'userId') !== -1;
+      if (hasUserIdField === false) {
+        modelFields.push('userId');
+      }
+      // merge model fields
+      members = _.map(members, m => _.pick(m, modelFields));
+
+      const MemberDetailFields = ['handle', 'firstName', 'lastName'];
+      const memberDetailFields = _.intersection(MemberDetailFields, fields);
+
+      // has handleField
+      const hasHandleField = _.indexOf(memberDetailFields, 'handle') !== -1;
+
+      if (hasHandleField === false) {
+        memberDetailFields.push('handle');
+      }
+
+      if (memberDetailFields.length) {
+        const userIds = _.map(members, m => `userId:${m.userId}`) || [];
+
+        const logger = req.log;
+        try {
+          const memberDetails = await util.getMemberDetailsByUserIds(userIds, logger, req.id);
+
+          // merge detail fields
+          _.forEach(members, (m) => {
+            const detail = _.find(memberDetails, mt => mt.userId === m.userId);
+            if (detail) {
+              _.assign(m, _.pick(detail, memberDetailFields));
+            }
+          });
+
+
+          const TraitFields = ['photoURL', 'workingHoursStart', 'workingHoursEnd', 'timeZone'];
+          const traitFields = _.intersection(TraitFields, fields);
+          if (traitFields.length) {
+            const promises = [];
+            _.forEach(members, (m) => {
+              if (m.handle) {
+                promises.push(util.getMemberTratisByHandle(m.handle, req.log, req.id));
+              }
+            });
+
+            const traits = await Promise.all(promises);
+
+            // remove photoURL, because connect_info also has photoURL
+            const ConnectInfoFields = ['workingHoursStart', 'workingHoursEnd', 'timeZone'];
+            const connectInfoFields = _.intersection(ConnectInfoFields, fields);
+
+            // merge traits
+            _.forEach(members, (m) => {
+              const traitsArr = _.find(traits, t => t[0].userId === m.userId);
+              if (traitsArr) {
+                if (traitFields[0] === 'photoURL') {
+                  _.assign(m, { photoURL: _.get(_.find(traitsArr, t => t.traitId === 'basic_info'), 'traits.data[0].photoURL') });
+                  if (traitFields.length > 1) {
+                    const traitInfo = _.get(_.find(traitsArr, t => t.traitId === 'connect_info'), 'traits.data[0]', {});
+                    _.assign(m, _.pick(traitInfo, connectInfoFields));
+                  }
+                } else {
+                  const traitInfo = _.get(_.find(traitsArr, t => t.traitId === 'connect_info'), 'traits.data[0]', {});
+                  _.assign(m, _.pick(traitInfo, connectInfoFields));
+                }
+              }
+            });
+          }
+        } catch (e) {
+          if (hasUserIdField === false) {
+            members = _.map(members, m => _.omit(m, ['userId']));
+          }
+          if (hasHandleField === false) {
+            members = _.map(members, m => _.omit(m, ['handle']));
+          }
+          return res.json(util.wrapResponse(req.id, members));
+        }
+      }
+
+      if (hasUserIdField === false) {
+        members = _.map(members, m => _.omit(m, ['userId']));
+      }
+      if (hasHandleField === false) {
+        members = _.map(members, m => _.omit(m, ['handle']));
+      }
+      return res.json(util.wrapResponse(req.id, members));
+    }
+
+    return res.json(util.wrapResponse(req.id, req.context.currentProjectMembers));
+  },
+];

src/util.js

@@ -392,6 +392,32 @@ _.assignIn(util, {
     return esClient;
   },
 
+  /**
+   * Retrieve member traitbyhandle
+   * @param  {string}     handle
+   * @param  {Object}     logger           req.logger
+   * @return {string}     requestId
+   */
+  getMemberTratisByHandle: Promise.coroutine(function* (handle, logger, requestId) { // eslint-disable-line func-names
+    try {
+      const token = yield this.getM2MToken();
+      const httpClient = this.getHttpClient({ id: requestId, log: logger });
+      if (logger) {
+        logger.trace(handle);
+      }
+
+      return httpClient.get(`${config.memberServiceEndpoint}/${handle}/traits`, {
+        params: {},
+        headers: {
+          'Content-Type': 'application/json',
+          Authorization: `Bearer ${token}`,
+        },
+      }).then(res => _.get(res, 'data.result.content', null));
+    } catch (err) {
+      return Promise.reject(err);
+    }
+  }),
+
   /**
    * Retrieve member details from userIds
    */