Add iOS Communication Notifications #32765

arosiclair · 2023-12-08T23:13:59Z

HELD on
- https://github.com/Expensify/Web-Expensify/pull/40158
- https://github.com/Expensify/Expensify/issues/350975

Details

Implements Communication Notifications for iOS. This adds user avatars and the group/room name to comment notifications. This uses a new Notification Service Extension which is a separate app target/binary that gets embedded into the application.

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/258522

Tests

iOS 15.0+ only

Log into NewDot
Accept notification permission
Send yourself a DM from an account with a custom avatar
Verify a notification for the message displays with the avatar
Send yourself a group DM from another user with a custom avatar
Verify a notification for the message displays with the avatar and the group participants first names in the subtitle
Create a workspace room
Send yourself another message in the room
Verify a notification for the message displays with the user's avatar and the room name in the subtitle

Offline tests

None

QA Steps

Same as Tests

PR Author Checklist

Screenshots/Videos

Android: Native

N/A

Android: mWeb Chrome

N/A

iOS: Native

iOS: mWeb Safari

N/A

MacOS: Chrome / Safari

N/A

MacOS: Desktop

N/A

…s-comms-notifications

arosiclair · 2023-12-20T23:08:39Z

I'm at a total loss for how to fix these workflow tests.

I thought updating references to "Decrypt profile" name would fix things but no dice. @roryabraham @radoslawkrzemien it looks like you guys are the experts on this. I've got a EOY deadline for this and I'm going OOO for a few days so any help would be greatly appreciated 🙇.

roryabraham · 2023-12-24T00:50:19Z

Going to jump in and see if I can help out here

# Conflicts: # ios/NewExpensify.xcodeproj/project.pbxproj # ios/Podfile.lock

github-actions · 2023-12-26T03:12:35Z

🧪🧪 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/32765/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/32765/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/32765/NewExpensify.dmg	https://32765.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

arosiclair · 2023-12-26T03:58:23Z

Many many thanks for fixing that up @roryabraham! This is ready for another set of reviews @mananjadhav @Julesssss. Let's get this merged ASAP!

mananjadhav · 2023-12-26T17:22:13Z

@arosiclair I am reviewing the code and I also tried testing the adhoc build. The notification didn't work for me. I didn't get any notification at all. I won't call it a blocker because the general notification didn't work for me on the prod app too. Would appreciate if we make it mandatory for the internal engineer to upload the screenshots.

RPReplay_Final1703611173.MP4

mananjadhav

Overall the code changes look fine. I've reviewed the entitlements and the swift code. I don't have the context on the signing profiles. Will let the internal engineer review it and also this comment.

melvin-bot · 2023-12-26T17:30:52Z

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

melvin-bot · 2023-12-26T17:30:56Z

🎯 @mananjadhav, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #33606.

arosiclair · 2023-12-26T18:09:56Z

@arosiclair I am reviewing the code and I also tried testing the adhoc build. The notification didn't work for me. I didn't get any notification at all. I won't call it a blocker because the general notification didn't work for me on the prod app too.

RPReplay_Final1703611173.MP4

This is expected for the ad-hoc build since we haven't setup push notifications for that bundle unfortunately. Currently they should only work in dev (only for internals on iOS) and in prod.

Would appreciate if we make it mandatory for the internal engineer to upload the screenshots.

@deetergp lemme know if you have an iPhone to test this with. Otherwise, you can just code review and then I'll re-test myself.

deetergp

The code looks good to me, but I'll leave it to you to test it @arosiclair 👍

deetergp · 2023-12-27T20:21:31Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

OSBotify · 2023-12-27T22:06:28Z

✋ 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 · 2023-12-28T21:36:55Z

🚀 Deployed to staging by https://github.com/deetergp in version: 1.4.19-0 🚀

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

OSBotify · 2023-12-29T18:13:48Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.19-2 🚀

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

arosiclair added 2 commits December 8, 2023 17:24

add notification service extension

523578f

move embed extensions build phase to fix build

4335e95

arosiclair self-assigned this Dec 8, 2023

arosiclair changed the base branch from main to arosiclair-clear-read-notifications December 8, 2023 23:14

use airship's UANotificationServiceExtension

53272e9

arosiclair force-pushed the arosiclair-ios-comms-notifications branch from 19dd7b9 to 53272e9 Compare December 11, 2023 19:30

arosiclair added 19 commits December 11, 2023 16:11

use iOS 13 minimum target

9f0e214

re-add default implementations

794eb84

check for payload properties

5ff5826

Merge branch 'arosiclair-clear-read-notifications' into arosiclair-io…

6b192da

…s-comms-notifications

use os_log instead of print

83c0b93

Add ExpError for throwing runtime errors with messages

315cf25

parse notification data

75bdc80

Merge branch 'arosiclair-clear-read-notifications' into arosiclair-io…

daf5876

…s-comms-notifications

parse accountID

91d7c7d

parse the user's name

73a49b6

add communication notification entitlement

b7c5cdb

add INSendMessageIntent

4707aba

move NSUserActivityTypes to the main bundle

de5d126

create message intents and configure communication notifications

fbc2eb1

parse message text

c0d636e

use updated INSendMessageIntent

e61d242

fetch and use avatar

82245cf

error handling

2e22250

parse and use roomName

718222e

Base automatically changed from arosiclair-clear-read-notifications to main December 15, 2023 22:33

arosiclair added 4 commits December 17, 2023 13:41

use formatted title

bad32ec

remove unused NotificationData properties

b57be15

remove unused var

8942cd0

rename to just NotificationServiceExtension

640eaa0

roryabraham added 2 commits December 23, 2023 16:53

Merge branch 'main' into arosiclair-ios-comms-notifications

5b0ec5b

# Conflicts: # ios/NewExpensify.xcodeproj/project.pbxproj # ios/Podfile.lock

Clean build after merge

8725cd2

arosiclair changed the title ~~[HOLD] Add iOS Communication Notifications~~ Add iOS Communication Notifications Dec 25, 2023

Fix workflow_tests

672d6ff

arosiclair added the Ready To Build label Dec 26, 2023

arosiclair requested review from Julesssss and mananjadhav December 26, 2023 03:58

mananjadhav approved these changes Dec 26, 2023

View reviewed changes

melvin-bot bot requested a review from deetergp December 26, 2023 17:30

melvin-bot bot mentioned this pull request Dec 26, 2023

Payment issue for E/App PR#32765 #33606

Closed

fix dev bundle IDs for NSE

a39f711

deetergp approved these changes Dec 27, 2023

View reviewed changes

deetergp merged commit 202037c into main Dec 27, 2023
19 checks passed

deetergp deleted the arosiclair-ios-comms-notifications branch December 27, 2023 22:02

github-actions bot mentioned this pull request Dec 28, 2023

Deploy Checklist: New Expensify 2023-12-28 #33727

Closed

22 tasks

arosiclair mentioned this pull request Jan 11, 2024

[HOLD for payment 2024-02-07] Fix version mismatch for Notification Service Extension #33961

Closed

6 tasks

arosiclair mentioned this pull request Mar 1, 2024

[HOLD for Payment 2024-09-24] Implement Android conversation notifications #37604

Closed

arosiclair mentioned this pull request Nov 1, 2024

iOS - Use "rich" notifications with avatar and room for new experience HybridApp users #51846

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add iOS Communication Notifications #32765

Add iOS Communication Notifications #32765

arosiclair commented Dec 8, 2023 •

edited

Loading

arosiclair commented Dec 20, 2023

roryabraham commented Dec 24, 2023

github-actions bot commented Dec 26, 2023

arosiclair commented Dec 26, 2023

mananjadhav commented Dec 26, 2023 •

edited

Loading

mananjadhav left a comment

melvin-bot bot commented Dec 26, 2023

melvin-bot bot commented Dec 26, 2023

arosiclair commented Dec 26, 2023

deetergp left a comment

deetergp commented Dec 27, 2023 •

edited

Loading

OSBotify commented Dec 27, 2023

OSBotify commented Dec 28, 2023

OSBotify commented Dec 29, 2023

Add iOS Communication Notifications #32765

Add iOS Communication Notifications #32765

Conversation

arosiclair commented Dec 8, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

arosiclair commented Dec 20, 2023

roryabraham commented Dec 24, 2023

github-actions bot commented Dec 26, 2023

arosiclair commented Dec 26, 2023

mananjadhav commented Dec 26, 2023 • edited Loading

mananjadhav left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Dec 26, 2023

melvin-bot bot commented Dec 26, 2023

arosiclair commented Dec 26, 2023

deetergp left a comment

Choose a reason for hiding this comment

deetergp commented Dec 27, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Dec 27, 2023

OSBotify commented Dec 28, 2023

OSBotify commented Dec 29, 2023

arosiclair commented Dec 8, 2023 •

edited

Loading

mananjadhav commented Dec 26, 2023 •

edited

Loading

deetergp commented Dec 27, 2023 •

edited

Loading