fix: Add a step validate to the Issue New Card form #50864

nkdengineer · 2024-10-16T09:03:16Z

Details

Fixed Issues

$ #50667
PROPOSAL: #50667 (comment)

Tests

Create a new workspace
Connect back account and enable Expensify Card
Go to Expensify Card page
Click New Issue card button
Do the steps to step confirmation
Click Issue card button
Verify that: Validate Code modal is displayed
Enter magic code and verify that: redirects to true page and validateCode param is sent

Verify that no errors appear in the JS console

Offline tests

same as above

QA Steps

same as above

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.mov

Android: mWeb Chrome

android-mweb.mov

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

nkdengineer · 2024-10-16T17:38:46Z

I am a little stuck on the iOS builds, will add later

melvin-bot · 2024-10-16T17:38:54Z

@hungvu193 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]

hungvu193 · 2024-10-17T02:52:37Z

Code wise LGTM, but let's hold for #50667 (comment) a little bit 😄

hungvu193 · 2024-10-22T02:35:49Z

Let's merge main 😄 This one can be off hold.

hungvu193 · 2024-10-23T07:24:30Z

Hey @nkdengineer, can you also handle the case when the user enter wrong validate code?

nkdengineer · 2024-10-23T07:34:08Z

@hungvu193 i'll update soon

nkdengineer · 2024-10-23T08:55:19Z

@hungvu193 as the solution mention here, we will send the validateCode with the CreateAdminIssuedVirtualCard API, and that API will be responsible for checking whether the validateCode is correct or not, right?

hungvu193 · 2024-10-23T08:57:41Z

@hungvu193 as the solution mention here, we will send the validateCode with the CreateAdminIssuedVirtualCard API, and that API will be responsible for checking whether the validateCode is correct or not, right?

Yes. If the API still return successful response with invalid code, then we will need BE changes

hungvu193 · 2024-10-23T16:27:59Z

It looks like we still need to merge the FE's PR first. Let's add the generic error message to failure data for now and handle it from there 😄

nkdengineer · 2024-10-25T17:57:42Z

@hungvu193 i don't know what I should really do here. Can i do like in NewContactMethodPage component?

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

Lines 165 to 177 in 2db49d4

    
           clearError={() => { 
        
               if (!loginData) { 
        
                   return; 
        
               } 
        
               User.clearContactMethodErrors(addSMSDomainIfPhoneNumber(pendingContactAction?.contactMethod ?? contactMethod), 'addedLogin'); 
        
           }} 
        
           onClose={() => { 
        
               if (loginData?.errorFields && pendingContactAction?.contactMethod) { 
        
                   User.clearContactMethod(pendingContactAction?.contactMethod); 
        
                   User.clearUnvalidatedNewContactMethodAction(); 
        
               } 
        
               setIsValidateCodeActionModalVisible(false); 
        
           }}

nkdengineer · 2024-10-29T03:06:09Z

@hungvu193 friendly bump here

hungvu193 · 2024-10-29T09:43:11Z

@hungvu193 i don't know what I should really do here. Can i do like in NewContactMethodPage component?

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

Lines 165 to 177 in 2db49d4

clearError={() => {

if (!loginData) {

return;

}

User.clearContactMethodErrors(addSMSDomainIfPhoneNumber(pendingContactAction?.contactMethod ?? contactMethod), 'addedLogin');

}}

onClose={() => {

if (loginData?.errorFields && pendingContactAction?.contactMethod) {

User.clearContactMethod(pendingContactAction?.contactMethod);

User.clearUnvalidatedNewContactMethodAction();

}

setIsValidateCodeActionModalVisible(false);

}}

I think it will be slightly different. Btw, optimistic failure data was added in this PR 😄 , so we don't need to do it anymore.

I think the suggestion changes here will be correct the validateError and clearError props.

hungvu193 · 2024-10-29T09:54:07Z

You can also improve the loading logic of ValidateCodeForm, right now loading is depended on account.isLoading but it's incorrect in this case.

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

Line 236 in 2463bf7

isLoading={account?.isLoading}

hungvu193 · 2024-11-01T16:50:40Z

@nkdengineer do you have any questions?

nkdengineer · 2024-11-04T16:03:25Z

You can also improve the loading logic of ValidateCodeForm, right now loading is depended on account.isLoading but it's incorrect in this case.

@hungvu193 how can I improve this logic in this case? Please give me some suggestions

hungvu193 · 2024-11-05T02:28:52Z

You can add a new props into ValidateCodeActionModal call isLoading.

Here's the example:
https://github.com/Expensify/App/pull/51135/files#diff-5a75ff8b317bf0b6472287731f466dbe6a71b34d2417aaac848a66ee88d397b4

In this PR, we can use the isLoading property from ONYXKEYS.ISSUE_NEW_EXPENSIFY_CARD

nkdengineer · 2024-11-05T08:51:54Z

@hungvu193 Thanks for the suggestion, I updated

src/pages/workspace/expensifyCard/issueNew/ConfirmationStep.tsx

hungvu193 · 2024-11-09T04:09:02Z

I encountered this issue while testing this PR, when ValidateCodeActionModal shows up, if I press any number, the modal dismissed.

Screen.Recording.2024-11-09.at.11.04.13.mov

Also, you can test the failed case by enabling Simulate failing network requests and setting MAX_REQUEST_RETRIES to 1 (or 0).

nkdengineer · 2024-11-09T15:43:50Z

I'm investigating

nkdengineer · 2024-11-09T18:38:49Z

thanks @hungvu193, i fixed

hungvu193 · 2024-11-10T05:47:05Z

I'll review again today

src/pages/workspace/expensifyCard/issueNew/ConfirmationStep.tsx

hungvu193 · 2024-11-10T09:40:56Z

Found 2 issues:

Sometimes ValidateActionCodeModal got dismissed right after I pressed IssueCard

Screen.Recording.2024-11-10.at.16.37.30.mov

CreateExpensifyCard was called successfully, however the modal was not dismissed and it's loading infinitely.

Screen.Recording.2024-11-10.at.16.37.48.mov

Co-authored-by: Hans <[email protected]>

nkdengineer · 2024-11-11T04:03:54Z

CreateExpensifyCard was called successfully, however the modal was not dismissed and it's loading infinitely.

This problem also occurs in the login form when we call the API and get the status 429 too many requests

bug-login.mov

nkdengineer · 2024-11-11T04:05:20Z

Sometimes ValidateActionCodeModal got dismissed right after I pressed IssueCard

I tried many times and couldn't reproduce it

hungvu193 · 2024-11-11T07:00:32Z

CreateExpensifyCard was called successfully, however the modal was not dismissed and it's loading infinitely.

This problem also occurs in the login form when we call the API and get the status 429 too many requests

bug-login.mov

tbh, I don't see any 429 error.

Screen.Recording.2024-11-11.at.13.58.47.mov

hungvu193 · 2024-11-11T07:05:16Z

Sometimes ValidateActionCodeModal got dismissed right after I pressed IssueCard

I tried many times and couldn't reproduce it

I just realized that you need to reproduce the first bug (infinite loading) to reproduce this one, after dismissing the infinite validate code action modal, next time when you issue a new card, this bug will happen.

Screen.Recording.2024-11-11.at.14.02.50.mov

nkdengineer · 2024-11-11T16:18:28Z

I'm investigating

nkdengineer · 2024-11-13T04:17:00Z

@hungvu193 after merging main i can't reproduce bug anymore, please help me check again

hungvu193 · 2024-11-13T07:08:37Z

Yeah I can't reproduce it anymore 🤔. It seems it was fixed on another PR.

hungvu193 · 2024-11-13T07:11:49Z

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 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

Screen.Recording.2024-11-13.at.14.43.38.mov

Android: mWeb Chrome

Screen.Recording.2024-11-13.at.15.09.27.mov

iOS: Native

Screen.Recording.2024-11-13.at.14.34.30.mov

iOS: mWeb Safari

Screen.Recording.2024-11-13.at.14.09.15.mov

MacOS: Chrome / Safari

Screen.Recording.2024-11-13.at.14.07.43.mov

MacOS: Desktop

Screen.Recording.2024-11-13.at.14.11.13.mov

hungvu193 · 2024-11-13T07:12:41Z

src/pages/workspace/expensifyCard/issueNew/ConfirmationStep.tsx

+                <ValidateCodeActionModal
+                    handleSubmitForm={submit}
+                    isLoading={issueNewCard?.isLoading}
+                    sendValidateCode={() => User.requestValidateCodeAction()}


Let's add hasMagicCodeBeenSent props here to make it consistent with other places.

@hungvu193 i updated

OSBotify · 2024-11-13T16:27:44Z

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

github-actions · 2024-11-14T00:52:38Z

🚀 Deployed to staging by https://github.com/tgolen in version: 9.0.62-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	failure ❌
🍎🔄 iOS HybridApp 🍎🔄	failure ❌

github-actions · 2024-11-15T14:15:58Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.62-4 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄	skipped 🚫

fix: Add a step validate to the Issue New Card form

0ea64e7

nkdengineer marked this pull request as ready for review October 16, 2024 17:38

nkdengineer requested a review from a team as a code owner October 16, 2024 17:38

melvin-bot bot requested review from hungvu193 and removed request for a team October 16, 2024 17:38

nkdengineer changed the title ~~fix: Add a step validate to the Issue New Card form~~ [HOLD 50667] fix: Add a step validate to the Issue New Card form Oct 17, 2024

nkdengineer changed the title ~~[HOLD 50667] fix: Add a step validate to the Issue New Card form~~ fix: Add a step validate to the Issue New Card form Oct 23, 2024

resolve conflict

d6aa32f

nkdengineer mentioned this pull request Oct 23, 2024

[HOLD for payment 2024-11-22] Add a step to the Issue New Card form that collects a magic code #50667

Closed

nkdengineer added 2 commits October 30, 2024 22:44

merge main

0ea9355

handle error code

ef089e9

handle loading validate modal

4d758ef

hungvu193 suggested changes Nov 6, 2024

View reviewed changes

nkdengineer added 3 commits November 9, 2024 23:36

Merge branch 'main' into fix/50667

545ba0d

remove login logic

d21fb1a

fix cannot enter validate code

589a398

hungvu193 suggested changes Nov 10, 2024

View reviewed changes

src/pages/workspace/expensifyCard/issueNew/ConfirmationStep.tsx Outdated Show resolved Hide resolved

Update src/pages/workspace/expensifyCard/issueNew/ConfirmationStep.tsx

4794ac7

Co-authored-by: Hans <[email protected]>

Merge branch 'main' into fix/50667

df101ac

hungvu193 suggested changes Nov 13, 2024

View reviewed changes

fix: add has magic code been set

c17ad24

hungvu193 approved these changes Nov 13, 2024

View reviewed changes

melvin-bot bot requested a review from tgolen November 13, 2024 08:11

tgolen approved these changes Nov 13, 2024

View reviewed changes

tgolen merged commit 0984113 into Expensify:main Nov 13, 2024
18 checks passed

github-actions bot mentioned this pull request Nov 14, 2024

Deploy Checklist: New Expensify 2024-11-14 #52512

Closed

47 tasks

IuliiaHerets mentioned this pull request Nov 14, 2024

[$250] QBO - RBR on expensify card without any indication or errors inside #52555

Closed

8 tasks

fix: Add a step validate to the Issue New Card form #50864

fix: Add a step validate to the Issue New Card form #50864

Conversation

nkdengineer commented Oct 16, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

nkdengineer commented Oct 16, 2024

melvin-bot bot commented Oct 16, 2024

hungvu193 commented Oct 17, 2024 • edited Loading

hungvu193 commented Oct 22, 2024

hungvu193 commented Oct 23, 2024

nkdengineer commented Oct 23, 2024

nkdengineer commented Oct 23, 2024

hungvu193 commented Oct 23, 2024

hungvu193 commented Oct 23, 2024

nkdengineer commented Oct 25, 2024

nkdengineer commented Oct 29, 2024

hungvu193 commented Oct 29, 2024 • edited Loading

hungvu193 commented Oct 29, 2024 • edited Loading

hungvu193 commented Nov 1, 2024

nkdengineer commented Nov 4, 2024 • edited Loading

hungvu193 commented Nov 5, 2024

nkdengineer commented Nov 5, 2024

hungvu193 commented Nov 9, 2024

nkdengineer commented Nov 9, 2024

nkdengineer commented Nov 9, 2024

hungvu193 commented Nov 10, 2024

hungvu193 commented Nov 10, 2024

nkdengineer commented Nov 11, 2024

nkdengineer commented Nov 11, 2024

hungvu193 commented Nov 11, 2024

hungvu193 commented Nov 11, 2024

nkdengineer commented Nov 11, 2024

nkdengineer commented Nov 13, 2024

hungvu193 commented Nov 13, 2024 • edited Loading

hungvu193 commented Nov 13, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

hungvu193 Nov 13, 2024

Choose a reason for hiding this comment

nkdengineer Nov 13, 2024

Choose a reason for hiding this comment

OSBotify commented Nov 13, 2024

github-actions bot commented Nov 14, 2024

github-actions bot commented Nov 15, 2024

nkdengineer commented Oct 16, 2024 •

edited

Loading

hungvu193 commented Oct 17, 2024 •

edited

Loading

hungvu193 commented Oct 29, 2024 •

edited

Loading

hungvu193 commented Oct 29, 2024 •

edited

Loading

nkdengineer commented Nov 4, 2024 •

edited

Loading

hungvu193 commented Nov 13, 2024 •

edited

Loading

hungvu193 commented Nov 13, 2024 •

edited

Loading