Feat: Add a step to to Request Physical Card form that collects a magic code

[hungvu193]

Details

This PR added a validate code modal when user want to issue a physical card.

Fixed Issues

$ #50967
PROPOSAL: N/A

Tests

Ask @NikkiWines to do the steps for you or follow this slack guide and ensure you request to cancel the card before it ships by asking in Slack

1. Log into an account with a
2. Go to your Settings => Wallet.
3. Click on your Physical card => Issue card.
4. Enter all necessary information => Press Ship card.
5. Verify that there's modal that allow you to enter magic code.
6. Enter the magic code that's been sent to your login.
7. Verify that you can continue with the flow after that.

• Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as Tests.

• 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

Screen.Recording.2024-11-01.at.14.16.51.mov

MacOS: Desktop

Desskotp.mov

[hungvu193]

Note: It looks like BE currently doesn't throw errors with invalid validate code.

[situchan]

[hungvu193]

I see. This is not related to current changes, however I think it's easy to update it so I can include useOnyx migration in this PR

[melvin-bot]

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

Onyx migration 's done. I mark this PR is ready so the linked issue won't be overdue.

[hungvu193]

@NikkiWines What's the successful response? Can you give me the example? I'm seeing here's the error response, it merges requestPhysicalCardForm key.

[hungvu193]

Another thing, The error that's showing between assigned card sections and inside ValidateCodeActionModal are different, do we need to fix it as well?

Screen.Recording.2024-11-01.at.14.17.49.mov

[dominictb]

@hungvu193 BUG: If we previously verified code in Get Physical Card flow then verified in Issue New Card Flow, OR VICE VERSA, ResendValidateCode API is not called the first time. It would only be called if we pressed Didn't receive a magic code?.

If we already requested validate code in another flow, validateActionCode.validateCodeSent is true. Later, this line prevents sendValidateCode if hasMagicCodeBeenSent:

App/src/components/ValidateCodeActionModal/index.tsx

Line 45 in 0855d78

if (!firstRenderRef.current || !isVisible || hasMagicCodeBeenSent) {

I think this is somehow related to #51663 but cannot confirm if it's expected (to prevent excessive API calls within a short duration). Can you confirm?

[hungvu193]

Yes, It's to prevent excessive API calls. But I think we should also fix it, we should add optimistic data to our API that use validateCode param.

[dominictb]

Thanks. Please do.

[NikkiWines]

@hungvu193 what's the latest here, can @dominictb re-review now?

[hungvu193]

@hungvu193 what's the latest here, can @dominictb re-review now?

Yes. I commented here

[dominictb]

Please also merge main.

[hungvu193]

Merged main and addressed all your comments 😄

[dominictb]

All yours @NikkiWines

[NikkiWines]

Looks like this needs another web PR to fix the error handling. I've got a PR up for that now and I'll CP if we can CP it so it goes live tomorrow. Holding off on approving until then.

Flow looks good once that correct error is being returned 🪅
https://github.com/user-attachments/assets/f99ab563-0978-4d94-9c8e-a87671eb225e

However, it looks like the error for the Assigned cards needs to be adjusted here so it's not just displaying Oops!... - maybe we can display the same error (or just red dot?) in this case?

[NikkiWines]

Backend PR for the error handling is on staging, will be deployed tomorrow 😊

[hungvu193]

However, it looks like the error for the Assigned cards needs to be adjusted here so it's not just displaying Oops!... - maybe we can display the same error (or just red dot?) in this case?

Yeah, currently we're getting the error from ONYXKEYS.CARD_LIST for assigned card, but when we validate the magic code the errors sometimes return from ONYXKEYS.FORMS.REPORT_PHYSICAL_CARD_FORM.

[NikkiWines]

Backend logic for the error handling is on prod

[dominictb]

However, it looks like the error for the Assigned cards needs to be adjusted here so it's not just displaying Oops!... - maybe we can display the same error (or just red dot?) in this case?

Yeah, currently we're getting the error from ONYXKEYS.CARD_LIST for assigned card, but when we validate the magic code the errors sometimes return from ONYXKEYS.FORMS.REPORT_PHYSICAL_CARD_FORM.

@NikkiWines Did that BE logic handle the double error issue mentioned here?

[NikkiWines]

No - it just handles updating the error message that we return when getting a 401 from the RequestPhysicalExpensifyCardcommand.

However, I think this is probably ok for now. I'd like to not display anything other than the 🔴 in that scenario, rather than show the Oops! but it's a minor thing.

I'm going to double check to see if we have staging friendly QA steps for this command, because I don't think we want go through the real flow of a requesting a new card in this case - once i've got that settled I'll re-review and merge.

[NikkiWines]

[OSBotify]

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

🚀 Deployed to staging by https://github.com/NikkiWines in version: 9.0.66-0 🚀

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

[NikkiWines]

Confirmed this works as expected on staging:

Screen.Recording.2024-11-25.at.13.23.31.mov

[github-actions]

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.66-8 🚀

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