Fix object mutation causes the WS item in search shows last message instead of WS name #54351

bernhardoj · 2024-12-19T09:10:06Z

Explanation of Change

Fixed Issues

$ #53361
PROPOSAL: #53361 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Prerequisite:

have a workspace
have at least 1 other member
send a message at least once to the member workspace chat

Open the search modal
Search for the member workspace chat
Verify the subtitle shows the last message

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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.ts 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 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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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.
I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

android.mweb.mp4

iOS: Native

iOS: mWeb Safari

ios.mweb.mp4

MacOS: Chrome / Safari

MacOS: Desktop

desktop.mp4

melvin-bot · 2024-12-19T09:10:12Z

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

rojiphil · 2024-12-24T03:54:10Z

@bernhardoj Can you please resolve the conflicts here? Also, please merge with the latest main as I am running into build issues due to another offending PR that was reverted. Will take this up for review today. Thanks.

bernhardoj · 2024-12-24T04:27:21Z

@rojiphil Done

rojiphil

Thanks @bernhardoj for the PR. I also left some NAB comments. Please have a look.

Apart from that, I am not sure if the expected behaviour is to display the Workspace name all the time. When there is an available message in the report, displaying the last message text may be correct. And the workspace name can be displayed if there are no messages yet in the chat. Here is a test video comparing the staging and dev version. Let us confirm this though with the design team.
@Expensify/design What do you think?

54351-validate.mp4

rojiphil · 2024-12-25T17:19:47Z

src/libs/ReportUtils.ts

@@ -6386,7 +6386,7 @@ function isReportNotFound(report: OnyxEntry<Report>): boolean {
 /**
 * Check if the report is the parent report of the currently viewed report or at least one child report has report action
 */
-function shouldHideReport(report: OnyxEntry<Report>, currentReportId: string): boolean {
+function shouldHideReport(report: OnyxEntry<Report>, currentReportId: string | undefined): boolean {


Can we do an early return here when currentReportId is undefined?

I don't think we should do it because the logic depends on isChildReportHasComment. I would prefer to just let it go through the code since the parentReport will be undefined when currentReportID is undefined.

rojiphil · 2024-12-25T17:20:08Z

src/libs/ReportUtils.ts

@@ -1631,7 +1631,7 @@ function isPolicyExpenseChatAdmin(report: OnyxEntry<Report>, policies: OnyxColle
 /**
 * Checks if the current user is the admin of the policy.
 */
-function isPolicyAdmin(policyID: string, policies: OnyxCollection<Policy>): boolean {
+function isPolicyAdmin(policyID: string | undefined, policies: OnyxCollection<Policy>): boolean {


Also, same here. Can we do an early return here when policyID is undefined?

I don't think it's necessary to add more code (3 lines) to this. If policyID is undefined, the policy object should be undefined too and the result will be false.

shawnborton · 2024-12-26T19:17:12Z

When there is an available message in the report, displaying the last message text may be correct. And the workspace name can be displayed if there are no messages yet in the chat.

Interesting, I think this is my general understanding as well that if there is a message preview to be displayed on a chat row when searching for chats, we would display the preview message cc @Expensify/design @trjExpensify @JmillsExpensify for gut check too

trjExpensify · 2024-12-28T10:43:54Z

IIRC, we've always shown the workspace name as the second line in search for the non-submitter participants where the title of the workspace chat is the submitter's name. That's to distinguish between the DM and workspace chat more easily. *Tom Rhys Jones * *Expensify*

…

On Thu, 26 Dec 2024 at 19:17, Shawn Borton ***@***.***> wrote: When there is an available message in the report, displaying the last message text may be correct. And the workspace name can be displayed if there are no messages yet in the chat. Interesting, I think this is my general understanding as well that if there is a message preview to be displayed on a chat row when searching for chats, we would display the preview message cc @Expensify/design <https://github.com/orgs/Expensify/teams/design> @trjExpensify <https://github.com/trjExpensify> @JmillsExpensify <https://github.com/JmillsExpensify> for gut check too — Reply to this email directly, view it on GitHub <#54351 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AD3246MV3ITVXWWN6EYHGJ32HRI47AVCNFSM6AAAAABT4QOOZWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKNRTGA2DANJXHA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

dannymcclain · 2024-12-29T16:20:35Z

I'm genuinely not sure what the expected behavior is. I can see how including Workspace potentially makes the chat easier to distinguish—but do we want these search results to display just like the LHN? Because if we do, obviously in that case displaying the message preview makes more sense.

shawnborton · 2025-01-02T09:29:00Z

Yeah I'm a bit torn as well, part of me thinks we should just treat these as consistently as possible and show them as they would show up in the LHN.

trjExpensify · 2025-01-03T12:24:42Z

Hm yeah, I'm a bit wary of it given that they would look identical apart from the avatar, which is pretty subtle.

shawnborton · 2025-01-03T13:47:48Z

@rojiphil can we see a side-by-side comparison (just screenshot, no video) of showing Workspace vs showing the message preview? Thanks!

rojiphil · 2025-01-03T14:23:30Z

@rojiphil can we see a side-by-side comparison (just screenshot, no video) of showing Workspace vs showing the message preview? Thanks!

@shawnborton Here is a screenshot of the same:

shawnborton · 2025-01-03T14:25:03Z

Hmm I can't tell the difference between the two?

rojiphil · 2025-01-03T14:33:45Z

Hmm I can't tell the difference between the two?

@shawnborton I just updated the image with a rectangular boundary here. Hope this helps now.

shawnborton · 2025-01-03T15:20:15Z

Ah interesting. Hmm, I still think we should just use whatever we use in the LHN. After all, this is the chat switcher, so I think it makes sense to show the list of chats exactly as it might appear in the LHN as well.

trjExpensify · 2025-01-03T19:01:27Z

I don't really understand what was circled in the above screenshot to illustrate the point, haha. The comparison I think we should be looking at is two results for:

A DM from Alice Cooper
A workspace chat for Alice Cooper

How do you know which one is which when they both look like this in the results:

Alice Cooper
this is the last message

rojiphil · 2025-01-06T15:34:51Z

The comparison I think we should be looking at is two results for:

A DM from Alice Cooper

A workspace chat for Alice Cooper

How do you know which one is which when they both look like this in the results:

Alice Cooper
this is the last message

Alice Cooper
this is the last message

Hmm... That's an interesting point, but we also have the same problem in LHN although the icons differentiate the chats. Maybe we can add the workspace name within brackets along with Alice Cooper to solve this. Something like how we do for user space chat as shown below. Does this make sense?

shawnborton · 2025-01-06T19:13:22Z

We could do something like that as a follow up, but again, for now I think I would go for consistency and just reuse whatever we have in the LHN for what we display in the chat finder.

bernhardoj · 2025-01-07T06:35:05Z

Updated

rojiphil · 2025-01-08T06:02:44Z

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 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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.ts 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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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

MacOS: Chrome / Safari

54351-web-safari-001.mp4

MacOS: Desktop

54351-desktop-001.mp4

Android: Native

54351-android-native-001.mp4

Android: mWeb Chrome

54351-mweb-chrome-001.mp4

iOS: Native

54351-ios-native-001.mp4

iOS: mWeb Safari

54351-mweb-safari-001.mp4

rojiphil

Thanks @bernhardoj for the update. Please also update the test steps to reflect the recent change.

@Beamanator The changes LGTM and works well too.
All yours for review.

Beamanator

LGTM! Love the cleanup along the way, thanks!

Beamanator · 2025-01-08T06:49:50Z

src/libs/OptionsListUtils.ts

        lastMessageTextFromReport = Localize.translateLocal('parentReportAction.hiddenMessage');
-    } else if (ReportUtils.isReportMessageAttachment({text: report?.lastMessageText ?? '-1', html: report?.lastMessageHtml, type: ''})) {


lol lastMessageText ?? -1 🤦

bernhardoj · 2025-01-08T09:30:05Z

@rojiphil updated

github-actions · 2025-01-10T03:57:25Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 9.0.83-0 🚀

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

github-actions · 2025-01-11T03:25:11Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.83-5 🚀

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

github-actions · 2025-01-13T13:58:32Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.83-5 🚀

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

don't mutate the report object

fa4c4b3

bernhardoj requested a review from a team as a code owner December 19, 2024 09:10

melvin-bot bot requested review from rojiphil and removed request for a team December 19, 2024 09:10

lint

07752f2

Merge branch 'main' into fix/53361-ws-last-msg-shows-in-search

3786b92

rojiphil reviewed Dec 25, 2024

View reviewed changes

bernhardoj added 2 commits January 7, 2025 14:32

Merge branch 'main' into fix/53361-ws-last-msg-shows-in-search

3cf8c71

don't force policy name preview

b9905de

rojiphil approved these changes Jan 8, 2025

View reviewed changes

melvin-bot bot requested a review from Beamanator January 8, 2025 06:06

Beamanator approved these changes Jan 8, 2025

View reviewed changes

Beamanator merged commit 51d7736 into Expensify:main Jan 8, 2025
18 checks passed

This was referenced Jan 8, 2025

[HOLD for payment 2025-01-18] Investigate workflow job failing on main: typecheck / typecheck #54933

Closed

[HOLD for payment 2025-01-18] Investigate workflow job failing on main: confirmPassingBuild #54934

Closed

Beamanator mentioned this pull request Jan 8, 2025

Allow currentReportId to be undefined #54936

Merged

50 tasks

github-actions bot mentioned this pull request Jan 10, 2025

Deploy Checklist: New Expensify 2025-01-10 #55051

Closed

54 tasks

melvin-bot bot mentioned this pull request Jan 11, 2025

[HOLD for payment 2025-01-18] [$250] Search - Workspace chat preview, flickers between last message and information message #53361

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix object mutation causes the WS item in search shows last message instead of WS name #54351

Fix object mutation causes the WS item in search shows last message instead of WS name #54351

bernhardoj commented Dec 19, 2024 •

edited

Loading

melvin-bot bot commented Dec 19, 2024

rojiphil commented Dec 24, 2024

bernhardoj commented Dec 24, 2024

rojiphil left a comment

rojiphil Dec 25, 2024

bernhardoj Dec 26, 2024

rojiphil Dec 25, 2024

bernhardoj Dec 26, 2024

shawnborton commented Dec 26, 2024

trjExpensify commented Dec 28, 2024 via email

dannymcclain commented Dec 29, 2024

shawnborton commented Jan 2, 2025

trjExpensify commented Jan 3, 2025

shawnborton commented Jan 3, 2025

rojiphil commented Jan 3, 2025 •

edited

Loading

shawnborton commented Jan 3, 2025

rojiphil commented Jan 3, 2025

shawnborton commented Jan 3, 2025

trjExpensify commented Jan 3, 2025

rojiphil commented Jan 6, 2025 •

edited

Loading

shawnborton commented Jan 6, 2025

bernhardoj commented Jan 7, 2025

rojiphil commented Jan 8, 2025

rojiphil left a comment

Beamanator left a comment

Beamanator Jan 8, 2025

bernhardoj commented Jan 8, 2025

github-actions bot commented Jan 10, 2025

github-actions bot commented Jan 11, 2025

github-actions bot commented Jan 13, 2025

		lastMessageTextFromReport = Localize.translateLocal('parentReportAction.hiddenMessage');
		} else if (ReportUtils.isReportMessageAttachment({text: report?.lastMessageText ?? '-1', html: report?.lastMessageHtml, type: ''})) {

Fix object mutation causes the WS item in search shows last message instead of WS name #54351

Fix object mutation causes the WS item in search shows last message instead of WS name #54351

Conversation

bernhardoj commented Dec 19, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 19, 2024

rojiphil commented Dec 24, 2024

bernhardoj commented Dec 24, 2024

rojiphil left a comment

Choose a reason for hiding this comment

rojiphil Dec 25, 2024

Choose a reason for hiding this comment

bernhardoj Dec 26, 2024

Choose a reason for hiding this comment

rojiphil Dec 25, 2024

Choose a reason for hiding this comment

bernhardoj Dec 26, 2024

Choose a reason for hiding this comment

shawnborton commented Dec 26, 2024

trjExpensify commented Dec 28, 2024 via email

dannymcclain commented Dec 29, 2024

shawnborton commented Jan 2, 2025

trjExpensify commented Jan 3, 2025

shawnborton commented Jan 3, 2025

rojiphil commented Jan 3, 2025 • edited Loading

shawnborton commented Jan 3, 2025

rojiphil commented Jan 3, 2025

shawnborton commented Jan 3, 2025

trjExpensify commented Jan 3, 2025

rojiphil commented Jan 6, 2025 • edited Loading

shawnborton commented Jan 6, 2025

bernhardoj commented Jan 7, 2025

rojiphil commented Jan 8, 2025

Reviewer Checklist

Screenshots/Videos

rojiphil left a comment

Choose a reason for hiding this comment

Beamanator left a comment

Choose a reason for hiding this comment

Beamanator Jan 8, 2025

Choose a reason for hiding this comment

bernhardoj commented Jan 8, 2025

github-actions bot commented Jan 10, 2025

github-actions bot commented Jan 11, 2025

github-actions bot commented Jan 13, 2025

bernhardoj commented Dec 19, 2024 •

edited

Loading

rojiphil commented Jan 3, 2025 •

edited

Loading

rojiphil commented Jan 6, 2025 •

edited

Loading