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

Use native KeyboardAvoidingView component everywhere #11586

Merged
merged 25 commits into from
Oct 28, 2022

Conversation

tgolen
Copy link
Contributor

@tgolen tgolen commented Oct 4, 2022

There are a couple of extra things that I threw into this PR that don't need any testing.

  • I renamed the FAB to "FloatingActionButton" so that it's clear what it is.
  • I increased the max cache key count which helps reliability with large accounts (many reports)

[Tracking Issue]

Fixed Issues

$ #11118
$ #10905

Tests

🎯 LHN - The green + button moves

iPad, Android and iOS

⚠️ DON'T MISS THAT THIS IS TO BE TESTED ON AN iPAD ⚠️

  1. Open the app and login with any account
  2. Click on the green ➕ button
  3. Select New Chat or New Group and then click the "x" to close the modal
  4. Verify that the green ➕ is back in it's original position
Web / Desktop

Do the same test as above. There won't be any keyboard, so just verify that the page looks correct and there are no weird styles or gaps anywhere.

Screenshot iPad

image

Screenshot iPad mobile web

image

Screenshot Android native

image

Screenshot Android mobile web

image

Screenshot iOS native

image

Screenshot iOS mobile web

image

Screenshot Web

image

Screenshot Desktop

image


🎯 Keyboard covers input on a chat with a draft

Android and iOS only
  1. Go to a chat that is both pinned and has a draft
  2. Tap into the compose box
  3. Verify the keyboard does not cover the comment input field
Web / Desktop

Do the same test as above. There won't be any keyboard, so just verify that the page looks correct and there are no weird styles or gaps anywhere.

Screenshot Android native

image

Screenshot Android mobile web

image

Screenshot iOS native

image

Screenshot iOS mobile web

image

Screenshot Web

image

Screenshot Desktop

image


  • Verify that no errors appear in the JS console

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 */
    • Any functional components have the displayName property
    • 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 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 */
    • Any functional components have the displayName property
    • 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.

QA Steps

Follow all the steps in the above testing section

  • Verify that no errors appear in the JS console

@tgolen tgolen self-assigned this Oct 12, 2022
@tgolen tgolen changed the title Tgolen animatedkeyboard Use native KeyboardAvoidingView component everywhere Oct 13, 2022
Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

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

Recordings: #11586 (comment)
Checklist: #11586 (comment)

Based on current Tests, On iPad, a blocking view is added to chat list while the keyboard is active

C+ Reviewed
🎀 👀 🎀

@Santhosh-Sellavel
Copy link
Collaborator

@tgolen
Requesting a price increase for this review!

@tgolen
Copy link
Contributor Author

tgolen commented Oct 28, 2022

@ctkochan22 Can you please have a final look and merge this?

@tgolen
Copy link
Contributor Author

tgolen commented Oct 28, 2022

Requesting a price increase for this review!

I'm approving a payment of $750 for this 👍

@Santhosh-Sellavel
Copy link
Collaborator

Thanks 👍 @tgolen

@ctkochan22
Copy link
Contributor

Everything is checked off, i'm going to merge

@ctkochan22 ctkochan22 merged commit d0dc566 into main Oct 28, 2022
@ctkochan22 ctkochan22 deleted the tgolen-animatedkeyboard branch October 28, 2022 17:49
@melvin-bot melvin-bot bot added the Emergency label Oct 28, 2022
@melvin-bot
Copy link

melvin-bot bot commented Oct 28, 2022

@ctkochan22 looks like this was merged without the checklist test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@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 @ctkochan22 in version: 1.2.22-0 🚀

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

@tgolen
Copy link
Contributor Author

tgolen commented Nov 1, 2022

@jliexpensify For this PR, @Santhosh-Sellavel was the C+ that reviewed this. I believe they normally get paid $250 for reviewing. Because this was such a large PR and process, I have approved for them to be paid $750 instead. Does that make sense?

@jliexpensify
Copy link
Contributor

Created job: https://www.upwork.com/ab/applicants/1587571561956552704/job-details

Invited @Santhosh-Sellavel. Just to confirm: are we waiting the requisite 7 days after deployment, or am I ok to pay now?

@Daniabbasi25
Copy link

Created job: https://www.upwork.com/ab/applicants/1587571561956552704/job-details

Invited @Santhosh-Sellavel. Just to confirm: are we waiting the requisite 7 days after deployment, or am I ok to pay now?

Hi, hope you are doing well. I read issue #11586 on GitHub and found that the theKeyboardAvoidingView issue I will resolve it. React Native provide a KeyboardAvoidingView I will rap the view inside this that cause a problem and it will automatically adjust its height position and bottom padding depending upon the keyboard size. It will work on all platforms.

@tgolen
Copy link
Contributor Author

tgolen commented Nov 2, 2022

@jliexpensify You can still wait the requisite 7 days.

@Daniabbasi25 Thanks for taking an interest on this issue. We have implemented the keyboardAvoidingView everywhere, so we are all good!

@OSBotify
Copy link
Contributor

OSBotify commented Nov 2, 2022

🚀 Deployed to production by @Julesssss in version: 1.2.22-3 🚀

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

@Santhosh-Sellavel
Copy link
Collaborator

Created job: https://www.upwork.com/ab/applicants/1587571561956552704/job-details

Invited @Santhosh-Sellavel. Just to confirm: are we waiting the requisite 7 days after deployment, or am I ok to pay now?

Accepted invite, thanks!

@jliexpensify
Copy link
Contributor

Cool, I'll make a note to pay in 2 days!

@parasharrajat
Copy link
Member

Heads up! There is a regression from this PR #12480

@jliexpensify
Copy link
Contributor

Thanks Rajat - I'll hold off on payment then.

@Santhosh-Sellavel
Copy link
Collaborator

@jliexpensify
Here is @tgolen'comment #12480 (comment)

Hi all, due to the work I did in #11586, which probably forced a regression in this area, please don't hold any regressions against the contributor.

@jliexpensify
Copy link
Contributor

Thanks for digging that up @Santhosh-Sellavel , I'll pay now.

@jliexpensify
Copy link
Contributor

Paid @Santhosh-Sellavel and job has been closed in Upworks.

<AnimatedIcon src={Expensicons.Plus} fill={fill} />
</AnimatedPressable>
</Tooltip>
<KeyboardAvoidingView behavior="padding">
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was a mistake to add because it created duplicate keyboard avoiding views. This was caught in the issue here: #10905

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The other one is in BaseScreenWrapper

@@ -1,18 +0,0 @@
/*
* This is a KeyboardAvoidingView only enabled for ios && disabled for all other platforms
Copy link
Contributor Author

Choose a reason for hiding this comment

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

When this file was removed, it led to a lot of regressions by having Android use <KeyboardAvoidingView>. We found in #11087 that it's best to not use <KeyboardAvoidingView> on Android at all.

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.

7 participants