Skip to content

refactor: Remove deprecated report name functions in ReportUtils (Part 4)#84485

Closed
mohammadjafarinejad wants to merge 15 commits intoExpensify:mainfrom
mohammadjafarinejad:fix/76852-part4
Closed

refactor: Remove deprecated report name functions in ReportUtils (Part 4)#84485
mohammadjafarinejad wants to merge 15 commits intoExpensify:mainfrom
mohammadjafarinejad:fix/76852-part4

Conversation

@mohammadjafarinejad
Copy link
Contributor

@mohammadjafarinejad mohammadjafarinejad commented Mar 7, 2026

Explanation of Change

Migrates non-component call sites from the deprecated ReportUtils.getReportName to ReportNameUtils.getReportName, passing report (and optionally reportAttributes) directly as arguments.

Task.ts
BrowserNotifications.ts
ModifiedExpenseMessage.ts
SearchQueryUtils.ts
MoneyRequestReportPreviewContent.tsx
MoneyRequestReportPreview.test.tsx

Fixed Issues

$ #76852
PROPOSAL:

Tests

1. Task Share Destination (Task.ts)

getShareDestination uses getReportName to display the name of the report a task is being shared/assigned to.

Test Steps:

  1. Open the app and navigate to a workspace with multiple reports.
  2. Create a new task (e.g., from the + menu → Task).
  3. Tap the Assignee or Share destination field.
  4. Verify report names appear correctly in the destination list (e.g., workspace expense chats, DMs, group rooms).
  5. Assign the task to a workspace expense chat and submit.
  6. Verify the task is created with the correct destination name shown.

2. Browser/Desktop Notification — Room or Group Chat Comment (BrowserNotifications.ts, LocalNotification/index.ts)

pushReportCommentNotification uses getReportName as the notification title for rooms/group chats.

Test Steps:

  1. Use two browser tabs logged in as two different accounts (or use two devices).
  2. Open a Group Chat or a Room (#admins, #announce, etc.) in Account A.
  3. From Account B, send a message into that same group chat or room.
  4. On Account A's desktop/web, verify a browser notification pops up.
  5. Verify the notification title matches the exact room/group chat name as displayed in the LHN.

3. Modified Expense Notification — Expense Moved Between Reports (ModifiedExpenseMessage.ts, BrowserNotifications.ts)

getMovedFromOrToReportMessage uses getReportName for the "moved from report" text in the notification.

Test Steps:

  1. Create an expense and submit it to a workspace report (Report A).
  2. While logged in as an admin on another browser/device, move that expense to a different report (Report B).
  3. On either account, open Report A and scroll to find the system/automated message about the moved expense.
  4. Verify the message reads something like "Moved from [Report A name]" — confirming the report name resolves correctly (not undefined, blank, or a raw report ID).
  5. Open Report B and verify that a corresponding message appears there as well.

4. Search — "In" Filter Display Value (SearchQueryUtils.ts, SearchPageHeaderInput.tsx, buildSubstitutionsMap.ts)

getFilterDisplayValue for filterName === CONST.SEARCH.SYNTAX_FILTER_KEYS.IN uses getReportName to resolve a report ID to a human-readable name. buildUserReadableQueryString and buildSubstitutionsMap now propagate reportAttributes.

Test Steps:

  1. Open the Search page and click/focus the search input.
  2. Type in: and select a specific report/room from the autocomplete suggestions.
  3. Verify the report name appears inline in the search input as styled text (not a raw report ID like in:123456789).
  4. Submit the search.
  5. Verify the query display bar below the input shows the human-readable report name (e.g., in: My Room) instead of the raw ID.
  6. Navigate away (e.g., open a report) and return to Search via the LHN — verify the query bar still shows the correct report name.
  7. Repeat with a #room, a DM, and a group chat to cover different report type name resolutions.

5. Money Request Report Preview Header (MoneyRequestReportPreviewContent.tsx)

getReportName(iouReport, reportAttributes) is used as the heading text of the MoneyRequestReportPreview component (the preview card visible in the 1:1 chat).

Test Steps:

  1. Open a 1:1 chat where an IOU/expense report exists.
  2. Locate the MoneyRequestReportPreview card in the chat thread.
  3. Verify the header shows the correct IOU/expense report name (e.g., "Expense Report" or a custom report name).
  4. Open a workspace-based expense report and find its preview card — verify the name matches the report's actual name.
  5. If the report has a custom reportName, verify that custom name is shown.

6. Pusher-Triggered Notifications (User.ts, Report/index.ts)

triggerNotifications in User.ts now passes reportAttributes?.reports to showReportActionNotification, which then threads it through to both showCommentNotification and showModifiedExpenseNotification.

Test Steps:

  1. Have two accounts open simultaneously.
  2. From Account B, send a message in a Room chatting with Account A.
  3. Verify Account A receives a browser notification with the correct room name as the title.
  4. From Account B, send a message in a 1:1 DM with Account A.
  5. Verify Account A's notification title shows the sender's name (not the room name path).
  • Verify that no errors appear in the JS console

Offline tests

Same as tests.

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

Tests

Task.ts

image

BrowserNotifications.ts / LocalNotification/index.ts

image

ModifiedExpenseMessage.ts

image

SearchQueryUtils.ts / SearchPageHeaderInput.tsx / buildSubstitutionsMap.ts

image

@codecov
Copy link

codecov bot commented Mar 7, 2026

Codecov Report

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

Files with missing lines Coverage Δ
...ReportPreview/MoneyRequestReportPreviewContent.tsx 61.87% <100.00%> (ø)
src/components/Search/SearchAutocompleteList.tsx 71.76% <ø> (ø)
.../Search/SearchPageHeader/SearchPageHeaderInput.tsx 50.00% <100.00%> (+0.35%) ⬆️
...nents/Search/SearchRouter/buildSubstitutionsMap.ts 100.00% <ø> (ø)
src/hooks/useSearchTypeMenu.tsx 69.33% <100.00%> (ø)
src/libs/ModifiedExpenseMessage.ts 90.09% <100.00%> (ø)
...Navigation/AppNavigator/AuthScreensInitHandler.tsx 96.92% <100.00%> (ø)
src/libs/SearchQueryUtils.ts 76.20% <100.00%> (ø)
src/libs/actions/Task.ts 46.66% <ø> (ø)
src/libs/actions/User.ts 30.90% <100.00%> (ø)
... and 5 more
... and 50 files with indirect coverage changes

@mohammadjafarinejad
Copy link
Contributor Author

mohammadjafarinejad commented Mar 7, 2026

Hey @sosek108, quick question on this refactor

The new getReportName in ReportNameUtils only returns report.reportName or the cached value from reportAttributes, but the old one in ReportUtils always computed the name dynamically. So if callers don't pass reportAttributes, they might get wrong results silently — is that right?

If yes, should we make it required to enforce correct usage, or keep it optional to allow graceful degradation for call sites that don't have easy access to it?

// required
function testCall(reportAttributes: ReportAttributesDerivedValue['reports']) {}

// optional
function testCall(reportAttributes?: ReportAttributesDerivedValue['reports']) {}
function testCall(reportAttributes: ReportAttributesDerivedValue['reports'] | undefined) {}

@mohammadjafarinejad mohammadjafarinejad marked this pull request as ready for review March 7, 2026 11:07
@mohammadjafarinejad mohammadjafarinejad requested review from a team as code owners March 7, 2026 11:07
@melvin-bot
Copy link

melvin-bot bot commented Mar 7, 2026

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

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 44f626279b

ℹ️ 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".

…SearchTypeMenu, BrowserNotifications, and SavedSearchList components
Copy link
Contributor

@sosek108 sosek108 left a comment

Choose a reason for hiding this comment

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

LGTM

JmillsExpensify
JmillsExpensify previously approved these changes Mar 9, 2026
Copy link
Contributor

@JmillsExpensify JmillsExpensify left a comment

Choose a reason for hiding this comment

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

All looks good for product.

@eVoloshchak
Copy link
Contributor

eVoloshchak commented Mar 10, 2026

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

Screenshots/Videos
Screen.Recording.2026-03-12.at.15.43.33.mov
Screenshot 2026-03-12 at 16 03 18
Screen.Recording.2026-03-12.at.16.07.28.mov
Screen.Recording.2026-03-12.at.16.17.49.mov

@sosek108
Copy link
Contributor

@mohammadjafarinejad can you resolve conflicts? And also eslint is failing


let reportAttributes: ReportAttributesDerivedValue | undefined;
Onyx.connect({
key: ONYXKEYS.DERIVED.REPORT_ATTRIBUTES,
Copy link
Contributor

Choose a reason for hiding this comment

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

Onyx.connect() is deprecated. Use useOnyx() hook instead and pass the data as parameters to a pure function

We should be able to pass reportAttributes from the function call on AuthScreen (useReportAttributes hook)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated.

@mohammadjafarinejad
Copy link
Contributor Author

@eVoloshchak Ready for re-review.

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

LGTM!

@melvin-bot melvin-bot bot requested a review from neil-marcellini March 12, 2026 15:21
Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Good to go. Thank you. We do need to fix merge conflicts first. Let me know when that's fixed.

@mohammadjafarinejad
Copy link
Contributor Author

@neil-marcellini Ready for re-review.

@eVoloshchak
Copy link
Contributor

@mohammadjafarinejad, this branch has conflicts that must be resolved

@sosek108
Copy link
Contributor

@mohammadjafarinejad can you please work on the merge conflicts?

@neil-marcellini
Copy link
Contributor

Asking @sosek108 if he can fix conflicts since @mohammadjafarinejad hasn't responded in a while

@mohammadjafarinejad
Copy link
Contributor Author

@neil-marcellini Sorry for the delay, I’ll work on it now.

Copy link
Contributor

@sosek108 sosek108 left a comment

Choose a reason for hiding this comment

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

you left behind unused useEffect dep. Please remove this

);
setAutocompleteSubstitutions(substitutionsMap);
}, [allFeeds, personalAndWorkspaceCards, originalInputQuery, personalDetails, reports, taxRates, policies, currentUserAccountID, translate, conciergeReportID]);
}, [allFeeds, personalAndWorkspaceCards, originalInputQuery, personalDetails, reports, taxRates, policies, currentUserAccountID, translate, conciergeReportID, reportAttributes]);
Copy link
Contributor

Choose a reason for hiding this comment

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

conciergeReportID is not used anymore

const feedKeysWithCards = useFeedKeysWithAssignedCards();
const {inputQuery: originalInputQuery} = queryJSON;
const [currentUserAccountID = -1] = useOnyx(ONYXKEYS.SESSION, {selector: accountIDSelector});
const [conciergeReportID] = useOnyx(ONYXKEYS.CONCIERGE_REPORT_ID);
Copy link
Contributor

Choose a reason for hiding this comment

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

conciergeReportID is not used anymore

@sosek108
Copy link
Contributor

@mohammadjafarinejad There are unfortunately another conflicts :/

@sosek108
Copy link
Contributor

@mohammadjafarinejad @neil-marcellini

because there are more and more merge conflicts can we plan a time slot where we resolve them, quickly test & review them, and then merge them into main?

@neil-marcellini
Copy link
Contributor

Yes, sounds good. I started a group chat in Slack to coordinate timings.

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

A bit more clean up is needed from resolving the merge conflict.

@@ -843,6 +873,154 @@ describe('actions/Report', () => {
});
});

it('should pass conciergeReportID through to showReportActionNotification when provided', () => {
Copy link
Contributor

Choose a reason for hiding this comment

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

This test no longer has a purpose. I suggest we remove it.

Copy link
Contributor

Choose a reason for hiding this comment

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

Let's also remove all the other "pass conciergeReportID" tests below.

Copy link
Contributor

Choose a reason for hiding this comment

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

Same here, a lot of these tests don't make sense anymore.

@neil-marcellini
Copy link
Contributor

neil-marcellini commented Mar 20, 2026

Hubert is available now and so am I, and he cannot push to your fork for this PR, so we have created a new PR and we're moving forward there to try to get this merged today.

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.

5 participants