[No QA] Refactor ReportUtils `GetIcons`... without changing any logic by grgia · Pull Request #64339 · Expensify/App

grgia · 2025-06-17T16:17:19Z

Explanation of Change

I added tests to main in #64331. Checked that they passed.

The aim of this PR is to decouple this PR without changing how it acts

I tested by running the tests.

➜  App git:(georgia-icon-part2) ✗ npm test --  tests/unit/ReportUtilsGetIconsTest.ts

{blah blah blah}

 PASS  tests/unit/ReportUtilsGetIconsTest.ts (6.573 s)
  getIcons
    ✓ should return a fallback icon if the report is empty (12 ms)
    ✓ should return the correct icons for an expense request (1 ms)
    ✓ should return the correct icons for a chat thread
    ✓ should return the correct icons for a task report (1 ms)
    ✓ should return the correct icons for a domain room
    ✓ should return the correct icons for a policy room (1 ms)
    ✓ should return the correct icons for a policy expense chat
    ✓ should return the correct icons for an expense report (1 ms)
    ✓ should return the correct icons for an IOU report with one transaction (1 ms)
    ✓ should return the correct icons for a Self DM
    ✓ should return the correct icons for a system chat (1 ms)
    ✓ should return the correct icons for a group chat (1 ms)
    ✓ should return the correct icons for a group chat without an avatar
    ✓ should return the correct icons for a group chat with an avatar
    ✓ should return the correct icons for an invoice report (1 ms)
    ✓ should return all participant icons for a one-on-one chat
    ✓ should return all participant icons as a fallback
    ✓ should return the correct icons for a workspace thread (1 ms)
    ✓ should return the correct icons for a workspace task report
    ✓ should return the correct icons for an admin room (1 ms)
    ✓ should return the correct icons for an announce room
    ✓ should return the correct icons for an invoice room with individual receiver
    ✓ should return the correct icons for an invoice room with business receiver
    ✓ should return the correct icons for a multi-transaction IOU report where current user is not manager (2 ms)
    ✓ should return the correct icons for a concierge chat
    ✓ should return the correct icons for an invoice report with individual receiver

Test Suites: 1 passed, 1 total
Tests:       26 passed, 26 total
Snapshots:   0 total
Time:        6.964 s, estimated 10 s
Ran all test suites matching /tests\/unit\/ReportUtilsGetIconsTest.ts/i.

Fixed Issues

Part of #64337
PROPOSAL:

Tests

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]."

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

grgia · 2025-06-17T16:55:46Z

src/libs/ReportUtils.ts

+/**
+ * Helper function to get the icons for an expense request. Only to be used in getIcons().
+ */
+function getIconsForExpenseRequest(report: OnyxInputOrEntry<Report>, personalDetails: OnyxInputOrEntry<PersonalDetailsList>, policy: OnyxInputOrEntry<Policy>): Icon[] {


The helper functions all use the existing blocks

grgia · 2025-06-17T16:56:34Z

src/libs/ReportUtils.ts

    policy?: OnyxInputOrEntry<Policy>,
    invoiceReceiverPolicy?: OnyxInputOrEntry<Policy>,
 ): Icon[] {


GetIcons is the root function

grgia · 2025-06-17T16:57:41Z

tests/actions/EnforceActionExportRestrictions.ts

+    it('does not export getIconsForChatThread', () => {
+        // @ts-expect-error the test is asserting that it's undefined, so the TS error is normal
+        expect(ReportUtils.getIconsForChatThread).toBeUndefined();


I don't want anyone to accidentally hardcode avatars by exporting these functions

makes sense

grgia · 2025-06-17T16:58:01Z

tests/unit/ReportUtilsGetIconsTest.ts

@@ -0,0 +1,535 @@
+import Onyx from 'react-native-onyx';


Tested on main in #64331

We can remove this file before merging.

allgandalf · 2025-06-18T10:17:25Z

@grgia can you open this pr up for review

allgandalf · 2025-06-18T10:58:06Z

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
- MacOS: Desktop
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 there are no new alerts related to the canBeMissing param for useOnyx
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

Android: HybridApp

Android: mWeb Chrome

Screen.Recording.2025-06-18.at.4.53.24.PM.mov

iOS: HybridApp

iOS: mWeb Safari

Screen.Recording.2025-06-18.at.4.52.09.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2025-06-18.at.4.48.49.PM.mov

MacOS: Desktop

Screen.Recording.2025-06-18.at.4.52.59.PM.mov

allgandalf

code LGTM, testing a bit and will approve then

allgandalf · 2025-06-18T11:00:09Z

tests/actions/EnforceActionExportRestrictions.ts

+    it('does not export getIconsForChatThread', () => {
+        // @ts-expect-error the test is asserting that it's undefined, so the TS error is normal
+        expect(ReportUtils.getIconsForChatThread).toBeUndefined();


makes sense

allgandalf · 2025-06-18T11:02:08Z

src/libs/ReportUtils.ts

+/**
+ * Helper function to get the icons for an expense request. Only to be used in getIcons().
+ */
+function getIconsForExpenseRequest(report: OnyxInputOrEntry<Report>, personalDetails: OnyxInputOrEntry<PersonalDetailsList>, policy: OnyxInputOrEntry<Policy>): Icon[] {


allgandalf

lets remove the tests please before merging

melvin-bot · 2025-06-18T11:24:51Z

@chiragsalian 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 · 2025-06-18T11:24:54Z

🎯 @allgandalf, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #64432.

melvin-bot · 2025-06-18T11:30:42Z

@neil-marcellini 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]

grgia · 2025-06-18T11:34:43Z

The auto assigner went off, sorry guys

inimaga

LGTM

inimaga · 2025-06-18T11:40:06Z

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
- MacOS: Desktop
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 there are no new alerts related to the canBeMissing param for useOnyx
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

Android: HybridApp

Android: mWeb Chrome

iOS: HybridApp

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

OSBotify · 2025-06-18T11:55:18Z

✋ 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 · 2025-06-18T23:45:37Z

🚀 Deployed to staging by https://github.com/inimaga in version: 9.1.69-0 🚀

platform	result
🖥 desktop 🖥	success ✅
🕸 web 🕸	success ✅
🤖 android 🤖	success ✅
🍎 iOS 🍎	failure ❌

github-actions · 2025-06-19T09:40:04Z

🚀 Deployed to staging by https://github.com/inimaga in version: 9.1.69-0 🚀

platform	result
🖥 desktop 🖥	success ✅
🕸 web 🕸	success ✅
🤖 android 🤖	success ✅
🍎 iOS 🍎	failure ❌

github-actions · 2025-06-19T10:20:19Z

🚀 Deployed to staging by https://github.com/inimaga in version: 9.1.69-0 🚀

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

github-actions · 2025-06-20T12:47:43Z

🚀 Deployed to production by https://github.com/lakchote in version: 9.1.69-3 🚀

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

grgia added 5 commits June 17, 2025 15:26

add tests for icons to prevent regressions while refactoring

033ca28

Code coverage

894cd82

temporarily disable test

da38385

fix lint

fa06607

lint

e6fc302

grgia self-assigned this Jun 17, 2025

grgia added 6 commits June 17, 2025 17:20

Merge branch 'main' into georgia-icon-part2

254eecd

add export unit tests, revrt any new code

06e7180

remove dupe test

1edbec3

Revert to existing logic

1d231e6

return early for getParticipantIcon

fff16d8

add comment

2052ddf

grgia commented Jun 17, 2025

View reviewed changes

lint

858c604

grgia requested review from allgandalf June 18, 2025 10:17

allgandalf reviewed Jun 18, 2025

View reviewed changes

allgandalf approved these changes Jun 18, 2025

View reviewed changes

melvin-bot bot requested a review from chiragsalian June 18, 2025 11:24

melvin-bot bot mentioned this pull request Jun 18, 2025

Payment issue for E/App PR#64339 #64432

Closed

remove tests file from this PR

2561706

grgia requested review from inimaga June 18, 2025 11:27

grgia requested a review from inimaga June 18, 2025 11:27

grgia marked this pull request as ready for review June 18, 2025 11:30

grgia requested a review from a team as a code owner June 18, 2025 11:30

melvin-bot bot requested review from neil-marcellini and removed request for a team June 18, 2025 11:30

inimaga approved these changes Jun 18, 2025

View reviewed changes

inimaga merged commit 461fb5a into main Jun 18, 2025
23 checks passed

inimaga deleted the georgia-icon-part2 branch June 18, 2025 11:44

github-actions bot mentioned this pull request Jun 18, 2025

Deploy Checklist: New Expensify 2025-06-18 #64518

Closed

58 tasks

MelvinBot mentioned this pull request Mar 18, 2026

[$250] Invited member to expense report sees the chat with fallback avatar on LHN #85240

Open

7 tasks

Conversation

grgia commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

allgandalf commented Jun 18, 2025

Uh oh!

allgandalf commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

allgandalf left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

allgandalf left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Jun 18, 2025

Uh oh!

melvin-bot bot commented Jun 18, 2025

Uh oh!

melvin-bot bot commented Jun 18, 2025

Uh oh!

grgia commented Jun 18, 2025

Uh oh!

inimaga left a comment

Choose a reason for hiding this comment

Uh oh!

inimaga commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

Uh oh!

OSBotify commented Jun 18, 2025

Uh oh!

github-actions bot commented Jun 18, 2025

Uh oh!

github-actions bot commented Jun 19, 2025

Uh oh!

github-actions bot commented Jun 19, 2025

Uh oh!

github-actions bot commented Jun 20, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

grgia commented Jun 17, 2025 •

edited

Loading

allgandalf commented Jun 18, 2025 •

edited

Loading

inimaga commented Jun 18, 2025 •

edited

Loading