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 selection is saved even though we don't press Save yet #18995

Merged

Conversation

bernhardoj
Copy link
Contributor

Details

When we select a currency from the currency list selection, it will immediately saved it to the onyx. We want to change it so the currency is only saved when the user press Save.

Fixed Issues

$ #18667
PROPOSAL: #18667 (comment)

Tests

Same as QA Steps

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

  1. Press the global + (FAB) button
  2. Choose Send Money
  3. Enter any amount and press Next
  4. Select any participant
  5. Press Amount to edit the amount
  6. Press the currency to go to the currency selection page
  7. Choose any currency that is different from the current currency
  8. Press the arrow back (Go back)
  9. Verify the currency shown in Amount is not changed
  10. Repeat step 6-7
  11. Now, press Save
  12. Verify the currency shown in Amount is changed with the new selected 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 / 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
Screen.Recording.2023-05-16.at.15.02.34.mov
Mobile Web - Chrome
WhatsApp.Video.2023-05-16.at.15.27.42.mp4
Mobile Web - Safari
Screen.Recording.2023-05-16.at.15.10.33.mov
Desktop
Screen.Recording.2023-05-16.at.15.04.08.mov
iOS
Screen.Recording.2023-05-16.at.15.11.24.mov
Android
Screen.Recording.2023-05-16.at.15.11.24.mov

@bernhardoj bernhardoj requested a review from a team as a code owner May 16, 2023 08:19
@melvin-bot melvin-bot bot requested review from arosiclair and Santhosh-Sellavel and removed request for a team May 16, 2023 08:19
@melvin-bot
Copy link

melvin-bot bot commented May 16, 2023

@arosiclair @Santhosh-Sellavel 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]

@bernhardoj
Copy link
Contributor Author

Sorry for taking it long. I was trying to make sure to cover edge cases.

  1. Accessing the currency list without backTo params
    A user can directly access the url of currency list (/send/new/currency) without passing the backTo params. To prevent any error, we just navigate them back if backTo is empty when the user select any currency.

  2. Refreshing the page while at the currency list page
    We have an open issue that is caused by this action in the year picker page here [HOLD for payment 2023-06-01] [$1000] On reload on date year search page, date search selection breaks #18815. Here is the issue:

When we refresh the page, the navigation stack history will be lost. So, when we go to the currency list, we have this stack:
Home -> MoneyRequestModal -> IOU currency list

If we refresh the page, the stack becomes
Home -> IOU currency list

When we select a currency, instead of going back, it will push the MoneyRequestModal to the stack. However, focus listener won't get called on component mount. This will messed up the selection as can be seen from the mentioned issue above. The solution from the selected proposal on that issue is to also get the selected option on component mount. However, the solution raise another issue for our case (explanation below). So, to (maybe temporarily) solve this, we check if IOU currency is the only route on the stack, we just go back, the same thing we did with the 1st case above.

I will show first the video of the issue if we get the selected currency on component mount too.

Screen.Recording.2023-05-16.at.16.41.55.mov

Notice that the currency looks like it is "saved" in the amount page. How can that happen?

  1. First, we open the send money page. It will show the initial amount step. Then we go all the way to the confirmation step. Notice that the url path does not change because the money request step is all in one screen/page (MoneyRequestModal).
  2. Then, we open the iou currency list (a separate screen/page). The backTo params value will be /send/new
  3. When we pick a currency (let say USD), we will go back to /send/new with a new params, currency. So, the new path is /send/new/?currency=USD even though the params is not shown on the url. (full url now new.expensify.com/send/new/?currency=USD)
  4. Now, we go back from the amount step to the confirmation step. Then, we go again to the edit amount step. When the edit amount step mount, it will get the currency from the current url params which is USD. This makes the edit amount have the previous selected currency.

This can happen because all money request step is in the same screen/page. The selected currency from IOU currency list is "shared" to all steps. One way we can solve this is to separate each step to each stack screen, so all of them has their own path. I have an open PR for that, but currently we are waiting for some confirmation before continuing it.

Let me know if there is anything confusing 😄.

src/ROUTES.js Outdated Show resolved Hide resolved
@bernhardoj
Copy link
Contributor Author

Hmm, the lint failed because there is a prettier dif, so I run npm run prettier but nothing changes. 😕

@bernhardoj
Copy link
Contributor Author

prettier diff comes from this PR #18865

src/pages/iou/IOUCurrencySelection.js Show resolved Hide resolved
src/pages/iou/IOUCurrencySelection.js Outdated Show resolved Hide resolved
arosiclair
arosiclair previously approved these changes May 18, 2023
Copy link
Contributor

@arosiclair arosiclair left a comment

Choose a reason for hiding this comment

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

Looks good thanks for the changes

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented May 18, 2023

@bernhardoj App gets crashed while trying to open Currency selection page

Screen.Recording.2023-05-19.at.1.57.30.AM.mov

cc: @arosiclair

Comment on lines 97 to 98
return _.map(this.props.currencyList, (currencyInfo, currencyCode) => {
const isSelectedCurrency = currencyCode === this.props.iou.selectedCurrencyCode;
const isSelectedCurrency = currencyCode === this.state.selectedCurrencyCode;
Copy link
Collaborator

Choose a reason for hiding this comment

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

The crash occurs here. This methodgetCurrencyOptions is called while initializing the state and trying to access the state.selectedCurrencyCode while it's not defined

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, my bad. I didn't retest after moving the selected currency code to a state. So, I guess we have 2 options:

  1. Take it out from the state and just put it back in a static variable
  2. Update getCurrencyOptions to accept selectedCurrencyCode.

I personally prefer the first one as it's a static value. What do you think? @Santhosh-Sellavel @arosiclair

Copy link
Contributor

Choose a reason for hiding this comment

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

After looking closer I think we should replace selectedCurrencyCode with a getSelectedCurrencyCode function instead. We can use that function in getCurrencyOptions() and render(). That should fix this while keeping everything reactive to prop changes.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's a nice idea. Updated and test well. Thanks for the help!

@Santhosh-Sellavel
Copy link
Collaborator

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 / Chrome
    • iOS / native
    • iOS / 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(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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web & Desktop
Screen.Recording.2023-05-20.at.1.13.11.AM.mov
Mobile Web - Chrome & Mobile Web - Safari
Screen.Recording.2023-05-20.at.1.07.18.AM.mov
iOS & Android
Screen.Recording.2023-05-20.at.1.11.27.AM.mov

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

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

LGTM tests well!

All yours @arosiclair

@arosiclair arosiclair merged commit 84ef813 into Expensify:main May 19, 2023
@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/arosiclair in version: 1.3.17-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.17-5 🚀

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

@marcaaron
Copy link
Contributor

marcaaron commented Jun 6, 2023

Came across this PR and had some general feedback. I have some doubts about passing the currency in the route params with the "backTo". And wonder if it's the best way to achieve what we are trying to do. Another way this could work is something like:

  • Create a unique page for each case where we need to save the currency selection with the logic to save the currency
  • No need to pass the currency or activeRoute around to create a link between the pages. Whatever needs it can get it from the props of the data that we are changing when we call a "save" function.

I'm not too sure what would go into setting things up to work that way and there are probably even better solutions - just something to think about!

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