Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dsr error handling configure alerts #1895

Merged
merged 95 commits into from
Dec 14, 2022

Conversation

chriscalhoun1974
Copy link
Contributor

@chriscalhoun1974 chriscalhoun1974 commented Nov 29, 2022

Closes #1218 #1491 #1492

Code Changes

  • Added new release flag called configureAlertsFlag to the flags.json file
  • Added new menu item More > Configure alerts to the Privacy Requests landing page
  • When user clicks the More > Configure alerts menu item, Configure alerts and notifications drawer is displayed which allows a user to configure a list of email recipients, to be notified immediately, and enter threshold number of DSR processing errors.
  • If the user has toggled the Notify me immediately if there are any DSR processing errors switch to ON and clicked the SAVE button, there is a polling process for every 15 seconds which invokes the API endpoint (api/v1/privacy-request?include_identities=true&status=error). If there are new DSR processing errors in which the total is greater than or equal to the DSR processing errors threshold configured, a toast error notification is displayed with the following text: DSR automation has failed for [X] privacy request(s). Please review the event log for further details.

NOTE All of the above coding changes are behind the release flag called configureAlertsFlag which is located in the flags.json file. By default, the isActive property is turned to false. For testing purposes, you can edit this value to true.

Steps to Confirm

  1. On a separate browser tab, log into the Fides Admin UI web app.
  2. Click the Connections nav button.
  3. Click the Create new connection button.
  4. Choose Mailchimp connection as an example.
  5. Enter the Connector parameters and Dataset configuration info (For the Connector parameters info, enter an invalid Domain, Username, and API Key values). NOTE: This is strictly used to have the DSR error for testing purposes.
  6. Once your new Connection is created, you will be navigated back to the Connections landing page.
  7. Navigate to the Privacy Requests landing page
  8. Click the More > Configure alerts menu item located in the upper right hand corner.
  9. When the sliding drawer titled Configure alerts and notifications is rendered, enter one or more email addresses, toggle the Notify me immediately if there are any DSR processing errors to ON, accept the default threshold value, and click the Save button.
  10. On a separate browser tab, log into the Privacy Center web app.
  11. Create one or more DSR(s) by entering Name and Email values via the Access your data modal and click the Continue button.
  12. Click the previous Fides Admin UI browser tab.
  13. Navigate to the Privacy Requests landing page.
  14. Verify your new DSR(s) from Step 2 have a NEW status.
  15. For each DSR, you can click the Approve button located on the right end of the row when hovered.
  16. For each DSR clicked in the previous step, the status should be ERROR now.
  17. A toast error notification located on the top of the UI screen should now be displayed with the following text: DSR automation has failed for [X] privacy request(s). Please review the event log for further details.
  18. To dismiss the toast error notification, the user must click the X icon within the toast notification itself.
  19. If the user would like to stop being notified to be alerted via toast notification or email for any DSR processing errors, the user will need to toggle the Notify me immediately if there are any DSR processing errors to OFF via clicking the More > Configure alerts menu item located in the upper right hand corner.

Pre-Merge Checklist

  • All CI Pipelines Succeeded
  • Documentation Updated:
    • documentation complete, or draft/outline provided (tag docs-team to complete/review on this branch)
    • documentation issue created (tag docs-team to complete issue separately)
  • Issue Requirements are Met
  • Relevant Follow-Up Issues Created
  • Update CHANGELOG.md

Screen Shots

Screen Shot 2022-11-30 at 8 47 54 AM
Screen Shot 2022-11-30 at 8 48 32 AM
Screen Shot 2022-11-30 at 8 50 49 AM

chriscalhoun1974 and others added 30 commits October 12, 2022 13:54
…' into 1203-individually-select-and-reprocess-DSRs-that-have-errored
…ividually-select-and-reprocess-DSRs-that-have-errored
…1203-individually-select-and-reprocess-DSRs-that-have-errored"

This reverts commit d446fe7, reversing
changes made to 28d3e33.
@sanders41
Copy link
Contributor

One thing I have noticed while testing this is once you turn messages on, you can't turn them off. If you turn off notifications and remove the email addresses you get an error.

Screen Shot 2022-12-02 at 11 31 08 AM

@chriscalhoun1974
Copy link
Contributor Author

@sanders41 The validation issue you identified has been resolved now.

Copy link
Contributor

@sanders41 sanders41 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving from a functionality standpoint.

@chriscalhoun1974
Copy link
Contributor Author

@Roger-Ethyca @Kelsey-Ethyca Ready for you to QA. Let @sanders41 or I know if you have any questions. Thank you!

@chriscalhoun1974
Copy link
Contributor Author

I have removed the configureAlertsFlag release flag.

@chriscalhoun1974 chriscalhoun1974 merged commit 8174a98 into main Dec 14, 2022
@chriscalhoun1974 chriscalhoun1974 deleted the dsr-error-handling-configure-alerts branch December 14, 2022 19:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DSR Notifications (toast)
4 participants