Trigger notifications for changes on project plan

[vic-georgiev]

Expected behavior

Activities and changes of project plan should trigger notifications to drive users' attention and guide them back to the UI.

• Project plan is ready (when we first publish a phase in Planned mode from draft)
• Project phase changes
  • Phase status change to Active (your phase is now active)
  • Phase status change to Delivered (we've closed the phase)
  • Phase progress changed
  • Phase payment changed
  • Phase new posts (should work as regular posts, and load the phase expanded, with tab selected and latest messages visible)
  • Scope changes on a phase - updated, files added
• Project progress changes

Aha! Link: https://topcoder.aha.io/features/TCCONNECT-431

[vikasrohit]

@vic-topcoder @rmjmccormick @gondzo I think we should also handle the email notifications for these new events at the same time. topcoder-platform/tc-notifications#51

[vic-georgiev]

Agreed - anytime I mention Notification, we should trigger all channels (in-app, email, and future {push, desktop, browser tab counter, etc.})

[architectt1]

@gondzo @vikasrohit

Project plan is ready (when we first publish a phase in Planned mode from draft)

Should this be triggered for both create and update actions for a given phase? I'm not sure if publish refers to create or to update as well. Also, I'm assuming that, if a phase already exists with the Planned mode for the project in question, then we shouldn't send this notification. Is that correct?

Scope changes on a phase - updated, files added

Regarding the files added, there's a project_attachments table in tc-project-service, is that what is being mentioned in here? Note that they associate to a project, not to a particular phase. What is the wanted approach for this requirement?

Let me know if this is not the correct place for this. These are changes related to https://github.com/topcoder-platform/tc-project-service, but the issue was present in here.

[architectt1]

@gondzo @vikasrohit I also noticed that in the project's API, an authorized user can create phases in any state. For all the phase transitions' notifications, these should be about update and not create actions, right?

[architectt1]

Could you please add the following topics to Kafka (@gondzo that would be the instance you passed me access credentials about)?

notifications.connect.project.planModified (this is already in dev, but it seems is not registered)
notifications.connect.project.planReady
project.phase.transition.active
project.phase.transition.completed
project.phase.update.payment
project.phase.update.progress
project.phase.update.scope
notifications.connect.project.progressModified

For files, we already have the notifications.connect.project.fileUploaded event being sent, but again, that's related to the project as a whole, and not to a particular phase. @gondzo if you can, please double check this event is already added to Kafka or not, as I didn't yet test it.

[architectt1]

@gondzo @vikasrohit I was able to install a local Kafka instance, so I'm able to test locally. I need the following information from you, as I don't have a deep insight of the business logic of the system: for each Kafka event, please let me know which roles from the ones below need to get notified:

projectRoles

• owner
• copilot
• manager
• member

topcoderRoles

• Connect Copilot
• Connect Manager
• administrator

Kafka events

notifications.connect.project.planReady
project.phase.transition.active
project.phase.transition.completed
project.phase.update.payment
project.phase.update.progress
project.phase.update.scope
notifications.connect.project.progressModified

[architectt1]

I can confirm attachments added to projects are generating a notification record to all project's members with notification type notifications.connect.project.fileUploaded.

[vikasrohit]

@gondzo Please keep the changes for this issue in a separate feature branch because it is not scheduled for upcoming release.

Project plan is ready (when we first publish a phase in Planned mode from draft)

@vic-topcoder Should we say that Project Plan is ready when only one phase in the plan is set to planned mode? May be we should send this event when all phases in the project plan are marked as planned?
Also, if we raise both Phase progress changed and Project progress changes, it would trigger two events when a phase's progress is changes because whenever progress of phase changes, it changes the progress of the project as well. In fact we don't have any other event which can change the progress of the project.

[vikasrohit]

@gondzo where are we with the changes for this issue? Do we need to start from ground zero or we have something already in place?

[gondzo]

We have the PR ready in project service https://github.com/topcoder-platform/tc-project-service/pull/110/files