✨ Add push primer support

@appcues/request-push action and _pushPrimerEligible auto-property

Sources/AppcuesKit/Data/Analytics/AutoPropertyDecorator.swift

@@ -104,7 +104,8 @@ internal class AutoPropertyDecorator: AnalyticsDecorating {
             "_lastSeenAt": now,
             "_updatedAt": now,
             "_lastContentShownAt": storage.lastContentShownAt,
-            "_sessionId": appcues?.sessionID?.appcuesFormatted
+            "_sessionId": appcues?.sessionID?.appcuesFormatted,
+            "_pushPrimerEligible": pushMonitor.pushPrimerEligible
         ]
 
         // Note: additional (custom) go first, as they may be overwritten by merged system items

Sources/AppcuesKit/Data/PushMonitor.swift

@@ -11,6 +11,9 @@ import UIKit
 internal protocol PushMonitoring: AnyObject {
     var pushEnabled: Bool { get }
     var pushBackgroundEnabled: Bool { get }
+    var pushPrimerEligible: Bool { get }
+
+    func refreshPushStatus(completion: ((UNAuthorizationStatus) -> Void)?)
 }
 
 internal class PushMonitor: PushMonitoring {
@@ -27,6 +30,10 @@ internal class PushMonitor: PushMonitoring {
         storage.pushToken != nil
     }
 
+    var pushPrimerEligible: Bool {
+        pushAuthorizationStatus == .notDetermined
+    }
+
     init(container: DIContainer) {
         self.storage = container.resolve(DataStoring.self)
 
@@ -45,14 +52,18 @@ internal class PushMonitor: PushMonitoring {
         refreshPushStatus()
     }
 
-    private func refreshPushStatus() {
+    func refreshPushStatus(completion: ((UNAuthorizationStatus) -> Void)? = nil) {
         // Skip call to UNUserNotificationCenter.current() in tests to avoid crashing in package tests
         #if DEBUG
-        guard ProcessInfo.processInfo.environment["XCTestBundlePath"] == nil else { return }
+        guard ProcessInfo.processInfo.environment["XCTestBundlePath"] == nil else {
+            completion?(pushAuthorizationStatus)
+            return
+        }
         #endif
 
         UNUserNotificationCenter.current().getNotificationSettings { [weak self] settings in
             self?.pushAuthorizationStatus = settings.authorizationStatus
+            completion?(settings.authorizationStatus)
         }
     }
 

Sources/AppcuesKit/Presentation/Actions/Appcues/AppcuesRequestPushAction.swift

@@ -0,0 +1,58 @@
+//
+//  AppcuesRequestPushAction.swift
+//  AppcuesKitTests
+//
+//  Created by Matt on 2024-02-26.
+//  Copyright © 2024 Appcues. All rights reserved.
+//
+
+import Foundation
+import UserNotifications
+
+@available(iOS 13.0, *)
+internal class AppcuesRequestPushAction: AppcuesExperienceAction {
+
+    static let type = "@appcues/request-push"
+
+    private weak var appcues: Appcues?
+
+    required init?(configuration: AppcuesExperiencePluginConfiguration) {
+        self.appcues = configuration.appcues
+    }
+
+    func execute(completion: @escaping ActionRegistry.Completion) {
+        guard let appcues = appcues else {
+            completion()
+            return
+        }
+
+        let resultHandler: (Bool, Error?) -> Void = { _, error in
+            if let error = error {
+                appcues.config.logger.error("@appcues/request-push failed with %{public}@", error.localizedDescription)
+            }
+
+            let pushMonitor = appcues.container.resolve(PushMonitoring.self)
+            let analyticsPublisher = appcues.container.resolve(AnalyticsPublishing.self)
+
+            pushMonitor.refreshPushStatus { _ in
+                analyticsPublisher.publish(TrackingUpdate(
+                    type: .event(name: Events.Device.deviceUpdated.rawValue, interactive: false),
+                    isInternal: true
+                ))
+
+                completion()
+            }
+        }
+
+        // Skip call to UNUserNotificationCenter.current() in tests to avoid crashing in package tests
+        #if DEBUG
+        guard ProcessInfo.processInfo.environment["XCTestBundlePath"] == nil else {
+            resultHandler(false, AppcuesTraitError(description: "Executing in test environment"))
+            return
+        }
+        #endif
+
+        let options: UNAuthorizationOptions = [.alert, .sound, .badge]
+        UNUserNotificationCenter.current().requestAuthorization(options: options, completionHandler: resultHandler)
+    }
+}