Repository navigation
fix: [SDK-5580] end duplicate Live Activities and keep the update token #1780
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Act on (3/3): The keeper is chosen once. If it dies during
await end(duplicate)(user dismiss, or theactivityUpdatespath), this loop still ends every remaining live sibling, thenkept.filter { $0.isLive }returns nothing.Listeners are attached only after this returns, and
activityStateUpdatesdoes not replay, soexitis never called. The update-token cache / backend can keep pushing to a dead token.testEndDuplicates_whenTheKeeperEndsDuringTheAwaits_returnsNothingcurrently encodes this.Re-check
keeper.isLiveafter each await, promote a new keeper if needed, andexit(activityId)if nothing is still live.