TOPCODER CONNECT PROJECTS API ENHANCEMENTS WINNING SUBMISSION (#45)

* update readme, update node js version

* fix #34

* fix #37, keep project history

* move project history update to core API's from event handlers

* fix #43

* add unit tests

* update direct mock service

* update swagger.yaml

* add sync script

* update postman

* update readme

* update tests

* filter members by copilot role, when promoting copilot

Author: Ritesh Sangwan

README.md

@@ -4,7 +4,7 @@ Microservice to manage CRUD operations for all things Projects.
 
 ### Local Development
 * We use docker-compose for running dependencies locally. Instructions for Docker compose setup - https://docs.docker.com/compose/install/
-* Nodejs 5.10.1 - consider using [nvm](https://github.com/creationix/nvm) or equivalent to manage your node version
+* Nodejs 6.9.4 - consider using [nvm](https://github.com/creationix/nvm) or equivalent to manage your node version
 * Install [libpg](https://www.npmjs.com/package/pg-native)
 * Install node dependencies
 `npm install | ./node_modules/.bin/bunyan`
@@ -25,6 +25,8 @@ npm run -s build
 > NODE_ENV=development node -e "require('./dist/models').default.sequelize.sync({force: true}).then((res)=> console.log('Success: ', res)).catch((err)=> console.log('Failed: ', err));"
 ```
 
+Other simple approach to create tables is to run `npm run sync` from root of project. This additional script is added to make the above task simpler.
+
 #### Redis
 Docker compose command will start a local redis instance as well. You should be able to connect to this instance using url `$(docker-machine ip):6379`
 
@@ -51,5 +53,8 @@ You may replace 172.17.0.1 with your docker0 IP.
 
 You can paste **swagger.yaml** to  [swagger editor](http://editor.swagger.io/) or import **postman.json** to verify endpoints.
 
+#### Deploying without docker
+If you don't want to use docker to deploy to localhost. You can simply run `npm run start` from root of project. This should start the server on default port `3000`.
+
 ### Deployment
 Using awsebcli - http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3-install.html

package.json

@@ -15,6 +15,7 @@
     "prestart": "npm run -s build",
     "seed": "babel-node src/tests/seed.js --presets es2015",
     "direct": "babel-node src/mocks/direct.js --presets es2015",
+    "sync": "node sync.js",
     "lint": "./node_modules/.bin/eslint src"
   },
   "repository": {

postman.json

@@ -44,7 +44,54 @@ const projectMemberAddedHandler = (logger, msg, channel) => {
             })
         } else {
           logger.info('project not associated with a direct project, skipping')
-          ack(msg)
+          channel.ack(msg)
+        }
+      })
+      .catch(err => {
+        // if the message has been redelivered dont attempt to reprocess it
+        logger.error('Error retrieving project', err, msg)
+        channel.nack(msg, false, !msg.fields.redelivered)
+      })
+  } else if (newMember.role === PROJECT_MEMBER_ROLE.MANAGER) {
+    // if manager is added we have to add the manager to direct project
+    return models.Project.getDirectProjectId(newMember.projectId)
+      .then(directProjectId => {
+        if (directProjectId) {
+          // retrieve system user token
+          return util.getSystemUserToken(logger)
+            .then(token => {
+              const req = {
+                id: origRequestId,
+                log: logger,
+                headers: {
+                  authorization: `Bearer ${token}`
+                }
+              }
+              return directProject.editProjectPermissions(req, directProjectId, {
+                  permissions: [
+                    {
+                      userId: newMember.userId,
+                      permissionType: {
+                        permissionTypeId: 3,
+                        name: 'project_full'
+                      },
+                      studio: false
+                    }
+                  ]
+                })
+                .then(resp => {
+                  logger.debug('added manager to direct')
+                    // acknowledge
+                  channel.ack(msg)
+                })
+            })
+            .catch(err => {
+              logger.error('Error caught while adding manager from direct', err)
+              channel.nack(msg, false, false)
+            })
+        } else {
+          logger.info('project not associated with a direct project, skipping')
+          channel.ack(msg)
         }
       })
       .catch(err => {
@@ -63,7 +110,7 @@ const projectMemberRemovedHandler = (logger, msg, channel) => {
   const member = JSON.parse(msg.content.toString())
 
   if (member.role === PROJECT_MEMBER_ROLE.COPILOT) {
-    // Add co-pilot when a co-pilot is added to a project
+    // Delete co-pilot when a co-pilot is deleted from a project
     return models.Project.getDirectProjectId(member.projectId)
       .then(directProjectId => {
         if (directProjectId) {
@@ -100,6 +147,54 @@ const projectMemberRemovedHandler = (logger, msg, channel) => {
         logger.error('Error retrieving project', err, msg)
         channel.nack(msg, false, !msg.fields.redelivered)
       })
+  } else if (member.role === PROJECT_MEMBER_ROLE.MANAGER) {
+    // when a manager is removed from direct project we have to remove manager from direct
+    return models.Project.getDirectProjectId(member.projectId)
+      .then(directProjectId => {
+        if (directProjectId) {
+          // retrieve system user token
+          return util.getSystemUserToken(logger)
+            .then(token => {
+              const req = {
+                id: origRequestId,
+                log: logger,
+                headers: {
+                  authorization: `Bearer ${token}`
+                }
+              }
+              return directProject.editProjectPermissions(req, directProjectId, {
+                  permissions: [
+                    {
+                      userId: member.userId,
+                      resourceId: directProjectId,
+                      permissionType: {
+                        permissionTypeId: '',
+                        name: 'project_full'
+                      },
+                      studio: false
+                    }
+                  ]
+                })
+                .then(resp => {
+                  logger.debug('removed manager from direct')
+                    // acknowledge
+                  channel.ack(msg)
+                })
+            })
+            .catch(err => {
+              logger.error('Error caught while adding manager from direct', err)
+              channel.nack(msg, false, false)
+            })
+        } else {
+          logger.info('project not associated with a direct project, skipping')
+          channel.ack(msg)
+        }
+      })
+      .catch(err => {
+        // if the message has been redelivered dont attempt to reprocess it
+        logger.error('Error retrieving project', err, msg)
+        channel.nack(msg, false, !msg.fields.redelivered)
+      })
   } else {
     // nothing to do
     channel.ack(msg)

src/events/projectMembers/index.js

@@ -96,6 +96,17 @@ router.route('/v3/direct/projects/:projectId(\\d+)/copilot')
         }
     })
 
+router.route('/v3/direct/projects/:projectId(\\d+)/permissions')
+    .post((req, res)=>{
+        const projectId = req.params.projectId
+        app.logger.info({body: req.body, projectId: projectId }, 'add permissions to Project')
+        if(projects[projectId]) {
+            res.json()
+        } else {
+            res.json(util.wrapErrorResponse(req.id, 404, `Cannot find direct project ${projectId}`))
+        }
+    })
+
 app.use(router)
 
 // =======================

src/mocks/direct.js

@@ -35,6 +35,7 @@ module.exports = function(sequelize, DataTypes) {
     },
     details: { type: DataTypes.JSON },
     challengeEligibility: DataTypes.JSON,
+    cancelReason: DataTypes.STRING,
     deletedAt: { type: DataTypes.DATE, allowNull: true },
     createdAt: { type: DataTypes.DATE, defaultValue: DataTypes.NOW },
     updatedAt: { type: DataTypes.DATE, defaultValue: DataTypes.NOW },

src/models/project.js

@@ -0,0 +1,22 @@
+'use strict'
+
+module.exports = function(sequelize, DataTypes) {
+  var ProjectHistory = sequelize.define('ProjectHistory', {
+    id: { type: DataTypes.BIGINT, primaryKey: true, autoIncrement: true },
+    projectId: { type: DataTypes.BIGINT, allowNull: false },
+    status: { type: DataTypes.STRING, allowNull: false },
+    cancelReason: { type: DataTypes.STRING, allowNull: true },
+    createdAt: { type: DataTypes.DATE, defaultValue: DataTypes.NOW },
+    updatedAt: { type: DataTypes.DATE, defaultValue: DataTypes.NOW },
+    updatedBy: { type: DataTypes.INTEGER, allowNull: false }
+  }, {
+    tableName: 'project_history',
+    paranoid: false,
+    timestamps: true,
+    updatedAt: 'updatedAt',
+    createdAt: 'createdAt',
+    indexes: []
+  })
+
+  return ProjectHistory
+}

src/models/projectHistory.js

@@ -25,7 +25,7 @@ const addAttachmentValidations = {
       filePath: Joi.string().required(),
       s3Bucket: Joi.string().required(),
       contentType: Joi.string().required()
-    })
+    }).required()
   }
 }
 

src/routes/attachments/create.js

@@ -21,7 +21,7 @@ const addMemberValidations = {
       userId: Joi.number().required(),
       isPrimary: Joi.boolean(),
       role: Joi.any().valid(PROJECT_MEMBER_ROLE.CUSTOMER, PROJECT_MEMBER_ROLE.MANAGER, PROJECT_MEMBER_ROLE.COPILOT).required()
-    })
+    }).required()
   }
 }
 

src/routes/projectMembers/create.js

@@ -4,7 +4,7 @@ import _ from 'lodash'
 
 import models from '../../models'
 import { middleware as tcMiddleware } from 'tc-core-library-js'
-import { EVENT } from '../../constants'
+import { EVENT, PROJECT_MEMBER_ROLE } from '../../constants'
 
 /**
  * API to delete a project member.
@@ -23,29 +23,65 @@ module.exports = [
       return models.ProjectMember.findOne({
         where: {id: memberRecordId, projectId: projectId}
       })
-          .then((member) => {
-            if (!member) {
-              let err = new Error('Record not found')
-              err.status = 404
-              return Promise.reject(err)
-            }
-            return member.destroy({logging: console.log})
-          })
-          .then(member => {
-            return member.save()
-          })
-          .then(member => {
-            // fire event
-            member = member.get({plain:true})
-            req.app.services.pubsub.publish(
-              EVENT.ROUTING_KEY.PROJECT_MEMBER_REMOVED,
-              member,
-              { correlationId: req.id }
-            )
-            req.app.emit(EVENT.ROUTING_KEY.PROJECT_MEMBER_REMOVED, { req, member })
-            res.status(204).json({})
-          })
-          .catch(err => next(err))
-    })
+      .then((member) => {
+        if (!member) {
+          let err = new Error('Record not found')
+          err.status = 404
+          return Promise.reject(err)
+        }
+        return member.destroy({logging: console.log})
+      })
+      .then(member => {
+        return member.save()
+      })
+      // if primary co-pilot is removed promote the next co-pilot to primary #43
+      .then((member) => {
+        return new Promise((accept, reject) => {
+          if (member.role === PROJECT_MEMBER_ROLE.COPILOT && member.isPrimary) {
+            // find the next copilot
+            models.ProjectMember.findAll({
+              limit: 1,
+              // return only non-deleted records
+              paranoid: true,
+              where: {
+                projectId: projectId,
+                role: PROJECT_MEMBER_ROLE.COPILOT
+              },
+              order: [['createdAt', 'ASC']]
+            }).then((members) => {
+              if (members && members.length > 0) {
+                // mark the copilot as primary
+                const nextMember = members[0]
+                nextMember.set({ isPrimary: true })
+                nextMember.save().then(() => {
+                  accept(member)
+                }).catch((err) => {
+                  reject(err)
+                })
+              } else {
+                // no copilot found nothing to do
+                accept(member)
+              }
+            }).catch((err) => {
+              reject(err)
+            })
+          } else {
+            // nothing to do
+            accept(member)
+          }
+        })
+      })
+    }).then((member) => {
+      // only return the response after transaction is committed
+      // fire event
+      member = member.get({plain:true})
+      req.app.services.pubsub.publish(
+        EVENT.ROUTING_KEY.PROJECT_MEMBER_REMOVED,
+        member,
+        { correlationId: req.id }
+      )
+      req.app.emit(EVENT.ROUTING_KEY.PROJECT_MEMBER_REMOVED, { req, member })
+      res.status(204).json({})
+    }).catch((err) => next(err))
   }
 ]