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

fire hover event on supported devices only #20432

Closed
wants to merge 3 commits into from

Conversation

kushu7
Copy link
Contributor

@kushu7 kushu7 commented Jun 8, 2023

Details

should fire hover event on supported devices only. for that we are using DeviceCapabilities.hasHoverSupport()

Fixed Issues

$ #19766
PROPOSAL: #19766 (comment)

Tests

  1. Tap on the search icon
  2. Long press on a contact just after the page opens
  3. Verify that contact will not get highlighted.
  • 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 / 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
web.mov
Mobile Web - Chrome
mweb-chrome.mp4
Mobile Web - Safari
mWeb-safari.mov
Desktop
desktop1k.mov
iOS
ios.mov
Android
android.mp4

@kushu7 kushu7 marked this pull request as ready for review June 8, 2023 13:08
@kushu7 kushu7 requested a review from a team as a code owner June 8, 2023 13:08
@melvin-bot melvin-bot bot requested review from puneetlath and Santhosh-Sellavel and removed request for a team June 8, 2023 13:08
@melvin-bot
Copy link

melvin-bot bot commented Jun 8, 2023

@puneetlath @Santhosh-Sellavel One of you needs to 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]

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jun 8, 2023

@kushu7 changes do not look like the second option from the proposal

@kushu7
Copy link
Contributor Author

kushu7 commented Jun 8, 2023

@kushu7 changes do not look like the second option from the proposal

@Santhosh-Sellavel , As component got updated during Proposal Review so i did some modification, but its inherit same properties of 2nd option. no unnecessary callbacks for non supported devices

  • declared in constructor so won't get redefine on re-renders
this.hasHoverSupport = DeviceCapabilities.hasHoverSupport();
  • added this so it will do callback accordingly based on hasHoverSupport
if (_.isFunction(child)) {
            child = child(this.state.isHovered && this.hasHoverSupport);
}
  • and ternary operation to return correct component
return this.hasHoverSupport ? (<WithHover/>) :( <WithoutHover/>)

When i provided proposal. Component was like this: During proposal

@@ -74,48 +78,52 @@ class Hoverable extends Component {
}

if (_.isFunction(child)) {
child = child(this.state.isHovered);
child = child(this.state.isHovered && this.hasHoverSupport);
}

Copy link
Collaborator

Choose a reason for hiding this comment

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

we can use early return instead

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Santhosh-Sellavel Thats good suggestion,
You are suggesting this?

 if (_.isFunction(child)) {
            child = child(this.state.isHovered && this.hasHoverSupport);
 }
  if(!this.hasHoverSupport) {
      return <View>{child}</View>
  }

Copy link
Collaborator

Choose a reason for hiding this comment

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

Look if there is any better ways refactor if not lets just proceed with above

Copy link
Contributor Author

Choose a reason for hiding this comment

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

 let child = this.props.children;
  if (_.isArray(this.props.children) && this.props.children.length === 1) {
      child = this.props.children[0];
  }
  // return child if device doesn't has hoverSupport
  if (!this.hasHoverSupport) {
      const childrenWithHoverState = _.isFunction(child) ? child(false) : child;
      return <View >{childrenWithHoverState}</View>;
  }
  if (_.isFunction(child)) {
      child = child(this.state.isHovered);
  }

This looks good to me. as we are not doing && and ternary operation.
Just pushing code.

@kushu7
Copy link
Contributor Author

kushu7 commented Jun 8, 2023

@Santhosh-Sellavel Just pushed latest changes. please have a look at it.

@@ -73,6 +77,12 @@ class Hoverable extends Component {
child = this.props.children[0];
}

// return child if device doesn't has hoverSupport
Copy link
Collaborator

Choose a reason for hiding this comment

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

It's not needed

@@ -15,6 +17,8 @@ class Hoverable extends Component {
};

this.wrapperView = null;
// Skip hover on not supported devices like mWeb
Copy link
Collaborator

Choose a reason for hiding this comment

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

can remove this comment too

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 have removed comments

@kushu7
Copy link
Contributor Author

kushu7 commented Jun 9, 2023

@Santhosh-Sellavel Bump for review. Changes are pushed. Please review it once.

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jun 9, 2023

It's not fixed yet able to reproduce easily on mWeb Android

Screen_Recording_20230610_015353_Chrome.mp4

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jun 9, 2023

Investigating more I was able to find that this issue was not able to reproduce on iOS mWeb before or after this PR.
Seems this seems to happen only on Android

I've added a custom style for the new view to make sure the new code was executed, and yet the issue occurs we are missing something else here.

Screen.Recording.2023-06-10.at.2.08.38.AM.mov

Another weird on real styles don't even appear 😨. I have only a Samsung device on that device,

Screenshot 2023-06-10 at 2 04 11 AM

cc: @puneetlath

@kushu7
Copy link
Contributor Author

kushu7 commented Jun 9, 2023

I've added a custom style for the new view to make sure the new code was executed, and yet the issue occurs we are missing something else here.

May i know where do you put that styles? I will retest again. Thanks

cc @Santhosh-Sellavel

@Santhosh-Sellavel
Copy link
Collaborator

Here it is

if (!this.hasHoverSupport) {
            const childrenWithHoverState = _.isFunction(child) ? child(false) : child;
            return <View style={{
                borderColor: "red",
                borderWidth: 1,
            }} >{childrenWithHoverState}</View>;
        }

@kushu7
Copy link
Contributor Author

kushu7 commented Jun 10, 2023

I debugged this.
When this is issue was open and and proposal was proposed OptionRow was relying on Hoverable hovered state to show hoverStyle
you can check that video in that issue also. before there was no focusStyle on longPress.

Now OptionRow is migrated to use PressableWithFeedback hoverStyle={this.props.hoverStyle}, focusStyle={this.props.hoverStyle}
From this PR: #19612
That longPress changes you are seeing is because of focusStyle.

So overall my RCA was correct.

still we are relying on Hoverable hovered state on many components.

Here is a video: problem persists.
real device casting using scrcpy

bug.mp4

cc @Santhosh-Sellavel @puneetlath

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jun 10, 2023

@puneetlath

After investigating again. Only with the new changes made in the PR #19612 the issue is reproducible on Android mWeb. After reverting #19612 locally all seems to be working fine with or without the changes in this PR. Not able to reproduce at all.

Screen.Recording.2023-06-10.at.10.59.41.PM.mov

@kushu7
Copy link
Contributor Author

kushu7 commented Jun 11, 2023

After investigating again. Only with the new changes made in the PR #19612 the issue is reproducible on Android mWeb. After reverting #19612 locally all seems to be working fine with or without the changes in this PR. Not able to reproduce at all.

@Santhosh-Sellavel Please see issue video once. You have to be quickly longPress after opening search page. I'm still able to reproduce it.

Here is video: reproducing issue and resolution.

bug_and_changes.mp4

cc @puneetlath

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jun 12, 2023

@tylerkaraszewski Please check the above thread and let us know your thoughts thanks!

@bernhardoj
Copy link
Contributor

@Santhosh-Sellavel I experience the same problem I reported here #20585. The root cause is exactly the same (because of the focusStyle). Should we mark that as a dupe or this PR will only handle the hovered style?

@Santhosh-Sellavel
Copy link
Collaborator

Here the focus is on hovered style alone for now.

@kushu7
Copy link
Contributor Author

kushu7 commented Jun 13, 2023

@Santhosh-Sellavel any updates?

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jun 13, 2023

Yeah, I am able to reproduce. The other PR seems to be a confusing factor here. Both are interdependent on each other here. One can not be tested without the other fix. So both should be done in the same PR if possible or the Other PR has to be reverted to merge this one.

@kushu7 Do you have any solution for the other issue?

@kushu7
Copy link
Contributor Author

kushu7 commented Jun 13, 2023

@kushu7 Do you have any solution for the other issue?

Coming from this #19612 (comment). I was checking Pressable of react-native-web.
it gets focused until we press outside.
https://necolas.github.io/react-native-web/docs/pressable/

I think we should not depend on focused state of Pressable.

@Santhosh-Sellavel
Copy link
Collaborator

@kushu7 let's wait until this PR #20838

@kushu7
Copy link
Contributor Author

kushu7 commented Jun 20, 2023

Just tested after merging of PR #20838
On dev its not reproducible now. As OptionRow component hover styling is handled by Pressable hover events now. Before it was handling by Hoverable component.

@Santhosh-Sellavel What should be need to do now i can see 4 components are still utilizing Hoverable hovered component.

cc @puneetlath

@kushu7
Copy link
Contributor Author

kushu7 commented Jun 22, 2023

Bump for suggestion.

cc @Santhosh-Sellavel @puneetlath

@Santhosh-Sellavel
Copy link
Collaborator

Discussing internally!

@puneetlath
Copy link
Contributor

Closing as discussed here: #19766 (comment)

@puneetlath puneetlath closed this Jun 23, 2023
@kushu7 kushu7 deleted the kushu7-fix-19766 branch June 23, 2023 21:42
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