Skip to content

Update Remaining functions of ReportWorkflow to remove getAllReportNameValuePairs() - #103475

Open
parasharrajat wants to merge 8 commits into
Expensify:mainfrom
parasharrajat:onyx/rnvp-2
Open

parasharrajat wants to merge 8 commits into
Expensify:mainfrom
parasharrajat:onyx/rnvp-2

Conversation

@parasharrajat

@parasharrajat parasharrajat commented Oct 8, 2026 •

Copy link
Copy Markdown
Member

Explanation of Change

Fixed Issues

$ #66518
PROPOSAL:

Tests

  1. As an invoice receiver admin, create/receive an invoice.
  2. Check that LHN shows the Pay badge.
  3. Archive the invoice room.
  4. Verify that the Pay badge disappears.
  5. For a workspace expense chat with an outstanding IOU, verify Approve/Pay/Submit badges are unchanged.
  • Verify that no errors appear in the JS console

Offline tests

NA

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

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
08.10.2026_19.31.57_REC.mp4

@parasharrajat parasharrajat changed the title Update Remaining functions of ReportWorkflow to remove getAllReportNa… Update Remaining functions of ReportWorkflow to remove getAllReportNameValuePairs() Oct 8, 2026
@parasharrajat
parasharrajat marked this pull request as ready for review October 8, 2026 14:03
@parasharrajat
parasharrajat requested review from a team as code owners October 8, 2026 14:03
@chatgpt-codex-connector

Copy link
Copy Markdown

Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits.
Credits must be used to enable repository wide code reviews.

@melvin-bot
melvin-bot Bot requested review from ikevin127 and trjExpensify and removed request for a team October 8, 2026 14:03
@melvin-bot

melvin-bot Bot commented Oct 8, 2026

Copy link
Copy Markdown

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

@trjExpensify
trjExpensify removed their request for review October 8, 2026 18:20
@trjExpensify

Copy link
Copy Markdown
Contributor

PR doesn’t need product input as a refactor PR. Unassigning and unsubscribing myself.

Comment thread src/libs/ReportUtils.ts Outdated
// When the caller threads the archived state down
// Then no badge is returned because the archived chat blocks paying the invoice
expect(getBadgeFromIOUReport(iouReport, chatReport, policy, {}, invoiceReceiverPolicy, RORY_EMAIL, RORY_ACCOUNT_ID, undefined)).toBeUndefined();
expect(getBadgeFromIOUReport(iouReport, chatReport, policy, {}, invoiceReceiverPolicy, RORY_EMAIL, RORY_ACCOUNT_ID, undefined, true)).toBeUndefined();

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.

🟡 Only getBadgeFromIOUReport gets tested with true. All 15 getIOUReportActionWithBadge calls in this file pass false, so nothing checks that the outer function actually passes isChatReportArchived on to the inner one. If someone changes L452 in ReportWorkflow.ts to a hardcoded false, typecheck still passes and no test fails.

Could we add one case in the getIOUReportActionWithBadge describe, reusing the invoice setup from this test ?

it('should not return a PAY badge when the invoice chat is archived', async () => {
    // Given an invoice chat with a payable invoice preview
    // ...same setup as the invoice test above, plus the REPORT_PREVIEW action in chatReportActions

    // When the caller threads the archived state down
    const result = getIOUReportActionWithBadge(chatReport, policy, {}, invoiceReceiverPolicy, RORY_EMAIL, RORY_ACCOUNT_ID, chatReportActions, true);

    // Then the archived chat blocks paying, so no candidate action or badge is returned
    expect(result.reportAction).toBeUndefined();
    expect(result.actionBadge).toBeUndefined();
});

@ikevin127

ikevin127 commented Oct 8, 2026 •

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 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
    • 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
    • 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 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 the PR adds or modifies the UI:
    • I asked an AI agent to review the changes for accessibility issues and addressed its findings.
    • I tested with a screen reader (VoiceOver on macOS) and verified all new/changed elements are reachable with a logical focus order.
    • I verified all new/changed elements have meaningful accessible names and roles.
    • I verified state changes are announced (e.g. checked/unchecked, expanded/collapsed, selected).
  • 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

MacOS: Chrome / Safari
Screen.Recording.2026-10-08.at.15.25.21.mov

@ikevin127 ikevin127 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 - No blockers: the refactor doesn't change behavior. The 2 code-comments I dropped are non-blockers.

@melvin-bot
melvin-bot Bot requested a review from danieldoglas October 8, 2026 22:28
@parasharrajat

Copy link
Copy Markdown
Member Author

@ikevin127 Looks like the functions have been moved to a different module but I have already worked on it. I will update those ones in the other module.

@parasharrajat

parasharrajat commented Oct 9, 2026 •

Copy link
Copy Markdown
Member Author

This requires recheck @ikevin127 as functions were moved to a different file and I reapplied changes.

@ikevin127

Copy link
Copy Markdown
Contributor

@parasharrajat Looks like 3 CIs are 🔴, please address them then tag me when ready for another pass.

currentUserAccountID: RORY_ACCOUNT_ID,
chatReportActions,
allViolations: undefined,
isChatReportArchived: true,

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.

🟡 This only checks that true gives no badge, so it would also pass if the setup never produced a badge at all. For example, if createRandomReport(2) comes back with pendingFields.preview: delete, or the preview gets filtered out, the test still goes green.

Could we assert that the same setup gives PAY with false before flipping to true ? Then the test actually proves the param reaches the inner function:

// When the caller says the chat is not archived
// Then the invoice preview is payable, which proves the setup yields a badge
const notArchivedResult = getIOUReportActionWithBadge({...params, isChatReportArchived: false});
expect(notArchivedResult.actionBadge).toBe(CONST.REPORT.ACTION_BADGE.PAY);

// When the caller threads the archived state down
const result = getIOUReportActionWithBadge({...params, isChatReportArchived: true});

initialKeyStates: {
[ONYXKEYS.SESSION]: {accountID: RORY_ACCOUNT_ID, email: RORY_EMAIL},
[ONYXKEYS.PERSONAL_DETAILS_LIST]: {[RORY_ACCOUNT_ID]: {accountID: RORY_ACCOUNT_ID, login: RORY_EMAIL}},
[ONYXKEYS.PERSONAL_DETAILS_LIST]: {

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.

🟡 About half of this file's diff is formatting-only changes to tests this PR doesn't touch. Objects like {accountID: RORY_ACCOUNT_ID, login: RORY_EMAIL} and transactionParams: {amount, currency, reportID} were split onto multiple lines.

Our .oxfmtrc.json uses printWidth: 190, so npm run fmt didn't do this. It looks like an IDE formatter with a narrower width. It makes blame noisy for everyone who later touches these tests and hides the real change in the diff.

Could we revert the hunks that only reformat and keep the call-signature updates plus the new test ?

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

My previous comments

  • ReportUtils.ts (old L4699), "add a short comment so nobody reorders the early return": Addressed. The comment is at L5122, above isChatReportArchived: isReportArchived. The thread is resolved.
  • ReportWorkflowTest.ts (old L6335), "add one getIOUReportActionWithBadge case with true": Partially addressed. The test was added at L6478, but it has no positive control (see below). The thread is still unresolved on GitHub, and outdated.
  • PR description, "Explanation of Change is empty": Not addressed. It's still blank.

Only had 2 comments regarding testing and formatting - non blockers.

This branch has not been deployed

No deployments
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.

3 participants