The update_notifications transition is not muting schedules

[abbyad]

Reported in https://github.com/medic/medic-projects/issues/1813, the ON and OFF forms are not getting auto responses, nor are they muting/unmuting schedules.

I was hoping this was a simple config issue but was not able to find the source of the problem. I have put further notes in the original issue.

[garethbowen]

Related to #3190

[abbyad]

This is in fact (partly) a config issue, and medic/medic-projects#1813 can be resolved for the time being by reverting to the older way of defining messages with message, not translation_key.

The larger issue of ON/OFF forms not working as expected is still valid, and not fully resolved by #3190.

Messages appear as deprecated, but are in fact required

Report not processed if autoreply is omitted

If the notifications section is missing the messages.message field, or even the whole messages object, the transition detects that and stops processing the form altogether. As a result, the form:

• does not have any outgoing messages (which is expected since there isn't a message!)
• does not provide any of the validation errors
• does not provide any ID not found errors
• provides no error in Sentinel logs
• provides no error in UI (on the contrary, it shows a valid green circle)
• does not do the mute/unmute action even though it appears as valid

To avoid this we will make sure projects have notifications with messages (or translation_key after 3190). I am removing the priority label and marking as a bug because although it could be considered a feature request to mute/unmute without messages, it is a UX bug to not do the mute/unmute action while not providing any errors.

Report shows as valid even if the patient ID is missing

As reported by Bishwas, the usual validations for patient ID like regex('^[0-9]{5}$') and lenMin(5) do not work for notification forms if the patient ID field is missing. The way to deal with this is to make the field required in the JSON definition of the form.

edited to reflect #3362 (comment)

[abbyad]

I have also removed this from the 2.11 project as it is no longer a blocker for that release.

[bishwasBhatta]

@abbyad regarding the validations and ID not found errors not showing up, it is happening even when the message object is present: https://github.com/medic/medic-projects/issues/1825

[abbyad]

Thanks @bishwas-medic, just tested that and you are right, that is a problem. I will update the comment above to include that as another way the forms don't behave as expected.

[garethbowen]

Closing as @abbyad reports it's a configuration issue - details in medic/medic-projects#1813

Reopen if this is incorrect!

[abbyad]

Although it can be partly mitigated in configuration, it is problematic to show a notification report as valid when the intended mute/unmute action is not taken. Because of that we should:

1. make necessary change so that reports are completely processed even if outgoing messages are missing
   OR
2. document that the notification messages are required in app_settings and config docs

If we chose the latter option we should also consider proper handling when messages are missing (eg reports marked as invalid, and errors in Sentinel logs), or as part of a more comprehensive error handling of the configuration.

[garethbowen]

@dianabarsan Do you think you work for #4767 will fix this one too?

[dianabarsan]

@garethbowen not yet, I did not change that part of the behavior. Working on it.

[ngaruko]

LGTM