[Video] The controls bar flickers when video's popover menu is closed #41125

ikevin127 · 2024-04-27T00:23:24Z

Details

Because within our VideoPopoverMenu component we're using a portal, when this is open it comes on top of the BaseVideoPlayer Hoverable surface of the video. These are the events that occur which lead to our issue:

The video player controls 3-dot menu (More) is clicked -> Popover opens -> isHovered state is set to false.
User clicks outside of the Popover -> Popover closes -> isHovered state is set to false again.
Right after the Popover is gone, the Hoverable surface re-captures the mouse event -> isHovered state is set to true.

Our issue occurs between (2.) and (3.) in very quick succession which causes the flicker of the video player controls bar because of this condition here, specifically the isHovered state variable coming from the Hoverable component which wraps the video container, toggling false/true in quick succession right after the isPopoverVisible becomes false.

This PR introduces a new boolean prop to the Hoverable component, named shouldFreezeCapture which will be used within the ActiveHoverable component to prevent setting the isHovered state to false the second time (unnecessarily) when an open portal (popover / modal) is being closed, essentially freezing the capture of the hover event.

Note

This behaviour and fix can observed only on large layout devices where hover event is available.

Fixed Issues

$ #39598
PROPOSAL: #39598 (comment)

Tests

Tip

Go to any chat.
Add a video attachment (you don't need to upload it).
Click on the 3-dot (More) button to open the Popover (you should see the Playback speed option).
Click outside of the Popover in order to close it.
Notice:

if the click outside the popover was applied within the video view -> the video controls bar remains visible and does not flicker when the popover menu is closed;
if the click outside the popover was applied outside of the video view -> the video controls bar disappears without flickering

Verify that no errors appear in the JS console

Offline tests

TLDR: same as Tests.

Tip

Go to any chat.
Add a video attachment (you don't need to upload it).
Click on the 3-dot (More) button to open the Popover (you should see the Playback speed option).
Click outside of the Popover in order to close it.
Notice:

if the click outside the popover was applied within the video view -> the video controls bar remains visible and does not flicker when the popover menu is closed;
if the click outside the popover was applied outside of the video view -> the video controls bar disappears without flickering

QA Steps

TLDR: same as Tests.

Tip

Go to any chat.
Add a video attachment (you don't need to upload it).
Click on the 3-dot (More) button to open the Popover (you should see the Playback speed option).
Click outside of the Popover in order to close it.
Notice:

if the click outside the popover was applied within the video view -> the video controls bar remains visible and does not flicker when the popover menu is closed;
if the click outside the popover was applied outside of the video view -> the video controls bar disappears without flickering

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

android-mweb.mov

iOS: Native

ios.MP4

iOS: mWeb Safari

ios-mweb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

…losed

melvin-bot · 2024-04-27T00:23:29Z

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

rojiphil

@ikevin127 Observations on testing the PR version with expanded mode of video player are as below:

1) Chrome:
a) Click inside of player => Action Bar remains shown (without flicker)
b) Click outside of player => Action Bar hides

Chrome:Outside Click

fix-chrome-outside.mp4

2) Safari:
a) Click inside of player => Action Bar remains shown (without flicker)
b) Click outside of player => Action Bar remains shown. Only after mouse move, it hides.

Safari:Outside Click

fix-safari-outside.mp4

So, while the flicker issue is resolved, we still have an inconsistency issue between Chrome and Safari when clicked outside. Here, the expected behavior is for the Action bar to be hidden on clicking outside on Safari (i.e. just like Chrome does).
What do you think?

ikevin127 · 2024-04-27T20:11:43Z

@rojiphil I think given that the flicker issue is resolved, the behaviour on Safari is strictly related to browser-specific handling of the mouseover event and not a blocker when it comes to this PR.

From what I can see, on Safari, once the popover is closed, the user needs to actually move the cursor outside of the video view for the controls to dissapear which means that the Hoverable component only captures the mouse moving once the user actually moves it.

I think these are just small differences between how Safari vs other browsers handle the mouseover event capture.

If you think this is a PR blocker then let me know and I'll spend a few more days looking into this in hopes to align the behaviour from Safari with other browsers.

rojiphil · 2024-04-29T03:53:21Z

the behaviour on Safari is strictly related to browser-specific handling of the mouseover event and not a blocker when it comes to this PR

@ikevin127 The behavior on Safari changed only after this PR. Before the fix, the action bar hid when clicked outside the player. But now it doesn't. To me, this is a regression and needs a fix. no?

ikevin127 · 2024-04-29T22:14:40Z

@rojiphil I looked into it and I can't find a solution. The problem is that Safari doesn't re-capture the mouseover event when the popover is closed without user actually moving the cursor, whereas Chrome re-captures it without user action.
Here's the behaviour on Safari before the fix (current main) and with the fix:

MacOS: Safari (before / after)

Before	After
before.mov	after.mov

As you can see on the before video on Safari, the issue on current main is that when the popover closes the video controls are hidden and only show up when the user moves the mouse over the video. With the fix, this issue is solved, but this thing will happen now with hiding the controls when cursor is outside -> which only works when user moves the mouse outside of the video in order for Safari to re-capture the mousemove event and hide the video controls.

Again, this is a weird Safari specific issue where cursor-related events are not fired unless the user actually moves the cursor. To conclude, it's either you're fine with moving forward with this as is, or I'm going to close this PR and the issue can continue to look for other proposals which will cover everything you're asking for, perfectly.

I, for one, I'm not willing to invest anymore more time into this as my capacity is limited and additionally -> I consider the issue is fixed and the behaviour on Safari evens out if we compare before / after.

Let me know what you decide!

rojiphil · 2024-05-05T17:30:58Z

it's either you're fine with moving forward with this as is

The worry I have here is that the PR changes have changed behavior as mentioned here and here. However, since it is only until the mouse moves again, it may also be fine. I would want @mountiny to weigh in here and arrive at a consensus. What’s your take here?

rojiphil · 2024-05-05T17:31:28Z

Meanwhile, let me also get a quick check on this with @Skalakid. Do you see any way to fix the behavior mentioned here?

Skalakid · 2024-05-06T17:27:24Z

I agree with @ikevin127 it's a really small edge case and it seems like a Safari bug. I tried using the mouseover event dispatching and updating the isHovered state when shouldFreezeCapture is set back to false, but every time there was a problem with event order on different browsers and new edge cases appeared. I can look into that tomorrow

Skalakid · 2024-05-07T08:16:09Z

I wasn't able to find any solution for this problem in my limited time capacity. @mountiny should we go with current solution or try to get different proposal that doesn't introduce any regression?

ikevin127 · 2024-05-07T20:39:10Z

try to get different proposal that doesn't introduce any regression

I wouldn't call the observed behaviour a regression 😅
I see the current vs PR behaviour on Safari as an actual improvement, as detailed in #41125 (comment) (see before / after videos):

As you can see on the before video on Safari, the issue on current main is that when the popover closes the video controls are hidden and only show up when the user moves the mouse over the video. With the fix, this issue is solved, but this thing will happen now with hiding the controls when cursor is outside -> which only works when user moves the mouse outside of the video in order for Safari to re-capture the mousemove event and hide the video controls.

mountiny · 2024-05-08T10:16:41Z

@rojiphil @ikevin127 I dont think this is a problem, we can go ahead with this PR if that is the only thing noticed

rojiphil · 2024-05-11T20:13:57Z

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

MacOS: Chrome / Safari

39598-web-safari.mp4

39598-web-chrome.mp4

Android: Native

39598-android-native.mp4

Android: mWeb Chrome

39598-mweb-chrome.mp4

iOS: Native

39598-ios-native.mp4

iOS: mWeb Safari

39598-mweb-safari.mp4

MacOS: Desktop

39598-desktop.mp4

rojiphil

Thanks @ikevin127. LGTM and tests well too.

mountiny

Thanks!

OSBotify · 2024-05-13T11:39:23Z

✋ 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 · 2024-05-15T10:13:11Z

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

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

OSBotify · 2024-05-22T23:58:12Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.4.74-6 🚀

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

ikevin127 added 2 commits April 26, 2024 16:43

[Video] The controls bar flickers when video's More menu popover is c…

50c995f

…losed

comment correction

4e5898c

ikevin127 requested a review from a team as a code owner April 27, 2024 00:23

melvin-bot bot removed the request for review from a team April 27, 2024 00:23

melvin-bot bot requested a review from rojiphil April 27, 2024 00:23

ikevin127 mentioned this pull request Apr 27, 2024

[HOLD for Payment 2024-05-29] [$250] Web - Attachment - The action bar flickers when downloading a video. #39598

Closed

6 tasks

rojiphil reviewed Apr 27, 2024

View reviewed changes

This comment was marked as outdated.

Sign in to view

rojiphil approved these changes May 11, 2024

View reviewed changes

melvin-bot bot requested a review from mountiny May 11, 2024 20:15

mountiny assigned ikevin127 May 13, 2024

mountiny approved these changes May 13, 2024

View reviewed changes

mountiny merged commit 9083c3e into Expensify:main May 13, 2024
17 of 19 checks passed

github-actions bot mentioned this pull request May 15, 2024

Deploy Checklist: New Expensify 2024-05-15 #42185

Closed

ikevin127 mentioned this pull request Sep 9, 2024

[$250] Top section of Settings doesn't remain fixed like we do on other pages #48736

Closed

6 tasks

truph01 mentioned this pull request Oct 19, 2024

[$250] Invoices - Unable to select payment option in the dropdown in expense preview in the main chat #51016

Open

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Video] The controls bar flickers when video's popover menu is closed #41125

[Video] The controls bar flickers when video's popover menu is closed #41125

ikevin127 commented Apr 27, 2024 •

edited

Loading

melvin-bot bot commented Apr 27, 2024

rojiphil left a comment •

edited

Loading

ikevin127 commented Apr 27, 2024

rojiphil commented Apr 29, 2024

This comment was marked as outdated.

ikevin127 commented Apr 29, 2024

rojiphil commented May 5, 2024

rojiphil commented May 5, 2024

Skalakid commented May 6, 2024

Skalakid commented May 7, 2024

ikevin127 commented May 7, 2024

mountiny commented May 8, 2024

rojiphil commented May 11, 2024

rojiphil left a comment

mountiny left a comment

OSBotify commented May 13, 2024

OSBotify commented May 15, 2024

OSBotify commented May 22, 2024

[Video] The controls bar flickers when video's popover menu is closed #41125

[Video] The controls bar flickers when video's popover menu is closed #41125

Conversation

ikevin127 commented Apr 27, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Apr 27, 2024

rojiphil left a comment • edited Loading

Choose a reason for hiding this comment

ikevin127 commented Apr 27, 2024

rojiphil commented Apr 29, 2024

This comment was marked as outdated.

ikevin127 commented Apr 29, 2024

rojiphil commented May 5, 2024

rojiphil commented May 5, 2024

Skalakid commented May 6, 2024

Skalakid commented May 7, 2024

ikevin127 commented May 7, 2024

mountiny commented May 8, 2024

rojiphil commented May 11, 2024

Reviewer Checklist

Screenshots/Videos

rojiphil left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented May 13, 2024

OSBotify commented May 15, 2024

OSBotify commented May 22, 2024

ikevin127 commented Apr 27, 2024 •

edited

Loading

rojiphil left a comment •

edited

Loading