Create amount filter #47343
Create amount filter #47343
Conversation
|
@luacmartins I noticed that when we set url with param |
|
@rayane-djouah 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] |
|
I'll OOO the whole next week but I asked @289Adam289 to take care of merging this one 😄 |
| // Remove spaces from the newAmount value because Safari on iOS adds spaces when pasting a copied value | ||
| // More info: https://github.com/Expensify/App/issues/16974 | ||
| const newAmountWithoutSpaces = stripSpacesFromAmount(newAmount); | ||
| const replacedCommasAmount = replaceCommaWithDot(newAmountWithoutSpaces); |
There was a problem hiding this comment.
| const replacedCommasAmount = replaceCommaWithDot(newAmountWithoutSpaces); | |
| const replacedCommasAmount = replaceCommasWithPeriod(newAmountWithoutSpaces); |
| import React, {useCallback, useMemo} from 'react'; | ||
| import useLocalize from '@hooks/useLocalize'; | ||
| import {replaceAllDigits, stripSpacesFromAmount, validateAmount} from '@libs/MoneyRequestUtils'; | ||
| import {replaceCommaWithDot} from '@libs/SearchUtils'; |
There was a problem hiding this comment.
| import {replaceCommaWithDot} from '@libs/SearchUtils'; |
| @@ -0,0 +1,61 @@ | |||
| import React, {useCallback, useMemo} from 'react'; | |||
| import useLocalize from '@hooks/useLocalize'; | |||
| import {replaceAllDigits, stripSpacesFromAmount, validateAmount} from '@libs/MoneyRequestUtils'; | |||
There was a problem hiding this comment.
| import {replaceAllDigits, stripSpacesFromAmount, validateAmount} from '@libs/MoneyRequestUtils'; | |
| import {replaceAllDigits, replaceCommasWithPeriod, stripSpacesFromAmount, validateAmount} from '@libs/MoneyRequestUtils'; |
src/libs/SearchUtils.ts
Outdated
| function replaceCommaWithDot(amount: string): string { | ||
| return amount.replace(/,/g, '.'); | ||
| } | ||
|
|
There was a problem hiding this comment.
Let's reuse MoneyRequestUtils.replaceCmmasWithPeriod
| function replaceCommaWithDot(amount: string): string { | |
| return amount.replace(/,/g, '.'); | |
| } |
src/libs/SearchUtils.ts
Outdated
| @@ -574,4 +601,5 @@ export { | |||
| normalizeQuery, | |||
| shouldShowYear, | |||
| getExpenseTypeTranslationKey, | |||
| replaceCommaWithDot, | |||
There was a problem hiding this comment.
| replaceCommaWithDot, |
src/libs/SearchUtils.ts
Outdated
| let amountFilter = ''; | ||
| if (lessThan) { | ||
| amountFilter += `${CONST.SEARCH.SYNTAX_FILTER_KEYS.AMOUNT}<${lessThan}`; | ||
| } | ||
| if (lessThan && greaterThan) { | ||
| amountFilter += ' '; | ||
| } | ||
| if (greaterThan) { | ||
| amountFilter += `${CONST.SEARCH.SYNTAX_FILTER_KEYS.AMOUNT}>${greaterThan}`; | ||
| } |
There was a problem hiding this comment.
Nit pick, let's invert the order so we show it always as greaterThan lessThan
| let amountFilter = ''; | |
| if (lessThan) { | |
| amountFilter += `${CONST.SEARCH.SYNTAX_FILTER_KEYS.AMOUNT}<${lessThan}`; | |
| } | |
| if (lessThan && greaterThan) { | |
| amountFilter += ' '; | |
| } | |
| if (greaterThan) { | |
| amountFilter += `${CONST.SEARCH.SYNTAX_FILTER_KEYS.AMOUNT}>${greaterThan}`; | |
| } | |
| let amountFilter = ''; | |
| if (greaterThan) { | |
| amountFilter += `${CONST.SEARCH.SYNTAX_FILTER_KEYS.AMOUNT}>${greaterThan}`; | |
| } | |
| if (lessThan && greaterThan) { | |
| amountFilter += ' '; | |
| } | |
| if (lessThan) { | |
| amountFilter += `${CONST.SEARCH.SYNTAX_FILTER_KEYS.AMOUNT}<${lessThan}`; | |
| } |
| // More info: https://github.com/Expensify/App/issues/16974 | ||
| const newAmountWithoutSpaces = stripSpacesFromAmount(newAmount); | ||
| const replacedCommasAmount = replaceCommaWithDot(newAmountWithoutSpaces); | ||
| if (!validateAmount(replacedCommasAmount, 3)) { |
There was a problem hiding this comment.
We support up to 2 digits
| if (!validateAmount(replacedCommasAmount, 3)) { | |
| if (!validateAmount(replacedCommasAmount, 2)) { |
|
Bug in iOS and Android native apps: When entering a number, the digit exceeding the maximum allowed decimal places is briefly inserted into the input field before being deleted. They should not be inserted at all. Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-08-15.at.15.52.28.mp4 |
|
There are conflicts |
|
Bug: The first input field is not automatically focused when the page opens. Screen.Recording.2024-08-15.at.4.07.55.PM.mov |
Screenshots/Videoscc @Expensify/design Android: NativeScreen.Recording.2024-08-15.at.4.14.56.PM.movAndroid: mWeb ChromeScreen.Recording.2024-08-15.at.4.13.49.PM.moviOS: NativeSimulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-08-15.at.16.11.54.mp4iOS: mWeb SafariSimulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-08-15.at.16.12.32.mp4MacOS: Chrome / SafariScreen.Recording.2024-08-15.at.4.06.39.PM.movMacOS: DesktopScreen.Recording.2024-08-15.at.4.10.40.PM.mov |
|
This is looking good to me. Could we see an example of where we have just |
|
@289Adam289 There are conflicts, could you please merge main? |
VideoSimulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-08-19.at.13.53.06.mp4VideoSimulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-08-19.at.13.53.45.mp4 |
|
We only have this bug pending |
|
@rayane-djouah is that bug specific to this filter or does it happen in other text inputs? |
This bug is specific to this filter and is related to the new |
|
@SzymczakJ could you please take a look at #47343 (comment)? |
|
@SzymczakJ is OOO this week. I am currently working on a fix. |
|
Looking great from a visual perspective too |
|
@luacmartins This bug appears to be bigger than I originally thought. It is connected to these issues: facebook/react-native#38155, facebook/react-native#24585, and how the native TextInput component works. A similar problem has already been encountered in the Expensify App #41961. I propose we deal with this in a follow-up issue. |
|
That sounds good to me. @rayane-djouah wanna do a final review? We'll address the input issue in a follow up |
|
bump @rayane-djouah for final review 🙇♂️ |
There was a problem hiding this comment.
Regarding the issue discussed here: #47343 (comment), I believe we need to multiply the amounts by 100 when building the search query to ensure they are correctly handled by the backend. However, The amounts will be correctly stored in Onyx with decimals and will be displayed correctly on the amount filter page and menu. We can determine how these amounts should be displayed in the search results page header as part of #47254.
|
|
||
| let amountFilter = ''; | ||
| if (greaterThan) { | ||
| amountFilter += `${CONST.SEARCH.SYNTAX_FILTER_KEYS.AMOUNT}>${greaterThan}`; |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
| amountFilter += ' '; | ||
| } | ||
| if (lessThan) { | ||
| amountFilter += `${CONST.SEARCH.SYNTAX_FILTER_KEYS.AMOUNT}<${lessThan}`; |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
|
cc @289Adam289 ^^ |
There was a problem hiding this comment.
I believe it’s better to store the amounts in Onyx in the backend format using convertToBackendAmount. For displaying the amounts in input default values and menu option preview text, we should use convertToDisplayStringWithoutCurrency to ensure the amounts are formatted and localized correctly.
| if (fieldName === CONST.SEARCH.SYNTAX_FILTER_KEYS.AMOUNT) { | ||
| const {lessThan, greaterThan} = filters; | ||
| if (lessThan && greaterThan) { | ||
| return translate('search.filters.amount.between', greaterThan, lessThan); |
There was a problem hiding this comment.
| return translate('search.filters.amount.between', greaterThan, lessThan); | |
| return translate('search.filters.amount.between', convertToDisplayStringWithoutCurrency(Number(greaterThan)), convertToDisplayStringWithoutCurrency(Number(lessThan))); | |
| return translate('search.filters.amount.between', greaterThan, lessThan); | ||
| } | ||
| if (lessThan) { | ||
| return translate('search.filters.amount.lessThan', lessThan); |
There was a problem hiding this comment.
| return translate('search.filters.amount.lessThan', lessThan); | |
| return translate('search.filters.amount.lessThan', convertToDisplayStringWithoutCurrency(Number(lessThan))); |
| return translate('search.filters.amount.lessThan', lessThan); | ||
| } | ||
| if (greaterThan) { | ||
| return translate('search.filters.amount.greaterThan', greaterThan); |
There was a problem hiding this comment.
| return translate('search.filters.amount.greaterThan', greaterThan); | |
| return translate('search.filters.amount.greaterThan', convertToDisplayStringWithoutCurrency(Number(greaterThan))); |
| const {translate} = useLocalize(); | ||
|
|
||
| const [searchAdvancedFiltersForm] = useOnyx(ONYXKEYS.FORMS.SEARCH_ADVANCED_FILTERS_FORM); | ||
| const greaterThan = searchAdvancedFiltersForm?.[INPUT_IDS.GREATER_THAN]; |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
|
|
||
| const [searchAdvancedFiltersForm] = useOnyx(ONYXKEYS.FORMS.SEARCH_ADVANCED_FILTERS_FORM); | ||
| const greaterThan = searchAdvancedFiltersForm?.[INPUT_IDS.GREATER_THAN]; | ||
| const lessThan = searchAdvancedFiltersForm?.[INPUT_IDS.LESS_THAN]; |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
| InputComponent={AmountWithoutCurrencyForm} | ||
| inputID={INPUT_IDS.GREATER_THAN} | ||
| name={INPUT_IDS.GREATER_THAN} | ||
| defaultValue={greaterThan} |
There was a problem hiding this comment.
| defaultValue={greaterThan} | |
| defaultValue={greaterThanFormattedAmount} |
| InputComponent={AmountWithoutCurrencyForm} | ||
| inputID={INPUT_IDS.LESS_THAN} | ||
| name={INPUT_IDS.LESS_THAN} | ||
| defaultValue={lessThan} |
There was a problem hiding this comment.
| defaultValue={lessThan} | |
| defaultValue={lessThanFormattedAmount} |
| const {inputCallbackRef} = useAutoFocusInput(); | ||
|
|
||
| const updateAmountFilter = (values: FormOnyxValues<typeof ONYXKEYS.FORMS.SEARCH_ADVANCED_FILTERS_FORM>) => { | ||
| updateAdvancedFilters(values); |
There was a problem hiding this comment.
| updateAdvancedFilters(values); | |
| const greaterThan = values[INPUT_IDS.GREATER_THAN]; | |
| const greaterThanBackendAmount = greaterThan ? convertToBackendAmount(Number(greaterThan)) : undefined; | |
| const lessThan = values[INPUT_IDS.LESS_THAN]; | |
| const lessThanBackendAmount = lessThan ? convertToBackendAmount(Number(lessThan)) : undefined; | |
| updateAdvancedFilters({greaterThan: greaterThanBackendAmount?.toString(), lessThan: lessThanBackendAmount?.toString()}); |
|
@289Adam289 - Sorry for not noticing this bug earlier: Bug: If user enter just the decimal separator nothing happens
Expected result (Similar to other amount inputs in the app): A leading zero is inserted along with the comma We have a Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-08-21.at.11.07.22.mp4 |
|
No problem. From what I understand this should work. cc @rayane-djouah |
| const greaterThan = searchAdvancedFiltersForm?.[INPUT_IDS.GREATER_THAN]; | ||
| const greaterThanFormattedAmount = greaterThan !== undefined ? convertToDisplayStringWithoutCurrency(Number(greaterThan)) : undefined; | ||
| const lessThan = searchAdvancedFiltersForm?.[INPUT_IDS.LESS_THAN]; | ||
| const lessThanFormattedAmount = lessThan !== undefined ? convertToDisplayStringWithoutCurrency(Number(lessThan)) : undefined; |
There was a problem hiding this comment.
When inserting the default value into the input, we need to ensure that decimal zeros are added, but formatting commas should not be included as they block input editing. We should follow a similar approach to that used for existing amount inputs.
Screen.Recording.2024-08-21.at.12.24.14.PM.mov
cc @289Adam289
There was a problem hiding this comment.
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 Issuessection 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
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - 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 verified the steps for local testing are in the
- 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.
toggleReportand notonIconClick). - 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
- 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.
- 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 usingAvatarhave 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
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - 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
Avataris modified, I verified thatAvataris 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
Designlabel and/or tagged@Expensify/designso the design team can review the changes.
- If a new page is added, I verified it's using the
ScrollViewcomponent to make it scrollable when more elements are added to the page. - If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
Screenshots/Videos
Android: Native
Screen.Recording.2024-08-21.at.2.26.13.PM.mov
Android: mWeb Chrome
Screen.Recording.2024-08-21.at.2.21.38.PM.mov
iOS: Native
Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-08-21.at.14.23.12.mp4
iOS: mWeb Safari
Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-08-21.at.14.19.38.mp4
MacOS: Chrome / Safari
Screen.Recording.2024-08-21.at.2.15.40.PM.mov
MacOS: Desktop
Screen.Recording.2024-08-21.at.2.20.10.PM.mov
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🚀 Deployed to staging by https://github.com/luacmartins in version: 9.0.24-0 🚀
|
|
🚀 Deployed to staging by https://github.com/luacmartins in version: 9.0.24-0 🚀
|
|
🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.24-5 🚀
|
Details
This PR adds an amount filter.
Fixed Issues
$ #46036
PROPOSAL:
Tests
Offline tests
QA Steps
Same as tests
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)myBool && <MyComponent />.src/languages/*files and using the translation methodSTYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel and/or tagged@Expensify/designso the design team can review the changes.ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Android: Native
android.mov
Android: mWeb Chrome
android_web.mov
iOS: Native
ios.mov
iOS: mWeb Safari
ios_web.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov