RFC for Status Collection Data Model

[heyrandhir]

The Collection name will be Status. All the documents in the collection will have the following data model.

{
  "userId": "String",
  "ooo":  {
      "status": "Boolean",
      "createdAt": "TimeStamp",
      "from": "TimeStamp",
      "till": "TimeStamp",
      "reason": "String"
    },
  "monthlyHoursCommitment": {
      "noOfHours": "Integer",
      "createdAt": "TimeStamp"
    }
}

̶T̶h̶e̶ ̶̶o̶o̶o̶̶ ̶a̶n̶d̶ ̶̶m̶o̶n̶t̶h̶l̶y̶H̶o̶u̶r̶s̶C̶o̶m̶m̶i̶t̶m̶e̶n̶t̶̶ ̶w̶i̶l̶l̶ ̶b̶e̶ ̶a̶n̶ ̶a̶r̶r̶a̶y̶ ̶a̶n̶d̶ ̶w̶h̶e̶n̶e̶v̶e̶r̶ ̶a̶ ̶U̶s̶e̶r̶ ̶u̶p̶d̶a̶t̶e̶s̶ ̶t̶h̶e̶i̶r̶ ̶s̶t̶a̶t̶u̶s̶ ̶w̶e̶ ̶w̶i̶l̶l̶ ̶p̶u̶s̶h̶ ̶t̶h̶e̶ ̶n̶e̶w̶ ̶o̶b̶j̶e̶c̶t̶ ̶i̶n̶ ̶t̶h̶e̶ ̶a̶r̶r̶a̶y̶.̶ ̶S̶t̶o̶r̶i̶n̶g̶ ̶l̶i̶k̶e̶ ̶t̶h̶i̶s̶ ̶w̶i̶l̶l̶ ̶h̶e̶l̶p̶ ̶u̶s̶ ̶i̶n̶ ̶t̶r̶a̶c̶k̶i̶n̶g̶ ̶h̶i̶s̶t̶o̶r̶y̶.̶ ̶

Note: If the User changes their status from OOO true to OOO false then the object will just have status and createdAt. The other fields Since,Till,Reason will be empty.

The final data model which we agreed for is as below

{
  "userId": "String",
  "currentStatus":  {
      "state": "OOO | IDLE | ACTIVE",
      "updatedAt": "TimeStamp",
      "from": "TimeStamp ",
      "until": "TimeStamp",
      "message": "String"
    },
  "monthlyHours": {
      "committed": "Integer",
      "updatedAt": "TimeStamp"
    }
}

[RitikJaiswal75]

We can also include another status like
"active" can include tasks that they are working on
"idle" shows when are they idle, their skills, etc.

[heyrandhir]

We can also include another status like "active" can include tasks that they are working on "idle" shows when are they idle, their skills, etc.

For tasks that the Users are working we already have a task API I think. and yeah idle can be added but we need to provide an option on mysite to change the idle status similar to OOO.

[vinayak-trivedi]

• what are we planning to do with monthlyHoursCommitment, are we planning to check if the monthly hour commitment will not be met if the user OOO duration exceeds a limit

[heyrandhir]

• what are we planning to do with monthlyHoursCommitment, are we planning to check if the monthly hour commitment will not be met if the user OOO duration exceeds a limit

The main purpose of monthlyHoursCommitment afaik is that Ankush wants to figure out how much time a developer is available for this month and then assign tasks accordingly. If someone is devoting more time he will get a more heavy feature. Also If a feature requires a minimum of x hrs then it should be allocated to someone who is left with x or more hours this month. That's the use case I can think of as of now.

[heyrandhir]

As discussed with @ankushdharkar the ooo and monthlyHoursCommitment will not be an array but instead an object as in an array we cant query. Hence whenever a new object is added we will push the old object into the log.

[heyrandhir]

Updated Data model

{
  "userId": "String",
  "currentStatus":  {
      "status": "ooo || idle || active",
      "createdAt": "TimeStamp",
      "from": "TimeStamp ",
      "till": "TimeStamp",
      "reason": "String"
    },
  "monthlyHoursCommited": {
      "noOfHours": "Integer",
      "createdAt": "TimeStamp"
    }
}

[heyrandhir]

As per the discussion with @RitikJaiswal75 and @vinayak-trivedi we need to consider the following points

• make the currentStatus object field generic to have the same keys in either ooo or idle or active status.
• Accommodate skills and skills gaps in the collection
• Make a Status Tag and use the Generic Tag API created by @DashDeipayan and @vinayak-trivedi .

[prakashchoudhary07]

Any specific reason for having an object for currentStatus and monthlyHoursCommited?

[heyrandhir]

Any specific reason for having an object for currentStatus and monthlyHoursCommited?

since there were multiple keys like status,createdAt,from etc I thought to club them in an object.

[heyrandhir]

The collection name will be UserStatus.The Updated Data model will look like this.

{
  "userId": "String",
  "currentStatus":  {
      "state": "OOO | IDLE | ACTIVE",
      "updatedAt": "TimeStamp",
      "from": "TimeStamp ",
      "until": "TimeStamp",
      "message": "String"
    },
  "monthlyHours": {
      "committed": "Integer",
      "updatedAt": "TimeStamp"
    }
}