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

Do not focus input after other interactions #48415

Merged
merged 18 commits into from
Sep 27, 2024

Conversation

rezkiy37
Copy link
Contributor

@rezkiy37 rezkiy37 commented Sep 2, 2024

Details

The PR fixes the Composer focusing and keyboard behavior after interactions with modals.

Fixed Issues

$ #47082
PROPOSAL: #47082 (comment)

Tests

  1. Open any chat.
  2. Tap the "+" button.
  3. Tap on the backdrop to close the modal.
  4. Verify that Composer has not been focused and the keyboard is not opened.
  5. Tap the "+" button > Add attachment.
  6. Tap on the backdrop to close the modal.
  7. Verify that Composer has not been focused and the keyboard is not opened.
  • Verify that no errors appear in the JS console

Offline tests

Same as "Tests".

QA Steps

Same as "Tests".

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

Screenshots/Videos

Android: Native
Android.mp4
Android: mWeb Chrome
Android.Chrome.mp4
iOS: Native
IOS.mp4
iOS: mWeb Safari
IOS.Safari.mp4
MacOS: Chrome / Safari
Chrome.mp4
MacOS: Desktop
Desktop.mp4

Copy link
Contributor

@fabioh8010 fabioh8010 left a comment

Choose a reason for hiding this comment

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

LGTM, but I think we should remove [No QA] label as this PR should have tests

@rezkiy37 rezkiy37 changed the title [WIP] [No QA] Do not focus input after other interactions [WIP] Do not focus input after other interactions Sep 3, 2024
@rezkiy37 rezkiy37 changed the title [WIP] Do not focus input after other interactions Do not focus input after other interactions Sep 4, 2024
@rezkiy37 rezkiy37 marked this pull request as ready for review September 4, 2024 07:06
@rezkiy37 rezkiy37 requested a review from a team as a code owner September 4, 2024 07:06
@melvin-bot melvin-bot bot requested a review from eh2077 September 4, 2024 07:07
Copy link

melvin-bot bot commented Sep 4, 2024

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

@rezkiy37
Copy link
Contributor Author

rezkiy37 commented Sep 9, 2024

@eh2077, please review the PR 🙂

Copy link
Contributor

@eh2077 eh2077 left a comment

Choose a reason for hiding this comment

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

I'm not sure if we should only avoid keyboard focusing for attachment picker modals.

And I feel that we have been so keen on the auto-focus feature in the past.

}
focus(true);
Copy link
Contributor

Choose a reason for hiding this comment

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

By removing this, we also won't focus back to the composer when navigating back from RHP. I just feel that the impact scope might be wider than we expect.

0-web.mp4
0-web.mp4

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I see. To clarify: we have the problem on the Android app only. So we can apply these changes to Android and keep the other platforms as they are. WDYT @eh2077?

cc @mountiny

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm, as a user, I'd be happy if keyboard is not focused (no matter the keyboard is focused before or not) when navigating back from attachment picker modals, no matter after uploading an attachment or just cancel to pick an attachment.

For other cases, like picking up an emoji or back from RHP, I think the current behaviour to focus input makes senses to me. I'd like to share following points to support my stance:

  • Back the issue itself, the delay is more noticeable only after interactions with system, like open camera or media manager
  • Auto-focusing the keyboard makes the user more engaged in chatting, like after picking up an emoji
  • IIRC, we have done quite a lot of polishing to this feature in the past.

@mountiny We'd also like to hear your thoughts on this.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think I agree with @eh2077 but I would like to give this more exposure, can you please summaarize the problem now and post what you suggest how we should handle it in Slack? I think we should get design team to agree on this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I totally agree with aligning it with the design team. I will create a post in the open-source channel.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@eh2077, can we move forward with this PR after the discussion in Slack where the guys said that auto-focus feels unnecessary?

Copy link
Contributor

Choose a reason for hiding this comment

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

@rezkiy37 I think we need to fix the case @eh2077 raised in this comment. in Web, we want to make sure the composer i focused when you go back from the RHP as that is a common flow and I think lots of users would be unhappy if we stop focusing to the composer

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay, I will do it. Thank you!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done - 3c4b392.

Refocus.mp4

Copy link
Contributor Author

Choose a reason for hiding this comment

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

IOS.mp4


onEmojiSelected: EmojiPickerAction.OnEmojiSelected;
};

function EmojiPickerButton({isDisabled = false, id = '', emojiPickerID = '', shiftVertical = 0, onModalHide, onEmojiSelected}: EmojiPickerButtonProps) {
function EmojiPickerButton({isDisabled = false, id = '', emojiPickerID = '', shiftVertical = 0, onModalHide = () => {}, onEmojiSelected}: EmojiPickerButtonProps) {
Copy link
Contributor

Choose a reason for hiding this comment

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

After selecting an emoji, we won't focus back the composer. TBH, I'm feeling a bit disquiet about changing this.

keyboard-dismiss-after-select-emoji.mov

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is also a part of the scope of fixing. From my point of view, it is not a problem and it is good as well. But let's decide #48415 (comment) first.

@eh2077
Copy link
Contributor

eh2077 commented Sep 16, 2024

I'd like to pull the design team @Expensify/design here, so we can hear feedback from them on new changes

@mountiny
Copy link
Contributor

@eh2077 @rezkiy37 to make this easier for the design team, can you provide before and after videos of the places that are affected?

I will run a build

@mountiny mountiny requested a review from a team September 16, 2024 14:20
@eh2077
Copy link
Contributor

eh2077 commented Sep 16, 2024

@eh2077 @rezkiy37 to make this easier for the design team, can you provide before and after videos of the places that are affected?

Sure, I'll upload videos to compare with staging.

@Expensify Expensify deleted a comment from github-actions bot Sep 16, 2024

This comment has been minimized.

@mountiny
Copy link
Contributor

@rezkiy37 can you make sure this is up to date with main? maybe your fork main is out of date, not sure why the adhoc build is failing

@eh2077
Copy link
Contributor

eh2077 commented Sep 18, 2024

I've replaced withOnyx with useOnyx.

@rezkiy37 Why do we need this change? Does it bring benefits for solving the issue here?

@eh2077
Copy link
Contributor

eh2077 commented Sep 18, 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
0-android.mp4
Android: mWeb Chrome
0-mobile-chrome.mp4
iOS: Native
0-ios.mp4
iOS: mWeb Safari
0-mobile-safari.mp4
MacOS: Chrome / Safari
0-web.mp4
MacOS: Desktop
0-web.mp4

@eh2077
Copy link
Contributor

eh2077 commented Sep 18, 2024

@rezkiy37 Mobile Safari backdrop attachment picker modal still focus the input

Screen.Recording.2024-09-19.at.12.58.12.AM.mov

@rezkiy37
Copy link
Contributor Author

I've replaced withOnyx with useOnyx.

@rezkiy37 Why do we need this change? Does it bring benefits for solving the issue here?

https://callstack-hq.slack.com/archives/C01GTK53T8Q/p1726169039084589

Screenshot 2024-09-18 at 21 11 18

@rezkiy37
Copy link
Contributor Author

Hello!
I am OOO from 19.09 - 23.09. I will continue to work on this one when I am back.

@JKobrynski
Copy link
Contributor

@eh2077 Hi, I'm Julian from Callstack and I'm taking care of this PR in @rezkiy37 's absence. I tried reproducing that on my end and it seems to work correctly. Are you still experiencing it?

ios_demo.mp4

@eh2077
Copy link
Contributor

eh2077 commented Sep 23, 2024

@JKobrynski Thanks for checking this out! In your clip, I saw the composer border is highlighted. Is it related to the composer focusing?

I'll test on my physical iPhone and update soon.

@eh2077
Copy link
Contributor

eh2077 commented Sep 23, 2024

@JKobrynski

Tested on physical mobile Safari, backdrop attachment picker modal will not pop up the keyboard, but the composer has a highlight border.

0-RPReplay_Final1727102365.mp4

Select an emoji won't open the keyboard, this should be unexpected according to #48415 (comment)

0-RPReplay_Final1727102390.mp4

@rezkiy37
Copy link
Contributor Author

I am back so I will manage the PR 🙂

@rezkiy37
Copy link
Contributor Author

Hey!
I've synced up the branch with the latest main. Fortunately, I cannot reproduce the bug:

Select an emoji won't open the keyboard, this should be unexpected according to #48415 (comment)

Details

Not.a.bug.mp4

However, this one is replicable:

Tested on physical mobile Safari, backdrop attachment picker modal will not pop up the keyboard, but the composer has a highlight border.

So I am working to fix and test it.

cc @eh2077 @JKobrynski

@rezkiy37
Copy link
Contributor Author

rezkiy37 commented Sep 25, 2024

I've fixed when the backdrop attachment picker modal will not pop up the keyboard, but the composer has a highlight border. Commit - a14bd8f.

Video
Fix.1.mp4

cc @eh2077 @JKobrynski

@mountiny
Copy link
Contributor

@rezkiy37 let us know when this is ready for another full look by c+

@rezkiy37
Copy link
Contributor Author

rezkiy37 commented Sep 26, 2024

@mountiny, this is ready. All comments have been addressed 🙂
cc @eh2077

@eh2077
Copy link
Contributor

eh2077 commented Sep 26, 2024

Cool! I'll retest it by the EOD

Copy link
Contributor

@eh2077 eh2077 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 tested well!

@rezkiy37 Great job and thank you for your patience!

Copy link

melvin-bot bot commented Sep 26, 2024

We did not find an internal engineer to review this PR, trying to assign a random engineer to #47082 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

@eh2077
Copy link
Contributor

eh2077 commented Sep 26, 2024

@mountiny All yours

mountiny
mountiny previously approved these changes Sep 27, 2024
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.

Thanks for your patience @rezkiy37 and great testing @eh2077

@mountiny mountiny merged commit 05ca35c into Expensify:main Sep 27, 2024
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.

Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.41-0 🚀

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.41-10 🚀

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

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.

9 participants