perf: disable hover when scrolling on web and desktop #27236

hurali97 · 2023-09-12T11:30:18Z

Details

This adds a prop shouldHandleScroll to Hoverable component, which decides whether we want to toggle isHovered state while scrolling or not. If shouldHandleScroll is set to true the Hoverable component will only toggle the isHovered state once the scroll is started and ended.

Since, react-native-web doesn't have support for onScrollBeginDrag and onScrollEndDrag, I moved forward with a temporary work around following here.

The implemented solution looks like this:

Added the temporary solution in BaseInvertedFlatList component and we only use this when we are on web and desktop.
We emit the scrolling state only once when scroll is started and ended, using the DeviceEventEmitter.
In Hoverable component, we added an event listener only if shouldHandleScroll prop is true and listener is not already set.
We then track the hover using isHoveredRef and use this once the scrolling is ended to update the isHovered state.

Fixed Issues

$ #27214
PROPOSAL: #27214 ( Proposal is in the issue description )

Tests

Manual Test:

Go to any Report which contains some messages.
Start scrolling and notice that the hover and reaction bar doesn't display while you're scrolling.
Once you stop the scroll, the hover and reaction bar will display.
Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

Go to any Report which contains some messages.
Start scrolling and notice that the hover and reaction bar doesn't display while you're scrolling.
Once you stop the scroll, the hover and reaction bar will display.
Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

web-recording.mp4

Mobile Web - Chrome

Mobile Web - Safari

Desktop

desktop-recording.mp4

iOS

Android

… perf/disable-hover-when-scrolling

github-actions · 2023-09-12T11:30:32Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

hurali97 · 2023-09-12T11:31:09Z

I have read the CLA Document and I hereby sign the CLA

melvin-bot · 2023-09-13T06:54:58Z

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

package-lock.json

src/CONST.ts

abdulrahuman5196 · 2023-09-14T09:25:30Z

@hurali97 There is lint failure as well.

hurali97 · 2023-09-14T10:23:31Z

@abdulrahuman5196 Thanks for the review. Addressed all reviews apart from the platform specific one. I am up to tackle it in this PR, it shouldn't take much time. @mountiny what do you think ? 🤔

mountiny · 2023-09-14T11:02:52Z

Addressed all reviews apart from the platform specific one. I am up to tackle it in this PR, it shouldn't take much time. @mountiny what do you think ? 🤔

yes please, try to tackle it in this PR, we have deployed now so there is around 24 hours til the next deploy

hurali97 · 2023-09-14T13:10:35Z

@mountiny @abdulrahuman5196 Can you guys re-review at your ease, much appreciated. I have addressed the platform specific change ✅

mountiny · 2023-09-14T15:18:15Z

thanks! great to get it in so quick, running the checks again

@abdulrahuman5196 can yu please check again now?

abdulrahuman5196 · 2023-09-14T15:19:01Z

Sure will do in 1-2 hours

abdulrahuman5196 · 2023-09-14T19:07:06Z

Code Looks fine to me. I have 2 questions

During testing I feel that the appearance of hover after the scroll is taking more time. We have kept 250 i assume, can we reduce it further so that the context menu icons comes faster.
How are we measuring the improvement on this? I could have missed some previous discussion as well. I am not sure if this change is making positive/negative impact apart from the logical theory?

@hurali97 @mountiny

mountiny · 2023-09-15T04:13:38Z

How are we measuring the improvement on this? I could have missed some previous discussion as well. I am not sure if this change is making positive/negative impact apart from the logical theory?

I agree there is probably not an easy way to measure this but just from the experience on some longer chat with attachments and such, did it feel smoother?

hurali97 · 2023-09-15T06:29:35Z

Code Looks fine to me. I have 2 questions

During testing I feel that the appearance of hover after the scroll is taking more time. We have kept 250 i assume, can we reduce it further so that the context menu icons comes faster.

How are we measuring the improvement on this? I could have missed some previous discussion as well. I am not sure if this change is making positive/negative impact apart from the logical theory?

@hurali97 @mountiny

Hey @abdulrahuman5196,

Yes we can reduce it further but it probably wouldn't affect that much as the main delay is due to the underlying component RenderActionItem as it's heavy to re-render. I have tried this by replacing ReportActionItem with a plain View and it was appearing relatively faster with same 250ms timeout. I think with Use initialValue in withOnyx and other optimizations for ReportScreen #26772 there will be improvements in the underlying renderItem.
Since this is improvement of a perceived performance, we measured this from a user perspective. You can follow the proposal for the before and after results.

mountiny · 2023-09-15T10:01:27Z

@abdulrahuman5196 let me know if this is good to be merged, thanks!

mountiny · 2023-09-15T10:48:50Z

Triggered a build for testing

abdulrahuman5196 · 2023-09-15T11:09:37Z

@mountiny I am not exactly sure on the performance impact. Sometimes it felt like the changes caused negative impact. But I am not sure though, maybe could be due to dev or my machine.

I will test again in the testing build. I think it's best to do some more testing before merging the change.

OSBotify · 2023-09-15T11:11:45Z

🧪🧪 Use the links below to test this build in android and iOS. Happy testing! 🧪🧪

android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/27236/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/27236/index.html

desktop 💻	web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/27236/NewExpensify.dmg	https://27236.pr-testing.expensify.com

mountiny · 2023-09-15T11:26:59Z

I will test again in the testing build. I think it's best to do some more testing before merging the change.

I agree with this!

abdulrahuman5196 · 2023-09-18T17:55:09Z

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

Screen.Recording.2023-09-18.at.10.45.57.PM.mp4

Mobile Web - Chrome

az_recorder_20230918_225706.mp4

Mobile Web - Safari

Screen.Recording.2023-09-18.at.11.16.10.PM.mp4

Desktop

Screen.Recording.2023-09-18.at.11.07.03.PM.mp4

iOS

Screen.Recording.2023-09-18.at.10.48.53.PM.mp4

Android

az_recorder_20230918_230211.mp4

abdulrahuman5196 · 2023-09-18T17:58:46Z

NAB: @hurali97 Kindly update Offline Tests as Same as Tests in author's checklist.

abdulrahuman5196

Changes looks good and works well. Reviewers checklist is also complete.

Note: The scrolling is similar to that of staging IMO, but i also agree its hard to test performance objectively here. We can go ahead since the theory seems to be intact.

All yours. @mountiny

🎀 👀 🎀
C+ Reviewed

… perf/disable-hover-when-scrolling

src/components/Hoverable/hoverablePropTypes.js

mountiny

Thanks everyone!

OSBotify · 2023-09-19T07:05:34Z

✋ 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 · 2023-09-20T08:45:18Z

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

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

OSBotify · 2023-09-22T13:27:13Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.72-11 🚀

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

hurali97 added 2 commits September 12, 2023 16:13

perf: disable hover while scrolling on web and desktop

de597ea

Merge branch 'main' of https://github.com/hurali97/Expensify-App into…

e3abfdf

… perf/disable-hover-when-scrolling

feat: handle scroll start

03b0f1e

hurali97 marked this pull request as ready for review September 13, 2023 06:54

hurali97 requested a review from a team as a code owner September 13, 2023 06:54

melvin-bot bot requested review from abdulrahuman5196 and removed request for a team September 13, 2023 06:54

mountiny assigned hurali97 Sep 14, 2023

mountiny reviewed Sep 14, 2023

View reviewed changes

package-lock.json Outdated Show resolved Hide resolved

abdulrahuman5196 reviewed Sep 14, 2023

View reviewed changes

src/CONST.ts Outdated Show resolved Hide resolved

hurali97 added 4 commits September 14, 2023 14:50

fix: prettier fixes

ab6422b

revert: integrity in package-lock for expensify-common

6bbe122

revert: expensify-common package-lock entry

5b83eb9

fix: upstream expensify-common package-lock entry

30cdb74

hurali97 added 3 commits September 14, 2023 17:54

refactor: move to platform specific files

327ba04

revert: line break

8cfb8f9

docs: add js docs for shouldHandleScroll prop

588cbbb

Merge branch 'Expensify:main' into perf/disable-hover-when-scrolling

4912dcf

mountiny added the Ready To Build label Sep 15, 2023

hurali97 mentioned this pull request Sep 15, 2023

feat: add event observer class #27513

Draft

59 tasks

abdulrahuman5196 approved these changes Sep 18, 2023

View reviewed changes

melvin-bot bot requested a review from mountiny September 18, 2023 18:05

hurali97 added 2 commits September 19, 2023 11:28

Merge branch 'main' of https://github.com/hurali97/Expensify-App into…

508f13d

… perf/disable-hover-when-scrolling

fix: prettier fixes

555d274

mountiny reviewed Sep 19, 2023

View reviewed changes

src/components/Hoverable/hoverablePropTypes.js Outdated Show resolved Hide resolved

fix: capitalise

a88f7b7

mountiny approved these changes Sep 19, 2023

View reviewed changes

mountiny merged commit f746c46 into Expensify:main Sep 19, 2023

OSBotify mentioned this pull request Sep 20, 2023

Deploy Checklist: New Expensify 2023-09-20 #27837

Closed

Pluto0104 mentioned this pull request Sep 20, 2023

[HOLD for payment 2023-10-02] Chat - IOU - Hover is not being shown after stopping to scroll #27873

Closed

6 tasks

cristipaval mentioned this pull request Sep 21, 2023

[HOLD for payment 2023-10-23] [$500] Android native - Default Scrollbar is visible when scrolling in a chat #27931

Closed

6 tasks

melvin-bot bot mentioned this pull request Sep 22, 2023

[HOLD for payment 2023-09-29] Disable hover effect while scrolling in Report Screen on Web #27214

Closed

perf: disable hover when scrolling on web and desktop #27236

perf: disable hover when scrolling on web and desktop #27236

Uh oh!

Conversation

hurali97 commented Sep 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Manual Test:

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

github-actions bot commented Sep 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hurali97 commented Sep 12, 2023

Uh oh!

melvin-bot bot commented Sep 13, 2023

Uh oh!

Uh oh!

Uh oh!

abdulrahuman5196 commented Sep 14, 2023

Uh oh!

hurali97 commented Sep 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mountiny commented Sep 14, 2023

Uh oh!

hurali97 commented Sep 14, 2023

Uh oh!

mountiny commented Sep 14, 2023

Uh oh!

abdulrahuman5196 commented Sep 14, 2023

Uh oh!

abdulrahuman5196 commented Sep 14, 2023

Uh oh!

mountiny commented Sep 15, 2023

Uh oh!

hurali97 commented Sep 15, 2023

Uh oh!

mountiny commented Sep 15, 2023

Uh oh!

mountiny commented Sep 15, 2023

Uh oh!

abdulrahuman5196 commented Sep 15, 2023

Uh oh!

OSBotify commented Sep 15, 2023

Uh oh!

mountiny commented Sep 15, 2023

Uh oh!

abdulrahuman5196 commented Sep 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

abdulrahuman5196 commented Sep 18, 2023

Uh oh!

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Sep 19, 2023

Uh oh!

OSBotify commented Sep 20, 2023

Uh oh!

OSBotify commented Sep 22, 2023

Uh oh!

Uh oh!

hurali97 commented Sep 12, 2023 •

edited

Loading

github-actions bot commented Sep 12, 2023 •

edited

Loading

hurali97 commented Sep 14, 2023 •

edited

Loading

abdulrahuman5196 commented Sep 18, 2023 •

edited

Loading