Use platform specific mute setting for sounds #52088

c3024 · 2024-11-06T04:00:54Z

Explanation of Change

This PR uses the platform specific mute settings for sounds. This is a followup PR for #50493 to fix these issues.

Fixed Issues

$ #49087
PROPOSAL: NA

Tests

Same as QA tests

Verify that no errors appear in the JS console

Offline tests

None

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."
Test 1:

Logon to ND
Switch the mute setting in Preferences page to On
Navigate to any chat and send a message in it
Verify that no sounds play

Test 2:

Logon to ND app on iOS or Android
Switch the mute setting in Preferences page to On
Click on FAB > Submit Expense > Scan
Take a photo with the camera
Verify that no sound plays

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

soundAndroid-compressed.mp4

Android: mWeb Chrome

soundMWebAndroid-compressed.mp4

iOS: Native

soundiOS.mp4

iOS: mWeb Safari

soundmWebiOS-compressed.mp4

MacOS: Chrome / Safari

muteSoundChrome.mp4

MacOS: Desktop

soundDesktop.mp4

melvin-bot · 2024-11-06T04:25:21Z

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

jjcoffee · 2024-11-06T12:22:43Z

src/libs/Sound/BaseSound.ts

-    callback: (val) => (isMuted = !!val?.isMutedAllSounds),
+    key: ONYXKEYS.NVP_MUTED_PLATFORMS,
+    callback: (val) => {
+        const platform = Browser.isMobile() ? CONST.PLATFORM.MOBILEWEB : getPlatform();


This isn't very DRY, should we maybe spin this out into a function (it will avoid problems in future too)?

jjcoffee · 2024-11-06T12:23:03Z

@c3024 So for this issue ~~I guess a message must have been sent first before the sign out~~ what would be the cause? I imagine the mute setting maybe wasn't re-enabled once the PR hit staging (as it would need to be in order for BE to pick up the correct setting).

jjcoffee · 2024-11-06T12:23: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: 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.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

android-app-2024-11-06_13.38.45.mp4

Android: mWeb Chrome

android-chrome-2024-11-06_13.40.38.mp4

iOS: Native

ios-app-2024-11-06_14.01.56.mp4

iOS: mWeb Safari

ios-safari-2024-11-06_13.49.53.mp4

MacOS: Chrome / Safari

desktop-chrome-2024-11-06_13.32.17.mp4

MacOS: Desktop

desktop-app-2024-11-06_13.35.47.mp4

c3024 · 2024-11-06T12:43:12Z

@jjcoffee

I think @mallenexpensify found that there were still sounds even after muting. I think he did not check the toggling of the setting in preferences page. It must be working fine but sounds were not disabled.

jjcoffee

Just need to DRY up code & add missing screenshots. Thanks! 🙏

c3024 · 2024-11-06T15:15:51Z

@jjcoffee

Done. Please have a look!

jjcoffee

LGTM! Thanks for the fix!

tgolen · 2024-11-06T16:51:43Z

src/libs/getPlatform/index.ts

 import CONST from '@src/CONST';
 import type Platform from './types';

-export default function getPlatform(): Platform {
+export default function getPlatform(treatMWebDifferently = false): Platform {


Would you mind renaming this param to shouldMobileWebBeDistinctFromWeb?

Done. And I was thinking for a smaller name because treatMWebDifferently was already mouthful.

Variable naming is one of the hardest things! Luckily code-minifiers usually render the name length insignificant in the end, so I prefer more clarity. Thanks!

OSBotify · 2024-11-06T17:40:29Z

✋ 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-11-07T13:10:14Z

🚀 Deployed to staging by https://github.com/tgolen in version: 9.0.59-0 🚀

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

c3024 added 2 commits November 6, 2024 09:30

use platform specific mute setting for sounds

2f578b4

remove unused user

fa7b684

c3024 marked this pull request as ready for review November 6, 2024 04:25

c3024 requested a review from a team as a code owner November 6, 2024 04:25

melvin-bot bot requested review from jjcoffee and removed request for a team November 6, 2024 04:25

c3024 added 2 commits November 6, 2024 10:17

mobileweb specific mute setting

68f1166

remove unused onyx prop

6de5680

jjcoffee reviewed Nov 6, 2024

View reviewed changes

jjcoffee suggested changes Nov 6, 2024

View reviewed changes

jjcoffee mentioned this pull request Nov 6, 2024

[HOLD for payment 2024-11-11] [$250] The setting "Mute all sounds from Expensify" keeps turning back off despite turning it on every day. #49087

Open

6 tasks

c3024 added 2 commits November 6, 2024 20:09

dry mWeb platform

ce16714

prettier

44caeb1

jjcoffee approved these changes Nov 6, 2024

View reviewed changes

melvin-bot bot requested a review from tgolen November 6, 2024 15:28

tgolen requested changes Nov 6, 2024

View reviewed changes

rename param

070eebc

tgolen approved these changes Nov 6, 2024

View reviewed changes

tgolen merged commit 9980299 into Expensify:main Nov 6, 2024
18 checks passed

github-actions bot mentioned this pull request Nov 7, 2024

Deploy Checklist: New Expensify 2024-11-07 #52178

Open

47 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use platform specific mute setting for sounds #52088

Use platform specific mute setting for sounds #52088

c3024 commented Nov 6, 2024 •

edited

Loading

melvin-bot bot commented Nov 6, 2024

jjcoffee Nov 6, 2024

jjcoffee commented Nov 6, 2024 •

edited

Loading

jjcoffee commented Nov 6, 2024 •

edited

Loading

c3024 commented Nov 6, 2024

jjcoffee left a comment

c3024 commented Nov 6, 2024

jjcoffee left a comment

tgolen Nov 6, 2024

c3024 Nov 6, 2024

tgolen Nov 6, 2024

OSBotify commented Nov 6, 2024

github-actions bot commented Nov 7, 2024

Use platform specific mute setting for sounds #52088

Use platform specific mute setting for sounds #52088

Conversation

c3024 commented Nov 6, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 6, 2024

jjcoffee Nov 6, 2024

Choose a reason for hiding this comment

jjcoffee commented Nov 6, 2024 • edited Loading

jjcoffee commented Nov 6, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

c3024 commented Nov 6, 2024

jjcoffee left a comment

Choose a reason for hiding this comment

c3024 commented Nov 6, 2024

jjcoffee left a comment

Choose a reason for hiding this comment

tgolen Nov 6, 2024

Choose a reason for hiding this comment

c3024 Nov 6, 2024

Choose a reason for hiding this comment

tgolen Nov 6, 2024

Choose a reason for hiding this comment

OSBotify commented Nov 6, 2024

github-actions bot commented Nov 7, 2024

c3024 commented Nov 6, 2024 •

edited

Loading

jjcoffee commented Nov 6, 2024 •

edited

Loading

jjcoffee commented Nov 6, 2024 •

edited

Loading