Don't play video if app is not visible #47217

bernhardoj · 2024-08-12T09:42:04Z

Details

When a video is played while the app is in background, a console error is thrown. This PR fix it.

Fixed Issues

$ #47162
PROPOSAL: #47162 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Login as a new user
Complete the onboarding form
Quickly switch tab or background the app before the onboarding video is shown
Wait for a few seconds until the welcome video page is loaded
Return back to the tap/open the app back
Verify the video is played
Verify there is no console error of "The play() request was interrupted because video-only background media was paused to save power" (this is a web error only)

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

android.mweb.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

ios.mweb.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

melvin-bot · 2024-08-12T09:42:09Z

@aimane-chnaif 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 · 2024-08-12T09:43:44Z

src/components/VideoPlayerContexts/PlaybackContext.tsx

@@ -94,12 +100,23 @@ function PlaybackContextProvider({children}: ChildrenProps) {
        // This prevents the video that plays when the app opens from being interrupted when currentReportID
        // is initially empty or '-1', or when it changes from empty/'-1' to another value
        // after the report screen in the central pane is mounted on the large screen.
-        if (!currentReportID || !prevCurrentReportID || currentReportID === '-1' || prevCurrentReportID === '-1') {
+        if (!currentReportID || !prevCurrentReportID || currentReportID === '-1' || prevCurrentReportID === '-1' || currentReportID === prevCurrentReportID) {


I added this since resetVideoPlayerData is called which clears the ref and the pending play video below won't do anything since the ref is already null. So, when we come back to the app/tab, the video isn't played.

It was added and explained here. I somehow miss the case to compare the prev and current value.

aimane-chnaif · 2024-08-12T19:26:31Z

You skipped pre-steps.

Open staging.new.expensify.com/onboarding/welcome-video

This doesn't work for existing accounts. It shows not found page.

It's pre-requisite to test with new acount.

aimane-chnaif · 2024-08-12T19:36:49Z

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

Android: Native

android2.mp4

Android: mWeb Chrome

iOS: Native

ios.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

web1.mov

web2.mov

MacOS: Desktop

aimane-chnaif · 2024-08-12T20:04:20Z

Got this console error while testing on native. Not blocker since this is existing bug before this PR.

aimane-chnaif

Looks good.

@bernhardoj please see #47217 (comment)

bernhardoj · 2024-08-13T03:58:29Z

Updated

OSBotify · 2024-08-13T07:09:17Z

✋ 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-08-13T20:40:31Z

🚀 Deployed to staging by https://github.com/techievivek in version: 9.0.20-0 🚀

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

Beamanator · 2024-08-16T19:55:03Z

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

don't play video if app is not visible

b8a8358

bernhardoj requested a review from a team as a code owner August 12, 2024 09:42

melvin-bot bot requested a review from aimane-chnaif August 12, 2024 09:42

melvin-bot bot removed the request for review from a team August 12, 2024 09:42

bernhardoj commented Aug 12, 2024

View reviewed changes

aimane-chnaif approved these changes Aug 12, 2024

View reviewed changes

melvin-bot bot requested a review from techievivek August 12, 2024 20:05

techievivek assigned bernhardoj Aug 13, 2024

techievivek approved these changes Aug 13, 2024

View reviewed changes

techievivek merged commit 9819f37 into Expensify:main Aug 13, 2024
18 of 19 checks passed

Christinadobrzyn mentioned this pull request Aug 13, 2024

[Payment due 8-26][$250] Web - Onboarding - "welcome-video:1 DOMException" console error if an app is opened before video #47162

Closed

6 tasks

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

Deploy Checklist: New Expensify 2024-08-13 #47356

Closed

72 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Don't play video if app is not visible #47217

Don't play video if app is not visible #47217

bernhardoj commented Aug 12, 2024 •

edited

Loading

melvin-bot bot commented Aug 12, 2024

bernhardoj Aug 12, 2024 •

edited

Loading

aimane-chnaif commented Aug 12, 2024

aimane-chnaif commented Aug 12, 2024 •

edited

Loading

aimane-chnaif commented Aug 12, 2024

aimane-chnaif left a comment

bernhardoj commented Aug 13, 2024

OSBotify commented Aug 13, 2024

OSBotify commented Aug 13, 2024

Beamanator commented Aug 16, 2024

Don't play video if app is not visible #47217

Don't play video if app is not visible #47217

Conversation

bernhardoj commented Aug 12, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 12, 2024

bernhardoj Aug 12, 2024 • edited Loading

Choose a reason for hiding this comment

aimane-chnaif commented Aug 12, 2024

aimane-chnaif commented Aug 12, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

aimane-chnaif commented Aug 12, 2024

aimane-chnaif left a comment

Choose a reason for hiding this comment

bernhardoj commented Aug 13, 2024

OSBotify commented Aug 13, 2024

OSBotify commented Aug 13, 2024

Beamanator commented Aug 16, 2024

bernhardoj commented Aug 12, 2024 •

edited

Loading

bernhardoj Aug 12, 2024 •

edited

Loading

aimane-chnaif commented Aug 12, 2024 •

edited

Loading