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

LG-14748 Add in person warning to password reset email #11547

Merged
merged 1 commit into from
Nov 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion app/mailers/user_mailer.rb
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@ def reset_password_instructions(token:, request_id:)
@token = token
@request_id = request_id
@gpo_verification_pending_profile = user.gpo_verification_pending_profile?
@hide_title = @gpo_verification_pending_profile
@in_person_verification_pending_profile = user.in_person_pending_profile?
@hide_title = @gpo_verification_pending_profile || @in_person_verification_pending_profile
mail(to: email_address.email, subject: t('user_mailer.reset_password_instructions.subject'))
end
end
Expand Down
10 changes: 9 additions & 1 deletion app/views/user_mailer/reset_password_instructions.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,15 @@
<h1>
<%= @header || message.subject %>
</h1>
<% end %>
<% end %>

<% if @in_person_verification_pending_profile %>
<%= render 'user_mailer/shared/in_person_warning_banner' %>
<h1>
<%= @header || message.subject %>
</h1>
<% end %>

<p class="lead">
<%= t(
'user_mailer.reset_password_instructions.header',
Expand Down
11 changes: 11 additions & 0 deletions app/views/user_mailer/shared/_in_person_warning_banner.html.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<table class="usa-alert usa-alert--warning margin-bottom-4">
<tbody>
<tr>
<td style="width:16px;">
<%= image_tag('email/warning.png', width: 16, height: 14, alt: 'warning icon', style: 'margin-top: 5px;') %>
Copy link
Contributor

Choose a reason for hiding this comment

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

[non-blocking] do you think it would be better to use an svg here or is the png ok? I just saw the styling and thought maybe it would be a bit easier to work with as an svg.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We have to use pngs for email because svgs are not supported by most email clients.

see #10839 (comment)

Copy link
Contributor

@gina-yamada gina-yamada Nov 27, 2024

Choose a reason for hiding this comment

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

For the alt text, do you want to ask if we can get translations order for that? Else you can use
two_factor_authentication.important_alert_icon with is important alert icon

This is non- blocking

</td>
<td>
<p><%= t('user_mailer.reset_password_instructions.in_person_warning_description_html') %></p>
</td>
</tr>
</table>
1 change: 1 addition & 0 deletions config/locales/en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1942,6 +1942,7 @@ user_mailer.reset_password_instructions.footer: This link expires in %{expires}
user_mailer.reset_password_instructions.gpo_letter_description: If you reset your password, the verification code in your letter will no longer work and you’ll have to verify your identity again.
user_mailer.reset_password_instructions.gpo_letter_header: Your letter is on the way
user_mailer.reset_password_instructions.header: To finish resetting your password, please click the link below or copy and paste the entire link into your browser.
user_mailer.reset_password_instructions.in_person_warning_description_html: <strong>If you reset your password now, your barcode will not work at the Post Office.</strong> You’ll have to restart the identity verification process from the beginning.
user_mailer.reset_password_instructions.link_text: Reset your password
user_mailer.reset_password_instructions.subject: Reset your password
user_mailer.signup_with_your_email.help_html: If you did not request a new account or suspect an error, please visit the %{app_name_html} %{help_link_html} or %{contact_link_html}.
Expand Down
1 change: 1 addition & 0 deletions config/locales/es.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1954,6 +1954,7 @@ user_mailer.reset_password_instructions.footer: Este vínculo vence en %{expires
user_mailer.reset_password_instructions.gpo_letter_description: Si restablece su contraseña, el código de verificación que recibió en su carta ya no funcionará y tendrá que volver a verificar su identidad.
user_mailer.reset_password_instructions.gpo_letter_header: Su carta está en camino
user_mailer.reset_password_instructions.header: Para terminar de restablecer su contraseña, haga clic en el enlace de abajo o copie y pegue el enlace completo en su navegador.
user_mailer.reset_password_instructions.in_person_warning_description_html: <strong>If you reset your password now, your barcode will not work at the Post Office.</strong> You’ll have to restart the identity verification process from the beginning.
user_mailer.reset_password_instructions.link_text: Restablezca su contraseña
user_mailer.reset_password_instructions.subject: Restablezca su contraseña
user_mailer.signup_with_your_email.help_html: Si usted no solicitó una cuenta nueva o sospecha que hubo un error, visite la %{help_link_html} de %{app_name_html} o %{contact_link_html}.
Expand Down
1 change: 1 addition & 0 deletions config/locales/fr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1942,6 +1942,7 @@ user_mailer.reset_password_instructions.footer: Ce lien expire dans %{expires} h
user_mailer.reset_password_instructions.gpo_letter_description: Si vous réinitialisez votre mot de passe, le code de vérification contenu dans votre lettre ne fonctionnera plus et vous devrez reconfirmer votre identité.
user_mailer.reset_password_instructions.gpo_letter_header: Votre lettre est en route
user_mailer.reset_password_instructions.header: Pour terminer la réinitialisation de votre mot de passe, veuillez cliquer sur le lien ci-dessous ou copier et coller le lien complet dans votre navigateur.
user_mailer.reset_password_instructions.in_person_warning_description_html: <strong>If you reset your password now, your barcode will not work at the Post Office.</strong> You’ll have to restart the identity verification process from the beginning.
user_mailer.reset_password_instructions.link_text: Réinitialiser votre mot de passe
user_mailer.reset_password_instructions.subject: Réinitialiser votre mot de passe
user_mailer.signup_with_your_email.help_html: Si vous n’avez pas demandé un nouveau compte ou soupçonnez qu’une erreur s’est produite, veuillez visiter le %{help_link_html} de %{app_name_html} ou %{contact_link_html}.
Expand Down
1 change: 1 addition & 0 deletions config/locales/zh.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1955,6 +1955,7 @@ user_mailer.reset_password_instructions.footer: 这一链接 %{expires} 小时
user_mailer.reset_password_instructions.gpo_letter_description: 如果你重设密码,信件中的一次性代码就会失效,你需要再次验证身份。
user_mailer.reset_password_instructions.gpo_letter_header: 你的信件已寄出。
user_mailer.reset_password_instructions.header: 要完成重设密码,请点击下面的链接或把整个链接复制并黏贴进浏览器。
user_mailer.reset_password_instructions.in_person_warning_description_html: <strong>If you reset your password now, your barcode will not work at the Post Office.</strong> You’ll have to restart the identity verification process from the beginning.
user_mailer.reset_password_instructions.link_text: 重设你的密码
user_mailer.reset_password_instructions.subject: 重设你的密码
user_mailer.signup_with_your_email.help_html: 如果你没有要求一封新电邮或怀疑有错, 请访问 %{app_name_html}的 %{help_link_html} 或者 %{contact_link_html}。
Expand Down
1 change: 1 addition & 0 deletions spec/i18n_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ class BaseTask
{ key: 'time.formats.event_timestamp', locales: %i[zh] },
{ key: 'time.formats.full_date', locales: %i[es] }, # format is the same in Spanish and English
{ key: 'time.formats.sms_date' }, # for us date format
{ key: 'user_mailer.reset_password_instructions.in_person_warning_description_html', locales: %i[es fr zh] }, # Temporary until spanish, french, and chinese translations come in.
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for the comment! 🚀

{ key: 'webauthn_platform_recommended.cta' }, # English-only A/B test
{ key: 'webauthn_platform_recommended.description_private_html' }, # English-only A/B test
{ key: 'webauthn_platform_recommended.description_secure_account' }, # English-only A/B test
Expand Down
21 changes: 21 additions & 0 deletions spec/mailers/previews/user_mailer_preview.rb
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,14 @@ def reset_password_instructions_with_pending_gpo_letter
)
end

def reset_password_instructions_with_pending_in_person_warning
UserMailer.with(
user: user_with_pending_in_person_profile, email_address: email_address_record,
).reset_password_instructions(
token: SecureRandom.hex, request_id: SecureRandom.hex,
)
end

def password_changed
UserMailer.with(user: user, email_address: email_address_record).
password_changed(disavowal_token: SecureRandom.hex)
Expand Down Expand Up @@ -313,6 +321,19 @@ def user_with_pending_gpo_letter
raw_user
end

def user_with_pending_in_person_profile
raw_user = user
in_person_pending_profile = unsaveable(
Profile.new(
user: raw_user,
active: false,
in_person_verification_pending_at: Time.zone.now,
),
)
raw_user.send(:instance_variable_set, :@pending_profile, in_person_pending_profile)
raw_user
end

def email_address
'[email protected]'
end
Expand Down
146 changes: 146 additions & 0 deletions spec/mailers/user_mailer_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,152 @@
end
end

describe '#reset_password_instructions' do
let(:token) { SecureRandom.hex }
let(:request_id) { SecureRandom.uuid }
let(:mail) do
UserMailer.with(
user: user,
email_address: email_address,
).reset_password_instructions(token:, request_id:)
end
let(:locale) { 'es' }

before do
I18n.locale = locale
end

it_behaves_like 'a system email'
it_behaves_like 'an email that respects user email locale preference'

context 'when the user has gpo verfication pending' do
let(:user) { create(:user, :with_pending_gpo_profile) }

it 'sends to the current email address' do
expect(mail.to).to eq [email_address.email]
end

it 'renders the subject' do
expect(mail.subject).to eq t('user_mailer.reset_password_instructions.subject')
end

it 'renders the gpo warning alert' do
expect(mail.html_part.body).to have_content(
t('user_mailer.reset_password_instructions.gpo_letter_description'),
)
end

it 'does not render the in person warning banner' do
expect(mail.html_part.body).not_to have_content(
strip_tags(
t('user_mailer.reset_password_instructions.in_person_warning_description_html'),
),
)
end

it 'renders the reset password instructions' do
expect(mail.html_part.body).to have_content(
t('user_mailer.reset_password_instructions.header'),
)
end

it 'renders the reset password button' do
expect(mail.html_part.body).to have_link(
t('user_mailer.reset_password_instructions.link_text'),
href: edit_user_password_url(
reset_password_token: token,
locale: locale,
request_id: request_id,
),
)
end
end

context 'when the user has in person verfication pending' do
let(:user) { create(:user, :with_pending_in_person_enrollment) }

it 'sends to the current email address' do
expect(mail.to).to eq [email_address.email]
end

it 'renders the subject' do
expect(mail.subject).to eq t('user_mailer.reset_password_instructions.subject')
end

it 'renders the in person warning banner' do
expect(mail.html_part.body).to have_content(
strip_tags(
t('user_mailer.reset_password_instructions.in_person_warning_description_html'),
),
)
end

it 'does not render the gpo warning alert' do
expect(mail.html_part.body).not_to have_content(
t('user_mailer.reset_password_instructions.gpo_letter_description'),
)
end

it 'renders the reset password instructions' do
expect(mail.html_part.body).to have_content(
t('user_mailer.reset_password_instructions.header'),
)
end

it 'renders the reset password button' do
expect(mail.html_part.body).to have_link(
t('user_mailer.reset_password_instructions.link_text'),
href: edit_user_password_url(
reset_password_token: token,
locale: locale,
request_id: request_id,
),
)
end
end

context 'when the user does not have any verification pending' do
it 'sends to the current email address' do
expect(mail.to).to eq [email_address.email]
end

it 'renders the subject' do
expect(mail.subject).to eq t('user_mailer.reset_password_instructions.subject')
end

it 'does not render the gpo warning alert' do
expect(mail.html_part.body).not_to have_content(
t('user_mailer.reset_password_instructions.gpo_letter_description'),
)
end

it 'does not render the in person warning banner' do
expect(mail.html_part.body).not_to have_content(
strip_tags(
t('user_mailer.reset_password_instructions.in_person_warning_description_html'),
),
)
end

it 'renders the reset password instructions' do
expect(mail.html_part.body).to have_content(
t('user_mailer.reset_password_instructions.header'),
)
end

it 'renders the reset password button' do
expect(mail.html_part.body).to have_link(
t('user_mailer.reset_password_instructions.link_text'),
href: edit_user_password_url(
reset_password_token: token,
locale: locale,
request_id: request_id,
),
)
end
end
end

describe '#password_changed' do
let(:mail) do
UserMailer.with(
Expand Down