Implement Batch Email Notifications

[ShanaLMoore]

Summary

SOW

The goal is to implement batch email notifications for some activities/trigers in the Hyku application. The notifications should match those of the One-step mediated deposit workflow. That includes:

• Notifications to submitter and approver for activity related to mediated deposit, which currently produce notifications within the app but not pushed out to email. These including:
  • Work submitted awaiting review
  • Work reviewed and accepted
  • Work reviewed and sent back with comment
  • Work revised and resubmitted for review

Acceptance Criteria

• Email notifications to submitter and approver for activity related to mediated deposit are set up and include: (see below)
  • Work submitted awaiting review
  • Work reviewed and accepted
  • Work reviewed and sent back with comment
  • Work revised and resubmitted for review
• Email notifications to authors related to views and downloads of their works are set up

TASKS

• Email Notifications UI #1022
• Set up MailDev for Staging #1023

Testing Instructions

1. Be sure the tenant has a contact email set on the account settings, and one-step mediated deposit set for the admin set. (This requires approval for every work created, for example, which also triggers the notifications).
2. Go to User profile to set the batch email notification frequency.
3. Create a work. Notice the notification bell should have an additional alert. This alert should be what gets emailed to the user email, per the selected frequency.

Notes

Spike results: #1005 (comment)
Implementation brainstorm: #1005 (comment)

[kirkkwang]

samvera/hyrax#5212 may be of interest

[ShanaLMoore]

QA RESULTS: Needs Rework ❌

We will come back to check if an email got sent tomorrow. We triggered the notifications today and set the frequency to daily.

re: PENDING

We can see the BatchEmailNotificationJob waiting to be run in /jobs

: :

[ShanaLMoore]

After 24 hrs, I did not receive any emails as expected:

[ShanaLMoore]

Perhaps hyku-demo wasn't set up right. Emails are received when tested using on hyku-staging:

[ShanaLMoore]

QA RESULTS: PASS ✅

Tested on: PALS KNAPSACK STAGING
Frequency: Daily

I will check maildev in 24 hrs.

UPDATE: The email appeared:

[ShanaLMoore]

cc @ndroark our staging mailer caught your batch email request:

[ctgraham]

It looks like all mail for demo.palni-palci-staging.notch8.cloud is sandboxed to the "staging mailer" you describe above.

How do I get credentials for a new user in the tenant? When I create and activate a new user, I don't see a way for the user to reset their password, nor for an admin to set their password.

How do I have a user review the email notifications once created?

[ShanaLMoore]

@ctgraham

You would need assistance with all the above requests because of the mailer interception.

As a workaround, when you create a user an admin user can "activate" the user and it'll set the password to password.

Otherwise you can let us know what tenant/emails you are expecting and we can check it for you and screenshot the email for your review or approval.

[ShanaLMoore]

@ctgraham I just checked the mail server and see 2 emails. click on the links to set passwords:

Hello [email protected]

Someone has invited you to https://demo.palni-palci-staging.notch8.cloud/, you can accept it through the link below.

Accept invitation

If you don't want to accept the invitation, please ignore this email. Your account won't be created until you access the link above and set your password.

---

Hello [email protected]

Someone has invited you to https://demo.palni-palci-staging.notch8.cloud/, you can accept it through the link below.

Accept invitation

If you don't want to accept the invitation, please ignore this email. Your account won't be created until you access the link above and set your password.

[ctgraham]

The following actions were taken in the demo.palni-palci-staging instance this week:

• ctgraham set to daily email frequency
• ctgraham+depositor deposited to Default Admin Set
• ctgraham+depositor deposited to Pitt Notifications Testing
• ctgraham read in-app notification for Pitt Notifications Testing
• ctgraham+depositor set for weekly notifications
• jeffw, abrenner added as watchers with daily email frequency, no messages expected.
• jfudrow deposited 3 works (with multiple related works automatically created)
• asw76 deposited 13 works
• ctgraham read in-app notifications

[ShanaLMoore]

I checked maildev (our staging mailbox) to see that no emails were sent because the BatchEmailNotificationJob failed. Migrations needed to be run on staging. I ran the migrations and we should hopefully see notification emails going forward.

I'm afraid you may need to redo the actions above ^^ @ctgraham for the users set to "daily" frequency as your actions were done more than a day ago, at the time of fixing staging. anything done more than a day ago won't match the query of emails to send.

To re test I created a new work and manually ran the job. the following emailed was received:

https://demo.palni-palci-staging.notch8.cloud/notifications?locale=en

Switched users and created a work.

email received after manually running job:

at

[ctgraham]

ctgraham and jfudrow performed multiple editorial actions today, accepting/commenting/returning about a score of submissions.

[ShanaLMoore]

@ctgraham The following emails were received this morning:

[ctgraham]

For John Fudrow, we see two items in his Notifications Feed from two days ago, but only one item in the email. The two items are as follows.

What caused this discrepancy?