Handle invisible characters in forms

[kosmydel]

Details

This PR handles invisible characters in the required fields, to prevent users from creating an i.g. workspace name with only invisible characters.

We:

• remove all invisible characters, and then check if are there any visible ones left,
• then we remove invisible characters that do not break the emojis (some emojis use helping invisible characters), before sending it to the BE.

Fixed Issues

$ #23297
PROPOSAL: #23297 (comment)

Tests

• Do the QA tests
• Write unit tests to verify:
  • isEmptyString function,
  • removeInvisibleCharacters function.

‍

Offline tests

N/A

QA Steps

• Verify that no errors appear in the JS console
• Verify invisible characters. In each field/form below, do the steps from the next point.
  • Verify workspace names:
    • Go to Settings -> Workspaces‍
    • Create a New workspace or use an existing one, select it
    • With workspace selected go to Settings, type in the Name field
  • Go to Settings -> Profile -> Personal details -> Home address -> Check: Address line, City and other fields
  • Go to Settings -> Wallet -> Add debit card -> Check: Billing address, and other fields
  • Try to cover as many forms/fields as possible, especially the ones which are required
• In each form (field) from above verify:
  • Try to change input, to a normal one, containing normal characters (e.g. My workspace 123)
  • Try input with only invisible characters:
    • Try characters from this site
    • Test U+3164 HANGUL FILLER.
    • ‍Try invisible characters used in emojis (e.g.r \u200D), you can use this tool to copy it (paste the character in the JS/Java/C section, click Convert, and then Copy in Characters section)
  • Try input with emojis, especially tricky ones (e.g. 😶‍🌫️, 🏴󠁧󠁢󠁥󠁮󠁧󠁿),‍‍
  • Try some different characters (i.g. from other alphabets)
• Verify other forms:
  • Verify Settings -> Profile -> Display Name (should do both First name and Last name):
    • Try to set the name to a normal string.
    • Try to set the name with Emojis.
    • Try to set the name to empty one.
    • Try to set the name to one with only invisible characters (e.g. \u200D) (should be able to save, but the name will be treated as empty)
  • Click the "Plus" button -> Assign task -> Title:
    • Do the same check as above.
  • Do the same with: Click "Plus" button -> Save the world -> I know a teacher -> All fields
  • Do the same with: Click "Plus" button -> Save the world -> I am a teacher -> All fields
  • Do the same with: Settings -> Profile -> Personal details -> Legal Name
  • Do the same with: Settings -> Profile -> Personal details -> Home address
  • Enable betas and do the same with: Fab -> Send message -> Room -> Room name
• Verify all other Forms, if you find any more.
• Go to Workspace settings -> Notes -> Edit note
• Double test recently migrated forms (i.g. this PR)

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 / Chrome
  • iOS / native
  • iOS / 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
  • 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(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

Web

web.mov

Mobile Web - Chrome

mWeb-android.mov

Mobile Web - Safari

mWeb-ios.mp4

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

[melvin-bot]

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

[melvin-bot]

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

[situchan]

@kosmydel please update QA step in more detail.
We should test fix in all possible pages - new/edit room, edit workspace name, first name, last name, etc where validations were not that strict originally.

[kosmydel]

@kosmydel please update QA step in more detail. We should test fix in all possible pages - new/edit room, edit workspace name, first name, last name, etc where validations were not that strict originally.

Merged with the main & slightly updated the PR.
I've also updated the QA steps, but I couldn't find a way to create/edit a room.

[situchan]

To create room, enable beta in Permissions.js and then go to FAB > Send message > Room tab

[kosmydel]

To create room, enable beta in Permissions.js and then go to FAB > Send message > Room tab

cc @situchan done, thanks!

[situchan]

Server is down - https://expensify.slack.com/archives/C01GTK53T8Q/p1695314249132269
Will checklist once it's back

[situchan]

@kosmydel please fix conflict

[kosmydel]

Hey @situchan.

Since this PR related to the Form component was merged recently, I have to apply my solution to the refactored forms. Unfortunately, I have other issues with higher priority. I will try to have a look at this by the end of this week.

[situchan]

No problem. Thanks for the update

[kosmydel]

Hey @situchan, there is a problem with implementing it in the new Form component. It doesn't implement full validation yet.

---

Here is how the validation looks right now.
Here is how it looks in the previous version.

I've talked with @kowczarz and he is preparing an update to the new component form. I think that we should wait for his changes to be merged.

---

Alternatively, we can process with only the old Form component and create a new PR with changes to the new one. The problem is, that some of the components are already migrated to the new Form (e.g. DisplayNamePage.js), and wouldn't include changes from this PR.

[situchan]

I think we can still wait as this is not critical bug.
cc: @hayata-suenaga

[hayata-suenaga]

@kosmydel is there any one GH issue or PR against which I can hold this PR?

[kosmydel]

Hey @hayata-suenaga
I don't think there is a GH issue, but here is a draft of the PR fixing it.

[kosmydel]

Hey @situchan, I've resolved conflicts. Sorry for the delay, I was OOO on Tuesday, and yesterday we had public holidays in Poland.

[hayata-suenaga]

@situchan please review this when you got a minute 🙇

[situchan]

reviewing in an hr

[situchan]

Overall looks good. Some minor code dry feedback

[situchan]

Performance Tests failing. I believe not caused by this PR but we should still wait until fixed in main and merge again

[kosmydel]

Hey, sorry for the delay, I was OOO. I think it is ready for another review. @situchan

[situchan]

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(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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

android-i.know.teacher.mov

Android: mWeb Chrome

mchrome-bank.step.mov

iOS: Native

ios-display.name.mov

iOS: mWeb Safari

msafari-legal.name.mov

MacOS: Chrome / Safari

web-workspace.settings.mov

web-edit.iou.description.mov

MacOS: Desktop

desktop-new.room.mov

[situchan]

Great work!

[hayata-suenaga]

👍

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.98-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.98-5 🚀

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

[OSBotify]

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.99-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.99-0 🚀

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