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

Fix send code validation #47772

Open
wants to merge 70 commits into
base: main
Choose a base branch
from

Conversation

teneeto
Copy link
Contributor

@teneeto teneeto commented Aug 21, 2024

Details

This PR fixes issue with sending email validation link. When a user triggers email validation from profile, the magic sign-in code isn't sent immediately till you have to trigger Didn't receive a magic code?. This PR is raise to fix a reverted code merge #46846

Fixed Issues

$: 41330
PROPOSAL: issuecomment

Tests

Verifying newly added account

  1. Make sure you are Logged out of both NewDot and OldDot
  2. Navigate to OldDot https://staging.expensify.com/
  3. In the login screen enter a new gmail account (make sure it's a gmail account as my work email didn't work)
  4. Verify you're navigated to staging NewDot
  5. Navigate to account Settings > profile > Contact methods
  6. Click on the email
  7. Verify you're prompted for the magic code to validate the account
  8. Verify the account receives a magic code to their email inbox
  9. Enter the magic code in the field
  10. Click on Verify

Adding a Secondary Contact

  1. add a new contact method
  2. clicking on "add" button should take you to validate code form
  3. Clicking on a contact in the contact methods should trigger a validate code request

Expectation: The validation link is sent first time, and user is not logged out when magic code is entered.

  • Verify that no errors appear in the JS console

Offline tests

Verifying newly added account

  1. Make sure you are Logged out of both NewDot and OldDot
  2. Navigate to OldDot https://staging.expensify.com/
  3. In the login screen enter a new gmail account (make sure it's a gmail account as my work email didn't work)
  4. Verify you're navigated to staging NewDot
  5. Navigate to account Settings > profile > Contact methods
  6. Click on the email
  7. Verify you're prompted for the magic code to validate the account
  8. Verify the account receives a magic code to their email inbox
  9. Enter the magic code in the field
  10. Click on Verify

Adding a Secondary Contact

  1. add a new contact method
  2. clicking on "add" button should take you to validate code form
  3. Clicking on a contact in the contact methods should trigger a validate code request

Expectation: The validation link is sent first time, and user is not logged out when magic code is entered.

QA Steps

Verifying newly added account

  1. Make sure you are Logged out of both NewDot and OldDot
  2. Navigate to OldDot https://staging.expensify.com/
  3. In the login screen enter a new gmail account (make sure it's a gmail account as my work email didn't work)
  4. Verify you're navigated to staging NewDot
  5. Navigate to account Settings > profile > Contact methods
  6. Click on the email
  7. Verify you're prompted for the magic code to validate the account
  8. Verify the account receives a magic code to their email inbox
  9. Enter the magic code in the field
  10. Click on Verify

Adding a Secondary Contact

  1. add a new contact method
  2. clicking on "add" button should take you to validate code form
  3. Clicking on a contact in the contact methods should trigger a validate code request

Expectation: The validation link is sent first time, and user is not logged out when magic code is entered.

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

MacOS: Chrome / Safari
Screen.Recording.2024-08-21.at.08.35.06.mov
iOS: Native
Android: Native
Android: mWeb Chrome
iOS: mWeb Safari
MacOS: Desktop

@teneeto teneeto requested a review from a team as a code owner August 21, 2024 07:47
@melvin-bot melvin-bot bot requested review from nkuoch and removed request for a team August 21, 2024 07:48
Copy link

melvin-bot bot commented Aug 21, 2024

@nkuoch Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@teneeto
Copy link
Contributor Author

teneeto commented Aug 21, 2024

Hi @c3024, can we check for the update here.

Copy link
Contributor

@c3024 c3024 left a comment

Choose a reason for hiding this comment

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

Automation did not work. Commenting so that it appears on my K2.

Copy link
Contributor

@c3024 c3024 left a comment

Choose a reason for hiding this comment

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

Based on the clarification for case (2) here,

we need changes here,

Navigation.goBack(ROUTES.SETTINGS_CONTACT_METHODS.getRoute(backTo));

-     Navigation.goBack(ROUTES.SETTINGS_CONTACT_METHODS.getRoute(backTo));
+     Navigation.navigate(ROUTES.SETTINGS_CONTACT_METHOD_DETAILS.getRoute(contactMethod));

and here,

Navigation.goBack(ROUTES.SETTINGS_CONTACT_METHODS.getRoute(backTo));

-         Navigation.goBack(ROUTES.SETTINGS_CONTACT_METHODS.getRoute(backTo));
+    Navigation.navigate(ROUTES.SETTINGS_CONTACT_METHODS.getRoute(backTo));

@teneeto
Copy link
Contributor Author

teneeto commented Sep 3, 2024

Hi @c3024, let's check this again.

@c3024
Copy link
Contributor

c3024 commented Sep 3, 2024

The first change mentioned here for User.ts is required for sending code correctly for secondary contacts. This is not included in the PR. Otherwise the API request is made for sending code for the primary contact.

Here is the video showing this bug.

validateChromeBug.mp4

@teneeto
Copy link
Contributor Author

teneeto commented Sep 4, 2024

Hi @c3024, I haven't added that piece yet, seeing that there was a recent code change which removed navigation completely: https://github.com/Expensify/App/pull/48320/files#r1738644645

I'm still trying to figure out why that was done and what next to do. As it stands, adding that piece gives this flickering navigation behaviour as shown in the screen record

Screen.Recording.2024-09-04.at.14.26.25.mov

@c3024
Copy link
Contributor

c3024 commented Nov 5, 2024

Test 1 works well even on main.

With this PR, Test 2 fails at step 7. Two magic codes, one from the backend and one from the frontend, are received.

@teneeto
Copy link
Contributor Author

teneeto commented Nov 6, 2024

Ok let me have a look at step 2.

@teneeto
Copy link
Contributor Author

teneeto commented Nov 14, 2024

Hi @c3024

All test cases should pass now, thanks for your patience.

Screen.Recording.2024-11-14.at.13.47.17.mov

@teneeto
Copy link
Contributor Author

teneeto commented Nov 15, 2024

@c3024 can we check again?

@teneeto
Copy link
Contributor Author

teneeto commented Nov 18, 2024

@c3024 added a fix and resolved your comment.

@teneeto
Copy link
Contributor Author

teneeto commented Nov 19, 2024

Ping! ping!! @c3024

@teneeto
Copy link
Contributor Author

teneeto commented Nov 20, 2024

@c3024 can we check this one again

@c3024
Copy link
Contributor

c3024 commented Nov 20, 2024

Sorry, I missed the tag. Checking today.

@c3024
Copy link
Contributor

c3024 commented Nov 21, 2024

In the new contact adding flow, when we validate the primary contact, the secondary contact should be added to the contact methods.

Previously, when validating the primary contact using the magic code in the new contact method flow, the app navigated to the ContactMethodsPage.

Now, it navigates to the ContactMethodDetails page, allowing the user to go back without validating the secondary contact. If the user goes back again to the primary contact validation code page, the newly added but not yet validated secondary contact is removed locally

User.clearContactMethod(pendingContactAction?.contactMethod);

and does not appear in the ContactMethodsPage.

On this branch compared to staging:

contactNotInContactMethodsPage.mp4

The secondary contact method is still written to the backend, so it reappears after logging out and logging back in:

logOutAndLogin.mp4

@waterim
Copy link
Contributor

waterim commented Nov 29, 2024

@c3024 Should work fine now

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.

6 participants