[Android|iOS] overwrite system sound for push notifications via a custom one by kirillzyusko · Pull Request #36807 · Expensify/App

kirillzyusko · 2024-02-19T16:28:28Z

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

Open app on two devices (A - iOS, B - Android)
Send a message from device A to device B
Be sure that you hear a custom sound only when message is received (plain messages)
Send message from device B to device A
Be sure that you hear a custom sound only when message is received (plain messages)
Open app on two devices (any platforms, exclude iOS/Android platform)
Send a message from device A to device B
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!

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

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-02-19T16:28:34Z

@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 · 2024-02-20T11:20:43Z

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 · 2024-02-20T11:28:01Z

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 · 2024-02-20T11:31:03Z

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 · 2024-02-20T11:34:29Z

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 · 2024-02-20T11:37:40Z

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 · 2024-02-20T14:14:05Z

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 · 2024-02-20T14:15:07Z

@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 · 2024-02-20T14:37:43Z

Sure @Julesssss will work on testing

kirillzyusko · 2024-02-20T14:56:59Z

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 · 2024-02-21T09:36:23Z

@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 · 2024-02-21T10:06:49Z

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

Build in progress 👍

github-actions · 2024-02-21T10:25:12Z

🧪🧪 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 · 2024-02-21T10:46:52Z

@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?

…hannel

kirillzyusko · 2024-02-21T12:26:39Z

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 · 2024-02-21T13:29:38Z

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

abdulrahuman5196 · 2024-02-21T13:45:50Z

@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 · 2024-02-21T15:46:26Z

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 · 2024-02-21T17:01:13Z

🧪🧪 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 · 2024-02-21T19:34:34Z

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 · 2024-02-21T19:38:49Z

@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 · 2024-02-26T12:14:04Z

✋ 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-02-26T21:08:56Z

🚀 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 · 2024-02-27T11:50:01Z

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

OSBotify · 2024-02-28T23:57:32Z

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

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

fix: overwrite system sound for push notifications via a custom one

eb6e684

kirillzyusko requested a review from a team as a code owner February 19, 2024 16:28

melvin-bot Bot requested review from abdulrahuman5196 and removed request for a team February 19, 2024 16:28

Julesssss added the Ready To Build label Feb 19, 2024

Julesssss reviewed Feb 19, 2024

View reviewed changes

Comment thread ...d/app/src/main/java/com/expensify/chat/customairshipextender/CustomNotificationProvider.java Resolved

This comment has been minimized.

Sign in to view

chore: changes after code review

5f14d62

Julesssss reviewed Feb 20, 2024

View reviewed changes

Comment thread src/libs/actions/User.ts Resolved

Julesssss reviewed Feb 20, 2024

View reviewed changes

chore: changes after code review

e38e062

kirillzyusko added 2 commits February 21, 2024 13:08

fix: don't play sound on mobile when someone mentions you or entire c…

e140633

…hannel

Merge branch 'main' into fix/36579-sound-from-push-notification

a593870

Merge branch 'main' into fix/36579-sound-from-push-notification

b9068f9

Julesssss mentioned this pull request Feb 21, 2024

[$500] User receiving "new message" notification sound even if the phone is on DND #36714

Closed

1 of 6 tasks

Julesssss reviewed Feb 21, 2024

View reviewed changes

Comment thread src/libs/actions/User.ts Resolved

refactor: playSoundOnWebOnly -> playSoundExcludingMobile

9e9476e

abdulrahuman5196 approved these changes Feb 21, 2024

View reviewed changes

melvin-bot Bot requested a review from Julesssss February 21, 2024 19:40

Julesssss reviewed Feb 23, 2024

View reviewed changes

Julesssss approved these changes Feb 26, 2024

View reviewed changes

Julesssss added the InternalQA This pull request required internal QA label Feb 26, 2024

Julesssss changed the title ~~fix: overwrite system sound for push notifications via a custom one~~ [Android|iOS] overwrite system sound for push notifications via a custom one Feb 26, 2024

Julesssss merged commit 6d20997 into Expensify:main Feb 26, 2024

github-actions Bot mentioned this pull request Feb 26, 2024

Deploy Checklist: New Expensify 2024-02-26 #37224

Closed

Julesssss mentioned this pull request Feb 29, 2024

[Hold for payment - 2024-03-07] MEDIUM: Custom message sound not consistent on mobile #36579

Closed

2 of 6 tasks

dukenv0307 mentioned this pull request Mar 11, 2024

Fix/37098: In app sound is played if user not viewing chat #37872

Merged

50 tasks done

c3024 mentioned this pull request Jul 22, 2024

[$250] Notification – Have no sound notification for message #45243

Closed

1 of 6 tasks

nkdengineer mentioned this pull request Apr 3, 2025

[Due for payment 2025-04-28] [$250] Android Hybrid - No sound for incoming messages in 1:1 chat #59546

Closed

1 of 8 tasks

Conversation

kirillzyusko commented Feb 19, 2024 • edited by Julesssss Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Feb 19, 2024

Uh oh!

Julesssss left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This comment has been minimized.

Uh oh!

Julesssss left a comment

Choose a reason for hiding this comment

Uh oh!

kirillzyusko commented Feb 20, 2024

Uh oh!

Julesssss commented Feb 20, 2024

Uh oh!

kirillzyusko commented Feb 20, 2024

Uh oh!

Julesssss commented Feb 20, 2024

Uh oh!

kirillzyusko commented Feb 20, 2024

Uh oh!

Julesssss commented Feb 20, 2024

Uh oh!

Julesssss commented Feb 20, 2024

Uh oh!

abdulrahuman5196 commented Feb 20, 2024

Uh oh!

kirillzyusko commented Feb 20, 2024

Uh oh!

abdulrahuman5196 commented Feb 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Julesssss commented Feb 21, 2024

Uh oh!

github-actions Bot commented Feb 21, 2024

Uh oh!

Julesssss commented Feb 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kirillzyusko commented Feb 21, 2024

Uh oh!

Julesssss commented Feb 21, 2024

Uh oh!

abdulrahuman5196 commented Feb 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kirillzyusko commented Feb 21, 2024

Uh oh!

Uh oh!

github-actions Bot commented Feb 21, 2024

Uh oh!

abdulrahuman5196 commented Feb 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

abdulrahuman5196 commented Feb 21, 2024

Uh oh!

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

Uh oh!

Julesssss left a comment

Choose a reason for hiding this comment

Uh oh!

Julesssss left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Feb 26, 2024

Uh oh!

kirillzyusko commented Feb 19, 2024 •

edited by Julesssss

Loading

abdulrahuman5196 commented Feb 21, 2024 •

edited

Loading

Julesssss commented Feb 21, 2024 •

edited

Loading

abdulrahuman5196 commented Feb 21, 2024 •

edited

Loading

abdulrahuman5196 commented Feb 21, 2024 •

edited

Loading