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

Feature: Integrate OpenPolicyEditCardLimitTypePage api command to the app #47092

Merged

Conversation

waterim
Copy link
Contributor

@waterim waterim commented Aug 8, 2024

Details

Integrate OpenPolicyEditCardLimitTypePage api command to the app

Fixed Issues

$ #46959
$ #45924
PROPOSAL: N/A

Tests

Pre-step:
Comment out the feature check in the WorkspaceExpensifyCardDetailsPage file, so you can access the screen.
Also don't forget to disable policy?.areExpensifyCardsEnabled here

  1. Navigate to Workspace -> Members
  2. Click on the member
  3. Observe that cards displays correctly
  4. Click on Card
  5. Click on Limit type

Go through these steps from here:

Case 1: Monthly -> SmartLimit
Monthly-limit card with:
limit: $1000
currentSpend: $500
unapprovedSpend: $1100
totalSpend: $2000
If the admin updates the card to SmartLimit, we'll check if the unapprovedSpend >= limit - which in this case is true, so we'll show the warning: If you change this card's limit type to SmartLimit, new transactions will be declined because the $1,000 unapproved limit has already been reached.

Case 2: SmartLimit -> Monthly
SmartLimit card with:
limit: $1000
currentSpend: $1000
unapprovedSpend: $1000
totalSpend: $2000
If the admin updates the card to Monthly, unapprovedSpend >= limit is true so we'll show the warning: **If you change this card's limit type to monthly, new transactions will be declined because the $1,000 monthly limit has already been reached.**

Case 3: Monthly or SmartLimit -> Fixed
SmartLimit card with:
limit: $1000
currentSpend: $500
unapprovedSpend: $500
totalSpend: $2000
We'll check if totalSpend >= **limit - true, in this case so we won't show Fixed as an option

Case 4: Fixed -> SmartLimit
Fixed-limit card with:
limit: $1000
currentSpend: $500
unapprovedSpend: $500
totalSpend: $500
If the admin updates the card to SmartLimit, we'll check if unapprovedSpend >= limit - false, in this case so we won't show the warning

Case 5: Fixed -> Monthly
Fixed-limit card with:
limit: $1000
currentSpend: $500
unapprovedSpend: $500
totalSpend: $500
Updating the card to Monthly shouldn't cause any issues here since currentSpend is still within the limit so we won't show the warning

  • Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

None

  • 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 / Chrome
    • iOS / native
    • iOS / 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 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 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

unapprovedSpend > limit and changing MONTHLY -> SMART

image

unapprovedSpend > limit and changing SMART -> MONTLY

image

totalSpend > limit

image

unapprovedSpend > limit and changing FIXED -> SMART

image

@waterim waterim marked this pull request as ready for review August 8, 2024 16:21
@waterim waterim requested a review from a team as a code owner August 8, 2024 16:21
@melvin-bot melvin-bot bot requested review from dubielzyk-expensify and DylanDylann and removed request for a team August 8, 2024 16:21
Copy link

melvin-bot bot commented Aug 8, 2024

@dubielzyk-expensify @DylanDylann One of you needs to 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]

@dubielzyk-expensify
Copy link
Contributor

If this has visual changes, then it'd be great to get screenshots for desktop and mobile to review 😄

@DylanDylann
Copy link
Contributor

@waterim Please ping me when the PR is ready

@allgandalf
Copy link
Contributor

Taking this over from @DylanDylann , slack, Can you resolve merge conflicts and get this ready for review @waterim , thanks

@allgandalf
Copy link
Contributor

@waterim , can you update videos on all platforms

Copy link
Contributor

@allgandalf allgandalf left a comment

Choose a reason for hiding this comment

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

Few comments, looks good in the first review

src/ONYXKEYS.ts Outdated Show resolved Hide resolved
src/ONYXKEYS.ts Show resolved Hide resolved
Comment on lines 53 to 59
? 'workspace.expensifyCard.changeCardMonthlyLimitTypeWarning'
: 'workspace.expensifyCard.changeCardSmartLimitTypeWarning';
? 'workspace.expensifyCard.changeCardSmartLimitTypeWarning'
: 'workspace.expensifyCard.changeCardMonthlyLimitTypeWarning';
Copy link
Contributor

Choose a reason for hiding this comment

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

If we have initialLimitType as CONST.EXPENSIFY_CARD.LIMIT_TYPES.MONTHLY then we should fallback to 'workspace.expensifyCard.changeCardMonthlyLimitTypeWarning' like before right? I don't understand this change @waterim

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If we have initialLimitType as CONST.EXPENSIFY_CARD.LIMIT_TYPES.MONTHLY then we need to have SmartLimit warning because we are changing Monthly -> SmartLimit and warning will be for smartLimit and vise versa

Copy link
Contributor

Choose a reason for hiding this comment

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

ahh that makes senes to me!

if (card.unapprovedSpend !== undefined && card.nameValuePairs?.limit) {
// Spends are coming as negative numbers from the backend and we need to make it positive for the correct expression.
const unapprovedSpend = Math.abs(card.unapprovedSpend);
const isUnapprovedSpendOverLimit = unapprovedSpend >= card.nameValuePairs.limit;
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
const isUnapprovedSpendOverLimit = unapprovedSpend >= card.nameValuePairs.limit;
const isUnapprovedSpendOverLimit = unapprovedSpend > card.nameValuePairs.limit;

Does it mention in the design doc that we should block spends exactly equal to the limit too ? if not then just drop the equals to case

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, from this conversation

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't have access there, maybe you can copy paste the comments or we can reconfirm on slack, c.c. @mountiny @MariaHCD

Copy link
Contributor

Choose a reason for hiding this comment

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

The Slack thread where @MariaHCD wrote this uses >= but it makes sense to just be >. I would wait for Maria to confirm

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 we should check for >=

Let's say the current limit type of the card is Fixed and the admin wants to update the card to SmartLimit

If the unapprovedSpend is exactly equal to the limit, the card would no longer be usable if the card were updated to SmartLimit

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah got it, thanks for the example

src/types/onyx/Card.ts Show resolved Hide resolved
src/types/onyx/Card.ts Show resolved Hide resolved
@waterim
Copy link
Contributor Author

waterim commented Aug 12, 2024

@waterim , can you update videos on all platforms

I will upload screenshots for all cases, but this PR is not about adding new UI, do we really need to have videos from all platforms?

@allgandalf
Copy link
Contributor

I will upload screenshots for all cases, but this PR is not about adding new UI, do we really need to have videos from all platforms?

Not really, I can do that for you, the author checklist states:

I included screenshots or videos for tests on all platforms

But in this case i can do that for you, no worries

@waterim
Copy link
Contributor Author

waterim commented Aug 12, 2024

@allgandalf Added all cases screenshots, also found one bug, will push in 1 min

@waterim
Copy link
Contributor Author

waterim commented Aug 12, 2024

@allgandalf should be ready!

@allgandalf
Copy link
Contributor

@waterim what are the steps to get real data instead of the mock data? I am having trouble. I have connected bank account, but not able to add a virtual card and also get that card on the members details page

@waterim
Copy link
Contributor Author

waterim commented Aug 12, 2024

@waterim what are the steps to get real data instead of the mock data? I am having trouble. I have connected bank account, but not able to add a virtual card and also get that card on the members details page

if you have problems with createExpensifyCard maybe first checkout on the branch with ConfigureExpensifyCardsForPolicy #46564

This flow is not merged yet thats why you can't add new card without going on this PR

@allgandalf
Copy link
Contributor

Can you merge main @waterim , the linked PR was merged to main

@waterim
Copy link
Contributor Author

waterim commented Aug 12, 2024

@allgandalf merged

@allgandalf
Copy link
Contributor

Still trying to setup the card, @waterim I tried checkout out to that branch but not much lucj

@mountiny mountiny removed the request for review from DylanDylann August 13, 2024 10:51
@allgandalf
Copy link
Contributor

Umm reassure test failed, maybe merge main again to trigger the workflow?

@allgandalf
Copy link
Contributor

allgandalf commented Aug 13, 2024

Also why is CLA failing

@allgandalf
Copy link
Contributor

@waterim , this has conflicts

@allgandalf
Copy link
Contributor

allgandalf commented Aug 14, 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 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

Android: Native Screenshot 2024-08-14 at 5 46 13 PM
Android: mWeb Chrome Screenshot 2024-08-14 at 5 44 41 PM
iOS: Native Screenshot 2024-08-14 at 5 47 19 PM
iOS: mWeb Safari Screenshot 2024-08-14 at 5 47 48 PM
MacOS: Chrome / Safari Screenshot 2024-08-14 at 5 44 09 PM
MacOS: Desktop

Copy link
Contributor

@allgandalf allgandalf left a comment

Choose a reason for hiding this comment

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

Looks good to be merged

mountiny
mountiny previously approved these changes Aug 14, 2024
Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

One minor comment

Copy link
Contributor

@MariaHCD MariaHCD left a comment

Choose a reason for hiding this comment

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

LGTM! One small comment

const validCombinations = [
[CONST.EXPENSIFY_CARD.LIMIT_TYPES.MONTHLY, CONST.EXPENSIFY_CARD.LIMIT_TYPES.SMART],
[CONST.EXPENSIFY_CARD.LIMIT_TYPES.SMART, CONST.EXPENSIFY_CARD.LIMIT_TYPES.MONTHLY],
[CONST.EXPENSIFY_CARD.LIMIT_TYPES.FIXED, CONST.EXPENSIFY_CARD.LIMIT_TYPES.SMART],
Copy link
Contributor

Choose a reason for hiding this comment

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

We could also be updating a fixed limit card to monthly?

Copy link
Contributor

Choose a reason for hiding this comment

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

Screenshot 2024-08-14 at 8 04 34 PM Case 5 from the testing steps above allows that

Copy link
Contributor

Choose a reason for hiding this comment

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

So Fixed -> Monthly should be included in validCombinations, correct?

Copy link
Contributor

Choose a reason for hiding this comment

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

According to the docs, Yes!

Copy link
Contributor

Choose a reason for hiding this comment

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

Cool, @waterim could you update this? :)

Copy link
Contributor

Choose a reason for hiding this comment

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

They are OoO until monday :)

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, okay, I've just pushed a commit to add this

@MariaHCD MariaHCD merged commit 6c4502a into Expensify:main Aug 14, 2024
17 checks passed
@OSBotify
Copy link
Contributor

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

🚀 Deployed to staging by https://github.com/MariaHCD in version: 9.0.21-0 🚀

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

@mvtglobally
Copy link

@mountiny @MariaHCD We not exactly sure how to QA all the cases described in this PR. Any chance you can validate these internally?

@MariaHCD
Copy link
Contributor

Let's check this one off. We can test these internally (via full E2E tests) at a later stage.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 9.0.21-4 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 9.0.21-4 🚀

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

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.

8 participants