feat: disable indexing objects on milestone and phase create and update

Temporary disable indexing these objects as for now we keep the logic for this inside Project Service.
It's because creating or updating a phase or milestone may cause cascading updates of other phases or milestones.
In such cases in Project Service we are doing one ES index call instead of multiple calls.
Otherwise ES may fail with error `version conflict`.
This would be turned on back, as soon as we get rid of such cascading updates inside Project Service.

Author: maxceem

src/services/ProcessorServiceMilestone.js

@@ -66,7 +66,7 @@ function createSchema () {
  */
 async function create (message) {
   // handle ES Update
-  async function updateDocPromise (doc) {
+  async function updateDocPromise (doc) { // eslint-disable-line no-unused-vars
     const milestones = _.isArray(doc._source.milestones) ? doc._source.milestones : []
 
     const existingMilestoneIndex = _.findIndex(milestones, p => p.id === message.id)// if milestone does not exists already
@@ -88,8 +88,14 @@ async function create (message) {
     return _.assign(doc._source, { milestones })
   }
 
-  await helper.updateTimelineESPromise(message.timelineId, updateDocPromise)
-  logger.debug(`Milestone created successfully in elasticsearch index, (milestoneId: ${message.id})`)
+  // NOTE Disable indexing milestones when create at the moment, as it's now being indexed inside Project Service.
+  //      It's because adding a milestones may cause cascading updates of other milestones and in such cases we are doing
+  //      one ES index call instead of multiple calls. Otherwise ES may fail with error `version conflict`.
+  //      This would be turned on back, as soon as we get rid of such cascading updates inside Project Service.
+  //
+  // await helper.updateTimelineESPromise(message.timelineId, updateDocPromise)
+  // logger.debug(`Milestone created successfully in elasticsearch index, (milestoneId: ${message.id})`)
+  logger.debug(`TEMPORARY SKIPPED: Milestone created successfully in elasticsearch index, (milestoneId: ${message.id})`)
 }
 
 create.schema = {
@@ -103,7 +109,7 @@ create.schema = {
  */
 async function update (message) {
   // handle ES Update
-  async function updateDocPromise (doc) {
+  async function updateDocPromise (doc) { // eslint-disable-line no-unused-vars
     const milestones = _.map(doc._source.milestones, (single) => {
       if (single.id === message.id) {
         return _.assign(single, message)
@@ -113,8 +119,14 @@ async function update (message) {
     return _.assign(doc._source, { milestones })
   }
 
-  await helper.updateTimelineESPromise(message.timelineId, updateDocPromise)
-  logger.debug(`Milestone updated successfully in elasticsearch index, (milestoneId: ${message.id})`)
+  // NOTE Disable indexing milestones when update at the moment, as it's now being indexed inside Project Service.
+  //      It's because updating a milestones may cause cascading updates of other milestones and in such cases we are doing
+  //      one ES index call instead of multiple calls. Otherwise ES may fail with error `version conflict`.
+  //      This would be turned on back, as soon as we get rid of such cascading updates inside Project Service.
+  //
+  // await helper.updateTimelineESPromise(message.timelineId, updateDocPromise)
+  // logger.debug(`Milestone updated successfully in elasticsearch index, (milestoneId: ${message.id})`)
+  logger.debug(`TEMPORARY SKIPPED: Milestone updated successfully in elasticsearch index, (milestoneId: ${message.id})`)
 }
 
 update.schema = {

src/services/ProcessorServicePhase.js

@@ -45,7 +45,7 @@ function createSchema () {
  */
 async function create (message) {
   // handle ES Update
-  async function updateDocPromise (doc) {
+  async function updateDocPromise (doc) { // eslint-disable-line no-unused-vars
     const phases = _.isArray(doc._source.phases) ? doc._source.phases : []
     const existingPhaseIndex = _.findIndex(phases, p => p.id === message.id)// if phase does not exists already
     if (existingPhaseIndex === -1) {
@@ -66,8 +66,14 @@ async function create (message) {
     return _.assign(doc._source, { phases })
   }
 
-  await helper.updateProjectESPromise(message.projectId, updateDocPromise)
-  logger.debug(`Project phase created successfully in elasticsearch index, (projectPhaseId: ${message.id})`)
+  // NOTE Disable indexing phases when create at the moment, as it's now being indexed inside Project Service.
+  //      It's because adding a phase may cause cascading updates of other phases and in such cases we are doing
+  //      one ES index call instead of multiple calls. Otherwise ES may fail with error `version conflict`.
+  //      This would be turned on back, as soon as we get rid of such cascading updates inside Project Service.
+  //
+  // await helper.updateProjectESPromise(message.projectId, updateDocPromise)
+  // logger.debug(`Project phase created successfully in elasticsearch index, (projectPhaseId: ${message.id})`)
+  logger.debug(`TEMPORARY SKIPPED: Project phase created successfully in elasticsearch index, (projectPhaseId: ${message.id})`)
 }
 
 create.schema = {
@@ -81,7 +87,7 @@ create.schema = {
  */
 async function update (message) {
   // handle ES Update
-  async function updateDocPromise (doc) {
+  async function updateDocPromise (doc) { // eslint-disable-line no-unused-vars
     const phases = _.map(doc._source.phases, (single) => {
       if (single.id === message.id) {
         return _.assign(single, message)
@@ -91,8 +97,14 @@ async function update (message) {
     return _.assign(doc._source, { phases })
   }
 
-  await helper.updateProjectESPromise(message.projectId, updateDocPromise)
-  logger.debug(`Project phase updated successfully in elasticsearch index, (projectPhaseId: ${message.id})`)
+  // NOTE Disable indexing phases when update at the moment, as it's now being indexed inside Project Service.
+  //      It's because updating a phase may cause cascading updates of other phases and in such cases we are doing
+  //      one ES index call instead of multiple calls. Otherwise ES may fail with error `version conflict`.
+  //      This would be turned on back, as soon as we get rid of such cascading updates inside Project Service.
+  //
+  // await helper.updateProjectESPromise(message.projectId, updateDocPromise)
+  // logger.debug(`Project phase updated successfully in elasticsearch index, (projectPhaseId: ${message.id})`)
+  logger.debug(`TEMPORARY SKIPPED: Project phase updated successfully in elasticsearch index, (projectPhaseId: ${message.id})`)
 }
 
 update.schema = {

test/e2e/processor.project.index.test.js

@@ -683,7 +683,7 @@ describe('TC Attachment Topic Tests', () => {
   })
 })
 
-describe('TC Phase Topic Tests', () => {
+xdescribe('TC Phase Topic Tests', () => {
   before(async () => {
     // runs before all tests in this block
     await ProcessorService.create(projectCreatedMessage)
@@ -738,7 +738,7 @@ describe('TC Phase Topic Tests', () => {
   })
 })
 
-describe('TC Phase Product Topic Tests', () => {
+xdescribe('TC Phase Product Topic Tests', () => {
   before(async () => {
     // runs before all tests in this block
     await ProcessorService.create(projectCreatedMessage)

test/e2e/processor.timeline.index.test.js

@@ -620,7 +620,7 @@ describe('TC Timeline And Nested Timeline Topic Tests', () => {
   })
 })
 
-describe('TC Milestone Topic Tests', () => {
+xdescribe('TC Milestone Topic Tests', () => {
   before(async () => {
     // runs before all tests in this block
     await ProcessorService.create(timelineCreatedMessage)