feat(auto-retry): added possibility to retry other requests

pubnub · Dec 19, 2023 · cc672a2 · cc672a2
1 parent b47b478
commit cc672a2
Show file tree

Hide file tree

Showing 11 changed files with 518 additions and 247 deletions.
diff --git a/PubNubMembership/Sources/Membership+PubNub.swift b/PubNubMembership/Sources/Membership+PubNub.swift
@@ -18,7 +18,6 @@ import PubNubUser
 public protocol PubNubMembershipInterface {
   /// A copy of the configuration object used for this session
   var configuration: PubNubConfiguration { get }
-
   /// Session used for performing request/response REST calls
   var networkSession: SessionReplaceable { get }
 
@@ -268,6 +267,7 @@ public extension PubNubMembershipInterface {
     (requestConfig.customSession ?? networkSession)
       .route(
         router,
+        requestOperator: configuration.automaticRetry?[.fetchMemberships],
         responseDecoder: FetchMultipleValueResponseDecoder<PubNubMembership.PartialSpace>(),
         responseQueue: requestConfig.responseQueue
       ) { result in
@@ -320,6 +320,7 @@ public extension PubNubMembershipInterface {
     (requestConfig.customSession ?? networkSession)
       .route(
         router,
+        requestOperator: configuration.automaticRetry?[.fetchMemberships],
         responseDecoder: FetchMultipleValueResponseDecoder<PubNubMembership.PartialUser>(),
         responseQueue: requestConfig.responseQueue
       ) { result in
@@ -365,6 +366,7 @@ public extension PubNubMembershipInterface {
     (requestConfig.customSession ?? networkSession)
       .route(
         router,
+        requestOperator: configuration.automaticRetry?[.addMemberships],
         responseDecoder: FetchStatusResponseDecoder(),
         responseQueue: requestConfig.responseQueue
       ) { result in
@@ -401,6 +403,7 @@ public extension PubNubMembershipInterface {
     (requestConfig.customSession ?? networkSession)
       .route(
         router,
+        requestOperator: configuration.automaticRetry?[.addMemberships],
         responseDecoder: FetchStatusResponseDecoder(),
         responseQueue: requestConfig.responseQueue
       ) { result in
@@ -463,6 +466,7 @@ public extension PubNubMembershipInterface {
     (requestConfig.customSession ?? networkSession)
       .route(
         router,
+        requestOperator: configuration.automaticRetry?[.removeMemberships],
         responseDecoder: FetchStatusResponseDecoder(),
         responseQueue: requestConfig.responseQueue
       ) { result in
@@ -499,6 +503,7 @@ public extension PubNubMembershipInterface {
     (requestConfig.customSession ?? networkSession)
       .route(
         router,
+        requestOperator: configuration.automaticRetry?[.removeMemberships],
         responseDecoder: FetchStatusResponseDecoder(),
         responseQueue: requestConfig.responseQueue
       ) { result in

diff --git a/PubNubSpace/Sources/Space+PubNub.swift b/PubNubSpace/Sources/Space+PubNub.swift
@@ -16,7 +16,6 @@ import PubNub
 public protocol PubNubSpaceInterface {
   /// A copy of the configuration object used for this session
   var configuration: PubNubConfiguration { get }
-
   /// Session used for performing request/response REST calls
   var networkSession: SessionReplaceable { get }
 
@@ -213,6 +212,7 @@ public extension PubNubSpaceInterface {
     (requestConfig.customSession ?? networkSession)
       .route(
         router,
+        requestOperator: configuration.automaticRetry?[.fetchSpaces],
         responseDecoder: FetchMultipleValueResponseDecoder<PubNubSpace>(),
         responseQueue: requestConfig.responseQueue
       ) { result in
@@ -237,6 +237,7 @@ public extension PubNubSpaceInterface {
     (requestConfig.customSession ?? networkSession)
       .route(
         router,
+        requestOperator: configuration.automaticRetry?[.fetchSpaces],
         responseDecoder: FetchSingleValueResponseDecoder<PubNubSpace>(),
         responseQueue: requestConfig.responseQueue
       ) { result in
@@ -273,6 +274,7 @@ public extension PubNubSpaceInterface {
     (requestConfig.customSession ?? networkSession)
       .route(
         router,
+        requestOperator: configuration.automaticRetry?[.createSpace],
         responseDecoder: FetchSingleValueResponseDecoder<PubNubSpace>(),
         responseQueue: requestConfig.responseQueue
       ) { result in
@@ -317,6 +319,7 @@ public extension PubNubSpaceInterface {
     (requestConfig.customSession ?? networkSession)
       .route(
         router,
+        requestOperator: configuration.automaticRetry?[.removeSpace],
         responseDecoder: FetchStatusResponseDecoder(),
         responseQueue: requestConfig.responseQueue
       ) { result in

diff --git a/PubNubUser/Sources/User+PubNub.swift b/PubNubUser/Sources/User+PubNub.swift
@@ -9,14 +9,12 @@
 //
 
 import Foundation
-
 import PubNub
 
 /// Protocol interface to manage `PubNubUser` entities using closures
 public protocol PubNubUserInterface {
   /// A copy of the configuration object used for this session
   var configuration: PubNubConfiguration { get }
-
   /// Session used for performing request/response REST calls
   var networkSession: SessionReplaceable { get }
 
@@ -221,6 +219,7 @@ public extension PubNubUserInterface {
     (requestConfig.customSession ?? networkSession)?
       .route(
         router,
+        requestOperator: configuration.automaticRetry?[.fetchUsers],
         responseDecoder: FetchMultipleValueResponseDecoder<PubNubUser>(),
         responseQueue: requestConfig.responseQueue
       ) { result in
@@ -248,6 +247,7 @@ public extension PubNubUserInterface {
     (requestConfig.customSession ?? networkSession)
       .route(
         router,
+        requestOperator: configuration.automaticRetry?[.fetchUsers],
         responseDecoder: FetchSingleValueResponseDecoder<PubNubUser>(),
         responseQueue: requestConfig.responseQueue
       ) {
@@ -288,6 +288,7 @@ public extension PubNubUserInterface {
     (requestConfig.customSession ?? networkSession)
       .route(
         router,
+        requestOperator: configuration.automaticRetry?[.createUser],
         responseDecoder: FetchSingleValueResponseDecoder<PubNubUser>(),
         responseQueue: requestConfig.responseQueue
       ) { result in
@@ -336,6 +337,7 @@ public extension PubNubUserInterface {
     (requestConfig.customSession ?? networkSession)
       .route(
         router,
+        requestOperator: configuration.automaticRetry?[.removeUser],
         responseDecoder: FetchStatusResponseDecoder(),
         responseQueue: requestConfig.responseQueue
       ) { result in

diff --git a/Sources/PubNub/APIs/File+PubNub.swift b/Sources/PubNub/APIs/File+PubNub.swift
@@ -29,6 +29,7 @@ public extension PubNub {
   ) {
     route(
       FileManagementRouter(.list(channel: channel, limit: limit, next: next), configuration: configuration),
+      requestOperator: configuration.automaticRetry?[.listFiles],
       responseDecoder: FileListResponseDecoder(),
       custom: requestConfig
     ) { result in
@@ -60,6 +61,7 @@ public extension PubNub {
   ) {
     route(
       FileManagementRouter(.delete(channel: channel, fileId: fileId, filename: filename), configuration: configuration),
+      requestOperator: configuration.automaticRetry?[.removeFile],
       responseDecoder: FileGeneralSuccessResponseDecoder(),
       custom: requestConfig
     ) { result in
@@ -137,6 +139,7 @@ public extension PubNub {
         .generateURL(channel: channel, body: .init(name: remoteFilename)),
         configuration: configuration
       ),
+      requestOperator: configuration.automaticRetry?[.generateFileUploadURL],
       responseDecoder: FileGenerateResponseDecoder(),
       custom: requestConfig
     ) { [configuration] result in
@@ -225,9 +228,12 @@ public extension PubNub {
       configuration: configuration
     )
 
-    route(router,
-          responseDecoder: PublishResponseDecoder(),
-          custom: request.customRequestConfig) { result in
+    route(
+      router,
+      requestOperator: configuration.automaticRetry?[.publishFile],
+      responseDecoder: PublishResponseDecoder(),
+      custom: request.customRequestConfig
+    ) { result in
       completion?(result.map { $0.payload.timetoken })
     }
   }

diff --git a/Sources/PubNub/Helpers/Constants.swift b/Sources/PubNub/Helpers/Constants.swift
@@ -162,6 +162,10 @@ public extension Constant {
   /// Produces a `User-Agent` header according to
   /// [RFC7231 section 5.5.3](https://tools.ietf.org/html/rfc7231#section-5.5.3)
   static let userAgentHeaderKey = "User-Agent"
+
+  /// A header indicating how long to wait before making a new request
+  /// [RFC6585 section 4](https://datatracker.ietf.org/doc/html/rfc6585#section-4)
+  static let retryAfterHeaderKey = "Retry-After"
 
   internal static let defaultUserAgentHeader: String = {
     let userAgent: String = {

diff --git a/Sources/PubNub/Networking/Replaceables+PubNub.swift b/Sources/PubNub/Networking/Replaceables+PubNub.swift
@@ -126,6 +126,7 @@ public protocol SessionReplaceable {
 
   func route<Decoder>(
     _ router: HTTPRouter,
+    requestOperator: RequestOperator?,
     responseDecoder: Decoder,
     responseQueue: DispatchQueue,
     completion: @escaping (Result<EndpointResponse<Decoder.Payload>, Error>) -> Void
@@ -135,11 +136,12 @@ public protocol SessionReplaceable {
 public extension SessionReplaceable {
   func route<Decoder>(
     _ router: HTTPRouter,
+    requestOperator: RequestOperator? = nil,
     responseDecoder: Decoder,
     responseQueue: DispatchQueue = .main,
     completion: @escaping (Result<EndpointResponse<Decoder.Payload>, Error>) -> Void
   ) where Decoder: ResponseDecoder {
-    request(with: router, requestOperator: nil)
+    request(with: router, requestOperator: requestOperator)
       .validate()
       .response(
         on: responseQueue,