Add room name to the top of searched chats #50135

zfurtak · 2024-10-03T08:47:59Z

Details

Fixed Issues

$ #48897
PROPOSAL:

Tests

Go to Reports tab
Choose Chats
Try different filters
Verify if shown result have chat name in the corner In ....

Verify that no errors appear in the JS console

Offline tests

As above

QA Steps

As above

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

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

Kicu

Left you some comments with small code tweaks

Kicu · 2024-10-03T13:11:38Z

src/libs/ReportUtils.ts

+    draftReports?: OnyxCollection<Report>,
+    reportNameValuePairs?: OnyxCollection<ReportNameValuePairs>,
+    policyTagLists?: OnyxCollection<PolicyTagLists>,
+    policies?: OnyxCollection<Policy>,


@luacmartins What do you think about this? that kinda messy :/ Frankly I'm surprised that we need some many arguments to generate the name.
I'm Afraid we are making the code very complex, perhaps it's a good moment to take a step back and redesign this a bit?

If we have to compute the reportName in the frontend codebase, then maybe temporary could somehow split this function for reports and for Search?

Clearly this was written specifically for the ReportUtils with the assumption that a lot of local values will be used. We are now breaking this assumption, I wonder if we can develop the "getReportForSearch" part somehow smarter 🤔

Frankly I'm surprised that we need some many arguments to generate the name.

Me too 😄

If we have to compute the reportName in the frontend codebase, then maybe temporary could somehow split this function for reports and for Search?

I raised this in Slack with the team and didn't get much support since that'd create another fork in the logic. How exactly would you propose the split? Maybe I can bring this up again because I also agree with a separate approach since the refactor might get out of hand.

One thing that I was thinking, is that even after this refactor, there's nothing stopping others from directly connecting these methods to Onyx in the future and the whole logic breaking for Search. We should probably think of a way to enforce that once the refactor is done.

src/libs/ReportUtils.ts

luacmartins · 2024-10-18T22:53:51Z

zfurtak · 2024-10-24T19:45:36Z

The only functions that left to refactor is Parser.htmlToText I'm still figuring that out 🔍
Others are done ✅

zfurtak · 2024-10-25T10:12:43Z

Never mind! The function Parser.htmlToText doesn't need refactoring. So all functions are ready 😊

luacmartins · 2024-10-25T15:32:48Z

Nice! That's awesome. The team is still discussing if we can simplify the report names for the Search page only (especially for threads since those add a lot of extra data). I'll report back once we land on a solution.

zfurtak · 2024-11-07T17:14:39Z

@luacmartins how is the discussion going? 😊

luacmartins · 2024-11-07T17:37:52Z

There hasn't been any movement, but last I checked the decision was to:

On Search only, show the highest context report name (e.g. From David, Jason, Tom) as the report name for all types of threads

Additionally, we started returning additional data for Search > Expenses. I'm hoping to do the same and include report and policy data in the Search results for chats. This + the simplification above might solve a lot of the naming issues 🤞

luacmartins · 2024-11-07T17:39:04Z

So I think next steps here:

Could you make a list of Onyxkeys we'd need to send with Search response?
Work on a function to return the simplified thread name on Search

DylanDylann · 2025-02-04T11:15:02Z

@luacmartins What do you think the expected of this case? It seems @zfurtak is trying to simplified the report name for thread

Open the admin workspace chat
Send a message "dkjanwdkj"
Reply above message --> A new thread report is created
On the new thread report, send a message "new 123123"
Click on the search page and see that the report name of the thread chat report is the name of the workspace

Screen.Recording.2025-02-04.at.18.10.34.mov

DylanDylann · 2025-02-04T14:38:03Z

@luacmartins What do you think the expected of this case? This logic isn't updated in this PR, I just want to confirm it again

Send invoice to someone --> A new report is created
Send a message in the new report
Click on the search page and see that the report name of the new chat report is the name of the workspace

Screen.Recording.2025-02-04.at.21.36.41.mov

DylanDylann · 2025-02-04T14:41:59Z

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

Screen.Recording.2025-02-04.at.21.46.46.mov

Android: mWeb Chrome

Screen.Recording.2025-02-04.at.21.46.09.mov

iOS: Native

Screen.Recording.2025-02-04.at.21.46.26.mov

iOS: mWeb Safari

Screen.Recording.2025-02-04.at.21.45.18.mov

MacOS: Chrome / Safari

Screen.Recording.2025-02-04.at.21.42.22.mov

MacOS: Desktop

luacmartins · 2025-02-04T16:08:54Z

@DylanDylann I think we can treat those as NAB. We can address them in a follow up if we decide to.

DylanDylann

The rest looks fine

luacmartins

LGTM

luacmartins · 2025-02-04T16:56:11Z

@zfurtak it seems like the last 2 commits were not signed/verified. Could you please look into that? Otherwise, we're good to merge

melvin-bot · 2025-02-04T19:58:14Z

@luacmartins looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

luacmartins · 2025-02-04T19:59:24Z

We decided to not address ESLint errors in this PR since it was a pretty large PR and addressing the failures was not trivial

OSBotify · 2025-02-04T20:07:10Z

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

github-actions · 2025-02-06T22:00:31Z

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

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

github-actions · 2025-02-11T02:11:50Z

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.95-6 🚀

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

zfurtak added 7 commits September 17, 2024 13:48

Added policy header to chats in search

c756e74

Added report name

c0086bc

Merge branch 'main' into @zfurtak/search-chat-header

38ee190

First part of refactor

ec5d2fb

Done refactoring functions

664ee13

Style change

2c36ccc

Merge branch 'main' into @zfurtak/search-chat-header

1bac0f2

zfurtak changed the title ~~Add header In to chat search~~ Add room name to the top of searched chats Oct 3, 2024

zfurtak added 2 commits October 3, 2024 15:34

Change props passing to getReportName

0a8ef3e

Merge branch 'main' into @zfurtak/search-chat-header

7c1dae3

Kicu reviewed Oct 3, 2024

View reviewed changes

zfurtak added 3 commits October 7, 2024 09:38

Adjusted to review

47cceca

Adjusted to review

06d6e65

Merge branch 'main' into @zfurtak/search-chat-header

138b819

luacmartins self-requested a review October 18, 2024 21:35

zfurtak added 2 commits October 21, 2024 14:02

Merge main

df25e44

Fixed checks

19a209d

luacmartins mentioned this pull request Oct 21, 2024

[Due for payment 2025-02-18] [$250] [Search v2.2] Add room name to the top of chats #48897

Open

zfurtak added 3 commits October 24, 2024 20:23

Adjusted to comments

1bf9696

Merge main

0dbd2c0

Refactored getReimbursementQueuedActionMessage

c729073

Fixed ts issue

88cd372

Merge main

86bfff4

DylanDylann approved these changes Feb 4, 2025

View reviewed changes

luacmartins previously approved these changes Feb 4, 2025

View reviewed changes

Merge branch 'main' into @zfurtak/search-chat-header

a2c62e9

zfurtak dismissed luacmartins’s stale review via a2c62e9 February 4, 2025 18:33

zfurtak force-pushed the @zfurtak/search-chat-header branch from a7fc6fb to a2c62e9 Compare February 4, 2025 18:33

zfurtak and others added 3 commits February 4, 2025 18:42

Merge branch 'main' into @zfurtak/search-chat-header

f965014

Merge branch 'main' into @zfurtak/search-chat-header

924afa6

Change the commit back to what is supposed to be

1d86468

luacmartins approved these changes Feb 4, 2025

View reviewed changes

luacmartins merged commit 1e4ff8a into Expensify:main Feb 4, 2025
15 of 16 checks passed

melvin-bot bot added the Emergency label Feb 4, 2025

luacmartins removed the Emergency label Feb 4, 2025

luacmartins assigned zfurtak Feb 4, 2025

luacmartins mentioned this pull request Feb 5, 2025

[$250] Update Search page to always show search input and type tabs at the top #52317

Open

github-actions bot mentioned this pull request Feb 6, 2025

Deploy Checklist: New Expensify 2025-02-06 #56482

Closed

mvtglobally mentioned this pull request Feb 7, 2025

"IN" is not translated to Spanish in Report Filter page #56503

Closed

8 tasks

AndrewGable mentioned this pull request Feb 10, 2025

Reports - Report name is "Unavailable workspace" after workspace is deleted #56580

Open

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add room name to the top of searched chats #50135

Add room name to the top of searched chats #50135

zfurtak commented Oct 3, 2024 •

edited

Loading

Kicu left a comment

Kicu Oct 3, 2024

luacmartins Oct 21, 2024

luacmartins Oct 22, 2024

luacmartins commented Oct 18, 2024 •

edited

Loading

zfurtak commented Oct 24, 2024

zfurtak commented Oct 25, 2024

luacmartins commented Oct 25, 2024 •

edited

Loading

zfurtak commented Nov 7, 2024

luacmartins commented Nov 7, 2024

luacmartins commented Nov 7, 2024

DylanDylann commented Feb 4, 2025 •

edited

Loading

DylanDylann commented Feb 4, 2025 •

edited

Loading

DylanDylann commented Feb 4, 2025 •

edited

Loading

luacmartins commented Feb 4, 2025

DylanDylann left a comment

luacmartins left a comment

luacmartins commented Feb 4, 2025

melvin-bot bot commented Feb 4, 2025

luacmartins commented Feb 4, 2025

OSBotify commented Feb 4, 2025

github-actions bot commented Feb 6, 2025

github-actions bot commented Feb 11, 2025

Add room name to the top of searched chats #50135

Add room name to the top of searched chats #50135

Conversation

zfurtak commented Oct 3, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Kicu left a comment

Choose a reason for hiding this comment

Kicu Oct 3, 2024

Choose a reason for hiding this comment

luacmartins Oct 21, 2024

Choose a reason for hiding this comment

luacmartins Oct 22, 2024

Choose a reason for hiding this comment

luacmartins commented Oct 18, 2024 • edited Loading

zfurtak commented Oct 24, 2024

zfurtak commented Oct 25, 2024

luacmartins commented Oct 25, 2024 • edited Loading

zfurtak commented Nov 7, 2024

luacmartins commented Nov 7, 2024

luacmartins commented Nov 7, 2024

DylanDylann commented Feb 4, 2025 • edited Loading

DylanDylann commented Feb 4, 2025 • edited Loading

DylanDylann commented Feb 4, 2025 • edited Loading

Reviewer Checklist

Screenshots/Videos

luacmartins commented Feb 4, 2025

DylanDylann left a comment

Choose a reason for hiding this comment

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins commented Feb 4, 2025

melvin-bot bot commented Feb 4, 2025

luacmartins commented Feb 4, 2025

OSBotify commented Feb 4, 2025

github-actions bot commented Feb 6, 2025

github-actions bot commented Feb 11, 2025

zfurtak commented Oct 3, 2024 •

edited

Loading

luacmartins commented Oct 18, 2024 •

edited

Loading

luacmartins commented Oct 25, 2024 •

edited

Loading

DylanDylann commented Feb 4, 2025 •

edited

Loading

DylanDylann commented Feb 4, 2025 •

edited

Loading

DylanDylann commented Feb 4, 2025 •

edited

Loading