Skip to content

Conversation

@JadeCara
Copy link
Contributor

@JadeCara JadeCara commented Nov 24, 2025

Ticket ENG-1759

Description Of Changes

🎯 All emails related to manual tasks can be edited in the message templates UI, except the welcome email to the task portal. Can we make this email editable as well?

AC

  • I can edit the subject and body of the “Welcome to our Privacy Center” from the Fides UI.

This PR adds the welcome email to the

Code Changes

  • Updates to Front End elements:
    • Update testing count clients/admin-ui/cypress/e2e/messaging.cy.ts
    • clients/admin-ui/src/features/messaging-templates/CustomizableMessagingTemplatesEnum.ts
    • clients/admin-ui/src/features/messaging-templates/CustomizableMessagingTemplatesLabelEnum.ts
  • Updates to BE
    • Updated the html src/fides/api/email_templates/templates/external_user_welcome.html
    • Added messaging template src/fides/api/models/messaging_template.py
    • Added to configurable templates src/fides/api/schemas/messaging/messaging.py
    • Updated dispatch to check for updates to template src/fides/api/service/messaging/message_dispatch_service.py
  • Tests
    • Updated for flaky test: tests/ops/api/v1/endpoints/privacy_request/test_privacy_request_performance.py
    • Added test for template tests/ops/service/messaging/test_messaging_crud_service.py

Steps to Confirm

  1. Run fidesplus pointed at this branch

  2. Go to the notifications - External User Welcome will now be one of the options

Screenshot 2025-11-25 at 9 54 56 AM
  1. You can click on it and edit it then save it
Screenshot 2025-11-25 at 9 46 24 AM
  1. To test the send go to integrations and create a manual task and hit manage - under Manual Tasks you can create an external user. Create one for yourself.
Screenshot 2025-11-25 at 9 47 30 AM
  1. This will automatically kick off an email to you - verify the updated text has changed and there are no placeholders in the message (the link locally doesnt actually point at anything)
Screenshot 2025-11-25 at 9 47 44 AM

Pre-Merge Checklist

  • Issue requirements met
  • All CI pipelines succeeded
  • CHANGELOG.md updated
    • Add a db-migration This indicates that a change includes a database migration label to the entry if your change includes a DB migration
    • Add a high-risk This issue suggests changes that have a high-probability of breaking existing code label to the entry if your change includes a high-risk change (i.e. potential for performance impact or unexpected regression) that should be flagged
    • Updates unreleased work already in Changelog, no new entry necessary
  • UX feedback:
    • All UX related changes have been reviewed by a designer
    • No UX review needed
  • Followup issues:
    • Followup issues created
    • No followup issues
  • Database migrations:
    • Ensure that your downrev is up to date with the latest revision on main
    • Ensure that your downgrade() migration is correct and works
      • If a downgrade migration is not possible for this change, please call this out in the PR description!
    • No migrations
  • Documentation:
    • Documentation complete, PR opened in fidesdocs
    • Documentation issue created in fidesdocs
    • If there are any new client scopes created as part of the pull request, remember to update public-facing documentation that references our scope registry
    • No documentation updates required

@vercel
Copy link

vercel bot commented Nov 24, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

2 Skipped Deployments
Project Deployment Preview Comments Updated (UTC)
fides-plus-nightly Ignored Ignored Preview Nov 26, 2025 5:13pm
fides-privacy-center Ignored Ignored Nov 26, 2025 5:13pm

@codecov
Copy link

codecov bot commented Nov 25, 2025

Codecov Report

❌ Patch coverage is 0% with 9 lines in your changes missing coverage. Please review.
✅ Project coverage is 87.01%. Comparing base (c3fc2c6) to head (7f82d87).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
.../api/service/messaging/message_dispatch_service.py 0.00% 9 Missing ⚠️

❌ Your patch status has failed because the patch coverage (0.00%) is below the target coverage (100.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7030      +/-   ##
==========================================
- Coverage   87.03%   87.01%   -0.03%     
==========================================
  Files         528      528              
  Lines       34668    34676       +8     
  Branches     4005     4008       +3     
==========================================
  Hits        30174    30174              
- Misses       3620     3628       +8     
  Partials      874      874              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@JadeCara JadeCara marked this pull request as ready for review November 25, 2025 17:06
@JadeCara JadeCara requested review from a team as code owners November 25, 2025 17:06
@JadeCara JadeCara requested review from adamsachs and gilluminate and removed request for a team November 25, 2025 17:06
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Nov 25, 2025

Greptile Overview

Greptile Summary

This PR successfully makes the External User Welcome email customizable through the messaging templates UI, following the existing pattern established for other configurable templates like Manual Task Digest.

Key changes:

  • Added EXTERNAL_USER_WELCOME to the list of configurable messaging action types across frontend and backend
  • Updated email template to support conditional rendering via custom_intro variable
  • Modified message dispatch service to check for custom templates and render custom subject/body
  • Added default template values with appropriate placeholders (__ORG_NAME__, __PORTAL_LINK__)
  • Updated Cypress test count from 9 to 10 templates
  • Fixed unrelated flaky performance test by mocking Celery task execution

The implementation is consistent with the existing MANUAL_TASK_DIGEST pattern, using the same approach of passing a custom_intro variable to conditionally replace default HTML content.

Confidence Score: 4/5

  • This PR is safe to merge with minimal risk - changes follow established patterns and include appropriate test coverage
  • The implementation correctly follows the existing pattern for customizable templates and includes proper test coverage. Score is 4 instead of 5 due to the template HTML readability issue noted in previous review comments (long default text on single line), though this doesn't affect functionality
  • No files require special attention - all changes follow established patterns

Important Files Changed

File Analysis

Filename Score Overview
src/fides/api/email_templates/templates/external_user_welcome.html 4/5 Refactored template to support custom intro text via custom_intro variable with conditional rendering
src/fides/api/models/messaging_template.py 5/5 Added default template entry for EXTERNAL_USER_WELCOME with subject and body placeholders
src/fides/api/schemas/messaging/messaging.py 5/5 Added EXTERNAL_USER_WELCOME to CONFIGURABLE_MESSAGING_ACTION_TYPES tuple to enable UI customization
src/fides/api/service/messaging/message_dispatch_service.py 4/5 Added logic to check for custom template and render custom subject/body, passing custom_intro to HTML template

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

9 files reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

@JadeCara
Copy link
Contributor Author

@greptile please review

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

9 files reviewed, no comments

Edit Code Review Agent Settings | Greptile

Copy link
Contributor

@adamsachs adamsachs left a comment

Choose a reason for hiding this comment

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

👍

Copy link
Contributor

@gilluminate gilluminate left a comment

Choose a reason for hiding this comment

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

👍

@JadeCara JadeCara enabled auto-merge November 25, 2025 19:31
@JadeCara JadeCara added this pull request to the merge queue Nov 25, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 25, 2025
@JadeCara JadeCara added this pull request to the merge queue Nov 26, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 26, 2025
@JadeCara JadeCara added this pull request to the merge queue Nov 26, 2025
Merged via the queue into main with commit 2c633a5 Nov 26, 2025
74 of 75 checks passed
@JadeCara JadeCara deleted the ENG-1759-manual-task-portal-welcome-email-should-be-an-editable-template branch November 26, 2025 18:31
jjdaurora pushed a commit that referenced this pull request Dec 5, 2025
Co-authored-by: Jade Wibbels <jade@ethyca.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants