Upgrade react-navigation/drawer to use our fork

[roryabraham]

Details

Upgrades @react-navigation/drawer to use our fork (published with gitpkg), to take advantage of this PR

Fixed Issues

$ #11915

Tests / QA Steps (iOS, Android, mWeb)

1. Open a chat
2. Click on the compose input to open the keyboard
3. Scroll the chat
4. Verify that the keyboard stays open
5. Click on the compose input to open the keyboard
6. Start typing until the arrows appear in the input, giving you the option to expand it.
7. Click on those arrows to expand the keyboard input
8. Verify that the keyboard remains focused and that you can keep typing your message without having to open the software keyboard again. (note – we know this doesn't work correctly on mobile web, ignore that for the sake of this PR's QA)
9. Long-press on the text input. Verify that the keyboard does not close and reopen when doing so.
10. Copy some text to your clipboard from a note or somewhere else.
11. Paste the text into the text input. It should work (i.e: long-press should work on iOS and Android)

• Verify that no errors appear in the JS console

Tests / QA Steps (Web, desktop)

Perform some basic regression tests on the drawer component. Verify that you can switch between chats as usual.

PR Review Checklist

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 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 included screenshots or videos for tests on all platforms
• I ran the tests on all platforms & verified they passed on:
  • iOS / native
  • Android / native
  • iOS / Safari
  • Android / Chrome
  • MacOS / Chrome
  • 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 was added in all src/languages/* files
  • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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
• 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 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.
• I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

• 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:
  • iOS / native
  • Android / native
  • iOS / Safari
  • Android / Chrome
  • MacOS / Chrome
  • 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 was added in all src/languages/* files
  • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 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.
• I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots

Web

Screen.Recording.2022-10-17.at.4.53.27.PM.mov

Mobile Web - Chrome (iOS)

RPReplay_Final1666050991.MP4

Mobile web – Chrome (Android)

screen-20221017-170121.mp4

Mobile Web - Safari

RPReplay_Final1666051086.MP4

Desktop

Screen.Recording.2022-10-17.at.5.03.47.PM.mov

iOS

RPReplay_Final1666050537.MP4

Android

screen-20221017-170920.mp4

[roryabraham]

Confirmed this works on iOS, still working on testing all platforms and gathering screenshots, but I'm opening this up to reviews so that we can get a C+ and reviewer testing in parallel.

[mountiny]

I see in the iOS video that the composer looses focus after expanding, I assume that is an issue which is unrelated to this update? there has been reports of it here #11944

[mountiny]

@mananjadhav Would you also be able to confirm if sending the message on mobile does not close the keyboard as raised in this bug report? Thank you!

[stitesExpensify]

Mobile web on android seems to be losing focus

2022-10-18_14-31-29.mp4

[mountiny]

@stitesExpensify thanks for testing, I think that is not a blocker as that expand issue was reported a while ago, just wanted to confirm.

I think the more important one to check is the issue with sending a message and the keyboard closing.

[mananjadhav]

@mountiny @roryabraham The keyboard doesn't close when we scroll. Tried on mWeb Safari and iOS. But it does lose focus when we click on the expand.

[hannojg]

Hey, @roryabraham just want to sync with you. I think you used the following PR for the Expensify fork:

• [Drawer] refactor: use GestrueDetector to fix onStart bug  react-navigation/react-navigation#10928

However, this PR is based on the still-in-development react-navigation version 7.x. Maybe that was on purpose as it fixes other issues etc, I don't know exactly.
If not, I'd recommend not going with this still in-dev version, and instead using this PR:

• fix: only call onGestureStart when criteria met in drawer react-navigation/react-navigation#10929

which is for the current react-navigation version 6.x

[aimane-chnaif]

@mountiny @roryabraham The keyboard doesn't close when we scroll. Tried on mWeb Safari and iOS. But it does lose focus when we click on the expand.

Losing focus when click on expand on mWeb is not related to this issue.
It's handled in a separated GH: #11093
@mananjadhav you can just confirm keep focused when click on expand on native apps

[mountiny]

@roryabraham should we update to what @hannojg has suggested? I think we should try to get this out as soon as possible

[roryabraham]

My two cents is that using the latest version of main in our react-navigation is fine even if its still in-development, because it seems to work and solve the problem?

[roryabraham]

The only reason react-navigation/react-navigation#10928 needs to target react-navigation 7 is because it relies on react-native-gesture-handler 2, and right now react-navgiation 6 has a peer dependency with react-native-gesture-handler >= 1. So that means requiring RNGH 2 is a breaking change.

This isn't a concern for us here, because we're already using react-native-gesture-handler 2.6

[mountiny]

Would be great to get this fix out sooner than later, but my mobile setup locally is not working right now, @mananjadhav would you be able to test this properly and fill in the PR reviewer checklist for us please? If everything is fine we can merge this, lots of annoying issues will be fixed.

[parasharrajat]

@mananjadhav Could you please test this #11684 (comment) bug on this PR as well?

[mananjadhav]

Team,
@roryabraham @mountiny I've tested the changes. Except mWeb focus, the tests are all working fine.

@parasharrajat I tested the Android composer long press issue as well. I hope I got the reproduction step right.

🎀 👀 🎀 
C+ reviewed

• 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:
  • iOS / native
  • Android / native
  • iOS / Safari
  • Android / Chrome
  • MacOS / Chrome
  • 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 was added in all src/languages/* files
  • 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 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.
• I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots

Web

web-rn-nav-upgrade.mov

Mobile Web - Chrome

mweb-android-rn-nav-upgrade.mov

Mobile Web - Safari

mweb-safari-rn-nav-upgrade.mov

Desktop

desktop-rn-nav-upgrade.mov

iOS

ios-rn-nav-upgrade.mov

Android

android-rn-nav-upgrade.mov

Long press Composer

android-long-press-composer.mov

[hannojg]

Oh yeah @roryabraham I see, that's fine. So you took their main branch and put the PR on top of it. Yes that sounds correct 👍 (the PR is compatible with their main branch and their 7.x branch)

[github-actions]

⚠️ ⚠️ Heads up! This pull request has the CP Staging label. ⚠️ ⚠️
Merging it will cause it to be immediately deployed to staging, even if the open StagingDeployCash deploy checklist is locked.

[mountiny]

Adding the CP Staging label to get this out sooner than later since it is evry annoying bug.

[mountiny]

@mananjadhav thanks for such rigorous testing 🙇

[melvin-bot]

@mountiny looks like this was merged without the Run e2e performance regression tests test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

[mountiny]

Everything passed 😡

[OSBotify]

🚀 Cherry-picked to staging by @mountiny in version: 1.2.18-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

[OSBotify]

🚀 Cherry-picked to staging by @mountiny in version: 1.2.18-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

[OSBotify]

🚀 Deployed to production by @chiragsalian in version: 1.2.18-10 🚀

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

[OSBotify]

🚀 Cherry-picked to staging by https://github.com/AndrewGable in version: 1.3.28-2 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

[OSBotify]

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.28-5 🚀

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