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

feat: validate new contact method action #48320

Merged
merged 12 commits into from
Sep 2, 2024

Conversation

getusha
Copy link
Contributor

@getusha getusha commented Aug 30, 2024

Details

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/423805
PROPOSAL:

Tests

  1. Go to Settings
  2. Go to Profile
  3. Go to Contact methods
  4. Click “Add new contact method”
  5. Enter new email or phone number
  6. Verify that you are navigated to magic code verification page
  7. Once the magic code is inserted, click Submit
  8. Verify that the contact is added and you're navigated to contact list page
  • Verify that no errors appear in the JS console

Offline tests

  1. Go to Settings
  2. Go to Profile
  3. Go to Contact methods
  4. Click “Add new contact method”
  5. Verify that the "Add" button is disabled

QA Steps

NOTE: The magic code verification does not work yet so no matter what magic code number you put in, it will succeed

  1. Go to Settings
  2. Go to Profile
  3. Go to Contact methods
  4. Click “Add new contact method”
  5. Enter new email or phone number
  6. Verify that you are navigated to magic code verification page
  7. Once the magic code is inserted, click Submit
  8. Verify that the contact is added and you're navigated to contact list page
  • 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

Android: Native
Screen.Recording.2024-08-31.at.11.17.09.in.the.morning.mov
Android: mWeb Chrome
Screen.Recording.2024-08-30.at.7.48.30.in.the.evening.mov
iOS: Native
Screen.Recording.2024-08-30.at.7.55.19.in.the.evening.mov
iOS: mWeb Safari
Screen.Recording.2024-08-30.at.5.30.34.in.the.afternoon.mov
MacOS: Chrome / Safari
Screen.Recording.2024-08-30.at.5.17.13.in.the.afternoon.mov
MacOS: Desktop
Screen.Recording.2024-08-30.at.5.31.36.in.the.afternoon.mov

@hungvu193
Copy link
Contributor

Thanks for assigning. I'll review this shortly

@hungvu193
Copy link
Contributor

Bug 1: User can spam Didn't receive magic code button,I think we should also implement countdown timer like login page

Screen.Recording.2024-08-30.at.21.33.22.mov

@getusha
Copy link
Contributor Author

getusha commented Aug 30, 2024

Bug 1: User can spam Didn't receive magic code button,I think we should also implement countdown timer like login page

Same as ContactMethodDetailsPage i think we should handle this separately.

@hungvu193
Copy link
Contributor

Bug 2: If you added a contact method before but not enter the magic code then exist the page, later when you press Add new contact method you will be redirected to ValidateContactActionPage page.

Screen.Recording.2024-08-30.at.21.38.43.mov

@hungvu193
Copy link
Contributor

hungvu193 commented Aug 30, 2024

Bug 3: A RBR will appear and can not be removed on the primary contact method.

Steps:

  1. Click add new contact method.
  2. Add any email, press Next
  3. Without entering any magic code, submit the form a few times.
  4. Notice that an RBR appears right next to the primary contact method.
Screenshot 2024-08-30 at 21 42 00

@hungvu193
Copy link
Contributor

I've never received any magic code even when I requested/ resent few times. Did you guys receive magic code input after ResendValidateCode was called?

@getusha
Copy link
Contributor Author

getusha commented Aug 30, 2024

I've never received any magic code even when I requested/ resent few times. Did you guys receive magic code input after ResendValidateCode was called?

Just did, make sure the email address you are trying to link doesn't have associated accounts.

Screenshot 2024-08-30 at 5 50 22 in the afternoon

@hungvu193
Copy link
Contributor

hungvu193 commented Aug 30, 2024

Bug 4: Click on close icon does not clear the error message.

Screen.Recording.2024-08-30.at.21.52.12.mov

We probably also want to clear the error when clicking Didn't receive the magic code?

@hungvu193
Copy link
Contributor

hungvu193 commented Aug 30, 2024

Bug 5: If you interrupt the api called on New Contact Method page, the loading indicator will be there forever.
Also even if it's loading we can still interact with it.

Screen.Recording.2024-08-30.at.21.55.14.mov

@hungvu193
Copy link
Contributor

Oh shoot :/ I got blocked because I requested so many times 😭 . I'll wait for a while then continue with my testing 😈

@getusha
Copy link
Contributor Author

getusha commented Aug 30, 2024

Oh shoot :/ I got blocked because I requested so many times 😭 . I'll wait for a while then continue with my testing 😈

I use a different email when that happens 😄

@hungvu193
Copy link
Contributor

Bug 6: New contact method page shows errors even there's no error.

Steps :

  1. Click add new contact method.
  2. Add any email, press Next
  3. Without entering any magic code, submit the form and request a new code a few times, until you saw the error Failed to send magic code.... Click back.
  4. Notice that on New Contact Method page, the error shows at the bottom.
Screen.Recording.2024-08-30.at.22.28.39.mov

@getusha
Copy link
Contributor Author

getusha commented Aug 30, 2024

Bug 2, bug 3, bug 4 (you should be able to see the error on the email form), bug 5

@hungvu193 could you recheck ^ bugs, now? thanks!

@hungvu193
Copy link
Contributor

Sure

@hungvu193
Copy link
Contributor

I still can reproduce the RBR bug by trying to request magic code few time at ValidateContactActionPage then go back to New Contact method page then press Next. Repeat few times.

Screen.Recording.2024-08-30.at.23.02.08.mov

Navigation.navigate(ROUTES.SETTINGS_CONTACT_METHODS.route);
}, [loginData, loginData?.pendingFields, loginList]);

useEffect(() => () => User.clearUnvalidatedNewContactMethodAction(), []);
Copy link
Contributor

Choose a reason for hiding this comment

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

Once user existed the page, we should also clear the error (RBR) as well.
Let's also add User.clearUnvalidatedNewContactMethodAction() as the return function.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Which function are you referring?

Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry. I mean the cleanup function of this useEffect.

@getusha
Copy link
Contributor Author

getusha commented Aug 31, 2024

@hungvu193 this is what i see trying to reproduce bug 5

Screen.Recording.2024-08-31.at.10.12.14.in.the.morning.mov

@hungvu193
Copy link
Contributor

Oh weird, after loging out and login again, I can't reproduce anymore :)

@hungvu193
Copy link
Contributor

hungvu193 commented Aug 31, 2024

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible 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 checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified tests pass on all platforms & I tested again on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (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
    • 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 verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • 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
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native Screenshot 2024-08-31 at 15 22 18
Android: mWeb Chrome
iOS: Native

// native error

iOS: mWeb Safari
Screen.Recording.2024-08-31.at.15.08.18.mov
MacOS: Chrome / Safari
Screen.Recording.2024-08-31.at.14.32.03.mov
MacOS: Desktop Screenshot 2024-08-31 at 14 55 12

@hungvu193
Copy link
Contributor

On mSafari, after entering the magic code, it still stay on ValidateContactActionPage. I tested it with Strict mode enabled.

Screen.Recording.2024-08-31.at.14.57.38.mov

@getusha
Copy link
Contributor Author

getusha commented Aug 31, 2024

On mSafari, after entering the magic code, it still stay on ValidateContactActionPage. I tested it with Strict mode enabled.

@hungvu193 could you logout & sign in again then retest?

Screen.Recording.2024-08-31.at.11.03.42.in.the.morning.mov

@hungvu193
Copy link
Contributor

On mSafari, after entering the magic code, it still stay on ValidateContactActionPage. I tested it with Strict mode enabled.

@hungvu193 could you logout & sign in again then retest?

I actually logged out before testing, but let me try again.

@hungvu193
Copy link
Contributor

hungvu193 commented Aug 31, 2024

Weird, I still can reproduce.
Nevermind, It worked after I cleared caches 🥲

Screen.Recording.2024-08-31.at.15.06.29.mov

Copy link
Contributor

@hungvu193 hungvu193 left a comment

Choose a reason for hiding this comment

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

All yours @mountiny

Copy link

melvin-bot bot commented Aug 31, 2024

🎯 @hungvu193, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #48374.

@mountiny
Copy link
Contributor

mountiny commented Sep 2, 2024

Thanks for the hustle, I will try to test with the backend changes later today

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

@getusha Thank you!

I think we will need to add some clean ups but for the sake of the urgency I think this is good to go and I would like to merge it before the deploy so we have it in staging tomorrow to unblock the backend changes

@getusha Could you look into the fixing the navigation when the user removes the optimistic login? The page goes to not found page because the contact method is in the URL. I think we need to redirect to the contact method list page

Screen.Recording.2024-09-02.at.22.00.17.mp4

/**
* Clears a contact method optimistically. this is used when the contact method fails to be added to the backend
*/

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change

@mountiny mountiny merged commit 2cb8354 into Expensify:main Sep 2, 2024
16 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Sep 2, 2024

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify
Copy link
Contributor

OSBotify commented Sep 2, 2024

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.28-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

@OSBotify
Copy link
Contributor

OSBotify commented Sep 3, 2024

🚀 Deployed to production by https://github.com/roryabraham in version: 9.0.28-3 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

Comment on lines +56 to +62
useEffect(() => {
if (!pendingContactAction?.validateCodeSent) {
return;
}

Navigation.navigate(ROUTES.SETINGS_CONTACT_METHOD_VALIDATE_ACTION);
}, [pendingContactAction]);
Copy link
Member

Choose a reason for hiding this comment

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

@getusha What is the purpose for this logic?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@parasharrajat We started requiring verification before adding a contact method. the new flow is temporarily save new contact > verify action > add the new contact method.

saveNewContactMethodAndRequestValidationCode just saves the contact method temporarily and requests a magic code, so this logic just navigates youValidateContactActionPage after the magic code is sent

validateCodeSent: true,

@parasharrajat
Copy link
Member

Is there a design doc for this PR? @hungvu193 @getusha

@getusha
Copy link
Contributor Author

getusha commented Sep 4, 2024

@parasharrajat there is no design doc but you can check this thread and this issue for more detail

@mountiny
Copy link
Contributor

mountiny commented Sep 4, 2024

No design doc for this, its an urgent change we require now to validate the primary login before taking certain actions, little more details in here #48541

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