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

Upgrade RNGestureHandler and use the new API everywhere #34101

Merged

Conversation

j-piasecki
Copy link
Contributor

@j-piasecki j-piasecki commented Jan 8, 2024

Details

Updates RNGestureHandler to the newest version (2.14.0) and updates its usage to utilize the gesture API instead of the deprecated useAnimatedGestureHandler hook. It also enables the new web implementation, which is incompatible with useAnimatedGestureHandler (it was disabled by me in #24152 to quickly work around issues coming from this).

Also adds a temporary patch for a PR that's already merged upstream: software-mansion/react-native-gesture-handler#2709.

Fixed Issues

$
PROPOSAL: https://swmansion.slack.com/archives/C04878MDF34/p1702979039829019

Tests

This PR changes code related to the magic code input, growl notifications, and avatar picker.
Tests for magic code input:

  1. Enter e-mail
  2. Verify that clicking on code input focuses the relevant field

Tests for growl notifications:

  1. Do any action that results in a growl notification being shown
  2. Verify that the notification can be dismissed by swiping it up

Tests for avatar picker:

  1. Go to Settings -> Profile -> Upload photo -> Choose any image
  2. Verify that zooming on image works
  3. Verify that the zoomed image can be moved
  4. Verify that the image can be rotated
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

This PR changes code related to the magic code input, growl notifications, and avatar picker.
Tests for magic code input:

  1. Enter e-mail
  2. Verify that clicking on code input focuses the relevant field

Tests for growl notifications:

  1. Do any action that results in a growl notification being shown
  2. Verify that the notification can be dismissed by swiping it up

Tests for avatar picker:

  1. Go to Settings -> Profile -> Upload photo -> Choose any image
  2. Verify that zooming on image works
  3. Verify that the zoomed image can be moved
  4. Verify that the image can be rotated
  • 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: 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
android-avatar.mov
android-input.mov
android-notification.mov
Android: mWeb Chrome
android-chrome-input.mov
android-chrome-notification.mov
android-chrome-avatar.mov
iOS: Native
ios-avatar.mov
ios-input.mov
ios-notification.mov
iOS: mWeb Safari
ios-safari-avatar.mov
ios-safari-input.mov
ios-safari-notification.mov
MacOS: Chrome / Safari
macos-safari-avatar.mov
macos-safari-input.mov
macos-safari-notification.mov
MacOS: Desktop
desktop-avatar.mov
desktop-magic-code.mov
desktop-notification.mov

Copy link
Contributor

@WoLewicki WoLewicki left a comment

Choose a reason for hiding this comment

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

Left one comment, other than that, LGTM 🚀

src/components/GrowlNotification/index.js Outdated Show resolved Hide resolved
src/components/AvatarCropModal/Slider.js Outdated Show resolved Hide resolved
patches/react-native-gesture-handler+2.14.0.patch Outdated Show resolved Hide resolved
@j-piasecki j-piasecki marked this pull request as ready for review January 12, 2024 15:53
@j-piasecki j-piasecki requested a review from a team as a code owner January 12, 2024 15:53
@melvin-bot melvin-bot bot requested review from rlinoz and removed request for a team January 12, 2024 15:54
Copy link

melvin-bot bot commented Jan 12, 2024

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

@rlinoz
Copy link
Contributor

rlinoz commented Jan 15, 2024

I am having a hard time testing this on iOS, keep getting this error in the two factor screen, I will try to build main to see if there is the same problem.
image

@rlinoz
Copy link
Contributor

rlinoz commented Jan 15, 2024

Yeah, it is not happening in main, maybe the library update is related?

@j-piasecki
Copy link
Contributor Author

Sorry for that, I've accidentally changed the thread the callback was run on. I think when I merged main a few days ago, the new Reanimated was already being used there, resulting in this error.

@rlinoz
Copy link
Contributor

rlinoz commented Jan 17, 2024

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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(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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
Screen.Recording.2024-01-19.at.10.35.27.mov
Screen.Recording.2024-01-19.at.10.35.02.mov
Screen.Recording.2024-01-19.at.10.30.13.mov
Android: mWeb Chrome
WhatsApp.Video.2024-01-19.at.10.45.13.mp4
WhatsApp.Video.2024-01-19.at.10.45.18.1.mp4
WhatsApp.Video.2024-01-19.at.10.45.18.mp4
iOS: Native
Screen.Recording.2024-01-19.at.10.21.57.mov
Screen.Recording.2024-01-19.at.10.21.09.mov
Screen.Recording.2024-01-19.at.10.20.50.mov
iOS: mWeb Safari
Screen.Recording.2024-01-19.at.10.46.25.mov
Screen.Recording.2024-01-19.at.10.46.01.mov
MacOS: Chrome / Safari
Screen.Recording.2024-01-19.at.10.24.47.mov
Screen.Recording.2024-01-19.at.10.25.56.mov
Screen.Recording.2024-01-19.at.10.25.28.mov
MacOS: Desktop
Screen.Recording.2024-01-19.at.10.30.13.mov
Screen.Recording.2024-01-19.at.10.29.56.mov

@rlinoz
Copy link
Contributor

rlinoz commented Jan 19, 2024

Sorry for the delay, I will finish testing this tomorrow.

@rlinoz rlinoz merged commit 0baad0a into Expensify:main Jan 19, 2024
15 of 17 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/rlinoz in version: 1.4.29-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/rlinoz in version: 1.4.29-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.29-1 🚀

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.

5 participants