[NoQA] Integrate OpenPolicyExpensifyCardsPage API call #47064

VickyStash · 2024-08-08T12:12:13Z

Details

This PR enables OpenPolicyExpensifyCardsPage API call and makes sure all of the relevant data is used correctly by the app.

Fixed Issues

$ #44310
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

Pre-steps:

Have all betas/workspaceFeed beta enabled

Go to the workspace where Expensify Card feature is enabled and several cards are added.
Open Expensify Card screen from the workspace navigation menu
Make sure the data is received successfully from OpenPolicyExpensifyCardsPage and that you see your cards are displayed.
Open one of the cards and go to Edit Card Limit screen. Update the limit and make sure the UpdateExpensifyCardLimit call returns the expected result and that your limit is updated.
Go to the workspace where Expensify Card feature is enabled and no cards are added. Make sure the OpenPolicyExpensifyCardsPage returns the expected result and that you see the empty page state.

Offline tests

Same as in the Tests section.

QA Steps

Verify that no errors appear in the JS console

Same as in the Tests section.

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

MacOS: Chrome / Safari

…instead of policyID in cards_ and sharedNVP_private_expensifyCardSettings_ onyx keys; TS fixes

src/libs/actions/Policy/Policy.ts

…CardsPage-integration # Conflicts: # src/pages/workspace/WorkspaceMoreFeaturesPage.tsx # src/pages/workspace/expensifyCard/WorkspaceEditCardLimitTypePage.tsx # src/pages/workspace/expensifyCard/WorkspaceExpensifyCardListPage.tsx # src/pages/workspace/expensifyCard/WorkspaceSettlementAccountPage.tsx

…CardsPage-integration # Conflicts: # src/libs/actions/Card.ts # src/pages/workspace/WorkspaceMoreFeaturesPage.tsx # src/pages/workspace/accounting/reconciliation/CardReconciliationPage.tsx # src/pages/workspace/accounting/reconciliation/ReconciliationAccountSettingsPage.tsx # src/pages/workspace/expensifyCard/WorkspaceCardListHeader.tsx # src/pages/workspace/expensifyCard/WorkspaceCardSettingsPage.tsx # src/pages/workspace/expensifyCard/WorkspaceEditCardLimitPage.tsx # src/pages/workspace/expensifyCard/WorkspaceExpensifyCardPage.tsx # src/pages/workspace/expensifyCard/WorkspaceSettlementAccountPage.tsx # src/pages/workspace/expensifyCard/WorkspaceSettlementFrequencyPage.tsx

melvin-bot · 2024-08-13T10:05:42Z

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

allgandalf

No major changes required, @VickyStash can you address those please really minor

src/pages/workspace/expensifyCard/WorkspaceCardListHeader.tsx

src/pages/workspace/expensifyCard/WorkspaceExpensifyCardPage.tsx

allgandalf · 2024-08-13T11:00:04Z

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

MacOS: Chrome / Safari

Screen.Recording.2024-08-13.at.4.35.49.PM.mov

MacOS: Desktop

Screen.Recording.2024-08-13.at.4.38.52.PM.mov

Android: Native

Screen.Recording.2024-08-13.at.4.53.18.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-08-13.at.4.55.23.PM.mov

iOS: Native

Screen.Recording.2024-08-13.at.4.49.46.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-08-13.at.4.48.27.PM.mov

allgandalf · 2024-08-13T11:24:14Z

@VickyStash , can you mark this as no QA please, they won't be able to test it

allgandalf

Test conditions look good on all platfomrs

mountiny

Great work everyone

mountiny · 2024-08-13T11:37:26Z

src/pages/workspace/expensifyCard/WorkspaceExpensifyCardListPage.tsx

+                const userA = personalDetails?.[cardA.accountID ?? '-1'] ?? {};
+                const userB = personalDetails?.[cardB.accountID ?? '-1'] ?? {};
+                const aName = PersonalDetailsUtils.getDisplayNameOrDefault(userA);
+                const bName = PersonalDetailsUtils.getDisplayNameOrDefault(userB);


NAB, it might be nice to have some helper method sort by name of cardholder

mountiny · 2024-08-13T11:39:47Z

src/types/onyx/ExpensifyCardSettings.ts

@@ -9,7 +9,7 @@ type ExpensifyCardSettings = OnyxCommon.OnyxValueWithOfflineFeedback<{
    remainingLimit: number;

    /** The total amount of cash back earned thus far */
-    cashBack: number;
+    earnedCashback: number;


This should be optional same as remainingLimit and currentBalance

Suggested change

earnedCashback: number;

earnedCashback?: number;

OSBotify · 2024-08-13T11:58:07Z

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

OSBotify · 2024-08-13T20:39:55Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.20-0 🚀

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

Beamanator · 2024-08-16T19:53:17Z

FYI I believe this was deployed to prod yesterday, from this checklist - #47356

VickyStash added 4 commits August 8, 2024 14:06

Enable OpenPolicyExpensifyCardsPage API call; Use workspaceAccountID …

27c0427

…instead of policyID in cards_ and sharedNVP_private_expensifyCardSettings_ onyx keys; TS fixes

Use correct field as a card limit

b451dc2

Add card list page loading indication

3d75456

Fix console error

7ba11bc

VickyStash mentioned this pull request Aug 9, 2024

[Workspace Feeds] [External] Create new Edit Card Limit page #44326

Closed

mountiny reviewed Aug 11, 2024

View reviewed changes

src/libs/actions/Policy/Policy.ts Outdated Show resolved Hide resolved

VickyStash added 2 commits August 12, 2024 14:59

TS fix

7f9caf6

DylanDylann mentioned this pull request Aug 13, 2024

Feat/44309 be integration create expensify card #46570

Merged

61 tasks

VickyStash added 4 commits August 13, 2024 08:54

TS fixes after merging main

81ec4f0

Minor code improvements

229f13b

Improve the list loading

0b0b3e4

VickyStash changed the title ~~[WIP] Integrate OpenPolicyExpensifyCardsPage API call~~ Integrate OpenPolicyExpensifyCardsPage API call Aug 13, 2024

VickyStash marked this pull request as ready for review August 13, 2024 10:05

VickyStash requested a review from a team as a code owner August 13, 2024 10:05

melvin-bot bot requested a review from allgandalf August 13, 2024 10:05

melvin-bot bot removed the request for review from a team August 13, 2024 10:05

VickyStash mentioned this pull request Aug 13, 2024

[Workspace Feeds] [External] Create new Card List page #44310

Closed

mountiny assigned VickyStash Aug 13, 2024

allgandalf reviewed Aug 13, 2024

View reviewed changes

src/pages/workspace/expensifyCard/WorkspaceCardListHeader.tsx Outdated Show resolved Hide resolved

src/pages/workspace/expensifyCard/WorkspaceExpensifyCardPage.tsx Show resolved Hide resolved

Pass policyID to WorkspaceCardListHeader

2554ac1

allgandalf approved these changes Aug 13, 2024

View reviewed changes

melvin-bot bot requested a review from mountiny August 13, 2024 11:26

mountiny changed the title ~~Integrate OpenPolicyExpensifyCardsPage API call~~ [NoQA] Integrate OpenPolicyExpensifyCardsPage API call Aug 13, 2024

mountiny approved these changes Aug 13, 2024

View reviewed changes

mountiny merged commit 55ded55 into Expensify:main Aug 13, 2024
18 of 24 checks passed

github-actions bot mentioned this pull request Aug 13, 2024

Deploy Checklist: New Expensify 2024-08-13 #47356

Closed

72 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NoQA] Integrate OpenPolicyExpensifyCardsPage API call #47064

[NoQA] Integrate OpenPolicyExpensifyCardsPage API call #47064

VickyStash commented Aug 8, 2024 •

edited

Loading

melvin-bot bot commented Aug 13, 2024

allgandalf left a comment

allgandalf commented Aug 13, 2024 •

edited

Loading

allgandalf commented Aug 13, 2024

allgandalf left a comment

mountiny left a comment

mountiny Aug 13, 2024

mountiny Aug 13, 2024

OSBotify commented Aug 13, 2024

OSBotify commented Aug 13, 2024

Beamanator commented Aug 16, 2024

[NoQA] Integrate OpenPolicyExpensifyCardsPage API call #47064

[NoQA] Integrate OpenPolicyExpensifyCardsPage API call #47064

Conversation

VickyStash commented Aug 8, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 13, 2024

allgandalf left a comment

Choose a reason for hiding this comment

allgandalf commented Aug 13, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

allgandalf commented Aug 13, 2024

allgandalf left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

mountiny Aug 13, 2024

Choose a reason for hiding this comment

mountiny Aug 13, 2024

Choose a reason for hiding this comment

OSBotify commented Aug 13, 2024

OSBotify commented Aug 13, 2024

Beamanator commented Aug 16, 2024

VickyStash commented Aug 8, 2024 •

edited

Loading

allgandalf commented Aug 13, 2024 •

edited

Loading