feat: mrf dashboard send reminders

[kevin9foong]

Problem

Admins want a way to send reminders for pending MRF forms, especially for cases when the email is lost. This emulates the real life scenario where you can remind someone to fill in a form.

Closes FRM-1963

Solution

Implement a action column with send reminder buttons in the hawkeye dashboard which admins can click to send these reminders.

Note: For backwards compatibility, the reminders button will not appear for pending MRF steps submitted before the release of reminders (since the nextStepRecipientEmails is not yet recorded)

Breaking Changes

No - this PR is backwards compatible

Before & After Screenshots

AFTER:

New column added for reminders

Tests

TC1: Reminders work for step 2

• Create a new MRF form with 4 steps. Let step 2 be static email, step 3 be dynamic email field routing and step 4 be conditional routing based on a dropdown (where each dropdown has multiple emails tied to it). Set up a valid configuration.
• Submit step 1. Assert that a next step is send to step 2.
• Click on send reminder for the submission on the hawkeye dashboard.
• Assert that you have received an email address with subject [Reminder] and can click on the link, fill it in and submit step 2.
• Assert non-reminder step 3 email notification arrives.

TC2: Reminders work for step 3

• Continue from TC1.
• Click on send reminder for step 3.
• Assert that you have received an email to the correct mail address with subject [Reminder] and can click on the link, fill it in and submit step 3.
• Assert non-reminder step 4 email notification arrives.

TC3: Reminders work for last step (eg, step 4 of 4-step MRF workflow) and multiple emails work

• Continue from TC2.
• Click on send reminder for step 4.
• Assert that you have received an email to the correct mail addresses (check there are multiple based on your dropdown option mapping for conditional routing) with subject [Reminder] and can click on the link, fill it in and submit step 4.
• Assert that the dashboard now displays the form is completed.

TC4: Back ward compatibility -- should not be able to trigger send reminder for pre-existing pending submissions.

• Open some existing pending MRF submissions before reminders.
• Ensure that the send reminder button does not exist.

TC5: Regression test -- Csv and individual submissions are unaffected

• From TC4, download your form responses for the MRF form.
• Assert that the CSV does not include any column related to reminders.
• Assert that individual submission page (ie click on a row in the dashboard) does not show reminder information either.

TC6: Rejected is considered completed

• Make a 3 step MRF with approvals on step 2.
• Reject at step 2.
• Assert that the send reminder button does not show up even though it is only at step 2.

[datadog-opengovsg]

Datadog Report

Branch report: feat/reminders
Commit report: c78fca1
Test service: formsg

❌ 2 Failed (0 Known Flaky), 3072 Passed, 1 Skipped, 7m 2.39s Total duration (695ms time saved)

❌ Failed Tests (2)

• multiresponodent-submision.controller sendPendingMrfSubmissionReminderForTest returns 200 ok when recipient email found and reminder email is sent successfully - src/app/modules/submission/multirespondent-submission/__tests__/multirespondent-submission.controller.spec.ts

• multiresponodent-submision.controller sendPendingMrfSubmissionReminderForTest returns 500 when sendNextStepReminderEmail encounters MailSendError - src/app/modules/submission/multirespondent-submission/__tests__/multirespondent-submission.controller.spec.ts - Details

  Expand for error

   Cannot read properties of undefined (reading 'findByIdAndUpdate')
  

[kevin9foong]

Pending items:

• Implementing of skeleton TCs
• Fix failing TCs
• Create linear ticket and update PR body
• Add Manual Tests to the PR body
• Run the manual tests on local
• Add beta flags if necessary
• Add usage tracking if necessary

[linear]

FRM-1963 MRF | Reminders

[kevin9foong]

Facing issues with playwright again -- seems to be affecting develop as well.