Migrate ReportActionsView.js to function component

[rayane-djouah]

Details

Fixed Issues

$ #16267
PROPOSAL: #16267 (comment)

Tests

1. Open a report with existing messages.
2. Check the initial render of the component:

• When the component mounts, it should display a list of messages (reportActions).

3. Check the FloatingMessageCounter behavior:

• Mark a message as unread.
• The "New Messages" notification (FloatingMessageCounter) should appear when you scroll up past the newest unread message.
• The "New Messages" notification should disappear when you scroll down past the newest unread message.
• When you click on the "New Messages" notification, it should scroll you down to the bottom of the chat and mark the report as read.

4. Check the handling of new reportActions:

• When a new reportAction is received, the component should scroll to the bottom.

5. Check the component behavior when report actions are marked as unread:

• If a report is manually marked as unread, the component should update the new marker position.

• Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

• Same as tests above.

• 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 / Chrome
  • iOS / native
  • iOS / 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • 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 verified the translation was requested/reviewed 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • 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.js 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 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(themeColors.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 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.
• 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mp4

Mobile Web - Chrome

chrome.mp4

Mobile Web - Safari

safari.mp4

Desktop

desktop.mp4

iOS

ios.mp4

Android

android.mp4

[melvin-bot]

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

[rayane-djouah]

@narefyev91 could you review this PR please?

[rayane-djouah]

I replaced ReportScrollManager with userReportScrollManager hook as suggested here #16267 (comment)

[rayane-djouah]

@narefyev91 could you review please?

[narefyev91]

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 tests pass on all platforms & I tested again on:
  • Android / native
  • Android / Chrome
  • iOS / native
  • iOS / 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 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • 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.js 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(themeColors.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 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.
• 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

Web

web.mov

Mobile Web - Chrome

android-web.mov

Mobile Web - Safari

ios-web.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

[narefyev91]

LGTM
🎀 👀 🎀 C+ reviewed

[melvin-bot]

We did not find an internal engineer to review this PR, trying to assign a random engineer to #16267 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

[bernhardoj]

Sorry, but I have a last request for the change. Can we remove ReportScrollManager file? The last usage of ReportScrollManager is in ReportActionsView, but as we already replace it with the hook, we don't need ReportScrollManager anymore.

[rayane-djouah]

@bernhardoj I removed ReportScrollManager files as you suggest.

[bernhardoj]

thanks!

[rayane-djouah]

@neil-marcellini could you review this PR please?

[neil-marcellini]

Looking pretty great! I do have some questions and small changes requested.

[rayane-djouah]

@neil-marcellini could you review please?

[neil-marcellini]

Thanks for the changes after my last review. It's good to go except one thing that got left out during the refactor.

[neil-marcellini]

@rayane-djouah if you want another review today please send me a message one NewDot when it's ready.

[rayane-djouah]

@neil-marcellini its ready for another review

[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.

[OSBotify]

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 1.3.38-0 🚀

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

[Julesssss]

Possible regression here, please take a look

[rayane-djouah]

@neil-marcellini @narefyev91 should we revert the PR?

[Pujan92]

@rayane-djouah I think you need to raise a new PR for this fix.

[mvtglobally]

we are facing issue understanding the steps. Can someone confirm the below is correct?
@rayane-djouah @narefyev91 @neil-marcellini @bernhardoj

1. Open a report with existing messages.
2. Mark a message as unread
3. The "New Messages" notification should appear when you scroll up past the newest unread message.
4. The "New Messages" notification should disappear when you scroll down past the newest unread message.
5. When you click on the "New Messages" notification, it should scroll you down to the bottom of the chat and mark the report as read.
6. Send the message from Account B to Account B
7. When a new message received, the component should scroll to the bottom.
8. If a report is manually marked as unread, the component should update the new marker position.

[rayane-djouah]

@mvtglobally here is a clarification:

1. Open a report with existing messages.
2. Mark a message as unread
3. The "New Messages" notification should appear when you scroll up past the newest unread message.
4. The "New Messages" notification should disappear when you scroll down past the newest unread message.
5. When you click on the "New Messages" notification, it should scroll you down to the bottom of the chat and mark the report as read.
6. Mark a message as unread.
7. Scroll up past the newest unread message.
8. Send a message in the chat.
9. The component should scroll to the bottom when the message is sent.
10. If a report is manually marked as unread, the component should update the new marker position.

[OSBotify]

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.38-7 🚀

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

[srikarparsi]

Hi! Just wanted to leave a comment on this issue regarding this regression. #22426. The issue was caused because of this if condition:

if (!didSubscribeToReportTypingEvents && didCreateReportSuccessfully) {
     Report.subscribeToReportTypingEvents(props.report.reportID);
     didSubscribeToReportTypingEvents.current = true;
}

In this if condition, we should have used didSubscribeToReportTypingEvents.current as didSubscribeToReportTypingEvents is a useRef value:

if (!didSubscribeToReportTypingEvents.current && didCreateReportSuccessfully) {
     Report.subscribeToReportTypingEvents(props.report.reportID);
     didSubscribeToReportTypingEvents.current = true;
}

[neil-marcellini]

Oh shoot we totally missed that. Thanks for the explanation! Typescript will save us soon!