Cancel requests on invalidated session

Author: kean

Package.swift

@@ -11,8 +11,8 @@ let package = Package(
     targets: [
         .binaryTarget(
             name: "WordPressKit",
-            url: "https://github.com/user-attachments/files/18570063/WordPressKit.zip",
-            checksum: "fc25d3065e80af713dac970db7ed89ff37e4cc98afc98b6a2ecf7b47b2ddd0c1"
+            url: "https://github.com/user-attachments/files/18646293/WordPressKit.zip",
+            checksum: "eb801860f5ce489390dd5a50fbd05cb3942dec8350b3665bc51c036fd669432f"
         ),
     ]
 )

Sources/CoreAPI/WordPressAPIError+NSErrorBridge.swift

@@ -33,6 +33,8 @@ extension WordPressAPIError: CustomNSError {
             return -100003
         case .unknown:
             return -100004
+        case .sessionInvalidated:
+            return -100005
         }
     }
 
@@ -42,8 +44,7 @@ extension WordPressAPIError: CustomNSError {
             return (endpointError as NSError).userInfo
         case .connection(let error):
             return [NSUnderlyingErrorKey: error]
-        case .requestEncodingFailure, .unacceptableStatusCode, .unparsableResponse,
-                .unknown:
+        case .requestEncodingFailure, .unacceptableStatusCode, .unparsableResponse, .sessionInvalidated, .unknown:
             return [:]
         }
     }

Sources/CoreAPI/WordPressAPIError.swift

@@ -19,6 +19,8 @@ import Foundation
     case unacceptableStatusCode(response: HTTPURLResponse, body: Data)
     /// The API call returned an HTTP response that WordPressKit can't parse. Receiving this error could be an indicator that there is an error response that's not handled properly by WordPressKit.
     case unparsableResponse(response: HTTPURLResponse?, body: Data?, underlyingError: Error)
+    /// Attempting to start a request on an invalidated session.
+    case sessionInvalidated
     /// Other error occured.
     case unknown(underlyingError: Error)
 
@@ -28,7 +30,7 @@ import Foundation
 
     var response: HTTPURLResponse? {
         switch self {
-        case .requestEncodingFailure, .connection, .unknown:
+        case .requestEncodingFailure, .connection, .unknown, .sessionInvalidated:
             return nil
         case let .endpointError(error):
             return (error as? HTTPURLResponseProviding)?.httpResponse
@@ -49,7 +51,7 @@ extension WordPressAPIError: LocalizedError {
         // always returns a non-nil value.
         let localizedErrorMessage: String
         switch self {
-        case .requestEncodingFailure, .unparsableResponse, .unacceptableStatusCode:
+        case .requestEncodingFailure, .unparsableResponse, .unacceptableStatusCode, .sessionInvalidated:
             // These are usually programming errors.
             localizedErrorMessage = Self.unknownErrorMessage
         case let .endpointError(error):

Sources/CoreAPI/WordPressComRestApi.swift

@@ -105,6 +105,8 @@ open class WordPressComRestApi: NSObject {
 
     private var useEphemeralSession: Bool
 
+    private var isInvalidated = false
+
     /**
      Configure whether or not the user's preferred language locale should be appended. Defaults to true.
      */
@@ -174,6 +176,10 @@ open class WordPressComRestApi: NSObject {
      Cancels all ongoing taks and makes the session invalid so the object will not fullfil any more request
      */
     @objc open func invalidateAndCancelTasks() {
+        guard !isInvalidated else {
+            return
+        }
+        isInvalidated = true
         for session in [urlSession, uploadURLSession] {
             session.invalidateAndCancel()
         }
@@ -431,7 +437,11 @@ open class WordPressComRestApi: NSObject {
         taskCreated: ((Int) -> Void)? = nil,
         session: URLSession? = nil
     ) async -> APIResult<T> {
-        await (session ?? self.urlSession)
+        guard !isInvalidated else {
+            print("Session Invalidated: ", Thread.callStackSymbols)
+            return APIResult.failure(.sessionInvalidated)
+        }
+        return await (session ?? self.urlSession)
             .perform(request: request, taskCreated: taskCreated, fulfilling: progress, errorType: WordPressComRestApiEndpointError.self)
             .mapSuccess { response -> HTTPAPIResponse<T> in
                 let object = try decoder(response.body)

Sources/CoreAPI/WordPressOrgXMLRPCApi.swift

@@ -424,6 +424,10 @@ private extension WordPressAPIError where EndpointError == WordPressOrgXMLRPCApi
             error = underlyingError as NSError
             data = body
             statusCode = nil
+        case .sessionInvalidated:
+            error = NSError(domain: WPXMLRPCFaultErrorDomain, code: -1)
+            data = nil
+            statusCode = nil
         case let .unknown(underlyingError):
             error = underlyingError as NSError
             data = nil