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: pre-validate masked input #56462

Merged

Conversation

kirillzyusko
Copy link
Contributor

@kirillzyusko kirillzyusko commented Feb 6, 2025

Explanation of Change

Added regexp validation before applying a mask.

Fixed Issues

$ #56330
PROPOSAL: N/A

Tests

  1. Go Reports > click on Filter > click on Total
  2. Enter few digits > press dot key or comma key to enter a decimal point
  3. Enter two digits after the decimal point
  4. Move the cell pointer on the left side of the entered decimal point (dot)
  5. Press dot key

Offline tests

N/A

QA Steps

  1. Go Reports > click on Filter > click on Total
  2. Enter few digits > press dot key or comma key to enter a decimal point
  3. Enter two digits after the decimal point
  4. Move the cell pointer on the left side of the entered decimal point (dot)
  5. Press dot key

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-02-12.at.10.47.07.mov
Android: mWeb Chrome
iOS: Native
Simulator.Screen.Recording.-.iPhone.15.Pro.-.2025-02-12.at.11.14.34.mp4
iOS: mWeb Safari
Simulator.Screen.Recording.-.iPhone.15.Pro.-.2025-02-12.at.10.58.00.mp4
MacOS: Chrome / Safari
masked-input-1.3-demo.mov
MacOS: Desktop
masked-input-1.3-demo.mov

Copy link

melvin-bot bot commented Feb 6, 2025

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

@kirillzyusko
Copy link
Contributor Author

@brunovjk would you mind to test these changes? As a reference I took existing web input behavior and tried to match that on all platforms 👀

I also update advanced-input-mask library, so you'll need to re-install dependencies

@brunovjk

This comment was marked as outdated.

@brunovjk
Copy link
Contributor

brunovjk commented Feb 6, 2025

Great work @kirillzyusko it's much better now, but I can't leave the field blank, without any digits:

Screen.Recording.2025-02-06.at.10.39.42.mov

@kirillzyusko
Copy link
Contributor Author

@brunovjk yep, can reproduce it! Fixed in 639e0bc

@brunovjk
Copy link
Contributor

brunovjk commented Feb 6, 2025

Very good @kirillzyusko

Android: Native
56462_android_native.mov
iOS: Native
56462_ios_native.mov

sorry for the inconvenience, but there is a detail that is bothering me, on the web (I was able to reproduce it with less reliability in native as well), when typing a letter, the "cursor" moves:

Screen.Recording.2025-02-06.at.12.17.02.mov

What do you think? Thank you.

@kirillzyusko
Copy link
Contributor Author

sorry for the inconvenience, but there is a detail that is bothering me, on the web, when typing a letter, the "cursor" moves

What is the expected behavior? To move cursor to the end (as it is in current web implementation)?

@brunovjk
Copy link
Contributor

brunovjk commented Feb 6, 2025

sorry for the inconvenience, but there is a detail that is bothering me, on the web, when typing a letter, the "cursor" moves

What is the expected behavior? To move cursor to the end (as it is in current web implementation)?

When typing letters, I believe nothing should happen. We can confirm with luacmartins

@kirillzyusko
Copy link
Contributor Author

When typing letters, I believe nothing should happen. We can confirm with luacmartins

I think on web it always go to the end in case if invalid character has been typed (i. e. including letters) 🤔

@brunovjk
Copy link
Contributor

brunovjk commented Feb 6, 2025

Great! I'll finish the tests and checklist later, but everything looks good so far.

@brunovjk
Copy link
Contributor

brunovjk commented Feb 6, 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
56462_android_native.mov
Android: mWeb Chrome
56462_android_web.mov
iOS: Native
56462_ios_native.mov
iOS: mWeb Safari
56462_ios_web.mov
MacOS: Chrome / Safari
56462_web_chrome.mov
MacOS: Desktop
56462_web_desktop.mov

Copy link
Contributor

@brunovjk brunovjk left a comment

Choose a reason for hiding this comment

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

Everything looks fine to me, please just pay attention to these comments comment_1 comment_2. @kirillzyusko could you please complete your checklist? Thanks a lot.

@melvin-bot melvin-bot bot requested a review from luacmartins February 6, 2025 20:29
@luacmartins
Copy link
Contributor

@kirillzyusko what's left to make this PR ready for review?

@kirillzyusko kirillzyusko marked this pull request as ready for review February 12, 2025 10:15
@kirillzyusko kirillzyusko requested a review from a team as a code owner February 12, 2025 10:15
@melvin-bot melvin-bot bot requested review from brunovjk and removed request for a team February 12, 2025 10:15
Copy link

melvin-bot bot commented Feb 12, 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]

@kirillzyusko
Copy link
Contributor Author

kirillzyusko commented Feb 12, 2025

@brunovjk I fixed a problem with moving cursor - now cursor will stay in the same position (on all platforms) if incorrect symbol has been types.

@brunovjk @luacmartins this PR is ready for review now (I mean I completed checklist/uploaded videos) 👀

@brunovjk
Copy link
Contributor

In native everything is very good now, it seems more solid to me, congratulations @kirillzyusko. However, in web I found a bug.
The field value is deleted when we start typing a new one, in native it works fine, as nothing happens:

Screen.Recording.2025-02-12.at.11.17.54.mov

Can you reproduce it? Thank you.

@kirillzyusko
Copy link
Contributor Author

@brunovjk I'll check! 👀

@kirillzyusko
Copy link
Contributor Author

Just a small update - I found a problem. Will fix it today/tomorrow 🤞

@kirillzyusko
Copy link
Contributor Author

@brunovjk may I ask you to test this PR again (I hope it will be the last time 😅)?

@brunovjk
Copy link
Contributor

@brunovjk may I ask you to test this PR again (I hope it will be the last time 😅)?

Sorry, I missed your message. I'll review it today 🚀 🚀 🚀

Copy link
Contributor

@brunovjk brunovjk left a comment

Choose a reason for hiding this comment

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

Looking good to me 🚀 Thank you very much for your effort @kirillzyusko.

Screenshots/Videos

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

@brunovjk
Copy link
Contributor

All yours @luacmartins :D

@kirillzyusko
Copy link
Contributor Author

Looking good to me 🚀 Thank you very much for your effort

Thank you for careful reviewing 😊 ❤️

@luacmartins
Copy link
Contributor

Verify HybridApp build is failing with:

 gh pr comment https://github.com/Expensify/App/pull/56462 --body \
  ":warning: This PR is possibly changing native code, it may cause problems with HybridApp. Please run an AdHoc build to verify that HybridApp will not break. :warning:"
  shell: /usr/bin/bash -e {0}
  env:
    GITHUB_TOKEN: ***
GraphQL: Resource not accessible by integration (addComment)

NAB

@luacmartins luacmartins merged commit 01242a7 into Expensify:main Feb 18, 2025
21 of 22 checks passed
Copy link

melvin-bot bot commented Feb 18, 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.

@luacmartins
Copy link
Contributor

See comment above

@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.

Copy link
Contributor

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

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 9.1.1-6 🚀

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.

4 participants