fix: ensure processing of markup in comment #24319

samh-nl · 2023-08-09T14:57:46Z

Details

Previously, markup was not always processed in a comment if the length exceeded a certain threshold. This PR ensures that markup is always processed.

Fixed Issues

$ #21817
PROPOSAL: #21817 (comment)

Tests

Open any report
Type a message that ends with a user mention and where the message length exceeds the 10,000 limit
Verify that an error indicator appears
Reduce the message length until the error indicator disappears, but ensure the user mention is still present
Post the message
Verify that the user mention is correctly processed (i.e. is not plaintext)

Verify that no errors appear in the JS console

Offline tests

Open any report
Type a message that ends with a user mention and where the message length exceeds the 10,000 limit
Verify that an error indicator appears
Reduce the message length until the error indicator disappears, but ensure the user mention is still present
Post the message
Verify that the user mention is correctly processed (i.e. is not plaintext)

QA Steps

Open any report
Type a message that ends with a user mention and where the message length exceeds the 10,000 limit
Verify that an error indicator appears
Reduce the message length until the error indicator disappears, but ensure the user mention is still present
Post the message
Verify that the user mention is correctly processed (i.e. is not plaintext)

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Web.Screen.Recording.2023-08-09.at.15.36.03.mp4

Mobile Web - Chrome

mWeb.Chrome.Screen.Recording.2023-08-09.at.16.48.28.mp4

Mobile Web - Safari

mWeb.Safari.Screen.Recording.2023-08-09.at.16.09.31.mp4

Desktop

Desktop.Screen.Recording.2023-08-09.at.15.36.30.mp4

iOS

Native.iOS.Screen.Recording.2023-08-09.at.16.00.34.mp4

Android

Native.Android.Screen.Recording.2023-08-09.at.16.45.54.mp4

melvin-bot · 2023-08-09T14:57:53Z

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

sobitneupane

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

Untitled.mov

Mobile Web - Chrome

Screen.Recording.2023-08-11.at.14.39.16.mov

Mobile Web - Safari

Screen.Recording.2023-08-11.at.14.16.34.mov

Desktop

Screen.Recording.2023-08-11.at.14.07.55.mov

iOS

Screen.Recording.2023-08-11.at.14.13.01.mov

Android

Screen.Recording.2023-08-11.at.14.38.17.mov

sobitneupane · 2023-08-11T08:58:38Z

NAB: We can use better error message instead of 10,000+. For example: 'Comment Too Long: Max length is 10,000 characters.'

samh-nl · 2023-08-11T12:53:19Z

Perhaps a shorter version of that? Comment exceeds 10,000 characters

samh-nl · 2023-08-14T10:03:02Z

Bump

sobitneupane · 2023-08-14T10:14:43Z

I have added by suggestion here. But it is not a blocker, so waiting for @neil-marcellini to have a look.

neil-marcellini · 2023-08-15T21:05:34Z

Ha good news, we have a marketing team that can help us figure out the best error message text. I'll request a review from them on the issue.

neil-marcellini

At around 57 seconds in the web testing video some plain text is removed and the comment no longer exceeds the max length. Next, one character is added to the plain text, and you would expect that the comment would again exceed the max length, but it does not. Why? I find that confusing.

Oh, maybe this is caused by the debounce on the comment length? In that case it's probably ok. Or maybe we can remove the debounce and make sure it's still performant?

App/src/components/ExceededCommentLength.js

Lines 23 to 27 in b43b1b9

    
           debounce((comment, onExceededMaxCommentLength) => { 
        
               const newCommentLength = ReportUtils.getCommentLength(comment); 
        
               setCommentLength(newCommentLength); 
        
               onExceededMaxCommentLength(newCommentLength > CONST.MAX_COMMENT_LENGTH); 
        
           }, CONST.TIMING.COMMENT_LENGTH_DEBOUNCE_TIME),

sobitneupane · 2023-08-16T05:09:49Z

Oh, maybe this is caused by the debounce on the comment length?

Yup. It is caused by debounce.

neil-marcellini · 2023-08-17T17:44:03Z

The error message we should use is "The maximum comment length is 10,000 characters." @samh-nl will you please work on getting it updated, and maybe see if it's okay to remove the debounce? Let's only remove it if we're sure it won't cause regressions, otherwise I'm fine with how it currently is.

samh-nl · 2023-08-18T11:38:27Z

The error message we should use is "The maximum comment length is 10,000 characters." @samh-nl will you please work on getting it updated,

Thank you, I'm just waiting for the Spanish translation and I've reached out to @grafaelg for this on Slack.

and maybe see if it's okay to remove the debounce? Let's only remove it if we're sure it won't cause regressions, otherwise I'm fine with how it currently is.

Regarding debouncing, it introduces noticeable lag on writing when removing it. The markdown isn't very performant unfortunately, I've previously compared it to other popular implementations in my proposal, which seem to be orders of magnitude faster than the homemade implementation used here. But perhaps there are specific reasons for the current implementation that I'm not aware of.

samh-nl · 2023-08-18T15:58:21Z

Please see the latest commit.

neil-marcellini · 2023-08-18T17:12:43Z

@sobitneupane would you please test once more, just to be cautious, then message me on NewDot so I can merge it?

sobitneupane · 2023-08-21T08:20:32Z

@samh-nl When window is resized, at some point the error message breaks into two line. Can we keep it in single line with ellipsis if it overflows.

samh-nl · 2023-08-21T10:01:39Z

@sobitneupane It now clamps to one line and adds ellipsis on overflow.

sobitneupane

Thanks for the update @samh-nl. Changes look good and test well.

Screenshots/Videos

Web

Screen.Recording.2023-08-22.at.12.09.05.mov

Mobile Web - Chrome

Screen.Recording.2023-08-22.at.12.26.05.mov

Mobile Web - Safari

Screen.Recording.2023-08-22.at.12.18.56.mov

Desktop

Screen.Recording.2023-08-22.at.12.13.30.mov

iOS

Screen.Recording.2023-08-22.at.12.20.40.mov

Android

neil-marcellini

Good to go except the conflicts. Please DM me on NewDot when it's ready.

samh-nl · 2023-08-28T16:43:58Z

Resolved the conflict, I will re-test now to ensure there's no problems.

samh-nl · 2023-08-29T11:29:36Z

Confirming that it tests well. Sorry for the delay, had some difficulty building android.

neil-marcellini · 2023-08-30T16:11:12Z

Good to go but we have a merge freeze so we have to wait unfortunately.

samh-nl · 2023-09-11T21:11:01Z

I have merged main into the branch and added a TS type.

neil-marcellini · 2023-09-18T21:47:24Z

Thanks @samh-nl. Would you please fix the merge conflicts and then DM me and we can get this merged?

samh-nl · 2023-09-19T09:00:23Z

I have merged main into the branch again.

neil-marcellini · 2023-09-20T03:44:53Z

I'm still seeing conflicts @samh-nl ☹️

samh-nl · 2023-09-20T07:00:45Z

Merged again. It's due to TS types being added. If it occurs again I can put our type a line higher in the list, so any additions shouldn't cause a merge conflict.

OSBotify · 2023-09-21T05:23:24Z

✋ 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-09-22T14:00:29Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 1.3.73-0 🚀

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

OSBotify · 2023-09-25T09:35:20Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.73-1 🚀

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

OSBotify · 2023-09-25T10:07:21Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 1.3.74-0 🚀

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

OSBotify · 2023-09-28T18:49:42Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

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

samh-nl added 4 commits August 9, 2023 12:56

fix: update length exceeded indicator

3bc046b

fix: make identical to max markup length

49b14a7

docs: update comment for MAX_MARKUP_LENGTH

588b04d

fix: inclusive comparison for parsing

b43b1b9

samh-nl requested a review from a team as a code owner August 9, 2023 14:57

melvin-bot bot requested review from sobitneupane and removed request for a team August 9, 2023 14:57

samh-nl mentioned this pull request Aug 9, 2023

[HOLD for payment 2023-10-02] [$1000] Chat - Mention is not displayed in message with full 15000 letters #21817

Closed

6 tasks

sobitneupane approved these changes Aug 11, 2023

View reviewed changes

melvin-bot bot requested a review from neil-marcellini August 11, 2023 08:55

neil-marcellini reviewed Aug 15, 2023

View reviewed changes

feat(lang): updated limit exceeded error

211e92d

neil-marcellini previously approved these changes Aug 18, 2023

View reviewed changes

neil-marcellini requested a review from sobitneupane August 18, 2023 17:12

fix: ensure single line with ellipsis on overflow

6dca5cd

samh-nl dismissed neil-marcellini’s stale review via 6dca5cd August 21, 2023 09:32

sobitneupane approved these changes Aug 22, 2023

View reviewed changes

Merge branch 'main' into fix/issue-21817

c0363d5

neil-marcellini previously approved these changes Aug 28, 2023

View reviewed changes

samh-nl dismissed neil-marcellini’s stale review via c0363d5 August 28, 2023 16:35

neil-marcellini previously approved these changes Aug 30, 2023

View reviewed changes

neil-marcellini changed the title ~~fix: ensure processing of markup in comment~~ [HOLD merge freeze] fix: ensure processing of markup in comment Aug 30, 2023

Merge branch 'main' into fix/issue-21817

33d4c06

samh-nl dismissed neil-marcellini’s stale review via 33d4c06 September 11, 2023 20:21

fix: added type

62de1ba

neil-marcellini changed the title ~~[HOLD merge freeze] fix: ensure processing of markup in comment~~ fix: ensure processing of markup in comment Sep 18, 2023

Merge branch 'main' into fix/issue-21817

b54ad9d

Merge branch 'main' into fix/issue-21817

a32f729

neil-marcellini approved these changes Sep 21, 2023

View reviewed changes

neil-marcellini merged commit c57c625 into Expensify:main Sep 21, 2023
11 checks passed

DylanDylann mentioned this pull request Sep 22, 2023

[$500] Web - Error doesn't disappear for a while after deleting entire max exceed message. #27698

Closed

6 tasks

OSBotify mentioned this pull request Sep 22, 2023

Deploy Checklist: New Expensify 2023-09-22 #28013

Closed

96 tasks

This was referenced Sep 25, 2023

Deploy Checklist: New Expensify DUPE 2023-09-25 #28118

Closed

Deploy Checklist: New Expensify 2023-09-25 #28119

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: ensure processing of markup in comment #24319

fix: ensure processing of markup in comment #24319

samh-nl commented Aug 9, 2023

melvin-bot bot commented Aug 9, 2023

sobitneupane left a comment

sobitneupane commented Aug 11, 2023

samh-nl commented Aug 11, 2023

samh-nl commented Aug 14, 2023

sobitneupane commented Aug 14, 2023

neil-marcellini commented Aug 15, 2023

neil-marcellini left a comment

sobitneupane commented Aug 16, 2023

neil-marcellini commented Aug 17, 2023

samh-nl commented Aug 18, 2023

samh-nl commented Aug 18, 2023

neil-marcellini commented Aug 18, 2023

sobitneupane commented Aug 21, 2023

samh-nl commented Aug 21, 2023

sobitneupane left a comment •

edited

Loading

neil-marcellini left a comment

samh-nl commented Aug 28, 2023

samh-nl commented Aug 29, 2023

neil-marcellini commented Aug 30, 2023

samh-nl commented Sep 11, 2023

neil-marcellini commented Sep 18, 2023

samh-nl commented Sep 19, 2023

neil-marcellini commented Sep 20, 2023

samh-nl commented Sep 20, 2023

OSBotify commented Sep 21, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

	debounce((comment, onExceededMaxCommentLength) => {
	const newCommentLength = ReportUtils.getCommentLength(comment);
	setCommentLength(newCommentLength);
	onExceededMaxCommentLength(newCommentLength > CONST.MAX_COMMENT_LENGTH);
	}, CONST.TIMING.COMMENT_LENGTH_DEBOUNCE_TIME),

fix: ensure processing of markup in comment #24319

fix: ensure processing of markup in comment #24319

Conversation

samh-nl commented Aug 9, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 9, 2023

sobitneupane left a comment

Choose a reason for hiding this comment

Reviewer Checklist

Screenshots/Videos

sobitneupane commented Aug 11, 2023

samh-nl commented Aug 11, 2023

samh-nl commented Aug 14, 2023

sobitneupane commented Aug 14, 2023

neil-marcellini commented Aug 15, 2023

neil-marcellini left a comment

Choose a reason for hiding this comment

sobitneupane commented Aug 16, 2023

neil-marcellini commented Aug 17, 2023

samh-nl commented Aug 18, 2023

samh-nl commented Aug 18, 2023

neil-marcellini commented Aug 18, 2023

sobitneupane commented Aug 21, 2023

samh-nl commented Aug 21, 2023

sobitneupane left a comment • edited Loading

Choose a reason for hiding this comment

Screenshots/Videos

neil-marcellini left a comment

Choose a reason for hiding this comment

samh-nl commented Aug 28, 2023

samh-nl commented Aug 29, 2023

neil-marcellini commented Aug 30, 2023

samh-nl commented Sep 11, 2023

neil-marcellini commented Sep 18, 2023

samh-nl commented Sep 19, 2023

neil-marcellini commented Sep 20, 2023

samh-nl commented Sep 20, 2023

OSBotify commented Sep 21, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

sobitneupane left a comment •

edited

Loading