OptionsSelector display max length error with counter when exceeded #28722

ahmedGaber93 · 2023-10-03T13:27:32Z

Details

Fixed Issues

$ #25804
PROPOSAL: #25804 (comment)

Tests

Open the app.
Click fab icon > send message > chat tab.
In search input type text with length more than 500 letter eg: 505 and Verify that the input has error with message "characters limited exceeded (505, 500).
Then complete typing to reach more than 520 letters and Verify that the input maxLength is 520 letters and not accept any text more than 520.
Then remove some letters to reach 500 letters or min and Verify that the input error is disappear.

Verify that no errors appear in the JS console

Offline tests

N/A.

QA Steps

Same as Tests step.

Verify that no errors appear in the JS console

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: https://expensify.slack.com/archives/C01GTK53T8Q/p1696599786092489
- 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

Screen.Recording.2023-10-03.at.12.34.04.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-10-03.at.1.40.30.PM.mov

Mobile Web - Safari

Screen.Recording.2023-10-03.at.1.02.26.PM.mov

Desktop

Screen.Recording.2023-10-03.at.12.39.02.PM.mov

iOS

Screen.Recording.2023-10-03.at.12.43.32.PM.mov

Android

Screen.Recording.2023-10-03.at.1.37.16.PM.mov

# Conflicts: # src/components/OptionsSelector/BaseOptionsSelector.js

melvin-bot · 2023-10-03T13:27:37Z

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

allroundexperts · 2023-10-04T19:50:22Z

src/components/OptionsSelector/BaseOptionsSelector.js

+    updateSearchValue(value) {
+        if (value.length > this.props.maxLength) {
+            this.setState({
+                searchValue: value,


Why are we setting the searchValue here and not calling onChangeText?

Not calling it causes the following behaviour:

Screen.Recording.2023-10-05.at.1.05.28.AM.mov

Notice how the options keep on showing despite no results existing.

The following should work well:

updateSearchValue(value) { this.setState({ searchValue: value, errorMessage: value.length > this.props.maxLength ? this.props.translate('common.error.characterLimitExceedCounter', {length: value.length, limit: this.props.maxLength}) : '', }); this.props.onChangeText(value); }

@allroundexperts
Calling this.props.onChangeText(value) will display the result for exceeded search value.
If we are going to allow that, I will remove searchValue also, because this.props.value it always updated when onChange and will used in the TextInput instead.

@ahmedGaber93 I think showing the results for the exceeded search value is fine. As long as we're allowing the user to enter the new value, we should also use it for showing the results. As such, the following works better:

updateSearchValue(value) { this.setState({ searchValue: value, errorMessage: value.length > this.props.maxLength ? this.props.translate('common.error.characterLimitExceedCounter', {length: value.length, limit: this.props.maxLength}) : '', }); this.props.onChangeText(value); }

@allroundexperts
I added searchValue to get the length of search text, because I was stopped calling this.props.onChangeText after exceed and the length of this.props.value is stopped, and now we will always use this.props.onChangeText, so I removed searchValue and back using this.props.value.
I will update it to be

updateSearchValue(value) { this.setState({ errorMessage: value.length > this.props.maxLength ? this.props.translate('common.error.characterLimitExceedCounter', {length: value.length, limit: this.props.maxLength}) : '', }); this.props.onChangeText(value); }

That makes sense. Thanks!

allroundexperts · 2023-10-04T20:12:41Z

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

Web

Screen.Recording.2023-10-05.at.1.02.10.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-10-05.at.1.11.00.AM.mov

Mobile Web - Safari

Screen.Recording.2023-10-05.at.1.08.26.AM.mov

Desktop

Screen.Recording.2023-10-05.at.1.03.48.AM.mov

iOS

Screen.Recording.2023-10-05.at.1.07.49.AM.mov

Android

Screen.Recording.2023-10-05.at.1.09.09.AM.mov

allroundexperts

One small change needed!

allroundexperts

Looks good!

src/languages/en.ts

src/languages/es.ts

flodnv · 2023-10-06T12:24:20Z

src/components/OptionsSelector/BaseOptionsSelector.js

                onSubmitEditing={this.selectFocusedOption}
                placeholder={this.props.placeholderText}
-                maxLength={this.props.maxLength}
+                maxLength={this.props.maxLength + CONST.ERROR_EXCEED_RANGE}


I am confused, can you explain this change?

@flodnv
We decide to use the below design.
We will allow the user to type more than the maxLength, but we will display an error with counter like the image below, and adding upper bound that stops the input.
So the input maxLength should be maxLength + the range we will display the exceeded counter
E.g. maxLength = 500 + 20 will show the error from 501 to 520

E.g. maxLength = 500 + 20 will show the error from 501 to 520

Sorry I am not seeing what that means on your screenshot 😕 What do you mean by "will show the error from 501 to 520"? What and where will the "501 to 520" error show? 😕

@flodnv
Sorry about wrong screenshot, this is the correct screenshot.

// the length can user type it without see the error with counter in the scrrenshot above. this.props.maxLength = 500; // the range we will display the error from 501 to 520 CONST.ERROR_EXCEED_RANGE = 20; // so the max length that user can type at all and the input will allow it will be maxLength={this.props.maxLength + CONST.ERROR_EXCEED_RANGE}

501 to 520 mean when the typed text length is between 501 and 520 characters, the error with counter will be displayed.

So if I understand this correctly, it is impossible to type past 520 chars? What if I paste 1000 chars there?

If we paste 1000 char, it will paste only 520 char, because the input maxLength don't let it accept more than 520 char, and this is the default behavior for maxLength, you can try here

flodnv · 2023-10-09T09:09:58Z

There are conflicts 😞

# Conflicts: # src/CONST.ts

ahmedGaber93 · 2023-10-09T09:57:08Z

@flodnv conflict is resolved.

# Conflicts: # src/CONST.ts

ahmedGaber93 · 2023-10-10T11:39:27Z

@flodnv other conflict is occurred and is now resolved.

flodnv · 2023-10-10T12:35:48Z

I am awaiting your reply here: #28722 (comment)

flodnv · 2023-10-10T15:58:25Z

src/CONST.ts

@@ -2737,6 +2737,8 @@ const CONST = {
    },

    MISSING_TRANSLATION: 'MISSING TRANSLATION',
+    SEARCH_MAX_LENGTH: 500,
+    ERROR_EXCEED_RANGE: 20,


Suggested change

ERROR_EXCEED_RANGE: 20,

/**

* The count of characters we'll allow the user to type after reaching SEARCH_MAX_LENGTH in an input.

*/

ADDITIONAL_ALLOWED_CHARACTERS: 20,

Thanks! Now that I understand what this is, I can suggest what I think is a better name along with some nice docs.

Yes, the comment makes it more understandable.

What about renaming the variable itself?

Yes, correct, I missed that.

@flodnv updated.

ahmedGaber93 · 2023-10-10T16:41:40Z

@flodnv Updated!

OSBotify · 2023-10-11T10:31:51Z

✋ 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-10-13T21:58:14Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-13T22:10:17Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-13T22:26:30Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-13T23:01:55Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

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

ahmedGaber93 added 4 commits October 3, 2023 00:36

OptionsSelector display max length error with counter when exceeded

05095d0

Merge branch 'main' into issue-25804

64d8a3d

# Conflicts: # src/components/OptionsSelector/BaseOptionsSelector.js

update translations

40354e1

prettier

7728993

ahmedGaber93 requested a review from a team as a code owner October 3, 2023 13:27

melvin-bot bot requested review from allroundexperts and removed request for a team October 3, 2023 13:27

ahmedGaber93 mentioned this pull request Oct 3, 2023

[HOLD for payment 2023-10-23] [HOLD for payment 2023-10-23] [HOLD for payment 2023-10-20] [HOLD for payment 2023-10-20] [$1000] Web - When input exceeds 500k characters, the web freezes. #25804

Closed

6 tasks

allroundexperts reviewed Oct 4, 2023

View reviewed changes

allroundexperts suggested changes Oct 4, 2023

View reviewed changes

ahmedGaber93 added 2 commits October 5, 2023 08:15

OptionsSelector display max length error with counter when exceeded

fde11f9

OptionsSelector display max length error with counter when exceeded

afc7d69

allroundexperts approved these changes Oct 5, 2023

View reviewed changes

melvin-bot bot requested a review from flodnv October 5, 2023 13:29

flodnv reviewed Oct 6, 2023

View reviewed changes

update en.ts file

9b98e98

allroundexperts approved these changes Oct 6, 2023

View reviewed changes

melvin-bot bot requested a review from flodnv October 6, 2023 19:43

Merge branch 'main' into issue-25804

731219c

# Conflicts: # src/CONST.ts

Merge branch 'main' into issue-25804

51e0e9c

# Conflicts: # src/CONST.ts

flodnv requested changes Oct 10, 2023

View reviewed changes

ahmedGaber93 added 2 commits October 10, 2023 18:08

add comment for CONST.ERROR_EXCEED_RANGE

0c00e23

Merge branch 'main' into issue-25804

b57df36

rename CONST.ERROR_EXCEED_RANGE

d5e39c2

flodnv approved these changes Oct 11, 2023

View reviewed changes

flodnv merged commit c0d470f into Expensify:main Oct 11, 2023
14 checks passed

mountiny mentioned this pull request Oct 12, 2023

Deploy Checklist: New Expensify 2023-10-12 #29417

Closed

97 tasks

trjExpensify mentioned this pull request Oct 16, 2023

[HOLD for payment 2023-10-30] Large legal name are not saved and no error message is displayed #19821

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OptionsSelector display max length error with counter when exceeded #28722

OptionsSelector display max length error with counter when exceeded #28722

ahmedGaber93 commented Oct 3, 2023 •

edited

Loading

melvin-bot bot commented Oct 3, 2023

allroundexperts Oct 4, 2023

allroundexperts Oct 4, 2023

allroundexperts Oct 4, 2023

ahmedGaber93 Oct 5, 2023 •

edited

Loading

ahmedGaber93 Oct 5, 2023

allroundexperts Oct 5, 2023

ahmedGaber93 Oct 5, 2023 •

edited

Loading

allroundexperts Oct 5, 2023

allroundexperts commented Oct 4, 2023 •

edited

Loading

allroundexperts left a comment

allroundexperts left a comment

flodnv Oct 6, 2023

ahmedGaber93 Oct 6, 2023

flodnv Oct 9, 2023

ahmedGaber93 Oct 10, 2023 •

edited

Loading

flodnv Oct 10, 2023

ahmedGaber93 Oct 10, 2023 •

edited

Loading

flodnv commented Oct 9, 2023

ahmedGaber93 commented Oct 9, 2023

ahmedGaber93 commented Oct 10, 2023

flodnv commented Oct 10, 2023

flodnv Oct 10, 2023

ahmedGaber93 Oct 10, 2023

flodnv Oct 11, 2023

ahmedGaber93 Oct 11, 2023

ahmedGaber93 Oct 11, 2023

flodnv Oct 11, 2023

ahmedGaber93 commented Oct 10, 2023

OSBotify commented Oct 11, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

-    ERROR_EXCEED_RANGE: 20,
+    /**
+      * The count of characters we'll allow the user to type after reaching SEARCH_MAX_LENGTH in an input.
+      */
+    ADDITIONAL_ALLOWED_CHARACTERS: 20,

OptionsSelector display max length error with counter when exceeded #28722

OptionsSelector display max length error with counter when exceeded #28722

Conversation

ahmedGaber93 commented Oct 3, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 3, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ahmedGaber93 Oct 5, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ahmedGaber93 Oct 5, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

allroundexperts commented Oct 4, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

allroundexperts left a comment

Choose a reason for hiding this comment

allroundexperts left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ahmedGaber93 Oct 10, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ahmedGaber93 Oct 10, 2023 • edited Loading

Choose a reason for hiding this comment

flodnv commented Oct 9, 2023

ahmedGaber93 commented Oct 9, 2023

ahmedGaber93 commented Oct 10, 2023

flodnv commented Oct 10, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ahmedGaber93 commented Oct 10, 2023

OSBotify commented Oct 11, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

ahmedGaber93 commented Oct 3, 2023 •

edited

Loading

ahmedGaber93 Oct 5, 2023 •

edited

Loading

ahmedGaber93 Oct 5, 2023 •

edited

Loading

allroundexperts commented Oct 4, 2023 •

edited

Loading

ahmedGaber93 Oct 10, 2023 •

edited

Loading

ahmedGaber93 Oct 10, 2023 •

edited

Loading