Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix last message text in LHN includes text and no space above quoted text #8814

Merged
merged 6 commits into from
Jun 9, 2022
Merged

Conversation

mollfpr
Copy link
Contributor

@mollfpr mollfpr commented Apr 28, 2022

Details

Using htmlToText from ExpensifyMark to replace breakline and blockquote closing tag to space ' ', strip out tags.

Fixed Issues

$ #8134

Tests

  1. Open chat
  2. Send quoted text and non-quoted text in a single message. Example:
> Confusing stuff
Tell me about it
  1. Verify on the sender and receiver LHN that there's empty space after the quoted text. Example:
    Confusing stuff Tell me about it
  • Verify that no errors appear in the JS console

PR Review Checklist

Contributor (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 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 included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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
  • 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 */
    • Any functional components have the displayName property
    • 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
  • 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 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.

PR Reviewer Checklist

  • 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 verified tests pass on all platforms & I tested again on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 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 */
    • Any functional components have the displayName property
    • 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 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 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.

QA Steps

  1. Open chat
  2. Send quoted text and non-quoted text in a single message. Example:
> Confusing stuff
Tell me about it
  1. Verify on the sender and receiver LHN that there's empty space after the quoted text. Example:
    Confusing stuff Tell me about it
  • Verify that no errors appear in the JS console

Screenshots

Web

screen-recording-2022-04-28-at-012537_TXS8ZwSl.mp4

Mobile Web

screen-recording-2022-04-28-at-115143_xnEOINzG.mp4
screen-recording-2022-04-28-at-115102_yu2dZd3t.mp4

Desktop

screen-recording-2022-04-28-at-115536_c5bFvKI6.mp4

iOS

screen-recording-2022-04-28-at-013409_GM3xdxCi.mp4

Android

screen-recording-2022-04-28-at-014003_Vib6YZX0.mp4

@mollfpr mollfpr requested review from marcaaron and a team as code owners April 28, 2022 05:26
@melvin-bot melvin-bot bot requested review from Luke9389 and parasharrajat and removed request for a team April 28, 2022 05:26
Comment on lines 602 to 609
let messageText = lodashGet(reportAction, ['message', 0, 'html'], '');
if (reportAction.actionName === CONST.REPORT.ACTIONS.TYPE.RENAMED) {
messageText = lodashGet(reportAction, 'originalMessage.html', '');
}

const parser = new ExpensiMark();
messageText = parser.htmlToText(messageText);

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like this change should be done at the backend.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@parasharrajat Yeah probably, any suggestion on what we should do then?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Luke9389 should we do the correct on the backend as well? The backend already converts the HTML to text and then sends it frontend. It does not use the text that we send in the action instead do the conversion itself. So I think we should also make the correction on the backend.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I was OOO last week. Just checking this one out. One moment....

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, yea. I agree this should be done on the backend.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Luke9389 @parasharrajat How do we do that?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I'll have to make a PR because our backend isn't open-source.

I'm just looking into how we prep the text value of that message key. It doesn't look like we import the Expensimark lib at all in that file.

I'll come back and update you guys when that change has been deployed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, sorry to flipflop here, but I think this is actually fine to do on the front end. We're using the strip_tags PHP method on the back end, and changing that to pick up on </blockquote> specifically is not going to be pretty, and seems inappropriate.

Comment on lines 106 to 113
const parser = new ExpensiMark();
const lastMessageIndex = _.findLastIndex(reportActions[reportID], action => (
!ReportUtils.isDeletedAction(action)
));
const htmlText = lodashGet(reportActions, [reportID, lastMessageIndex, 'message', 0, 'html'], '');
const messageText = parser.htmlToText(htmlText);

return ReportUtils.formatReportLastMessageText(
lodashGet(reportActions, [reportID, lastMessageIndex, 'message', 0, 'text'], ''),
);
return ReportUtils.formatReportLastMessageText(messageText);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we do the previous change, then we won't need this.

@parasharrajat
Copy link
Member

@mollfpr We can [Hold] on the PR title.

@mollfpr mollfpr changed the title Fix last message text in LHN includes text and no space above quoted text [Hold] Fix last message text in LHN includes text and no space above quoted text May 3, 2022
@marcaaron marcaaron removed their request for review May 6, 2022 19:49
@mollfpr
Copy link
Contributor Author

mollfpr commented May 12, 2022

@Luke9389 Any update for the API?

@Luke9389
Copy link
Contributor

Still on hold. Feel free to take other jobs in the meantime @mollfpr

@Luke9389 Luke9389 changed the title [Hold] Fix last message text in LHN includes text and no space above quoted text Fix last message text in LHN includes text and no space above quoted text Jun 7, 2022
@Luke9389
Copy link
Contributor

Luke9389 commented Jun 7, 2022

Took this off HOLD, feel free to continue. Sorry for the long delay here @mollfpr

@mollfpr
Copy link
Contributor Author

mollfpr commented Jun 7, 2022

@Luke9389 No problem! 👍

@parasharrajat
Copy link
Member

Please merge main.

@mollfpr mollfpr requested a review from parasharrajat June 8, 2022 01:34
@@ -548,9 +547,12 @@ function updateReportWithNewAction(
reportAction,
notificationPreference = CONST.REPORT.NOTIFICATION_PREFERENCE.ALWAYS,
) {
const messageText = reportAction.actionName === CONST.REPORT.ACTIONS.TYPE.RENAMED
let messageText = reportAction.actionName === CONST.REPORT.ACTIONS.TYPE.RENAMED
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
let messageText = reportAction.actionName === CONST.REPORT.ACTIONS.TYPE.RENAMED
let messageHtml = reportAction.actionName === CONST.REPORT.ACTIONS.TYPE.RENAMED

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch 👍

lastMessageText = lastActionMessage
.replace(/((<br[^>]*>)+)/gi, ' ')
.replace(/(<([^>]+)>)/gi, '');
// We convert the line-breaks and blockquote closing tag in html to space ' ' before striping the tags
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this comment makes sense here. This is best suited for htmlToText method.

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update this as well

newReportAction.message[0].text = Str.stripHTML(htmlForNewComment.replace(/((<br[^>]*>)+)/gi, ' '));
.

@mollfpr mollfpr requested a review from parasharrajat June 9, 2022 13:26
Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

cc: @Luke9389

🎀 👀 🎀 C+ reviewed

@parasharrajat
Copy link
Member

@mollfpr Improve the QA steps.

@Luke9389 Luke9389 self-assigned this Jun 9, 2022
@Luke9389 Luke9389 assigned mollfpr and unassigned Luke9389 Jun 9, 2022
@Luke9389 Luke9389 merged commit 28a1254 into Expensify:main Jun 9, 2022
@OSBotify
Copy link
Contributor

OSBotify commented Jun 9, 2022

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@mollfpr mollfpr deleted the fix-8134 branch June 9, 2022 14:59
@OSBotify
Copy link
Contributor

OSBotify commented Jun 9, 2022

🚀 Deployed to staging by @Luke9389 in version: 1.1.75-0 🚀

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

: lodashGet(reportAction, ['message', 0, 'html'], '');

const parser = new ExpensiMark();
const messageText = parser.htmlToText(messageHtml);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Luke9389 thoughts on what changes we need to make now on the API side? I am removing this entire function in #9350... 🙃

@OSBotify
Copy link
Contributor

OSBotify commented Jun 9, 2022

🚀 Deployed to production by @roryabraham in version: 1.1.75-1 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants