[Android|iOS] overwrite system sound for push notifications via a custom one

[kirillzyusko]

Details

Based on the assumption, that we receive push-notification only for plain messages -> we can skip a call to playSound(SOUNDS.RECEIVE) and change a native code to play a receive sound (that's exactly what I did in this PR).

Fixed Issues

$ #36579
$ #36714
PROPOSAL: N/A

Tests

1. Open app on two devices (A - iOS, B - Android)
2. Send a message from device A to device B
3. Be sure that you hear a custom sound only when message is received (plain messages)
4. Send message from device B to device A
5. Be sure that you hear a custom sound only when message is received (plain messages)
6. Open app on two devices (any platforms, exclude iOS/Android platform)
7. Send a message from device A to device B
8. Be sure that sound can be heard

• Verify that no errors appear in the JS console

Offline tests

Not needed.

QA Steps

For Android, you should completely uninstall and reinstall the app first!

1. Open app on two devices (A - iOS, B - Android)
2. Send a message from device A to device B
3. Be sure that you hear a custom sound only when push notification is received
4. Send message from device B to device A
5. Be sure that you hear a custom sound only when message is received
6. Open app on two devices (any platforms, exclude iOS/Android platform)
7. Send a message from device A to device B
8. Be sure that sound can be heard

• 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 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • 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 form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label 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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[melvin-bot]

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

[Julesssss]

Nice, I'm generating some test builds.

[Julesssss]

Android isn't working for me, I still get the default notification sound.

[kirillzyusko]

Android isn't working for me, I still get the default notification sound.

Can you try to clean app data or do a clean installation? I had the same problem - it seems like if channel is created then it's kind of persisted, so the modified code (new sound) will not be applied.

[Julesssss]

Can you try to clean app data or do a clean installation?

Yep, working now on Android 👍

iOS is going to be a problem to test though, I might need to build locally

[kirillzyusko]

Yep, working now on Android 👍

By the way I still think it's a bug, because if we publish a new version, then people will have to re-install app in order not to hear default sound - maybe we need to find a way on how to invalidate channel without an additional user interaction?

[Julesssss]

maybe we need to find a way on how to invalidate channel without an additional user interaction?

Ah, seems like a new channel is the solution. Though I'd rather not do that. We've barely started to migrate users yet so this isn't really a problem

After you create a notification channel, you can't change the notification behaviors.

[kirillzyusko]

After you create a notification channel, you can't change the notification behaviors.

I thought about deleting an old channel and creating a new one (and adding versioning to this). But if it's not a problem, then okay 🙂

[Julesssss]

Hey @abdulrahuman5196 can you review this, excluding iOS? For Android the generated build should work, and for the other platforms we should still here the received message sound.

[Julesssss]

@kirillzyusko I think the test steps are wrong. We want two tests, one for iOS/Android and another for the other platforms to ensure the sound plays

[abdulrahuman5196]

Sure @Julesssss will work on testing

[kirillzyusko]

I think the test steps are wrong. We want two tests, one for iOS/Android and another for the other platforms to ensure the sound plays

@Julesssss I updated test steps 👍

[abdulrahuman5196]

@kirillzyusko Couple of auto-checks are failing for this PR? Could you kindly check on the same?

@Julesssss Could you kindly generate builds again, since we had changes after the last build?

[Julesssss]

@Julesssss Could you kindly generate builds again, since we had changes after the last build?

Build in progress 👍

[github-actions]

🧪🧪 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/36807/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/36807/index.html
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/36807/NewExpensify.dmg	https://36807.pr-testing.expensify.com

---

👀 View the workflow run that generated this build 👀

[Julesssss]

@kirillzyusko I see there's a podfile error, have you been able to build ios and test that the audio doesn't play when a simulator receives a message?

[kirillzyusko]

I see there's a podfile error, have you been able to build ios and test that the audio doesn't play when a simulator receives a message?

@Julesssss I think I also had a changed Podfile after Pods installation, but it wasn't related to changes that I did, so I thought that problem comes from main, so I didn't commit the lock file. I pulled latest changes from main - I believe the problem should gone 🤞

[Julesssss]

@kirillzyusko can you add screenshots and check that item off the list please

[abdulrahuman5196]

@Julesssss / @kirillzyusko

Be sure that you hear a custom sound only when message is received (plain messages)

Does this mean only messages without any markdown? I hear sound for message I have strikethrough and italic features added.

Am I mis-understanding something here?

But anyways I tested android and I get the custom sound for all types of push notification in android.

[kirillzyusko]

I hear sound for message I have strikethrough and italic features added.

@abdulrahuman5196 no, presence of markdown in messages shouldn't make any impact. By "plain" messages I meant all messages excluding mentions/money transfers/task completion/etc.

[github-actions]

🧪🧪 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/36807/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/36807/index.html
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/36807/NewExpensify.dmg	https://36807.pr-testing.expensify.com

---

👀 View the workflow run that generated this build 👀

[abdulrahuman5196]

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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • 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 form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label 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

az_recorder_20240222_001933.mp4

Android: mWeb Chrome

az_recorder_20240222_002259.mp4

iOS: Native

iOS: mWeb Safari

Recording.62.MOV

MacOS: Chrome / Safari

Screen.Recording.2024-02-22.at.12.46.30.AM.mov

MacOS: Desktop

Screen.Recording.2024-02-22.at.12.50.16.AM.mov

[abdulrahuman5196]

@Julesssss I am unable to test in iOS native alone, since I am not part of the development profile like here https://expensify.slack.com/archives/C02NK2DQWUX/p1698038568836489

I tested on other platforms.

Could you kindly test in iOS native and have a quick look?

[abdulrahuman5196]

Changes looks good and works well. Reviewers checklist is also complete.

All yours. @Julesssss

🎀 👀 🎀
C+ Reviewed

[Julesssss]

I'm really struggling to get our dev iOS build working on a phyiscal device (required for push notification testing).

I've asked for help, but I fear we may have recently broken our env configuration. I'll return to this PR review once I have resolved my issues.

[Julesssss]

It's currently impossible to test this on iOS, so I'll test on staging with an InternalQA blocker. If necessary I will revert

[OSBotify]

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

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.4.44-0 🚀

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

[Julesssss]

Okay, I have verified Android, and @dylanexpensify has verified Android. Excellent 🎉

[OSBotify]

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.44-13 🚀

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