Fix unstable sound level #53449

sumo-slonik · 2024-12-03T12:09:30Z

Explanation of Change

The logic responsible for proper mute and unmute functionality has been implemented, eliminating audio instability issues on mobile devices.

Fixed Issues

$ #52858

$
PROPOSAL:

Tests

Open any chat.
Send a video.
Play the video.
Adjust the volume several times.

Expected behavior:

The volume remains at the level it was set to.

Verify that no errors appear in the JS console

Offline tests

unnecessary

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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 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 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.ts 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 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.
I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
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.

Screenshots/Videos

Android: Native

android.native_2.mp4

Android: mWeb Chrome

android.web.mp4

iOS: Native

ios.native.mp4

iOS: mWeb Safari

ios.web.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-12-05.at.08.53.23.mp4

MacOS: Desktop

desktop.mac_1.mp4

sumo-slonik · 2024-12-04T12:09:53Z

src/components/VideoPlayer/BaseVideoPlayer.tsx

@@ -211,14 +209,13 @@ function BaseVideoPlayer({
                setIsEnded(false);
            }

-            if (prevIsMutedRef.current && prevVolumeRef.current === 0 && !status.isMuted) {
-                updateVolume(0.25);
+            if (prevIsMuted.get() && volume.get() === 0 && !status.isMuted) {


At first I thought I would be able to get rid of this part completely, however, in the full-screen mode mute states are not properly initialized on first startup, this fixes these lines now

sumo-slonik · 2024-12-04T12:12:55Z

cc: @Skalakid @blazejkustra

blazejkustra · 2024-12-04T15:09:35Z

src/components/VideoPlayer/BaseVideoPlayer.tsx

@@ -90,7 +90,7 @@ function BaseVideoPlayer({
    const isCurrentlyURLSet = currentlyPlayingURL === url;
    const isUploading = CONST.ATTACHMENT_LOCAL_URL_PREFIX.some((prefix) => url.startsWith(prefix));
    const videoStateRef = useRef<AVPlaybackStatus | null>(null);
-    const {updateVolume} = useVolumeContext();
+    const {updateVolume, lastNonZeroVolume, volume} = useVolumeContext();


Eslint is failing here

blazejkustra · 2024-12-04T15:11:31Z

src/components/VideoPlayerContexts/VolumeContext.tsx

-            currentVideoPlayerRef.current.setStatusAsync({volume: newVolume, isMuted: newVolume === 0});
+            currentVideoPlayerRef.current.setStatusAsync({
+                volume: newVolume,
+                isMuted: newVolume === 0,
+            });


Nothing was changed here, right? Let's revert

blazejkustra · 2024-12-04T15:11:55Z

src/components/VideoPlayerContexts/VolumeContext.tsx

            volume.set(newVolume);
        },
        [currentVideoPlayerRef, volume],
    );
-


Here as well, let's add the empty line back

blazejkustra · 2024-12-04T15:12:58Z

src/components/VideoPlayer/VideoPlayerControls/VolumeButton/index.tsx

+    const toggleMute = () => {
+        if (volume.get() !== 0) {
+            lastNonZeroVolume.set(volume.get());
+        }
+        updateVolume(volume.get() === 0 ? lastNonZeroVolume.get() : 0);
+    };


How about moving this logic to the Volume context? Additionally, I strongly recommend adding a comment to clearly explain its purpose.

blazejkustra · 2024-12-04T15:16:44Z

src/components/VideoPlayer/BaseVideoPlayer.tsx

@@ -211,14 +210,15 @@ function BaseVideoPlayer({
                setIsEnded(false);
            }

-            if (prevIsMutedRef.current && prevVolumeRef.current === 0 && !status.isMuted) {
-                updateVolume(0.25);
+            if (prevIsMuted.get() && prevVolume.get() === 0 && !status.isMuted) {


Let's add a comment explaining why this logic is necessary

blazejkustra

Awesome! LGTM

melvin-bot · 2024-12-05T13:08:40Z

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

blazejkustra · 2024-12-05T14:15:11Z

@hungvu193 Please check out the original PR that caused this issue. The idea was to implement it similarly to how youtube works, and remove the faulty code and refs completely

hungvu193 · 2024-12-05T14:16:08Z

Thanks for the context. I'll take a look

hungvu193 · 2024-12-05T17:20:56Z

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 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.ts 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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

Screen.Recording.2024-12-06.at.00.08.47.mov

Android: mWeb Chrome

Uploading mWeb.mov.....

iOS: Native

IOS.mov

iOS: mWeb Safari

Screen.Recording.2024-12-06.at.00.20.06.mov

MacOS: Chrome / Safari

Screen.Recording.2024-12-05.at.23.58.59.mov

Screen.Recording.2024-11-17.at.18.20.31.mov

MacOS: Desktop

Desk.mov

melvin-bot · 2024-12-05T17:21:20Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #52858 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

blimpich

LGTM! Nice work!

OSBotify · 2024-12-05T18:50:41Z

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

github-actions · 2024-12-09T16:29:08Z

🚀 Deployed to staging by https://github.com/blimpich in version: 9.0.73-0 🚀

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

github-actions · 2024-12-10T22:47:22Z

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.73-8 🚀

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

fix unstable sound level bug

2c91dcf

sumo-slonik force-pushed the bugfix/kuba_nowakowski/unstable_sound_level branch from b4776b5 to 2c91dcf Compare December 3, 2024 12:16

sumo-slonik added 2 commits December 3, 2024 18:21

working logic move to sound context

10c3901

code cleaning before PR

f98f9da

sumo-slonik force-pushed the bugfix/kuba_nowakowski/unstable_sound_level branch from 140860a to f98f9da Compare December 4, 2024 09:22

apply Blazej suggestions

b1199ce

sumo-slonik commented Dec 4, 2024

View reviewed changes

Skalakid approved these changes Dec 4, 2024

View reviewed changes

fix full screen unmute bug

bb836ca

sumo-slonik force-pushed the bugfix/kuba_nowakowski/unstable_sound_level branch from 34a46c8 to bb836ca Compare December 4, 2024 14:37

blazejkustra suggested changes Dec 4, 2024

View reviewed changes

changes after code review

d8c55a8

sumo-slonik force-pushed the bugfix/kuba_nowakowski/unstable_sound_level branch from 29e66fd to d8c55a8 Compare December 5, 2024 07:58

sumo-slonik requested a review from blazejkustra December 5, 2024 08:12

blazejkustra approved these changes Dec 5, 2024

View reviewed changes

sumo-slonik marked this pull request as ready for review December 5, 2024 13:08

sumo-slonik requested a review from a team as a code owner December 5, 2024 13:08

melvin-bot bot requested a review from hungvu193 December 5, 2024 13:08

melvin-bot bot removed the request for review from a team December 5, 2024 13:08

sumo-slonik mentioned this pull request Dec 5, 2024

[HOLD for payment 2024-12-17] [$250] unstable sound levels after unmuting the video #52858

Closed

8 tasks

hungvu193 approved these changes Dec 5, 2024

View reviewed changes

blimpich assigned sumo-slonik Dec 5, 2024

blimpich approved these changes Dec 5, 2024

View reviewed changes

blimpich merged commit 2479379 into Expensify:main Dec 5, 2024
17 of 18 checks passed

github-actions bot mentioned this pull request Dec 9, 2024

Deploy Checklist: New Expensify 2024-12-09 #53762

Closed

70 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix unstable sound level #53449

Fix unstable sound level #53449

sumo-slonik commented Dec 3, 2024 •

edited

Loading

sumo-slonik Dec 4, 2024

sumo-slonik commented Dec 4, 2024

blazejkustra Dec 4, 2024

blazejkustra Dec 4, 2024

blazejkustra Dec 4, 2024

blazejkustra Dec 4, 2024

blazejkustra Dec 4, 2024

blazejkustra left a comment

melvin-bot bot commented Dec 5, 2024

blazejkustra commented Dec 5, 2024

hungvu193 commented Dec 5, 2024 •

edited

Loading

hungvu193 commented Dec 5, 2024

melvin-bot bot commented Dec 5, 2024

blimpich left a comment

OSBotify commented Dec 5, 2024

github-actions bot commented Dec 9, 2024

github-actions bot commented Dec 10, 2024

Fix unstable sound level #53449

Fix unstable sound level #53449

Conversation

sumo-slonik commented Dec 3, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Expected behavior:

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

sumo-slonik Dec 4, 2024

Choose a reason for hiding this comment

sumo-slonik commented Dec 4, 2024

blazejkustra Dec 4, 2024

Choose a reason for hiding this comment

blazejkustra Dec 4, 2024

Choose a reason for hiding this comment

blazejkustra Dec 4, 2024

Choose a reason for hiding this comment

blazejkustra Dec 4, 2024

Choose a reason for hiding this comment

blazejkustra Dec 4, 2024

Choose a reason for hiding this comment

blazejkustra left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Dec 5, 2024

blazejkustra commented Dec 5, 2024

hungvu193 commented Dec 5, 2024 • edited Loading

hungvu193 commented Dec 5, 2024

Reviewer Checklist

Screenshots/Videos

melvin-bot bot commented Dec 5, 2024

blimpich left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 5, 2024

github-actions bot commented Dec 9, 2024

github-actions bot commented Dec 10, 2024

sumo-slonik commented Dec 3, 2024 •

edited

Loading

hungvu193 commented Dec 5, 2024 •

edited

Loading