fix: Kafka events when updating milestones

- don't raise status change event on every milestone update
- removed/commented redundant code for raising events during cascading updates

Author: Maksym Mykhailenko

src/events/busApi.js

@@ -1,5 +1,4 @@
 import _ from 'lodash';
-import moment from 'moment';
 import config from 'config';
 import {
   EVENT,
@@ -715,7 +714,6 @@ module.exports = (app, logger) => {
     req,
     resource,
     originalResource,
-    cascadedUpdates,
     skipNotification,
   }) => { // eslint-disable-line no-unused-vars
     logger.debug(`receive MILESTONE_UPDATED event for milestone ${resource.id}`);
@@ -742,15 +740,9 @@ module.exports = (app, logger) => {
               timeline.progress = progress;
               sendMilestoneNotification(req, original, updated, project, timeline);
 
-              logger.debug('cascadedUpdates', cascadedUpdates);
-              if (cascadedUpdates && cascadedUpdates.milestones && cascadedUpdates.milestones.length > 0) {
-                _.each(cascadedUpdates.milestones, cascadedUpdate =>
-                  sendMilestoneNotification(req, cascadedUpdate.original, cascadedUpdate.updated, project, timeline),
-                );
-              }
-
+              // TODO raise this event again
               // if timeline is modified
-              if (cascadedUpdates && cascadedUpdates.timeline) {
+              /* if (cascadedUpdates && cascadedUpdates.timeline) {
                 const cTimeline = cascadedUpdates.timeline;
                 // if endDate of the timeline is modified, raise TIMELINE_ADJUSTED event
                 if (!moment(cTimeline.original.endDate).isSame(cTimeline.updated.endDate)) {
@@ -766,7 +758,7 @@ module.exports = (app, logger) => {
                     initiatorUserId: req.authUser.userId,
                   }, logger);
                 }
-              }
+              } */
             });
         }).catch(err => null); // eslint-disable-line no-unused-vars
     }

src/routes/milestones/bulkUpdate.js

@@ -99,11 +99,20 @@ module.exports = [
       [
         [created, EVENT.ROUTING_KEY.MILESTONE_ADDED],
         [deleted, EVENT.ROUTING_KEY.MILESTONE_REMOVED],
-        [updated, EVENT.ROUTING_KEY.MILESTONE_UPDATED],
       ].forEach(([results, routingKey]) =>
         results.forEach(result => util.sendResourceToKafkaBus(req, routingKey, RESOURCES.MILESTONE, result)),
       );
 
+      updated.forEach(({ updated: updatedMilestone, original: originalMilestone }) => {
+        util.sendResourceToKafkaBus(
+          req,
+          EVENT.ROUTING_KEY.MILESTONE_UPDATED,
+          RESOURCES.MILESTONE,
+          updatedMilestone,
+          originalMilestone,
+        );
+      });
+
       // return all the timeline milestones after all updates
       const milestones = await req.timeline.getMilestones()
         .map(milestone => _.omit(milestone.toJSON(), ['deletedAt', 'deletedBy']));

src/routes/milestones/commonHelper.js

@@ -65,7 +65,7 @@ async function deleteMilestone(authUser, timelineId, id, transaction, item) {
  * @param {Object} data The updated data
  * @param {Object} transaction The transaction to use
  * @param {Object} [item] The item to update
- * @returns {Object} The updated milestone
+ * @returns {{updated: Object, original: Object}} The updated and original milestones
  * @throws {Error} If something went wrong
  */
 async function updateMilestone(authUser, timelineId, data, transaction, item) {
@@ -87,6 +87,9 @@ async function updateMilestone(authUser, timelineId, data, transaction, item) {
     apiErr.status = 404;
     throw apiErr;
   }
+
+  const original = milestone.toJSON();
+
   if (entityToUpdate.status === MILESTONE_STATUS.PAUSED && !validStatuses.includes(milestone.status)) {
     const validStatutesStr = validStatuses.join(', ');
     const apiErr = new Error(`Milestone can only be paused from the next statuses: ${validStatutesStr}`);
@@ -196,7 +199,10 @@ async function updateMilestone(authUser, timelineId, data, transaction, item) {
   */
 
   const result = await milestone.update(entityToUpdate, { comment: entityToUpdate.statusComment, transaction });
-  return _.omit(result.toJSON(), ['deletedBy', 'deletedAt']);
+  return {
+    original: _.omit(original, ['deletedBy', 'deletedAt']),
+    updated: _.omit(result.toJSON(), ['deletedBy', 'deletedAt']),
+  };
 }
 
 

src/routes/milestones/update.js

@@ -59,13 +59,15 @@ module.exports = [
         req.params.timelineId,
         Object.assign({}, req.body, { id: req.params.milestoneId }),
         t))
-      .then((result) => {
+      .then(({ updated, original }) => {
         util.sendResourceToKafkaBus(
           req,
           EVENT.ROUTING_KEY.MILESTONE_UPDATED,
           RESOURCES.MILESTONE,
-          result);
-        res.json(result);
+          updated,
+          original,
+        );
+        res.json(updated);
       })
       .catch(next),
 ];

src/routes/milestones/update.spec.js

@@ -1209,7 +1209,7 @@ describe('UPDATE Milestone', () => {
               done(err);
             } else {
               testUtil.wait(() => {
-                createEventSpy.callCount.should.be.eql(4);
+                createEventSpy.callCount.should.be.eql(3);
 
                 createEventSpy.calledWith(BUS_API_EVENT.MILESTONE_UPDATED, sinon.match({
                   resource: RESOURCES.MILESTONE,
@@ -1302,7 +1302,7 @@ describe('UPDATE Milestone', () => {
               done(err);
             } else {
               testUtil.wait(() => {
-                createEventSpy.callCount.should.be.eql(3);
+                createEventSpy.callCount.should.be.eql(2);
 
                 createEventSpy.calledWith(BUS_API_EVENT.MILESTONE_UPDATED, sinon.match({
                   resource: RESOURCES.MILESTONE,
@@ -1329,7 +1329,7 @@ describe('UPDATE Milestone', () => {
               done(err);
             } else {
               testUtil.wait(() => {
-                createEventSpy.callCount.should.be.eql(3);
+                createEventSpy.callCount.should.be.eql(2);
 
                 createEventSpy.calledWith(BUS_API_EVENT.MILESTONE_UPDATED, sinon.match({
                   resource: RESOURCES.MILESTONE,