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

Extract gesture logic from MultiGestureCanvas to hooks and improve code #33756

Merged

Conversation

chrispader
Copy link
Contributor

@chrispader chrispader commented Dec 29, 2023

@pecanoro @aimane-chnaif

Details

This PR extracts gesture code to separate hooks for more readability and easier error-tracking. (usePinchGesture, useTapGestures, usePanGesture)

It also improves some variable names and general code patterns.

This PR also adds TS types for many of the components used within the attachment gallery. Original TS migration PR: #33081

Fixed Issues

$
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console
  1. Go to a report
  2. Open image attachment
  3. Check that all gestures and carousel functionality works as expected

Offline tests

None needed.

QA Steps

  • Verify that no errors appear in the JS console

Same as in Tests, though there should be no change in functionality.

Especially check for (console) errors on all platforms...

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 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 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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.
  • 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
Screen_Recording_20240122_115117_New.Expensify.Dev.mp4
Android: mWeb Chrome
iOS: Native
Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-01-22.at.11.50.00.mp4
iOS: mWeb Safari
MacOS: Chrome / Safari
Screen.Recording.2024-01-22.at.11.57.39.mov
MacOS: Desktop

Added iOS Native, Android Native and web screen recordings. Web platforms are technically not affected by these changes...

@chrispader chrispader marked this pull request as ready for review December 29, 2023 13:54
@chrispader chrispader requested a review from a team as a code owner December 29, 2023 13:54
@melvin-bot melvin-bot bot requested review from tgolen and removed request for a team December 29, 2023 13:55
Copy link

melvin-bot bot commented Dec 29, 2023

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

@chrispader chrispader changed the title Re-structure MultiGestureCanvas: Extract gesture logic to hooks Extract gesture logic from MultiGestureCanvas to hooks Dec 29, 2023
Copy link
Contributor

@aimane-chnaif aimane-chnaif left a comment

Choose a reason for hiding this comment

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

performance tests are failing

@chrispader
Copy link
Contributor Author

performance tests are failing

not sure why it failed. now it's working

@chrispader chrispader changed the title Extract gesture logic from MultiGestureCanvas to hooks Extract gesture logic from MultiGestureCanvas to hooks and improve code Dec 29, 2023
Copy link
Contributor

@tgolen tgolen left a comment

Choose a reason for hiding this comment

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

I am a fan of cleaning this up! It could be much better with improved code comments. I probably don't understand 80% of the code that is here and why it's necessary or what it does. Could you take a full pass on this code and do the following:

  1. Make sure comments are consistently formatted (start with a capital letter, use consistent line length limits, use proper grammar)
  2. Make sure comments describe WHY the logic is there
  3. Code that isn't self-explanatory gets a comment

src/components/MultiGestureCanvas/usePanGesture.js Outdated Show resolved Hide resolved
src/components/MultiGestureCanvas/usePanGesture.js Outdated Show resolved Hide resolved
src/components/MultiGestureCanvas/usePanGesture.js Outdated Show resolved Hide resolved
src/components/MultiGestureCanvas/usePanGesture.js Outdated Show resolved Hide resolved
src/components/MultiGestureCanvas/usePanGesture.js Outdated Show resolved Hide resolved
src/components/MultiGestureCanvas/usePanGesture.js Outdated Show resolved Hide resolved
src/components/MultiGestureCanvas/utils.ts Outdated Show resolved Hide resolved
src/components/MultiGestureCanvas/useTapGestures.js Outdated Show resolved Hide resolved
@chrispader
Copy link
Contributor Author

@pecanoro addressed all your comments! Lmk if there is anything else :)

Copy link
Contributor

@pecanoro pecanoro left a comment

Choose a reason for hiding this comment

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

Thank you for all the comments, it made the code much easier for whoever has no experience with it or is new to the codebase! ❤️

@aimane-chnaif
Copy link
Contributor

@chrispader please merge main. Hopefully it will fix perf-tests.
Node version was bumped in #35272

@pecanoro
Copy link
Contributor

@chrispader Can you merge with main? I think we updated node and tests are failing due to that.

@chrispader
Copy link
Contributor Author

@chrispader Can you merge with main? I think we updated node and tests are failing due to that.

done! @pecanoro

@chrispader
Copy link
Contributor Author

JFYI @pecanoro @aimane-chnaif @s77rt

If possible, it would be great to merge this today, because i'm gonna be 100% OOO from 31/01/2024 - 17/03/2024.

I'm available all day for any comments on this PR!

@chrispader
Copy link
Contributor Author

Additionally, there is one more PR that i have been working on which is waiting for this one to be merged first. Going to update it and merge main, so maybe we can merge it too.

#34080

@chrispader
Copy link
Contributor Author

@pecanoro all checks have passed!

@pecanoro
Copy link
Contributor

Awesome! Merging since Tim is OOO. I did my best with the review, it's a big PR so hopefully I didn't miss anything important.

@pecanoro pecanoro merged commit 523656d into Expensify:main Jan 29, 2024
26 checks passed
@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/pecanoro in version: 1.4.33-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.33-5 🚀

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

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