Fix/30921: No error message when editing a chat #31769

DylanDylann · 2023-11-23T03:56:24Z

Details

No error message when editing a chat to go past character limit

Fixed Issues

$ #30921
PROPOSAL: #30921 (comment)

Tests

Open app
Go to a report and enter > 10K characters
Observe the error message
Edit a message and enter >10k characters
Error message should appear

Verify that no errors appear in the JS console

Offline tests

QA Steps

Open app
Go to a report and enter > 10K characters
Observe the error message
Edit a message and enter >10k characters
Error message should appear

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screencast.from.23-11-2023.19.42.54.webm

Android: mWeb Chrome

Screencast.from.23-11-2023.10.58.09.webm

iOS: Native

Screencast.from.23-11-2023.19.52.33.webm

iOS: mWeb Safari

Screencast.from.23-11-2023.11.01.59.webm

MacOS: Chrome / Safari

Screencast.from.23-11-2023.10.56.54.webm

MacOS: Desktop

Screencast.from.23-11-2023.18.51.13.webm

melvin-bot · 2023-11-23T09:10:40Z

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

burczu · 2023-11-27T09:29:07Z

src/pages/home/report/ReportActionCompose/ComposerWithSuggestions/ComposerWithSuggestions.js

+            return;
+        }
+        setExceededMaxCommentLength(true);
+    }, [value, setExceededMaxCommentLength, hasExceededMaxCommentLength]);


I don't like this - I think we should rename these two props:

setExceededMaxCommentLength to onMaxLengthExceeded,
hasExceededMaxCommentLengthto maxLengthExceeded

@burczu I think we do not need to rename these two props, because we also call setExceededMaxCommentLength(false) when the input `s length < 10K. So it does not make sense if we call onMaxLengthExceeded(false)

I think, to keep the separation of concerns, the responsibility for setting the state should be moved to the component that holds this state, so here, in this file we should have:

useEffect(() => { onValueChange(value); }, [value]);

and in the ReportActionCompose we should handle onValueChange (onValueChange={handleValueChange}) like below:

handleValueChange = (value) => { if (ReportUtils.getCommentLength(value) <= CONST.MAX_COMMENT_LENGTH) { if (hasExceededMaxCommentLength) { setExceededMaxCommentLength(false); } return; } setExceededMaxCommentLength(true); }

What do you think?

@burczu Updated based on your suggestion

burczu · 2023-11-29T09:17:05Z

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

Screen.Recording.2023-12-08.at.10.18.22.mov

Android: mWeb Chrome

Screen.Recording.2023-12-08.at.10.26.39.mov

iOS: Native

Screen.Recording.2023-12-08.at.10.20.21.mov

iOS: mWeb Safari

Screen.Recording.2023-12-08.at.10.22.59.mov

MacOS: Chrome / Safari

Screen.Recording.2023-12-08.at.10.37.00.mov

MacOS: Desktop

Screen.Recording.2023-12-08.at.10.30.31.mov

burczu · 2023-11-29T09:50:00Z

@DylanDylann I've found some warning when I open a chat with a very long message - please see screenshots below:

Looks like it's related with the prop you've added, so please fix it.

burczu · 2023-11-29T09:53:19Z

Also, please check the below video of Native Android, there is some strange behavior:

Screen.Recording.2023-11-29.at.10.46.07.mov

When I delete the word dolor the do re-appears for some reason after a while - might this be related with the debounce removal?

P.S. Checked also on web, and it does not happen there, but there is another problem - when the text has almost 10k characters, there is significant delay between typing the letters on the keyboard and appearing them in the input (this issue disappears right after the limit is exceeded and the error message appears), so I guess debounce is necessary here...

DylanDylann · 2023-11-29T10:06:11Z

@burczu In the above, you mentioned:

So I guess debounce is necessary here...

So you mean debounce when update the shouldShowError, right?

burczu · 2023-11-29T10:09:59Z

@DylanDylann Yeah, I think so but please test it.

DylanDylann · 2023-11-29T10:10:49Z

@burczu Sure, will test it

DylanDylann · 2023-11-30T09:41:35Z

@DylanDylann I've found some warning when I open a chat with a very long message - please see screenshots below:

Looks like it's related with the prop you've added, so please fix it.

I cannot reproduce this one. If can, please help give me the steps to reproduce

Screencast.from.30-11-2023.16.40.03.webm

DylanDylann · 2023-11-30T10:09:42Z

When I delete the word dolor the do re-appears for some reason after a while - might this be related with the debounce removal?

@burczu ~~I can reproduce this one in the latest main. Can you try it.~~
~~Here is the screenshot in latest main:~~

~~Screencast from 30-11-2023 17:10:06.webm~~

DylanDylann · 2023-11-30T11:33:18Z

P.S. Checked also on web, and it does not happen there, but there is another problem - when the text has almost 10k characters, there is significant delay between typing the letters on the keyboard and appearing them in the input (this issue disappears right after the limit is exceeded and the error message appears), so I guess debounce is necessary here...

@burczu

Yeah, I agree with you that we need to add the debounce here
RCA: Currrently, once the text input change, we call ReportUtils.getCommentLength(value) to get the input length. And because the longer the text, the longer the execution time of the function, so it leads to the behavior that you mentioned
Solution: Using the debounce function:

const handleValueChangeDebounce = useMemo(() => _.debounce(handleValueChange, 1500), [handleValueChange]);

rather than
handleValueChange

burczu · 2023-12-04T12:51:40Z

@DylanDylann Regarding this:

I cannot reproduce this one. If can, please help give me the steps to reproduce

I've tested again and wasn't able to reproduce it too, so maybe it's fixed now - I'll let you know if I encounter it again.

When it comes to this one:

@burczu I can reproduce this one in the latest main. Can you try it.
Here is the screenshot in latest main:

Can we try to tackle this issue - I guess it is related to the code we touch while working on this issue.

Regarding the last comment, yes - I think we should give the solution you've proposed a try.

DylanDylann · 2023-12-06T08:58:55Z

I am working on this comment #31769 (comment)

DylanDylann · 2023-12-06T15:34:43Z

@burczu

I just updated the PR to use the debounce

const handleValueChangeDebounce = useMemo(() => _.debounce(handleValueChange, 1500), [handleValueChange]);

It also fixes the bellow issue:

When I delete the word dolor the do re-appears for some reason after a while - might this be related with the debounce removal?

Just to note here, Fix/30921: No error message when editing a chat #31769 (comment), in latest main, I cannot reproduce it

burczu

LGTM in general.

The only concern I have is that we have code duplication in ComposerWithSuggestion and ReportActionItemMessageEdit components (handleValueChange and handleValueChangeDebounce methods are the same in both places) - maybe we could think about extracting them to some shared custom hook? But it does not seem to be widely used approach in the App... I wonder what the Expensify engineer that will be assigned thinks about it.

tgolen

I agree I would like to see if the duplicated logic for handleValueChange could be cleaned up and shared. I think a custom hook is fine.

DylanDylann · 2023-12-12T16:56:03Z

@burczu @tgolen I just created the hook based on this comment #31769 (review)

tgolen · 2023-12-12T18:33:03Z

src/hooks/useHandleExceedMaxCommentLength.ts

+
+    const handleValueChangeDebounce = useMemo(() => _.debounce(handleValueChange, 1500), [handleValueChange]);
+
+    return {hasExceededMaxCommentLength, handleValueChangeDebounce};


Could you please rename handleValueChangeDebounce to validateCommentMaxLength? There are a few reasons for this:

Functions should be named for what they do, not what they handle

It isn't necessary for anything to know that it's debounced (it's an implementation detail)

It is a bit ambiguous without mentioning the word "comment"

@tgolen I updated

tgolen

Looks really good. Thank you!

OSBotify · 2023-12-13T15:38:20Z

✋ 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-12-14T16:05:34Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.4.13-0 🚀

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

OSBotify · 2023-12-14T16:45:22Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.4.13-0 🚀

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

OSBotify · 2023-12-19T02:01:40Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.4.13-8 🚀

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

fix no error message when editing a chat

56ae3df

DylanDylann marked this pull request as ready for review November 23, 2023 09:10

DylanDylann requested a review from a team as a code owner November 23, 2023 09:10

melvin-bot bot requested review from burczu and removed request for a team November 23, 2023 09:10

DylanDylann mentioned this pull request Nov 23, 2023

[HOLD for payment 2023-12-26] [$500] No error message when editing a chat to go past character limit #30921

Closed

6 tasks

burczu reviewed Nov 27, 2023

View reviewed changes

fix refactor the onValueChange

9344c1e

fix merge main

61ae94b

DylanDylann added 2 commits December 6, 2023 21:19

fix merge main

a6fb968

fix perf issue

dd81868

burczu approved these changes Dec 8, 2023

View reviewed changes

melvin-bot bot requested a review from tgolen December 8, 2023 09:49

tgolen requested changes Dec 11, 2023

View reviewed changes

DylanDylann added 3 commits December 12, 2023 23:35

fix create useHandleExceedMaxCommentLength

8909420

fix add underscore lib

8063878

fix add lodash lib

62718fc

tgolen requested changes Dec 12, 2023

View reviewed changes

fix rename function

37acb42

tgolen approved these changes Dec 13, 2023

View reviewed changes

tgolen merged commit ba19793 into Expensify:main Dec 13, 2023

github-actions bot mentioned this pull request Dec 14, 2023

Deploy Checklist: New Expensify 2023-12-14 #33072

Closed

77 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix/30921: No error message when editing a chat #31769

Fix/30921: No error message when editing a chat #31769

DylanDylann commented Nov 23, 2023 •

edited

Loading

melvin-bot bot commented Nov 23, 2023

burczu Nov 27, 2023 •

edited

Loading

DylanDylann Nov 27, 2023

burczu Nov 28, 2023 •

edited

Loading

DylanDylann Nov 28, 2023

burczu commented Nov 29, 2023 •

edited

Loading

burczu commented Nov 29, 2023

burczu commented Nov 29, 2023 •

edited

Loading

DylanDylann commented Nov 29, 2023

burczu commented Nov 29, 2023

DylanDylann commented Nov 29, 2023

DylanDylann commented Nov 30, 2023 •

edited

Loading

DylanDylann commented Nov 30, 2023 •

edited

Loading

DylanDylann commented Nov 30, 2023 •

edited

Loading

burczu commented Dec 4, 2023

DylanDylann commented Dec 6, 2023

DylanDylann commented Dec 6, 2023 •

edited

Loading

burczu left a comment •

edited

Loading

tgolen left a comment

DylanDylann commented Dec 12, 2023

tgolen Dec 12, 2023

DylanDylann Dec 13, 2023

tgolen left a comment

OSBotify commented Dec 13, 2023

OSBotify commented Dec 14, 2023

OSBotify commented Dec 14, 2023

OSBotify commented Dec 19, 2023


		const handleValueChangeDebounce = useMemo(() => _.debounce(handleValueChange, 1500), [handleValueChange]);

		return {hasExceededMaxCommentLength, handleValueChangeDebounce};

Fix/30921: No error message when editing a chat #31769

Fix/30921: No error message when editing a chat #31769

Conversation

DylanDylann commented Nov 23, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 23, 2023

burczu Nov 27, 2023 • edited Loading

Choose a reason for hiding this comment

DylanDylann Nov 27, 2023

Choose a reason for hiding this comment

burczu Nov 28, 2023 • edited Loading

Choose a reason for hiding this comment

DylanDylann Nov 28, 2023

Choose a reason for hiding this comment

burczu commented Nov 29, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

burczu commented Nov 29, 2023

burczu commented Nov 29, 2023 • edited Loading

DylanDylann commented Nov 29, 2023

burczu commented Nov 29, 2023

DylanDylann commented Nov 29, 2023

DylanDylann commented Nov 30, 2023 • edited Loading

DylanDylann commented Nov 30, 2023 • edited Loading

DylanDylann commented Nov 30, 2023 • edited Loading

burczu commented Dec 4, 2023

DylanDylann commented Dec 6, 2023

DylanDylann commented Dec 6, 2023 • edited Loading

burczu left a comment • edited Loading

Choose a reason for hiding this comment

tgolen left a comment

Choose a reason for hiding this comment

DylanDylann commented Dec 12, 2023

tgolen Dec 12, 2023

Choose a reason for hiding this comment

DylanDylann Dec 13, 2023

Choose a reason for hiding this comment

tgolen left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 13, 2023

OSBotify commented Dec 14, 2023

OSBotify commented Dec 14, 2023

OSBotify commented Dec 19, 2023

DylanDylann commented Nov 23, 2023 •

edited

Loading

burczu Nov 27, 2023 •

edited

Loading

burczu Nov 28, 2023 •

edited

Loading

burczu commented Nov 29, 2023 •

edited

Loading

burczu commented Nov 29, 2023 •

edited

Loading

DylanDylann commented Nov 30, 2023 •

edited

Loading

DylanDylann commented Nov 30, 2023 •

edited

Loading

DylanDylann commented Nov 30, 2023 •

edited

Loading

DylanDylann commented Dec 6, 2023 •

edited

Loading

burczu left a comment •

edited

Loading