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

[navigation-refactor ] Disable KeyboardAvoidingView for the BaseSidebarScreen and fix KeyboardAvoidingView used with react-freeze #21124

Conversation

adamgrzybowski
Copy link
Contributor

@adamgrzybowski adamgrzybowski commented Jun 20, 2023

Details

Disable the KeyboardAvoidingView for the chat list screen. It should prevent the glitch described in the issue.

I couldn't find any use case for this functionality on this screen so I am assuming it's not necessary.

NOTE: KeyboardAvoidingView is used only in a file with ios.js extension so these changes shouldn't affect other platforms. For other platforms, it's simply a View component.

NOTE 2: There is a patch included so make sure to install it

Fixed Issues

$ #20514
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

  1. Open iOS app
  2. Open a chat
  3. Long press a message in chat that doesn't have a thread
  4. Tap "Reply in thread" (make sure that the keyboard is visible if you are using simulator, cmd + K)
  5. Swipe thread screen to the right to close it and land in chat
  6. Swipe chat screen to the right to close it and land in LHN
  7. Verify that there is no glitch (part of the list hidden under overlay)

It looks like sometimes you may need to repeat these actions a few times to reproduce this bug, so make sure to test it well.

  • 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 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Mobile Web - Chrome
androidWeb.mov
Mobile Web - Safari
iosWeb.mov
Desktop
iOS
ios.mov
Android
android.mov

@adamgrzybowski adamgrzybowski requested a review from a team as a code owner June 20, 2023 14:34
@melvin-bot melvin-bot bot removed the request for review from a team June 20, 2023 14:34
@melvin-bot
Copy link

melvin-bot bot commented Jun 20, 2023

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

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.

Interesting, thanks for the fix, I have started the build so we can test this on device.

@fedirjh Would you be able to test this one, I think you said you were able to repro in simulator too

@OSBotify
Copy link
Contributor

@mountiny
Copy link
Contributor

Tested the builds and seems to be working well for me on iOS native and mWeb 🎉

RPReplay_Final1687276656.mp4
RPReplay_Final1687276326.mp4

mountiny
mountiny previously approved these changes Jun 20, 2023
@adamgrzybowski
Copy link
Contributor Author

Let's wait with this one for a moment. It fixes the problem with the sidebar but @WoLewicki discovered that it may also occur for different screens (e.g. report screen)

We are looking for a more complete solution

@adamgrzybowski
Copy link
Contributor Author

Here you can see the problem that we found #20514 (comment)

@mountiny
Copy link
Contributor

thanks for an update!

mountiny
mountiny previously approved these changes Jun 23, 2023
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.

Changes look good to me, SWM will handle creating an upstream PR so we can remove this patch.

I will have limited availability next week, feel free to merge this once its ready @amyevans 🙇 thank you!

@fedirjh are you able to test this pr thoroughly?

@adamgrzybowski
Copy link
Contributor Author

Hey, I updated the patch with the code that I proposed here facebook/react-native#38074 to fix this upstream

@fedirjh
Copy link
Contributor

fedirjh commented Jun 26, 2023

@adamgrzybowski there is a weird behaviour on IOS safari when you navigate back from thread to parent report

Screen.Recording.2023-06-26.at.8.09.53.PM.mov

@adamgrzybowski
Copy link
Contributor Author

adamgrzybowski commented Jun 27, 2023

Hey, @fedirjh

@adamgrzybowski there is a weird behaviour on IOS safari when you navigate back from thread to parent report

Good catch but I think this is a candidate for a separate issue.

It's related to the keyboard but not to the KeyboardAvoidingView. This component is used only in the iOS app. So it may be a little out of the scope of this PR.

This PR still should fix the problem with the glitch on iOS app
cc: @mountiny

@fedirjh
Copy link
Contributor

fedirjh commented Jun 27, 2023

This component is used only in the iOS app. So it may be a little out of the scope of this PR.

@adamgrzybowski Aren’t we disabling the KeyboardAvoidingView for all platforms ?

@fedirjh
Copy link
Contributor

fedirjh commented Jun 27, 2023

For IOS the tests looks good to me

Test1.mp4
Test2.mp4

@adamgrzybowski
Copy link
Contributor Author

@adamgrzybowski Aren’t we disabling the KeyboardAvoidingView for all platforms ?

Yeah, this issue evolved a little 😄 I will update the title of this PR. What we are doing currently is:

  • Disable the KeyboardAvoidingView for the BaseSidebarScreen
  • Fix the KeyboardAvoidingView so it won't break after freeze (e.g report screen is using freeze)

But the KeyboardAvoidingView is used only in the iOS native app. For other platforms, it's just <View>

What you can observe in the browser is another mechanism. I guess it's just changing the size of the website to make room for the keyboard. But it's not handled by this component.

@adamgrzybowski adamgrzybowski changed the title [navigation-refactor ] Disable KeyboardAvoidingView for the BaseSidebarScreen [navigation-refactor ] Disable KeyboardAvoidingView for the BaseSidebarScreen and fix KeyboardAvoidingView used with react-freeze Jun 27, 2023
@fedirjh
Copy link
Contributor

fedirjh commented Jun 27, 2023

@adamgrzybowski Thank you for the clarification 🙌🏼 , that make sense, I think we should handle other case separately.

@fedirjh
Copy link
Contributor

fedirjh commented Jun 27, 2023

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 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(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 Screenshot 2023-06-27 at 7 07 33 PM
Mobile Web - Chrome
Chrome.mov
Mobile Web - Safari
Safari.mov
Desktop Screenshot 2023-06-27 at 7 09 11 PM
iOS
Test1.mp4
Test2.mp4
Android
Android.mov

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

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

LGTM and tests well.

All yours @amyevans

@amyevans
Copy link
Contributor

For the iOS Safari bug identified, do you want me to create a bug issue and assign to you @adamgrzybowski or should we just send it through the regular bug reporting workflow (open to the community for proposals)?

Copy link
Contributor

@amyevans amyevans left a comment

Choose a reason for hiding this comment

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

Code looks good. I tested on both a sim and real device and it tests well.

🚀

@amyevans
Copy link
Contributor

For the iOS Safari bug identified, do you want me to create a bug issue and assign to you @adamgrzybowski or should we just send it through the regular bug reporting workflow (open to the community for proposals)?

@fedirjh want to report it in #expensify-bugs and collect the bounty? We can then assign @adamgrzybowski, or not, based on his answer

@amyevans amyevans merged commit e029bb1 into Expensify:main Jun 27, 2023
@melvin-bot
Copy link

melvin-bot bot commented Jun 27, 2023

Congrats, that’s your 5th PR merged! 🎉 Do you know about the ContributorPlus role? It’s an opportunity to earn more in the Expensify Open Source community. Keep up the great work - thanks!

@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.

@fedirjh
Copy link
Contributor

fedirjh commented Jun 27, 2023

want to report it in #expensify-bugs and collect the bounty?

Reported here https://expensify.slack.com/archives/C049HHMV9SM/p1687902430669059.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.34-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.3.34-1 🚀

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

- if (duration && easing) {
+ this._setBottom(height);
+
+ if (enabled && duration && easing) {
Copy link
Contributor

Choose a reason for hiding this comment

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

This line was overlooked and caused #22206. enabled should be replaced with this.props.enabled.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should I create a new PR for that? @0xmiroslav

Copy link
Contributor

@0xmiros 0xmiros Jul 10, 2023

Choose a reason for hiding this comment

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

@adamgrzybowski there's already PR from contributor. You can still review and approve it.

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

Successfully merging this pull request may close these issues.

6 participants