Turn off participant email notifications

[philerooski]

My workflow already handles emailing the submitter when their submission has been validated and scored. This process rarely takes more than a few seconds, so I want to be able to disable the emails sent by the workflow hook to the submitter so that they aren't inundated with emails.

The "received" email is more useful in my use case than the "completed" email, so being able to enable/disable these individually would be ideal.

[thomasyu888]

There is a docker compose env variable you can set to disable notifications. Please carefully read through readme.

It's something like SHARE_RESULTS_IMMEDIATELY=false

[philerooski]

Are you certain this disables email notifications? Even received? The README currently only mentions how this variable affects logs (which are sent with the "completed" email).

[thomasyu888]

Hmm.... Maybe I'm remembering incorrectly. I would confirm with Bruce.

Edit. I think you're right and we would need this feature for what you want. SHARE_RESULTS_IMMEDIATELY has to do with the logs being returned. Although I will say that the email tool we have is actually a bit hacky. We should honestly be figuring out how to log certain steps of the workflow and returning those to the participant. We can chat more when I get back

[brucehoff]

The workflow hook notifies the submitter of the following events:

• workflow has been started
• workflow has completed
• workflow has failed
• workflow is stopped by the user
• workflow timed out The SHARE_RESULTS_IMMEDIATELY parameter is something different. It controls whether workflow logs are shared with the submitter. (If not, they are just provided to the queue administrator who can share later, if desired.)

Do you want to control which of the five notifications are sent?

[philerooski]

It would be great if they could be optional variables that I set in .env -- defaulting to true (do notify).

[brucehoff]

How about a 'mask' of submitter notifications: 0x00001 = 1 = send message when workflow has started 0x00010 = 2 = send message when workflow has completed 0x00100 = 4 = send message when workflow has failed 0x01000 = 8 = send message when workflow has been stopped by user 0x10000 = 16 = send message when workflow has timed out

The default would be 0x11111 = 31, send messages for everything.

[brucehoff]

https://github.com/Sage-Bionetworks/SynapseWorkflowHook/commit/e8e21a189bf4118b17edc5e8853764237a799941

[brucehoff]

@philerooski When the build finishes, as shown here: https://cloud.docker.com/u/sagebionetworks/repository/docker/sagebionetworks/synapseworkflowhook/builds you can try out the new SUBMITTER_NOTIFICATION_MASK parameter documented here: https://github.com/Sage-Bionetworks/SynapseWorkflowHook/blob/master/README.md

[philerooski]

Am I using SUBMITTER_NOTIFICATION_MASK correctly? I pulled the latest sagebionetworks/synapseworkflowhook and sagebionetworks/synapseworkflowhook-toil and set SUBMITTER_NOTIFICATION_MASK=28 because I only wanted participants to receive emails when something went wrong or they cancelled their submission -- but I still received "workflow in progress" and "workflow has finished running" emails.

[brucehoff]

A line needs to be added to docker-compose.yaml as shown in this commit: https://github.com/Sage-Bionetworks/SynapseWorkflowHook/commit/5fae5997c4e488a4a6d033a97dd4862c9280e61b

[philerooski]

I still seem to be getting emails after pulling commit 7c7a022 and respective images (also from 7c7a022).

I've set SUBMITTER_NOTIFICATION_MASK=28 in my .env file

[brucehoff]

Sorry, there was a typo. Please:

docker pull sagebionetworks/synapseworkflowhook

to get the fix.