delete session only when error is non-retryable

Author: grdsdev

Sources/Auth/AuthError.swift

@@ -1,4 +1,5 @@
 import Foundation
+import Helpers
 
 #if canImport(FoundationNetworking)
   import FoundationNetworking
@@ -47,7 +48,8 @@ extension ErrorCode {
   public static let oauthProviderNotSupported = ErrorCode("oauth_provider_not_supported")
   public static let unexpectedAudience = ErrorCode("unexpected_audience")
   public static let singleIdentityNotDeletable = ErrorCode("single_identity_not_deletable")
-  public static let emailConflictIdentityNotDeletable = ErrorCode("email_conflict_identity_not_deletable")
+  public static let emailConflictIdentityNotDeletable = ErrorCode(
+    "email_conflict_identity_not_deletable")
   public static let identityAlreadyExists = ErrorCode("identity_already_exists")
   public static let emailProviderDisabled = ErrorCode("email_provider_disabled")
   public static let phoneProviderDisabled = ErrorCode("phone_provider_disabled")
@@ -108,14 +110,16 @@ public enum AuthError: LocalizedError, Equatable {
   @available(
     *,
     deprecated,
-    message: "Error used to be thrown when no exp claim was found in JWT during setSession(accessToken:refreshToken:) method."
+    message:
+      "Error used to be thrown when no exp claim was found in JWT during setSession(accessToken:refreshToken:) method."
   )
   case missingExpClaim
 
   @available(
     *,
     deprecated,
-    message: "Error used to be thrown when provided JWT wasn't valid during setSession(accessToken:refreshToken:) method."
+    message:
+      "Error used to be thrown when provided JWT wasn't valid during setSession(accessToken:refreshToken:) method."
   )
   case malformedJWT
 
@@ -155,14 +159,16 @@ public enum AuthError: LocalizedError, Equatable {
   @available(
     *,
     deprecated,
-    message: "This error is never thrown, if you depend on it, you can remove the logic as it never happens."
+    message:
+      "This error is never thrown, if you depend on it, you can remove the logic as it never happens."
   )
   case missingURL
 
   @available(
     *,
     deprecated,
-    message: "Error used to be thrown on methods which required a valid redirect scheme, such as signInWithOAuth. This is now considered a programming error an a assertion is triggered in case redirect scheme isn't provided."
+    message:
+      "Error used to be thrown on methods which required a valid redirect scheme, such as signInWithOAuth. This is now considered a programming error an a assertion is triggered in case redirect scheme isn't provided."
   )
   case invalidRedirectScheme
 
@@ -249,9 +255,9 @@ public enum AuthError: LocalizedError, Equatable {
     switch self {
     case .sessionMissing: "Auth session missing."
     case let .weakPassword(message, _),
-         let .api(message, _, _, _),
-         let .pkceGrantCodeExchange(message, _, _),
-         let .implicitGrantRedirect(message):
+      let .api(message, _, _, _),
+      let .pkceGrantCodeExchange(message, _, _),
+      let .implicitGrantRedirect(message):
       message
     // Deprecated cases
     case .missingExpClaim: "Missing expiration claim in the access token."
@@ -281,3 +287,13 @@ public enum AuthError: LocalizedError, Equatable {
     return lhs == rhs
   }
 }
+
+extension AuthError: RetryableError {
+  package var shouldRetry: Bool {
+    switch self {
+    case .api(_, _, _, let response):
+      defaultRetryableHTTPStatusCodes.contains(response.statusCode)
+    default: false
+    }
+  }
+}

Sources/Auth/Internal/SessionManager.swift

@@ -84,7 +84,7 @@ private actor LiveSessionManager {
                 url: configuration.url.appendingPathComponent("token"),
                 method: .post,
                 query: [
-                  URLQueryItem(name: "grant_type", value: "refresh_token"),
+                  URLQueryItem(name: "grant_type", value: "refresh_token")
                 ],
                 body: configuration.encoder.encode(
                   UserCredentials(refreshToken: refreshToken)
@@ -97,10 +97,13 @@ private actor LiveSessionManager {
             eventEmitter.emit(.tokenRefreshed, session: session)
 
             return session
+          } catch let error as RetryableError {
+            logger?.debug("Refresh token failed with a retryable error: \(error)")
+            throw error
           } catch {
-            logger?.debug("Failed to refresh token: \(error)")
+            logger?.debug("Refresh token failed with a non-retryable error: \(error)")
+
             remove()
-            eventEmitter.emit(.signedOut, session: nil)
 
             throw error
           }
@@ -146,7 +149,9 @@ private actor LiveSessionManager {
       }
 
       let expiresInTicks = Int((session.expiresAt - now) / autoRefreshTickDuration)
-      logger?.debug("access token expires in \(expiresInTicks) ticks, a tick lasts \(autoRefreshTickDuration)s, refresh threshold is \(autoRefreshTickThreshold) ticks")
+      logger?.debug(
+        "access token expires in \(expiresInTicks) ticks, a tick lasts \(autoRefreshTickDuration)s, refresh threshold is \(autoRefreshTickThreshold) ticks"
+      )
 
       if expiresInTicks <= autoRefreshTickThreshold {
         _ = try? await refreshSession(session.refreshToken)

Sources/Helpers/HTTP/RetryRequestInterceptor.swift

@@ -30,22 +30,6 @@ package actor RetryRequestInterceptor: HTTPClientInterceptor {
     .delete, .get, .head, .options, .put, .trace,
   ]
 
-  /// The default set of retryable HTTP status codes.
-  package static let defaultRetryableHTTPStatusCodes: Set<Int> = [
-    408, 500, 502, 503, 504,
-  ]
-
-  /// The default set of retryable URL error codes.
-  package static let defaultRetryableURLErrorCodes: Set<URLError.Code> = [
-    .backgroundSessionInUseByAnotherProcess, .backgroundSessionWasDisconnected,
-    .badServerResponse, .callIsActive, .cannotConnectToHost, .cannotFindHost,
-    .cannotLoadFromNetwork, .dataNotAllowed, .dnsLookupFailed,
-    .downloadDecodingFailedMidStream, .downloadDecodingFailedToComplete,
-    .internationalRoamingOff, .networkConnectionLost, .notConnectedToInternet,
-    .secureConnectionFailed, .serverCertificateHasBadDate,
-    .serverCertificateNotYetValid, .timedOut,
-  ]
-
   /// The maximum number of retries.
   package let retryLimit: Int
   /// The base value for exponential backoff.
@@ -73,8 +57,8 @@ package actor RetryRequestInterceptor: HTTPClientInterceptor {
     exponentialBackoffBase: UInt = RetryRequestInterceptor.defaultExponentialBackoffBase,
     exponentialBackoffScale: Double = RetryRequestInterceptor.defaultExponentialBackoffScale,
     retryableHTTPMethods: Set<HTTPTypes.HTTPRequest.Method> = RetryRequestInterceptor.defaultRetryableHTTPMethods,
-    retryableHTTPStatusCodes: Set<Int> = RetryRequestInterceptor.defaultRetryableHTTPStatusCodes,
-    retryableErrorCodes: Set<URLError.Code> = RetryRequestInterceptor.defaultRetryableURLErrorCodes
+    retryableHTTPStatusCodes: Set<Int> = defaultRetryableHTTPStatusCodes,
+    retryableErrorCodes: Set<URLError.Code> = defaultRetryableURLErrorCodes
   ) {
     precondition(
       exponentialBackoffBase >= 2, "The `exponentialBackoffBase` must be a minimum of 2."

Sources/Helpers/RetryableError.swift

@@ -0,0 +1,33 @@
+//
+//  RetryableError.swift
+//  Supabase
+//
+//  Created by Guilherme Souza on 15/10/24.
+//
+import Foundation
+
+package protocol RetryableError: Error {
+  var shouldRetry: Bool { get }
+}
+
+extension URLError: RetryableError {
+  package var shouldRetry: Bool {
+    defaultRetryableURLErrorCodes.contains(code)
+  }
+}
+
+/// The default set of retryable URL error codes.
+package let defaultRetryableURLErrorCodes: Set<URLError.Code> = [
+  .backgroundSessionInUseByAnotherProcess, .backgroundSessionWasDisconnected,
+  .badServerResponse, .callIsActive, .cannotConnectToHost, .cannotFindHost,
+  .cannotLoadFromNetwork, .dataNotAllowed, .dnsLookupFailed,
+  .downloadDecodingFailedMidStream, .downloadDecodingFailedToComplete,
+  .internationalRoamingOff, .networkConnectionLost, .notConnectedToInternet,
+  .secureConnectionFailed, .serverCertificateHasBadDate,
+  .serverCertificateNotYetValid, .timedOut,
+]
+
+/// The default set of retryable HTTP status codes.
+package let defaultRetryableHTTPStatusCodes: Set<Int> = [
+  408, 500, 502, 503, 504,
+]