Skip to content

feat: [SDK-5376] persistent queue and retry for sessions API requests #1766

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
fadi-george wants to merge 2 commits into from
Closed

feat: [SDK-5376] persistent queue and retry for sessions API requests #1766

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83522a1
feat: [SDK-5376] persistent queue and retry for sessions API requests
fadi-george Oct 8, 2026
dd918f4
fix: [SDK-5376] address session queue review feedback
fadi-george Oct 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,11 +96,14 @@
A5162F01A1B2C3D4E5F60002 /* OSSessionService.swift in Sources */ = {isa = PBXBuildFile; fileRef = A5162F01A1B2C3D4E5F60001 /* OSSessionService.swift */; };
A5162F01A1B2C3D4E5F60014 /* OSSessionsRequests.swift in Sources */ = {isa = PBXBuildFile; fileRef = A5162F01A1B2C3D4E5F60013 /* OSSessionsRequests.swift */; };
A5162F01A1B2C3D4E5F60012 /* OSSessionsBackendService.swift in Sources */ = {isa = PBXBuildFile; fileRef = A5162F01A1B2C3D4E5F60011 /* OSSessionsBackendService.swift */; };
A5162F01A1B2C3D4E5F60018 /* OSSessionRequestQueue.swift in Sources */ = {isa = PBXBuildFile; fileRef = A5162F01A1B2C3D4E5F60017 /* OSSessionRequestQueue.swift */; };
A5162F01A1B2C3D4E5F6001C /* OSSessionRequest.swift in Sources */ = {isa = PBXBuildFile; fileRef = A5162F01A1B2C3D4E5F6001B /* OSSessionRequest.swift */; };
A5426001A1B2C3D4E5F60002 /* OSInputGuard.swift in Sources */ = {isa = PBXBuildFile; fileRef = A5426001A1B2C3D4E5F60001 /* OSInputGuard.swift */; };
A5426001A1B2C3D4E5F60004 /* OSInputGuardTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = A5426001A1B2C3D4E5F60003 /* OSInputGuardTests.swift */; };
A5062F01A1B2C3D4E5F60004 /* OSDeviceGestureDetectorTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = A5062F01A1B2C3D4E5F60003 /* OSDeviceGestureDetectorTests.swift */; };
A5162F01A1B2C3D4E5F60004 /* OSSessionServiceTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = A5162F01A1B2C3D4E5F60003 /* OSSessionServiceTests.swift */; };
A5162F01A1B2C3D4E5F60016 /* OSSessionsBackendServiceTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = A5162F01A1B2C3D4E5F60015 /* OSSessionsBackendServiceTests.swift */; };
A5162F01A1B2C3D4E5F6001A /* OSSessionRequestQueueTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = A5162F01A1B2C3D4E5F60019 /* OSSessionRequestQueueTests.swift */; };
C781A33FED62B4B54221A09A /* OSLogCrashHandlerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3B6A59620B83538CEFF77269 /* OSLogCrashHandlerTests.swift */; };
32D3A6EA8AD44274B5CE378A /* FileLogStoreRetentionTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9CC252C94ECB485E8D0380E9 /* FileLogStoreRetentionTests.swift */; };
B96A3B6BA8CC49EE4796D9BF /* OSRemoteLoggingController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8A72F938F8A3808AC1FF7F3C /* OSRemoteLoggingController.swift */; };
Expand Down Expand Up @@ -1914,11 +1917,14 @@
A5162F01A1B2C3D4E5F60001 /* OSSessionService.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSSessionService.swift; sourceTree = "<group>"; };
A5162F01A1B2C3D4E5F60013 /* OSSessionsRequests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSSessionsRequests.swift; sourceTree = "<group>"; };
A5162F01A1B2C3D4E5F60011 /* OSSessionsBackendService.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSSessionsBackendService.swift; sourceTree = "<group>"; };
A5162F01A1B2C3D4E5F60017 /* OSSessionRequestQueue.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSSessionRequestQueue.swift; sourceTree = "<group>"; };
A5162F01A1B2C3D4E5F6001B /* OSSessionRequest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSSessionRequest.swift; sourceTree = "<group>"; };
A5426001A1B2C3D4E5F60001 /* OSInputGuard.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSInputGuard.swift; sourceTree = "<group>"; };
A5426001A1B2C3D4E5F60003 /* OSInputGuardTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSInputGuardTests.swift; sourceTree = "<group>"; };
A5062F01A1B2C3D4E5F60003 /* OSDeviceGestureDetectorTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSDeviceGestureDetectorTests.swift; sourceTree = "<group>"; };
A5162F01A1B2C3D4E5F60003 /* OSSessionServiceTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSSessionServiceTests.swift; sourceTree = "<group>"; };
A5162F01A1B2C3D4E5F60015 /* OSSessionsBackendServiceTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSSessionsBackendServiceTests.swift; sourceTree = "<group>"; };
A5162F01A1B2C3D4E5F60019 /* OSSessionRequestQueueTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSSessionRequestQueueTests.swift; sourceTree = "<group>"; };
3B6A59620B83538CEFF77269 /* OSLogCrashHandlerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSLogCrashHandlerTests.swift; sourceTree = "<group>"; };
9CC252C94ECB485E8D0380E9 /* FileLogStoreRetentionTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileLogStoreRetentionTests.swift; sourceTree = "<group>"; };
8A72F938F8A3808AC1FF7F3C /* OSRemoteLoggingController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSRemoteLoggingController.swift; sourceTree = "<group>"; };
Expand Down Expand Up @@ -2426,6 +2432,8 @@
A5162F01A1B2C3D4E5F60001 /* OSSessionService.swift */,
A5162F01A1B2C3D4E5F60013 /* OSSessionsRequests.swift */,
A5162F01A1B2C3D4E5F60011 /* OSSessionsBackendService.swift */,
A5162F01A1B2C3D4E5F60017 /* OSSessionRequestQueue.swift */,
A5162F01A1B2C3D4E5F6001B /* OSSessionRequest.swift */,
A5426001A1B2C3D4E5F60001 /* OSInputGuard.swift */,
DEFB3E642BB7346D00E65DAD /* OSLiveActivities.swift */,
DEFB3E662BB735B500E65DAD /* OSStubLiveActivities.swift */,
Expand Down Expand Up @@ -2756,6 +2764,7 @@
A5062F01A1B2C3D4E5F60003 /* OSDeviceGestureDetectorTests.swift */,
A5162F01A1B2C3D4E5F60003 /* OSSessionServiceTests.swift */,
A5162F01A1B2C3D4E5F60015 /* OSSessionsBackendServiceTests.swift */,
A5162F01A1B2C3D4E5F60019 /* OSSessionRequestQueueTests.swift */,
A5426001A1B2C3D4E5F60003 /* OSInputGuardTests.swift */,
3B6A59620B83538CEFF77269 /* OSLogCrashHandlerTests.swift */,
9CC252C94ECB485E8D0380E9 /* FileLogStoreRetentionTests.swift */,
Expand Down Expand Up @@ -4678,6 +4687,8 @@
A5162F01A1B2C3D4E5F60002 /* OSSessionService.swift in Sources */,
A5162F01A1B2C3D4E5F60014 /* OSSessionsRequests.swift in Sources */,
A5162F01A1B2C3D4E5F60012 /* OSSessionsBackendService.swift in Sources */,
A5162F01A1B2C3D4E5F60018 /* OSSessionRequestQueue.swift in Sources */,
A5162F01A1B2C3D4E5F6001C /* OSSessionRequest.swift in Sources */,
A5426001A1B2C3D4E5F60002 /* OSInputGuard.swift in Sources */,
3C4F9E4428A4466C009F453A /* OSOperationRepo.swift in Sources */,
3C14E3B02FAE54C006ED053 /* IOSLogger.swift in Sources */,
Expand Down Expand Up @@ -4876,6 +4887,7 @@
A5062F01A1B2C3D4E5F60004 /* OSDeviceGestureDetectorTests.swift in Sources */,
A5162F01A1B2C3D4E5F60004 /* OSSessionServiceTests.swift in Sources */,
A5162F01A1B2C3D4E5F60016 /* OSSessionsBackendServiceTests.swift in Sources */,
A5162F01A1B2C3D4E5F6001A /* OSSessionRequestQueueTests.swift in Sources */,
A5426001A1B2C3D4E5F60004 /* OSInputGuardTests.swift in Sources */,
C781A33FED62B4B54221A09A /* OSLogCrashHandlerTests.swift in Sources */,
32D3A6EA8AD44274B5CE378A /* FileLogStoreRetentionTests.swift in Sources */,
Expand Down
1 change: 1 addition & 0 deletions iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalCommonDefines.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@
#define OSUD_UNSENT_ACTIVE_TIME @"GT_UNSENT_ACTIVE_TIME" // * OSUD_UNSENT_ACTIVE_TIME
#define OSUD_UNSENT_ACTIVE_TIME_ATTRIBUTED @"GT_UNSENT_ACTIVE_TIME_ATTRIBUTED" // * OSUD_UNSENT_ACTIVE_TIME_ATTRIBUTED
#define OSUD_SESSION_RECORD @"OSUD_SESSION_RECORD"
#define OSUD_SESSION_REQUEST_QUEUE @"OSUD_SESSION_REQUEST_QUEUE"

// To avoid undefined symbol compiler errors on older versions of Xcode,
// instead of using UNAuthorizationOptionProvisional directly, we will use
Expand Down
128 changes: 128 additions & 0 deletions iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/OSSessionRequest.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
/*
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.
*/

import Foundation
import Network

struct OSSessionRequest: Codable, Equatable {
enum Kind: Codable, Equatable {
/// `startTime` is seconds since 1970.
case create(startTime: TimeInterval, directAttributionId: String?)
/// `activeDuration` is cumulative for the session. `endTime` is seconds since 1970, set
/// only on the update that ends the session.
case update(activeDuration: TimeInterval, endTime: TimeInterval?)
}

let appId: String
/// `OSSessionRecord.sessionId`, which stands in for the backend session ID until the create succeeds.
let localSessionId: String
/// Set on an update once its session's create succeeds.
var serverSessionId: String?
let identityModelId: String?
var onesignalId: String?
var subscriptionId: String?
var kind: Kind
/// Generated once and persisted, so every retry, including after a restart, is deduplicated by the backend.
let idempotencyKey: String
/// Failed attempts the backend answered, persisted so the limit holds across restarts.
var failedAttempts = 0

var isCreate: Bool {
if case .create = kind {
return true
}
return false
}

var isEnd: Bool {
if case .update(_, let endTime) = kind {
return endTime != nil
}
return false
}

/// Leaves out the user and subscription IDs, since WARN logs can be uploaded.
var logDescription: String {
let kindName = isCreate ? "create" : (isEnd ? "end" : "update")
return "\(kindName) for session \(localSessionId), failed attempts: \(failedAttempts)"
}

var activeDuration: TimeInterval? {
if case .update(let activeDuration, _) = kind {
return activeDuration
}
return nil
}
}

protocol OSSessionNetworkMonitoring: AnyObject {
func start(onAvailable: @escaping () -> Void)
func stop()
}

final class OSSessionNetworkMonitor: OSSessionNetworkMonitoring {
private var monitor: NWPathMonitor?

func start(onAvailable: @escaping () -> Void) {
guard monitor == nil else {
return
}
let monitor = NWPathMonitor()
var wasSatisfied: Bool?
monitor.pathUpdateHandler = { path in
let isSatisfied = path.status == .satisfied
defer { wasSatisfied = isSatisfied }
if isSatisfied, wasSatisfied == false {
onAvailable()
}
}
monitor.start(queue: DispatchQueue(label: "OneSignal.OSSessionNetworkMonitor"))
self.monitor = monitor
}

func stop() {
monitor?.cancel()
monitor = nil
}

deinit {
monitor?.cancel()
}
}

extension OSSessionsApiResult {
func map<T>(_ transform: (Value) -> T) -> OSSessionsApiResult<T> {
switch self {
case .success(let value):
return .success(transform(value))
case .retry(let statusCode, let retryAfterSeconds):
return .retry(statusCode: statusCode, retryAfterSeconds: retryAfterSeconds)
case .drop(let statusCode):
return .drop(statusCode: statusCode)
}
}
}
Loading
Loading