Skip to content

Add room name to the top of searched chats - #50135

Merged
luacmartins merged 50 commits into
Expensify:mainfrom
software-mansion-labs:@zfurtak/search-chat-header
Feb 4, 2025
Merged

luacmartins merged 50 commits into
Expensify:mainfrom
software-mansion-labs:@zfurtak/search-chat-header

Conversation

@zfurtak

@zfurtak zfurtak commented Oct 3, 2024

Copy link
Copy Markdown
Contributor

Details

Fixed Issues

$ #48897
PROPOSAL:

Tests

  1. Go to Reports tab
  2. Choose Chats
  3. Try different filters
  4. 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

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

@Kicu Kicu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left you some comments with small code tweaks

Comment thread src/libs/ReportUtils.ts Outdated
draftReports?: OnyxCollection<Report>,
reportNameValuePairs?: OnyxCollection<ReportNameValuePairs>,
policyTagLists?: OnyxCollection<PolicyTagLists>,
policies?: OnyxCollection<Policy>,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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 🤔

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread src/libs/ReportUtils.ts Outdated
Comment thread src/libs/ReportUtils.ts Outdated
@luacmartins
luacmartins self-requested a review October 18, 2024 21:35
@luacmartins

luacmartins commented Oct 18, 2024

Copy link
Copy Markdown
Contributor

@zfurtak great job on this PR so far. I audited the child function calls that connect directly to Onyx and it seems like we'd also need to refactor the following so that we can pass the data in instead of retrieving it directly from the "live" Onyx data:

  • getIOUForwardedMessage
  • getDisplayNameForParticipant
  • getReportNameValuePairs
  • getForReportAction
  • getCardIssuedMessage
  • getPolicyName
  • getRootParentReport
  • getReportOrDraftReport
  • getPolicyExpenseChatName
  • getLastVisibleAction
  • getMoneyRequestSpendBreakdown
  • hasNonReimbursableTransactions
  • isReportApproved
  • isMoneyRequestReport
  • isSettled
  • getInvoicesChatName
  • getReimbursementQueuedActionMessage

I'm still mapping all the different objects and keys that we'll need to send back from the API.

@zfurtak

zfurtak commented Oct 24, 2024

Copy link
Copy Markdown
Contributor Author

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

@zfurtak

zfurtak commented Oct 25, 2024

Copy link
Copy Markdown
Contributor Author

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

@luacmartins

luacmartins commented Oct 25, 2024

Copy link
Copy Markdown
Contributor

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

zfurtak commented Nov 7, 2024

Copy link
Copy Markdown
Contributor Author

@luacmartins how is the discussion going? 😊

@luacmartins

Copy link
Copy Markdown
Contributor

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

Copy link
Copy Markdown
Contributor

So I think next steps here:

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

@luacmartins

Copy link
Copy Markdown
Contributor

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

@DylanDylann DylanDylann left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rest looks fine

luacmartins
luacmartins previously approved these changes Feb 4, 2025

@luacmartins luacmartins left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@luacmartins

Copy link
Copy Markdown
Contributor

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

@luacmartins
luacmartins merged commit 1e4ff8a into Expensify:main Feb 4, 2025
@melvin-bot melvin-bot Bot added the Emergency label Feb 4, 2025
@melvin-bot

melvin-bot Bot commented Feb 4, 2025

Copy link
Copy Markdown

@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

Copy link
Copy Markdown
Contributor

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

OSBotify commented Feb 4, 2025

Copy link
Copy Markdown
Contributor

✋ 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

github-actions Bot commented Feb 6, 2025

Copy link
Copy Markdown
Contributor

🚀 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

Copy link
Copy Markdown
Contributor

🚀 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
zfurtak deleted the @zfurtak/search-chat-header branch April 4, 2025 13:08
fontSize={variables.fontSizeSmall}
onPress={() => onSelectRow(item)}
>
{reportActionItem.reportName}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You forgot to handle the invoice room name case when displaying room name, which caused #58581

Comment thread src/libs/ReportUtils.ts
return allReports?.[`${ONYXKEYS.COLLECTION.REPORT}${reportID}`];
function getReport(reportID: string, reports: SearchReport[] | OnyxCollection<Report>): OnyxEntry<Report> | SearchReport {
if (isSearchReportArray(reports)) {
reports?.find((report) => report.reportID === reportID);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zfurtak @DylanDylann this seems to be missing a return?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.