fix: delay in displaying comment length limit error #33848

aswin-s · 2024-01-02T19:54:04Z

Details

This PR fixes an issue where the error message for exceeding character limit in composer was delayed on first render.

Fixed Issues

$ #33612
PROPOSAL: #33612 (comment)

Tests

Navigate to NewDot.
Draft a message over 10 000 characters in any chat
Navigate to any other conversation
Navigate back
Verify that the error message The maximum comment length is 10,000 characters is only shown without any delay.

Verify that no errors appear in the JS console

Offline tests

Navigate to NewDot.
Draft a message over 10 000 characters in any chat
Navigate to any other conversation
Navigate back
Verify that the error message The maximum comment length is 10,000 characters is only shown without any delay.

QA Steps

Navigate to NewDot.
Draft a message over 10 000 characters in any chat
Navigate to any other conversation
Navigate back
Verify that the error message The maximum comment length is 10,000 characters is only shown without any delay.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

android-web.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

ios-web.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

melvin-bot · 2024-01-02T19:54:09Z

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

abdulrahuman5196 · 2024-01-03T08:57:49Z

src/hooks/useHandleExceedMaxCommentLength.ts

@@ -19,7 +19,7 @@ const useHandleExceedMaxCommentLength = () => {
        [hasExceededMaxCommentLength],
    );

-    const validateCommentMaxLength = useMemo(() => _.debounce(handleValueChange, 1500), [handleValueChange]);
+    const validateCommentMaxLength = useMemo(() => _.debounce(handleValueChange, 500, {leading: true}), [handleValueChange]);


@aswin-s I don't think we need to reduce the timeout. Any reason to do it?

1.5 seconds feels a bit too much in my testing. It waits for 1.5 seconds after last invocation to trigger the check. 500ms felt like a safe middle ground. The issue gets fixed even without the change in timing.

@abdulrahuman5196 Do you think it is safe to revert the timeout change?

I think we should only do the computation once the user stops typing and gives a pause, since it could add computational overhead to compute the error sooner. That's why I assume we kept it at 1500 ms. I think for this PR, it should be fine to leave it as it is.

@abdulrahuman5196 I've reverted the timeout change.

abdulrahuman5196 · 2024-01-03T11:26:31Z

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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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.
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

Screen.Recording.2024-01-03.at.3.54.28.PM.mp4

Android: mWeb Chrome

Screen.Recording.2024-01-03.at.4.03.59.PM.mp4

iOS: Native

Screen.Recording.2024-01-03.at.3.45.07.PM.mp4

iOS: mWeb Safari

Screen.Recording.2024-01-03.at.3.52.30.PM.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-01-03.at.3.40.24.PM.mp4

MacOS: Desktop

Screen.Recording.2024-01-03.at.3.42.52.PM.mp4

abdulrahuman5196

Changes looks good and works well. Reviewers checklist is also complete.

All yours. @tylerkaraszewski

🎀 👀 🎀
C+ Reviewed

OSBotify · 2024-01-03T17:13:03Z

✋ 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 · 2024-01-04T19:04:36Z

🚀 Deployed to staging by https://github.com/tylerkaraszewski in version: 1.4.22-0 🚀

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

OSBotify · 2024-01-04T20:12:13Z

🚀 Deployed to staging by https://github.com/tylerkaraszewski in version: 1.4.22-0 🚀

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

OSBotify · 2024-01-09T05:20:53Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.22-6 🚀

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

fix: delay in displaying comment length limit error

4388e1e

aswin-s requested a review from a team as a code owner January 2, 2024 19:54

melvin-bot bot requested review from abdulrahuman5196 and removed request for a team January 2, 2024 19:54

abdulrahuman5196 reviewed Jan 3, 2024

View reviewed changes

fix: revert timeout to 1500ms

48f3a87

aswin-s requested a review from abdulrahuman5196 January 3, 2024 09:14

abdulrahuman5196 approved these changes Jan 3, 2024

View reviewed changes

melvin-bot bot requested a review from tylerkaraszewski January 3, 2024 11:32

tylerkaraszewski approved these changes Jan 3, 2024

View reviewed changes

tylerkaraszewski merged commit b097996 into Expensify:main Jan 3, 2024
16 of 17 checks passed

github-actions bot mentioned this pull request Jan 4, 2024

Deploy Checklist: New Expensify 2024-01-04 #33973

Closed

74 tasks

aswin-s deleted the fix/issue-33612 branch January 9, 2024 05:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: delay in displaying comment length limit error #33848

fix: delay in displaying comment length limit error #33848

aswin-s commented Jan 2, 2024

melvin-bot bot commented Jan 2, 2024

abdulrahuman5196 Jan 3, 2024

aswin-s Jan 3, 2024

aswin-s Jan 3, 2024

abdulrahuman5196 Jan 3, 2024

abdulrahuman5196 Jan 3, 2024

aswin-s Jan 3, 2024

abdulrahuman5196 commented Jan 3, 2024 •

edited

Loading

abdulrahuman5196 left a comment

OSBotify commented Jan 3, 2024

OSBotify commented Jan 4, 2024

OSBotify commented Jan 4, 2024

OSBotify commented Jan 9, 2024

fix: delay in displaying comment length limit error #33848

fix: delay in displaying comment length limit error #33848

Conversation

aswin-s commented Jan 2, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jan 2, 2024

abdulrahuman5196 Jan 3, 2024

Choose a reason for hiding this comment

aswin-s Jan 3, 2024

Choose a reason for hiding this comment

aswin-s Jan 3, 2024

Choose a reason for hiding this comment

abdulrahuman5196 Jan 3, 2024

Choose a reason for hiding this comment

abdulrahuman5196 Jan 3, 2024

Choose a reason for hiding this comment

aswin-s Jan 3, 2024

Choose a reason for hiding this comment

abdulrahuman5196 commented Jan 3, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

OSBotify commented Jan 3, 2024

OSBotify commented Jan 4, 2024

OSBotify commented Jan 4, 2024

OSBotify commented Jan 9, 2024

abdulrahuman5196 commented Jan 3, 2024 •

edited

Loading