Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor ReportActionItem to use hooks #18809

Merged
merged 50 commits into from
May 22, 2023

Conversation

jasperhuangg
Copy link
Contributor

Details

Fixed Issues

$ #16264

Tests/QA Steps

[If testing locally perform these using the web proxy]

  1. Sign in with your Expensify account.
  2. Open/create a policy room with report actions. Verify they render correctly and no console errors are thrown.
  3. Scroll to the top of the room. Verify that the created action renders correctly.
  4. Rename this room. Verify the room renamed report action renders correctly.
  5. React to a report action. Verify that it works as expected.
  6. [MOBILE ONLY] Long press on a report action. Verify that the report context menu appears as expected.
  7. Via the report action context menu, edit the report action message. Verify that the ReportActionItemMessageEdit component renders correctly.
  8. Finally verify that no console errors appeared while you were completing these steps.

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
web.mov
Mobile Web - Chrome
mweb-chrome.mov
Mobile Web - Safari
mweb-safari.mov
Desktop
desktop.mov
iOS
ios.mov
Android
android.mov

@jasperhuangg jasperhuangg self-assigned this May 12, 2023
@jasperhuangg jasperhuangg marked this pull request as ready for review May 12, 2023 02:43
@jasperhuangg jasperhuangg requested a review from a team as a code owner May 12, 2023 02:43
@melvin-bot melvin-bot bot requested review from danieldoglas and thesahindia and removed request for a team May 12, 2023 02:44
@melvin-bot
Copy link

melvin-bot bot commented May 12, 2023

@thesahindia @danieldoglas 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]

Copy link
Contributor

@0xmiros 0xmiros left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few bugs I noticed related to ref:

  • Long press doesn't work on native
ios.error.mov
  • console error

console

@0xmiros
Copy link
Contributor

0xmiros commented May 17, 2023

@jasperhuangg sorry, another conflict

@jasperhuangg
Copy link
Contributor Author

jasperhuangg commented May 17, 2023

@0xmiroslav good for another look! Fixed everything you mentioned above.

@jasperhuangg jasperhuangg requested a review from 0xmiros May 17, 2023 20:09
@0xmiros
Copy link
Contributor

0xmiros commented May 21, 2023

@jasperhuangg lint failing

src/styles/getTooltipStyles.js Outdated Show resolved Hide resolved
jasperhuangg and others added 2 commits May 22, 2023 06:54
Co-authored-by: Miroslav Stevanovic <97473779+0xmiroslav@users.noreply.github.com>
Co-authored-by: Miroslav Stevanovic <97473779+0xmiroslav@users.noreply.github.com>
0xmiros
0xmiros previously approved these changes May 21, 2023
@marcaaron
Copy link
Contributor

@jasperhuangg I think the next time you fix conflicts here you should just ping in #engineering-chat and grab whoever is around to review asap.

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thats some great hooks refactor here, thanks for getting through it @jasperhuangg!

@mountiny
Copy link
Contributor

Given the previous approvals and completed checklists, I am going to merge this to avoid further conflicts

@mountiny mountiny merged commit 4e39d5d into main May 22, 2023
@mountiny mountiny deleted the jasper-refactorReportActionItemHooks1 branch May 22, 2023 23:03
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.17-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.17-5 🚀

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


componentDidUpdate(prevProps) {
if (prevProps.draftMessage || !this.props.draftMessage) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coming from #23886

Sometimes, the component will re-render when it is out of focus or the page reloaded, making the input focus unnecessary. To prevent this, we should keep the check against the previous draftMessage, and only focus the input if the draftMessage is changed.

Comment on lines +452 to +464
memo(
ReportActionItem,
(prevProps, nextProps) =>
prevProps.displayAsGroup === nextProps.displayAsGroup &&
prevProps.draftMessage === nextProps.draftMessage &&
prevProps.isMostRecentIOUReportAction !== nextProps.isMostRecentIOUReportAction &&
prevProps.hasOutstandingIOU === nextProps.hasOutstandingIOU &&
prevProps.shouldDisplayNewMarker === nextProps.shouldDisplayNewMarker &&
!_.isEqual(prevProps.action, nextProps.action) &&
lodashGet(prevProps.report, 'statusNum') === lodashGet(nextProps.report, 'statusNum') &&
lodashGet(prevProps.report, 'stateNum') === lodashGet(nextProps.report, 'stateNum') &&
prevProps.translate === nextProps.translate,
),
Copy link
Contributor

@s77rt s77rt May 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is missing the check for preferredSkinTone prop changes. Coming from #42058

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants