22875 Add API Calls when clicking “Reveal details” buttons #29017

lukemorawski · 2023-10-06T16:30:51Z

Details

This PR add a call to the Expensify API to upon the tap on card "Reveal Details" button, to get the that card details and display it to the user.
The call is done locally and saved in components state, and not to Onyx for security reasons.
When the call progresses, the loading indicator is displayed in the button and the button is disabled to prevent concurrent calls.
There's also error handling displaying the error message under the MenuItem.
To test fully this feature we would need a way to add a real virtual card to the account. Currently we can only test that call has been made and also test the error handling.
Mocking the success response locally is also possible.
Here's a mocked happy path scenario:

happy.path.mov

Fixed Issues

$ #22875
PROPOSAL: no proposal

Tests

same as QA steps
Verify that no errors appear in the JS console

Offline tests

QA Steps

open the web app and navigate to /settings/wallet/card/expensify (you'll see "not found" page)
in the JS console run the following code

Onyx.merge(`cardList`, {
    5678: {
	cardID: 5678,
	state: 4,
	bank: '1000',
	availableSpend: 10000,
	domainName: 'Expensify',
	lastFourPAN: '2345',
	isVirtual: true,
    },
});

Click on Reveal Details
A loading indicator should appear on the button
Observe the network console that the correct request is made
An error should appear under this menu item, as the card is fake
Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

web.desktop.mov

Mobile Web - Chrome

web.android.mov

Mobile Web - Safari

web.ios.mov

Desktop

native.desktop.mov

iOS

native.ios.mp4

Android

web.android.mov

MrMuzyk · 2023-10-09T07:32:04Z

src/pages/settings/InitialSettingsPage.js

@@ -1,11 +1,11 @@
 import lodashGet from 'lodash/get';


Nothing should change in this file?

you're right!

MrMuzyk · 2023-10-09T07:34:37Z

src/pages/settings/Wallet/revealCardDetailsUtils.ts

+    error: string;
+};
+
+type Action = {type: 'START'} | {type: 'SUCCESS'; payload: State['details']} | {type: 'FAIL'; payload: string};


nit, Id move 'START', 'SUCCESS', 'FAIL' to some kind of const variable

it's TS typed, so the right values should be autocompleted by the IDE, hence no constants needed imo.

Card page is in .js tho. Im not sure if any checks happen there when dispatching actions

MrMuzyk · 2023-10-09T07:42:29Z

src/pages/settings/Wallet/revealCardDetailsUtils.ts

+            };
+        };
+    };
+    loading: boolean;


I think it should be named isLoading

MrMuzyk · 2023-10-09T07:45:50Z

Would it be possible to get some videos from happy path too?

melvin-bot · 2023-10-10T11:31:05Z

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

marcaaron

Thanks for the changes! Unfortunately, it is not yet ready...

Please check the documentation for the App architecture. The PR is running counter to several foundational designs that will hopefully be more clear after reading the following:

https://github.com/Expensify/App/tree/main#philosophy
https://github.com/Expensify/App/blob/main/contributingGuides/API.md
https://github.com/Expensify/App/blob/main/contributingGuides/OFFLINE_UX.md

Let me know if there are any questions

marcaaron · 2023-10-10T23:49:22Z

src/pages/settings/Wallet/ExpensifyCardPage.js

@@ -1,5 +1,5 @@
 import PropTypes from 'prop-types';
-import React, {useState} from 'react';
+import React, {useReducer} from 'react';


I don't think we should start with useReducer. We have avoided it until now and it looks like the incorrect pattern for what we are trying to achieve here.

marcaaron · 2023-10-10T23:50:10Z

src/pages/settings/Wallet/ExpensifyCardPage.js

@@ -18,6 +18,10 @@ import styles from '../../../styles/styles';
 import * as CardUtils from '../../../libs/CardUtils';
 import Button from '../../../components/Button';
 import CardDetails from './WalletPage/CardDetails';
+// eslint-disable-next-line rulesdir/no-api-in-views
+import * as API from '../../../libs/API';


This is here for a reason. If you want to call an API you need to create an "action" in the Card.js file

lukemorawski · 2023-10-11T08:48:09Z

@marcaaron Thanks for clarifying some stuff. Working on the changes now.

lukemorawski · 2023-10-11T14:23:55Z

@marcaaron made some fixes, please have a look

marcaaron

Thank you for the changes!

I will do some local testing.

marcaaron · 2023-10-11T22:31:52Z

src/libs/actions/Card.ts

+        API.makeRequestWithSideEffects('RevealVirtualCardDetails', {cardID})
+            .then((response) => {
+                if (response.jsonCode !== CONST.JSON_CODE.SUCCESS) {
+                    reject(response.message || Localize.translateLocal('cardPage.cardDetailsLoadingFailure'));


I think we should not return the response.message error. It could be anything. Same with the catch below. Just return the default translated error in either case since the user will end up seeing this.

marcaaron · 2023-10-11T22:34:13Z

@rushatgabhane Any status? The PR is related to our product roadmap and needs priority.

rushatgabhane · 2023-10-11T22:38:19Z

got it! reviewing

rushatgabhane · 2023-10-11T23:07:52Z

src/languages/en.ts

@@ -843,6 +843,7 @@ export default {
            revealDetails: 'Reveal details',
            copyCardNumber: 'Copy card number',
        },
+        cardDetailsLoadingFailure: 'An error occurred loading card details, please try again.',


I think this reads better

Suggested change

cardDetailsLoadingFailure: 'An error occurred loading card details, please try again.',

cardDetailsLoadingFailure: 'An error occurred while loading the card details. Please try again.',

I assumed this copy was already approved by marketing.

@lukemorawski @MrMuzyk @grgia is this wrong?

There's no error message copy for this in the Design Doc @marcaaron

Ok I think we need to get the copy looked at. All copy needs to be approved. 🙃

Where did this error message come from?

src/pages/settings/Wallet/ExpensifyCardPage.js

rushatgabhane

@lukemorawski am i missing something? are there any prerequisities to test this PR?

Bug:
Steps:

navigate to /settings/wallet/card/expensify
run in JS console

Onyx.merge(`cardList`, {
    5678: {
	cardID: 5678,
	state: 4,
	bank: '1000',
	availableSpend: 10000,
	domainName: 'Expensify',
	lastFourPAN: '2345',
	isVirtual: true,
    },
});

Click on Reveal Details

Expected: Network request is made

Actual: no request is made, and we have a console error : TypeError: Cannot read properties of undefined (reading 'revealVirtualCardDetails') at Object.handleRevealDetails [as onPress] (ExpensifyCardPage.js:77:9)

rushatgabhane · 2023-10-19T16:11:29Z

@grgia yep

src/libs/actions/Card.js

marcaaron · 2023-10-19T23:37:49Z

@rushatgabhane Are you on the checklist for this one?

Co-authored-by: Rushat Gabhane <rushatgabhane@gmail.com>

lukemorawski · 2023-10-20T09:50:17Z

updated @rushatgabhane

rushatgabhane · 2023-10-21T00:29:54Z

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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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(themeColors.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 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

Web

Mobile Web - Chrome

Mobile Web - Safari

my emulator is broken

Desktop

iOS

Android

rushatgabhane · 2023-10-21T00:48:56Z

@lukemorawski am i missing something? I don't see the card.

steps:

go to settings/wallet/card/expensify
in console, merge cardList

I'm on the latest commit and re-ran npm ci

grgia · 2023-10-23T09:49:11Z

@rushatgabhane the domain check is case sensitive, could you try changing the data to:

Onyx.merge(`cardList`, {
    [5678]: {
	"cardID": 5678,
	"state": 4,
	"bank": 'Expensify Card',
	"availableSpend": 10000,
	"domainName": 'expensify',
	"lastFourPAN": '2345',
	"isVirtual": true,
    },
});

Co-authored-by: Rushat Gabhane <rushatgabhane@gmail.com>

rushatgabhane

@grgia LGTM!

grgia · 2023-10-25T15:04:48Z

Hey @rushatgabhane we've decided to move the error handling into a follow up PR, would you mind doing a final pass through on the final branch?

rushatgabhane · 2023-10-25T15:15:02Z

we've decided to move the error handling into a follow up PR,

cool

Code LGTM! The promise can be removed later

Screen.Recording.2023-10-25.at.20.43.06.mov

grgia · 2023-10-25T15:44:15Z

Sounds good! added removing the promise to the issue as well - #30329

OSBotify · 2023-10-25T16:59:05Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.91-0 🚀

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

OSBotify · 2023-10-26T22:41:06Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.91-8 🚀

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

lukemorawski added 2 commits October 6, 2023 10:55

first commit

f73d601

move to reducer and error handling

5985ec1

MrMuzyk reviewed Oct 9, 2023

View reviewed changes

lukemorawski added 7 commits October 9, 2023 10:46

removed unnecessary helper function

df10ff7

formatting

36fb11a

var name change to isLoading

bfdb546

better linting

9a8962c

moved action types to const

c7dd8fa

action types fix and cardID added to api call

ccf8f4e

address refactoring

ef623a4

MrMuzyk approved these changes Oct 10, 2023

View reviewed changes

lukemorawski marked this pull request as ready for review October 10, 2023 11:30

lukemorawski requested a review from a team as a code owner October 10, 2023 11:31

melvin-bot bot requested review from rushatgabhane and removed request for a team October 10, 2023 11:31

marcaaron assigned lukemorawski Oct 10, 2023

marcaaron requested changes Oct 10, 2023

View reviewed changes

refactoring

f7ba68a

lukemorawski requested a review from marcaaron October 11, 2023 14:23

Merge branch 'main' into 22875-api_call_on_reveal_card_details

9f173af

marcaaron reviewed Oct 11, 2023

View reviewed changes

rushatgabhane suggested changes Oct 11, 2023

View reviewed changes

removed comment

8361350

rushatgabhane suggested changes Oct 12, 2023

View reviewed changes

lukemorawski requested a review from marcaaron October 19, 2023 16:10

rushatgabhane reviewed Oct 19, 2023

View reviewed changes

src/libs/actions/Card.js Outdated Show resolved Hide resolved

lukemorawski dismissed grgia’s stale review via dcb188b October 20, 2023 09:49

Update src/libs/actions/Card.js

dcb188b

Co-authored-by: Rushat Gabhane <rushatgabhane@gmail.com>

linting

8254860

grgia requested a review from rushatgabhane October 20, 2023 16:35

lukemorawski and others added 3 commits October 23, 2023 17:08

Merge branch 'main' into 22875-api_call_on_reveal_card_details

586f20e

merging with latest changes

aaa7042

Update src/languages/en.ts

95d4a43

Co-authored-by: Rushat Gabhane <rushatgabhane@gmail.com>

rushatgabhane approved these changes Oct 24, 2023

View reviewed changes

melvin-bot bot requested a review from grgia October 24, 2023 16:10

grgia mentioned this pull request Oct 25, 2023

[HOLD for payment 2023-11-22] [ECARD] CRITICAL: Settings - Reveal Details Follow Up - Add Error Handling #30329

Closed

removed error handling

934344a

grgia approved these changes Oct 25, 2023

View reviewed changes

marcaaron approved these changes Oct 25, 2023

View reviewed changes

marcaaron merged commit 65d4e2b into Expensify:main Oct 25, 2023
13 checks passed

OSBotify mentioned this pull request Oct 25, 2023

Deploy Checklist: New Expensify 2023-10-25 #30365

Closed

99 tasks

melvin-bot bot mentioned this pull request Oct 26, 2023

[HOLD for payment 2023-11-02] [ECARD] CRITICAL: Settings - Add API Calls when clicking “Reveal details” buttons. #22875

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

22875 Add API Calls when clicking “Reveal details” buttons #29017

22875 Add API Calls when clicking “Reveal details” buttons #29017

lukemorawski commented Oct 6, 2023 •

edited

Loading

MrMuzyk Oct 9, 2023

lukemorawski Oct 9, 2023

MrMuzyk Oct 9, 2023

lukemorawski Oct 9, 2023

MrMuzyk Oct 9, 2023

MrMuzyk Oct 9, 2023

MrMuzyk commented Oct 9, 2023

melvin-bot bot commented Oct 10, 2023

marcaaron left a comment

marcaaron Oct 10, 2023

marcaaron Oct 10, 2023

lukemorawski commented Oct 11, 2023

lukemorawski commented Oct 11, 2023

marcaaron left a comment

marcaaron Oct 11, 2023

marcaaron commented Oct 11, 2023

rushatgabhane commented Oct 11, 2023

rushatgabhane Oct 11, 2023

marcaaron Oct 12, 2023

grgia Oct 18, 2023

marcaaron Oct 19, 2023

rushatgabhane left a comment •

edited

Loading

rushatgabhane commented Oct 19, 2023

marcaaron commented Oct 19, 2023

lukemorawski commented Oct 20, 2023

rushatgabhane commented Oct 21, 2023 •

edited

Loading

rushatgabhane commented Oct 21, 2023 •

edited

Loading

grgia commented Oct 23, 2023

rushatgabhane left a comment •

edited

Loading

grgia commented Oct 25, 2023

rushatgabhane commented Oct 25, 2023 •

edited

Loading

grgia commented Oct 25, 2023

OSBotify commented Oct 25, 2023

OSBotify commented Oct 26, 2023

	cardDetailsLoadingFailure: 'An error occurred loading card details, please try again.',
	cardDetailsLoadingFailure: 'An error occurred while loading the card details. Please try again.',

22875 Add API Calls when clicking “Reveal details” buttons #29017

22875 Add API Calls when clicking “Reveal details” buttons #29017

Conversation

lukemorawski commented Oct 6, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

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

MrMuzyk commented Oct 9, 2023

melvin-bot bot commented Oct 10, 2023

marcaaron left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lukemorawski commented Oct 11, 2023

lukemorawski commented Oct 11, 2023

marcaaron left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcaaron commented Oct 11, 2023

rushatgabhane commented Oct 11, 2023

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

rushatgabhane left a comment • edited Loading

Choose a reason for hiding this comment

rushatgabhane commented Oct 19, 2023

marcaaron commented Oct 19, 2023

lukemorawski commented Oct 20, 2023

rushatgabhane commented Oct 21, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

rushatgabhane commented Oct 21, 2023 • edited Loading

grgia commented Oct 23, 2023

rushatgabhane left a comment • edited Loading

Choose a reason for hiding this comment

grgia commented Oct 25, 2023

rushatgabhane commented Oct 25, 2023 • edited Loading

grgia commented Oct 25, 2023

OSBotify commented Oct 25, 2023

OSBotify commented Oct 26, 2023

lukemorawski commented Oct 6, 2023 •

edited

Loading

rushatgabhane left a comment •

edited

Loading

rushatgabhane commented Oct 21, 2023 •

edited

Loading

rushatgabhane commented Oct 21, 2023 •

edited

Loading

rushatgabhane left a comment •

edited

Loading

rushatgabhane commented Oct 25, 2023 •

edited

Loading