Handle invisible characters in forms #27414

kosmydel · 2023-09-14T06:29:52Z

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

PR Author Checklist

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 · 2023-09-14T06:29:56Z

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

melvin-bot · 2023-09-14T10:48:01Z

@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 · 2023-09-18T18:30:50Z

@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 · 2023-09-19T12:06:33Z

@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 · 2023-09-19T12:08:43Z

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

kosmydel · 2023-09-19T14:34:22Z

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

cc @situchan done, thanks!

situchan · 2023-09-21T17:57:01Z

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

situchan · 2023-09-28T13:47:45Z

@kosmydel please fix conflict

kosmydel · 2023-10-03T07:58:15Z

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 · 2023-10-03T08:34:24Z

No problem. Thanks for the update

kosmydel · 2023-10-04T13:12:15Z

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 · 2023-10-04T13:13:31Z

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

hayata-suenaga · 2023-10-05T05:57:34Z

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

kosmydel · 2023-10-05T10:06:29Z

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

kosmydel · 2023-11-02T08:58:07Z

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 · 2023-11-02T17:23:32Z

@situchan please review this when you got a minute 🙇

situchan · 2023-11-02T17:25:03Z

reviewing in an hr

src/components/Form.js

situchan

Overall looks good. Some minor code dry feedback

src/libs/isEmptyString.ts

src/libs/removeInvisibleCharacters.ts

situchan · 2023-11-02T18:21:38Z

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

kosmydel · 2023-11-06T12:18:48Z

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

situchan · 2023-11-07T08:01:21Z

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 · 2023-11-09T18:29:36Z

✋ 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 · 2023-11-10T15:59:30Z

🚀 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 · 2023-11-14T21:52:57Z

🚀 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 · 2023-11-14T22:12:52Z

🚀 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 · 2023-11-15T20:56:07Z

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

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

alitoshmatov · 2024-12-02T13:23:33Z

src/libs/StringUtils.ts

+
+    // Remove all characters from the 'Other' (C) category except for format characters (Cf)
+    // because some of them are used for emojis
+    result = result.replace(/[\p{Cc}\p{Cs}\p{Co}\p{Cn}]/gu, '');


In safari this regex is removing emojis too. ref: #52071

Handle invisible characters in forms

a1a7dc3

kosmydel force-pushed the @kosmydel/handle-invisible-characters branch from 095cfd8 to a1a7dc3 Compare September 14, 2023 06:56

update Form story, fix typos

3350528

kosmydel marked this pull request as ready for review September 14, 2023 10:47

kosmydel requested a review from a team as a code owner September 14, 2023 10:47

melvin-bot bot requested review from situchan and removed request for a team September 14, 2023 10:47

kosmydel added 2 commits September 19, 2023 13:10

Merge branch 'main' into @kosmydel/handle-invisible-characters

53adb90

fix invisible characters first/last name

dfde954

kosmydel added 2 commits October 2, 2023 19:00

Merge branch 'main' into @kosmydel/handle-invisible-characters

458600d

Merge branch 'main' into @kosmydel/handle-invisible-characters

220915d

hayata-suenaga changed the title ~~Handle invisible characters in forms~~ [HOLD for new Form comp migration] Handle invisible characters in forms Oct 5, 2023

hayata-suenaga changed the title ~~[HOLD for new Form comp migration] Handle invisible characters in forms~~ [HOLD App PR #28821] Handle invisible characters in forms Oct 6, 2023

Merge branch 'main' into @kosmydel/handle-invisible-characters

e5e9413

kosmydel marked this pull request as draft October 17, 2023 09:34

kosmydel changed the title ~~[HOLD App PR #28821] Handle invisible characters in forms~~ Handle invisible characters in forms Oct 17, 2023

Merge branch 'main' into @kosmydel/handle-invisible-characters

ac22a25

kosmydel dismissed hayata-suenaga’s stale review via ac22a25 November 2, 2023 08:56

situchan reviewed Nov 2, 2023

View reviewed changes

src/components/Form.js Outdated Show resolved Hide resolved

situchan reviewed Nov 2, 2023

View reviewed changes

src/libs/isEmptyString.ts Outdated Show resolved Hide resolved

src/libs/removeInvisibleCharacters.ts Outdated Show resolved Hide resolved

kosmydel added 2 commits November 6, 2023 12:48

refactor

685df2d

extract prepareValues function

7f44418

kosmydel requested a review from situchan November 7, 2023 07:41

situchan approved these changes Nov 7, 2023

View reviewed changes

melvin-bot bot requested a review from hayata-suenaga November 7, 2023 08:01

hayata-suenaga approved these changes Nov 7, 2023

View reviewed changes

Merge branch 'Expensify:main' into @kosmydel/handle-invisible-characters

275eb00

hayata-suenaga merged commit 3432f08 into Expensify:main Nov 9, 2023
12 checks passed

OSBotify mentioned this pull request Nov 10, 2023

Deploy Checklist: New Expensify 2023-11-10 #31187

Closed

chiragsalian mentioned this pull request Nov 10, 2023

[CP-staging] Revert "Handle invisible characters in forms" #31219

Merged

45 tasks

kosmydel mentioned this pull request Nov 13, 2023

Handle invisible characters in forms v2 #31259

Merged

84 tasks

OSBotify mentioned this pull request Nov 14, 2023

Deploy Checklist: New Expensify 2023-11-14 #31324

Closed

alitoshmatov reviewed Dec 2, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Handle invisible characters in forms #27414

Handle invisible characters in forms #27414

kosmydel commented Sep 14, 2023 •

edited

Loading

melvin-bot bot commented Sep 14, 2023

melvin-bot bot commented Sep 14, 2023

situchan commented Sep 18, 2023

kosmydel commented Sep 19, 2023

situchan commented Sep 19, 2023

kosmydel commented Sep 19, 2023

situchan commented Sep 21, 2023

situchan commented Sep 28, 2023

kosmydel commented Oct 3, 2023

situchan commented Oct 3, 2023

kosmydel commented Oct 4, 2023

situchan commented Oct 4, 2023

hayata-suenaga commented Oct 5, 2023

kosmydel commented Oct 5, 2023

kosmydel commented Nov 2, 2023

hayata-suenaga commented Nov 2, 2023

situchan commented Nov 2, 2023

situchan left a comment

situchan commented Nov 2, 2023

kosmydel commented Nov 6, 2023

situchan commented Nov 7, 2023

situchan left a comment

hayata-suenaga left a comment

OSBotify commented Nov 9, 2023

OSBotify commented Nov 10, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 15, 2023

alitoshmatov Dec 2, 2024

Handle invisible characters in forms #27414

Handle invisible characters in forms #27414

Conversation

kosmydel commented Sep 14, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 14, 2023

melvin-bot bot commented Sep 14, 2023

situchan commented Sep 18, 2023

kosmydel commented Sep 19, 2023

situchan commented Sep 19, 2023

kosmydel commented Sep 19, 2023

situchan commented Sep 21, 2023

situchan commented Sep 28, 2023

kosmydel commented Oct 3, 2023

situchan commented Oct 3, 2023

kosmydel commented Oct 4, 2023

situchan commented Oct 4, 2023

hayata-suenaga commented Oct 5, 2023

kosmydel commented Oct 5, 2023

kosmydel commented Nov 2, 2023

hayata-suenaga commented Nov 2, 2023

situchan commented Nov 2, 2023

situchan left a comment

Choose a reason for hiding this comment

situchan commented Nov 2, 2023

kosmydel commented Nov 6, 2023

situchan commented Nov 7, 2023

Reviewer Checklist

Screenshots/Videos

situchan left a comment

Choose a reason for hiding this comment

hayata-suenaga left a comment

Choose a reason for hiding this comment

OSBotify commented Nov 9, 2023

OSBotify commented Nov 10, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 15, 2023

alitoshmatov Dec 2, 2024

Choose a reason for hiding this comment

kosmydel commented Sep 14, 2023 •

edited

Loading