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

FIX: Implement pattern C for money reports with various currencies #35062

Merged

Conversation

BartoszGrajdek
Copy link
Contributor

@BartoszGrajdek BartoszGrajdek commented Jan 24, 2024

Details

While working on #31345 I have noticed that when money report contains money requests with currencies different than default currency of the money report itself the app cannot handle calculations like getting a total amount while the user is offline. Because of that after a discussion on Slack with Expensify team it was decided that for now we want to implement pattern C whenever there's a money request sent with a different currency.

Fixed Issues

N/A (Details above)

Tests

  1. Send a couple of money requests with different currencies to a workspace, or just normal IOU
  2. Make sure that the total amount on the money report is displayed & calculated properly
  3. Check if you can pay for the money report from parent chat window (the settlement button in top right corner should be enabled)
  4. Check if you can pay for the money report from the money report chat itself (the settlement button in top right corner should be enabled)

Offline tests

  1. Send a money request (you can do this part offline as well as online) if you're sending it to a workspace try sending it using the default currency set for that workspace
  2. Go offline
  3. Open up the newly created money report
  4. Check if you can still pay for that money report & the total amount is displayed with full opacity - the button should be enabled, you don't need to go through the process of payment, if you do then afterwards please go back online and repeat steps 1. & 2.
  5. Now send a request using a different currency
  6. Check if the total amount in the money report summary is set to opacity = 0.5
  7. Check if the button in top right corner has been disabled (it should be)
  8. Make sure to go back into the parent chat, where the money report preview can be seen, the settlement button should be disabled as well
  9. Go back online and after all API requests has been sent check if you can now pay the money report

QA Steps

Online
  1. Send a couple of money requests with different currencies to a workspace, or just normal IOU
  2. Make sure that the total amount on the money report is displayed & calculated properly
  3. Check if you can pay for the money report from parent chat window (the settlement button in top right corner should be enabled)
  4. Check if you can pay for the money report from the money report chat itself (the settlement button in top right corner should be enabled)
Offline
  1. Send a money request (you can do this part offline as well as online) if you're sending it to a workspace try sending it using the default currency set for that workspace
  2. Go offline
  3. Open up the newly created money report
  4. Check if you can still pay for that money report & the total amount is displayed with full opacity - the button should be enabled, you don't need to go through the process of payment, if you do then afterwards please go back online and repeat steps 1. & 2.
  5. Now send a request using a different currency
  6. Check if the total amount in the money report summary is set to opacity = 0.5
  7. Check if the button in top right corner has been disabled (it should be)
  8. Make sure to go back into the parent chat, where the money report preview can be seen, the settlement button should be disabled as well
  9. Go back online and after all API requests has been sent check if you can now pay the money report

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.mp4
Android: mWeb Chrome
chrome.mp4
iOS: Native
ios.mp4
iOS: mWeb Safari
safari.mp4
MacOS: Chrome / Safari
web.mp4
MacOS: Desktop
desktop.mp4

@BartoszGrajdek BartoszGrajdek marked this pull request as ready for review January 29, 2024 20:45
@BartoszGrajdek BartoszGrajdek requested a review from a team as a code owner January 29, 2024 20:45
@melvin-bot melvin-bot bot requested review from johnmlee101 and removed request for a team January 29, 2024 20:45
Copy link

melvin-bot bot commented Jan 29, 2024

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

@johnmlee101
Copy link
Contributor

Adding @allroundexperts to help review this and do the checklist

@allroundexperts
Copy link
Contributor

allroundexperts commented Jan 30, 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 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
Screen.Recording.2024-01-31.at.3.12.06.AM.mov
Android: mWeb Chrome
Screen.Recording.2024-01-31.at.3.00.57.AM.mov
iOS: Native
Screen.Recording.2024-01-31.at.2.58.37.AM.mov
iOS: mWeb Safari
Screen.Recording.2024-01-31.at.2.51.03.AM.mov
MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/30054992/595fa564-2f9a-4d91-9a84-1018a1ad49de
https://github.com/Expensify/App/assets/30054992/b61aa5e0-5983-4d39-b086-179170c7a6f0

MacOS: Desktop
Screen.Recording.2024-01-31.at.2.46.34.AM.mov

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

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

Works good!

Copy link

melvin-bot bot commented Jan 30, 2024

🎯 @allroundexperts, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #35441.

@allroundexperts
Copy link
Contributor

Forgot to post this previously, but I think the following is not related to this PR. @BartoszGrajdek Can you please confirm before merging?

Screenshot 2024-01-31 at 2 41 05 AM

}

const transactions = TransactionUtils.getAllReportTransactions(report.reportID);

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

Copy link
Contributor

Choose a reason for hiding this comment

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

+1

@johnmlee101
Copy link
Contributor

Forgot to post this previously, but I think the following is not related to this PR. @BartoszGrajdek Can you please confirm before merging?

Let's confirm this before I approve 😄

@BartoszGrajdek
Copy link
Contributor Author

I think that's not something related to this PR, but I'll check it today to make sure 🫡

@johnmlee101
Copy link
Contributor

Any update @BartoszGrajdek ?

@BartoszGrajdek
Copy link
Contributor Author

BartoszGrajdek commented Feb 4, 2024

I don't get an error like the one you've sent, so maybe it got fixed after merging the main? @allroundexperts let me know if you can still see it. I would like to wait for the main to get fixed first though, because it seems like there are some problems there

@BartoszGrajdek
Copy link
Contributor Author

Alright, I've checked to make sure and all the errors I'm getting are the same as on the main branch. The one you've sent @allroundexperts seems to have disappeared to it most likely got fixed. cc @johnmlee101

@johnmlee101 johnmlee101 merged commit 43d1576 into Expensify:main Feb 5, 2024
15 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Feb 5, 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 Feb 5, 2024

🚀 Cherry-picked to staging by https://github.com/thienlnam in version: 1.4.36-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

1 similar comment
@OSBotify
Copy link
Contributor

OSBotify commented Feb 5, 2024

🚀 Cherry-picked to staging by https://github.com/thienlnam in version: 1.4.36-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

@OSBotify
Copy link
Contributor

OSBotify commented Feb 7, 2024

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.37-7 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 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.

None yet

5 participants