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: no jumpy input in amount filter #53695

Merged
merged 16 commits into from
Feb 3, 2025

Conversation

kirillzyusko
Copy link
Contributor

@kirillzyusko kirillzyusko commented Dec 6, 2024

Explanation of Change

Added react-native-advanced-input-mask that based on "mask" concept (instead of imperative formatting) and performs formatting in a native thread, so as a result it's flicker/jumpy-free, brings native performance, doesn't produce delays and other unpleasant UI issues 😊

Staring from now TextInput can be implemented via 3 implementations:

  • default from react-native;
  • markdown from react-native-live-markdown;
  • mask from react-native-advanced-input-mask

So to manage which implementation from listed above should be used I added a new property type that switches between implementations.

Fixed Issues

$ #47875
PROPOSAL: #47875 (comment)

Tests

  • go to Reports
  • press "criteria" button;
  • go to Total;
  • enter Greater than/Less than fields;
  • after entering two digits after comma/dot try to continue to enter symbols
  • make sure subsequently entered characters (after two symbols after comma) do not get entered and instantly removed after that

Offline tests

N/A

QA Steps

  • go to Reports
  • press "criteria" button;
  • go to Total;
  • enter Greater than/Less than fields;
  • after entering two digits after comma/dot try to continue to enter symbols
  • make sure subsequently entered characters (after two symbols after comma) do not get entered and instantly removed after that

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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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
Screen.Recording.2025-01-20.at.14.52.55.mov
Android: mWeb Chrome
iOS: Native
Simulator.Screen.Recording.-.iPhone.15.Pro.-.2025-01-20.at.14.54.38.mp4
iOS: mWeb Safari
MacOS: Chrome / Safari
Screen.Recording.2025-01-20.at.15.32.07.mov
MacOS: Desktop

Copy link

melvin-bot bot commented Jan 20, 2025

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

@kirillzyusko kirillzyusko changed the title poc: masked input fix: no jumpy input in amount filter Jan 20, 2025
@kirillzyusko kirillzyusko marked this pull request as ready for review January 20, 2025 14:26
@kirillzyusko kirillzyusko requested a review from a team as a code owner January 20, 2025 14:26
@melvin-bot melvin-bot bot requested a review from brunovjk January 20, 2025 14:26
Copy link

melvin-bot bot commented Jan 20, 2025

@brunovjk 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 removed the request for review from a team January 20, 2025 14:26
@kirillzyusko
Copy link
Contributor Author

All yours @brunovjk 🙌

@luacmartins luacmartins self-requested a review January 20, 2025 16:40
@brunovjk
Copy link
Contributor

BUG: When we type a letter, a dot . appears instead of nothing happening.

Screen.Recording.2025-01-20.at.15.01.03.mov

Can you reproduce @kirillzyusko? Thanks.

@kirillzyusko
Copy link
Contributor Author

When we type a letter, a dot . appears instead of nothing happening.

It happens because all symbols (except numeric values) are considered as a float separator (and thus they are replaced with .). Using phone keyboard I highly doubt it will be possible to enter anything else except 01234567890.,symbols. Am I right? If yes, then should we really focus on solving this problem?..

@brunovjk
Copy link
Contributor

Good question, thanks @kirillzyusko. I believe that in general it would be interesting to explore solutions to this issue, but I say this without knowing how complex it might be. What do you think @luacmartins?

@luacmartins
Copy link
Contributor

Can we just skip adding anything when we type letters? I think we should only allow 0-9., as input

@kirillzyusko
Copy link
Contributor Author

Can we just skip adding anything when we type letters? I think we should only allow 0-9., as input

@brunovjk @luacmartins Fixed in f888cd9

Would you mind to do another round of review?

@brunovjk
Copy link
Contributor

Sure :D Thanks for the update, I'll review it later today.

@brunovjk
Copy link
Contributor

@kirillzyusko, I can still reproduce it:

Screen.Recording.2025-01-22.at.13.20.15.mov

What about you? After your changes it shouldn't be possible to use letters, strange.

@kirillzyusko
Copy link
Contributor Author

@brunovjk did you reinstall deps? I updated a library, so you have to re-install node_modules/pods

@brunovjk
Copy link
Contributor

@brunovjk did you reinstall deps? I updated a library, so you have to re-install node_modules/pods

Yes, I did. I will do it again. :D

@kirillzyusko
Copy link
Contributor Author

Yes, I did. I will do it again. :D

Very strange 😬 Did you re-assemble app after that? I was definitely testing all three platforms and everything was working fine - alphabetical input was simply ignored 🤔

@brunovjk
Copy link
Contributor

Yes, I did. I will do it again. :D

Very strange 😬 Did you re-assemble app after that? I was definitely testing all three platforms and everything was working fine - alphabetical input was simply ignored 🤔

I was probably doing something wrong, I cleaned everything again and it worked like a charm.

@brunovjk
Copy link
Contributor

brunovjk commented Jan 22, 2025

It’s looking good!! Great work, @kirillzyusko! 🎉 I’ll need a bit more time to review the changes in-depth and test other areas of the app that might be impacted. Would it be possible to add some unit tests?

@luacmartins, do you think we should assign QA to test this later? Thanks in advance! 🙌

Screenshots/Videos

Android: Native
53695_android_native.mov
Android: mWeb Chrome
53695_android_web.mov
iOS: Native
53695_ios_native.mov
iOS: mWeb Safari
53695_ios_web.mov
MacOS: Chrome / Safari
53695_web_chrome.mov
MacOS: Desktop
53695_web_desktop.mov

task.assigneeAccountID,
task.assigneeChatReport,
);
createTaskAndNavigate(task?.parentReportID ?? '-1', values.taskTitle, values.taskDescription ?? '', task?.assignee ?? '', task.assigneeAccountID, task.assigneeChatReport);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

One thing that I can not resolve without breaking changes 😔 Any help is appreciated 🙏

Copy link
Contributor

Choose a reason for hiding this comment

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

I believe we can just remove the fallbacks here since they are all strings. Have you tried that?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@brunovjk We can't, because createTaskAndNavigate expects parentReportID as string. And we can not make it optional, because subsequent arguments are mandatory. We also can't specify default it, because it's number and we expect a string 🤔

@kirillzyusko
Copy link
Contributor Author

Would it be possible to add some unit tests?

Yeah, I would love to add them. But the problem here is that we moved all logic from JS to a native component. So js unit-tests can be only snapshot tests (and I don't know whether it makes sense to have such tests)?

@brunovjk
Copy link
Contributor

@kirillzyusko, I found a bug, I think, I haven't gone deep into the changes yet. But it's not "saving":

Android: Native - main
main.mov
Android: Native - our PR
PR_53695.mov

@kirillzyusko
Copy link
Contributor Author

I found a bug, I think, I haven't gone deep into the changes yet. But it's not "saving":

@brunovjk Fixed in 81edc2c 🙈

@brunovjk
Copy link
Contributor

Thank you @kirillzyusko. I'm working on another PR now, I will get back here later today 🚀

@kirillzyusko
Copy link
Contributor Author

What do you think? It makes sense ? I didn't have time to look where else we needed to, @kirillzyusko can you do that for us? Thanks a lot!!!

I would love to do that, but in a different PR. My main concern is that if the PR will be reverted, then only a small part of changes will be reverted. If I implement all changes in a single PR which will be reverted/added again it'll be slightly a nightmare to manage all that things 🤔

Does it make sense to merge this PR and handle other input in a different PR?

@brunovjk
Copy link
Contributor

I see your point, it makes sense, thanks. What do you think @luacmartins?

@luacmartins
Copy link
Contributor

Agreed! Let's keep the changes self-contained for now and if no regressions are detected we move on to updating the other amount inputs

@brunovjk
Copy link
Contributor

Great! @kirillzyusko can you resolve the conflicts? I'll do a quick review and let you know luacmartins

@kirillzyusko
Copy link
Contributor Author

can you resolve the conflicts

Resolved! 😎

@brunovjk
Copy link
Contributor

Can we fix these errors @kirillzyusko? Let me know of anything.

@kirillzyusko
Copy link
Contributor Author

@brunovjk it fails because of this:

/home/runner/work/App/App/src/pages/tasks/NewTaskDetailsPage.tsx
Error: 79:55 error Do not default string IDs to any value. See: https://github.com/Expensify/App/blob/main/contributingGuides/STYLE.md#default-value-for-inexistent-IDs rulesdir/no-default-id-values

And honestly I don't have any ideas how to fix this problem (without breaking changes or re-working a lot of code) 🤷‍♂️ Can we skip this error?

@brunovjk
Copy link
Contributor

brunovjk commented Feb 3, 2025

@brunovjk it fails because of this:

/home/runner/work/App/App/src/pages/tasks/NewTaskDetailsPage.tsx
Error: 79:55 error Do not default string IDs to any value. See: https://github.com/Expensify/App/blob/main/contributingGuides/STYLE.md#default-value-for-inexistent-IDs rulesdir/no-default-id-values

And honestly I don't have any ideas how to fix this problem (without breaking changes or re-working a lot of code) 🤷‍♂️ Can we skip this error?

Very good, let me do some tests here and let you know in a moment.

@brunovjk
Copy link
Contributor

brunovjk commented Feb 3, 2025

@luacmartins I tested everything again and it looks good. Can you help us with these errors? Thank you very much.

@luacmartins
Copy link
Contributor

@brunovjk I think we can ignore the ESLint checks since they are unrelated to this PR. Same for the HybridApp build, because it fails with Input required and not supplied: token.

Could you complete the reviewer checklist though?

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

LGTM

@brunovjk
Copy link
Contributor

brunovjk commented Feb 3, 2025

oops, my bad, I thought I had already done it. I'll do it now.

@brunovjk
Copy link
Contributor

brunovjk commented Feb 3, 2025

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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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
53695_android_native.mov
Android: mWeb Chrome
53695_android_web.mov
iOS: Native
53695_ios_native.mov
iOS: mWeb Safari
53695_ios_web.mov
MacOS: Chrome / Safari
53695_web_chrome.mov
MacOS: Desktop
53695_web_desktop.mov

@brunovjk
Copy link
Contributor

brunovjk commented Feb 3, 2025

Could you complete the reviewer checklist though?

Done @luacmartins :D sorry about that.

@luacmartins
Copy link
Contributor

Gonna merge with the failing ESLint and HybridApp build failing. See comment here

@luacmartins luacmartins merged commit d31566b into Expensify:main Feb 3, 2025
16 of 21 checks passed
@melvin-bot melvin-bot bot added the Emergency label Feb 3, 2025
Copy link

melvin-bot bot commented Feb 3, 2025

@luacmartins looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

Copy link
Contributor

github-actions bot commented Feb 3, 2025

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.0.94-0 🚀

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

Copy link
Contributor

github-actions bot commented Feb 6, 2025

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.0.94-25 🚀

platform result
🤖 android 🤖 true ❌
🖥 desktop 🖥 cancelled 🔪
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 failure ❌
🍎🔄 iOS HybridApp 🍎🔄 failure ❌

Copy link
Contributor

github-actions bot commented Feb 6, 2025

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.0.94-25 🚀

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

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.

3 participants