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: Add a step to to Request Physical Card form that collects a magic code #51135

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

Conversation

hungvu193
Copy link
Contributor

@hungvu193 hungvu193 commented Oct 20, 2024

Details

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

Fixed Issues

$ #50967
PROPOSAL: N/A

Tests

Prerequisite: Your account needs at least one physical card added.

  1. Go to your Settings => Wallet.
  2. Click on your Physical card => Issue card.
  3. Enter all necessary information => Press Ship card.
  4. Verify that there's modal that allow you to enter magic code.
  5. Enter the magic code.
  6. 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
Copy link
Contributor Author

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

Copy link
Contributor

@situchan situchan left a comment

Choose a reason for hiding this comment

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

image

@hungvu193
Copy link
Contributor Author

image

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

@hungvu193 hungvu193 marked this pull request as ready for review October 24, 2024 02:07
@hungvu193 hungvu193 requested a review from a team as a code owner October 24, 2024 02:07
@melvin-bot melvin-bot bot requested a review from situchan October 24, 2024 02:07
Copy link

melvin-bot bot commented Oct 24, 2024

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

@melvin-bot melvin-bot bot removed the request for review from a team October 24, 2024 02:07
@hungvu193
Copy link
Contributor Author

hungvu193 commented Oct 24, 2024

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

@hungvu193 hungvu193 changed the title Feat: Add a step to to Request Physical Card form that collects a magic code [Hold for BE PR] Feat: Add a step to to Request Physical Card form that collects a magic code Oct 25, 2024
src/types/onyx/Card.ts Outdated Show resolved Hide resolved
@hungvu193
Copy link
Contributor Author

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

Screenshot 2024-11-01 at 11 45 15

@hungvu193 hungvu193 changed the title [Hold for BE PR] Feat: Add a step to to Request Physical Card form that collects a magic code Feat: Add a step to to Request Physical Card form that collects a magic code Nov 1, 2024
@hungvu193
Copy link
Contributor Author

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
Copy link
Contributor

dominictb commented Nov 12, 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 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
Screen.Recording.2024-11-15.at.11.56.20-compressed.mov
iOS: mWeb Safari
Screen.Recording.2024-11-15.at.11.27.17-compressed.mov
MacOS: Chrome / Safari
Screen.Recording.2024-11-15.at.11.18.41-compressed.mov
MacOS: Desktop

@dominictb
Copy link
Contributor

dominictb commented Nov 12, 2024

@hungvu193 Are #51135 (comment) and #51135 (comment) expected? Or are we waiting for BE changes?

@hungvu193
Copy link
Contributor Author

@hungvu193 Are #51135 (comment) and #51135 (comment) expected? Or are we waiting for BE changes?

I think they're expected for now. I believe we don't want to block existing user from using this feature at the moment because we haven't released this PR yet. cc @NikkiWines

@dominictb

This comment was marked as resolved.

@dominictb
Copy link
Contributor

BUG: If I abandoned the verify flow (wrong magic code then close the RHP) and refreshed, the card automatically turned to have NOT_ACTIVATED state

But seems like it's this one #51135 (comment) and a BE bug.

@dominictb
Copy link
Contributor

BUG: If I entered wrong validate code, I would always got Card data missing in detail error like #51135 (comment) all the time even when I entered the correct code.

I think it is a BE bug as well.

@dominictb
Copy link
Contributor

The above issue ^ together with the rate limit of ResendValidateCode made this PR very difficult to test. I'll try again tonight.

@NikkiWines
Copy link
Contributor

NikkiWines commented Nov 13, 2024

@dominictb you might be able to test more easily by following the setup steps from this PR? @hungvu193 it might be helpful to incorporate something like this into the QA steps as well

Copy link
Contributor

@NikkiWines NikkiWines left a comment

Choose a reason for hiding this comment

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

Couple of comments

src/components/ValidateCodeActionModal/type.ts Outdated Show resolved Hide resolved
src/libs/actions/Wallet.ts Outdated Show resolved Hide resolved
@hungvu193
Copy link
Contributor Author

Couple of comments

Addressed all the comments

@NikkiWines
Copy link
Contributor

@hungvu193 you've got conflicts

@NikkiWines
Copy link
Contributor

@dominictb can you re-review please 🙇

(validateCode: string) => {
setCurrentCardID(cardToBeIssued?.cardID.toString());
const updatedPrivatePersonalDetails = GetPhysicalCardUtils.getUpdatedPrivatePersonalDetails(draftValues, privatePersonalDetails);
Wallet.requestPhysicalExpensifyCard(cardToBeIssued?.cardID ?? -1, session?.authToken ?? '', updatedPrivatePersonalDetails, validateCode);
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this is the line causing the -1 problem. I can still reproduce it.

Copy link
Contributor

Choose a reason for hiding this comment

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

Please retest before requesting another review round.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure. I'll do it shortly

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We clear the error when modal is hide, unfortunately we used the old cardID value for it, which caused the issue, can you verify it now? Ty

@dominictb
Copy link
Contributor

dominictb commented Nov 15, 2024

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

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
Copy link
Contributor Author

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
Copy link
Contributor

Thanks. Please do.

@NikkiWines
Copy link
Contributor

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

@hungvu193
Copy link
Contributor Author

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

Yes. I commented here

const [draftValues] = useOnyx(ONYXKEYS.FORMS.GET_PHYSICAL_CARD_FORM_DRAFT);
const [account] = useOnyx(ONYXKEYS.ACCOUNT);
const [isActionCodeModalVisible, setActionCodeModalVisible] = useState(false);
const [formData] = useOnyx(ONYXKEYS.FORMS.REPORT_PHYSICAL_CARD_FORM);
const domainCards = CardUtils.getDomainCards(cardList)[domain] || [];
const cardToBeIssued = domainCards.find((card) => !card?.nameValuePairs?.isVirtual && card?.state === CONST.EXPENSIFY_CARD.STATE.STATE_NOT_ISSUED);
const cardID = cardToBeIssued?.cardID.toString() ?? '-1';
Copy link
Contributor

Choose a reason for hiding this comment

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

Please remove this intermediary variable and replace all its usages to avoid confusion (e.g., why cardID somewhere and currentCardID elsewhere).

// Current step of the get physical card flow should be the confirmation page; and
// Card has NOT_ACTIVATED state when successfully being issued so cardToBeIssued should be undefined
// -1 is not a valid cardID, we don't need to clean up the form value in that case.
if (!isConfirmation || !!cardToBeIssued || !currentCardID || currentCardID === '-1') {
Copy link
Contributor

Choose a reason for hiding this comment

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

If so, do we still need currentCardID === '-1'?

// so that no stale data is left on Onyx
FormActions.clearDraftValues(ONYXKEYS.FORMS.GET_PHYSICAL_CARD_FORM);
Wallet.clearPhysicalCardError(currentCardID);
Navigation.navigate(ROUTES.SETTINGS_WALLET_DOMAINCARD.getRoute(currentCardID.toString()));
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
Navigation.navigate(ROUTES.SETTINGS_WALLET_DOMAINCARD.getRoute(currentCardID.toString()));
Navigation.navigate(ROUTES.SETTINGS_WALLET_DOMAINCARD.getRoute(currentCardID));

@dominictb
Copy link
Contributor

Please also merge main.

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