Skip to content

[Phase 2 of #66427, sub-pr 2/5] Migrate deprecatedGetReportName → getReportName in component files - #96952

Merged
marcochavezf merged 10 commits into
Expensify:mainfrom
hoangzinh:refactor/66427-phase2-sub2-component
Aug 3, 2026
Merged

[Phase 2 of #66427, sub-pr 2/5] Migrate deprecatedGetReportName → getReportName in component files#96952
marcochavezf merged 10 commits into
Expensify:mainfrom
hoangzinh:refactor/66427-phase2-sub2-component

Conversation

@hoangzinh

@hoangzinh hoangzinh commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

Part of #66427. Phase 2, Sub-PR 2 of 5 Sub-PR 2 — migrate deprecatedGetReportName → getReportName per directory src/components/**

Next step:

  • Sub-PR 3 — migrate deprecatedGetReportName → getReportName per directory src/libs/**
  • Sub-PR 4 — migrate deprecatedGetReportName → getReportName per directory src/pages/** + tests.
  • Final Sub-PR 5 — delete deprecatedGetReportName; the compiler proves zero callers remain and its baseline rows go to zero.

Fixed Issues

$ #66427
PROPOSAL: #66427 (comment)

Tests

Same as QA

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

1. Report header title — AvatarWithDisplayName

  1. Open a 1:1 DM, a group chat, a workspace room (#room), and a workspace expense chat.
  2. Verify the header title shows the correct name in each.
  3. Open a thread
  4. Verify both the thread title and the parent-report subtitle line render correctly.
  5. Rename a report (chat → Settings → Room name) and verify the header updates without a manual refresh.

2. Expense confirmation "Report" field — ReportField

  1. Submit an expense into a workspace that has outstanding reports → confirm the Report row shows the selected report's name.
  2. Create a scenario with no existing report → verify it shows "New report".
  3. Change the selected report and verify the name updates.

3. Welcome message - ReportWelcomeText / SidebarUtils.getRoomWelcomeMessage

  1. Open a fresh workspace room → verify "Welcome to #room" hero + beginning-of-room message name.
  2. Open an invoice room → verify the "X owes Y" name in the welcome 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
  • 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 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 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)
  • 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)
  • 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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.
  • 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

Screen.Recording.2026-07-24.at.20.13.31.mp4

…nsify#66427)

Replace deprecatedGetReportName(report, reportAttributes) with getReportName(report, derivedReportName) across AvatarWithDisplayName, ReportField, MoneyRequestView, ReportWelcomeText, useFilterReportValue, SidebarUtils and DebugReportActions.

Names are now sourced via the new getDerivedReportNameByReportID helper (ReportAttributesUtils) and the new useDerivedReportNamesByReportIDs hook, which subscribes to REPORT_ATTRIBUTES once and selects only the needed names instead of subscribing to the whole attributes Record for a single name.

Part of Expensify#66427 Phase 2.
Add unit tests for getDerivedReportNameByReportID (ReportAttributesUtils) and useDerivedReportNamesByReportIDs (useReportAttributes), and adapt SidebarUtilsTest to the derivedReportName argument of getWelcomeMessage.
@codecov

codecov Bot commented Jul 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
src/components/AvatarWithDisplayName.tsx 80.41% <100.00%> (ø)
...eyRequestConfirmationList/sections/ReportField.tsx 85.10% <100.00%> (ø)
src/components/ReportWelcomeText.tsx 96.72% <100.00%> (ø)
src/hooks/useReportAttributes.ts 76.92% <100.00%> (+14.42%) ⬆️
src/libs/ReportAttributesUtils.ts 100.00% <100.00%> (ø)
src/libs/SidebarUtils.ts 80.26% <100.00%> (ø)
src/pages/Debug/Report/DebugReportActions.tsx 89.36% <100.00%> (ø)
...c/components/ReportActionItem/MoneyRequestView.tsx 74.71% <88.88%> (+0.40%) ⬆️
...c/components/Search/hooks/useFilterReportValue.tsx 0.00% <0.00%> (ø)
... and 8 files with indirect coverage changes

@hoangzinh hoangzinh changed the title [Phase 2 of #66427, Sub-PR 2/5] Migrate deprecatedGetReportName → getReportName in component files [Phase 2 of #66427, sub-pr 2/5] Migrate deprecatedGetReportName → getReportName in component files Jul 24, 2026
…ames (Expensify#66427)

The old name was nearly identical to the useDerivedReportNameByReportID hook but did something different (a pure lookup on a passed-in names map, not an Onyx fetch). getReportNameFromNames makes clear it selects from the map returned by useDerivedReportNamesByReportIDs.
@hoangzinh
hoangzinh marked this pull request as ready for review July 24, 2026 13:22
@hoangzinh
hoangzinh requested review from a team as code owners July 24, 2026 13:22
@melvin-bot
melvin-bot Bot requested review from a team, DylanDylann and JmillsExpensify and removed request for a team July 24, 2026 13:22
@melvin-bot

melvin-bot Bot commented Jul 24, 2026

Copy link
Copy Markdown

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

@melvin-bot
melvin-bot Bot requested review from marcochavezf and removed request for a team July 24, 2026 13:22
@melvin-bot

melvin-bot Bot commented Jul 24, 2026

Copy link
Copy Markdown

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

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

No product review required.

return {
reportID: match.reportID,
name: deprecatedGetReportName(match, reportAttributes) || match.reportName,
name: getReportName(match, reportAttributes?.[match.reportID]?.reportName) || match.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.

@hoangzinh Let's avoid using reportAttributes

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I updated in this commit 4853736


return reportIDs
.map((id) => deprecatedGetReportName(reports?.[`${ONYXKEYS.COLLECTION.REPORT}${id}`], reportAttributes?.reports))
.map((id) => getReportName(reports?.[`${ONYXKEYS.COLLECTION.REPORT}${id}`], reportAttributes?.reports?.[id]?.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.

same above

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I updated in this commit 89d0a18

@DylanDylann

Copy link
Copy Markdown
Contributor

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • 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 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)
  • 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)
  • 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.
  • 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

Screen.Recording.2026-07-29.at.15.09.03.mov

@DylanDylann

Copy link
Copy Markdown
Contributor

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Another round soon, please!

Reviewed commit: 6c6445774a

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@hoangzinh
hoangzinh force-pushed the refactor/66427-phase2-sub2-component branch from eef4949 to 49e1ac0 Compare July 29, 2026 10:37
Replace the whole-Record useReportAttributes() subscription with a single
useDerivedReportNamesByReportIDs call for the trip room and parent report
names, so the component only re-renders when those specific names change.
@hoangzinh
hoangzinh force-pushed the refactor/66427-phase2-sub2-component branch from 49e1ac0 to 4853736 Compare July 29, 2026 10:39
Replace the whole REPORT_ATTRIBUTES subscription with a single
useDerivedReportNamesByReportIDs call so the hook only re-renders when one
of the requested report names changes.
@hoangzinh

Copy link
Copy Markdown
Contributor Author

@DylanDylann PR is ready for next review round

reportID: match.reportID,
name: deprecatedGetReportName(match, reportAttributes) || match.reportName,
};
return match;

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.

Let's return report.reportName only instead of the entire report

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.

I see getReportName receives a report object. But a selector returning a single field would be better for performance. So please find a way to resolve the type problem.

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.

Should allow getReportName accept an object or a string?

@hoangzinh hoangzinh Jul 30, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Should allow getReportName accept an object or a string?

I think about this option too, but then it's hard to deal with this logic. And, somehow, we increase the refactoring scope.

if (!report?.reportID) {
return '';
}

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.

@hoangzinh Let's keep following up on this problem in the next PRs. If making this refactor also helps performance in other places, I'd still suggest doing it.

@DylanDylann

Copy link
Copy Markdown
Contributor

@hoangzinh Could you please resolve the conflict and ping me again to approve? Thank you

@hoangzinh

Copy link
Copy Markdown
Contributor Author

@marcochavezf all yours

@marcochavezf
marcochavezf merged commit 7a6718e into Expensify:main Aug 3, 2026
35 checks passed
@OSBotify

OSBotify commented Aug 3, 2026

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 Aug 3, 2026

Copy link
Copy Markdown
Contributor

🚧 marcochavezf has triggered a test Expensify/App build. You can view the workflow run here.

@OSBotify

OSBotify commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/marcochavezf in version: 9.4.49-0 🚀

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

@MelvinBot

Copy link
Copy Markdown
Contributor

🤖 Help site review — no changes required

I reviewed the changes in this PR against the help site content in App/docs/articles, applying HELPSITE_NAMING_CONVENTIONS.md, HELP_AUTHORING_GUIDELINES.md, and TEMPLATE.md.

Conclusion: No help site changes are needed, so I did not create a draft PR.

Why

This is a behavior-preserving internal refactor — it migrates deprecatedGetReportNamegetReportName and adds supporting hooks/utils. Every changed file is TypeScript source or a unit test:

  • src/components/AvatarWithDisplayName.tsx, MoneyRequestConfirmationList/sections/ReportField.tsx, ReportActionItem/MoneyRequestView.tsx, ReportWelcomeText.tsx, Search/hooks/useFilterReportValue.tsx
  • src/hooks/useReportAttributes.ts, src/libs/ReportAttributesUtils.ts, src/libs/SidebarUtils.ts, src/pages/Debug/Report/DebugReportActions.tsx
  • tests/unit/*

Report names (chat headers, the expense "Report" field, welcome messages, sidebar) render identically to before — no new feature, no UI label change, no pricing/billing/workspace/integration behavior change. Help articles describe user-facing product behavior, none of which is altered 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.

6 participants