fix: [SDK-5580] end duplicate Live Activities and keep the update token

iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj

@@ -121,6 +121,7 @@
 		3C30FE362F21FBE1001B9C25 /* EarlyTriggerTrackingTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3C30FE352F21FBE1001B9C25 /* EarlyTriggerTrackingTests.swift */; };
 		3C8B41D82F7E9A6C001B9C25 /* TriggerThreadingTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3C8B41D72F7E9A6C001B9C25 /* TriggerThreadingTests.swift */; };
 		3C3D34E92E95EAA5006A2924 /* LiveActivityConstants.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3C3D34E82E95EAA5006A2924 /* LiveActivityConstants.swift */; };
+		E5195D813B9499A01F9A102A /* OSLiveActivityDuplicates.swift in Sources */ = {isa = PBXBuildFile; fileRef = 06B90FBD16038D378B54330A /* OSLiveActivityDuplicates.swift */; };
 		3C3D8D782E92DB7500C3E977 /* OSLiveActivityViewExtensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3C3D8D772E92DB7500C3E977 /* OSLiveActivityViewExtensions.swift */; };
 		3C427AC9301BB28A0059B8B7 /* OSOperationRepoFlushTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3C427AC8301BB28A0059B8B7 /* OSOperationRepoFlushTests.swift */; };
 		B5481A0100000000000000A8 /* OSRequestRetryBackoffTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = B5481A0100000000000000A7 /* OSRequestRetryBackoffTests.swift */; };
@@ -1444,6 +1445,7 @@
 		3C30FE352F21FBE1001B9C25 /* EarlyTriggerTrackingTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EarlyTriggerTrackingTests.swift; sourceTree = "<group>"; };
 		3C8B41D72F7E9A6C001B9C25 /* TriggerThreadingTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TriggerThreadingTests.swift; sourceTree = "<group>"; };
 		3C3D34E82E95EAA5006A2924 /* LiveActivityConstants.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LiveActivityConstants.swift; sourceTree = "<group>"; };
+		06B90FBD16038D378B54330A /* OSLiveActivityDuplicates.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSLiveActivityDuplicates.swift; sourceTree = "<group>"; };
 		3C3D8D772E92DB7500C3E977 /* OSLiveActivityViewExtensions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSLiveActivityViewExtensions.swift; sourceTree = "<group>"; };
 		3C427AC8301BB28A0059B8B7 /* OSOperationRepoFlushTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSOperationRepoFlushTests.swift; sourceTree = "<group>"; };
 		B5481A0100000000000000A7 /* OSRequestRetryBackoffTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSRequestRetryBackoffTests.swift; sourceTree = "<group>"; };
@@ -2640,6 +2642,7 @@
 				3CFA8F4D2E9087DB00201FE5 /* OSLiveActivitiesExtension.swift */,
 				3CFA8F492E9087DB00201FE5 /* AnyCodable.swift */,
 				3C3D34E82E95EAA5006A2924 /* LiveActivityConstants.swift */,
+				06B90FBD16038D378B54330A /* OSLiveActivityDuplicates.swift */,
 				3CFA8F4A2E9087DB00201FE5 /* DefaultLiveActivityAttributes.swift */,
 			);
 			path = Source;
@@ -4842,6 +4845,7 @@
 				3CFA8F4F2E9087DB00201FE5 /* AnyCodable.swift in Sources */,
 				3C3D8D782E92DB7500C3E977 /* OSLiveActivityViewExtensions.swift in Sources */,
 				3C3D34E92E95EAA5006A2924 /* LiveActivityConstants.swift in Sources */,
+				E5195D813B9499A01F9A102A /* OSLiveActivityDuplicates.swift in Sources */,
 				3CFA8F502E9087DB00201FE5 /* OSLiveActivitiesExecutor.swift in Sources */,
 				3CFA8F512E9087DB00201FE5 /* DefaultLiveActivityAttributes.swift in Sources */,
 				3CFA8F522E9087DB00201FE5 /* OSRequestSetStartToken.swift in Sources */,

iOS_SDK/OneSignalSDK/OneSignalLiveActivities/Source/Executors/OSLiveActivitiesExecutor.swift

@@ -186,6 +186,14 @@ class OSLiveActivitiesExecutor: OSPushSubscriptionObserver {
         }
     }
 
+    func cachedUpdateToken(_ activityId: String) async -> String? {
+        await withCheckedContinuation { continuation in
+            self.requestDispatch.async {
+                continuation.resume(returning: (self.updateTokens.items[activityId] as? OSRequestSetUpdateToken)?.token)
+            }
+        }
+    }
+
     func pollPendingRequests() {
         OneSignalLog.onesignalLog(.LL_VERBOSE, message: "OneSignal.LiveActivities pollPendingRequests")
 

iOS_SDK/OneSignalSDK/OneSignalLiveActivities/Source/OSLiveActivityDuplicates.swift

@@ -0,0 +1,98 @@
+/*
+ Modified MIT License
+
+ Copyright 2026 OneSignal
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ 1. The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ 2. All copies of substantial portions of the Software may only be used in connection
+ with services provided by OneSignal.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+ */
+
+// Effectively blanks out this file for Mac Catalyst
+#if targetEnvironment(macCatalyst)
+#else
+import OneSignalCore
+import ActivityKit
+
+/// Tests cannot create an `Activity`, so the helpers below take this protocol.
+protocol OSLiveActivityInstance {
+    var id: String { get }
+    var oneSignalActivityId: String { get }
+    var pushTokenString: String? { get }
+    var isLive: Bool { get }
+}
+
+@available(iOS 16.1, *)
+extension Activity: OSLiveActivityInstance where Attributes: OneSignalLiveActivityAttributes {
+    var oneSignalActivityId: String { attributes.onesignal.activityId }
+    var pushTokenString: String? { pushToken?.map { String(format: "%02x", $0) }.joined() }
+    var isLive: Bool { activityState != .ended && activityState != .dismissed }
+}
+
+extension OneSignalLiveActivitiesManagerImpl {
+    static func duplicateGroups<T: OSLiveActivityInstance>(_ activities: [T]) -> [String: [T]] {
+        Dictionary(grouping: activities.filter { $0.isLive }, by: { $0.oneSignalActivityId }).filter { $0.value.count > 1 }
+    }
+
+    /// The backend sends updates to the cached update token, so we prefer the
+    /// activity that has that token.
+    static func activityToKeep<T: OSLiveActivityInstance>(_ group: [T], cachedUpdateToken: String?) -> T? {
+        group.first { $0.pushTokenString != nil && $0.pushTokenString == cachedUpdateToken }
+            ?? group.first { $0.pushTokenString != nil }
+            ?? group.first
+    }
+
+    static func endDuplicates<T: OSLiveActivityInstance>(
+        _ groups: [String: [T]],
+        cachedUpdateToken: (String) async -> String?,
+        end: (T) async -> Void
+    ) async -> [T] {
+        var kept = [T]()
+        // An activity can end during any await below, so we read isLive again
+        // before we keep or end an activity.
+        for (activityId, group) in groups {
+            let cachedToken = await cachedUpdateToken(activityId)
+            guard let keeper = activityToKeep(group.filter { $0.isLive }, cachedUpdateToken: cachedToken) else {
+                continue
+            }
+            kept.append(keeper)
+            for duplicate in group where duplicate.id != keeper.id && duplicate.isLive {
+                await end(duplicate)
+            }
+        }
+        return kept.filter { $0.isLive }
+    }
+
+    @available(iOS 16.2, *)
+    static func endDuplicateActivities<Attributes: OneSignalLiveActivityAttributes>(
+        _ groups: [String: [Activity<Attributes>]],
+        cachedUpdateToken: (String) async -> String?
+    ) async -> [Activity<Attributes>] {
+        await endDuplicates(groups, cachedUpdateToken: cachedUpdateToken) { duplicate in
+            OneSignalLog.onesignalLog(.LL_DEBUG, message: "OneSignal.LiveActivities ending duplicate activity: \(Attributes.self):\(duplicate.oneSignalActivityId):\(duplicate.id)")
+            await duplicate.end(nil, dismissalPolicy: ActivityUIDismissalPolicy.immediate)
+        }
+    }
+
+    static func hasLiveDuplicate<T: OSLiveActivityInstance>(_ activity: T, in activities: [T]) -> Bool {
+        activities.contains { $0.id != activity.id && $0.oneSignalActivityId == activity.oneSignalActivityId && $0.isLive }
+    }
+}
+#endif

iOS_SDK/OneSignalSDK/OneSignalLiveActivities/Source/OneSignalLiveActivitiesManagerImpl.swift

@@ -38,7 +38,7 @@
 
 @objc(OneSignalLiveActivitiesManagerImpl)
 public class OneSignalLiveActivitiesManagerImpl: NSObject, OSLiveActivities {
     private static let _executor: OSLiveActivitiesExecutor = OSLiveActivitiesExecutor(requestDispatch: DispatchQueue(label: "OneSignal.LiveActivities"))
 
     @objc
     public static func liveActivities() -> AnyClass {
@@ -65,7 +65,7 @@
     @objc
     @available(iOS 17.2, *)
     public static func setPushToStartToken(_ activityType: String, withToken: String) throws {
         OneSignalLog.onesignalLog(.LL_VERBOSE, message: "OneSignal.LiveActivities setStartToken called with activityType: \(activityType) token: \(withToken)")
 
         guard let activityType = activityType.addingPercentEncoding(withAllowedCharacters: NSCharacterSet.urlUserAllowed) else {
             throw LiveActivitiesError.invalidActivityType("Cannot translate activity type to url encoded string.")
@@ -220,13 +220,13 @@
         - clickId: UUID representing the unique click event, as it is possible for this click to be tracked multiple times.
      */
     private static func trackClick(clickId: String, activityType: String, activityId: String, notificationId: String?) {
         OneSignalLog.onesignalLog(.LL_VERBOSE, message: "OneSignal.LiveActivities trackClick called with clickId: \(clickId), activityType: \(activityType), activityId: \(activityId)")
         let req = OSRequestLiveActivityClicked(key: clickId, activityType: activityType, activityId: activityId, notificationId: notificationId)
         _executor.append(req)
     }
 
     @available(iOS 17.2, *)
     private static func listenForPushToStart<Attributes: OneSignalLiveActivityAttributes>(_ activityType: Attributes.Type, options: LiveActivitySetupOptions? = nil) {
         if options == nil || options!.enablePushToStart {
             Task {
                 OneSignalLog.onesignalLog(.LL_VERBOSE, message: "OneSignal.LiveActivities listening for pushToStart on: \(activityType)")
@@ -239,7 +239,7 @@
     }
 
     @available(iOS 16.1, *)
     private static func listenForActivity<Attributes: OneSignalLiveActivityAttributes>(_ activityType: Attributes.Type, options: LiveActivitySetupOptions? = nil) {
 
         /*
          Apple has confirmed that when using push-to-start, it is best to check both `Activity<...>.activities` in addition
@@ -249,11 +249,22 @@
          */
 
         // Establish listeners for activity (if any exist)
-        for activity in Activity<Attributes>.activities {
-            listenForActivityStateUpdates(activityType, activity: activity, options: options)
-            listenForActivityPushToUpdate(activityType, activity: activity, options: options)
-            if #available(iOS 16.2, *) {
-                listenForContentUpdates(activityType, activity: activity)
+        let activities = Activity<Attributes>.activities
+        var duplicates = [String: [Activity<Attributes>]]()
+        if #available(iOS 16.2, *) {
+            duplicates = duplicateGroups(activities)
+        }
+        // If a duplicate that we end gets listeners, its token replaces the
+        // kept activity's token.
+        for activity in activities where duplicates[activity.oneSignalActivityId] == nil {
+            listenForActivityEvents(activityType, activity: activity, options: options)
+        }
+
+        if #available(iOS 16.2, *), !duplicates.isEmpty {
+            Task {
+                for activity in await endDuplicateActivities(duplicates, cachedUpdateToken: _executor.cachedUpdateToken) {
+                    listenForActivityEvents(activityType, activity: activity, options: options)
+                }
             }
         }
 
@@ -265,22 +276,27 @@
                     // if there's already an activity with the same OneSignal activityId, dismiss it before
                     // listening for the new activity's events.
                     for otherActivity in Activity<Attributes>.activities {
                         if activity.id != otherActivity.id && otherActivity.attributes.onesignal.activityId == activity.attributes.onesignal.activityId {
                             OneSignalLog.onesignalLog(.LL_DEBUG, message: "OneSignal.LiveActivities dismissing other activity: \(activityType):\(otherActivity.attributes.onesignal.activityId):\(otherActivity.id)")
                             await otherActivity.end(nil, dismissalPolicy: ActivityUIDismissalPolicy.immediate)
                         }
                     }
                 }
 
-                listenForActivityStateUpdates(activityType, activity: activity, options: options)
-                listenForActivityPushToUpdate(activityType, activity: activity, options: options)
-                if #available(iOS 16.2, *) {
-                    listenForContentUpdates(activityType, activity: activity)
-                }
+                listenForActivityEvents(activityType, activity: activity, options: options)
             }
         }
     }
 
+    @available(iOS 16.1, *)
+    private static func listenForActivityEvents<Attributes: OneSignalLiveActivityAttributes>(_ activityType: Attributes.Type, activity: Activity<Attributes>, options: LiveActivitySetupOptions? = nil) {
+        listenForActivityStateUpdates(activityType, activity: activity, options: options)
+        listenForActivityPushToUpdate(activityType, activity: activity, options: options)
+        if #available(iOS 16.2, *) {
+            listenForContentUpdates(activityType, activity: activity)
+        }
+    }
+
     @available(iOS 16.1, *)
     private static func listenForActivityStateUpdates<Attributes: OneSignalLiveActivityAttributes>(_ activityType: Attributes.Type, activity: Activity<Attributes>, options: LiveActivitySetupOptions? = nil) {
         // listen for activity dismisses so we can forget about the token
@@ -289,7 +305,12 @@
             for await activityState in activity.activityStateUpdates {
                 switch activityState {
                 case .dismissed:
-                    OneSignalLiveActivitiesManagerImpl.exit(activity.attributes.onesignal.activityId)
+                    // If a live duplicate exists, `exit` can stop its updates.
+                    if hasLiveDuplicate(activity, in: Activity<Attributes>.activities) {
+                        OneSignalLog.onesignalLog(.LL_DEBUG, message: "OneSignal.LiveActivities keeping update token for: \(activityType):\(activity.attributes.onesignal.activityId):\(activity.id), a duplicate is still live")
+                    } else {
+                        OneSignalLiveActivitiesManagerImpl.exit(activity.attributes.onesignal.activityId)
+                    }
                 case .active: break
                 case .ended: break
                 case .stale: break

iOS_SDK/OneSignalSDK/OneSignalLiveActivitiesTests/LiveActivitiesManagerTests.swift

@@ -151,4 +151,140 @@ final class LiveActivitiesManagerTests: XCTestCase {
         XCTAssertEqual(result!.query, "param1=value1&param2=value2")
         XCTAssertEqual(result!.fragment, "section")
     }
+
+    // MARK: - Duplicate activities
+
+    private final class FakeActivity: OSLiveActivityInstance {
+        let id: String
+        let oneSignalActivityId: String
+        let pushTokenString: String?
+        var isLive: Bool
+
+        init(id: String, oneSignalActivityId: String, pushTokenString: String? = nil, isLive: Bool = true) {
+            self.id = id
+            self.oneSignalActivityId = oneSignalActivityId
+            self.pushTokenString = pushTokenString
+            self.isLive = isLive
+        }
+    }
+
+    func testDuplicateGroups_groupsOnlyLiveActivitiesSharingAnActivityId() throws {
+        let activities = [
+            FakeActivity(id: "x1", oneSignalActivityId: "x"),
+            FakeActivity(id: "y1", oneSignalActivityId: "y"),
+            FakeActivity(id: "x2", oneSignalActivityId: "x"),
+            FakeActivity(id: "y2", oneSignalActivityId: "y", isLive: false),
+            FakeActivity(id: "z1", oneSignalActivityId: "z")
+        ]
+
+        let groups = OneSignalLiveActivitiesManagerImpl.duplicateGroups(activities)
+
+        XCTAssertEqual(Array(groups.keys), ["x"])
+        XCTAssertEqual(groups["x"]?.map(\.id), ["x1", "x2"])
+    }
+
+    func testActivityToKeep_prefersTheActivityWithTheCachedToken() throws {
+        let group = [
+            FakeActivity(id: "a1", oneSignalActivityId: "a", pushTokenString: "token-1"),
+            FakeActivity(id: "a2", oneSignalActivityId: "a", pushTokenString: "token-2"),
+            FakeActivity(id: "a3", oneSignalActivityId: "a", pushTokenString: "token-3")
+        ]
+
+        XCTAssertEqual(OneSignalLiveActivitiesManagerImpl.activityToKeep(group, cachedUpdateToken: "token-2")?.id, "a2")
+    }
+
+    func testActivityToKeep_withoutACachedMatch_keepsAnActivityWithAToken() throws {
+        let group = [
+            FakeActivity(id: "a1", oneSignalActivityId: "a"),
+            FakeActivity(id: "a2", oneSignalActivityId: "a", pushTokenString: "token-2")
+        ]
+
+        XCTAssertEqual(OneSignalLiveActivitiesManagerImpl.activityToKeep(group, cachedUpdateToken: "token-other")?.id, "a2")
+        XCTAssertEqual(OneSignalLiveActivitiesManagerImpl.activityToKeep(group, cachedUpdateToken: nil)?.id, "a2")
+    }
+
+    func testActivityToKeep_withoutTokens_keepsTheFirstActivity() throws {
+        let group = [
+            FakeActivity(id: "a1", oneSignalActivityId: "a"),
+            FakeActivity(id: "a2", oneSignalActivityId: "a")
+        ]
+
+        XCTAssertEqual(OneSignalLiveActivitiesManagerImpl.activityToKeep(group, cachedUpdateToken: nil)?.id, "a1")
+    }
+
+    func testEndDuplicates_endsAllButOneActivityPerActivityId() async throws {
+        let activities = [
+            FakeActivity(id: "x1", oneSignalActivityId: "x", pushTokenString: "token-x1"),
+            FakeActivity(id: "x2", oneSignalActivityId: "x", pushTokenString: "token-x2"),
+            FakeActivity(id: "x3", oneSignalActivityId: "x", pushTokenString: "token-x3"),
+            FakeActivity(id: "y1", oneSignalActivityId: "y"),
+            FakeActivity(id: "y2", oneSignalActivityId: "y", pushTokenString: "token-y2")
+        ]
+        let cachedTokens = ["x": "token-x3"]
+        var ended = [String]()
+
+        let kept = await OneSignalLiveActivitiesManagerImpl.endDuplicates(
+            OneSignalLiveActivitiesManagerImpl.duplicateGroups(activities),
+            cachedUpdateToken: { cachedTokens[$0] },
+            end: { ended.append($0.id) }
+        )
+
+        XCTAssertEqual(Set(kept.map(\.id)), ["x3", "y2"])
+        XCTAssertEqual(Set(ended), ["x1", "x2", "y1"])
+    }
+
+    func testEndDuplicates_whenTheCachedTokenActivityHasEnded_keepsTheLiveOne() async throws {
+        let endedActivity = FakeActivity(id: "x1", oneSignalActivityId: "x", pushTokenString: "token-x1", isLive: false)
+        let liveActivity = FakeActivity(id: "x2", oneSignalActivityId: "x", pushTokenString: "token-x2")
+        var ended = [String]()
+
+        let kept = await OneSignalLiveActivitiesManagerImpl.endDuplicates(
+            ["x": [endedActivity, liveActivity]],
+            cachedUpdateToken: { _ in "token-x1" },
+            end: { ended.append($0.id) }
+        )
+
+        XCTAssertEqual(kept.map(\.id), ["x2"])
+        XCTAssertEqual(ended, [])
+    }
+
+    func testEndDuplicates_whenTheKeeperEndsDuringTheAwaits_returnsNothing() async throws {
+        let keeper = FakeActivity(id: "x1", oneSignalActivityId: "x", pushTokenString: "token-x1")
+        let duplicate = FakeActivity(id: "x2", oneSignalActivityId: "x", pushTokenString: "token-x2")
+
+        let kept = await OneSignalLiveActivitiesManagerImpl.endDuplicates(
+            ["x": [keeper, duplicate]],
+            cachedUpdateToken: { _ in "token-x1" },
+            // A new activity with the same activityId ends the keeper while this call waits.
+            end: { _ in keeper.isLive = false }
+        )
+
+        XCTAssertTrue(kept.isEmpty)
+    }
+
+    func testHasLiveDuplicate_whenAnotherLiveActivityHasTheSameActivityId_returnsTrue() throws {
+        let dismissed = FakeActivity(id: "a1", oneSignalActivityId: "a", isLive: false)
+        let activities = [dismissed, FakeActivity(id: "a2", oneSignalActivityId: "a")]
+
+        XCTAssertTrue(OneSignalLiveActivitiesManagerImpl.hasLiveDuplicate(dismissed, in: activities))
+    }
+
+    func testHasLiveDuplicate_withoutAnotherLiveActivityForTheActivityId_returnsFalse() throws {
+        let dismissed = FakeActivity(id: "a1", oneSignalActivityId: "a", isLive: false)
+        let activities = [
+            dismissed,
+            FakeActivity(id: "a2", oneSignalActivityId: "a", isLive: false),
+            FakeActivity(id: "b1", oneSignalActivityId: "b")
+        ]
+
+        XCTAssertFalse(OneSignalLiveActivitiesManagerImpl.hasLiveDuplicate(dismissed, in: activities))
+        XCTAssertFalse(OneSignalLiveActivitiesManagerImpl.hasLiveDuplicate(dismissed, in: []))
+    }
+
+    func testHasLiveDuplicate_forALiveActivityWithoutAnotherForItsActivityId_returnsFalse() throws {
+        let live = FakeActivity(id: "a1", oneSignalActivityId: "a")
+        let activities = [live, FakeActivity(id: "b1", oneSignalActivityId: "b")]
+
+        XCTAssertFalse(OneSignalLiveActivitiesManagerImpl.hasLiveDuplicate(live, in: activities))
+    }
 }