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

fix: 10731 Focus composer without showing keyboard when users go to chats #32711

Merged
merged 38 commits into from
Sep 30, 2024

Conversation

christianwen
Copy link
Contributor

@christianwen christianwen commented Dec 8, 2023

Details

Fixed Issues

$ #10731
PROPOSAL: #10731 (comment)

Tests

  1. Go to any chats
  2. Verify that the composer is focused and the virtual keyboard is not shown. After touching on the composer, the keyboard is shown
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

  1. Go to any chats
  2. Verify that the composer is focused and the virtual keyboard is not shown. After touching on the composer, the keyboard is shown
  • 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
      • 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

Android: Native
e-android.native.mov
Android: mWeb Chrome
e-android.mweb.mov
iOS: Native
e-ios.mov
iOS: mWeb Safari
e-safari.mov
MacOS: Chrome / Safari
e-web.mov
MacOS: Desktop
e-desktop.mov

@christianwen christianwen marked this pull request as ready for review December 11, 2023 08:45
@christianwen christianwen requested a review from a team as a code owner December 11, 2023 08:45
@melvin-bot melvin-bot bot requested review from Santhosh-Sellavel and removed request for a team December 11, 2023 08:45
Copy link

melvin-bot bot commented Dec 11, 2023

@Santhosh-Sellavel 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]

@christianwen christianwen changed the title fix: 10731 fix: 10731 Focus composer without showing keyboard when users go to chats Dec 11, 2023
@0xmiros
Copy link
Contributor

0xmiros commented Dec 11, 2023

  1. Go to any chats
  2. Verify that the composer is focused and the virtual keyboard is not shown. After touching on the composer, the keyboard is shown

I am not sure if this is the expected behavior. @ntdiary can you confirm this doesn't conflict with your refactor?

@Santhosh-Sellavel
Copy link
Collaborator

I am not sure if this is the expected behavior.
@0xmiroslav Can you add more context for this why you think this way?

@ntdiary
Copy link
Contributor

ntdiary commented Dec 12, 2023

  1. Go to any chats
  2. Verify that the composer is focused and the virtual keyboard is not shown. After touching on the composer, the keyboard is shown

I am not sure if this is the expected behavior. @ntdiary can you confirm this doesn't conflict with your refactor?

I need some time to understand this issue first. :)

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Dec 14, 2023

@ntdiary @0xmiroslav bump

I am not sure if this is the expected behavior.

@0xmiroslav Can you add more context for this why you think this way?

@ntdiary
Copy link
Contributor

ntdiary commented Dec 15, 2023

@ntdiary @0xmiroslav bump

I am not sure if this is the expected behavior.

@0xmiroslav Can you add more context for this why you think this way?

@Santhosh-Sellavel, we have a PR #29199 that aims to standardize the behavior of refocusing when a modal is closed (including BaseModal, PopoverWithoutOverlay, and RHP), which will address many refocusing issues. The basic principle is that if there is a focused input box before opening the modal, then the focus will be restored after closing the modal. If there is no focus before opening, then it will not be restored.

So, after it is merged, the main input box will no longer gain focus if we complete the money request from the green plus button, which means that the keyboard will no longer be pulled up (for all mobile native/mWeb platforms).

As for whether the main composer should be focused when we open a chat from LHN, it is beyond the scope of that PR.

demo.mp4

@Santhosh-Sellavel
Copy link
Collaborator

@christianwen can you resolve conflicts, please?

@christianwen
Copy link
Contributor Author

merged main

@Santhosh-Sellavel
Copy link
Collaborator

@christianwen Sorry for the delay, can resolve conflicts please?

@christianwen
Copy link
Contributor Author

@Santhosh-Sellavel I fixed the conflicts, can you help process review this PR to avoid the conflicts? Thanks

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jan 25, 2024

@christianwen
Bug: On tapping composer to bring Keyboard, Keyboard gets dismissed automatically on mWeb iOS

Screen.Recording.2024-01-26.at.1.04.52.AM.mov

@christianwen
Copy link
Contributor Author

Checking...

@Santhosh-Sellavel
Copy link
Collaborator

Any update?

@Santhosh-Sellavel
Copy link
Collaborator

Bump @christianwen

@christianwen
Copy link
Contributor Author

I faced with some errors when building iOS.Pls give me a day to fix it

@Santhosh-Sellavel
Copy link
Collaborator

@christianwen
Bug: On tapping composer to bring Keyboard, Keyboard gets dismissed automatically on mWeb iOS

Screen.Recording.2024-01-26.at.1.04.52.AM.mov

@christianwen this happens on mWeb iOS

@Santhosh-Sellavel
Copy link
Collaborator

Any update @christianwen

@DylanDylann
Copy link
Contributor

BUG: The keyboard doesn't show on Android (only show if clicking two times)

Screen.Recording.2024-09-25.at.17.44.01.mov

@DylanDylann
Copy link
Contributor

DylanDylann commented Sep 25, 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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-09-25.at.23.11.55.mov
Android: mWeb Chrome
Screen.Recording.2024-09-25.at.23.10.40.mov
iOS: Native
Screen.Recording.2024-09-25.at.23.12.23.mov
iOS: mWeb Safari
Screen.Recording.2024-09-25.at.23.10.15.mov
MacOS: Chrome / Safari
Screen.Recording.2024-09-25.at.23.09.27.mov
MacOS: Desktop
Screen.Recording.2024-09-25.at.23.12.43.mov

@melvin-bot melvin-bot bot requested a review from iwiznia September 25, 2024 16:14
@DylanDylann
Copy link
Contributor

Just a note:

  1. Changed files ESLint check
    This action failed because of https://expensify.slack.com/archives/C01GTK53T8Q/p1726169039084589. This PR is complicated, so I think we should migrate withOnyx to useOnyx in another PR
  2. Reassure Performance Tests
    As mentioned above

Updated! For the perf issue, we shouldn't mind about it since this test is to compare the number of re-render when users interact with input in baseline (from main) with the current behavior (this PR). In this PR we try to open the keyboard when they focus on the composer -> it takes 2 times to re-render

This PR will change the current behavior on purpose

@DylanDylann
Copy link
Contributor

@iwiznia All yours

@christianwen
Copy link
Contributor Author

@iwiznia Can you take a look at this PR? Thanks

@iwiznia
Copy link
Contributor

iwiznia commented Sep 30, 2024

Checks failed

@DylanDylann
Copy link
Contributor

@iwiznia Please check this comment: #32711 (comment)

@iwiznia iwiznia merged commit a9224f3 into Expensify:main Sep 30, 2024
14 of 16 checks passed
@melvin-bot melvin-bot bot added the Emergency label Sep 30, 2024
Copy link

melvin-bot bot commented Sep 30, 2024

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

@iwiznia iwiznia removed the Emergency label Sep 30, 2024
@iwiznia
Copy link
Contributor

iwiznia commented Sep 30, 2024

See #32711 (comment)

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

Copy link
Contributor

🚀 Deployed to staging by https://github.com/iwiznia in version: 9.0.42-0 🚀

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

@iwiznia
Copy link
Contributor

iwiznia commented Oct 1, 2024

Going to revert the PR since it caused #49977

@DylanDylann
Copy link
Contributor

@christianwen Could you create a quick PR to address this bug?

Copy link
Contributor

github-actions bot commented Oct 2, 2024

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.42-3 🚀

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

@DylanDylann DylanDylann mentioned this pull request Oct 7, 2024
50 tasks
!modal?.isVisible &&
Modal.areAllModalsHidden() &&
isFocused &&
(shouldFocusInputOnScreenFocus || (isEmptyChat && !ReportActionsUtils.isTransactionThread(parentReportAction))) &&
Copy link
Contributor

@rojiphil rojiphil Nov 11, 2024

Choose a reason for hiding this comment

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

Probably a design issue as we did not notice that the keyboard display on mobile platforms would cover the task description and cause UX issue #50346
Sorry. Wrong place to comment this

Copy link
Contributor

@DylanDylann DylanDylann Nov 11, 2024

Choose a reason for hiding this comment

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

@rojiphil This PR was reverted

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh! Thanks for pointing this out. Didn't notice this. Let me dig a little deeper.

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