Remove class component from `ReportActionsList` #16613

marcaaron · 2023-03-28T14:14:08Z

Details

Refactors the ReportActionsList to use React Hooks.

Fixed Issues

$ #16266

Tests

Load a chat with a reasonable number of report actions / messages (tested against production with live chat data)
Verify everything looks good and that the performance is OK
Verify the animations look normals and there are no regressions.

Verify that no errors appear in the JS console

Offline tests

QA Steps

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 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 correct English and 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 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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

tomekzaw · 2023-03-28T14:34:26Z

src/pages/home/report/ReportActionsList.js

+// This is a workaround to a reanimated issue -> https://github.com/software-mansion/react-native-reanimated/issues/3355
+if (process.browser) {
+    // eslint-disable-next-line no-underscore-dangle
+    window._frameTimestamp = null;
+}


It looks like software-mansion/react-native-reanimated#3355 was fixed in software-mansion/react-native-reanimated@2fd0da8 which was released in 3.0.0, however you're still using 3.0.0-rc.10. It's okay to keep this workaround as for now but once you upgrade to 3.0.0+ (currently the latest version is 3.0.2) you should be safe to get rid of it.

Hey there :-)
Using reanimated@3.0.2 I still seem to have this problem with next.js unfortunately.
next.js version is 12.1.5
The workaround from above still seems to work.

marcaaron · 2023-04-10T18:39:07Z

Had some time to test this one so taking it out of draft.

MelvinBot · 2023-04-10T18:39:45Z

@s77rt @dangrous One of you needs to 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]

s77rt · 2023-04-10T21:19:22Z

src/pages/home/report/ReportActionsList.js

+// Workaround to a reanimated issue -> https://github.com/software-mansion/react-native-reanimated/issues/3355
+// We can remove it as soon as we are on > reanimated 3.0.0+
+if (process.browser) {
+    // eslint-disable-next-line no-underscore-dangle
+    window._frameTimestamp = null;
+}
+


Shouldn't this workaround be used in a Top Level since we may need it for other components too.

Good point. I think it can.

s77rt · 2023-04-10T21:21:10Z

src/pages/home/report/ReportActionsList.js

+function keyExtractor(item) {
+    return item.reportActionID;
+}


Why this function is defined outside ReportActionsList Wouldn't it be better to define it inside and useCallback with empty dependency array.

We had some conversation here about it: https://expensify.slack.com/archives/C01GTK53T8Q/p1680096510744619

I don't have a strong preference though and just going with what we decided there. Can you think of some different or better arguments on why to do what you suggest?

Just thought that since keyExtractor was a part of the class component it should still be a part of the functional component but maybe having that function a part of the class component was a "mistake" in the first place.

I think having the function defined outside is slightly better e.g. If we render 100 instances of that component all will use the same function, where if we defined it inside each will use it's own function (100 functions that are all the same).

s77rt · 2023-04-11T00:45:57Z

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 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 correct English and 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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

s77rt

LGTM! 🚀

dangrous

Looks great! Awesome (for me) to see this before I work on my own, too, haha.

Will wait to merge in case there are any last comments from @johkade or @tomekzaw but I'm guessing we're probably fine

OSBotify · 2023-04-12T23:19:28Z

✋ 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 · 2023-04-13T03:43:21Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.0-0 🚀

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

OSBotify · 2023-04-17T22:57:47Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.0-2 🚀

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

marcaaron added 2 commits March 27, 2023 18:24

ReportActionsList

15464a6

Refactor ReportActionsList to use hooks

249a0e1

marcaaron self-assigned this Mar 28, 2023

marcaaron changed the base branch from main to marcaaron-eslintHooks March 28, 2023 14:14

marcaaron changed the base branch from marcaaron-eslintHooks to main March 28, 2023 14:14

Fix conflicts

4e2cf54

tomekzaw reviewed Mar 28, 2023

View reviewed changes

marcaaron added 5 commits March 29, 2023 15:57

Merge remote-tracking branch 'origin' into marcaaron-reportActionsList

18775b4

clarify workaround

edcdd2e

add opacity to dependenc

a008a9b

Merge remote-tracking branch 'origin' into marcaaron-reportActionsList

03f8353

Merge remote-tracking branch 'origin' into marcaaron-reportActionsList

ac43cca

marcaaron changed the title ~~[WIP] report actions list~~ Remove class component from ReportActionsList Mar 31, 2023

marcaaron added 2 commits April 10, 2023 06:13

Merge remote-tracking branch 'origin' into marcaaron-reportActionsList

c108207

clean up variable and comment

4618517

marcaaron marked this pull request as ready for review April 10, 2023 18:39

marcaaron requested a review from a team as a code owner April 10, 2023 18:39

melvin-bot bot requested review from dangrous and s77rt and removed request for a team April 10, 2023 18:39

s77rt suggested changes Apr 10, 2023

View reviewed changes

marcaaron added 2 commits April 10, 2023 11:44

move workaround to global setup

a5ef63d

Merge remote-tracking branch 'origin' into marcaaron-reportActionsList

c274425

s77rt approved these changes Apr 11, 2023

View reviewed changes

dangrous approved these changes Apr 11, 2023

View reviewed changes

marcaaron merged commit 7dff903 into main Apr 12, 2023

marcaaron deleted the marcaaron-reportActionsList branch April 12, 2023 23:13

OSBotify mentioned this pull request Apr 13, 2023

Deploy Checklist: New Expensify 2023-04-13 #17379

Closed

26 tasks

MelvinBot mentioned this pull request Apr 17, 2023

[HOLD for payment 2023-04-24] [$250] Migrate ReportActionsList.js to function component #16266

Closed

1 task

therealsujitk mentioned this pull request May 8, 2023

[$4000] Android - Chat - Empty chat (black screen) is displayed instead of messages #17870

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove class component from `ReportActionsList` #16613

Remove class component from `ReportActionsList` #16613

marcaaron commented Mar 28, 2023 •

edited

Loading

tomekzaw Mar 28, 2023

johkade Apr 2, 2023 •

edited

Loading

marcaaron commented Apr 10, 2023

MelvinBot commented Apr 10, 2023

s77rt Apr 10, 2023

marcaaron Apr 10, 2023

s77rt Apr 10, 2023

marcaaron Apr 10, 2023

s77rt Apr 10, 2023

s77rt commented Apr 11, 2023

s77rt left a comment

dangrous left a comment

OSBotify commented Apr 12, 2023

OSBotify commented Apr 13, 2023

OSBotify commented Apr 17, 2023

Remove class component from ReportActionsList #16613

Remove class component from ReportActionsList #16613

Conversation

marcaaron commented Mar 28, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

tomekzaw Mar 28, 2023

Choose a reason for hiding this comment

johkade Apr 2, 2023 • edited Loading

Choose a reason for hiding this comment

marcaaron commented Apr 10, 2023

MelvinBot commented Apr 10, 2023

s77rt Apr 10, 2023

Choose a reason for hiding this comment

marcaaron Apr 10, 2023

Choose a reason for hiding this comment

s77rt Apr 10, 2023

Choose a reason for hiding this comment

marcaaron Apr 10, 2023

Choose a reason for hiding this comment

s77rt Apr 10, 2023

Choose a reason for hiding this comment

s77rt commented Apr 11, 2023

Reviewer Checklist

Screenshots/Videos

s77rt left a comment

Choose a reason for hiding this comment

dangrous left a comment

Choose a reason for hiding this comment

OSBotify commented Apr 12, 2023

OSBotify commented Apr 13, 2023

OSBotify commented Apr 17, 2023

Remove class component from `ReportActionsList` #16613

Remove class component from `ReportActionsList` #16613

marcaaron commented Mar 28, 2023 •

edited

Loading

johkade Apr 2, 2023 •

edited

Loading