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 currency breaking issue with currency conversion #43133

Merged
merged 4 commits into from
Jun 6, 2024

Conversation

b4s36t4
Copy link
Contributor

@b4s36t4 b4s36t4 commented Jun 5, 2024

Details

Fixed Issues

$ #43004
PROPOSAL: #43004 (comment)

Tests

Maybe a technical testing is required than manual QA

  1. Open any report
  2. Click (+) icon > Submit expense then submit an expense
  3. Open the expense report that you created it in step 2 and Verify the app is not crashed
  • extra steps for Web and Desktop only
  1. Open your browser console and type Onyx.merge("report_<your_report_id>",{currency: null}) then press Enter. You can get your_report_id from browser link.
  2. Verify the app is not crashed
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Same as Above

  • 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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
Kapture.2024-06-06.at.01.21.00.mp4
Android: mWeb Chrome
Kapture.2024-06-06.at.01.45.31.mp4
iOS: Native
Kapture.2024-06-06.at.00.49.17.mp4
iOS: mWeb Safari
Kapture.2024-06-06.at.01.02.36.mp4
MacOS: Chrome / Safari
Kapture.2024-06-05.at.21.43.29.mp4
MacOS: Desktop
Kapture.2024-06-05.at.22.21.38.mp4

@b4s36t4 b4s36t4 requested a review from a team as a code owner June 5, 2024 16:55
@melvin-bot melvin-bot bot removed the request for review from a team June 5, 2024 16:55
Copy link

melvin-bot bot commented Jun 5, 2024

@ahmedGaber93 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 ahmedGaber93 June 5, 2024 16:55
@b4s36t4
Copy link
Contributor Author

b4s36t4 commented Jun 5, 2024

I'll update the recordings shortly.

@b4s36t4
Copy link
Contributor Author

b4s36t4 commented Jun 5, 2024

@ahmedGaber93 can you take latest pull from main and execute the Onyx.merge command on a IOU report please?

I'm getting the following error, wanted to know if it's because of my commits or it's on latest itself.

I tried on main but wanted to make sure again, so asking you.

Screenshot 2024-06-05 at 10 27 16 PM

@ahmedGaber93
Copy link
Contributor

@b4s36t4 I don't think this related to your PR.

@b4s36t4
Copy link
Contributor Author

b4s36t4 commented Jun 5, 2024

Thanks for checking @ahmedGaber93 .

@b4s36t4
Copy link
Contributor Author

b4s36t4 commented Jun 5, 2024

@ahmedGaber93 Please go ahead with your review and testing. I have uploaded the videos as well (except android chrome, setting up ssl certificated would be done soon).

Commit verification is also being handled, just wanted to unblock you.

@ahmedGaber93
Copy link
Contributor

ahmedGaber93 commented Jun 5, 2024

@b4s36t4 I think you missed those two places

const formattedAmount = CurrencyUtils.convertToDisplayString(transactionDetails?.amount ?? 0, transactionDetails?.currency ?? '');

const formattedAmount = CurrencyUtils.convertToDisplayString(transactionDetails?.amount ?? 0, transactionDetails?.currency ?? '');

Also why typescript not catch this?

@b4s36t4
Copy link
Contributor Author

b4s36t4 commented Jun 5, 2024

because keyof CurrencyList is of type string. which itself again leaves it to string.

Although typescript doesn't catch this I had a validation condition inside the function which will catch there even if we miss here.

@b4s36t4
Copy link
Contributor Author

b4s36t4 commented Jun 5, 2024

@ahmedGaber93 please check now updated, sorry for missing it out!.

@ahmedGaber93
Copy link
Contributor

type CurrencyList = Record<string, Currency | null>;

Yes, CurrencyList key is string as the list seem come from backend and save to onyx not static in the code

src/libs/CurrencyUtils.ts Outdated Show resolved Hide resolved
Comment on lines 121 to 124
let validatedCurrency = currency;
if (!currency || currency.length === 0 || currency.length > 3) {
validatedCurrency = 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.

I think we can simplify this condition to !currency and this will check for undefined or ''

let currencyWithFallback = currency;
if (!currency) {
    currencyWithFallback = CONST.CURRENCY.USD;
}

Also, I think it is self-explanatory

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yea, but my idea is to make it explain the value shouldn't be empty string as well.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yea, but my idea is to make it explain the value shouldn't be empty string as well.

Ok, we can simplify the comment, maybe like this // Fallback currency to USD if it empty string or undefined

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done, updated.!

Copy link
Contributor

@ahmedGaber93 ahmedGaber93 Jun 5, 2024

Choose a reason for hiding this comment

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

@b4s36t4 I think this syntax is better than the new one you pushed

let currencyWithFallback = currency;
if (!currency) {
    currencyWithFallback = CONST.CURRENCY.USD;
}

@ahmedGaber93
Copy link
Contributor

@b4s36t4 I think we need to simplify Tests to

  1. Open any report
  2. Click (+) icon > Submit expense then submit an expense
  3. Open the expense report that you created it in step 2 and Verify the app is not crashed
  • extra steps for Web and Desktop only
  1. Open your browser console and type Onyx.merge("report_<your_report_id>",{currency: null}) then press Enter. You can get your_report_id from browser link.
  2. Verify the app is not crashed

@b4s36t4
Copy link
Contributor Author

b4s36t4 commented Jun 5, 2024

Agree, updating.!

@ahmedGaber93
Copy link
Contributor

@b4s36t4 We still need to update #43133 (comment) and #43133 (comment).
And please remove this part as it already cover by step 4 and maybe misleads QA team as it should be null not INR.

Screenshot 2024-06-06 at 12 42 02 AM

Thanks for your patience.

@ahmedGaber93

This comment was marked as outdated.

@ahmedGaber93
Copy link
Contributor

ahmedGaber93 commented Jun 5, 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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
a.mp4
Android: mWeb Chrome
aw.mp4
iOS: Native
ios.mp4
iOS: mWeb Safari
iw.mp4
MacOS: Chrome / Safari
20240606012640236.mp4
MacOS: Desktop
d.mp4

@ahmedGaber93
Copy link
Contributor

@b4s36t4 this issue is urgent, are you able to update this #43133 (comment) today?

@b4s36t4
Copy link
Contributor Author

b4s36t4 commented Jun 6, 2024

@ahmedGaber93 Sorry I went to sleep at that time. I have updated the changes you requested can you please check again?

Copy link
Contributor

@ahmedGaber93 ahmedGaber93 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 srikarparsi June 6, 2024 05:24
Copy link
Contributor

@srikarparsi srikarparsi left a comment

Choose a reason for hiding this comment

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

code looks good and tests well, thanks for the quick changes

@srikarparsi srikarparsi merged commit 90dee7a into Expensify:main Jun 6, 2024
16 of 17 checks passed
@srikarparsi
Copy link
Contributor

srikarparsi commented Jun 6, 2024

QA, if you're not able to follow the test steps (deals with the browser console), please tag me and I can help QA it.

@OSBotify
Copy link
Contributor

OSBotify commented Jun 6, 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

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.81-11 🚀

platform result
🤖 android 🤖 failure ❌
🖥 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