Skip to content

Feat: refactor getReportName and move report name related functions#75357

Merged
neil-marcellini merged 22 commits intoExpensify:mainfrom
callstack-internal:feat/waterim/getReportName-refactor
Dec 1, 2025
Merged

Feat: refactor getReportName and move report name related functions#75357
neil-marcellini merged 22 commits intoExpensify:mainfrom
callstack-internal:feat/waterim/getReportName-refactor

Conversation

@waterim
Copy link
Contributor

@waterim waterim commented Nov 17, 2025

Details

This PR refactors our report naming logic by extracting it from ReportUtils into a new dedicated module ReportNameUtils:

  • Introduces a new computeReportName helper that encapsulates the full “smart” name generation logic for reports (DMs, group chats, policy rooms, tasks, threads, invoice/money request reports, etc).
  • Adds a simpler ReportNameUtils.getReportName(report, reportAttributes) that only reads the name from derived values or report.reportName, and deprecates the old heavy getReportName in ReportUtils.
  • Moves all report‑name–related helpers from ReportUtils into ReportNameUtils and leaves deprecated wrappers.
  • Keeps the implementations of the moved helpers identical or similar to the originals.

Performance profile:
BEFORE:

[Profile] LHNOptionsList Mount: 1350.87 ms
[Profile] reportAttributes compute took 16.60ms. Updated reports: 167 (the lowest)

AFTER:

[Profile] LHNOptionsList Mount: 1399.24 ms
[Profile] reportAttributes compute took 16.50ms. Updated reports: 167 (the lowest)

Fixed Issues

$ #72613
$ #73839
PROPOSAL: N/A

Tests

  1. DM and group chat names still correct

    • On Web (Chrome/Safari), sign in and open:
      • A 1:1 DM with a user who has a display name.
        • Verify the report header shows the contact’s display name, not a combined list.
      • A 1:1 DM with a user who has no display name.
        • Verify the header falls back to the login (e.g. floki@vikings.net).
      • A group DM with > 2 participants.
        • Verify the header shows a comma‑separated list and matches the previous behavior.
  2. Policy room and policy expense chat names

    • Open a default policy room (e.g. #admins).
      • Verify the room name is #admins when active.
    • Open a policy expense chat as a member and as an admin.
      • Verify the report name still matches the old behavior.
  3. Money request / invoice names and previews

    • Open an invoice room where you are the payer.
      • Verify the invoice room name still shows the workspace / payer name correctly.
    • Open a money request thread with a report preview.
      • Verify the preview title uses the correct report name.

All of the above were tested on Web (macOS Chrome), and the changes are platform‑independent, so behavior should be the same across platforms.

  • Verify that no errors appear in the JS console

Offline tests

N/A

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

Details

@waterim waterim marked this pull request as ready for review November 17, 2025 21:47
@waterim waterim requested review from a team as code owners November 17, 2025 21:47
@melvin-bot melvin-bot bot requested review from heyjennahay and linhvovan29546 and removed request for a team and heyjennahay November 17, 2025 21:47
@melvin-bot
Copy link

melvin-bot bot commented Nov 17, 2025

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

@codecov
Copy link

codecov bot commented Nov 17, 2025

Codecov Report

❌ Looks like you've decreased code coverage for some files. Please write tests to increase, or at least maintain, the existing level of code coverage. See our documentation here for how to interpret this table.

Files with missing lines Coverage Δ
src/libs/ReportUtils.ts 75.37% <ø> (-0.19%) ⬇️
...bs/actions/OnyxDerived/configs/reportAttributes.ts 97.82% <100.00%> (ø)
src/libs/ReportNameUtils.ts 75.08% <75.08%> (ø)
... and 3 files with indirect coverage changes

@linhvovan29546

This comment was marked as resolved.

@neil-marcellini neil-marcellini mentioned this pull request Nov 18, 2025
59 tasks
@neil-marcellini neil-marcellini requested review from shubham1206agra and removed request for linhvovan29546 November 18, 2025 18:32
@neil-marcellini
Copy link
Contributor

Closing this as explained here

@neil-marcellini
Copy link
Contributor

Ok never mind - we can re-open this because @shubham1206agra pointed out that it's helping us to remove dependencies on Onyx.connect variables.

@OSBotify
Copy link
Contributor

OSBotify commented Dec 1, 2025

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.2.67-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Dec 3, 2025

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.2.70-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Dec 3, 2025

🚀 Deployed to production by https://github.com/mountiny in version: 9.2.70-0 🚀

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

}

if (isActionOfType(parentReportAction, CONST.REPORT.ACTIONS.TYPE.UNREPORTED_TRANSACTION)) {
return getUnreportedTransactionMessage();
Copy link
Contributor

Choose a reason for hiding this comment

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

We need to parse html to text here to avoid issue #78840

if (parentReportAction?.actionName === CONST.REPORT.ACTIONS.TYPE.POLICY_CHANGE_LOG.ADD_REPORT_FIELD) {
return getWorkspaceReportFieldAddMessage(parentReportAction);
}
if (parentReportAction?.actionName === CONST.REPORT.ACTIONS.TYPE.POLICY_CHANGE_LOG.UPDATE_REPORT_FIELD) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Along with the handling of all POLICY_CHANGE_LOG actions, we missed handling UPDATE_PROHIBITED_EXPENSES. We handled this in #81605

return payerPaidAmountMessage;
}

function computeReportNameBasedOnReportAction(parentReportAction?: ReportAction, report?: Report, reportPolicy?: Policy, parentReport?: Report): string | undefined {
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure if this is related to this PR
But we need to cover HOLD/UNHOLD actions too
More context here

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants