Support having new models in ES

[maxceem]

We have some models which we don't use at the moment in the production. We didn't add them to ES index during migration to V5 to speed up the process. And now we would like to make sure we index all the models in ES before we use new models in PROD.

[maxceem]

Implement

• BuildingBlock - we don't have endpoints to manage this model, thus it's never added to ES. Also, project-processor-es doesn't support handling events for this model.

  • we would have to add post-processing filter to the project endpoints to filter out privateConfigs for them, or even don't index private configs, if we are not going to use them client-side

• WorkStream - a new model which is not indexed so far and project-processor-es doesn't support it.

• Work - it's indexed as a phase, which is incorrect. We have to create separate events for works now and index them inside workstreams. So the final shape with works and workstreams suppose be like this:

   project = {
     id: 1234,
     phases: [], // phases stay separately
     workstreams: [
        ...
        { // Worstream
           id: 123,
           works: [], // now works should be inside respective workstreams instead of phases
        }
        ...
     ] 
   }
  
  

• ProjectEstimation and ProjectEstimationItems - are not indexed yet, suppose to be added inside project docuemtns:

  project = {
     id: 1234,
     estimations: [
        { // Estimation
           id: 12,
           items: [] // list of ProjectEstimationItems
        }
     ],
  }
  

  • we have to filter items using post-processing in projects endpoints, as not all users can get all estimation items

• ProjectHistory - is not indexed yet. Suppose to be added into project documents:

  project = {
     id: 1234,
     history: [], // ProjectHistory records
  }
  

  • Not sure if need it, as it looks like we never use it for now.

• ProjectSettings - not yet in ES.
  It is supposed to be added into the project document:

   project = {
     id: 1234,
    settings: [], // List of ProjectSettings
   }
  

  • we have to implement post-processing for project endpoints as not all settings could be retrieved by all the users

• ScopeChangeRequest - not yet in ES.
  It is supposed to be added into the project document:

   project = {
     id: 1234,
    scopeChangeRequests: [], // List of ScopeChangeRequest
   }
  

• StatusHistory - this model is currently used to track status changes of milestones only, though it's designed to be a general model to keep track of status of any model. So technically it's better to create a separate index of this model. Though practical wise, we for now we would return it inside milestones so more comfortable for us would be keeping these records inside milestones:

  timeline = {
     id: 12,
     milestones: [
       {
          id: 34,
          statusHistory: [], // list of StatusHistory
       }
     ]
  }
  

  • if we can come up with an idea how we can keep StatusHistory records inside the respective models in ES, to keep it inside milestones, that would be great. Though it should be somehow a universal way which could be applied to new model. Though if we are considering to keep StatusHistory as a separate service, then this way would be impossible. Also, for sure it's more tricky, even though more convenient during reading the data.
  • The most straightforward and universal way is to create a separate index, and make 2 calls to ES when getting data: one to the main model (milestones) and the second one to the statusHistory index for gettings statuses and after populate respective objects (milestones).

• WorkManagementPermission - not yet in ES.
  We can keep it inside metadata index, as it related to the Project Templates.

  • We should refactor how CRUD endpoints work to follow RESTful format.

Verify

• Form, PriceConfig, PlanConfig - ES indexing has been implemented but wasn't properly tested as we don't use them in real life yet.

[vikasrohit]

@maxceem we haven't started on this yet, right?

[maxceem]

@vikasrohit haven't started yet.