Cherry pick of pull request forcedotcom#3958 from bbirman/rest-callbacks

Fix callbacks for RestAPI

Author: bbirman

libs/SalesforceSDKCore/SalesforceSDKCore/Classes/RestAPI/SFRestAPI.m

@@ -290,14 +290,14 @@ - (void)send:(SFRestRequest *)request
         [[SFUserAccountManager sharedInstance] loginWithReason:SFLoginReasonRestCredentials completion:^(SFOAuthInfo *authInfo, SFUserAccount *userAccount) {
             __strong typeof(weakSelf) strongSelf = weakSelf;
             strongSelf.user = userAccount;
-            [strongSelf enqueueRequest:request failureBlock:failureBlock successBlock:successBlock shouldRetry:shouldRetry];
+            [strongSelf enqueueRequest:request shouldRetry:shouldRetry];
         } failure:^(SFOAuthInfo *authInfo, NSError *error) {
             __strong typeof(weakSelf) strongSelf = weakSelf;
             [SFSDKCoreLogger e:[strongSelf class] format:@"Authentication failed in SFRestAPI: %@. Logging out.", error];
             [[SFUserAccountManager sharedInstance] logout:SFLogoutReasonUnexpected];
         }];
     } else {
-        [self enqueueRequest:request failureBlock:failureBlock successBlock:successBlock shouldRetry:shouldRetry];
+        [self enqueueRequest:request shouldRetry:shouldRetry];
     }
 }
 
@@ -315,10 +315,7 @@ - (SFOAuthSessionRefresher *)sessionRefresherForUser:(SFUserAccount *)user {
     return self.oauthSessionRefresher;
 }
 
-- (void)enqueueRequest:(SFRestRequest *)request
-          failureBlock:(SFRestRequestFailBlock)failureBlock
-          successBlock:(SFRestResponseBlock)successBlock
-           shouldRetry:(BOOL)shouldRetry {
+- (void)enqueueRequest:(SFRestRequest *)request shouldRetry:(BOOL)shouldRetry {
     __weak __typeof(self) weakSelf = self;
     NSURLRequest *finalRequest = [request prepareRequestForSend:self.user];
     if (finalRequest) {
@@ -338,16 +335,16 @@ - (void)enqueueRequest:(SFRestRequest *)request
             if (error) {
                 [SFSDKCoreLogger d:[strongSelf class] format:@"REST request failed with error: Error Code: %ld, Description: %@, URL: %@", (long) error.code, error.localizedDescription, finalRequest.URL];
                 id dataForDelegate = [strongSelf prepareDataForDelegate:data request:request response:response];
-                if (failureBlock) {
-                    failureBlock(dataForDelegate, error, response);
+                if (request.failureBlock) {
+                    request.failureBlock(dataForDelegate, error, response);
                 }
                 return;
             }
 
             // Timeout.
             if (!response) {
-                if (failureBlock) {
-                    failureBlock(nil, nil, nil);
+                if (request.failureBlock) {
+                    request.failureBlock(nil, nil, nil);
                 }
                 return;
             }
@@ -356,18 +353,18 @@ - (void)enqueueRequest:(SFRestRequest *)request
             // 2xx indicates success.
             if ([SFRestAPI isStatusCodeSuccess:statusCode]) {
                 id dataForDelegate = [strongSelf prepareDataForDelegate:data request:request response:response];
-                if (successBlock) {
-                    successBlock(dataForDelegate, response);
+                if (request.successBlock) {
+                    request.successBlock(dataForDelegate, response);
                 }
             } else {
                 if (shouldRetry && [self shouldRetryTask:dataTask withData:data]) {
-                    [strongSelf replayRequest:request response:response failureBlock:failureBlock successBlock:successBlock];
+                    [strongSelf replayRequest:request response:response];
                 } else {
                     // Other status codes indicate failure.
                     NSError *errorForDelegate = [strongSelf prepareErrorForDelegate:data response:response];
                     id dataForDelegate = [strongSelf prepareDataForDelegate:data request:request response:response];
-                    if (failureBlock) {
-                        failureBlock(dataForDelegate, errorForDelegate, response);
+                    if (request.failureBlock) {
+                        request.failureBlock(dataForDelegate, errorForDelegate, response);
                     }
                 }
             }
@@ -447,10 +444,7 @@ - (NSError*) prepareErrorForDelegate:(NSData *)data response:(NSURLResponse *)re
     return [[NSError alloc] initWithDomain:kSFRestErrorDomain code:statusCode userInfo:errorDict];
 }
 
-- (void)replayRequest:(SFRestRequest *)request
-             response:(NSURLResponse *)response
-         failureBlock:(SFRestRequestFailBlock)failureBlock
-         successBlock:(SFRestResponseBlock)successBlock {
+- (void)replayRequest:(SFRestRequest *)request response:(NSURLResponse *)response {
     [SFSDKCoreLogger i:[self class] format:@"%@: REST request failed due to expired credentials. Attempting to refresh credentials.", NSStringFromSelector(_cmd)];
 
     /*
@@ -470,22 +464,13 @@ - (void)replayRequest:(SFRestRequest *)request
                 @synchronized (strongSelf) {
                     if (!strongSelf.pendingRequestsBeingProcessed) {
                         strongSelf.pendingRequestsBeingProcessed = YES;
-                        [strongSelf resendActiveRequestsRequiringAuthenticationWithFailureBlock:failureBlock
-                                                                                   successBlock:successBlock];
+                        [strongSelf resendActiveRequestsRequiringAuthentication];
                     }
                 }
             } error:^(NSError *refreshError) {
                 __strong typeof(weakSelf) strongSelf = weakSelf;
                 [SFSDKCoreLogger e:[strongSelf class] format:@"Failed to refresh expired session. Error: %@", refreshError];
-                
-                // Call the failure block for the triggering request first
-                if (failureBlock) {
-                    failureBlock(nil, refreshError, response);
-                }
-                
                 strongSelf.pendingRequestsBeingProcessed = YES;
-                // Remove the triggering request from active requests to avoid double callback
-                [strongSelf.activeRequests removeObject:request];
                 [strongSelf flushPendingRequestQueue:refreshError rawResponse:response];
                 strongSelf.sessionRefreshInProgress = NO;
                 strongSelf.oauthSessionRefresher = nil;
@@ -514,14 +499,13 @@ - (void)flushPendingRequestQueue:(NSError *)error rawResponse:(NSURLResponse *)r
     }
 }
 
-- (void)resendActiveRequestsRequiringAuthenticationWithFailureBlock:(SFRestRequestFailBlock)failureBlock
-                                                   successBlock:(SFRestResponseBlock)successBlock  {
+- (void)resendActiveRequestsRequiringAuthentication {
     @synchronized (self) {
         NSSet *pendingRequests = [self.activeRequests asSet];
         for (SFRestRequest *request in pendingRequests) {
             [self send:request
-          failureBlock:failureBlock
-          successBlock:successBlock
+          failureBlock:request.failureBlock
+          successBlock:request.successBlock
            shouldRetry:NO];
         }
         self.pendingRequestsBeingProcessed = NO;

libs/SalesforceSDKCore/SalesforceSDKCoreTests/RestClientTest.swift

@@ -771,6 +771,60 @@ class RestClientTests: XCTestCase {
         }
     }
 
+    func testRefreshWithSuccesfulRequests() async throws {
+        // Revoke access token
+        try await revokeAccessToken()
+        
+        // Send multiple requests for replay and verify completion block is only called once per request
+        let resourcesRequest = RestClient.shared.request(forResources: nil)
+        let resourcesExpectation = XCTestExpectation(description: "Resources request")
+        resourcesExpectation.assertForOverFulfill = true
+        RestClient.shared.send(resourcesRequest) { _, error, _  in
+            XCTFail("Request unexpectedly failed with error: \(error.debugDescription)")
+        } successBlock: { _,_ in
+            resourcesExpectation.fulfill()
+        }
+        
+        let describeRequest = RestClient.shared.request(forDescribeGlobal: nil)
+        let describeExpectation = XCTestExpectation(description: "Describe request")
+        describeExpectation.assertForOverFulfill = true
+        RestClient.shared.send(describeRequest) { _, error, _  in
+            XCTFail("Request unexpectedly failed with error: \(error.debugDescription)")
+        } successBlock: { _,_ in
+            describeExpectation.fulfill()
+        }
+        
+        let contactRequest = RestClient.shared.requestForDescribe(withObjectType: "Contact", apiVersion: nil)
+        let contactExpectation = XCTestExpectation(description: "Contact request")
+        contactExpectation.assertForOverFulfill = true
+        RestClient.shared.send(contactRequest) { _, error, _ in
+            XCTFail("Request unexpectedly failed with error: \(error.debugDescription)")
+        } successBlock: { _,_ in
+           contactExpectation.fulfill()
+        }
+
+        await fulfillment(of: [resourcesExpectation, describeExpectation, contactExpectation])
+    }
+    
+    private func revokeAccessToken() async throws  {
+        guard let currentUser = UserAccountManager.shared.currentUserAccount,
+              let accessToken = currentUser.credentials.accessToken,
+              let encodedToken = accessToken.addingPercentEncoding(withAllowedCharacters: .urlQueryAllowed) else {
+            XCTFail("No current user access token")
+            return
+        }
+        
+        let request = RestRequest(method: .POST, path: "/services/oauth2/revoke", queryParams: nil)
+        request.endpoint = ""
+        
+        // Set the request body with URL-encoded token
+        let bodyString = "token=\(encodedToken)"
+        request.setCustomRequestBodyString(bodyString, contentType: "application/x-www-form-urlencoded")
+        
+        // Send the request
+        _ = try await RestClient.shared.send(request: request)
+    }
+    
     private func generateRecordName() -> String {
         let timecode = Date.timeIntervalSinceReferenceDate
         return "SwiftTestsiOS\(timecode)"