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

[Wave Collect] [Workflows] Display meaningful message when currency is not available for Direct Reimbursement #38318

Merged
merged 36 commits into from
Mar 20, 2024

Conversation

lakchote
Copy link
Contributor

@lakchote lakchote commented Mar 14, 2024

Details

Currently, there are no meaningful message displayed to the user when he has a currency not compatible with direct reimbursement, and he wants to use Make or track payments in Simplified Collect Workflows.

See #38235 and #38206
and latest updates from discussion here.

In addition to that, error messages were not handled for Delayed Submissions Add approvals.

Moreover, errors were not taken care of in Workspace > Profile for Currency, Description, and Workspace name.

This PR aims to solve these issues.

Fixed Issues

$ #38206
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Prerequisites:

  • have collect policy enabled on NewDot (instructions)
  • Make or track payments in Workflows toggled to off.
  • No VBBA set up

Test 1

  1. Go to Workspace > Profile, select an unsupport currency for direct reimbursement such as UGX
  2. Go to Workspace > Workflows, toggle on Make or track payments
  3. Click on Connect bank account
  4. You should see this modal:

change_currency

  1. Cancel it
  2. Click again on Connect bank account
  3. The modal should appear again.
  4. Click on Update to USD
  5. You should see this in the RHP:
image

Test 2

  1. Enable Make or track payments and ensure the toggle turns on
  2. Tap Connect bank account and go through the flow to set up a VBBA account
  3. Disable Make or track payments, ensure the toggle turns off
  4. Change the workspace default currency to a non-USD currency
  5. Enable Make or track payments, ensure the toggle is on
  6. Tap Connect bank account and Update to USD in the modal
  7. Dismiss the bank account modal and verify that you can toggle Make or track payments off

(Only for Expensify engineers)

In order to test Delayed Submission and Add approval errors, we'll need to force an error being thrown in the backend.

Throw an exception in PolicyAPI:update for Add approval, and do the same in PolicyAPI::setAutoHarvesting for Delayed Submission.

You should see something like this after trying to toggle them:

image

Offline tests

Complete the same steps as in the Tests section above. Whenever you come back online, the error messages should display.

QA Steps

  • Verify that no errors appear in the JS console
    Same as in Tests section above (except for the section related to Expensify engineers).

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 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 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari Screenshots are in `Tests` section above.
MacOS: Desktop

@lakchote lakchote self-assigned this Mar 14, 2024
@lakchote lakchote requested a review from a team as a code owner March 14, 2024 15:15
@lakchote lakchote requested review from luacmartins and mountiny and removed request for a team March 14, 2024 15:15
@melvin-bot melvin-bot bot requested a review from robertjchen March 14, 2024 15:15
Copy link

melvin-bot bot commented Mar 14, 2024

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

@lakchote
Copy link
Contributor Author

Please keep in mind that I'll be OOO tomorrow.

@lakchote lakchote changed the title [Wave Collect] [Workflows] Better errors handling [HOLD] [Wave Collect] [Workflows] Better errors handling Mar 14, 2024
@lakchote
Copy link
Contributor Author

lakchote commented Mar 14, 2024

Putting this on HOLD.

We'll need to change the error location for direct reimbursement and prevent setting direct reimbursement as soon as Make or track payments is toggled.

See discussion here.

@lakchote lakchote changed the title [HOLD] [Wave Collect] [Workflows] Better errors handling [Wave Collect] [Workflows] Display meaningful message when currency is not available for Direct Reimbursement Mar 18, 2024
@lakchote
Copy link
Contributor Author

@luacmartins @robertjchen @mountiny ready for review!

Comment on lines +1076 to +1081
autoReportingErrorMessage: 'The delayed submission parameter could not be changed. Please try again or contact support.',
autoReportingFrequencyErrorMessage: 'The submission frequency could not be changed. Please try again or contact support.',
monthlyOffsetErrorMessage: 'The monthly frequency could not be changed. Please try again or contact support.',
},
workflowsApprovalPage: {
genericErrorMessage: 'The approver could not be changed. Please try again or contact support.',
Copy link
Contributor

Choose a reason for hiding this comment

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

Has marketing reviewed these copies?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Asked about it here

Copy link
Contributor

Choose a reason for hiding this comment

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

@lakchote This is usually done using Marketing label autoassigner on the linked issue so we get one dedicated person for this

Comment on lines 132 to 139
const CURRENCY_AU = 'AUD';
const CURRENCY_CA = 'CAD';
const CURRENCY_GB = 'GBP';
const CURRENCY_US = 'USD';
const CURRENCY_EUR = 'EUR';

const DIRECT_REIMBURSEMENT_CURRENCIES: string[] = [CURRENCY_AU, CURRENCY_CA, CURRENCY_EUR, CURRENCY_GB, CURRENCY_US];

Copy link
Contributor

Choose a reason for hiding this comment

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

We already have these defined here, it also seems like we support NZD, which is missing in your list above

Copy link
Contributor

Choose a reason for hiding this comment

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

+1 definitely lets reuse this from Const or add there what is missing there

Copy link
Contributor Author

@lakchote lakchote Mar 19, 2024

Choose a reason for hiding this comment

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

We already have these defined here, it also seems like we support NZD, which is missing in your list above

NZD is not supported for direct reimbursement it seems?

See here.

I'm going to remove it in order to be ISO with PHP-Libs.

src/libs/actions/Policy.ts Outdated Show resolved Hide resolved
src/pages/workspace/WorkspaceProfilePage.tsx Outdated Show resolved Hide resolved
src/pages/workspace/WorkspaceProfilePage.tsx Outdated Show resolved Hide resolved
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.

Looking good, couple comments

Comment on lines 132 to 139
const CURRENCY_AU = 'AUD';
const CURRENCY_CA = 'CAD';
const CURRENCY_GB = 'GBP';
const CURRENCY_US = 'USD';
const CURRENCY_EUR = 'EUR';

const DIRECT_REIMBURSEMENT_CURRENCIES: string[] = [CURRENCY_AU, CURRENCY_CA, CURRENCY_EUR, CURRENCY_GB, CURRENCY_US];

Copy link
Contributor

Choose a reason for hiding this comment

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

+1 definitely lets reuse this from Const or add there what is missing there

src/libs/actions/Policy.ts Outdated Show resolved Hide resolved
src/pages/workspace/workflows/WorkspaceWorkflowsPage.tsx Outdated Show resolved Hide resolved
src/pages/workspace/workflows/WorkspaceWorkflowsPage.tsx Outdated Show resolved Hide resolved
@luacmartins
Copy link
Contributor

@jjcoffee this would be an important PR to prioritize review.

@lakchote
Copy link
Contributor Author

Changes look good to me but I think we should resolve @jjcoffee concerns with testing and clarify those

I've handled them, waiting for @jjcoffee review.

@@ -219,10 +217,10 @@ function WorkspaceWorkflowsPage({policy, betas, route, reimbursementAccount, ses
</>
),
isEndOptionRow: true,
isActive: policy?.reimbursementChoice !== CONST.POLICY.REIMBURSEMENT_CHOICES.REIMBURSEMENT_NO,
isActive: policy?.reimbursementChoice === CONST.POLICY.REIMBURSEMENT_CHOICES.REIMBURSEMENT_YES,
Copy link
Contributor

Choose a reason for hiding this comment

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

This prevents the toggle getting toggled on if a workspace has a non-USD currency (as the toggle will set it to REIMBURSEMENT_MANUAL). I think the previous commit worked fine for this.

const effectiveReimbursementChoice = shouldUseDirectReimbursement ? newReimbursementChoice : CONST.POLICY.REIMBURSEMENT_CHOICES.REIMBURSEMENT_MANUAL;
const effectiveReimbursementChoice = shouldUseDirectReimbursement
? CONST.POLICY.REIMBURSEMENT_CHOICES.REIMBURSEMENT_YES
: CONST.POLICY.REIMBURSEMENT_CHOICES.REIMBURSEMENT_MANUAL;
Copy link
Contributor

Choose a reason for hiding this comment

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

Almost there! If I revert the change I commented on here, I can't toggle off, because we now never set REIMBURSEMENT_NO. The way I see it, we need to check if we are enabling the toggle (reimbursementChoice === REIMBURSEMENT_NO), then switch between REIMBURSEMENT_YES and REIMBURSEMENT_MANUAL based on shouldUseDirectReimbursement, otherwise we are turning the toggle off so should set to REIMBURSEMENT_NO.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you @jjcoffee, I've pushed up a new commit here, let me know what you think!

@jjcoffee
Copy link
Contributor

jjcoffee commented Mar 20, 2024

Since this slightly edge-case flow seems to be causing a bit of trouble, I'm pulling out some test steps here. It might be worth adding them to the PR test steps @lakchote so QA pick up on it too:

  1. Enable Make or track payments and ensure the toggle turns on
  2. Tap Connect bank account and go through the flow to set up a VBBA account
  3. Disable Make or track payments, ensure the toggle turns off
  4. Change the workspace default currency to a non-USD currency
  5. Enable Make or track payments, ensure the toggle is on
  6. Tap Connect bank account and Update to USD in the modal
  7. Dismiss the bank account modal and verify that you can toggle Make or track payments off

@lakchote lakchote force-pushed the lucien/fix-worklows-error-messages branch from dfc3e8b to adb5d5e Compare March 20, 2024 16:45
@lakchote
Copy link
Contributor Author

Since this slightly edge-case flow seems to be causing a bit of trouble, I'm pulling out some test steps here. It might be worth adding them to the PR test steps @lakchote so QA pick up on it too:

  1. Enable Make or track payments and ensure the toggle turns on
  2. Tap Connect bank account and go through the flow to set up a VBBA account
  3. Disable Make or track payments, ensure the toggle turns off
  4. Change the workspace default currency to a non-USD currency
  5. Enable Make or track payments, ensure the toggle is on
  6. Tap Connect bank account and Update to USD in the modal
  7. Dismiss the bank account modal and verify that you can toggle Make or track payments off

Good point, test steps updated!

Copy link
Contributor

@jjcoffee jjcoffee left a comment

Choose a reason for hiding this comment

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

LGTM and tests well!

@melvin-bot melvin-bot bot requested a review from rlinoz March 20, 2024 17:02
Copy link

melvin-bot bot commented Mar 20, 2024

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

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

LGTM!

@luacmartins luacmartins merged commit 399077f into main Mar 20, 2024
19 checks passed
@luacmartins luacmartins deleted the lucien/fix-worklows-error-messages branch March 20, 2024 17:37
@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/luacmartins in version: 1.4.56-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.56-8 🚀

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.

6 participants