Add Email Notification Logic #2837
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kunwp1
requested review from
aglinxinyuan
and removed request for
Yicong-Huang
PurelyBlank
pushed a commit
that referenced
this pull request
Dec 4, 2024
This PR introduces functionality to send an email notification whenever a workflow transitions from a running state to a non-running state (e.g., `Completed`, `Failed`, `Killed`, or `Paused`). This feature was requested by the bioinformatics team at Cornell University to facilitate their long-running workflows. They wanted to be notified once the execution of their workflow is finished. ### Implementation Details A new `sendWorkflowStatusEmail` method has been added to handle the construction of the email notification, which includes details such as the workflow ID, name, state, timestamp, and a link to the dashboard. This method is triggered on the frontend whenever it detects a status change from the backend. ### Setup To enable this functionality, update the following parameters in the core/amber/src/main/resources/application.conf file: 1. Set `user-sys.enabled` to true. 2. Set `user-sys.google.clientId` to your Google API client ID. 3. Set `user-sys.google.smtp.gmail` to your Gmail ID (ensure that IMAP is enabled for this account). 4. Set `user-sys.google.smtp.password` to your Gmail password. https://github.com/user-attachments/assets/dd72af90-b8a8-45ef-9bcc-1ba628e55e9a --------- Co-authored-by: Kunwoo Park <kunwoopark@Kunwoos-MacBook-Pro.local> Co-authored-by: linxinyuan <linxinyuan@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces functionality to send an email notification whenever a workflow transitions from a running state to a non-running state (e.g.,
Completed,Failed,Killed, orPaused). This feature was requested by the bioinformatics team at Cornell University to facilitate their long-running workflows. They wanted to be notified once the execution of their workflow is finished.Implementation Details
A new
sendWorkflowStatusEmailmethod has been added to handle the construction of the email notification, which includes details such as the workflow ID, name, state, timestamp, and a link to the dashboard. This method is triggered on the frontend whenever it detects a status change from the backend.Setup
To enable this functionality, update the following parameters in the core/amber/src/main/resources/application.conf file:
user-sys.enabledto true.user-sys.google.clientIdto your Google API client ID.user-sys.google.smtp.gmailto your Gmail ID (ensure that IMAP is enabled for this account).user-sys.google.smtp.passwordto your Gmail password.Screen.Recording.2024-09-16.at.10.30.57.AM.mov