✨ Add push response handler

Sources/AppcuesKit/Appcues.swift

@@ -336,6 +336,11 @@ public class Appcues: NSObject {
         return container.resolve(DeepLinkHandling.self).didHandleURL(url)
     }
 
+    public func didReceiveNotification(response: UNNotificationResponse, completionHandler: @escaping () -> Void) -> Bool {
+        let userInfo = response.notification.request.content.userInfo
+        return container.resolve(PushMonitoring.self).didReceiveNotification(userInfo: userInfo, completionHandler: completionHandler)
+    }
+
     func initializeContainer() {
         container.owner = self
         container.register(Config.self, value: config)

Sources/AppcuesKit/Data/Events.swift

@@ -18,6 +18,10 @@ internal enum Events {
         case deviceUnregistered = "appcues:device_unregistered"
     }
 
+    enum Push: String {
+        case pushOpened = "appcues:push_opened"
+    }
+
     enum Experience: String {
         case stepSeen = "appcues:v2:step_seen"
         case stepInteraction = "appcues:v2:step_interaction"

Sources/AppcuesKit/Presentation/Actions/ActionRegistry.swift

@@ -81,6 +81,12 @@ internal class ActionRegistry {
         execute(transformQueue(actionInstances), completion: completion)
     }
 
+    /// Enqueue the action instances.
+    /// This version is used for push action handlers.
+    func enqueue(actionInstances: [AppcuesExperienceAction], completion: @escaping () -> Void) {
+        execute(transformQueue(actionInstances), completion: completion)
+    }
+
     /// Enqueue the action instances generated from a factory function to be executed.
     /// This version is used for post-completion actions on an experience.
     func enqueue(actionFactory: (Appcues?) -> [AppcuesExperienceAction]) {

Sources/AppcuesKit/Presentation/Debugger/Panel/LoggedEvent.swift

@@ -106,6 +106,9 @@ internal struct LoggedEvent: Identifiable {
         case let .event(name, _) where Events.Device(rawValue: name) != nil:
             self.type = .device
             self.name = name.prettifiedEventName
+        case let .event(name, _) where Events.Push(rawValue: name) != nil:
+            self.type = .push
+            self.name = name.prettifiedEventName
         case let .event(name, _):
             self.type = .custom
             self.name = name
@@ -134,6 +137,7 @@ extension LoggedEvent {
         case session
         case experience
         case device
+        case push
 
         var description: String {
             switch self {
@@ -144,6 +148,7 @@ extension LoggedEvent {
             case .session: return "Session"
             case .experience: return "Experience"
             case .device: return "Device"
+            case .push: return "Push"
             }
         }
 
@@ -156,6 +161,7 @@ extension LoggedEvent {
             case .session: return "clock.arrow.2.circlepath"
             case .experience: return "arrow.right.square"
             case .device: return "iphone"
+            case .push: return "bell.badge"
             }
         }
     }

Sources/AppcuesKit/Presentation/ExperienceRendering/ExperienceTrigger.swift

@@ -12,6 +12,7 @@ internal enum ExperienceTrigger: Equatable {
     case qualification(reason: QualifyResponse.QualificationReason?)
     case experienceCompletionAction(fromExperienceID: UUID?)
     case launchExperienceAction(fromExperienceID: UUID?)
+    case push
     case showCall
     case deepLink
     case preview
@@ -24,7 +25,7 @@ internal enum ExperienceTrigger: Equatable {
         switch self {
         case .qualification:
             return false
-        case .experienceCompletionAction, .launchExperienceAction, .showCall, .deepLink, .preview:
+        case .experienceCompletionAction, .launchExperienceAction, .push, .showCall, .deepLink, .preview:
             return true
         }
     }

Sources/AppcuesKit/Push/ParsedNotification.swift

@@ -0,0 +1,49 @@
+//
+//  ParsedNotification.swift
+//  AppcuesKit
+//
+//  Created by Matt on 2024-03-05.
+//  Copyright © 2024 Appcues. All rights reserved.
+//
+
+import Foundation
+
+internal struct ParsedNotification {
+    let accountID: String
+    let userID: String
+    let notificationID: String
+    let workflowID: String
+    let workflowTaskID: String
+    let transactionID: String
+    let deepLinkURL: URL?
+    let experienceID: String?
+    let attachmentURL: URL?
+    let attachmentType: String?
+    let isTest: Bool
+
+    init?(userInfo: [AnyHashable: Any]) {
+        guard let accountID = userInfo["appcues_account_id"] as? String,
+        let userID = userInfo["appcues_user_id"] as? String,
+        let notificationID = userInfo["appcues_notification_id"] as? String,
+        let workflowID = userInfo["appcues_workflow_id"] as? String,
+        let workflowTaskID = userInfo["appcues_workflow_task_id"] as? String,
+        let transactionID = userInfo["appcues_transaction_id"] as? String else {
+            return nil
+        }
+
+        self.accountID = accountID
+        self.userID = userID
+        self.notificationID = notificationID
+        self.workflowID = workflowID
+        self.workflowTaskID = workflowTaskID
+        self.transactionID = transactionID
+
+        self.deepLinkURL = (userInfo["appcues_deep_link_url"] as? String)
+            .flatMap { URL(string: $0) }
+        self.experienceID = userInfo["appcues_experience_id"] as? String
+        self.attachmentURL = (userInfo["appcues_attachment_url"] as? String)
+            .flatMap { URL(string: $0) }
+        self.attachmentType = userInfo["appcues_attachment_type"] as? String
+        self.isTest = userInfo["appcues_test"] as? Bool ?? false
+    }
+}

Sources/AppcuesKit/Push/PushMonitor.swift

@@ -14,10 +14,14 @@ internal protocol PushMonitoring: AnyObject {
     var pushPrimerEligible: Bool { get }
 
     func refreshPushStatus(completion: ((UNAuthorizationStatus) -> Void)?)
+
+    // Using `userInfo` as a parameter to be able to mock notification data.
+    func didReceiveNotification(userInfo: [AnyHashable: Any], completionHandler: @escaping () -> Void) -> Bool
 }
 
 internal class PushMonitor: PushMonitoring {
 
+    private weak var appcues: Appcues?
     private let storage: DataStoring
 
     private var pushAuthorizationStatus: UNAuthorizationStatus = .notDetermined
@@ -35,6 +39,7 @@ internal class PushMonitor: PushMonitoring {
     }
 
     init(container: DIContainer) {
+        self.appcues = container.owner
         self.storage = container.resolve(DataStoring.self)
 
         refreshPushStatus()
@@ -67,6 +72,58 @@ internal class PushMonitor: PushMonitoring {
         }
     }
 
+    // `completionHandler` should be called iff the function returns true.
+    func didReceiveNotification(userInfo: [AnyHashable: Any], completionHandler: @escaping () -> Void) -> Bool {
+        guard let parsedNotification = ParsedNotification(userInfo: userInfo) else {
+            // Not an Appcues push
+            return false
+        }
+
+        guard let appcues = appcues else {
+            return false
+        }
+
+        // If there's a user ID mismatch, don't do anything with the notification
+        guard parsedNotification.userID == storage.userID else {
+            completionHandler()
+            return true
+        }
+
+        // If no session, start one for the user in the notification
+        if !appcues.isActive {
+            storage.userID = parsedNotification.userID
+            storage.isAnonymous = false
+        }
+
+        let analyticsPublisher = appcues.container.resolve(AnalyticsPublishing.self)
+        analyticsPublisher.publish(TrackingUpdate(
+            type: .event(name: Events.Push.pushOpened.rawValue, interactive: false),
+            properties: [
+                "notification_id": parsedNotification.notificationID
+            ],
+            isInternal: true
+        ))
+
+        if #available(iOS 13.0, *) {
+            var actions: [AppcuesExperienceAction] = []
+
+            if let deepLinkURL = parsedNotification.deepLinkURL {
+                actions.append(AppcuesLinkAction(appcues: appcues, url: deepLinkURL))
+            }
+
+            if let experienceID = parsedNotification.experienceID {
+                actions.append(AppcuesLaunchExperienceAction(appcues: appcues, experienceID: experienceID, trigger: .push))
+            }
+
+            let actionRegistry = appcues.container.resolve(ActionRegistry.self)
+            actionRegistry.enqueue(actionInstances: actions, completion: completionHandler)
+        } else {
+            completionHandler()
+        }
+
+        return true
+    }
+
     #if DEBUG
     func mockPushStatus(_ status: UNAuthorizationStatus) {
         pushAuthorizationStatus = status