debounce rate input in reimburse expenses #11967

aimane-chnaif · 2022-10-18T17:46:16Z

Details

Let user keep typing and show raw input value until debounce timeout.
After timeout, fix value and show corrected value accordingly, along with syncing to server
And limit characters length to 12

Fixed Issues

$ #11352
PROPOSAL: #11352 (comment)

Tests

Login with any account
Create workspace if not exist
Go to Settings -> workspace -> Reimburse expenses
Edit rate
Verify that numbers don't shake

Verify that no errors appear in the JS console

PR Review Checklist

PR Author Checklist

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

QA Steps

Login with any account
Create workspace if not exist
Go to Settings -> workspace -> Reimburse expenses
Edit rate
Verify that numbers don't shake

Verify that no errors appear in the JS console

Screenshots

Web

web.mov

Mobile Web - Chrome

mchrome.mp4

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mp4

thesahindia

@aimane-chnaif, I found that the user can add non numeric values to the input. Can we fix that?

aimane-chnaif · 2022-10-19T12:22:49Z

@aimane-chnaif, I found that the user can add non numeric values to the input. Can we fix that?

@thesahindia I don't think it's possible to prevent non-numeric input with debounce.
As this happens only on web/desktop, this is my suggested change:

    setRate(value) {
        const decimalSeparator = this.props.toLocaleDigit('.');
        const rateValueRegex = RegExp(String.raw`^\d{1,8}([${getPermittedDecimalSeparator(decimalSeparator)}]\d{0,3})?$`, 'i');
        const isInvalidRateValue = value !== '' && !rateValueRegex.test(value);

+       if (this.props.isShown) {
+           const updatedValue = !isInvalidRateValue ? this.getRateDisplayValue(value) : this.state.unitRateValue;
+           this.setState({unitRateValue: value}, () => {
+               // Set the corrected value with a delay and sync to the server
+               this.updateRateValueDebounced(updatedValue);
+           });
+       } else {
            this.setState(prevState => ({
                unitRateValue: !isInvalidRateValue ? this.getRateDisplayValue(value) : prevState.unitRateValue,
            }), () => {
                // Set the corrected value with a delay and sync to the server
                this.updateRateValueDebounced(this.state.unitRateValue);
            });
+       }
    }

export default compose(
    withLocalize,
+   withKeyboardState,
    withNetwork(),
)(WorkspaceReimburseView);

So on web/desktop (that doesn't show keyboard), use original logic that don't use debounce.
But on native/mWeb (that shows keyboard), use debounce

How do you think?

thesahindia · 2022-10-20T13:47:39Z

So on web/desktop (that doesn't show keyboard), use original logic that don't use debounce.
But on native/mWeb (that shows keyboard), use debounce

@aimane-chnaif, I don't like the idea of using two logics just to prevent users from entering non numeric characters. Let me know if you have any other idea.

@AndrewGable, what do you think, do we wanna prevent user from entering non numeric characters?

After this PR the user will be able to type non numeric chars. If the user refreshes the page or closes the page and comes back then they will see the previous valid value.

aimane-chnaif · 2022-10-21T09:39:27Z

I don't like the idea of using two logics just to prevent users from entering non numeric characters

value.replace(/[^0-9.]|\.(?=.*\.)/g, '')
Filter only decimal values before applying logic.
This solution will not impact (shaking issue) native/mWeb because user cannot input any other characters on numeric keyboard.
Thoughts on this?

thesahindia · 2022-10-21T18:39:37Z

Thoughts on this?

Let's wait for @AndrewGable's opinion at #11967 (comment), because I am not 100% sure if we should prevent the user from adding non numeric characters because we also try to not restrict the user from typing something.

thesahindia · 2022-10-26T20:52:12Z

Bump @AndrewGable ^

AndrewGable · 2022-10-27T00:42:14Z

Thanks for the bump, currently we do not allow non-numerical characters to be inserted, so I do not think we should "go back" in a sense. So I think only numbers should allowed to be inserted.

thesahindia · 2022-10-28T22:22:12Z

value.replace(/[^0-9.]|.(?=.*.)/g, '')
Filter only decimal values before applying logic.

Let's do it @aimane-chnaif

aimane-chnaif · 2022-10-31T17:50:55Z

@thesahindia one more thing when apply regex:

/[^0-9.]|\.(?=.*\.)/g: this filters multiple dots (i.e. 12adfsf4.w34.684 => 12434.684)
~~This works perfect on web~~ but on mobile it shakes when add second .
When add second ., first . is removed so it's weird
/[^0-9.]/g: this allows multiple dots (i.e. 12adfsf4.w34.684 => 124.34.684)

Which one do you recommend?

thesahindia · 2022-10-31T21:06:32Z

@aimane-chnaif, can you share the screen recording?

aimane-chnaif · 2022-11-01T03:10:00Z

@thesahindia I updated comment above. So allowing multiple dots (/[^0-9.]/g) is my final suggestion

thesahindia · 2022-11-01T10:17:50Z

@thesahindia I updated comment above. So allowing multiple dots (/[^0-9.]/g) is my final suggestion

Cool, let's move forward with it.

thesahindia · 2022-11-01T16:53:50Z

I was able to add 11 digits before the decimal

thesahindia · 2022-11-01T16:48:19Z

src/pages/workspace/reimburse/WorkspaceReimburseView.js

@@ -236,12 +235,13 @@ class WorkspaceReimburseView extends React.Component {
                                    <TextInput
                                        label={this.props.translate('workspace.reimburse.trackDistanceRate')}
                                        placeholder={this.state.outputCurrency}
-                                        onChangeText={value => this.setRate(value)}
+                                        onChangeText={value => this.setRate(value.replace(/[^0-9.]/g, ''))}


I think we should move this logic inside setRate or let's create a new method where we will replace the non numeric chars and call setRate inside it with the new value?

I added that logic inline because setRate is called only here. But yes it's better to move this logic inside setRate

aimane-chnaif · 2022-11-01T17:01:58Z

I was able to add 11 digits before the decimal

After debounce timeout, what output we expect?
i.e. 1234567890.2

thesahindia · 2022-11-01T17:09:16Z

I think the output should be
12345678.000

aimane-chnaif · 2022-11-02T08:40:02Z

@thesahindia ready for review

thesahindia · 2022-11-02T19:43:53Z

Looks good but we have one problem. We are removing , even when the language is spanish

Screen.Recording.2022-11-03.at.1.08.31.AM.mov

aimane-chnaif · 2022-11-02T20:00:20Z

@thesahindia Good catch. It was original issue before this PR and now good time to fix it here.
So we may need to allow both . and , in immediate input. And after debounce timeout, filter according to localization.

thesahindia · 2022-11-03T10:50:02Z

I think we shouldn't allow user to type , or . unless they enter a number

aimane-chnaif · 2022-11-03T10:54:09Z

There's ., , in mobile keyboard, so if we don't allow at the beginning (remove immediately if typed), shaking issue will happen again on mobile app

aimane-chnaif · 2022-11-03T10:57:38Z

The issue is becoming more complex.
Let's clarify the exact behavior on web and mobile for each and then continue updating PR.

thesahindia · 2022-11-03T11:07:18Z

There's ., , in mobile keyboard, so if we don't allow at the beginning (remove immediately if typed), shaking issue will happen again on mobile app

Good point. I think the other option is to use the previous valid value after the debounce timeout.

aimane-chnaif · 2022-11-03T11:09:03Z

I think the other option is to use the previous valid value after the debounce timeout.

This is what I implemented already, isn't it?
this.updatedValue is the previous valid value to be used after timeout

thesahindia · 2022-11-03T11:12:07Z

This is what I implemented already, isn't it? this.updatedValue is the previous valid value to be used after timeout

If I only add . or , it doesn't update to the previous value.

aimane-chnaif · 2022-11-03T11:33:41Z

If I only add . or , it doesn't update to the previous value.

This happens because empty value (after removing dots) is considered as valid rate.
As we won't save non-numeric value (including empty) in backend (reference), it's safe to remove this condition:

App/src/pages/workspace/reimburse/WorkspaceReimburseView.js

Line 137 in 25c3060

const isInvalidRateValue = value !== '' && !rateValueRegex.test(value);

-       const isInvalidRateValue = value !== '' && !rateValueRegex.test(value);
+       const isInvalidRateValue = !rateValueRegex.test(value);

thesahindia · 2022-11-03T13:01:26Z

This happens because empty value (after removing dots) is considered as valid rate. As we won't save non-numeric value (including empty) in backend (reference), it's safe to remove this condition:

I think it can be a problem, e.g. A user clears the default value and pauses before adding the new value, now the user will have to clear the value again because the previous value will be added again after the timeout.

aimane-chnaif · 2022-11-03T15:56:56Z

@thesahindia ready for review

…o fix-11352

thesahindia · 2022-11-04T10:30:39Z

Screenshots

Web

Screen.Recording.2022-11-04.at.3.52.26.PM.mov

Mobile Web - Chrome

Screen.Recording.2022-11-04.at.3.45.28.PM.mov

Mobile Web - Safari

Screen.Recording.2022-11-04.at.3.51.28.PM.mov

Desktop

Screen.Recording.2022-11-04.at.3.48.00.PM.mov

iOS

Screen.Recording.2022-11-04.at.3.50.02.PM.mov

Android

Screen.Recording.2022-11-04.at.3.58.13.PM.mov

Looks good and tests well!

cc: @AndrewGable

C+ reviewed 🎀👀🎀

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:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- 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 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 was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and 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 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

thesahindia · 2022-11-04T10:31:49Z

@aimane-chnaif, thanks for the changes!

thesahindia · 2022-11-07T20:43:46Z

Bump @AndrewGable

OSBotify · 2022-11-07T21:12:40Z

✋ 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 · 2022-11-08T19:38:33Z

🚀 Deployed to staging by @AndrewGable in version: 1.2.25-0 🚀

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

OSBotify · 2022-11-09T21:13:35Z

🚀 Deployed to production by @yuwenmemon in version: 1.2.25-0 🚀

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

debounce rate input in reimburse expenses

44df660

aimane-chnaif requested a review from a team as a code owner October 18, 2022 17:46

melvin-bot bot requested review from AndrewGable and thesahindia and removed request for a team October 18, 2022 17:46

thesahindia suggested changes Oct 19, 2022

View reviewed changes

filter only numeric inputs

3716dff

thesahindia suggested changes Nov 1, 2022

View reviewed changes

aimane-chnaif added 2 commits November 2, 2022 18:31

use getUnitRateValue common function

a1ff32e

fix logic to set debounced value

48502c0

allow , in rate input in reimburse expenses

ef7c792

leave empty rate value

f3cdcbb

Merge branch 'main' of https://github.com/aimane-chnaif/Expensify int…

e7375f2

…o fix-11352

thesahindia approved these changes Nov 4, 2022

View reviewed changes

AndrewGable approved these changes Nov 7, 2022

View reviewed changes

AndrewGable merged commit c6c2405 into Expensify:main Nov 7, 2022

melvin-bot bot added the Emergency label Nov 7, 2022

This comment was marked as off-topic.

Sign in to view

AndrewGable removed the Emergency label Nov 7, 2022

OSBotify mentioned this pull request Nov 8, 2022

Deploy Checklist: New Expensify 2022-11-08 #12563

Closed

34 tasks

melvin-bot bot mentioned this pull request Nov 9, 2022

[HOLD for payment 2022-11-16] [$500] Android/iOS - Workspace - Numbers shaking while updating rate in reimburse expenses @gadhiyamanan #11352

Closed

debounce rate input in reimburse expenses #11967

debounce rate input in reimburse expenses #11967

Conversation

aimane-chnaif commented Oct 18, 2022 • edited Loading

Details

Fixed Issues

Tests

PR Review Checklist

PR Author Checklist

PR Reviewer Checklist

QA Steps

Screenshots

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

thesahindia left a comment

Choose a reason for hiding this comment

aimane-chnaif commented Oct 19, 2022

thesahindia commented Oct 20, 2022

aimane-chnaif commented Oct 21, 2022

thesahindia commented Oct 21, 2022

thesahindia commented Oct 26, 2022

AndrewGable commented Oct 27, 2022

thesahindia commented Oct 28, 2022

aimane-chnaif commented Oct 31, 2022 • edited Loading

thesahindia commented Oct 31, 2022

aimane-chnaif commented Nov 1, 2022

thesahindia commented Nov 1, 2022

thesahindia commented Nov 1, 2022

thesahindia Nov 1, 2022

Choose a reason for hiding this comment

aimane-chnaif Nov 1, 2022

Choose a reason for hiding this comment

aimane-chnaif commented Nov 1, 2022

thesahindia commented Nov 1, 2022

aimane-chnaif commented Nov 2, 2022

thesahindia commented Nov 2, 2022

aimane-chnaif commented Nov 2, 2022

thesahindia commented Nov 3, 2022

aimane-chnaif commented Nov 3, 2022

aimane-chnaif commented Nov 3, 2022

thesahindia commented Nov 3, 2022

aimane-chnaif commented Nov 3, 2022 • edited Loading

thesahindia commented Nov 3, 2022

aimane-chnaif commented Nov 3, 2022

thesahindia commented Nov 3, 2022

aimane-chnaif commented Nov 3, 2022

thesahindia commented Nov 4, 2022

thesahindia commented Nov 4, 2022

thesahindia commented Nov 7, 2022

This comment was marked as off-topic.

OSBotify commented Nov 7, 2022

OSBotify commented Nov 8, 2022

OSBotify commented Nov 9, 2022

aimane-chnaif commented Oct 18, 2022 •

edited

Loading

aimane-chnaif commented Oct 31, 2022 •

edited

Loading

aimane-chnaif commented Nov 3, 2022 •

edited

Loading