Fix: do not display new line when creating request money. #32177

teneeto · 2023-11-29T12:19:19Z

Details

This PR seeks to fix the inconsistency between how the new line marker (green line) is displayed when a user requests money and when a user splits a bill.

When a user Splits a bill, the new line marker isn't displayed to the current user. It's different when a user requests money, the green line is displayed. The solution was to mute the green line when a viewing user requests money.

Also updates hook dependency #32177 (comment)

Fixed Issues

$: 29376
PROPOSAL: 16170

Tests

Clear the green marker on the chats

As a user A active on a chat with B, send messages from B to A and ensure no green line is displayed and message are marked as read
As a user A, move to another chat than B and send messages from B to A and ensure chat is marked as bold in LHN and when visiting the chat, new marker line is displayed.
Clear the unread marker
As a user A, request money from user B and ensure no green line is displayed on user A's side
As a user A, move to another chat and request money from user B to A. Ensure chat is marked as bold in LHN and when visiting the chat, new marker line is displayed above IOU preview
Click on IOU preview and ensure new line is displayed above new IOU request.
Clear the unread marker
As a user A, mark messages as unread and ensure they work as expected.
As a user A, mark message as unread, delete it and ensure they work as expected

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

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 the expected offline behavior in the Offline steps 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- 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 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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 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
I verified that if a function's arguments changed that all usages have also been updated correctly
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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  - 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

https://drive.google.com/file/d/1ACkFZPw-IdlnNmXtVh-O22g4MmKLQJH4/view?usp=sharing

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

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

Android

src/pages/home/report/ReportActionsList.js

melvin-bot · 2023-11-29T13:38:18Z

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

MonilBhavsar · 2023-11-29T14:45:43Z

Assigning @Santhosh-Sellavel as C+ in the linked issue

src/pages/home/report/ReportActionsList.js

MonilBhavsar · 2023-11-29T14:55:49Z

IMO, the logic should be

diff --git a/src/pages/home/report/ReportActionsList.js b/src/pages/home/report/ReportActionsList.js
index 6da3c1d34e..503da2e724 100644
--- a/src/pages/home/report/ReportActionsList.js
+++ b/src/pages/home/report/ReportActionsList.js
@@ -335,17 +335,14 @@ function ReportActionsList({
         (reportAction, index) => {
             let shouldDisplay = false;
             if (!currentUnreadMarker) {
-                // Check if the report type is "REPORTREVIEW" and last actor is the current user.
-                // Return shouldDisplay new marker action (terminate flow).
-                // This is to avoid displaying the new line marker when a current userrequests money.
-                if (ReportActionsUtils.isReportPreviewAction(reportAction) && reportAction.childLastActorAccountID === Report.getCurrentUserAccountID()) {
-                    return shouldDisplay;
-                }
                 const nextMessage = sortedReportActions[index + 1];
                 const isCurrentMessageUnread = isMessageUnread(reportAction, lastReadTimeRef.current);
                 shouldDisplay = isCurrentMessageUnread && (!nextMessage || !isMessageUnread(nextMessage, lastReadTimeRef.current));
                 if (!messageManuallyMarkedUnread) {
-                    shouldDisplay = shouldDisplay && reportAction.actorAccountID !== Report.getCurrentUserAccountID();
+                    // Check if the report type is "REPORTREVIEW" and last actor is the current user.
+                    // Return shouldDisplay new marker action (terminate flow).
+                    // This is to avoid displaying the new line marker when a current user requests money.
+                    shouldDisplay = shouldDisplay && ((ReportActionsUtils.isReportPreviewAction(reportAction) ? reportAction.childLastActorAccountID : reportAction.actorAccountID) !== Report.getCurrentUserAccountID());
                 }
                 if (shouldDisplay) {
                     cacheUnreadMarkers.set(report.reportID, reportAction.reportActionID);

cc @gedu

teneeto · 2023-11-30T05:51:19Z

IMO, the logic should be

diff --git a/src/pages/home/report/ReportActionsList.js b/src/pages/home/report/ReportActionsList.js
index 6da3c1d34e..503da2e724 100644
--- a/src/pages/home/report/ReportActionsList.js
+++ b/src/pages/home/report/ReportActionsList.js
@@ -335,17 +335,14 @@ function ReportActionsList({
         (reportAction, index) => {
             let shouldDisplay = false;
             if (!currentUnreadMarker) {
-                // Check if the report type is "REPORTREVIEW" and last actor is the current user.
-                // Return shouldDisplay new marker action (terminate flow).
-                // This is to avoid displaying the new line marker when a current userrequests money.
-                if (ReportActionsUtils.isReportPreviewAction(reportAction) && reportAction.childLastActorAccountID === Report.getCurrentUserAccountID()) {
-                    return shouldDisplay;
-                }
                 const nextMessage = sortedReportActions[index + 1];
                 const isCurrentMessageUnread = isMessageUnread(reportAction, lastReadTimeRef.current);
                 shouldDisplay = isCurrentMessageUnread && (!nextMessage || !isMessageUnread(nextMessage, lastReadTimeRef.current));
                 if (!messageManuallyMarkedUnread) {
-                    shouldDisplay = shouldDisplay && reportAction.actorAccountID !== Report.getCurrentUserAccountID();
+                    // Check if the report type is "REPORTREVIEW" and last actor is the current user.
+                    // Return shouldDisplay new marker action (terminate flow).
+                    // This is to avoid displaying the new line marker when a current user requests money.
+                    shouldDisplay = shouldDisplay && ((ReportActionsUtils.isReportPreviewAction(reportAction) ? reportAction.childLastActorAccountID : reportAction.actorAccountID) !== Report.getCurrentUserAccountID());
                 }
                 if (shouldDisplay) {
                     cacheUnreadMarkers.set(report.reportID, reportAction.reportActionID);

cc @gedu

Also thought about it this way. But again, I was thinking that if we weren't going to show the new line marker for a particular message, then it's better to have returned early. In all I think this approach is safer. Thanks.

MonilBhavsar · 2023-11-30T13:39:14Z

There is a logic below to cache report action data for unread markers. I believe if we return early, we won't be caching that and would eventually lead to some inconsistency.
Also, there are conflicts now, could you please merge main

…isplay-new-line-when-creating-request-money

…ing-request-money

MonilBhavsar · 2023-12-04T11:04:34Z

Had a chat with @teneeto. One of the test case is failing where we're not displaying green line above REPORTPREVIEW actions. The issue is one of the hook here -

App/src/pages/home/report/ReportActionsList.js

Line 209 in 01b27d9

}, [sortedReportActions.length, report.reportID]);

is not trigerred because for Money requests, the report actions remains same and only child report's actions are added. We'll update the hook dependency to report.lastVisibleActionCreated which is updated everytime a new action(Comment or IOU) is added/removed cc @gedu

MonilBhavsar · 2023-12-04T11:26:39Z

@Santhosh-Sellavel this is ready for a review!

gedu · 2023-12-04T13:48:22Z

Looks good

Santhosh-Sellavel · 2023-12-04T18:13:07Z

I'll get to this tomorrow.

MonilBhavsar · 2023-12-06T07:09:17Z

@Santhosh-Sellavel if you could please prioritise this today, thanks!

Santhosh-Sellavel · 2023-12-06T12:09:02Z

@teneeto

Tests Step 3 fails

As a user A, request money from user B and ensure no green line is displayed on user A's side

, the green line is still displayed after requesting money

Screen.Recording.2023-12-06.at.5.33.04.PM.mov

cc: @MonilBhavsar

MonilBhavsar · 2023-12-06T12:13:15Z

@Santhosh-Sellavel this is expected. If the green line is already there, it should persist. If it is not there, it should not show up.

Santhosh-Sellavel · 2023-12-06T12:17:08Z

Cool can we update steps please it's bit confusing.

MonilBhavsar · 2023-12-06T12:26:44Z

Updated. Let me know if it is unclear, thanks!

Santhosh-Sellavel · 2023-12-06T17:38:29Z

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 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 & iOS: Native

Screen.Recording.2023-12-06.at.10.52.03.PM.mov

Screen.Recording.2023-12-06.at.10.55.54.PM.mov

Android: mWeb Chrome & iOS: mWeb Safari

mWebs.mov

MacOS: Chrome / Safari & MacOS: Desktop

Screen.Recording.2023-12-06.at.5.33.04.PM.mov

Screen.Recording.2023-12-06.at.8.40.52.PM.mov

Santhosh-Sellavel · 2023-12-06T17:59:04Z

Step 7

As a user A, mark message as unread, delete it and ensure they work as expected

Is this working as expected? @MonilBhavsar

Screen.Recording.2023-12-06.at.11.23.32.PM.mov

DeleteCase.mov

MonilBhavsar · 2023-12-06T19:48:16Z

Yes, it is expected except marker is not sometimes going to next message and gets disappear. We are fixing that issue here #31714

Santhosh-Sellavel · 2023-12-07T01:23:22Z

Cool LGTM then, @MonilBhavsar I am AFK. Please review and merge thanks!

MonilBhavsar

Thanks!

OSBotify · 2023-12-07T07:23:34Z

✋ 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-08T01:24:08Z

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.4.10-0 🚀

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

OSBotify · 2023-12-08T02:54:01Z

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.4.10-0 🚀

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

OSBotify · 2023-12-11T10:41:18Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.10-1 🚀

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

OSBotify · 2023-12-11T15:23:13Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.10-1 🚀

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

do not display new line when creating request money

20ddda9

koko57 reviewed Nov 29, 2023

View reviewed changes

src/pages/home/report/ReportActionsList.js Outdated Show resolved Hide resolved

use isReportPreviewAction

6bac4f8

teneeto marked this pull request as ready for review November 29, 2023 13:37

teneeto requested a review from a team as a code owner November 29, 2023 13:37

melvin-bot bot requested review from amyevans and removed request for a team November 29, 2023 13:38

MonilBhavsar requested review from MonilBhavsar and Santhosh-Sellavel November 29, 2023 14:44

MonilBhavsar reviewed Nov 29, 2023

View reviewed changes

src/pages/home/report/ReportActionsList.js Outdated Show resolved Hide resolved

amyevans removed their request for review November 29, 2023 15:51

fix review comment

8d308c5

teneeto and others added 5 commits December 1, 2023 10:10

merge conflict

c189fc5

fix lint

7f23712

Merge branch 'main' of github.com:teneeto/App into fix/29376-do-not-d…

3bf9149

…isplay-new-line-when-creating-request-money

fix failing test

01b27d9

Merge branch 'main' into fix/29376-do-not-display-new-line-when-creat…

05c6b1e

…ing-request-money

Update hook dependency and property type

d82f0c8

MonilBhavsar approved these changes Dec 7, 2023

View reviewed changes

MonilBhavsar merged commit 2fd1bb8 into Expensify:main Dec 7, 2023
19 checks passed

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

Deploy Checklist: New Expensify 2023-12-08 #32704

Closed

27 tasks

stephanieelliott mentioned this pull request Dec 8, 2023

[$500] IOU - Unread marker does not appear above IOU preview when IOU is received #31621

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: do not display new line when creating request money. #32177

Fix: do not display new line when creating request money. #32177

teneeto commented Nov 29, 2023 •

edited by MonilBhavsar

Loading

melvin-bot bot commented Nov 29, 2023

MonilBhavsar commented Nov 29, 2023

MonilBhavsar commented Nov 29, 2023

teneeto commented Nov 30, 2023

MonilBhavsar commented Nov 30, 2023

MonilBhavsar commented Dec 4, 2023 •

edited

Loading

MonilBhavsar commented Dec 4, 2023

gedu commented Dec 4, 2023

Santhosh-Sellavel commented Dec 4, 2023

MonilBhavsar commented Dec 6, 2023

Santhosh-Sellavel commented Dec 6, 2023

MonilBhavsar commented Dec 6, 2023

Santhosh-Sellavel commented Dec 6, 2023

MonilBhavsar commented Dec 6, 2023

Santhosh-Sellavel commented Dec 6, 2023 •

edited

Loading

Santhosh-Sellavel commented Dec 6, 2023

MonilBhavsar commented Dec 6, 2023

Santhosh-Sellavel commented Dec 7, 2023

MonilBhavsar left a comment

OSBotify commented Dec 7, 2023

OSBotify commented Dec 8, 2023

OSBotify commented Dec 8, 2023

OSBotify commented Dec 11, 2023

OSBotify commented Dec 11, 2023

Fix: do not display new line when creating request money. #32177

Fix: do not display new line when creating request money. #32177

Conversation

teneeto commented Nov 29, 2023 • edited by MonilBhavsar Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 29, 2023

MonilBhavsar commented Nov 29, 2023

MonilBhavsar commented Nov 29, 2023

teneeto commented Nov 30, 2023

MonilBhavsar commented Nov 30, 2023

MonilBhavsar commented Dec 4, 2023 • edited Loading

MonilBhavsar commented Dec 4, 2023

gedu commented Dec 4, 2023

Santhosh-Sellavel commented Dec 4, 2023

MonilBhavsar commented Dec 6, 2023

Santhosh-Sellavel commented Dec 6, 2023

MonilBhavsar commented Dec 6, 2023

Santhosh-Sellavel commented Dec 6, 2023

MonilBhavsar commented Dec 6, 2023

Santhosh-Sellavel commented Dec 6, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

Santhosh-Sellavel commented Dec 6, 2023

MonilBhavsar commented Dec 6, 2023

Santhosh-Sellavel commented Dec 7, 2023

MonilBhavsar left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 7, 2023

OSBotify commented Dec 8, 2023

OSBotify commented Dec 8, 2023

OSBotify commented Dec 11, 2023

OSBotify commented Dec 11, 2023

teneeto commented Nov 29, 2023 •

edited by MonilBhavsar

Loading

MonilBhavsar commented Dec 4, 2023 •

edited

Loading

Santhosh-Sellavel commented Dec 6, 2023 •

edited

Loading