Merge branch 'release/v1.3.0'

Author: Parth Shah

config/custom-environment-variables.json

@@ -28,5 +28,6 @@
     "masterUrl": "DB_MASTER_URL",
     "maxPoolSize": "DB_MAX_POOL_SIZE",
     "minPoolSize": "DB_MIN_POOL_SIZE"
-  }
+  },
+  "analyticsKey": "ANALYTICS_KEY"
 }

config/default.json

@@ -33,5 +33,6 @@
     "maxPoolSize": 50,
     "minPoolSize": 4,
     "idleTimeout": 1000
-  }
+  },
+  "analyticsKey": ""
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tc-projects-service",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Projects microservice",
   "main": "index.js",
   "engines": {
@@ -48,6 +48,7 @@
   },
   "dependencies": {
     "amqplib": "^0.5.1",
+    "analytics-node": "^2.1.1",
     "app-module-path": "^1.0.7",
     "bluebird": "^3.4.1",
     "body-parser": "^1.15.0",

src/app.js

@@ -60,6 +60,12 @@ app.logger = logger
 // =======================
 logger.info('Registering models ... ', !!models)
 
+// =======================
+// Analytics
+// =======================
+const analyticsKey = config.get('analyticsKey')
+if (!_.isEmpty(analyticsKey))
+  require('./events/analytics')(analyticsKey, app, logger)
 
 // ========================
 // Permissions
@@ -79,4 +85,6 @@ app.routerRef = router
 // =======================
 require('./services')(app, logger)
 
+
+
 module.exports = app

src/constants.js

@@ -1,5 +1,4 @@
 
-import _ from 'lodash'
 export const PROJECT_TYPE = {
   APP_DEV          : 'app_dev',
   GENERIC          : 'generic',
@@ -37,10 +36,7 @@ export const EVENT = {
     PROJECT_MEMBER_UPDATED: 'project.member.updated',
 
     PROJECT_DRAFT_CREATED: 'project.draft-created',
-    PROJECT_LAUNCHED: 'project.launched',
     PROJECT_UPDATED: 'project.updated',
-    PROJECT_CANCELLED: 'project.cancelled',
-    PROJECT_COMPLETED: 'project.completed',
     PROJECT_DELETED: 'project.deleted'
   }
 }

src/events/analytics.js

@@ -0,0 +1,101 @@
+import Analytics from 'analytics-node'
+import {
+  EVENT,
+  PROJECT_STATUS
+} from '../constants'
+import 'config'
+import _ from 'lodash'
+
+const PROJECT_CREATED = 'Project Created'
+const PROJECT_SUBMITTED = 'Project Submitted'
+const PROJECT_REVIEWED = 'Project Reviewed'
+const PROJECT_ACTIVATED = 'Project Acvtivated'
+const PROJECT_COMPLETED = 'Project Completed'
+const PROJECT_CANCELED = 'Project Canceled'
+const PROJECT_DELETED = 'Project Deleted'
+const PROJECT_PAUSED = 'Project Paused'
+const PROJECT_SPEC_UPDATED = 'Project Spec Updated'
+const PROJECT_MEMBER_ADDED = 'Project Member Added'
+const PROJECT_MEMBER_REMOVED = 'Project Member Removed'
+
+const mapEventTypes = {
+  [PROJECT_STATUS.DRAFT]: PROJECT_CREATED,
+  [PROJECT_STATUS.IN_REVIEW]: PROJECT_SUBMITTED,
+  [PROJECT_STATUS.REVIEWED]: PROJECT_REVIEWED,
+  [PROJECT_STATUS.ACTIVE]: PROJECT_ACTIVATED,
+  [PROJECT_STATUS.COMPLETED]: PROJECT_COMPLETED,
+  [PROJECT_STATUS.CANCELLED]: PROJECT_CANCELED,
+  [PROJECT_STATUS.PAUSED]: PROJECT_PAUSED
+}
+
+module.exports = (analyticsKey, app, logger) => {
+
+  // Initialize analytics
+  const analytics = analyticsKey ? new Analytics(analyticsKey) : null
+
+  /**
+   * Invokes analytics track and attaches additional props
+   * @param  {Object} req       Http request
+   * @param  {String} eventType analytics event
+   * @param  {Object} props    properties to track
+   */
+  const track = (req, eventType, props) => {
+    if (analytics) {
+      const userId = _.get(req, 'authUser.userId', 'system').toString()
+      // add referrer ?
+      const _props = _.assign({}, { referrer: req.get('Referer') }, props)
+      const data = {
+        userId,
+        event: eventType,
+        properties: _props
+      }
+      req.log.debug('Analytics tracking:', data)
+      analytics.track(data)
+    }
+
+  }
+
+  app.on(EVENT.ROUTING_KEY.PROJECT_DRAFT_CREATED, ({req, project}) => {
+    track(req, PROJECT_CREATED, {
+      id: project.id,
+      name: project.name,
+      type: project.type,
+      products: _.get(project, 'products', [])
+    })
+  })
+
+  app.on(EVENT.ROUTING_KEY.PROJECT_DELETED, ({req, id}) => {
+    track(req, PROJECT_CREATED, { id })
+  })
+
+  app.on(EVENT.ROUTING_KEY.PROJECT_UPDATED, ({req, original, updated }) => {
+    // determine what changed
+    let eventType
+    if (original.status !== updated.status) {
+      // status was changed
+      eventType = mapEventTypes[updated.status]
+    } else if (!_.isEqual(original.details, updated.details)) {
+      // specifications updated
+      eventType = PROJECT_SPEC_UPDATED
+    }
+    if (eventType) {
+      track(req, eventType, {
+        id: updated.id,
+        name: updated.name,
+        type: updated.type,
+        products: _.get(updated, 'products', [])
+      })
+    }
+
+  })
+
+
+  app.on(EVENT.ROUTING_KEY.PROJECT_MEMBER_ADDED, ({req, member}) => {
+    track(req, PROJECT_MEMBER_ADDED, { role: member.role })
+  })
+
+  app.on(EVENT.ROUTING_KEY.PROJECT_MEMBER_REMOVED, ({req, member}) => {
+    track(req, PROJECT_MEMBER_REMOVED, { role: member.role })
+  })
+
+}

src/routes/projectMembers/create.js

@@ -69,6 +69,7 @@ module.exports = [
           newMember,
           { correlationId: req.id }
         )
+        req.app.emit(EVENT.ROUTING_KEY.PROJECT_MEMBER_ADDED, { req, member: newMember })
         res.status(201).json(util.wrapResponse(req.id, newMember, 1, 201))
       })
       .catch((err) => {

src/routes/projectMembers/delete.js

@@ -36,11 +36,13 @@ module.exports = [
           })
           .then(member => {
             // fire event
+            member = member.get({plain:true})
             req.app.services.pubsub.publish(
               EVENT.ROUTING_KEY.PROJECT_MEMBER_REMOVED,
-              member.get({plain:true}),
+              member,
               { correlationId: req.id }
             )
+            req.app.emit(EVENT.ROUTING_KEY.PROJECT_MEMBER_REMOVED, { req, member })
             res.status(204).json({})
           })
           .catch(err => next(err))

src/routes/projects/create.js

@@ -61,7 +61,7 @@ module.exports = [
    * POST projects/
    * Create a project if the user has access
    */
-      (req, res, next) => {
+  (req, res, next) => {
     var project = req.body.param
     const userRole = util.hasRole(req, USER_ROLE.MANAGER)
         ? PROJECT_MEMBER_ROLE.MANAGER
@@ -122,6 +122,7 @@ module.exports = [
                 // log the error and continue
                 req.log.error('Error creating direct project')
                 req.log.error(err)
+                return Promise.resolve()
               })
           })
           .then(() => {
@@ -134,6 +135,8 @@ module.exports = [
               newProject,
               { correlationId: req.id }
             )
+            // emit event
+            req.app.emit(EVENT.ROUTING_KEY.PROJECT_DRAFT_CREATED, {req, project: newProject })
             res.status(201).json(util.wrapResponse(req.id, newProject, 1, 201))
           })
           .catch((err) => {

src/routes/projects/delete.js

@@ -37,6 +37,8 @@ module.exports = [
               { id: projectId },
               { correlationId: req.id }
             )
+            // emit event
+            req.app.emit(EVENT.ROUTING_KEY.PROJECT_DELETED, {req, id: projectId })
             res.status(204).json({})
           }
         })

src/routes/projects/update.js

@@ -165,10 +165,15 @@ module.exports = [
           previousValue =  _.omit(previousValue, ['deletedAt'])
           // publish original and updated project data
           req.app.services.pubsub.publish(
-            EVENT.ROUTING_KEY.PROJECT_UPDATED, 
+            EVENT.ROUTING_KEY.PROJECT_UPDATED,
             { original: previousValue, updated: project },
             { correlationId: req.id }
           )
+          req.app.emit(EVENT.ROUTING_KEY.PROJECT_UPDATED, {
+            req,
+            original: previousValue,
+            updated: project
+          })
           // check context for project members
           project.members = req.context.currentProjectMembers
           // get attachments