(1/2) Add support for all reportAction types in ChatListItem - create PureReportActionItem

[wildan-m]

Explanation of Change

Initial PR for adding support for all reportAction types in ChatListItem. Extracted onyx data to params to create PureReportAction component.

Fixed Issues

$ https://github.com/Expensify/App/issues/51296 PROPOSAL: https://github.com/Expensify/App/issues/51296#issuecomment-2475914063

Tests

No specific test required, just ensure that the report action item functions correctly as usual.

• [X] Verify that no errors appear in the JS console

Offline tests

Same as Test

QA Steps

Same as Test

• [X] Verify that no errors appear in the JS console

PR Author Checklist

• [X] I linked the correct issue in the ### Fixed Issues section above
• [X] I wrote clear testing steps that cover the changes made in this PR
  • [X] I added steps for local testing in the Tests section
  • [X] I added steps for the expected offline behavior in the Offline steps section
  • [X] I added steps for Staging and/or Production testing in the QA steps section
  • [X] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
  • [X] 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)
  • [X] 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).
• [X] I included screenshots or videos for tests on all platforms
• [X] I ran the tests on all platforms & verified they passed on:
  • [X] Android: Native
  • [X] Android: mWeb Chrome
  • [X] iOS: Native
  • [X] iOS: mWeb Safari
  • [X] MacOS: Chrome / Safari
  • [X] MacOS: Desktop
• [X] 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)
• [X] I followed proper code patterns (see Reviewing the code)
  • [X] 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)
  • [X] I verified that comments were added to code that is not self explanatory
  • [X] 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.
  • [X] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [X] 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:
  • [X] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [X] 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)
  • [X] 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.
  • [X] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [X] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [X] I followed the guidelines as stated in the Review Guidelines
• [X] 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)
• [X] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [X] I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
• [X] I verified that if a function's arguments changed that all usages have also been updated correctly
• [X] If any new file was added I verified that:
  • [X] 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
• [X] If a new CSS style is added I verified that:
  • [X] A similar style doesn't already exist
  • [X] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
• [X] 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.
• [X] 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)
• [X] 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.
• [X] 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.
• [X] 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:
  • [X] I verified that all the inputs inside a form are aligned with each other.
  • [X] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
• [X] 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.
• [X] 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

MacOS: Desktop

[melvin-bot[bot]]

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

[allgandalf]

Started the review, this is gonna take some time, I will post a feedback today

[allgandalf]

@wildan-m just to be sure, this PR didn't change any functionality right ? we just updated the report action page to be a component.

@luacmartins do you agree with the new name or should we change it to a different name?

[wildan-m]

@allgandalf yes, the functionality change for chatlistitem will be in the 2nd pr

[wildan-m]

@allgandalf @luacmartins what's your opinion about this additional memo logic?

.......
        prevProps.draftMessage === nextProps.draftMessage &&
        prevProps.iouReport?.reportID === nextProps.iouReport?.reportID &&
        lodashIsEqual(prevProps.emojiReactions, nextProps.emojiReactions) &&
        lodashIsEqual(prevProps.userWallet, nextProps.userWallet) &&
        lodashIsEqual(prevProps.linkedTransactionRouteError, nextProps.linkedTransactionRouteError) &&
        lodashIsEqual(prevProps.reportNameValuePairs, nextProps.reportNameValuePairs) &&
        prevProps.isUserValidated === nextProps.isUserValidated &&
        prevProps.parentReport?.reportID === nextProps.parentReport?.reportID &&
        lodashIsEqual(prevProps.personalDetails, nextProps.personalDetails) &&
        lodashIsEqual(prevProps.blockedFromConcierge, nextProps.blockedFromConcierge) &&
        prevProps.originalReportID === nextProps.originalReportID &&
        prevProps.isArchivedRoom === nextProps.isArchivedRoom &&
        prevProps.isChronosReport === nextProps.isChronosReport &&
        prevProps.doesUserHavePaymentCardAdded === nextProps.doesUserHavePaymentCardAdded

[allgandalf]

what's your opinion about this additional memo logic?

What is the question here ?

[wildan-m]

@allgandalf does that looks good to you? the known issue is when I'm not adding prevProps.emojiReactions to the memo logic the UI will not update before refreshing the page, so I added almost all new extracted props there to avoid similar issue

[wildan-m]

@luacmartins @allgandalf any suggestion for better purification? deleteReportActionDraft will modify non search result data. Not from snapshot_.

I mean, how that function should behave in the search result? should it modify data under snapshot_? or modify actual transaction? or we'll only add mock function and not doing anything?

Hmm I'm not sure how making those props optional helps with my comments.

Did you mean we need to make the extracted props mandatory?

[luacmartins]

I think we can do something like this to a lot of these functions so we can either pass a report object (from the ReportScreen or Search for example, or a reportID that then connects to Onyx). That'd help minimize refactoring existing code to always pass a report object for example, while allowing us to pass the object in new usage.

For the deleteReportActionDraft case, I'm not sure if we need to do anything about it. The context menu should not be available on the Search page, so we shouldn't be able to call this at all.

[wildan-m]

I think we can do something like this to a lot of these functions so we can either pass a report object (from the ReportScreen or Search for example, or a reportID that then connects to Onyx). That'd help minimize refactoring existing code to always pass a report object for example, while allowing us to pass the object in new usage.

@luacmartins thanks for your suggestion, that'd work for 'read' type function, what should we do for 'write' type function like deleteReportActionDraft, toggleEmojiReaction, createDraftTransactionAndNavigateToParticipantSelector, etc. Do we need to extract them with empty function as default ()=>{} ?

Some of these 'write' functions are triggered by useEffect even if we don't display the unwanted components. I believe it makes sense to keep extracting these functions and assign empty functions. @allgandalf @luacmartins what are your thoughts?

[luacmartins]

I think ultimately we want to extract them to make the component pure. For the Search case, we wouldn't need any of them so an empty function seems fine

[allgandalf]

@wildan-m this has conflicts, also let me know if this is ready for final review

[wildan-m]

@allgandalf conflict resolved working on the functions.

@luacmartins I'm aware that isCurrentUserTheOnlyParticipant connected to onyx to get currentUserAccountID but would that also break in the search result? if it will, how the BE will fill currentUserAccountID?

Also, for a function that purely depend on onyx like hasExpense that being used by isClosedExpenseReportWithNoExpenses. would search result directly return isClosedExpenseReportWithNoExpenses value?

/**
 * Whether the provided report has expenses
 */
function hasExpenses(reportID?: string): boolean {
    return !!Object.values(allTransactions ?? {}).find((transaction) => `${transaction?.reportID}` === `${reportID}`);
}

/**
 * Whether the provided report is a closed expense report with no expenses
 */
function isClosedExpenseReportWithNoExpenses(report: OnyxEntry<Report>): boolean {
    return report?.statusNum === CONST.REPORT.STATUS_NUM.CLOSED && isExpenseReport(report) && !hasExpenses(report.reportID);
}

[luacmartins]

@luacmartins I'm aware that isCurrentUserTheOnlyParticipant connected to onyx to get currentUserAccountID but would that also break in the search result? if it will, how the BE will fill currentUserAccountID?

That shouldn't break on Search. But it might be a good idea to make it pure as well so the component is indeed pure in the end.

Also, for a function that purely depend on onyx like hasExpense that being used by isClosedExpenseReportWithNoExpenses. would search result directly return isClosedExpenseReportWithNoExpenses value?

I'm not sure that I understood the question. Do you mean if we can use isClosedExpenseReportWithNoExpenses for Search logic? If that's the question, the answer is that we already use it in MoneyReportPreview which would be shown in the search page.

[wildan-m]

@allgandalf @luacmartins please review this latest changes. Thanks!

[allgandalf]

I will try to finish the review today 👍

[wildan-m]

forReportAction has been renamed to modifiedExpenseMessage

[allgandalf]

Reviewer Checklist

• [x] I have verified the author checklist is complete (all boxes are checked off).
• [x] I verified the correct issue is linked in the ### Fixed Issues section above
• [x] I verified testing steps are clear and they cover the changes made in this PR
  • [x] I verified the steps for local testing are in the Tests section
  • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
  • [x] 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)
  • [x] 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)
• [x] I checked that screenshots or videos are included for tests on all platforms
• [x] I included screenshots or videos for tests on all platforms
• [x] I verified tests pass on all platforms & I tested again on:
  • [x] Android: Native
  • [x] Android: mWeb Chrome
  • [x] iOS: Native
  • [x] iOS: mWeb Safari
  • [x] MacOS: Chrome / Safari
  • [x] MacOS: Desktop
• [x] 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
• [x] I verified proper code patterns were followed (see Reviewing the code)
  • [x] 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).
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [x] 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)
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] If a new component is created I verified that:
  • [x] A similar component doesn't exist in the codebase
  • [x] All props are defined accurately and each prop has a /** comment above it */
  • [x] The file is named correctly
  • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • [x] The only data being stored in the state is data necessary for rendering and nothing else
  • [x] 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)
  • [x] 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)
  • [x] All JSX used for rendering exists in the render method
  • [x] 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
• [x] If any new file was added I verified that:
  • [x] 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
• [x] If a new CSS style is added I verified that:
  • [x] A similar style doesn't already exist
  • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
• [x] 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.
• [x] 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)
• [x] 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.
• [x] 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.
• [x] 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:
  • [x] I verified that all the inputs inside a form are aligned with each other.
  • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
• [x] 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.
• [x] For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
• [x] 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.
• [x] I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

https://github.com/user-attachments/assets/cec37dc3-a8cd-4d6d-974e-95b4dbc7c642

Android: mWeb Chrome

https://github.com/user-attachments/assets/ad91c66e-27a7-42df-b5dd-be678b597ef2

iOS: Native

https://github.com/user-attachments/assets/fe4d8f57-5220-44c5-be9f-c3099a8a5c66

iOS: mWeb Safari

https://github.com/user-attachments/assets/7ea45bb1-0be0-409e-9818-792a78a8be4d

MacOS: Chrome / Safari

https://github.com/user-attachments/assets/cc0648e3-756a-418f-a72a-297ef915e352

MacOS: Desktop

https://github.com/user-attachments/assets/50ad06a5-30db-4d1e-b39e-01ea9405b503

[allgandalf]

Almost done testing, I will finish the checklist today

[luacmartins]

@wildan-m we have conflicts now

[luacmartins]

@allgandalf let's prioritize reviewing this one so we can move on to part 2

[wildan-m]

@luacmartins @allgandalf the conflict has been resolved

[allgandalf]

@allgandalf let's prioritize reviewing this one so we can move on to part 2

Yes, testing it carefully as this affects one of our major component

[wildan-m]

@allgandalf Sure. The PR has been updated with a random test related to the report action item. I believe it functions the same way as it does in staging.

[wildan-m]

@allgandalf I think providing detailed test steps for this PR would be excessive, so I will simply update the general activities.

No specific test required, just ensure that the report action item functions correctly as usual. Ensure these actions works as usual:

• commenting
• sending expenses,
• creating tasks
• add emoji
• reply thread
• mark as unread
• deleting comment

[luacmartins]

@wildan-m we have conflicts again 😞

[wildan-m]

@allgandalf @luacmartins the conflict has been resolved

[luacmartins]

Great job here!

[OSBotify]

:hand: 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[bot]]

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.0.77-0 🚀

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