support transaction for creating timeline so filing creating milestones or statusHistory reverts timeline too

small code improvements

Author: maxceem

src/constants.js

@@ -165,6 +165,10 @@ export const TIMELINE_REFERENCES = {
   PRODUCT: 'product',
 };
 
+export const STATUS_HISTORY_REFERENCES = {
+  MILESTONE: 'milestone',
+};
+
 export const MILESTONE_TEMPLATE_REFERENCES = {
   PRODUCT_TEMPLATE: 'productTemplate',
 };

src/models/milestone.js

@@ -1,47 +1,43 @@
 import _ from 'lodash';
 import moment from 'moment';
 import models from '../models';
+import { STATUS_HISTORY_REFERENCES } from '../constants';
 /* eslint-disable valid-jsdoc */
 
 /**
  * Populate and map milestone model with statusHistory
  * NOTE that this function mutates milestone
- * @param {Object} milestone the milestone
+ *
+ * @param {Array|Object} milestone one milestone or list of milestones
+ *
  * @returns {Promise} promise
  */
-const mapWithStatusHistory = async (milestone) => {
+const populateWithStatusHistory = async (milestone) => {
   if (Array.isArray(milestone)) {
-    try {
-      const allStatusHistory = await models.StatusHistory.findAll({
-        where: {
-          referenceId: { $in: milestone.map(m => m.dataValues.id) },
-          reference: 'milestone',
-        },
-        order: [['createdAt', 'desc']],
-        raw: true,
-      });
-      return milestone.map((m, index) => {
-        const statusHistory = allStatusHistory.filter(s => s.referenceId === m.dataValues.id);
-        return _.merge(milestone[index], { dataValues: { statusHistory } });
-      });
-    } catch (err) {
-      return milestone.map((m, index) => _.merge(milestone[index], { dataValues: { statusHistory: [] } }));
-    }
-  } else {
-    try {
-      const statusHistory = await models.StatusHistory.findAll({
-        where: {
-          referenceId: milestone.dataValues.id,
-          reference: 'milestone',
-        },
-        order: [['createdAt', 'desc']],
-        raw: true,
-      });
-      return _.merge(milestone, { dataValues: { statusHistory } });
-    } catch (err) {
-      return _.merge(milestone, { dataValues: { statusHistory: [] } });
-    }
+    const allStatusHistory = await models.StatusHistory.findAll({
+      where: {
+        referenceId: { $in: milestone.map(m => m.dataValues.id) },
+        reference: 'milestone',
+      },
+      order: [['createdAt', 'desc']],
+      raw: true,
+    });
+
+    return milestone.map((m, index) => {
+      const statusHistory = allStatusHistory.filter(s => s.referenceId === m.dataValues.id);
+      return _.merge(milestone[index], { dataValues: { statusHistory } });
+    });
   }
+
+  const statusHistory = await models.StatusHistory.findAll({
+    where: {
+      referenceId: milestone.dataValues.id,
+      reference: 'milestone',
+    },
+    order: [['createdAt', 'desc']],
+    raw: true,
+  });
+  return _.merge(milestone, { dataValues: { statusHistory } });
 };
 
 /**
@@ -127,19 +123,19 @@ module.exports = (sequelize, DataTypes) => {
     },
     hooks: {
       afterCreate: (milestone, options) => models.StatusHistory.create({
-        reference: 'milestone',
+        reference: STATUS_HISTORY_REFERENCES.MILESTONE,
         referenceId: milestone.id,
         status: milestone.status,
         comment: null,
         createdBy: milestone.createdBy,
         updatedBy: milestone.updatedBy,
       }, {
         transaction: options.transaction,
-      }).then(() => mapWithStatusHistory(milestone)),
+      }).then(() => populateWithStatusHistory(milestone)),
 
       afterBulkCreate: (milestones, options) => {
         const listStatusHistory = milestones.map(({ dataValues }) => ({
-          reference: 'milestone',
+          reference: STATUS_HISTORY_REFERENCES.MILESTONE,
           referenceId: dataValues.id,
           status: dataValues.status,
           comment: null,
@@ -149,28 +145,28 @@ module.exports = (sequelize, DataTypes) => {
 
         return models.StatusHistory.bulkCreate(listStatusHistory, {
           transaction: options.transaction,
-        }).then(() => mapWithStatusHistory(milestones));
+        }).then(() => populateWithStatusHistory(milestones));
       },
 
       afterUpdate: (milestone, options) => {
         if (milestone.changed().includes('status')) {
           return models.StatusHistory.create({
-            reference: 'milestone',
+            reference: STATUS_HISTORY_REFERENCES.MILESTONE,
             referenceId: milestone.id,
             status: milestone.status,
             comment: options.comment || null,
             createdBy: milestone.createdBy,
             updatedBy: milestone.updatedBy,
           }, {
             transaction: options.transaction,
-          }).then(() => mapWithStatusHistory(milestone));
+          }).then(() => populateWithStatusHistory(milestone));
         }
-        return mapWithStatusHistory(milestone);
+        return populateWithStatusHistory(milestone);
       },
 
       afterFind: (milestone) => {
         if (!milestone) return Promise.resolve();
-        return mapWithStatusHistory(milestone);
+        return populateWithStatusHistory(milestone);
       },
     },
   });

src/routes/timelines/create.js

@@ -51,9 +51,9 @@ module.exports = [
 
     let result;
     // Save to DB
-    models.sequelize.transaction(() => {
+    models.sequelize.transaction((tx) => {
       req.log.debug('Started transaction');
-      return models.Timeline.create(entity)
+      return models.Timeline.create(entity, { transaction: tx })
         .then((createdEntity) => {
           // Omit deletedAt, deletedBy
           result = _.omit(createdEntity.toJSON(), 'deletedAt', 'deletedBy');
@@ -97,7 +97,7 @@ module.exports = [
                   }
                   return milestone;
                 });
-                return models.Milestone.bulkCreate(milestones, { returning: true })
+                return models.Milestone.bulkCreate(milestones, { returning: true, transaction: tx })
                 .then((createdMilestones) => {
                   req.log.debug('Milestones created for timeline with template id %d', templateId);
                   result.milestones = _.map(createdMilestones, cm => _.omit(cm.toJSON(), 'deletedAt', 'deletedBy'));