fix: 15131 html decode in lhn and iou #16957

tienifr · 2023-04-05T09:32:06Z

Details

Fixed Issues

$ #16819
$ #15131
PROPOSAL: #15131 (comment)

Tests

LHN should show the last message

Go to chat
Enter &nbsp
Verify LHN should show &nbsp
Enter *abc*
Verify LHN should show *abc*

IOU cancelling message shouldn't display escaped html characters

Go to chat
Request money with IOU message contains HTML characters, like Tokyo <> Mexico
Click sent IOU message to open IOU details page
Click cancel money request
Verify IOU cancelling message should display Tokyo <> Mexico

iou message should not be flicker when user goes offline then online again

Go to chat
Go offline
Request money
Enter amount and click Next
Type What's it for message: test abc &nbsp
Click request button
Verify the message in report should be test abc &nbsp
Go online
Verify the message in report should be test abc &nbsp and shouldn't be flicker

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

LHN should show the last message

Go to chat
Enter &nbsp
Verify LHN should show &nbsp
Enter *abc*
Verify LHN should show *abc*

IOU cancelling message shouldn't display escaped html characters

Go to chat
Request money with IOU message contains HTML characters, like Tokyo <> Mexico
Click sent IOU message to open IOU details page
Click cancel money request
Verify IOU cancelling message should display Tokyo <> Mexico

iou message should not be flicker when user goes offline then online again

Go to chat
Go offline
Request money
Enter amount and click Next
Type What's it for message: test abc &nbsp
Click request button
Verify the message in report should be test abc &nbsp
Go online
Verify the message in report should be test abc &nbsp and shouldn't be flicker

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-04-05.at.16.17.41.mov

iou message should not be flicker when user goes offline then online again:

Screen.Recording.2023-04-11.at.15.08.28.mp4

Mobile Web - Chrome

https://user-images.githubusercontent.com/113963320/230040355-67afaad4-be36-4b74-b855-caaae53d910c.mp4
iou message should not be flicker when user goes offline then online again:

RPReplay_Final1681200919.mp4

Mobile Web - Safari

RPReplay_Final1680686249.mp4

iou message should not be flicker when user goes offline then online again:

RPReplay_Final1681200766.mp4

Desktop

https://user-images.githubusercontent.com/113963320/230041357-a7ceb2a9-aa3c-4b43-9c20-6c06a71d98da.mp4
iou message should not be flicker when user goes offline then online again:

Screen.Recording.2023-04-11.at.15.25.40.mp4

iOS

Screen-Recording-2023-04-11-at-16.55.21.mp4

iou message should not be flicker when user goes offline then online again:

Screen-Recording-2023-04-11-at-16.57.51.mp4

Android

Untitled5.mp4

Untitled6.mp4

MelvinBot · 2023-04-05T09:35:09Z

@MariaHCD @rushatgabhane One of you needs to 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

Changes look good. But let's make sure it works in all test conditions.

Screenshots/Videos

Web

Screen.Recording.2023-04-05.at.17.47.13.mov

Desktop

sobitneupane · 2023-04-06T06:36:37Z

@tienifr
Found a bug.

Being offline, If you request money first and the cancel money, html entities (like &nbsp, &#38) in comment will de decoded.

rushatgabhane · 2023-04-06T19:42:05Z

@sobitneupane all yours to review :)

tienifr · 2023-04-07T10:51:26Z

@sobitneupane After investigating I see the problem in

App/src/libs/actions/IOU.js

Line 556 in 64f4a78

moneyRequestAction.originalMessage.comment,

If user is offline, the originalMessage will be &nbsp

but after go online, it's updated to &nbsp

That makes the inconsistency between online and offline mode.

Solution: We can update function buildOptimisticIOUReportAction by changing the originalMessage:

   const parser = new ExpensiMark();
   const commentText = getParsedComment(comment);
   const textForNewComment = parser.htmlToText(commentText)
   const textFotNewCommentDecode = Str.htmlDecode(textForNewComment)
   const originalMessage = {
       amount,
       comment:textForNewComment,
       currency,
       IOUTransactionID,
       IOUReportID,
       type,
   };

...
       message: getIOUReportActionMessage(type, amount, participants, textFotNewCommentDecode, currency, paymentType, isSettlingUp),

But I don't think it's a good idea, we should preserve the comment as its name originalMessage.
Please tell me what your thought. Thanks

sobitneupane · 2023-04-07T11:16:15Z

@tienifr I think we should change the frontend to match the backend if it won't cause any regression.

tienifr · 2023-04-10T08:09:36Z

@sobitneupane I updated my PR to fix this issue: #16957 (comment)
Here is the result:

Screen.Recording.2023-04-10.at.15.03.45.mp4

sobitneupane · 2023-04-10T16:16:35Z

Thanks for the update @tienifr. Can you please update the screenshots. Also, Offline Test Steps are missing in PR body

tienifr · 2023-04-11T14:13:57Z

@sobitneupane I've added the screenshots, and PR body. Please help take a look. Thanks

sobitneupane

Screenshots/Videos

Web

Screen.Recording.2023-04-12.at.13.37.11.mov

Mobile Web - Chrome

Screen.Recording.2023-04-12.at.14.02.54.mov

Mobile Web - Safari

Screen.Recording.2023-04-12.at.13.51.15.mov

Desktop

Untitled.mov

iOS

Screen.Recording.2023-04-12.at.13.57.03.mov

Android

Screen.Recording.2023-04-12.at.13.59.24.mov

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 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 correct English and 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 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 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.

sobitneupane · 2023-04-12T08:25:37Z

Changes look good and test well

cc: @pecanoro

pecanoro

@tienifr So the PR works well, but I am wondering why we decided to do all this dance with htmlDecode and we are not repeating what we do with requestMoney for example?

App/src/libs/actions/IOU.js

Lines 55 to 89 in 604c759

    
           function requestMoney(report, amount, currency, recipientEmail, participant, comment) { 
        
               const debtorEmail = OptionsListUtils.addSMSDomainIfPhoneNumber(participant.login); 
        
               let chatReport = lodashGet(report, 'reportID', null) ? report : null; 
        
               let isNewChat = false; 
        
               if (!chatReport) { 
        
                   chatReport = ReportUtils.getChatByParticipants([debtorEmail]); 
        
               } 
        
               if (!chatReport) { 
        
                   chatReport = ReportUtils.buildOptimisticChatReport([debtorEmail]); 
        
                   isNewChat = true; 
        
               } 
        
               let iouReport; 
        
               if (chatReport.iouReportID) { 
        
                   iouReport = IOUUtils.updateIOUOwnerAndTotal( 
        
                       iouReports[`${ONYXKEYS.COLLECTION.REPORT}${chatReport.iouReportID}`], 
        
                       recipientEmail, 
        
                       amount, 
        
                       currency, 
        
                   ); 
        
               } else { 
        
                   iouReport = ReportUtils.buildOptimisticIOUReport(recipientEmail, debtorEmail, amount, chatReport.reportID, currency, preferredLocale); 
        
               } 
        
               // Note: The created action must be optimistically generated before the IOU action so there's no chance that the created action appears after the IOU action in the chat 
        
               const optimisticCreatedAction = ReportUtils.buildOptimisticCreatedReportAction(recipientEmail); 
        
               const optimisticReportAction = ReportUtils.buildOptimisticIOUReportAction( 
        
                   CONST.IOU.REPORT_ACTION_TYPE.CREATE, 
        
                   amount, 
        
                   currency, 
        
                   comment, 
        
                   [participant], 
        
                   '', 
        
                   '', 
        
                   iouReport.reportID, 
        
               );

tienifr · 2023-04-13T02:49:46Z

@pecanoro With requestMoney we're passing the comment state instead of originalMessage:

App/src/pages/iou/MoneyRequestModal.js

Lines 312 to 319 in 42bea4b

    
           IOU.requestMoney( 
        
               props.report, 
        
               Math.round(amount * 100), 
        
               props.iou.selectedCurrencyCode, 
        
               props.currentUserPersonalDetails.login, 
        
               selectedParticipants[0], 
        
               trimmedComment, 
        
           );

The originalMessage is encoded but not comment state. That why we don't need to decode the comment in this case

pecanoro · 2023-04-13T21:35:26Z

@tienifr Gotcha, thank you for the explanation! Hopefully we solve everything with this and we can forget about it hehe

OSBotify · 2023-04-13T21:41:33Z

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

jayeshmangwani · 2023-04-14T05:45:19Z

src/libs/SidebarUtils.js

@@ -247,7 +247,7 @@ function getOptionData(reportID) {
    if (ReportUtils.isReportMessageAttachment({text: report.lastMessageText, html: report.lastMessageHtml})) {
        lastMessageTextFromReport = `[${Localize.translateLocal('common.attachment')}]`;
    } else {
-        lastMessageTextFromReport = Str.htmlDecode(report ? report.lastMessageText : '');
+        lastMessageTextFromReport = _.get(report, 'lastMessageText', '');


This line causes a crash on iOS, when we get lastMessageText: null then it is causing the crash

cc: @tienifr @sobitneupane @pecanoro @MariaHCD

@tienifr Let's get this sorted asap.

@sobitneupane if you are free now, please raise a PR as this makes app unusable

@tienifr might be in a different timezone so

Thanks for catching this, @jayeshmangwani! Is anyone currently working on a fix? 👀

Created PR #17449

@sobitneupane Thanks for your quick PR. I'm really sorry for this delay. Do you need any help?

@tienifr If you are available, can you please review the PR

OSBotify · 2023-04-18T06:10:00Z

🚀 Deployed to staging by https://github.com/pecanoro in version: 1.3.1-0 🚀

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

OSBotify · 2023-04-19T17:23:09Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.1-3 🚀

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

fix: 15131 html decode in lhn and iou

7abf10c

tienifr marked this pull request as ready for review April 5, 2023 09:35

tienifr requested a review from a team as a code owner April 5, 2023 09:35

melvin-bot bot requested review from MariaHCD and rushatgabhane and removed request for a team April 5, 2023 09:35

tienifr mentioned this pull request Apr 5, 2023

[HOLD for payment 2023-04-26] [HOLD for payment 2023-04-21] [$1000] Special html characters like &nbsp are not escaped in name and can bug out the UI #15131

Closed

2 tasks

fix: use lodash get

4cec1ae

sobitneupane reviewed Apr 5, 2023

View reviewed changes

fix: decode optimistic iou report comment

604c759

tienifr mentioned this pull request Apr 11, 2023

The message written within multiple * in 'What's its for field' seems to delete the first * wrapped outside the message #17213

Closed

6 tasks

sobitneupane reviewed Apr 12, 2023

View reviewed changes

sobitneupane approved these changes Apr 12, 2023

View reviewed changes

MariaHCD removed the request for review from rushatgabhane April 12, 2023 12:37

MariaHCD approved these changes Apr 12, 2023

View reviewed changes

MariaHCD requested a review from pecanoro April 12, 2023 13:10

pecanoro reviewed Apr 12, 2023

View reviewed changes

pecanoro approved these changes Apr 13, 2023

View reviewed changes

pecanoro merged commit 1f53560 into Expensify:main Apr 13, 2023

jayeshmangwani reviewed Apr 14, 2023

View reviewed changes

sobitneupane mentioned this pull request Apr 14, 2023

Fix null issue in lastMessageText #17449

Merged

56 tasks

OSBotify mentioned this pull request Apr 17, 2023

Deploy Checklist: New Expensify 2023-04-17 #17546

Closed

53 tasks

MariaHCD mentioned this pull request Apr 18, 2023

[HOLD for payment 2023-04-26] [HOLD for payment 04-25-2023] Escaped html characters appear for a brief moment when cancelling request money #16819

Closed

6 tasks

kbecciv mentioned this pull request Apr 18, 2023

IOU - Invalid characters error message for "<>" brackets in IOU description #17577

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: 15131 html decode in lhn and iou #16957

fix: 15131 html decode in lhn and iou #16957

tienifr commented Apr 5, 2023 •

edited

Loading

MelvinBot commented Apr 5, 2023

sobitneupane left a comment •

edited

Loading

sobitneupane commented Apr 6, 2023 •

edited

Loading

rushatgabhane commented Apr 6, 2023

tienifr commented Apr 7, 2023 •

edited

Loading

sobitneupane commented Apr 7, 2023

tienifr commented Apr 10, 2023

sobitneupane commented Apr 10, 2023 •

edited

Loading

tienifr commented Apr 11, 2023

sobitneupane left a comment

sobitneupane left a comment

sobitneupane commented Apr 12, 2023

pecanoro left a comment

tienifr commented Apr 13, 2023 •

edited

Loading

pecanoro commented Apr 13, 2023

OSBotify commented Apr 13, 2023

jayeshmangwani Apr 14, 2023

sobitneupane Apr 14, 2023

rushatgabhane Apr 14, 2023 •

edited

Loading

MariaHCD Apr 14, 2023

sobitneupane Apr 14, 2023

tienifr Apr 14, 2023

sobitneupane Apr 14, 2023

tienifr Apr 14, 2023

OSBotify commented Apr 18, 2023

OSBotify commented Apr 19, 2023

	function requestMoney(report, amount, currency, recipientEmail, participant, comment) {
	const debtorEmail = OptionsListUtils.addSMSDomainIfPhoneNumber(participant.login);
	let chatReport = lodashGet(report, 'reportID', null) ? report : null;
	let isNewChat = false;
	if (!chatReport) {
	chatReport = ReportUtils.getChatByParticipants([debtorEmail]);
	}
	if (!chatReport) {
	chatReport = ReportUtils.buildOptimisticChatReport([debtorEmail]);
	isNewChat = true;
	}
	let iouReport;
	if (chatReport.iouReportID) {
	iouReport = IOUUtils.updateIOUOwnerAndTotal(
	iouReports[`${ONYXKEYS.COLLECTION.REPORT}${chatReport.iouReportID}`],
	recipientEmail,
	amount,
	currency,
	);
	} else {
	iouReport = ReportUtils.buildOptimisticIOUReport(recipientEmail, debtorEmail, amount, chatReport.reportID, currency, preferredLocale);
	}

	// Note: The created action must be optimistically generated before the IOU action so there's no chance that the created action appears after the IOU action in the chat
	const optimisticCreatedAction = ReportUtils.buildOptimisticCreatedReportAction(recipientEmail);
	const optimisticReportAction = ReportUtils.buildOptimisticIOUReportAction(
	CONST.IOU.REPORT_ACTION_TYPE.CREATE,
	amount,
	currency,
	comment,
	[participant],
	'',
	'',
	iouReport.reportID,
	);

fix: 15131 html decode in lhn and iou #16957

fix: 15131 html decode in lhn and iou #16957

Conversation

tienifr commented Apr 5, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Apr 5, 2023

sobitneupane left a comment • edited Loading

Choose a reason for hiding this comment

Screenshots/Videos

sobitneupane commented Apr 6, 2023 • edited Loading

rushatgabhane commented Apr 6, 2023

tienifr commented Apr 7, 2023 • edited Loading

sobitneupane commented Apr 7, 2023

tienifr commented Apr 10, 2023

sobitneupane commented Apr 10, 2023 • edited Loading

tienifr commented Apr 11, 2023

sobitneupane left a comment

Choose a reason for hiding this comment

Screenshots/Videos

sobitneupane left a comment

Choose a reason for hiding this comment

Reviewer Checklist

sobitneupane commented Apr 12, 2023

pecanoro left a comment

Choose a reason for hiding this comment

tienifr commented Apr 13, 2023 • edited Loading

pecanoro commented Apr 13, 2023

OSBotify commented Apr 13, 2023

jayeshmangwani Apr 14, 2023

Choose a reason for hiding this comment

sobitneupane Apr 14, 2023

Choose a reason for hiding this comment

rushatgabhane Apr 14, 2023 • edited Loading

Choose a reason for hiding this comment

MariaHCD Apr 14, 2023

Choose a reason for hiding this comment

sobitneupane Apr 14, 2023

Choose a reason for hiding this comment

tienifr Apr 14, 2023

Choose a reason for hiding this comment

sobitneupane Apr 14, 2023

Choose a reason for hiding this comment

tienifr Apr 14, 2023

Choose a reason for hiding this comment

OSBotify commented Apr 18, 2023

OSBotify commented Apr 19, 2023

tienifr commented Apr 5, 2023 •

edited

Loading

sobitneupane left a comment •

edited

Loading

sobitneupane commented Apr 6, 2023 •

edited

Loading

tienifr commented Apr 7, 2023 •

edited

Loading

sobitneupane commented Apr 10, 2023 •

edited

Loading

tienifr commented Apr 13, 2023 •

edited

Loading

rushatgabhane Apr 14, 2023 •

edited

Loading