enonic / xp

Enonic XP
https://enonic.com
GNU General Public License v3.0
201 stars 34 forks source link

Reduce number of issue email notifications #7664

Closed pmi closed 4 years ago

pmi commented 4 years ago

Case 1: User A creates an issue, but doesn’t assign it to anyone.

Expected behaviour: No email is sent

Case 2: User A creates an issue and assigns it to user B during creation.

Expected behaviour: System sends an email with subject “You were assigned…” From: User A To: User B

Case 3: Any user assigns an existing issue to user B

Expected behaviour: System sends an email with subject “You were assigned…” (even if it was user B who assigned the issue to himself)

From: modifier To: User B

Case 4: Any user adds a comment to an issue

Expected behaviour: System sends an email “A new comment is posted”

From: modifier (the one who left a comment) To: creator + all assignees - modifier

Case 5: Any user closes or reopens the issue

Expected behaviour: System sends an email “The issue was closed” or “The issue was reopened”

From: modifier To: creator + all assignees - modifier

Case 6: Any user changes issue title or modifies the list of content items

Expected behaviour: No email is sent

Case 7: Any user publishes an issue or a publish request (which then closes)

Expected behaviour: System sends an email “X published and closed the issue...”

From: modifier To: creator + all assignees - modifier

NB! There are certain cases when email should not be sent at all. For example, when creator, assignee and modifier is the same user. Or when creator changes an issue and there are no assignees.

GlennRicaud commented 4 years ago

See comment in PR https://github.com/enonic/xp/pull/7665#issuecomment-563230530

GlennRicaud commented 4 years ago

Thanks @alansemenov

If I understood correctly:

Common rules:
  No copy recipients
  Do not sent mail if the list of recipients is empty

##############
Issue Created

Subject: "You were assigned…"
From: Creator
To: Assignees - Creator
Copy: -

##############
Issue Updated

If new assignees (no filtering)
  Subject: "You were assigned…"
  From: Modifier
  To: New assignees
  Copy: -

If issue opened / closed
  Subject: "The issue was closed" / "The issue was reopened"
  From: Modifier
  To: Creator + all assignees - modifier
  Copy: -

##############
Issue Commented

  Subject: "A new comment is posted"
  From: Commenter
  To: Creator + Assignees - Commenter
  Copy: -

##############
Issue Published

  No email sent anymore

@pmi Please apply the necessary modifications to have the behaviour above (Closing current PR as it does not match)

EDIT:

##############
Issue Published

  Subject: "X published and closed the issue Y"
  From: Publisher
  To: Creator + Assignees - Publisher
  Copy: -
alansemenov commented 4 years ago
##############
Issue Published

  No email sent anymore

Turns out we had a special email template for this case. Added case 7 describing this.