Add iOS Communication Notifications

ios/NewExpensify/Chat.entitlements

@@ -14,5 +14,7 @@
 		<string>applinks:staging.new.expensify.com</string>
 		<string>webcredentials:new.expensify.com</string>
 	</array>
+	<key>com.apple.developer.usernotifications.communication</key>
+	<true/>
 </dict>
 </plist>

ios/NewExpensify/Info.plist

@@ -122,5 +122,9 @@
 	</array>
 	<key>UIViewControllerBasedStatusBarAppearance</key>
 	<false/>
+	<key>NSUserActivityTypes</key>
+	<array>
+		<string>INSendMessageIntent</string>
+	</array>
 </dict>
 </plist>

ios/NotificationServiceExtension/ExpError.swift

@@ -0,0 +1,12 @@
+//
+//  ExpError.swift
+//  NotificationServiceExtension
+//
+//  Created by Andrew Rosiclair on 12/13/23.
+//
+
+import Foundation
+
+enum ExpError: Error {
+    case runtimeError(String)
+}

ios/NotificationServiceExtension/Info.plist

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>NSExtension</key>
+	<dict>
+		<key>NSExtensionPointIdentifier</key>
+		<string>com.apple.usernotifications.service</string>
+		<key>NSExtensionPrincipalClass</key>
+		<string>$(PRODUCT_MODULE_NAME).NotificationService</string>
+	</dict>
+</dict>
+</plist>

ios/NotificationServiceExtension/NotificationService.swift

@@ -0,0 +1,236 @@
+//
+//  NotificationService.swift
+//  NotificationServiceExtension
+//
+//  Created by Andrew Rosiclair on 12/8/23.
+//
+
+import AirshipServiceExtension
+import os.log
+import Intents
+
+class NotificationService: UANotificationServiceExtension {
+
+  var contentHandler: ((UNNotificationContent) -> Void)?
+  var bestAttemptContent: UNMutableNotificationContent?
+  let log = OSLog(subsystem: Bundle.main.bundleIdentifier ?? "com.expensify.chat.dev.NotificationServiceExtension", category: "NotificationService")
+
+  override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
+    os_log("[NotificationService] didReceive() - received notification", log: log)
+
+    self.contentHandler = contentHandler
+    guard let bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent) else {
+      contentHandler(request.content)
+      return
+    }
+
+    if #available(iOSApplicationExtension 15.0, *) {
+      configureCommunicationNotification(notificationContent: bestAttemptContent, contentHandler: contentHandler)
+    } else {
+      contentHandler(bestAttemptContent)
+    }
+  }
+
+  @available(iOSApplicationExtension 15.0, *)
+  func configureCommunicationNotification(notificationContent: UNMutableNotificationContent, contentHandler: @escaping (UNNotificationContent) -> Void) {
+    var notificationData: NotificationData
+    do {
+      notificationData = try parsePayload(notificationContent: notificationContent)
+    } catch ExpError.runtimeError(let errorMessage) {
+      os_log("[NotificationService] configureCommunicationNotification() - couldn't parse the payload '%@'", log: log, type: .error, errorMessage)
+      contentHandler(notificationContent)
+      return
+    } catch {
+      os_log("[NotificationService] configureCommunicationNotification() - unexpected error while parsing payload", log: log, type: .error)
+      contentHandler(notificationContent)
+      return
+    }
+
+    // Create an intent for the incoming message
+    let intent: INSendMessageIntent = createMessageIntent(notificationData: notificationData)
+
+    // Use the intent to initialize the interaction.
+    let interaction = INInteraction(intent: intent, response: nil)
+
+
+    // Interaction direction is incoming because the user is
+    // receiving this message.
+    interaction.direction = .incoming
+
+
+    // Donate the interaction before updating notification content.
+    interaction.donate { error in
+        if error != nil {
+            os_log("[NotificationService] configureCommunicationNotification() - failed to donate the message intent", log: self.log, type: .error)
+            contentHandler(notificationContent)
+            return
+        }
+
+        // After donation, update the notification content.
+        do {
+          // Update notification content before displaying the
+          // communication notification.
+          let updatedContent = try notificationContent.updating(from: intent)
+
+          // Call the content handler with the updated content
+          // to display the communication notification.
+          contentHandler(updatedContent)
+        } catch {
+          os_log("[NotificationService] configureCommunicationNotification() - failed to update the notification with send message intent", log: self.log, type: .error)
+          contentHandler(notificationContent)
+        }
+    }
+  }
+
+  func parsePayload(notificationContent: UNMutableNotificationContent) throws -> NotificationData  {
+    guard let payload = notificationContent.userInfo["payload"] as? NSDictionary else {
+      throw ExpError.runtimeError("payload missing")
+    }
+
+    guard let reportID = payload["reportID"] as? Int64 else {
+      throw ExpError.runtimeError("payload.reportID missing")
+    }
+
+    guard let reportActionID = payload["reportActionID"] as? String else {
+      throw ExpError.runtimeError("payload.reportActionID missing")
+    }
+
+    guard let onyxData = payload["onyxData"] as? NSArray else {
+      throw ExpError.runtimeError("payload.onyxData missing" + reportActionID)
+    }
+
+    guard let reportActionOnyxUpdate = onyxData[1] as? NSDictionary else {
+      throw ExpError.runtimeError("payload.onyxData[1] missing" + reportActionID)
+    }
+
+    guard let reportActionCollection = reportActionOnyxUpdate["value"] as? NSDictionary else {
+      throw ExpError.runtimeError("payload.onyxData[1].value (report action onyx update) missing" + reportActionID)
+    }
+
+    guard let reportAction = reportActionCollection[reportActionID] as? NSDictionary else {
+      throw ExpError.runtimeError("payload.onyxData[1].value['\(reportActionID)'] (report action) missing" + reportActionID)
+    }
+
+    guard let avatarURL = reportAction["avatar"] as? String else {
+      throw ExpError.runtimeError("reportAction.avatar missing. reportActionID: " + reportActionID)
+    }
+
+    guard let accountID = reportAction["actorAccountID"] as? Int else {
+      throw ExpError.runtimeError("reportAction.actorAccountID missing. reportActionID: " + reportActionID)
+    }
+
+    guard let person = reportAction["person"] as? NSArray else {
+      throw ExpError.runtimeError("reportAction.person missing. reportActionID: " + reportActionID)
+    }
+
+    guard let personObject = person[0] as? NSDictionary else {
+      throw ExpError.runtimeError("reportAction.person[0] missing. reportActionID: " + reportActionID)
+    }
+
+    guard let userName = personObject["text"] as? String else {
+      throw ExpError.runtimeError("reportAction.person[0].text missing. reportActionID: " + reportActionID)
+    }
+
+    return NotificationData(
+      reportID: reportID,
+      reportActionID: reportActionID,
+      avatarURL: avatarURL,
+      accountID: accountID,
+      userName: userName,
+      title: notificationContent.title,
+      messageText: notificationContent.body,
+      roomName: payload["roomName"] as? String
+    )
+  }
+
+  @available(iOSApplicationExtension 14.0, *)
+  func createMessageIntent(notificationData: NotificationData) -> INSendMessageIntent {
+    // Initialize only the sender for a one-to-one message intent.
+    let handle = INPersonHandle(value: String(notificationData.accountID), type: .unknown)
+    let avatar = fetchINImage(imageURL: notificationData.avatarURL, reportActionID: notificationData.reportActionID)
+    let sender = INPerson(personHandle: handle,
+                          nameComponents: nil,
+                          displayName: notificationData.userName,
+                          image: avatar,
+                          contactIdentifier: nil,
+                          customIdentifier: nil)
+
+    // Configure the group/room name if there is one
+    var speakableGroupName: INSpeakableString? = nil
+    var recipients: [INPerson]? = nil
+    if (notificationData.roomName != nil) {
+      speakableGroupName = INSpeakableString(spokenPhrase: notificationData.roomName ?? "")
+
+      // To add the group name subtitle there must be multiple recipients set. However, we do not have
+      // data on the participatns in the room/group chat so we just add a placeholder here. This shouldn't
+      // appear anywhere in the UI
+      let placeholderPerson = INPerson(personHandle: INPersonHandle(value: "placeholder", type: .unknown),
+                                       nameComponents: nil,
+                                       displayName: "placeholder",
+                                       image: nil,
+                                       contactIdentifier: nil,
+                                       customIdentifier: nil)
+      recipients = [sender, placeholderPerson]
+    }
+
+    // Because this communication is incoming, you can infer that the current user is
+    // a recipient. Don't include the current user when initializing the intent.
+    let intent = INSendMessageIntent(recipients: recipients,
+                                     outgoingMessageType: .outgoingMessageText,
+                                     content: notificationData.messageText,
+                                     speakableGroupName: speakableGroupName,
+                                     conversationIdentifier: String(notificationData.reportID),
+                                     serviceName: nil,
+                                     sender: sender,
+                                     attachments: nil)
+
+    // When the group name is set, we force the avatar to just be the sender's avatar
+    intent.setImage(avatar, forParameterNamed: \.speakableGroupName)
+
+    return intent
+  }
+
+  override func serviceExtensionTimeWillExpire() {
+    // Called just before the extension will be terminated by the system.
+    // Use this as an opportunity to deliver your "best attempt" at modified content, otherwise the original push payload will be used.
+    if let contentHandler = contentHandler, let bestAttemptContent =  bestAttemptContent {
+      contentHandler(bestAttemptContent)
+    }
+  }
+
+  func fetchINImage(imageURL: String, reportActionID: String) -> INImage? {
+    guard let url = URL(string: imageURL) else {
+      return nil
+    }
+
+    do {
+      let data = try Data(contentsOf: url)
+      return INImage(imageData: data)
+    } catch {
+      os_log("[NotificationService] fetchINImage() - failed to fetch avatar. reportActionID: %@", log: self.log, type: .error, reportActionID)
+      return nil
+    }
+  }
+}
+
+class NotificationData {
+  public var reportID: Int64
+  public var reportActionID: String
+  public var avatarURL: String
+  public var accountID: Int
+  public var userName: String
+  public var title: String
+  public var messageText: String
+  public var roomName: String?
+
+  public init (reportID: Int64, reportActionID: String, avatarURL: String, accountID: Int, userName: String, title: String, messageText: String, roomName: String?) {
+    self.reportID = reportID
+    self.reportActionID = reportActionID
+    self.avatarURL = avatarURL
+    self.accountID = accountID
+    self.userName = userName
+    self.title = title
+    self.messageText = messageText
+    self.roomName = roomName
+  }
+}

ios/Podfile

@@ -118,3 +118,7 @@ target 'NewExpensify' do
     end
   end
 end
+
+target 'NotificationServiceExtension' do
+  pod 'AirshipServiceExtension'
+end

ios/Podfile.lock

@@ -20,6 +20,7 @@ PODS:
     - Airship (= 16.12.1)
     - Airship/MessageCenter (= 16.12.1)
     - Airship/PreferenceCenter (= 16.12.1)
+  - AirshipServiceExtension (16.12.5)
   - AppAuth (1.6.2):
     - AppAuth/Core (= 1.6.2)
     - AppAuth/ExternalUserAgent (= 1.6.2)
@@ -777,10 +778,35 @@ PODS:
     - React-Core
   - RNReactNativeHapticFeedback (1.14.0):
     - React-Core
-  - RNReanimated (3.6.1):
-    - RCT-Folly (= 2021.07.22.00)
+  - RNReanimated (3.5.4):
+    - DoubleConversion
+    - FBLazyVector
+    - glog
+    - hermes-engine
+    - RCT-Folly
+    - RCTRequired
+    - RCTTypeSafety
+    - React-callinvoker
     - React-Core
+    - React-Core/DevSupport
+    - React-Core/RCTWebSocket
+    - React-CoreModules
+    - React-cxxreact
+    - React-hermes
+    - React-jsi
+    - React-jsiexecutor
+    - React-jsinspector
+    - React-RCTActionSheet
+    - React-RCTAnimation
+    - React-RCTAppDelegate
+    - React-RCTBlob
+    - React-RCTImage
+    - React-RCTLinking
+    - React-RCTNetwork
+    - React-RCTSettings
+    - React-RCTText
     - ReactCommon/turbomodule/core
+    - Yoga
   - RNScreens (3.21.0):
     - React-Core
     - React-RCTImage
@@ -803,6 +829,7 @@ PODS:
     - Yoga (~> 1.14)
 
 DEPENDENCIES:
+  - AirshipServiceExtension
   - boost (from `../node_modules/react-native/third-party-podspecs/boost.podspec`)
   - BVLinearGradient (from `../node_modules/react-native-linear-gradient`)
   - DoubleConversion (from `../node_modules/react-native/third-party-podspecs/DoubleConversion.podspec`)
@@ -917,6 +944,7 @@ SPEC REPOS:
   trunk:
     - Airship
     - AirshipFrameworkProxy
+    - AirshipServiceExtension
     - AppAuth
     - CocoaAsyncSocket
     - Firebase
@@ -1137,6 +1165,7 @@ EXTERNAL SOURCES:
 SPEC CHECKSUMS:
   Airship: 2f4510b497a8200780752a5e0304a9072bfffb6d
   AirshipFrameworkProxy: ea1b6c665c798637b93c465b5e505be3011f1d9d
+  AirshipServiceExtension: 89c6e25a69f3458d9dbd581c700cffb196b61930
   AppAuth: 3bb1d1cd9340bd09f5ed189fb00b1cc28e1e8570
   boost: 57d2868c099736d80fcd648bf211b4431e51a558
   BVLinearGradient: 421743791a59d259aec53f4c58793aad031da2ca
@@ -1255,7 +1284,7 @@ SPEC CHECKSUMS:
   rnmapbox-maps: 6f638ec002aa6e906a6f766d69cd45f968d98e64
   RNPermissions: 9b086c8f05b2e2faa587fdc31f4c5ab4509728aa
   RNReactNativeHapticFeedback: 1e3efeca9628ff9876ee7cdd9edec1b336913f8c
-  RNReanimated: fdbaa9c964bbab7fac50c90862b6cc5f041679b9
+  RNReanimated: ab2e96c6d5591c3dfbb38a464f54c8d17fb34a87
   RNScreens: d037903436160a4b039d32606668350d2a808806
   RNSVG: d00c8f91c3cbf6d476451313a18f04d220d4f396
   SDWebImage: a7f831e1a65eb5e285e3fb046a23fcfbf08e696d
@@ -1266,6 +1295,6 @@ SPEC CHECKSUMS:
   Yoga: 3efc43e0d48686ce2e8c60f99d4e6bd349aff981
   YogaKit: f782866e155069a2cca2517aafea43200b01fd5a
 
-PODFILE CHECKSUM: ff769666b7221c15936ebc5576a8c8e467dc6879
+PODFILE CHECKSUM: 39399f883f6ae62edb4cc9e4fab8d4143eab59a7
 
 COCOAPODS: 1.12.1