Require validateCode when requesting replacement cards #51147

youssef-lr · 2024-10-21T02:25:48Z

Details

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/434460
$ https://github.com/Expensify/Expensify/issues/434468

Tests

Verify that no errors appear in the JS console

First checkout this Auth PR, and then hardcode these lines:

https://github.com/Expensify/Web-Expensify/blob/4fccc5d6258fc9d7879d5cea6c0ced5663cd3334/lib/CardAPI.php#L652 => $response = Auth::requestReplacementExpensifyCard($authToken, $cardID, $reason, validateCode: $validateCode);
https://github.com/Expensify/Web-Expensify/blob/4fccc5d6258fc9d7879d5cea6c0ced5663cd3334/lib/CardAPI.php#L405 => Auth::requestReplacementExpensifyCard($authToken, $existingVirtualCardID, Card::CARD_REPLACEMENT_REASON_STOLEN, validateCode: $validateCode, skipVirtualCardCreation: true);
Have an account with a physical and virtual card.
Report virtual card for fraud, make sure you're asked to enter a validateCode.
Enter a wrong validate code and make sure the request doesn't go through.
Enter the correct magic code and make sure you're redirected to the new card page.
Repeat the same steps by requesting a replacement physical card.

Offline tests

QA Steps

Verify that no errors appear in the JS console

Have an account with a physical and virtual card.
Report virtual card for fraud, make sure you're asked to enter a validateCode.
Enter a wrong validate code and make sure the request doesn't go through.
Enter the correct magic code and make sure you're redirected to the new card page.
Repeat the same steps by requesting a replacement physical card.

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-10-29.at.21.18.47.mov

MacOS: Desktop

melvin-bot · 2024-10-26T16:14:16Z

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

youssef-lr · 2024-10-26T16:16:32Z

@jjcoffee this needs an internal review due to some backend changes that aren't live and we can't make them live until this PR is deployed.

melvin-bot · 2024-10-26T16:17:24Z

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

youssef-lr · 2024-10-29T20:44:18Z

Yup I found it weird too. I haven't touched this part in my changes.

github-actions · 2024-10-29T20:47:41Z

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

Android 🤖	iOS 🍎
❌ FAILED ❌	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/51147/index.html
The QR code can't be generated, because the android build failed
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/51147/NewExpensify.dmg	https://51147.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

youssef-lr · 2024-10-29T20:50:20Z

Fixed. This was using OfflineWithFeedback which by default shows the error below, but it has an option to display the error above.

Screen.Recording.2024-10-29.at.21.49.36.mov

thienlnam

Code largely looks good, just a comment about the side effect pattern. One more thing is will this work even without the auth changes?

thienlnam · 2024-10-29T22:38:45Z

src/pages/settings/Wallet/ReportCardLostPage.tsx

+        requestValidateCodeAction();
+    };
+
+    const handleValidateCodeEntered = (validateCode: string) => {
+        CardActions.requestReplacementExpensifyCard(physicalCard.cardID, reason?.key as ReplacementReason, validateCode).then((newCardID) => {
+            if (!newCardID) {
+                return;
+            }
+            setIsValidateCodeActionModalVisible(false);
+            Navigation.navigate(ROUTES.SETTINGS_WALLET_DOMAINCARD.getRoute(newCardID));
+        });


It doesn't look like we did this navigation before, is there a reason we are adding it now?

thienlnam · 2024-10-29T22:41:59Z

src/libs/actions/Card.ts

+        // eslint-disable-next-line rulesdir/no-api-side-effects-method
+        API.makeRequestWithSideEffects(SIDE_EFFECT_REQUEST_COMMANDS.REQUEST_REPLACEMENT_EXPENSIFY_CARD, parameters, {optimisticData, successData, failureData})
+            .then((response): string | undefined => {
+                if (response?.jsonCode !== CONST.JSON_CODE.SUCCESS) {
+                    return;
+                }
+                resolve((response as ExpensifyCardID).newCardID.toString());
+            })
+            .catch(() => reject());
    });
 }


Returning promises from action methods is a discouraged pattern - it looks like we can do this without the side effects.

We just want the new cardID here, so we could probably just have it update an onyx key and only re-direct if we have that key present and are done loading. Alternatively, it seems like we didn't have a redirect before so maybe we don't need to have it still

@thienlnam without the side effects we used to redirect to the old card page and we display a "$0" limit which looks like a bug to the user

Screen_Recording_2024-10-23_at_22.04.03-2024-10-30.17_36_55.334.mov

We also use side effects for reveal virtual card details here

App/src/libs/actions/Card.ts

Line 197 in 084b104

function revealVirtualCardDetails(cardID: number, validateCode: string): Promise<ExpensifyCardDetails> {

. We also already display a loading spinner when requesting a new card.

We use side effects there because we can't store those details in onyx since they're sensitive - but for this which is just a cardID is fine to store in onyx

Hmm let me see how I can make this work without side effects and also prevent the bug above.

👍 lmk if you need some ideas - usually the way we get around this is by adding a loading indicator on a loading key on the onyx key for the page

Something like this, wdyt?

@thienlnam IMO I think we can keep the side effect call here, you can see in the comment that our use case here is allowed, we are both calling Marqeta and redirecting based on the response

Also given that we display a spinner and make the user wait, I don't see how is using the optimistic pattern is helpful?

Yup something along those lines would work - you'd need to have the API command send an onyx update for the newCardID if you wanted to redirect to the new card.

Though thinking about this more though, if you only added the redirect so that the card doesn't show with a $0 limit we could also just not do the redirect because then it forces this flow to happen online.

In App, in the optimistic data you could set a new key called isReplacing or something on the cardID and so when you open that cardID you would see some note that it's been replaced and then when the API completes it would remove the card and have the new card in the list. That's probably easier and then allows the user to take other actions offline with the command queued - what do you think?

I hear you. However I think that this stuff is out of scope, so it's best if I kept this PR focused on validateCode using the same offline pattern we have now, which means not fixing the $0 bug, I think we can open an issue to fix separately. Sounds good?

Yeah that works for me - the main concern for me here is to remove the side effect so if we can do that here and have an external contributor handle the UI update seperately

shawnborton · 2024-10-30T08:21:44Z

Good shout Danny, I agree seeing the error below the footer button felt weird - glad we have the option to easily add it above!

youssef-lr · 2024-11-06T22:37:24Z

Updated @thienlnam

thienlnam · 2024-11-06T23:17:07Z

Looks like there are some lint failures

youssef-lr · 2024-11-06T23:18:02Z

Ah, I need to remove usage of withOnyx. Will do tomorrow. Also, apologies for late update, I was OOO sick.

youssef-lr · 2024-11-07T18:48:08Z

Fixed @thienlnam

thienlnam

Great, thanks!

thienlnam · 2024-11-07T18:57:59Z

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

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

OSBotify · 2024-11-07T19:09:17Z

✋ 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-11T18:39:14Z

🚀 Deployed to staging by https://github.com/thienlnam in version: 9.0.60-0 🚀

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

kavimuru · 2024-11-12T17:52:41Z

@youssef-lr @francoisl we don't have physical card and we can verify with virtual card only.

francoisl · 2024-11-12T18:16:00Z

@youssef-lr is there a way to test with physical cards without actually requesting a replacement on each platform?

youssef-lr · 2024-11-12T18:18:35Z

I'm not sure there is, cc @NikkiWines. I think we can check this off for now, nothing has changed once a validateCode is valid, things should work the same as before

NikkiWines · 2024-11-12T18:29:04Z

🤔 I don't think we have a flow for that. Except maybe you could request a replacement then cancel the request internally which might be tricky timing wise and I'm not to sure exactly how you'd do that.

It's a little dicey to not test the success flow at all on staging or prod, but I'm not sure how to bypass that here

NikkiWines · 2024-11-13T00:14:46Z

Maybe we could follow the same / similar steps from when this command was initially added here?

github-actions · 2024-11-13T00:42:43Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.60-3 🚀

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

youssef-lr added 6 commits October 21, 2024 03:05

Sort command alphabetically

2df4f36

Move commands to side effect commands list

e0af600

Use a side effect request when report virtual card fraud

4e26e41

Navigate back to the card page on error

e631c0a

Set description of ValidateCodeActionModal

172e11f

Cleanup code

85a9dd7

youssef-lr changed the title ~~Youssef validate code replacement cards~~ Require validateCode when requesting replacement cards Oct 21, 2024

youssef-lr self-assigned this Oct 21, 2024

youssef-lr added 9 commits October 22, 2024 23:04

Make sure all validateCode modals have confirmation button docked

f60a62f

Handle loading state and display validetCode error

f53f47f

Navigate to new cardID page and fix brief display of 404 page

5845c87

Cleanup unused stuff

2c3e090

Merge branch 'main' into youssef_validateCode_replacement_cards

d774a7f

Merge branch 'main' into youssef_validateCode_replacement_cards

00ae18e

Show validateCode error in the valideCode modal

de7bf8a

Use makeRequestWithSideEffects when requesting physical replacement card

9feb1cd

Require validate code when replacing physical cards

0bfa399

youssef-lr marked this pull request as ready for review October 26, 2024 16:14

youssef-lr requested a review from a team as a code owner October 26, 2024 16:14

melvin-bot bot requested review from jjcoffee and removed request for a team October 26, 2024 16:14

youssef-lr added 2 commits October 26, 2024 17:14

Lint

e777ee5

More lint

419167a

youssef-lr removed the request for review from jjcoffee October 26, 2024 16:16

youssef-lr requested a review from a team October 26, 2024 16:16

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

Display validateCode error above submit button

c7b2059

thienlnam requested changes Oct 29, 2024

View reviewed changes

youssef-lr added 3 commits November 3, 2024 19:16

Merge branch 'main' into youssef_validateCode_replacement_cards

62b7fea

Merge branch 'main' into youssef_validateCode_replacement_cards

7ed59ee

Keep offline pattern

e4af3c8

youssef-lr added 3 commits November 7, 2024 17:10

Remove usage of withOnyx and other lint fixes

1868fcb

Merge branch 'main' into youssef_validateCode_replacement_cards

ff17b0e

Lint

cc4c172

thienlnam approved these changes Nov 7, 2024

View reviewed changes

thienlnam merged commit 7a605ec into main Nov 7, 2024
16 of 17 checks passed

thienlnam deleted the youssef_validateCode_replacement_cards branch November 7, 2024 18:59

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

[HOLD for payment 2024-11-21] Deploy Checklist: New Expensify 2024-11-11 #52320

Closed

95 tasks

lanitochka17 mentioned this pull request Nov 11, 2024

Expensify Card - No error message when incorrect code is entered when deactivating card #52338

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Require validateCode when requesting replacement cards #51147

Require validateCode when requesting replacement cards #51147

youssef-lr commented Oct 21, 2024 •

edited

Loading

melvin-bot bot commented Oct 26, 2024

youssef-lr commented Oct 26, 2024

melvin-bot bot commented Oct 26, 2024

youssef-lr commented Oct 29, 2024

github-actions bot commented Oct 29, 2024

youssef-lr commented Oct 29, 2024

thienlnam left a comment

thienlnam Oct 29, 2024

thienlnam Oct 29, 2024

youssef-lr Oct 30, 2024

thienlnam Oct 30, 2024 •

edited

Loading

youssef-lr Oct 30, 2024

thienlnam Oct 30, 2024

youssef-lr Nov 1, 2024

youssef-lr Nov 1, 2024

thienlnam Nov 1, 2024

youssef-lr Nov 1, 2024

thienlnam Nov 1, 2024 •

edited

Loading

shawnborton commented Oct 30, 2024

youssef-lr commented Nov 6, 2024

thienlnam commented Nov 6, 2024

youssef-lr commented Nov 6, 2024 •

edited

Loading

youssef-lr commented Nov 7, 2024

thienlnam left a comment

thienlnam commented Nov 7, 2024 •

edited

Loading

OSBotify commented Nov 7, 2024

github-actions bot commented Nov 11, 2024

kavimuru commented Nov 12, 2024

francoisl commented Nov 12, 2024

youssef-lr commented Nov 12, 2024

NikkiWines commented Nov 12, 2024

NikkiWines commented Nov 13, 2024

github-actions bot commented Nov 13, 2024

Require validateCode when requesting replacement cards #51147

Require validateCode when requesting replacement cards #51147

Conversation

youssef-lr commented Oct 21, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 26, 2024

youssef-lr commented Oct 26, 2024

melvin-bot bot commented Oct 26, 2024

youssef-lr commented Oct 29, 2024

github-actions bot commented Oct 29, 2024

youssef-lr commented Oct 29, 2024

thienlnam left a 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

thienlnam Oct 30, 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

thienlnam Nov 1, 2024 • edited Loading

Choose a reason for hiding this comment

shawnborton commented Oct 30, 2024

youssef-lr commented Nov 6, 2024

thienlnam commented Nov 6, 2024

youssef-lr commented Nov 6, 2024 • edited Loading

youssef-lr commented Nov 7, 2024

thienlnam left a comment

Choose a reason for hiding this comment

thienlnam commented Nov 7, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Nov 7, 2024

github-actions bot commented Nov 11, 2024

kavimuru commented Nov 12, 2024

francoisl commented Nov 12, 2024

youssef-lr commented Nov 12, 2024

NikkiWines commented Nov 12, 2024

NikkiWines commented Nov 13, 2024

github-actions bot commented Nov 13, 2024

youssef-lr commented Oct 21, 2024 •

edited

Loading

thienlnam Oct 30, 2024 •

edited

Loading

thienlnam Nov 1, 2024 •

edited

Loading

youssef-lr commented Nov 6, 2024 •

edited

Loading

thienlnam commented Nov 7, 2024 •

edited

Loading