Add support for dismissal-date to live activity notification (#167)

Author: mark-urbanthings

README.md

@@ -97,7 +97,7 @@ try await client.sendAlertNotification(
 )
 ```
 
-## Sending Live Activity Update
+## Sending Live Activity Update / End
 It requires sending `ContentState` matching with the live activity configuration to successfully update activity state. `ContentState` needs to conform to `Encodable`
 
 ```swift
@@ -115,6 +115,21 @@ It requires sending `ContentState` matching with the live activity configuration
         )
 ```
 
+```swift
+        try await client.sendLiveActivityNotification(
+            .init(
+                  expiration: .immediately,
+                  priority: .immediately,
+                  appID: "com.app.bundle",
+                  contentState: ContentState,
+                  event: .end,
+                  timestamp: Int(Date().timeIntervalSince1970),
+                  dismissalDate: .dismissImmediately // Optional to alter default behaviour
+            ),
+            activityPushToken: activityPushToken,
+            deadline: .distantFuture
+        )
+```
 ## Authentication
 `APNSwift` provides two authentication methods. `jwt`, and `TLS`. 
 

Sources/APNSwift/LiveActivity/APNSLiveActivityDismissalDate.swift

@@ -0,0 +1,40 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the APNSwift open source project
+//
+// Copyright (c) 2022 the APNSwift project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of APNSwift project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import struct Foundation.Date
+
+public struct APNSLiveActivityDismissalDate: Hashable {
+    /// The date at which the live activity will be dismissed
+    /// This value is a UNIX epoch expressed in seconds (UTC)
+    @usableFromInline
+    let dismissal: Int?
+
+    /// Omits sending an dismissal date for APNs. APNs will default to a default value for dismissal time.
+    public static let none = Self(dismissal: nil)
+
+    /// Have live activity dismiss immediately when end received
+    public static let immediately = Self(dismissal: 0)
+
+    /// Specify dismissal as a unix time stamp, if in past will dismiss
+    /// immedidately.
+    public static func timeIntervalSince1970InSeconds(_ timeInterval: Int) -> Self {
+        Self(dismissal: timeInterval)
+    }
+    
+    /// Specify dismissal as a date, if in past will dismiss
+    /// immedidately.
+    public static func date(_ date: Date) -> Self {
+        Self(dismissal: Int(date.timeIntervalSince1970))
+    }
+}

Sources/APNSwift/LiveActivity/APNSLiveActivityNotification.swift

@@ -14,7 +14,7 @@
 
 import struct Foundation.UUID
 
-/// An alert notification.
+/// A live activity notification.
 ///
 /// It is **important** that you do not encode anything with the key `aps`.
 public struct APNSLiveActivityNotification<ContentState: Encodable>: Encodable {
@@ -58,6 +58,15 @@ public struct APNSLiveActivityNotification<ContentState: Encodable>: Encodable {
         }
     }
 
+    public var dismissalDate: Int? {
+        get {
+            return self.aps.dismissalDate
+        }
+        set {
+            self.aps.dismissalDate = newValue
+        }
+    }
+    
     /// A canonical UUID that identifies the notification. If there is an error sending the notification,
     /// APNs uses this value to identify the notification to your server. The canonical form is 32 lowercase hexadecimal digits,
     /// displayed in five groups separated by hyphens in the form 8-4-4-4-12. An example UUID is as follows:
@@ -90,15 +99,18 @@ public struct APNSLiveActivityNotification<ContentState: Encodable>: Encodable {
     ///   - appID: Your app’s bundle ID/app ID. This will be suffixed with `.push-type.liveactivity`.
     ///   - apnsID: A canonical UUID that identifies the notification.
     ///   - contentState: Updated content-state of live activity
-    ///   - timestamp: Timestamp when sending notification
     ///   - event: event type e.g. update
+    ///   - timestamp: Timestamp when sending notification
+    ///   - dismissalDate: Timestamp when to dismiss live notification when sent with `end`, if in the past
+    ///    dismiss immediately
     public init(
         expiration: APNSNotificationExpiration,
         priority: APNSPriority,
         appID: String,
         contentState: ContentState,
         event: APNSLiveActivityNotificationEvent,
         timestamp: Int,
+        dismissalDate: APNSLiveActivityDismissalDate = .none,
         apnsID: UUID? = nil
     ) {
         self.init(
@@ -107,11 +119,12 @@ public struct APNSLiveActivityNotification<ContentState: Encodable>: Encodable {
             topic: appID + ".push-type.liveactivity",
             contentState: contentState,
             event: event,
-            timestamp: timestamp
+            timestamp: timestamp,
+            dismissalDate: dismissalDate
         )
     }
 
-    
+
     /// Initializes a new ``APNSLiveActivityNotification``.
     ///
     /// - Important: Your dynamic payload will get encoded to the root of the JSON payload that is send to APNs.
@@ -123,21 +136,25 @@ public struct APNSLiveActivityNotification<ContentState: Encodable>: Encodable {
     ///   - topic: The topic for the notification. In general, the topic is your app’s bundle ID/app ID suffixed with `.push-type.liveactivity`.
     ///   - apnsID: A canonical UUID that identifies the notification.
     ///   - contentState: Updated content-state of live activity
-    ///   - timestamp: Timestamp when sending notification
     ///   - event: event type e.g. update
+    ///   - timestamp: Timestamp when sending notification
+    ///   - dismissalDate: Timestamp when to dismiss live notification when sent with `end`, if in the past
+    ///    dismiss immediately
     public init(
         expiration: APNSNotificationExpiration,
         priority: APNSPriority,
         topic: String,
         apnsID: UUID? = nil,
         contentState: ContentState,
         event: APNSLiveActivityNotificationEvent,
-        timestamp: Int
+        timestamp: Int,
+        dismissalDate: APNSLiveActivityDismissalDate = .none
     ) {
         self.aps = APNSLiveActivityNotificationAPSStorage(
             timestamp: timestamp,
             event: event.rawValue,
-            contentState: contentState
+            contentState: contentState,
+            dismissalDate: dismissalDate.dismissal
         )
         self.apnsID = apnsID
         self.expiration = expiration

Sources/APNSwift/LiveActivity/APNSLiveActivityNotificationAPSStorage.swift

@@ -17,20 +17,23 @@ struct APNSLiveActivityNotificationAPSStorage<ContentState: Encodable>: Encodabl
         case timestamp = "timestamp"
         case event = "event"
         case contentState = "content-state"
-
+        case dismissalDate = "dismissal-date"
     }
 
     var timestamp: Int
     var event: String
     var contentState: ContentState
-
+    var dismissalDate: Int?
+    
     init(
         timestamp: Int,
         event: String,
-        contentState: ContentState
+        contentState: ContentState,
+        dismissalDate: Int?
     ) {
         self.timestamp = timestamp
         self.event = event
         self.contentState = contentState
+        self.dismissalDate = dismissalDate
     }
 }

Tests/APNSwiftTests/LiveActivity/APNSLiveActivityNotificationTests.swift

@@ -0,0 +1,89 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the APNSwift open source project
+//
+// Copyright (c) 2022 the APNSwift project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of APNSwift project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import APNSwift
+import XCTest
+
+final class APNSLiveActivityNotificationTests: XCTestCase {
+
+    struct State: Encodable, Hashable {
+        let string: String = "Test"
+        let number: Int = 123
+    }
+    
+    func testEncodeUpdate() throws {
+        let notification = APNSLiveActivityNotification(
+            expiration: .immediately,
+            priority: .immediately,
+            appID: "test.app.id",
+            contentState: State(),
+            event: .update,
+            timestamp: 1672680658)
+        
+        let encoder = JSONEncoder()
+        let data = try encoder.encode(notification)
+
+        let expectedJSONString = """
+        {"aps":{"event":"update","content-state":{"string":"Test","number":123},"timestamp":1672680658}}
+        """
+
+        let jsonObject1 = try JSONSerialization.jsonObject(with: data) as! NSDictionary
+        let jsonObject2 = try JSONSerialization.jsonObject(with: expectedJSONString.data(using: .utf8)!) as! NSDictionary
+        XCTAssertEqual(jsonObject1, jsonObject2)
+    }
+    
+    func testEncodeEndNoDismiss() throws {
+        let notification = APNSLiveActivityNotification(
+            expiration: .immediately,
+            priority: .immediately,
+            appID: "test.app.id",
+            contentState: State(),
+            event: .end,
+            timestamp: 1672680658)
+        
+        let encoder = JSONEncoder()
+        let data = try encoder.encode(notification)
+
+        let expectedJSONString = """
+        {"aps":{"event":"end","content-state":{"string":"Test","number":123},"timestamp":1672680658}}
+        """
+
+        let jsonObject1 = try JSONSerialization.jsonObject(with: data) as! NSDictionary
+        let jsonObject2 = try JSONSerialization.jsonObject(with: expectedJSONString.data(using: .utf8)!) as! NSDictionary
+        XCTAssertEqual(jsonObject1, jsonObject2)
+    }
+
+    func testEncodeEndDismiss() throws {
+        let notification = APNSLiveActivityNotification(
+            expiration: .immediately,
+            priority: .immediately,
+            appID: "test.app.id",
+            contentState: State(),
+            event: .end,
+            timestamp: 1672680658,
+            dismissalDate: .timeIntervalSince1970InSeconds(1672680800))
+        
+        let encoder = JSONEncoder()
+        let data = try encoder.encode(notification)
+
+        let expectedJSONString = """
+        {"aps":{"event":"end","content-state":{"string":"Test","number":123},"timestamp":1672680658,
+        "dismissal-date":1672680800}}
+        """
+
+        let jsonObject1 = try JSONSerialization.jsonObject(with: data) as! NSDictionary
+        let jsonObject2 = try JSONSerialization.jsonObject(with: expectedJSONString.data(using: .utf8)!) as! NSDictionary
+        XCTAssertEqual(jsonObject1, jsonObject2)
+    }
+}