Skip to content

Refactor issue 66427: Add reportAttributes parameter to getReportName and getParentNavigationSubtitle functions (Part 1/4)#91295

Open
hoangzinh wants to merge 7 commits into
Expensify:mainfrom
hoangzinh:66427-pr2-reportAttributes
Open

Refactor issue 66427: Add reportAttributes parameter to getReportName and getParentNavigationSubtitle functions (Part 1/4)#91295
hoangzinh wants to merge 7 commits into
Expensify:mainfrom
hoangzinh:66427-pr2-reportAttributes

Conversation

@hoangzinh
Copy link
Copy Markdown
Contributor

@hoangzinh hoangzinh commented May 21, 2026

Explanation of Change

This is part 1 of a 4-PR series to remove the deprecated Onyx.connect() pattern for ONYXKEYS.DERIVED.REPORT_ATTRIBUTES. The goal is to migrate from module-level Onyx connections to explicit parameter passing.

This PR makes reportAttributes (or reportAttributesDerivedValue) a required parameter in several utility functions: getReportName() and getParentNavigationSubtitle() in ReportUtils.ts:

  • Made reportAttributes parameter required with default value = {}
  • Updated all call sites to pass the parameter explicitly

Fixed Issues

$ #66427
PROPOSAL: #66427 (comment)

Tests

Same as QA

  • Verify that no errors appear in the JS console

Offline tests

Same as QA

QA Steps

Test 1: Test report details page

  1. Sign in to ND
  2. Go to any chat report
  3. Open report details
  4. Verify it displays correct report name

Test 2: Test sub navigation link

  1. Sign in to ND
  2. Send a message
  3. Open a thread for that message
  4. Verify that the thread report displays the correct report name of the parent report at the top

Test 3: Spend -> Reports

  1. Sign in to ND
  2. Go to Spend -> Reports
  3. Verify that it displays the correct report name
  • 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

Screen.Recording.2026-05-21.at.22.49.14.mov

hoangzinh added 3 commits May 21, 2026 16:07
Make reportAttributes parameter required in getReportName() and
getSearchReportName() to ensure derived report name values are always
passed explicitly. Updated all call sites including SearchUIUtils,
Search components, and related hooks to pass reportAttributes from
useReportAttributes() hook.

This enforces awareness of the reportAttributes parameter and prevents
accidental omissions while maintaining backward compatibility through
default values.

Related to Expensify#66427
Make reportAttributes parameter required in getParentNavigationSubtitle()
to ensure derived report name values are always passed explicitly when
computing parent navigation subtitles. Updated all call sites including
ShareCodePage and ReportDetailsPage to pass reportAttributes from
useReportAttributes() hook.

This enforces awareness of the reportAttributes parameter and prevents
accidental omissions while maintaining backward compatibility through
a default empty object.

Related to Expensify#66427
…ctions

- Make reportAttributesDerivedValue accept undefined in type definition
- Add default value (= {}) to getSections parameter
- Remove redundant ?? {} from all 6 call sites
- Maintains type safety while reducing code repetition
@codecov
Copy link
Copy Markdown

codecov Bot commented May 21, 2026

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 Δ
...h/SearchList/ListItem/TransactionGroupListItem.tsx 73.28% <100.00%> (+0.18%) ⬆️
src/components/Search/index.tsx 0.62% <ø> (+<0.01%) ⬆️
src/pages/ReportDetailsPage.tsx 55.61% <100.00%> (ø)
src/pages/inbox/HeaderView.tsx 95.23% <100.00%> (ø)
src/components/Search/SearchStaticList.tsx 4.16% <0.00%> (-0.05%) ⬇️
.../home/SpendOverTimeSection/useSpendOverTimeData.ts 37.50% <0.00%> (-1.21%) ⬇️
src/libs/ReportUtils.ts 83.11% <50.00%> (+0.01%) ⬆️
src/libs/SearchUIUtils.ts 64.08% <50.00%> (-0.06%) ⬇️
src/pages/ShareCodePage.tsx 0.00% <0.00%> (ø)
... and 18 files with indirect coverage changes

@hoangzinh hoangzinh changed the title Refactor issue 66427: Add reportAttributes parameter to getReportName and getParentNavigationSubtitle functions (Part 1/5) Refactor issue 66427: Add reportAttributes parameter to getReportName and getParentNavigationSubtitle functions (Part 1/4) May 21, 2026
hoangzinh added 3 commits May 21, 2026 19:49
The reportAttributesDerivedValue variable is used inside the useMemo callback
when calling getSections(). After adding it as a default parameter to getSections,
React's exhaustive-deps rule correctly identified it as a missing dependency.

This fixes the react-hooks/exhaustive-deps lint error.
@hoangzinh hoangzinh marked this pull request as ready for review May 21, 2026 16:26
@hoangzinh hoangzinh requested review from a team as code owners May 21, 2026 16:26
@melvin-bot melvin-bot Bot requested review from DylanDylann and heyjennahay and removed request for a team May 21, 2026 16:26
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 21, 2026

@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 removed the request for review from a team May 21, 2026 16:26
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.

1 participant