[CP Staging] add validate code modal #48628

hungvu193 · 2024-09-05T09:42:37Z

We recently need a reusable component to verify the magic code, this PR introduces ValidateCodeActionModal which is a modal that includes a magic code input that can be reused between flows.

Details

Fixed Issues

$ #48541
PROPOSAL: N/A

Tests

For Card reveal details:
Prerequisite: Your account has an Expensify physical card setup

Go to Profile => Wallet => Click on the Reveal details button.
Enter the magic code input.
Verify that you can see your card details if you entered correct magic code.

For adding new contact method:

Go to Profile.
Go to Contact methods.
Click “Add new contact method”.
Enter a new email or phone number and press Enter.
Verify that you are navigated to magic code verification page
Once the magic code is inserted, click Submit
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

QA Steps

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

marcaaron · 2024-09-05T23:50:18Z

Thanks. Gonna pull this branch and test a few things locally.

src/components/ValidateCodeActionModal/index.tsx

melvin-bot · 2024-09-06T03:03:22Z

@marcaaron One of you needs to 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]

hungvu193 · 2024-09-06T03:15:16Z

@getusha I also replaced ValidateContactActionPage with ValidateCodeActionModal in this PR, so please test adding new contact method flow carefully and let me know if you have any issue.
If everything is ok, we can use ValidateContactActionPage everywhere instead of duplicating BaseValidateCodeForm everytime.

mountiny

Looking to test this also on the adhoc build

src/components/ValidateCodeActionModal/type.ts

src/libs/actions/User.ts

github-actions · 2024-09-06T11:23:59Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/48628/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/48628/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/48628/NewExpensify.dmg	https://48628.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

mountiny · 2024-09-06T16:48:53Z

@marcaaron @hungvu193 I have tested this, and it works 🎉 not add recording because, duh, but the validation seems to pass for any validation code now. Is that expected for now? @marcaaron

hungvu193 · 2024-09-06T16:54:49Z

It's the same for Adding new contact method 🤔 we will always navigate back to contact method list after entering magic code, but not sure we should also do it here.

marcaaron · 2024-09-06T21:16:30Z

Yep, to clarify, that's expected. We will switch it on in https://github.com/Expensify/Web-Secure/pull/2740 and be able to QA this properly before shipping the change. Then we can force users to upgrade to the next version around the same time as deploying Web-Secure.

Since @getusha hasn't reviewed yet I'll go ahead and do the checklist on this one.

marcaaron · 2024-09-06T21:17:44Z

I think we still need copy to be confirmed as well? Mentioned it here. I'll add a label to get some help with that.

marcaaron · 2024-09-06T21:26:31Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

marcaaron · 2024-09-06T21:27:07Z

@hungvu193 can you please make the changes requested by @mountiny? Thanks!

marcaaron · 2024-09-06T21:35:00Z

And also the copy changes requested here.

Co-authored-by: Vit Horacek <36083550+mountiny@users.noreply.github.com>

…93/App into feat/validate-code-modal

hungvu193 · 2024-09-07T06:18:35Z

Sure. I've just addressed all the comments.

hungvu193 · 2024-09-07T06:23:55Z

Requested a translation on slack:
https://expensify.slack.com/archives/C01GTK53T8Q/p1725690186932629

marcaaron · 2024-09-08T16:55:59Z

Let's CP this one?

OSBotify · 2024-09-08T17:05:43Z

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

add validate code modal (cherry picked from commit aaa60b9) (CP triggered by mountiny)

ntdiary · 2024-09-18T13:37:05Z

src/pages/settings/Profile/Contacts/NewContactMethodPage.tsx

+                validatePendingAction={pendingContactAction?.pendingFields?.actionVerified}
+                validateError={validateLoginError}
+                handleSubmitForm={addNewContactMethod}
+                clearError={() => User.clearContactMethodErrors(contactMethod, 'validateLogin')}


Hi, @hungvu193, If I register with a phone number, when I add a new contact method, this clearContactMethodErrors will add a new record into the loginList. Is this behavior intentional? (because the value of account.primaryLogin is the phone number at that point.)

@ntdiary it came from this PR:

#48320

I think Yes because right now on the new Adding Contact Method flow we will need to verify magic code first so we need to save the temporary contact method to submit it later. Is there any issue with it?

Oh wait. I think I misunderstood the question. I'll need my laptop to take a look 🥲

Eh, What I'm confused about is: the new contact I actually wanted to add is 2471314+21@gmail.com, but it seems that clearContactMethodErrors unexpectedly added a record with +13393011884 to the loginList. 😂

Yeap that's pretty weird. I think it shouldn't add a new contact method into loginList but let me grab my laptop and see what I find.

I'm trying to signup with phone number but I can't receive the magic code :( . Can you check the verbose to see where does that contact method come from? (Probably Pusher event).

test.mp4

App/src/components/ValidateCodeActionModal/ValidateCodeForm/BaseValidateCodeForm.tsx

Lines 131 to 137 in b7c0055

useEffect(() => {

if (!validateError) {

return;

}

clearError();

// eslint-disable-next-line react-compiler/react-compiler, react-hooks/exhaustive-deps

}, [clearError, validateError]);

App/src/pages/settings/Profile/Contacts/NewContactMethodPage.tsx

Lines 150 to 152 in b7c0055

validateError={validateLoginError}

handleSubmitForm={addNewContactMethod}

clearError={() => User.clearContactMethodErrors(contactMethod, 'validateLogin')}

validateLoginError is empty object, so when BaseValidateCodeForm is mounted, clearError (i.e., clearContactMethodErrors) is automatically called. And because the value of contactMethod (i.e., account.primaryLogin) is +13393011884, clearContactMethodErrors adds that phone number to the loginList instead of using the existing +13393011884@expensify.sms key.

BTW, I don't have a phone number either, just generated some randomly with this url, and no magic code is required when signing up with a new phone number. 😂

I see. So I think we should check _isEmpty(validateError) instead of using !validateError. We will fix it in this PR

I'm afraid that's not enough, clearError is also called when the modal is closed.

App/src/libs/actions/User.ts

Lines 285 to 288 in 8d645bf

/**

* Clears any possible stored errors for a specific field on a contact method

*/

function clearContactMethodErrors(contactMethod: string, fieldName: string) {

Perhaps we need to ensure that the contactMethod string contains the SMS domain.
account.primaryLogin is just a phone number +13393011884, while the correct key in loginList is +13393011884@expensify.sms.
We have a function addSMSDomainIfPhoneNumber that might help, which can add the SMS domain to the phone number. :)

Thanks for your advice 💯 . I'll keep that in mind.

sobitneupane · 2024-12-05T12:26:15Z

This issue was missed while implementing the feature.

Issue: Copilot - Clicking outside magic code RHP does not dismiss the RHP entirely

Steps to reprodue:

Go to Settings > Security > Add copilot
Select a user > Next.
Select an access level > Next.
Click Add copilot.
Click outside the RHP to dismiss it.

hungvu193 added 4 commits September 5, 2024 16:42

add validate code modal

f9a20e3

replace ValidateContactActionPage

778c68b

remove console.log

4582516

add ValidateCodeModal into ExpensifyCardPage

541f282

hungvu193 mentioned this pull request Sep 5, 2024

[HOLD for payment 2024-09-18] Update the Magic code form to be easier to reuse in other flows and add it to Reveal card details flow #48541

Closed

4 tasks

lint

ae40d6a

marcaaron assigned hungvu193 Sep 5, 2024

marcaaron self-requested a review September 5, 2024 23:49

hungvu193 added 3 commits September 6, 2024 09:54

update translation

2cc3b95

update contact method translations for NewContactMethodPage

5022fa8

update docs

35d064c

hungvu193 commented Sep 6, 2024

View reviewed changes

src/components/ValidateCodeActionModal/index.tsx Outdated Show resolved Hide resolved

hungvu193 marked this pull request as ready for review September 6, 2024 03:03

hungvu193 requested a review from a team as a code owner September 6, 2024 03:03

melvin-bot bot requested review from getusha and mountiny September 6, 2024 03:03

melvin-bot bot removed the request for review from a team September 6, 2024 03:03

merge main

7578c92

mountiny added Ready To Build InternalQA This pull request required internal QA labels Sep 6, 2024

mountiny reviewed Sep 6, 2024

View reviewed changes

marcaaron removed the request for review from getusha September 6, 2024 21:16

hungvu193 and others added 5 commits September 7, 2024 13:04

Update src/components/ValidateCodeActionModal/type.ts

cdcd287

Co-authored-by: Vit Horacek <36083550+mountiny@users.noreply.github.com>

Update src/components/ValidateCodeActionModal/type.ts

3915b4b

Co-authored-by: Vit Horacek <36083550+mountiny@users.noreply.github.com>

update js docs and remove FullScreenLoadingIndicator

e1d133b

Merge branch 'feat/validate-code-modal' of https://github.com/hungvu1…

d88b0c3

…93/App into feat/validate-code-modal

Merge remote-tracking branch 'origin/main' into feat/validate-code-modal

5296333

marcaaron approved these changes Sep 8, 2024

View reviewed changes

marcaaron merged commit aaa60b9 into Expensify:main Sep 8, 2024
15 checks passed

marcaaron changed the title ~~add validate code modal~~ [CP Staging] add validate code modal Sep 8, 2024

OSBotify pushed a commit that referenced this pull request Sep 9, 2024

Merge pull request #48628 from hungvu193/feat/validate-code-modal

86cdee7

add validate code modal (cherry picked from commit aaa60b9) (CP triggered by mountiny)

github-actions bot added the CP Staging marks PRs that have been CP'd to staging label Sep 9, 2024

mountiny mentioned this pull request Sep 9, 2024

Deploy Checklist: New Expensify 2024-09-05 #48664

Closed

69 tasks

jjcoffee mentioned this pull request Sep 12, 2024

[PAID] [$250] Wallet empty state has disabled "Add bank account" button for new, unvalidated accounts #48041

Closed

6 tasks

ntdiary reviewed Sep 18, 2024

View reviewed changes

ntdiary mentioned this pull request Sep 18, 2024

fix: Remove GBR from the account settings on initial signup. #49004

Merged

50 tasks

daledah mentioned this pull request Sep 18, 2024

fix: requires validate when opening bank account #49230

Merged

50 tasks

This was referenced Sep 19, 2024

Refactor: reuse ValidateCodeActionModal #49445

Merged

[$325] Android - Profile - Add contact method flow resumes at magic code page after killing app #48498

Closed

getusha mentioned this pull request Oct 6, 2024

[HOLD for payment 2024-10-03] [$250] Wallet - Verify button does not show loading indicator after entering magic code #49073

Closed

6 tasks

sobitneupane mentioned this pull request Dec 5, 2024

[HOLD for payment 2024-11-29] [$125] Copilot - Clicking outside magic code RHP does not dismiss the RHP entirely #51272

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CP Staging] add validate code modal #48628

[CP Staging] add validate code modal #48628

hungvu193 commented Sep 5, 2024 •

edited

Loading

marcaaron commented Sep 5, 2024

melvin-bot bot commented Sep 6, 2024 •

edited by marcaaron

Loading

hungvu193 commented Sep 6, 2024

mountiny left a comment

github-actions bot commented Sep 6, 2024

mountiny commented Sep 6, 2024

hungvu193 commented Sep 6, 2024

marcaaron commented Sep 6, 2024

marcaaron commented Sep 6, 2024

marcaaron commented Sep 6, 2024 •

edited

Loading

marcaaron commented Sep 6, 2024

marcaaron commented Sep 6, 2024

hungvu193 commented Sep 7, 2024

hungvu193 commented Sep 7, 2024

marcaaron commented Sep 8, 2024

OSBotify commented Sep 8, 2024

ntdiary Sep 18, 2024 •

edited

Loading

hungvu193 Sep 18, 2024

hungvu193 Sep 18, 2024

ntdiary Sep 18, 2024

hungvu193 Sep 18, 2024

hungvu193 Sep 18, 2024

ntdiary Sep 18, 2024

hungvu193 Sep 19, 2024

ntdiary Sep 19, 2024 •

edited

Loading

hungvu193 Sep 19, 2024

sobitneupane commented Dec 5, 2024

	useEffect(() => {
	if (!validateError) {
	return;
	}
	clearError();
	// eslint-disable-next-line react-compiler/react-compiler, react-hooks/exhaustive-deps
	}, [clearError, validateError]);

	validateError={validateLoginError}
	handleSubmitForm={addNewContactMethod}
	clearError={() => User.clearContactMethodErrors(contactMethod, 'validateLogin')}

	/**
	* Clears any possible stored errors for a specific field on a contact method
	*/
	function clearContactMethodErrors(contactMethod: string, fieldName: string) {

[CP Staging] add validate code modal #48628

[CP Staging] add validate code modal #48628

Conversation

hungvu193 commented Sep 5, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

marcaaron commented Sep 5, 2024

melvin-bot bot commented Sep 6, 2024 • edited by marcaaron Loading

hungvu193 commented Sep 6, 2024

mountiny left a comment

Choose a reason for hiding this comment

github-actions bot commented Sep 6, 2024

mountiny commented Sep 6, 2024

hungvu193 commented Sep 6, 2024

marcaaron commented Sep 6, 2024

marcaaron commented Sep 6, 2024

marcaaron commented Sep 6, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

marcaaron commented Sep 6, 2024

marcaaron commented Sep 6, 2024

hungvu193 commented Sep 7, 2024

hungvu193 commented Sep 7, 2024

marcaaron commented Sep 8, 2024

OSBotify commented Sep 8, 2024

ntdiary Sep 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ntdiary Sep 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sobitneupane commented Dec 5, 2024

hungvu193 commented Sep 5, 2024 •

edited

Loading

melvin-bot bot commented Sep 6, 2024 •

edited by marcaaron

Loading

marcaaron commented Sep 6, 2024 •

edited

Loading

ntdiary Sep 18, 2024 •

edited

Loading

ntdiary Sep 19, 2024 •

edited

Loading