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

Updated total amount when change the different currency #35880

Merged
merged 16 commits into from
Feb 16, 2024

Conversation

dukenv0307
Copy link
Contributor

Details

Only amount of the first request is displayed in total

Fixed Issues

$ #35209
PROPOSAL: #35209 (comment)

Tests

  1. Go offline
  2. Click FAB > Request money > Manual.
  3. Request money from a user that has no existing chat.
  4. In 1:1 DM, click + > Request money.
  5. Create another manual request in a different currency
  6. Open the detail IOU page from second request
  7. Change the currency into same as first IOU
  8. Go to 1:1 conversation
  9. Verify that: Total from two IOU requests be present, since both requests are in same currency
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Go offline
  2. Click FAB > Request money > Manual.
  3. Request money from a user that has no existing chat.
  4. In 1:1 DM, click + > Request money.
  5. Create another manual request in a different currency
  6. Open the detail IOU page from second request
  7. Change the currency into same as first IOU
  8. Go to 1:1 conversation
  9. Verify that: Total from two IOU requests be present, since both requests are in same currency
  • 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
android.mov
Android: mWeb Chrome
android-mweb.mov
iOS: Native
ios.mov
iOS: mWeb Safari
ios.mov
MacOS: Chrome / Safari
web-resize.mp4
MacOS: Desktop
desktop-resize.mp4

@dukenv0307 dukenv0307 requested a review from a team as a code owner February 6, 2024 08:51
@melvin-bot melvin-bot bot removed the request for review from a team February 6, 2024 08:51
Copy link

melvin-bot bot commented Feb 6, 2024

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

@melvin-bot melvin-bot bot requested a review from cubuspl42 February 6, 2024 08:51
@cubuspl42
Copy link
Contributor

TypeScript Checks are failing

key: `${ONYXKEYS.COLLECTION.REPORT}${iouReport?.reportID}`,
value: {pendingAction: null},
});
let diff = 0;
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you refactor this not to use let? Maybe we could extract a local or non-local helper function.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@cubuspl42 I updated to create a local function.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm sorry, I wasn't clear enough. My suggestion was quite technical. I asked specifically whether we could refactor the code not to use the let, i.e. whether the code could be expressed without introducing a mutable variable.

Copy link
Contributor Author

@dukenv0307 dukenv0307 Feb 7, 2024

Choose a reason for hiding this comment

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

got it . I will re-update soon.

Copy link
Contributor

@cubuspl42 cubuspl42 Feb 7, 2024

Choose a reason for hiding this comment

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

Previously, we defined diff like: const diff = ....

I'm suggesting to keep it like this. The easiest way to keep the const is to introduce a helper function for calculating the difference. It can even be local and take no arguments; it's up to you.

function computeDiff() {
  if (someCondition1) {
    return anything;
  } else if (someCondition2) {
    return something;
  } else {
    return somethingElse;
  }
}

const diff = computeDiff();

I think it's best to introduce as few mutable variables to the code as possible.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, that is the current ideal I will re-update.

Copy link
Contributor

Choose a reason for hiding this comment

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

By "local" I actually meant local in the most-inner surrounding scope. It could also be understood as module-local, as opposed to exported from a module; I didn't mean that.

Copy link
Contributor Author

@dukenv0307 dukenv0307 Feb 7, 2024

Choose a reason for hiding this comment

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

getUpdateMoneyRequestParams function is very complex so I think we should create an outside function.

@cubuspl42
Copy link
Contributor

TypeScript Checks are failing

@dukenv0307 ☝️

@dukenv0307
Copy link
Contributor Author

TypeScript Checks are failing

It's fixed now.


if (updatedCurrency === iouReport?.currency && currentCurrency !== iouReport?.currency) {
// add the diff with the total if we change the currency from different currency to the currency of the iou report
return TransactionUtils.getAmount(updatedTransaction, isExpenseReport);
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you add new helper consts above the if blocks, like...

const oldAmount = TransactionUtils.getAmount(transaction, isExpenseReport);
const updateAmount = TransactionUtils.getAmount(updatedTransaction, isExpenseReport);

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated with two variables before the if blocks.

/**
* Compute the diff amount when we update the transaction
*/
function computeDiffAmount(iouReport: OnyxEntry<OnyxTypes.Report>, updatedTransaction: OnyxEntry<OnyxTypes.Transaction>, transaction: OnyxEntry<OnyxTypes.Transaction>): number {
Copy link
Contributor

Choose a reason for hiding this comment

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

I like this change! It clearly separates the computation of the diff from the surrounding logic of getUpdateMoneyRequestParams. That function is already long enough.

Copy link
Contributor

@cubuspl42 cubuspl42 Feb 7, 2024

Choose a reason for hiding this comment

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

Actually, would you have anything against changing this name to calculateDiffAmount? "Calculation" is "computing" but with numbers. I should have suggested this name in the first place.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree.

const currentCurrency = TransactionUtils.getCurrency(transaction);

if (updatedCurrency === iouReport?.currency && currentCurrency !== iouReport?.currency) {
// add the diff with the total if we change the currency from different currency to the currency of the iou report
Copy link
Contributor

Choose a reason for hiding this comment

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

Add the diff to the total if we change the currency from a different currency to the currency of the IOU report

Copy link
Contributor

Choose a reason for hiding this comment

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

If English is not your native language, it can be very hard to use "a" and "the" correctly. In general, we use "a"/"an" if we talk about an entity/person/object from a group/set/category, without having a specific instance in mind (jn the given context). We use "the" when we talk about a specific instance (in the given context).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for your knowledge, noted it and will improve in the future.

return -TransactionUtils.getAmount(updatedTransaction, isExpenseReport);
}
if (updatedCurrency === iouReport?.currency && updatedTransaction?.modifiedAmount) {
// get the diff between the updated amount and the current amount if we change the amount and the currency of the transaction is the currency of the report
Copy link
Contributor

Choose a reason for hiding this comment

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

I can't spot any language mistakes! 😃

I suggested to start the other comment with a capital letter, so we could do this here, too, for consistency. We could also say "calculate", as it's more specific than "get".

Calculate the diff between the updated amount and the current amount if we change the amount and the currency of the transaction is the currency of the report

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated this comment.

return TransactionUtils.getAmount(updatedTransaction, isExpenseReport);
}
if (updatedCurrency !== iouReport?.currency && currentCurrency === iouReport?.currency) {
// subtract the diff with the total if we change the currency from the currency of iou report to different currency
Copy link
Contributor

Choose a reason for hiding this comment

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

Subtract the diff from the total if we change the currency from the currency of IOU report to a different currency

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated this comment.

@cubuspl42
Copy link
Contributor

@dukenv0307 Bump!

@cubuspl42
Copy link
Contributor

@dukenv0307 Bump again

@dukenv0307
Copy link
Contributor Author

I'm on the traditional holiday until February 15th

@cubuspl42
Copy link
Contributor

All possible checks are failing, so let's fix that 🙂

@dukenv0307
Copy link
Contributor Author

I missed resolving a conflict.

@dukenv0307
Copy link
Contributor Author

@cubuspl42 All checks are fixed now.

@cubuspl42
Copy link
Contributor

It doesn't look right. The sum should be 100 PLN, not 120 PLN.

total-after-currency-change-issue-1-web-converted.mp4

@dukenv0307
Copy link
Contributor Author

Thanks, I missed this case.

@dukenv0307
Copy link
Contributor Author

@cubuspl42 I updated to fix the case above and also fix the case when deleting the request.

@cubuspl42
Copy link
Contributor

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
fix-total-amount-android-compressed.mp4
Android: mWeb Chrome
fix-total-amount-android-web-compressed.mp4
iOS: Native
fix-total-amount-ios-compressed.mp4
iOS: mWeb Safari
fix-total-amount-ios-web-compressed.mp4
MacOS: Chrome / Safari
fix-total-amount-web-converted.mp4
MacOS: Desktop
fix-total-amount-desktop-converted.mp4

@tylerkaraszewski tylerkaraszewski merged commit f28dd93 into Expensify:main Feb 16, 2024
16 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/tylerkaraszewski in version: 1.4.43-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.43-20 🚀

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.

4 participants