fix Hide video playback controls on auto-playing videos #43349

tienifr · 2024-06-10T10:05:44Z

Details

Fixed Issues

$ #42323
PROPOSAL: #42323 (comment)

Tests

On a new account, tap green (+) button
Tap "Track Expense"
Observe bottom sheet w/video about how to Track expense playing with controls does not display by default

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

Prerequisite: Native and mWeb platforms only

A) Testing feature training video player:

On a new account, tap green (+) button
Tap "Track Expense"
Verify that the training video for Track Expense does not show the video controls by default. (#Test 1)
Tap inside the video player once (i.e. do not tap repeatedly) while the video still plays.
Verify that the video controls are displayed in the video player(#Test 2)
Also verify that the video playing status (i.e. play/pause) does not change (#Test 3)
Also verify that the video controls fades away after 1.5 seconds (#Test 4)
Tap inside the video player again so that the video controls are displayed.
Tap again inside the video player within 1.5 seconds and verify that the video controls fade away (#Test 5)
Tap inside the video player once to show the video controls again.
Tap on the Pause button available in the video controls to pause the play and verify that the video controls do not fade away (#Test 6)
Tap on the Play button available in the video controls to start playing again
While playing, tap again on 3DotMenu available in the video controls and verify that the video controls do not fade away (#Test 7)
Tap on the Got it button to close the feature training video.

B) Testing non-feature training video player:

Navigate to Concierge Chat.
Tap on the attachment to launch the video which explains how to track your spend
Verify that the displayed video controls fade away after 1.5 seconds. (#Test 8)
Repeat steps (A-6) to (A-12) as mentioned above.

Prerequisite: Web and Desktop versions.
C) Testing non-feature and feature training video player

On a new account, tap green (+) button
Tap "Track Expense"
Verify that the training video for Track Expense does not show the video controls by default. (#Test 9)
Hover inside the video player and verify that video controls are displayed (#Test 10)
Other than the above step, all other video player features remain the same without any change.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-06-10.at.17.59.32.mov

Android: mWeb Chrome

iOS: Native

Screen.Recording.2024-06-10.at.17.51.38.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-06-10.at.17.14.04.mov

43349-test-video-001.mp4

MacOS: Desktop

melvin-bot · 2024-06-10T11:00:46Z

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

tienifr · 2024-06-10T11:01:44Z

I am updating the recording.

dubielzyk-expensify · 2024-06-12T01:01:55Z

The video on iOS don't seem to be autoplaying is that correct?

Can you do some recordings of how this looks for a in a chat thread?

Checked out the PR locally and the desktop versions feels good to me. A bit harder to get a feel for native, but it looks alright at first glance.

cc @Expensify/design

dubielzyk-expensify · 2024-06-12T02:17:06Z

Going OOO for the next 7 days, so @shawnborton and @dannymcclain will be able to assist with the last few details :)

tienifr · 2024-06-12T09:38:18Z

@rojiphil Can you help review the PR?

rojiphil · 2024-06-13T08:54:58Z

Reviewing today

rojiphil

For feature training videos on mobile devices, the video plays automatically and we do not show the controls by default. This works fine.

But when a video Attachment is played (I.e. either via tap or on the play button on playback controls), the playback controls do not fade away as per OP expectations. Did we miss implementing this?

Also, I have a few additional observations and follow-up queries:

Currently, the fading away feature will get triggered when played and paused.
Curious to know if the playback controls should remain shown when paused on mobile. Or is it fine for the playback controls to fade away when paused?
Also, when popover is visible, shouldn’t the playback controls remain displayed and not fade away?

What do you think?

rojiphil · 2024-06-14T05:56:55Z

Can you do some recordings of how this looks for a in a chat thread?

Please find recordings below.
I have also left some follow-up queries here

iOS Native

43349-ios-native-000.mp4

mWeb Chrome

43349-mweb-chrome-000.mp4

shawnborton · 2024-06-14T06:28:44Z

But when a video Attachment is played (I.e. either via tap or on the play button on playback controls), the playback controls do not fade away as per OP expectations. Did we miss implementing this?

Perhaps we did not implement this, and we probably should implement it?

Currently, the fading away feature will get triggered when played and paused. Curious to know if the playback controls should remain shown when paused on mobile. Or is it fine for the playback controls to fade away when paused?

I think I would expect the controls to remain there even if the video is paused? But if you tap the video outside of the pause button, I would expect the video to remain paused but the controls to fade away.

Also, when popover is visible, shouldn’t the playback controls remain displayed and not fade away?

Popover as in the training modal? I think we'd want to fade those away too.

rojiphil · 2024-06-14T07:27:37Z

Also, when popover is visible, shouldn’t the playback controls remain displayed and not fade away?

Popover as in the training modal?

I meant the popover menu with menu options Download and Playback speed as shown below. Suppose the user makes the popover menu visible while the playback controls are shown (i.e. before it fades away). In that case, the menu options remain displayed even after the playback controls fade.

rojiphil · 2024-06-14T07:29:09Z

But when a video Attachment is played (I.e. either via tap or on the play button on playback controls), the playback controls do not fade away as per OP expectations. Did we miss implementing this?

Perhaps we did not implement this, and we probably should implement it?

Currently, the fading away feature will get triggered when played and paused. Curious to know if the playback controls should remain shown when paused on mobile. Or is it fine for the playback controls to fade away when paused?

I think I would expect the controls to remain there even if the video is paused? But if you tap the video outside of the pause button, I would expect the video to remain paused but the controls to fade away.

So, if I understand correctly,
On mobile devices,

When the video is tapped outside of the playback controls (whether play or pause), we show the playback controls and fade them after the agreed interval.
When the playback controls are interacted upon by clicking any of the button, we keep showing the playback controls without fading them.
Video attachment also behaves as mentioned in 1. and 2. But, unlike feature training videos, the playback controls is shown initially by default and fades away.

Is this understanding correct?

shawnborton · 2024-06-14T09:09:09Z

I think that sounds right to me, yup.

tienifr · 2024-06-17T11:48:35Z

@shawnborton I have a few thing need to confirm:

This pull request addresses only the behavior in the feature training video. Therefore, fixing the attachment video would expand the scope of this issue. What are your thoughts?
Just to confirm a few expected behavior then I will apply the change to the code:

In desktop: Leave it as it is.
In mobile:

When the video is tapped outside of the playback controls (whether play or pause), we show the playback controls and fade them after the agreed interval.
When the playback controls are interacted upon by clicking any of the button, we keep showing the playback controls without fading them.

shawnborton · 2024-06-19T06:07:23Z

Therefore, fixing the attachment video would expand the scope of this issue. What are your thoughts?

This seems okay to me though. Or maybe, what exactly are you asking me here? Anything else you need me to clear up?

tienifr · 2024-06-24T11:41:09Z

@shawnborton With the feature:

When the playback controls are interacted upon by clicking any of the button, we keep showing the playback controls without fading them.

Then, how can the user hide the playback controls?

shawnborton · 2024-06-24T11:48:37Z

Ah, I think maybe the idea is that as long as the video is playing, the controls will eventually fade out. Then you tap to get them to come back. But if you tap and pause, the controls stay in place. Does that sound right @Expensify/design ?

dannymcclain · 2024-06-24T13:23:02Z

Ah, I think maybe the idea is that as long as the video is playing, the controls will eventually fade out. Then you tap to get them to come back. But if you tap and pause, the controls stay in place. Does that sound right @Expensify/design ?

Yup that sounds right to me.

dubielzyk-expensify · 2024-07-25T22:32:02Z

In your mobile video it looks like it's correct where the controls aren't showing, but given your cursor is above the video when it pops up it's hard to tell. Can you do a recording where you tap track submit and your cursor goes off to see if the controls never show?

rojiphil

@tienifr I have left a comment for an issue that is demonstrated in test video below. Please have a look. Otherwise, I think we are very close to getting this done.

43349-hide-controls-issue.mp4

rojiphil · 2024-07-26T08:01:51Z

src/components/VideoPlayer/BaseVideoPlayer.tsx

@@ -311,7 +358,10 @@ function BaseVideoPlayer({
                                    if (isFullScreenRef.current) {
                                        return;
                                    }
-                                    togglePlayCurrentVideo();
+                                    if (!canUseTouchScreen) {
+                                        togglePlayCurrentVideo();


I think we need an early return here. Otherwise, showControl will trigger the timer to hide the controls for large screen devices.

Suggested change

togglePlayCurrentVideo();

togglePlayCurrentVideo();

return;

rojiphil · 2024-07-26T09:22:11Z

In your mobile video it looks like it's correct where the controls aren't showing, but given your cursor is above the video when it pops up it's hard to tell. Can you do a recording where you tap track submit and your cursor goes off to see if the controls never show?

@dubielzyk-expensify From the code perspective, there is only one pending issue left. As soon as it is addressed, I suggest that we trigger a build (via Ready to Build) so that @Expensify/Design can have the final review on ux before we wrap-up on this.

shawnborton · 2024-07-26T11:35:01Z

I can trigger the build now.

github-actions · 2024-07-26T12:11:43Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

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

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

👀 View the workflow run that generated this build 👀

rojiphil · 2024-07-26T12:14:47Z

Yeah. Reviewing in parallel maybe even better. Just one thing to note. There is one pending issue as mentioned here

dubielzyk-expensify · 2024-07-29T05:59:01Z

Ohh this is looking good. I got two notes:

Can we made the delay before the controls fade starts slightly shorter? What's it at the moment? Felt like is was more than 2 seconds.
It would be awesome if we could get the controls to disappear when you tap on the video as well (when the controls are showing). The auto fade is mostly for when you don't do anything and to make sure the controls disappear automatically when the video is playing.

tienifr · 2024-07-31T09:44:08Z

I updated PR

Can we made the delay before the controls fade starts slightly shorter? What's it at the moment? Felt like is was more than 2 seconds.

@dubielzyk-expensify Currently, the controls stay visible fully for 2000ms, and fade out for 500ms. I made it disappear at once.

dubielzyk-expensify · 2024-07-31T10:06:14Z

Currently, the controls stay visible fully for 2000ms, and fade out for 500ms. I made it disappear at once.

I think keep everything as it was, just reduce the 2000ms down to 1500ms.

tienifr · 2024-08-01T07:28:09Z

Updated.

rojiphil · 2024-08-03T10:20:37Z

2. It would be awesome if we could get the controls to disappear when you tap on the video as well (when the controls are showing).

@dubielzyk-expensify The commits after the above statements has impacted test step A-9 as mentioned here. As per step A-9, if we keep continually tapping on the video player within the timeout interval, the video controls remain shown. However, the controls will auto hide if timeout interval is exhausted after the most recent tap inside video player. The recent commits though forcefully hides the controls on every tap thereby impacting step A-9. Here is a test video after recent commits and I think it’s jittery. Can you confirm if it was intentional to change step A-9 or were you just concerned about reducing the time interval from 2 sec to 1.5 sec?

43349-ios-native-conf-01.mp4

dubielzyk-expensify · 2024-08-05T00:32:03Z

The recent commits though forcefully hides the controls on every tap thereby impacting step A-9.

The goal was that if the controls aren't showing, tapping the screen should show them. And reversely, if the controls aren't showing, tapping them show reveal them. So tapping many times on the screen should show, hide, repeat, multiple times. Tapping the screen should reset the timer for auto-hiding the controls so if a user interacts with it, it should override that behaviour anyways.

Basically the list of interactions are as follow:

Auto-hide controls on startup
Tapping the video canvas should reveal the controls
If nothing is tapped again, then the controls should fade away after 1.5 seconds.
But if a user taps the video canvas again with the controls showing, we should hide the controls

Does that make sense?

rojiphil · 2024-08-05T04:13:14Z

Thanks @dubielzyk-expensify for the clarification.
Accordingly, Step A-9 is changed here from
9. Tap again inside the video player repeatedly within 2 seconds and verify that the video controls do not fade away (#Test 5)
to the following
9. Tap again inside the video playerwithin 1.5 seconds and verify that thevideo controls fade away (#Test 5)

rojiphil · 2024-08-05T04:13:37Z

@tienifr Can you please merge with the latest main? And I can complete the checklist. Thanks.

rojiphil · 2024-08-05T06:59:10Z

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

43349-web-safari-006.mp4

MacOS: Desktop

43349-desktop-006.mp4

iOS: mWeb Safari

43349-mweb-safari-006.mp4

Android: Native

43349-android-native-006.mp4

Android: mWeb Chrome

43349-mweb-chrome-006.mp4

iOS: Native

43349-ios-native-006.mp4

rojiphil

@tienifr Thanks. Just one note. Please update the test cases for QA as mentioned here.

@dubielzyk-expensify Can you please also have one final look at the test steps here just to ensure that we are all on the same page? Thanks.

@MariaHCD I have completed the reviewer checklist and the improvements works well too. Over to you for review.

MariaHCD

LGTM, after approval from design, we should be good to go

dubielzyk-expensify · 2024-08-05T22:42:49Z

Those test steps look good to me 👍

MariaHCD · 2024-08-06T12:29:18Z

@tienifr @rojiphil let's update the test steps for QA in the OP?

rojiphil · 2024-08-07T14:41:08Z

@tienifr @rojiphil let's update the test steps for QA in the OP?

Oh! I do not have privileges to update the OP.
@tienifr Can you please update the QA steps as mentioned here? Thanks

tienifr · 2024-08-08T10:51:45Z

@rojiphil @MariaHCD Updated QA test steps.

OSBotify · 2024-08-08T13:05:16Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

Beamanator · 2024-08-14T20:12:03Z

FYI I believe this was deployed to prod yesterday, from this checklist - #47219

tienifr added 3 commits June 10, 2024 17:03

fix Hide video playback controls on auto-playing videos

944c6ed

fix lint

fe167aa

fix update controlsStatus

9caa203

tienifr marked this pull request as ready for review June 10, 2024 11:00

tienifr requested a review from a team as a code owner June 10, 2024 11:00

melvin-bot bot requested review from rojiphil and removed request for a team June 10, 2024 11:00

tienifr mentioned this pull request Jun 10, 2024

[$250] Hide video playback controls on auto-playing videos #42323

Closed

6 tasks

fix use runOnJS

8a7993d

dubielzyk-expensify requested a review from a team June 11, 2024 23:26

rojiphil reviewed Jun 14, 2024

View reviewed changes

fix merge main

6bf5ec3

tienifr added 2 commits June 26, 2024 14:44

fix merge main

19c70fc

fix auto hide controls after playing video 2s

cf99a4c

fix lint

dd15a3d

rojiphil reviewed Jul 26, 2024

View reviewed changes

do not delay hide control & hide control on tap

53f69d6

reduce hide delay to 1500

8f5c197

Merge branch 'main' of https://github.com/tienifr/App into fix/42323

7034385

rojiphil approved these changes Aug 5, 2024

View reviewed changes

melvin-bot bot requested a review from MariaHCD August 5, 2024 07:11

MariaHCD approved these changes Aug 5, 2024

View reviewed changes

MariaHCD merged commit 4f45424 into Expensify:main Aug 8, 2024
17 checks passed

github-actions bot mentioned this pull request Aug 12, 2024

Deploy Checklist: New Expensify 2024-08-12 #47219

Closed

90 tasks

fix Hide video playback controls on auto-playing videos #43349

fix Hide video playback controls on auto-playing videos #43349

Conversation

tienifr commented Jun 10, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 10, 2024

tienifr commented Jun 10, 2024

dubielzyk-expensify commented Jun 12, 2024

dubielzyk-expensify commented Jun 12, 2024

tienifr commented Jun 12, 2024

rojiphil commented Jun 13, 2024

rojiphil left a comment

Choose a reason for hiding this comment

rojiphil commented Jun 14, 2024

shawnborton commented Jun 14, 2024

rojiphil commented Jun 14, 2024

rojiphil commented Jun 14, 2024

shawnborton commented Jun 14, 2024

tienifr commented Jun 17, 2024

shawnborton commented Jun 19, 2024

tienifr commented Jun 24, 2024 • edited Loading

shawnborton commented Jun 24, 2024

dannymcclain commented Jun 24, 2024

dubielzyk-expensify commented Jul 25, 2024

rojiphil left a comment

Choose a reason for hiding this comment

rojiphil Jul 26, 2024

Choose a reason for hiding this comment

rojiphil commented Jul 26, 2024

shawnborton commented Jul 26, 2024

github-actions bot commented Jul 26, 2024

rojiphil commented Jul 26, 2024

dubielzyk-expensify commented Jul 29, 2024

tienifr commented Jul 31, 2024 • edited Loading

dubielzyk-expensify commented Jul 31, 2024

tienifr commented Aug 1, 2024

rojiphil commented Aug 3, 2024

dubielzyk-expensify commented Aug 5, 2024

rojiphil commented Aug 5, 2024 • edited Loading

rojiphil commented Aug 5, 2024

rojiphil commented Aug 5, 2024

Reviewer Checklist

Screenshots/Videos

rojiphil left a comment

Choose a reason for hiding this comment

MariaHCD left a comment

Choose a reason for hiding this comment

dubielzyk-expensify commented Aug 5, 2024

MariaHCD commented Aug 6, 2024

rojiphil commented Aug 7, 2024

tienifr commented Aug 8, 2024

OSBotify commented Aug 8, 2024

Beamanator commented Aug 14, 2024

tienifr commented Jun 10, 2024 •

edited

Loading

tienifr commented Jun 24, 2024 •

edited

Loading

tienifr commented Jul 31, 2024 •

edited

Loading

rojiphil commented Aug 5, 2024 •

edited

Loading