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

Conversation

shanechesnutt-ft
Copy link
Contributor

@shanechesnutt-ft shanechesnutt-ft commented Nov 22, 2024

🎫 Ticket

Link to the relevant ticket:
LG-14748

🛠 Summary of changes

Add a warning banner to the password reset email for users with a pending in-person enrollments.

Scenario: When the user does not have a pending in-person enrollment

  • Login through the oidc sinatra application selecting the Identity Verified level of service.
  • Create a new account
  • Logout
  • Attempt to reset the password of the user
  • Ensure the password reset email does not have the in-person warning banner.

Scenario: When the user has a pending in-person enrollment

  • Login through the oidc sinatra application selecting the Identity Verified level of service.
  • Create a new account
  • Complete the ID-IPP flow reaching the ready to verify page.
  • Logout
  • Attempt to reset the password of the user
  • Ensure the password reset email has the in-person warning banner.

(Regression Test) Scenario: When the user has a pending gpo enrollment

Note: You might have enable gpo flow from the environment vars

  • Login through the oidc sinatra application selecting the Identity Verified level of service.
  • Create a new account
  • Go through the remote flow and select "verify your address by mail instead" on the /verify/phone page
  • complete gpo flow
  • Logout
  • Attempt to reset the password of the user
  • Ensure the password reset email does not have the in-person warning banner.
  • Ensure the password reset email has the gpo warning banner.

👀 Screenshots

Updated Password Reset Email

English:

Screenshot 2024-11-25 at 3 06 19 PM

Spanish:

Screenshot 2024-11-25 at 3 11 53 PM

French:

Screenshot 2024-11-25 at 3 12 47 PM

Chinese:

Screenshot 2024-11-25 at 3 13 52 PM

Copy link
Contributor

Choose a reason for hiding this comment

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

These are legacy styles for older versions of alert in the design system. Can we use the updated styles instead (see warning.png and existing usage for IPP outage alerts.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same here. I will check with the designers.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Update: Designers agree that we should be going with the updated design. I will update this today!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated to the latest design

@@ -91,6 +91,18 @@ h6 {
}
}

.usa-alert-no-border {
Copy link
Contributor

Choose a reason for hiding this comment

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

Similarly, I think we should be using standard alert appearance and not adding this variation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree, I was just following what design wanted. I will check-in with the designers to see if using the existing designs for the alert will be okay. 👍🏻

@shanechesnutt-ft shanechesnutt-ft force-pushed the sc/LG-14748 branch 2 times, most recently from cb13119 to 6629d31 Compare November 25, 2024 19:54
@shanechesnutt-ft shanechesnutt-ft requested review from a team, kellular, WilliamBirdsall and rutvigupta-design and removed request for a team November 25, 2024 21:02
@rutvigupta-design rutvigupta-design removed the request for review from kellular November 25, 2024 21:03
Copy link

@rutvigupta-design rutvigupta-design left a comment

Choose a reason for hiding this comment

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

This LGTM! The spacing for the mailer alert component seems to be a bit different from the design system spec, so Shane and I have discussed and plan on handling this in a separate ticket.

@gina-yamada gina-yamada self-requested a review November 26, 2024 15:25
@gina-yamada
Copy link
Contributor

gina-yamada commented Nov 26, 2024

Testing Notes:
✅ Scenario: When the user does not have a pending in-person enrollment (new account- has not started any flow)

screenshot

Screenshot 2024-11-26 at 8 45 22 AM

✅ Scenario: When the user has a pending in-person enrollment

screenshot

Screenshot 2024-11-26 at 8 41 51 AM

✅ Scenario: (Regression Test) When the user has a pending gpo enrollment

screenshot

Screenshot 2024-11-26 at 8 56 31 AM

Just noting GPO flow has a warning banner in the flow
Screenshot 2024-11-26 at 8 55 12 AM

✅ Scenario: (Regression Test) When user has proofed via remote

screenshot

Screenshot 2024-11-26 at 9 01 33 AM

✅ Scenario: (Regression Test) When user started IPP (picked a PO) - has an establishing enrollment

I did not take a screenshot but warning banner does not show

<tbody>
<tr>
<td style="width:16px;">
<%= image_tag('email/warning.png', width: 16, height: 14, alt: '', style: 'margin-top: 5px;') %>
Copy link
Contributor

@gina-yamada gina-yamada Nov 26, 2024

Choose a reason for hiding this comment

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

I know there are many instances where alt text is blank but I still prefer we don't leave it blank. When I test with VoiceOver, it recognizes the image but our users don't have any context or knowledge about it. I think if we have an image, we should have alt text for our users and to be 508 compliant, see GSA resource here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@@ -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] },
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: Only if you are updating the code again- a note that this will temporary until translations come in would be nice

@gina-yamada gina-yamada self-requested a review November 26, 2024 16:49
Copy link
Contributor

@gina-yamada gina-yamada left a comment

Choose a reason for hiding this comment

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

Nice work Shane. I added a suggestions. Nothing is blocking.

@gina-yamada
Copy link
Contributor

gina-yamada commented Nov 26, 2024

I was testing more with VoiceOver. I notice the banner does not get read unless you know it is there and click on it. Page reads h1 first. I moved the banner below the h1 but it is still not getting read.

Also, I put your content in the table- no luck. It still skips to the h1.

I tested the GPO reset PW email. The information about PW reset is read without clicking on it. I am wondering if we should modify our design to be like GPO?

Maybe we merge as is and have design rework the mocks a bit?

@shanechesnutt-ft
Copy link
Contributor Author

I was testing more with VoiceOver. I notice the banner does not get read unless you know it is there and click on it. Page reads h1 first. I moved the banner below the h1 but it is still not getting read.

Also, I put your content in the table- no luck. It still skips to the h1.

I tested the GPO reset PW email. The information about PW reset is read without clicking on it. I am wondering if we should modify our design to be like GPO?

Maybe we merge as is and have design rework the mocks a bit?

Nice find Gina! I think this would also apply to other emails that have this type of banner... so we might need an entire re-work for ID-IPP/EIPP emails.

changelog: User-facing Improvements, In-person Proofing, Add warning banner to password reset email when the user has an in-progress in-person enrollment
<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

@shanechesnutt-ft shanechesnutt-ft marked this pull request as ready for review November 27, 2024 15:17
@@ -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! 🚀

@gina-yamada
Copy link
Contributor

Thanks for addressing my comments. Looks good to me.

@shanechesnutt-ft shanechesnutt-ft merged commit 247ce08 into main Nov 27, 2024
2 checks passed
@shanechesnutt-ft shanechesnutt-ft deleted the sc/LG-14748 branch November 27, 2024 15:48
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.

5 participants