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

Ask non-USD Workspaces to update currency before adding VBBA #19638

Merged
merged 22 commits into from
Jun 19, 2023

Conversation

luacmartins
Copy link
Contributor

@luacmartins luacmartins commented May 25, 2023

Details

Part 1 of 2 from #16744
Here we'll start preventing users from initiating/completing the VBBA flow if their Workspace currency is different than USD.

Fixed Issues

$ #16744

Tests

  1. Create a Workspace
  2. Navigate to Settings > Workspace > Settings > Default Currency
  3. Set the currency to AED
  4. Navigate to Settings > Workspace > Bank account
  5. Verify that you see the modal below
  6. Tap Cancel
  7. Verify that the modal is closed
  8. Tap Bank account again and verify that the modal opens again
  9. Tap Update to USD
  10. Verify that you are redirected to the Connect bank account page
  11. Navigate to Settings > Workspace > Settings > Default Currency
  12. Verify that the currency is now set to USD
  13. Change the currency to AED again

Steps below are for Web only:

  1. In the URL bar, copy the Workspace id. For example 9283AFFC0378797B in workspace/9283AFFC0378797B/settings
  2. Navigate directly to /bank-account/CompanyStep?policyID=<Workspace id>, replacing <Workspace id> with the value copied in step 14
  3. Verify that you see the following error message Oops! It appears that your workspace currency is set to a different currency than USD. To proceed, please set it to USD and try again
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as tests

  • 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
    • 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
web.mov
Mobile Web - Chrome
chrome.mov
Mobile Web - Safari
safari.mov
Desktop
desktop.mov
iOS
ios.mov
Android
android.mov

@luacmartins luacmartins self-assigned this May 25, 2023
@luacmartins luacmartins marked this pull request as ready for review June 8, 2023 19:51
@luacmartins luacmartins requested a review from a team as a code owner June 8, 2023 19:51
@melvin-bot melvin-bot bot requested review from rushatgabhane and thienlnam and removed request for a team June 8, 2023 19:51
@melvin-bot
Copy link

melvin-bot bot commented Jun 8, 2023

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

@mountiny mountiny self-requested a review June 12, 2023 15:36
@mountiny
Copy link
Contributor

@rushatgabhane Will you be able to complete the checklist on this one or should we ask some other C+?

@rushatgabhane
Copy link
Member

@mountiny I'll be able to complete it

@luacmartins
Copy link
Contributor Author

luacmartins commented Jun 13, 2023

This is a race condition between Policy.updateGeneralSettings and OpenReimbursementAccountPage. I think we have two options here:

  1. Use makeRequestWithSideEffects to first update the currency and then navigate to the bank page, which calls OpenReimbursementAccountPage
  2. Create a new API command to update the currency and return the data in OpenReimbursementAccountPage. This solution would normally be preferred, but in this case I'm unsure. We'd have to somehow prevent calling OpenReimbursementAccountPage if we're being navigated from the currency update modal but then call it in every other instance.

@thienlnam @mountiny would love your thoughts on the above solutions

@thienlnam
Copy link
Contributor

We're run into a similar situation where we're navigating to a page and the onyx data hasn't been set yet. Creating a new room and immediately navigating to it.

What we ended up doing was using onyx.set for the items we needed for navigation bc it was much faster, would that be possible here as well?

@mountiny
Copy link
Contributor

Is what Jack proposed possible here?

Otherwise I feel like if new command works for this then it could be a way to go. It matches the 1:1:1 strategy

@luacmartins
Copy link
Contributor Author

Now that I'm thinking more about it, I'm not sure if the issue @rushatgabhane is seeing is a race condition. I'll try to reproduce it on my end to investigate.

@luacmartins
Copy link
Contributor Author

So it does seem to be an Onyx race condition. I updated updateGeneralSettings to use SET. @rushatgabhane can you test the changes and see if you can still reproduce the issue?

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

LGTM

cc: @mountiny

@melvin-bot
Copy link

melvin-bot bot commented Jun 16, 2023

We did not find an internal engineer to review this PR, trying to assign a random engineer to #16744... Please reach out for help on Slack if no one gets assigned!

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 change requested, otherwise LGTM

src/pages/ReimbursementAccount/ReimbursementAccountPage.js Outdated Show resolved Hide resolved
@luacmartins
Copy link
Contributor Author

@mountiny updated!

Copy link
Contributor

@thienlnam thienlnam left a comment

Choose a reason for hiding this comment

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

Thanks, sending it!

@thienlnam
Copy link
Contributor

Jk, can't need Vit to re-approve

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.

Thanks everyone!

@mountiny mountiny merged commit 158c34b into main Jun 19, 2023
@mountiny mountiny deleted the cmartins-blockNonUSDVBBA branch June 19, 2023 14:54
@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/mountiny in version: 1.3.30-0 🚀

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

Li357 pushed a commit that referenced this pull request Jun 22, 2023
…VBBA"

This reverts commit 158c34b, reversing
changes made to 057a182.
@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.30-5 🚀

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

Comment on lines +346 to +352
if (this.state.shouldShowContinueSetupButton) {
return (
<ContinueBankAccountSetup
reimbursementAccount={this.props.reimbursementAccount}
continue={this.continue}
policyName={policyName}
/>
Copy link
Contributor

Choose a reason for hiding this comment

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

cc @luacmartins, This block is duplicated now, check line 384 ,we intentionally changed the order of rendering in this PR #20406.

Copy link
Contributor Author

@luacmartins luacmartins Jul 4, 2023

Choose a reason for hiding this comment

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

ah nice catch. Do we have a PR to fix this already?

Copy link
Contributor

Choose a reason for hiding this comment

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

No we don't have a PR yet, needed to confirm before moving forward. I will create a PR.

Copy link
Contributor

Choose a reason for hiding this comment

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

PR is ready : #22253

<Text>{this.props.translate('bankAccount.hasBeenThrottledError')}</Text>
</View>
);
const hasUnsupportedCurrency = lodashGet(this.props.policy, 'outputCurrency', '') !== CONST.CURRENCY.USD;
Copy link
Contributor

Choose a reason for hiding this comment

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

This line caused an edge case regression, when the policy is empty (deleted from other device) it will display the CurrencyError, we fixed that by displaying FullPageNotFoundView when policy is deleted.

@@ -512,9 +512,12 @@ function clearAvatarErrors(policyID) {
function updateGeneralSettings(policyID, name, currency) {
const optimisticData = [
{
onyxMethod: Onyx.METHOD.MERGE,
// We use SET because it's faster than merge and avoids a race condition when setting the currency and navigating the user to the Bank account page in confirmCurrencyChangeAndHideModal
onyxMethod: Onyx.METHOD.SET,
Copy link
Member

Choose a reason for hiding this comment

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

Coming from #37254 (comment)

Because we're using Onyx.set, we should have spread the old pendingFields.

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