[Avatars - Reports] Use centralized logic for report actions avatars everywhere in the app

[JakubKorytko]

Explanation of Change

If the report is of the IOU type and contains only one person's expenses, we want to display only the sender's avatar. If there is more than one expense, we want to display diagonal avatars of both users.

The PR #64802 takes care of that in terms of IOU report previews and report headers.
This PR will address the rest of the app, meaning that with an exception for simple single avatars & avatars with image picker we will use a single component ReportAvatar for every report-related avatar.

I've removed MultipleAvatars, SingleReportAvatar and SubscriptAvatar — it's now just ReportActionAvatars with the whole logic encapsulated. The new component has one mandatory prop, which can be either a report ID, an action or account IDs (the other two are for specific cases where a report ID is unavailable, not really used 90% of the time). Also removed some functions related to report avatars that was used in a few places in the code to keep it centralized.

The ReportActionAvatars component uses the ReportActionAvatar compound component to display the correct UI based on the avatar type. The avatar type can be one of the following:

Single Avatar (CONST.REPORT_ACTION_AVATARS.TYPE.SINGLE)

Multiple Avatar (CONST.REPORT_ACTION_AVATARS.TYPE.MULTIPLE)

Multiple Diagonal Avatar (CONST.REPORT_ACTION_AVATARS.TYPE.MULTIPLE_DIAGONAL)

Multiple Horizontal Avatar (CONST.REPORT_ACTION_AVATARS.TYPE.MULTIPLE_HORIZONTAL)

Subscript Avatar (CONST.REPORT_ACTION_AVATARS.TYPE.SUBSCRIPT)

Since there is a lot to test here, automated testing is necessary and is included in this PR. We also need to ensure that, if the data is still loading, the app displays a single avatar and then changes to a diagonal one, if applicable - not the other way around.

Optimization

This PR is already huge, but the next step is to optimize the ReportActionAvatars component as much as possible, since it is currently used in many places. This may be easier once the report actions BE issue is resolved, we could also add a new Onyx derived value, but I would prefer to do so in a follow-up PR with a little refractor as a bonus.

Testing

I'm aware that the test steps are extensive, but since we have automated UI tests, I suggest focusing on the report previews, the details page, the LHN, the report and chat headers, and the search page.

Fixed Issues

$ #65559
$ #65741
$ #65813
$ #65814
PROPOSAL: N/A

Tests

[Subtest: Go through these steps to see if the avatar is displayed correctly.]
This must be done for both User A and User B, and the same avatar/s must be displayed for both.

1. Go to Inbox.
2. Open a chat with the report.
3. Verify that the avatar above the report preview is correct.
4. Open the report.
5. Verify that the avatar is displayed correctly in the focused element inside LHN.
6. Verify that avatar in the report header is correct.
7. Click on the green part of the header to trigger details panel.
8. Verify that avatar is correct in the details page.
9. Open Reports tab and select Chats.
10. Find a message with the report preview and verify that avatar above the report preview is displayed correctly.

[Tests]

1. Log into two new accounts.
2. As user A create one or more expenses to user B.
3. Verify that for Subtest you see only user's A avatar.
4. Create one or more expenses as user B to user A.
5. Verify that for Subtest you see both users avatars.
6. Delete every expense that user A has created.
7. Verify that for Subtest you see only user's B avatar.
8. Create a new report using "Create report" option
9. Repeat steps 2-7.
10. Create another report.
11. Repeat steps 2-7 but this time create splits instead of expenses.
12. Create a payment using Send Money flow from user A to user B
13. Verify that for Subtest you see only user's A avatar.
14. Create a payment using Send Money flow from user B to user A
15. Verify that for Subtest you see only user's B avatar.
16. Create third account
17. Create a group for user A, B and C
18. Create split as user A
19. Verify that you see only user's A avatar above the split as user A, B and C.
20. Verify that this PR logic is not applied to workspaces. In workspaces after you create a report, expense or split we want to display author avatar with subscript being the workspace icon or vice-versa. You can use Subtest steps to verify that.
21. Verify that the avatar is correct in the assigned task, the schedule call confirmation page, the workspace member invitation confirmation page, the workspace initial page and other places where avatars can be displayed.

Offline tests

Same as tests, but the connection must be restored and then dropped after each step in order to receive updated Onyx data.

QA Steps

Same as tests.

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
  • MacOS: Desktop
• 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 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

Web.mov

MacOS: Desktop

[grgia]

Assigning as a reviewer so I don't lose track :)

[OSBotify]

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

🚀 Deployed to staging by https://github.com/grgia in version: 9.1.89-1 🚀

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

[kavimuru]

@JakubKorytko @shawnborton
Steps 8-11 : create report option is not available in 1:1

[JakubKorytko]

Yeah, fair point. To simulate that behavior, you can simply create an expense without having any unsettled expenses before.

[github-actions]

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.1.89-21 🚀

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

[QichenZhu]

This relied on underlying logic to work: before this PR, iouReport only existed if the action was a report preview, which is no longer the case after this PR, so it caused an issue #68262. We fixed it in PR #71907.