Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Fix playing Shutter Sound in Scan Receipt #39400

Merged
merged 11 commits into from
Apr 4, 2024

Conversation

mrousavy
Copy link
Contributor

@mrousavy mrousavy commented Apr 2, 2024

Details

Fixes playing shutter sound in scan receipt page when:

  1. ..sound is explicitly disabled in app settings (Android + iOS)
  2. ..phone is on silent/vibrate ringer mode (Android)

Fixed Issues

$ #39241
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console
  1. Toggle sound mode in app preferences (try on/off) or toggle phone's vibrate/silent mode
  2. Go to some report
  3. Click on the "+" icon in the composer
  4. Select "Request money"
  5. In the "Scan" tab, take a photo
  6. If sound is enabled (in both app and phone), make sure there is a sound. If not, make sure there isn't

Offline tests

None needed.

QA Steps

  • Verify that no errors appear in the JS console

Same as in Tests.

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 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
      • If any non-english text was added/modified, I verified the translation was requested/reviewed 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.js 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.
  • 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
Screen_Recording_20240403_161420_New_Expensify_Dev.mp4
Screen_Recording_20240403_161452_New_Expensify_Dev.mp4
Android: mWeb Chrome
iOS: Native
RPReplay_Final1712153932.mov
RPReplay_Final1712153897.mov
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

Only provided screen captures for iOS and Android. Web not affected

@mrousavy mrousavy requested a review from a team as a code owner April 2, 2024 11:13
@melvin-bot melvin-bot bot requested review from ntdiary and removed request for a team April 2, 2024 11:13
Copy link

melvin-bot bot commented Apr 2, 2024

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

@@ -63,6 +65,7 @@ function IOURequestStepScan({
const device = useCameraDevice('back', {
physicalDevices: ['wide-angle-camera'],
});
const [user] = useOnyx(ONYXKEYS.USER)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should I use a selector for only isMutedAllSounds here, or is this fine?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dont think we can use useOnyx yet, please use selector

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How would that look like then? Onyx.connect(...)?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mountiny what is the reason we shouldn't use `useOnyx yet?

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ntdiary Will you be able to review this one quickly?

@@ -63,6 +65,7 @@ function IOURequestStepScan({
const device = useCameraDevice('back', {
physicalDevices: ['wide-angle-camera'],
});
const [user] = useOnyx(ONYXKEYS.USER)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dont think we can use useOnyx yet, please use selector

@@ -31,6 +31,8 @@ import reportPropTypes from '@pages/reportPropTypes';
import * as IOU from '@userActions/IOU';
import CONST from '@src/CONST';
import ROUTES from '@src/ROUTES';
import Onyx, {useOnyx} from 'react-native-onyx';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
import Onyx, {useOnyx} from 'react-native-onyx';
import {withOnyx} from 'react-native-onyx';

@@ -63,6 +65,7 @@ function IOURequestStepScan({
const device = useCameraDevice('back', {
physicalDevices: ['wide-angle-camera'],
});
const [user] = useOnyx(ONYXKEYS.USER)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const [user] = useOnyx(ONYXKEYS.USER)

Copy link
Contributor

@c3024 c3024 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

    transaction: {isFromGlobalCreate},
    user

at

transaction: {isFromGlobalCreate},

export default compose(withWritableReportOrNotFound, withFullTransactionOrNotFound, withOnyx({
    user: {
        key: ONYXKEYS.USER,
    }
}))(IOURequestStepScan);

at

export default compose(withWritableReportOrNotFound, withFullTransactionOrNotFound)(IOURequestStepScan);

@c3024
Copy link
Contributor

c3024 commented Apr 2, 2024

    report: {},
    transaction: {},
    user: {}

report: {},
transaction: {},

@c3024
Copy link
Contributor

c3024 commented Apr 2, 2024

There is shutter sound even when enableShutterSound is false on android. 🤔 💭

@mrousavy
Copy link
Contributor Author

mrousavy commented Apr 2, 2024

@c3024 are you by any chance in Japan?

Maybe the MediaActionSound.mustPlayShutterSound() method returns true?

@c3024
Copy link
Contributor

c3024 commented Apr 2, 2024

No, I am in India. The phone is a Xiaomi. The camera app of the device has an option to disable shutter sound. Disabling it disables the shutter sound in the camera app. So, I think this might not be happening due to regional restrictions.

But shutter sound plays when sounds are muted in settings in New Expensify app.

@mrousavy
Copy link
Contributor Author

mrousavy commented Apr 2, 2024

Can you check your adb logcat logs?

Look for something like:

This phone must play a shutter sound due to regional restrictions, enabling shutter sound...

See mrousavy/react-native-vision-camera@86c0f86

@c3024
Copy link
Contributor

c3024 commented Apr 3, 2024

Yes, that was logged.

Screenshot 2024-04-03 at 10 27 23 AM

Looks like other apps are not obeying the regional restrictions. WhatsApp plays no shutter sound and the phone default camera app has a setting to disable shutter sound.

@mrousavy
Copy link
Contributor Author

mrousavy commented Apr 3, 2024

Well I guess then I'll just remove that check, seems to be ignored?
I'll push another update later today then.

@mrousavy mrousavy requested a review from chrispader April 3, 2024 14:29
@chrispader
Copy link
Contributor

@ntdiary @c3024 could you please give this PR another review? :)

@mrousavy
Copy link
Contributor Author

mrousavy commented Apr 3, 2024

Not sure how to proceed with the mustPlayShutterSound() - per documentation it is a regional restriction (often a law, eg Japan) to play a shutter sound when this value is true.

I can of course take it out, it probably won't cause any trouble. Just need to know

@chrispader
Copy link
Contributor

@c3024 as @mrousavy wrote, we'll remove the check for mustPlayShutterSound() so pls either wait until we updated the react-native-vision-camera version or ignore this until we changed it

@c3024
Copy link
Contributor

c3024 commented Apr 4, 2024

@mountiny I see many apps disregard this requirement. I think we can remove that check.

Could you confirm this?

@mrousavy
Copy link
Contributor Author

mrousavy commented Apr 4, 2024

Released 4.0.0-beta.13 that doesn't use mustPlayShutterSound() anymore 👍

@chrispader can you update the version in E/App?

@chrispader
Copy link
Contributor

@c3024 @ntdiary updated react-native-vision-camera, so hopefully all problems should be resolved now. Lmk if there is anything else to address in this PR

@@ -42,6 +45,12 @@ const propTypes = {
/** The report that the transaction belongs to */
report: reportPropTypes,

/** Information about the logged in user's account */
user: PropTypes.shape({
/** Whether or not the user is on a public domain email account or not */
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/** Whether or not the user is on a public domain email account or not */
/** Whether user muted all sounds in application */

@c3024
Copy link
Contributor

c3024 commented Apr 4, 2024

@mountiny could you add Ready to Build label?

@c3024
Copy link
Contributor

c3024 commented Apr 4, 2024

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
shutterAndroid-compressed.mp4
Android: mWeb Chrome
iOS: Native
shutteriOS-compressed.mp4
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@mountiny
Copy link
Contributor

mountiny commented Apr 4, 2024

Running the build

Copy link
Contributor

github-actions bot commented Apr 4, 2024

Copy link
Contributor

@c3024 c3024 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@melvin-bot melvin-bot bot requested a review from johnmlee101 April 4, 2024 15:20
Copy link
Contributor

@johnmlee101 johnmlee101 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice!

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @chrispader @mrousavy @c3024

Going to go ahead and merge this now that John also approved

@mountiny mountiny merged commit 015581f into Expensify:main Apr 4, 2024
19 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Apr 8, 2024

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

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

@OSBotify
Copy link
Contributor

OSBotify commented Apr 8, 2024

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

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.61-8 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants