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

Disable hover on device without hover support #22925

Merged
merged 3 commits into from
Jul 26, 2023

Conversation

bernhardoj
Copy link
Contributor

Details

We want to disable hover on device that doesn't support hover, for example mobile web.

Fixed Issues

$ #22759
PROPOSAL: #22759 (comment)

Tests

Same as QA Steps

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

mWeb only

  1. Open any chat that has multiple messages
  2. Tap quickly between messages
  3. Verify no message is highlighted and no mini context menu shows

On the Web, I'm just making sure the hover still works as usual
No hover on Android/iOS

  • 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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
Screen.Recording.2023-07-15.at.10.37.48.mov
Mobile Web - Chrome
Screen.Recording.2023-07-15.at.10.50.06.mov
Mobile Web - Safari
Screen.Recording.2023-07-15.at.10.45.40.mov
Desktop
Screen.Recording.2023-07-15.at.10.45.05.mov
iOS

N/A

Android

N/A

@bernhardoj bernhardoj requested a review from a team as a code owner July 15, 2023 02:57
@melvin-bot melvin-bot bot requested review from Santhosh-Sellavel and removed request for a team July 15, 2023 02:57
@melvin-bot
Copy link

melvin-bot bot commented Jul 15, 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]

@bernhardoj
Copy link
Contributor Author

Bump @Santhosh-Sellavel

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jul 17, 2023

@bernhardoj This was hardly reproducible earlier. Now it happens for every tap for me

Screen_Recording_20230718_003145_Chrome.mp4

@bernhardoj
Copy link
Contributor Author

@Santhosh-Sellavel is the recording correct? I don't see any issue in the recording.

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jul 18, 2023

Sorry updated @bernhardoj check now

@bernhardoj
Copy link
Contributor Author

@Santhosh-Sellavel That's really weird. Are you sure you applied all the changes?

especially this one

if (!DeviceCapabilities.hasHoverSupport()) {
    return child;
}

@Santhosh-Sellavel
Copy link
Collaborator

I was on your branch. While testing, as I said it was hard to reproduce the issue in other branches, very easily reproducible on yours. Also I'm using a real device to test. (S20 Plus)

@bernhardoj
Copy link
Contributor Author

I'm also using a real device. Can you please try to log the value of DeviceCapabilities.hasHoverSupport()? It should be false.

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jul 18, 2023

Seems It's true, for me which device are you using?

@bernhardoj
Copy link
Contributor Author

bernhardoj commented Jul 19, 2023

@Santhosh-Sellavel I'm using Redmi Note 8 Pro. So, I'm googling and found that Samsung devices did "support" hover
https://www.ctrl.blog/entry/css-media-hover-samsung.html
https://stackoverflow.com/questions/60531036/problem-with-css-media-query-to-detect-if-samsung-device-supports-hover

This means all of our DeviceCapabilities.hasHoverSupport() usage leads to different behavior between Samsung and other devices.

DeviceCapabilities.hasHoverSupport() is currently being used in 4 components:

  1. Hoverable, has a problem in this branch
  2. Tooltip, actually relies on Hoverable, so also has a problem in this branch
  3. PressableWithSecondaryInteraction
    use hasHoverSupport to early return the long press callback here
    executeSecondaryInteraction(e) {
    if (DeviceCapabilities.hasHoverSupport() && !this.props.enableLongPressWithHover) {
    return;
    }

but in Samsung devices, we will also early return, which means we ignore the long press on Samsung, but on mobile web, the long press will trigger contextmenu event which is handled by

executeSecondaryInteractionOnContextMenu(e) {
if (!this.props.onSecondaryInteraction) {
return;
}
e.stopPropagation();
if (this.props.preventDefaultContextMenu) {
e.preventDefault();
}
this.props.onSecondaryInteraction(e);
/**
* This component prevents the tapped element from capturing focus.
* We need to blur this element when clicked as it opens modal that implements focus-trapping.
* When the modal is closed it focuses back to the last active element.
* Therefore it shifts the element to bring it back to focus.
* https://github.com/Expensify/App/issues/14148
*/
if (this.props.withoutFocusOnSecondaryInteraction && this.pressableRef) {
this.pressableRef.blur();
}
}

So, no problem here.
4. and AutoCompleteSuggestions
This component is the base component of emoji and the mentioned suggestions. hasHoverSupport is being used to prevent long pressing the suggestion from blurring the composer.

container.onpointerdown = (e) => {
if (DeviceCapabilities.hasHoverSupport()) {
return;
}
e.preventDefault();
};

See the video below:

Chrome.mp4

The video above shows the correct behavior, that is long pressing the suggestion doesn't blur the composer. My guess is, on Samsung devices (both on the main and this branch), long pressing the suggestion will blur the composer, therefore closing the keyboard.

So, here is the plan:

  1. Can you please test the AutoCompleteSuggestions (on the main branch) and see whether it behaves as expected, that is not blurring the composer when long pressing? I'm expecting it will blur the composer
  2. If it blurs the composer, then we should update the code of DeviceCapabilities.hasHoverSupport to include checking the pointer type must be fine. This solution is based on the SO link above.
hasHoverSupport() {
    return window.matchMedia('(hover: hover) and (pointer: fine)').matches;
}

Here is an image showing device matching from https://drafts.csswg.org/mediaqueries/#mf-interaction
image

This is working fine so far on my devices, both web and mobile. I can either push this update, or you can apply this change on your end first and see whether it solves the issue or not.

But we also need to keep in mind that window.matchMedia('(hover: hover) and (pointer: fine)') checks the primary input, which means if we connect an external mouse to a mobile device, the hover still won't work (except Puffin browser, see https://patrickhlauke.github.io/touch/pointer-hover-any-pointer-any-hover/results/). This actually aligns with the native platform, but if we don't want this to happen, then we can't use the hasHoverSupport solution.

that's it. Let me know your thoughts!

@Santhosh-Sellavel
Copy link
Collaborator

@bernhardoj

The video above shows the correct behavior, that is long pressing the suggestion doesn't blur the composer. My guess is, on Samsung devices (both on the main and this branch), long pressing the suggestion will blur the composer, therefore closing the keyboard.

Yes, you are right, it blurs composer and closes the keyboard!

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jul 20, 2023

return window.matchMedia('(hover: hover) and (pointer: fine)').matches;

This works for me on AutoSuggestion As I tested it.

Can you a raise thread in Slack so we can get feedback and align based on a consensus on the solution before proceeding?

If you have another solution please include that too, please tag me & @iwiznia in thread.

@bernhardoj
Copy link
Contributor Author

Here is the dicussion https://expensify.slack.com/archives/C01GTK53T8Q/p1689930070214919

@bernhardoj
Copy link
Contributor Author

Pushed the new update. Retested + iPad and works fine so far.

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jul 24, 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 & Desktop
Screen.Recording.2023-07-25.at.2.59.06.AM.mov
Mobile Web - Chrome
Screen_Recording_20230725_025242_Chrome.mp4
Mobile Web - Safari
Screen.Recording.2023-07-25.at.3.08.41.AM.mov
iOS & Android

N/a

@Santhosh-Sellavel
Copy link
Collaborator

I don't see any issues so far, all look good. But @bernhardoj can you please test other components as well that use Hoverable and ensure there's no breakage here?

If all is good till tomorrow we can move to CME's review

@bernhardoj
Copy link
Contributor Author

@Santhosh-Sellavel Sure. Below are the videos showing the Hoverable works on all components that use it (except Banner, idk how can I show the banner in a report screen as it requires an account manager id)

Footer

Screen.Recording.2023-07-25.at.12.57.08.mov

MenuItem (settings), OptionRow (search), OptionRowLHN (LHN), Tooltip, ReportActionItem

Screen.Recording.2023-07-25.at.12.53.30.mov

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.

Thanks, @bernhardoj, LGTM!

All yours @roryabraham!

@melvin-bot melvin-bot bot requested a review from roryabraham July 26, 2023 00:06
Copy link
Contributor

@roryabraham roryabraham left a comment

Choose a reason for hiding this comment

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

nice simplification

@roryabraham roryabraham merged commit d0ef241 into Expensify:main Jul 26, 2023
@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 https://github.com/roryabraham in version: 1.3.46-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.47-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.46-2 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.47-6 🚀

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants