AO3-7035 Add Invitation Mailer Previews and Refactored I18n Keys #5489

Dcano-png · 2025-11-29T22:04:54Z

Pull Request Checklist

Have you read "How to write the perfect pull request"?
Have you read the contributing guidelines?
[X ] Have you added tests for any changed functionality?
Have you added the Jira issue number
as the first thing in your pull request title (e.g. AO3-1234 Fix thing)
Do you have fewer than 5 pull requests already open? If not, please wait
until they are reviewed and merged before creating new pull requests.

Issue

https://otwarchive.atlassian.net/browse/AO3-7035

Purpose

This PR introduces the Invitation Mailer Preview functionality and conducts a required I18n refactoring of the invitation email. The refactoring eliminates unsafe practices (like html_safe and view helpers for formatting) to improve code maintainability, rendering safety, and compliance with current I18n standards.

Changes Included

Added Mailer Preview (invitation_mailer_preview.rb): A new preview class was added, featuring two necessary variants:
- invitation_by_other_user: Previews the mailer when an inviter's username is present in the greeting.
- invitation_by_queue: Previews the generic mailer greeting when the invitation is system-generated.
Refactored I18n Keys (config/locales/*.en.yml) and Templates(app/views/user_mailer/invitation.*.erb):
- Eliminated the use of html_safe from all calls in app/views/user_mailer/invitation.*.erb.
- Refactored Locale Keys (config/locales/*.en.yml): Separated nested keys (e.g., .html.about) into the standard structure (.about.html and .about.text). This ensures the I18n system correctly prevents raw HTML from showing in the final message while allowing helpers to be used in the HTML view.
- Resolved Issue: This refactoring inherently fixed the issues with exposed HTML tags and eliminated the variable mismatch errors encountered during development.

Credit

Dcano-png (She/Her)

…_preview

Bilka2 · 2025-11-29T22:30:05Z

Hi!

Thank you so much for this pull request. Someone will be along to review it soon.

I've updated the Jira issue status to In Review so no one will mistakenly create a duplicate pull request. If you'd like the ability to comment on, assign, and transition issues in the future, you're welcome to create a Jira account! It makes things a bit easier for us on the organizational side if the Full Name on your Jira account either closely matches the name you'd like us to credit in the release notes or includes it in parentheses, e.g. "Nickname (CREDIT NAME)."

Once you've done that (or if you've already done it -- Jira has been unreliable about showing us new accounts in the admin panel lately), you can either reply here or send an email to otw-coders@transformativeworks.org with your account name and email address and we'll set up the permissions for you.

Thanks again for contributing! If you have any questions, you can contact us at the same email address listed above.

…Redundancy

config/locales/mailers/en.yml

…ctions

Bilka2

Thank you for working on this. Since part of this issue is to do a style cleanup, I've pointed out a lot of places where we should make modifications to follow the latest version of our i18n standards.

Bilka2 · 2025-12-08T12:52:26Z

app/views/user_mailer/invitation.html.erb

-      <%= t(".has_invited", user_name: style_bold(@user_name)).html_safe %>
+      <%= t(".has_invited.html", user_name: style_bold(@user_name)) %>
    <% else %>
      <%= t ".been_invited" %>


Please update all t method calls in these emails to use parentheses, as explained in our i18n standards:

Suggested change

<%= t ".been_invited" %>

<%= t(".been_invited") %>

Bilka2 · 2025-12-08T12:55:06Z

app/views/user_mailer/invitation.html.erb


  <p>
-    <%= t(".html.activation_support", support_link: style_link(t(".html.support_link_text"), new_feedback_report_url)).html_safe %>
+    <%= t(".activation_support.html", support_link: style_link(t(".activation_support.support_link_text"), new_feedback_report_url)) %>


Like slavalamp said, please update all link variables and keys in this email to conform to our i18n standards for hyperlinks:

Suggested change

<%= t(".activation_support.html", support_link: style_link(t(".activation_support.support_link_text"), new_feedback_report_url)) %>

<%= t(".activation_support.html", contact_support_link: style_link(t(".activation_support.contact_support"), new_feedback_report_url)) %>

Bilka2 · 2025-12-08T12:57:10Z

app/views/user_mailer/invitation.html.erb

    <% if !@user_name.blank? %>
-      <%= t(".has_invited", user_name: style_bold(@user_name)).html_safe %>
+      <%= t(".has_invited.html", user_name: style_bold(@user_name)) %>


We prefer username without a space, please update these variables here for that

Bilka2 · 2025-12-08T13:01:26Z

config/locales/mailers/en.yml

      subject: "[%{app_name}][%{collection_title}] Invalid sign-ups found"
    invitation:
+      about:
+        html: The Archive of Our Own (AO3) is a free, noncommercial archive built by and for fans. Our servers are owned by our parent nonprofit, the %{otw_link}, which works to protect fan rights and preserve fanworks. We welcome all kinds of fanworks, including fanfiction, fanart, fanvids, and podfic from any fandom.


In all these strings, please replace "AO3" with the %{app_name} variable and set that to ArchiveConfig.APP_SHORT_NAME instead of using AO3 directly (refer the general i18n guidelines). Same goes for the longform Archive of Our Own, it should be using a variable that is set to ArchiveConfig.APP_NAME

Bilka2 · 2025-12-08T13:06:42Z

test/mailers/previews/user_mailer_preview.rb


+  # URL: /rails/mailers/user_mailer/invitation
+  def invitation_by_other_user
+    inviting_user = create(:user)


Please give this user the for_mailer_preview trait.

Bilka2 · 2025-12-08T13:08:28Z

config/locales/mailers/en.yml

+      faq:
        faq_link_text: our FAQ
+        html: For more information, please check %{faq_link}.
+        text: For more information, please check %{faq_url}.


Please move the exact text to the new location without modifying it:

Suggested change

text: For more information, please check %{faq_url}.

text: 'For more information, please check our FAQ: %{faq_url}.'

Bilka2 · 2025-12-08T13:09:39Z

config/locales/mailers/en.yml

-        join: If you'd like to join us, please %{invitation_link}.
-        otw_link_text: Organization for Transformative Works
-        support_link_text: contact Support
+        text: If you'd like to join us, please follow this link to sign up %{invitation_url}.


Suggested change

text: If you'd like to join us, please follow this link to sign up %{invitation_url}.

text: 'If you''d like to join us, please follow this link to sign up: %{invitation_url}.'

Bilka2 · 2025-12-08T13:09:54Z

config/locales/mailers/en.yml

+      activation_support:
+        html: After you sign up, you'll receive an account activation email. If you do not receive this email after 48 hours, please %{support_link}.
+        support_link_text: contact Support
+        text: After you sign up, you'll receive an account activation email. If you do not receive this email after 48 hours, please %{support_url}.


Suggested change

text: After you sign up, you'll receive an account activation email. If you do not receive this email after 48 hours, please %{support_url}.

text: 'After you sign up, you''ll receive an account activation email. If you do not receive this email after 48 hours, please contact Support: %{support_url}.'

Bilka2 · 2025-12-08T13:11:30Z

config/locales/mailers/en.yml

+      has_invited:
+        html: "%{user_name} has invited you to join the Archive of Our Own!"
+        text: "%{user_name} has invited you to join the Archive of Our Own!"


Since this is the same text in both emails it can just be one key. If it needs the html suffix to avoid html_safe, make the key has_invited_html instead of giving it variants

Dcano-png added 2 commits November 29, 2025 10:40

AO3-7035 Add user and queue invitation mailer previews in user_mailer…

c8128a6

…_preview

AO3-1234 Remove html_safe from invitation mailer

7048e89

github-actions bot added the Awaiting Review label Nov 29, 2025

AO3-1234 Normalized I18n en files and fixed .join.txt message

d248a35

Bilka2 added the Priority: Low label Nov 29, 2025

Dcano-png added 8 commits November 29, 2025 17:30

AO3-1234 Fixed Rubocop flagged excess code and lines

edf5014

AO3-1234 Restored user for mailer preview in invitation preview

1a49796

AO3-7035 Previous Commits had Wrong Issue Number and Removal of User …

f853aaa

…Redundancy

AO3-7035 Restored to prior Normalized I18n Commit

3050af7

AO3-7035 Restored .join.txt message to include correct message

352193c

AO3-7035 Removed semicolon in .join.txt message

9f2ca85

AO3-7035 Added missing expected to find text in .about.text

9884d1f

AO3-7035 Normalized en.yml to i18n standards with command

ea71832

slavalamp reviewed Dec 2, 2025

View reviewed changes

config/locales/mailers/en.yml Outdated Show resolved Hide resolved

Dcano-png added 2 commits December 7, 2025 15:30

AO3-7035 Refactored link text keys to reside within their relevant se…

ffe6a7a

…ctions

AO3-7035 Normalized en.yml to i18n standards with command

a6ac3ea

Bilka2 requested changes Dec 8, 2025

View reviewed changes

Bilka2 added Reviewed: Action Needed and removed Awaiting Review labels Dec 8, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

AO3-7035 Add Invitation Mailer Previews and Refactored I18n Keys #5489

AO3-7035 Add Invitation Mailer Previews and Refactored I18n Keys #5489

Uh oh!

Dcano-png commented Nov 29, 2025

Uh oh!

Bilka2 commented Nov 29, 2025

Uh oh!

Uh oh!

Bilka2 left a comment

Uh oh!

Bilka2 Dec 8, 2025

Uh oh!

Bilka2 Dec 8, 2025

Uh oh!

Bilka2 Dec 8, 2025

Uh oh!

Bilka2 Dec 8, 2025

Uh oh!

Bilka2 Dec 8, 2025

Uh oh!

Bilka2 Dec 8, 2025

Uh oh!

Bilka2 Dec 8, 2025

Uh oh!

Bilka2 Dec 8, 2025

Uh oh!

Bilka2 Dec 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	<%= t(".activation_support.html", support_link: style_link(t(".activation_support.support_link_text"), new_feedback_report_url)) %>
	<%= t(".activation_support.html", contact_support_link: style_link(t(".activation_support.contact_support"), new_feedback_report_url)) %>

	text: For more information, please check %{faq_url}.
	text: 'For more information, please check our FAQ: %{faq_url}.'

	text: If you'd like to join us, please follow this link to sign up %{invitation_url}.
	text: 'If you''d like to join us, please follow this link to sign up: %{invitation_url}.'

	text: After you sign up, you'll receive an account activation email. If you do not receive this email after 48 hours, please %{support_url}.
	text: 'After you sign up, you''ll receive an account activation email. If you do not receive this email after 48 hours, please contact Support: %{support_url}.'

AO3-7035 Add Invitation Mailer Previews and Refactored I18n Keys #5489

Are you sure you want to change the base?

AO3-7035 Add Invitation Mailer Previews and Refactored I18n Keys #5489

Uh oh!

Conversation

Dcano-png commented Nov 29, 2025

Pull Request Checklist

Issue

Purpose

Changes Included

Credit

Uh oh!

Bilka2 commented Nov 29, 2025

Uh oh!

Uh oh!

Bilka2 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants