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

Add CurrencySelectionList component and use it in IOU and WS currency settings #30889

Merged
merged 17 commits into from
Apr 30, 2024

Conversation

tsa321
Copy link
Contributor

@tsa321 tsa321 commented Nov 5, 2023

Details

Fixed Issues

$ #29618
PROPOSAL: #29618 (comment)

Tests

  1. Go to workspace settings and select default currency
  2. The currency selection list will appears and type "euro"
  3. The euro currency must be available in the list
  4. Select the euro currency, then notice the default currency is changed into euro
  5. Repeat step 2-4 for other search text like "rupee", "pound", "Australia" then notice the Indian rupee , England pounds, Australia dollar is available in the list for the respected search text
  6. Go to + fab button -> select money request -> go to manual tab -> click the currency
  7. Repeat the step 2-5
  8. Go to IOU request money address like: https://dev.new.expensify.com:8082/request/new/currency/?currency=HUF&backTo=%2Frequest%2Fnew%2Fmanual then notice the selected currency code is HUF
  9. Change the HUF text of the address into JPY and notice the selected currency in the list is JPY
  • Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

  1. Go to workspace settings and select default currency
  2. The currency selection list will appears and type "euro"
  3. The euro currency must be available in the list
  4. Select the euro currency, then notice the default currency is changed into euro
  5. Repeat step 2-4 for other search text like "rupee", "pound", "Australia" then notice the Indian rupee , England pounds, Australia dollar is available in the list for the respected search text
  6. Go to + fab button -> select money request -> go to manual tab -> click the currency
  7. Repeat the step 2-5
  8. Go to IOU request money address like: https://dev.new.expensify.com:8082/request/new/currency/?currency=HUF&backTo=%2Frequest%2Fnew%2Fmanual then notice the selected currency code is HUF
  9. Change the HUF text of the address into JPY and notice the selected currency in the list is JPY
  • 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
      • 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 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 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

Android: Native
android-native_d.mp4
Android: mWeb Chrome
android-mweb_d.mp4
iOS: Native
ios-native_d.mp4
iOS: mWeb Safari
ios-msfari_d.mp4
MacOS: Chrome / Safari
macos-web_d.mp4
MacOS: Desktop
macos-desktop_d.mp4

… settings

Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>
@tsa321 tsa321 requested a review from a team as a code owner November 5, 2023 04:00
@melvin-bot melvin-bot bot requested review from parasharrajat and removed request for a team November 5, 2023 04:00
Copy link

melvin-bot bot commented Nov 5, 2023

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

@tsa321
Copy link
Contributor Author

tsa321 commented Nov 5, 2023

@parasharrajat Currently the behavior of the workspace default currency setting is still the same.
and I have some doubts before applying the url currency parameter for the workspace currency settings:

ss:

Screenshot 2023-11-04 at 19 50 58 copy

Screenshot 2023-11-04 at 19 33 27 copy

If the url parameter of currency is different than current policy currency stored in onyx, should we change the selected currency based on the url parameter?

Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>
@parasharrajat
Copy link
Member

If the url parameter of currency is different than current policy currency stored in onyx, should we change the selected currency based on the url parameter?

Only on Currency Selection page, the URL parameter will manage the selection. Then it should be removed when going back to workspace settings page.

Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>
@tsa321
Copy link
Contributor Author

tsa321 commented Nov 8, 2023

@parasharrajat I have add the URL parameter for workspace currency settings page and update the route accordingly.
In my latest commit the focused currency is based on URL parameter and the selected currency is based on currency of the policy stored in onyx. The result is something like this:

Screenshot 2023-11-08 at 20 24 16 ed

If it is weird, I will revert back to make the focused and selected currency based on URL parameter.

@tsa321
Copy link
Contributor Author

tsa321 commented Nov 9, 2023

Friendly bump @parasharrajat , Could you review my pr when you have a chance? thank you...

@tsa321
Copy link
Contributor Author

tsa321 commented Nov 21, 2023

@parasharrajat are you ready to review this PR? I will merge main

@parasharrajat
Copy link
Member

parasharrajat commented Nov 22, 2023

Apologies for the delay here. I had build issues last week so couldn't focus on it. Unfortunately, I will be AFK till the weekend. But I am sure I can get this reviewed on Monday.

#30889 (comment)

This is a weird situation. I currently don't have a direct answer here but I can dig into that. I would suggest that we follow similar patterns that are already being used in the App. May be try finding a similar page in the app and see what is done there.

@parasharrajat
Copy link
Member

There is another variant of such a pattern in the APP used around CountrySelectionPage. Things to check would be comparing and seeing what is different between both. And can we stick to one?

…in selection list

Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>
Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>
@tsa321
Copy link
Contributor Author

tsa321 commented Nov 24, 2023

@parasharrajat done. The behavior will be like country selection page and will also fix #31650

@cead22
Copy link
Contributor

cead22 commented Nov 27, 2023

@tsa321 will it fix #29822?

@tsa321
Copy link
Contributor Author

tsa321 commented Nov 27, 2023

@cead22 yes, this will also fix that issue. I will follow the displayed text of the workspace currency setting, which is agreed in here.

Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>
Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>
@parasharrajat
Copy link
Member

Started review.

Keyboard.dismiss();
Navigation.goBack(ROUTES.WORKSPACE_INITIAL.getRoute(policy.id));
Navigation.navigate(ROUTES.WORKSPACE_INITIAL.getRoute(policy.id));
Copy link
Contributor Author

@tsa321 tsa321 Dec 4, 2023

Choose a reason for hiding this comment

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

I change the goBack with navigate because if we open currency selection page by url for example: https://dev.new.expensify.com:8082/workspace/WORKSPACEID/settings/currency?currency=NZD then click a currency then click save it will go back to currency selection list page and not to workspace setting page.

Also occurs in back button press of the header of workspace setting page. Should I change it too?

Copy link
Member

Choose a reason for hiding this comment

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

Ah, It shouldn't IMP. There is some issue with doing this. Let me check.


const onSelectCurrency = (item) => {
Policy.updateGeneralSettings(policy.id, policy.name, item.keyForList);
Navigation.goBack(ROUTES.WORKSPACE_SETTINGS.getRoute(policy.id));
Navigation.navigate(ROUTES.WORKSPACE_SETTINGS.getRoute(policy.id, item.currencyCode));
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 am using navigate here because, goBack won't properly pass currency parameter when user select a currency to previous page.

Country selection page also use navigate:

Navigation.navigate(`${route.params.backTo}?country=${option.value}`);

The video:

goback-1_d.mp4

@parasharrajat
Copy link
Member

I am currently OOO. I plan to continue this in 2 days. There are no urgent PRs/issues on my side so I would be able to fully focus here.

@tsa321
Copy link
Contributor Author

tsa321 commented Dec 30, 2023

@parasharrajat if there is navigation problem here, I suggest to solve the issue separately in here: #31650 to get the best solution to fix the issue about Default Currency Updated Without Clicking "Save" Button.

@parasharrajat
Copy link
Member

Thanks for waiting here. It's been long but I was somewhat waiting on request flow migration done by Tgolen which would update IOUCurrencySelection. But it seems that we are completely removing that component #34607.

More details #29107.

This affects this PR as we are trying to update IOUCurrencySelection.

What should we do?

  1. Revert all the changes done on IOUCurrencySelection.
  2. If a better solution has been implemented in IOURequestStepCurrency, analyze this.
  3. Revisit the solution.

I will start analyzing the changes myself to speed up the process.

@tsa321 tsa321 changed the title Add CurrencySelectionList component and use it in IOU and WS currency settings [HOLD] Add CurrencySelectionList component and use it in IOU and WS currency settings Mar 10, 2024
@parasharrajat
Copy link
Member

We should be good here @tsa321 to move ahead.

Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>
@tsa321 tsa321 changed the title [HOLD] Add CurrencySelectionList component and use it in IOU and WS currency settings Add CurrencySelectionList component and use it in IOU and WS currency settings Apr 16, 2024
tsa321 added 3 commits April 16, 2024 17:08
Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>
Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>
@parasharrajat
Copy link
Member

parasharrajat commented Apr 16, 2024

@tsa321 Please ping me when this is ready for review.

@tsa321

This comment was marked as outdated.

@tsa321
Copy link
Contributor Author

tsa321 commented Apr 16, 2024

@parasharrajat for now it is ready for review...

@parasharrajat
Copy link
Member

So the issue you mentioned is unrelated. @tsa321 Could you please merge main? Testing it now.

@parasharrajat
Copy link
Member

We need to merge main to be able to test it properly. Please merge main when possible and I will finish my testing immediately before another conflict.

@tsa321
Copy link
Contributor Author

tsa321 commented Apr 24, 2024

@parasharrajat main merged

@parasharrajat
Copy link
Member

parasharrajat commented Apr 24, 2024

Screenshots

🔲 iOS / native

Screen.Recording.2024-04-24.at.5.51.15.PM.mov

🔲 iOS / Safari

Screen.Recording.2024-04-24.at.5.54.13.PM.mov

🔲 MacOS / Desktop

Screen.Recording.2024-04-24.at.3.37.52.PM.mov

🔲 MacOS / Chrome

Screen.Recording.2024-04-24.at.3.33.04.PM.mov

🔲 Android / Chrome

Screen.Recording.2024-04-24.at.3.41.53.PM.mov

🔲 Android / native

Screen.Recording.2024-04-24.at.4.32.25.PM.mov

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

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.

🎀 👀 🎀 C+ reviewed

@melvin-bot melvin-bot bot requested a review from cead22 April 24, 2024 12:29
@parasharrajat
Copy link
Member

@cead22 Bump for review.

Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>
Copy link
Contributor

@cead22 cead22 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, but there's conflicts again

/** Constant, list of available currencies */
currencyList: OnyxEntry<CurrencyList>;
};
type WorkspaceProfileCurrentPageProps = WithPolicyAndFullscreenLoadingProps;
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
type WorkspaceProfileCurrentPageProps = WithPolicyAndFullscreenLoadingProps;
type WorkspaceProfileCurrencyPageProps = WithPolicyAndFullscreenLoadingProps;

};

type CurrencySelectionListOnyxProps = {
/** Constant, list of available currencies */
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
/** Constant, list of available currencies */
/** List of available currencies */


type CurrencySelectionListProps = CurrencySelectionListOnyxProps & {
/** Label for the search text input */
textInputLabel: string;
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB

Suggested change
textInputLabel: string;
searchInputLabel: string;

tsa321 added 2 commits April 30, 2024 06:35
Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>
Signed-off-by: Tsaqif <tsaiinkwa@yahoo.com>
@tsa321 tsa321 requested a review from cead22 April 30, 2024 00:05
@tsa321
Copy link
Contributor Author

tsa321 commented Apr 30, 2024

@cead22 I have made some changes based on your review...

@cead22 cead22 merged commit 4c1e8b8 into Expensify:main Apr 30, 2024
15 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

OSBotify commented May 1, 2024

🚀 Deployed to staging by https://github.com/cead22 in version: 1.4.69-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented May 2, 2024

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.69-2 🚀

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.

6 participants