Skip to content

Avoid task delegates for background sessions #25774

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
crazytonyli merged 3 commits into from
Jul 14, 2026
+39 −11
Merged

Avoid task delegates for background sessions #25774

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
510d0cb
Avoid task delegates for background sessions
crazytonyli Jul 13, 2026
7bd3c34
Format HTTPClient
crazytonyli Jul 13, 2026
0c00b5f
Extract background session check
crazytonyli Jul 13, 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
50 changes: 39 additions & 11 deletions Modules/Sources/WordPressKit/HTTPClient.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,22 @@ extension URLSession {
fulfilling parentProgress: Progress? = nil,
errorType: E.Type = E.self
) async -> WordPressAPIResult<HTTPAPIResponse<Data>, E> {
if configuration.identifier != nil {
assert(delegate is BackgroundURLSessionDelegate, "Unexpected `URLSession` delegate type. See the `backgroundSession(configuration:)`")
if isBackgroundSession() {
assert(
delegate is BackgroundURLSessionDelegate,
"Unexpected `URLSession` delegate type. See the `backgroundSession(configuration:)`"
)
}

if let parentProgress {
assert(parentProgress.completedUnitCount == 0 && parentProgress.totalUnitCount > 0, "Invalid parent progress")
assert(parentProgress.cancellationHandler == nil, "The progress instance's cancellationHandler property must be nil")
assert(
parentProgress.completedUnitCount == 0 && parentProgress.totalUnitCount > 0,
"Invalid parent progress"
)
assert(
parentProgress.cancellationHandler == nil,
"The progress instance's cancellationHandler property must be nil"
)
}

let taskHolder = TaskHolder()
Expand All @@ -83,7 +92,11 @@ extension URLSession {
guard let task = await taskHolder.task as? URLSessionDataTask else { return }

if let data {
(wpkURLSessionNotifyingDelegate as? URLSessionDataDelegate)?.urlSession?(self, dataTask: task, didReceive: data)
(wpkURLSessionNotifyingDelegate as? URLSessionDataDelegate)?.urlSession?(
self,
dataTask: task,
didReceive: data
)
}
wpkURLSessionNotifyingDelegate?.urlSession?(self, task: task, didCompleteWithError: error)
}
Expand All @@ -107,7 +120,11 @@ extension URLSession {
return
}

task.delegate = wpkURLSessionNotifyingDelegate
// Background tasks only support the delegate assigned to their session at creation time.
if !isBackgroundSession(), let delegate = wpkURLSessionNotifyingDelegate {
task.delegate = delegate
}

task.resume()
taskCreated?(task.taskIdentifier)
Task { await taskHolder.assign(task) }
Expand Down Expand Up @@ -140,9 +157,10 @@ extension URLSession {
//
// In reality, `callCompletionFromDelegate` and `isBackgroundSession` have the same value.
let callCompletionFromDelegate = delegate is BackgroundURLSessionDelegate
let isBackgroundSession = configuration.identifier != nil
let isBackgroundSession = self.isBackgroundSession()
let task: URLSessionTask
let body = try builder.encodeMultipartForm(request: &request, forceWriteToFile: isBackgroundSession)
let body =
try builder.encodeMultipartForm(request: &request, forceWriteToFile: isBackgroundSession)
?? builder.encodeXMLRPC(request: &request, forceWriteToFile: isBackgroundSession)
var completion = originalCompletion
if let body {
Expand Down Expand Up @@ -179,14 +197,21 @@ extension URLSession {
}

if callCompletionFromDelegate {
assert(delegate is BackgroundURLSessionDelegate, "Unexpected `URLSession` delegate type. See the `backgroundSession(configuration:)`")
assert(
delegate is BackgroundURLSessionDelegate,
"Unexpected `URLSession` delegate type. See the `backgroundSession(configuration:)`"
)

set(completion: completion, forTaskWithIdentifier: task.taskIdentifier)
}

return task
}

private func isBackgroundSession() -> Bool {
configuration.identifier != nil
}

private static func parseResponse<E: LocalizedError>(
data: Data?,
response: URLResponse?,
Expand Down Expand Up @@ -226,7 +251,9 @@ extension WordPressAPIResult {
do {
return try .success(transform(success))
} catch {
return .failure(.unparsableResponse(response: success.response, body: success.body, underlyingError: error))
return .failure(
.unparsableResponse(response: success.response, body: success.body, underlyingError: error)
)
}
}
}
Expand All @@ -248,7 +275,8 @@ extension WordPressAPIResult {
do {
return try WordPressAPIError<E>.endpointError(transform(response, body))
} catch {
return WordPressAPIError<E>.unparsableResponse(response: response, body: body, underlyingError: error)
return WordPressAPIError<E>
.unparsableResponse(response: response, body: body, underlyingError: error)
}
}
return error
Expand Down