Notifications sent twice on action

[kpsherva]

1. make a inclusion request
2. go to request detail page
3. try to accept the request
4. add comment in "Additional comments" box
5. Click accept

Bug:
the mail is sent twice, once for accept, the second time for the additional comment.

See:

[rekt-hard]

Current state

The current simplified service flow when executing an action is as follows (code):

• get the specific request action
• execute the request action
• if there is additional data (assuming it is only for comments)
  • create a comment

Most notifications are registered when executing an action. The additional data is not available there though. This means we can send the action notification but after that another comment notification may be registered as well.

Possible solutions

Introduce an attribute on the base request action

Similar to the log_event attribute, an attribute such as create_comment can be introduced. This attribute will then be checked in the base execute_action of the requests service before creating a comment

• Since we usually override the request action for a notification, we can also specify this attribute.
• In the action, we still would not have the additional data but at least we would not send the action notification and the comment notification on one action.
• If there is a comment, the user/guest could checkout the request timeline, if interested.

Impact

This will have a rather small impact on the general application.

• Specify the attribute with a default value of True
• Adapt it for the current actions with notifications.

Move the creation of a comment to the base request action

Creation of the comment could be moved from the service to the request action. Additionally, the attribute for create_comment can be introduced as well, to allow easy configuration for the base method logic.

• Since we usually override the request action for a notification, we can also specify this attribute.
• We are able to include the comment in the respective action notification - thus only sending one notification with all the information.
• Moving the creation of the comment to the request action would allow to further customize the action in the future. If the provided additional data will not always be a comment, it can be dealt with accordingly on the specific action level, where we should have enough context. Thus providing a lot of flexibility for the future.

Impact

This will have a large impact on the general application.

• Specify the attribute with a default value of True
• Adapt it for the current actions with notifications.
• An additional function parameter has to be added to the execute action (explicit data=None, implicit **kwargs) and adapted for every subclass.
• Move implementation from service to request action
• Adapt calls (e.g. RequestActions, RequestService )

[rekt-hard]

A possible solution would be to go with the attribute only first, to have a quick solution for the general issue.
Then follow up with moving the comment creation to the request action as a next step, as it would probably lead to braking changes and a new major version?