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

Workspace currency optimistic actions update #33171

Merged
merged 8 commits into from
Jan 3, 2024

Conversation

esh-g
Copy link
Contributor

@esh-g esh-g commented Dec 15, 2023

Details

Fixed Issues

$ #31638
PROPOSAL: #31638 (comment)

Tests

Test 1

  1. Create a new workspace.
  2. Click on the bank account to change currency to USD
  3. Go to the expense report of the workspace
  4. Make a request of any amount.
  5. Go offline.
  6. Make another request in a currency that is not USD.
  7. Make sure the preview is greyed out and the amount gets updated once we get online.

Test 2

  1. Create a new workspace.
  2. Click on the bank account to change currency to USD
  3. Go to the expense report of the workspace
  4. Go offline.
  5. Make a request in a currency that is not USD.
  6. Make sure that we are shown that currency in the preview and it gets updated to USD once online.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Test 1

  1. Create a new workspace.
  2. Click on the bank account to change currency to USD
  3. Go to the expense report of the workspace
  4. Make a request of any amount.
  5. Go offline.
  6. Make another request in a currency that is not USD.
  7. Make sure the preview is greyed out and the amount gets updated once we get online.

Test 2

  1. Create a new workspace.
  2. Click on the bank account to change currency to USD
  3. Go to the expense report of the workspace
  4. Go offline.
  5. Make a request in a currency that is not USD.
  6. Make sure that we are shown that currency in the preview and it gets updated to USD once online.
  • 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: 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
325822be-5b00-4975-b866-59d629090c07.mp4
ef0777e2-8964-4bb6-ba88-7941ede3e90e.mp4
Android: mWeb Chrome
041b2ba4-5cc3-4181-aa6f-4a5364aa9790.mp4
b4d7b0a6-443c-4909-a760-1a887ada23a2.mp4
iOS: Native
3e7c8dc7-04bb-4755-93fa-dc8dda8d3201.mp4
18d3b201-afbd-4380-865f-ac32a2278eba.mp4
iOS: mWeb Safari
MacOS: Chrome / Safari
2380fe02-f64e-4cdc-a518-5d3647e30e0e.mp4
c4606897-d3d0-4c75-9466-62e1cc1b680f.mp4
MacOS: Desktop
04da6809-a236-4414-9aa2-c4bba9af2e72.mp4
91b4692a-2ce0-43e9-9b80-5ddb450b1bd9.mp4

@esh-g esh-g requested a review from a team as a code owner December 15, 2023 16:18
@melvin-bot melvin-bot bot requested review from c3024 and removed request for a team December 15, 2023 16:19
Copy link

melvin-bot bot commented Dec 15, 2023

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


// Because of the Expense reports are stored as negative values, we substract the total from the amount
iouReport.total -= amount;
if (policy.outputCurrency === currency) {
Copy link
Contributor

@c3024 c3024 Dec 17, 2023

Choose a reason for hiding this comment

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

I think we better use lodash here so that it does not crash when we make a distance request in the workspace chat because we are not passing any policy here and accessing outputCurrency on undefined will crash the app.

@esh-g
Copy link
Contributor Author

esh-g commented Dec 19, 2023

@c3024 Upon further inspection, I noticed that this does solve the following case:

  1. Create a workspace with default currency as USD.
  2. Make 1-2 requests in USD.
  3. Make the default currency of the workspace INR.
  4. Try to make a request in INR.

We see that the iouReport and the reportPreview retain the original USD currency because that was the currency with which the IOU report was made. At first I thought that we update the iouReport once we change the default currency of the workspace to be in that currency.

But since it seems that we don't do that, would be be alright if we check for the currency of the iouReport rather than the outputCurrency of the workspace?

if (lodashGet(iouReport, 'currency') === currency) {

The question basically is that if the user updates the workspace default currency, then should the iouReport be updated to that currency or not.

  • If yes, then we can go with the changes already made in the PR
  • If no, then we would have to update to check the iouReport currency instead of policy.outputCurrency...

@c3024
Copy link
Contributor

c3024 commented Dec 20, 2023

Nice find.

The question basically is that if the user updates the workspace default currency, then should the iouReport be updated to that currency or not.

The currency and the amount of the iouReport comes from the backend, right? So, if we need to update the iouReport to workspace default currency, it would require forex conversion and I think it would need backend changes, correct?

@esh-g
Copy link
Contributor Author

esh-g commented Dec 21, 2023

Yes @c3024 that would require backend changes. Moreover, I think we need to make the decision whether that conversion should happen or not as well. But I think that can be a separate issue as well... maybe feedback from an internal engineer is required.

@c3024
Copy link
Contributor

c3024 commented Dec 22, 2023

The question basically is that if the user updates the workspace default currency, then should the iouReport be updated to that currency or not.

I too think is outside the scope of this issue.

if (lodashGet(iouReport, 'currency') === currency) {
If no, then we would have to update to check the iouReport currency instead of policy.outputCurrency.

We should get the currency from iouReport like you pointed out. This is not inconsistent with the Slack discussion as well.

Please make those changes.

We will refer our discussion to the CME for final approval of PR.

If they suggest something different then their suggested changes can be incorporated.

@esh-g
Copy link
Contributor Author

esh-g commented Dec 23, 2023

@c3024 Made the requested changes

@c3024
Copy link
Contributor

c3024 commented Dec 25, 2023

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(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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
reportPreviewEshTest1Android.mov
reportPreviewEshTest2Android.mov
Android: mWeb Chrome
iOS: Native
reportPreviewEshTest1iOSNative.mov
reportPreviewEshTest2iOSNative.mov
iOS: mWeb Safari
reportPreviewEshTestiOSSafari.mov
MacOS: Chrome / Safari
reportPreviewEshTestMacChrome.mov
MacOS: Desktop
reportPreviewEshTestMacDesktop.mov

@c3024
Copy link
Contributor

c3024 commented Dec 25, 2023

Please attach test videos of all platforms.

@esh-g
Copy link
Contributor Author

esh-g commented Dec 27, 2023

@c3024 Really sorry for the delay... I have been trying to make the web version work on mWeb safari but for some reason the simulator doesn't load beyond the logo page. Videos for other platforms has been attached.

@esh-g
Copy link
Contributor Author

esh-g commented Dec 27, 2023

Fixed the conflict that came up

Copy link
Contributor

@c3024 c3024 left a comment

Choose a reason for hiding this comment

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

LGTM

@melvin-bot melvin-bot bot requested a review from nkuoch December 29, 2023 16:16
nkuoch
nkuoch previously approved these changes Jan 2, 2024
@nkuoch
Copy link
Contributor

nkuoch commented Jan 2, 2024

Ah sorry can you fix the conflict @esh-g ?

@esh-g
Copy link
Contributor Author

esh-g commented Jan 3, 2024

@nkuoch Fixed!

@nkuoch nkuoch merged commit f518ab9 into Expensify:main Jan 3, 2024
16 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Jan 3, 2024

✋ 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

OSBotify commented Jan 4, 2024

🚀 Deployed to staging by https://github.com/nkuoch in version: 1.4.22-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jan 4, 2024

🚀 Deployed to staging by https://github.com/nkuoch in version: 1.4.22-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jan 9, 2024

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.22-6 🚀

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

onPress={() => IOU.submitReport(props.iouReport)}
/>
)}
{!isScanning && (numberOfRequests > 1 || hasReceipts) && (
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 #33874

We should have checked for a partial merchant. i.e. (none)

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.

5 participants