Exclude empty chats (with no ADDCOMMENT actions or message drafts) from LNH

[PauloGasparSv]

Details

Updating the LNH logic so it doesn't show empty chats! We consider a chat empty if it's not active and has no drafts or messages (ADDCOMMENT actions).
This change must not influence how Threads, IOUS, Tasks and other features of the App work.

Fixed Issues

$ #14523
PROPOSAL: N/A

Tests

Empty chat shouldn't stay in LNH

1. Sign into newDot
2. Start a new chat with an account.
3. Make sure the new chat opens and is shown in the LNH
4. [WEB ONLY]: Copy the chat's reportID (last number in the chat's URL)
5. Open another existing chat (like concierge), make sure the chat disappears from the LNH
6. Start a chat again with that same account, make sure the account shows up in the Options list since you already had a chat with it before
7. Make sure the chat opens and has the same reportID (has the same URL)

Chat should stay in LNH if it has a Draft

1. In the same chat of used in the previous test, type some text into the composer but do not send the message
2. Open another existing chat (like concierge), make sure the chat stays in the LNH and shows the draft icon

Not-Empty chat should stay in LNH

1. Send a message in the same chat from the previous test.
2. Open another existing chat (like concierge), make sure the chat stays in the LNH.

Deleting messages and leaving chat empty should remove it from LNH

1. Open a chat that has a message sent inside it
2. Delete that message so the chat becomes empty
3. Open another existing chat (like concierge), make sure the chat disappears from the LNH.

Same tests w/ Group Chat

1. Start a new group chat with two accounts "B" and "C"
2. Make sure the new chat opens and is shown in the LNH
3. [WEB ONLY]: Copy the chat's reportID (last number in the chat's URL)
4. Open another existing chat (like concierge), make sure the chat disappears from the LNH
5. Start a group chat again with account B and C
6. Make sure the chat opens and has the same reportID (has the same URL)

Money request should stay in LNH

1. Start a new empty chat as userA with existing account userB
2. Sign in as userB and send a message back to userA so you become known
3. As userA, send new Money Request to userB inside the chat
4. As userB, delete the message sent in step 2 so the chat becomes empty
5. As userA, Open another existing chat (like concierge), make sure the reports don't disappear from the LNH
6. Make sure both the Money Request and the original report stay in the LNH

Workspace Chats should stay in LNH

1. Create a new Workspace in an account
2. Make sure the #admins, #announce and a workspace chats are created
3. Open another existing chat (like concierge), make sure none of the workspace related chats disappear from the LNH
4. Invite another user to the workspace, make sure another workspace chat is created for the invited user
5. Open another existing chat (like concierge), make sure none of the workspace related chats disappear from the LNH

TODO: add steps for these

• Verify that no errors appear in the JS console

Offline tests

1. Sign into newDot
2. Turn connectivity off
3. Start a new chat with an account.
4. Make sure the new chat opens and is shown in the LNH
5. [WEB ONLY]: Copy that chat's reportID (last number in the chat's URL)
6. Open another existing chat (like concierge), make sure the chat disappears from the LNH
7. Start a chat again with that same account, make sure the account shows up in the Options list since you already had a chat with it before
8. [WEB ONLY]: That chat's reportID will not be the same as the first attempt because we are offline, but make note of that reportID as well
9. Open another existing chat (like concierge), make sure the chat disappears from the LNH
10. [WEB ONLY]: Toggle connectivity back on
11. [WEB ONLY]: Start a chat again with that same account
12. [WEB ONLY]: Make sure that chat's reportID is the same as the from step 5 (and not step 8)

Make sure the chat opens and has the same reportID (has the same URL)

QA Steps

Same as Tests

• 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
  • 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 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

web-up-to-group-chat.mov

web-2.mov

Mobile Web - Chrome

android-web-1.mov

Screen.Recording.2023-08-09.at.20.35.46.mov

Mobile Web - Safari

ios.Web.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

[PauloGasparSv]

Having some trouble fixing the Travis errors in SideBarOrderTest and SideBarFilterTest, getting back to this tomorrow. There are some tests that create empty chats expecting them to be at LNH but I don't understand where these chat reports are being created or converted. (e.g. the includes or excludes policy expense chats depending on the beta test seems to create 1 policy expense chat but after the beta is added it becomes a chat report)

I also think I'll have to change the condition to include a chatType check but I'm not 100% sure if I should check for an empty one or maybe add !isUserCreatedPolicyRoom(report) && ! isDefaultRoom(report) there.

[PauloGasparSv]

I think I fixed all tests!

Since the SidebarOrderTest tests deal with ordering and checking the created/updated time of actions, instead of creating a comment inside the test so the reports stick to the LNH I mocked the lastMessageHTML field on the reports. This way I don't influence the last action time or anything related to those tests

[PauloGasparSv]

I think I still have a problem to fix:

Sending a message then going to another chat really quickly makes the Chat disappear then pop back in! I think there might be some optimistic data in the chat creation that I should be setting to avoid that.

Will fix this tomorrow

[PauloGasparSv]

I think I still have a problem to fix:

Sending a message then going to another chat really quickly makes the Chat disappear then pop back in! I think there might be some optimistic data in the chat creation that I should be setting to avoid that.

Will fix this tomorrow

Trying to reproduce this reliably to fix it, this is not always happening!

I managed to reproduce this a couple of times by deleting multiple comments inside the report and then going to the concierge chat really quickly.

I think we are not clearing lastMessageText somewhere correctly and that is generating the behaviour.

Still trying to understand how force that behavior to replicate this

Screen.Recording.2023-06-06.at.16.10.29.mov

[PauloGasparSv]

I'm having trouble with the Android emulator so I'll add it's evidence tomorrow morning

[luacmartins]

LGTM

[luacmartins]

@thesahindia bump for review!

[thesahindia]

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

Screen.Recording.2023-08-12.at.1.49.00.PM.mov

Screen.Recording.2023-08-12.at.1.44.33.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-08-12.at.2.33.23.PM.mov

Mobile Web - Safari

Screen.Recording.2023-08-12.at.2.36.08.PM.mov

Desktop

Screen.Recording.2023-08-12.at.3.26.07.PM.mov

iOS

Screen.Recording.2023-08-12.at.3.07.23.PM.mov

Android

Screen.Recording.2023-08-12.at.2.18.48.PM.mov

[thesahindia]

Tested well!

P.S. Sorry for the delay. I am having internet issues.

[melvin-bot]

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

[luacmartins]

Not sure why Joel got assigned since we already had an internal engineer assigned. Merging.

[joh42]

Running into a failing unit test on main, seems to be from this PR:

@luacmartins @PauloGasparSv

[Beamanator]

Probably copy / pasta error? Should be "The report is rendered in the LHN"

[PauloGasparSv]

Oh yes, thks for catching that!

I'll create a P.R. to fix that unit test that is failing + fix that comment.

[PauloGasparSv]

Running into a failing unit test on main, seems to be from this PR:

Thks for tagging me and reporting here, taking a look at that test right now : )

I see the other issues that tagged this are also mentioning that failed Task.

[OSBotify]

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.54-0 🚀

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

[OSBotify]

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.54-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.54-13 🚀

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

[namhihi237]

@PauloGasparSv @Beamanator In that case :
Not-Empty chat should stay in LNH:

1. Open new report
2. Chat any message
3. Go to the thread and send a message
4. Delete the parent message
   => In a parent report we have a [Deleted message] with a threaded chat. So in that case do we show on LHN?

[github-actions]

CLA Assistant Lite bot:
Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.

---

I have read the CLA Document and I hereby sign the CLA

---

Paulo Vale seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You can retrigger this bot by commenting recheck in this Pull Request}