Merge pull request #18 from microsoftgraph/vidadhee/MiddlewareOptions

Add Middleware options for RetryHandler and RedirectHandler

Author: dadheech115

MSGraphClientSDK/MSGraphClientSDK.xcodeproj/project.pbxproj

@@ -34,6 +34,10 @@
 		E52AD9F62133E740005FED47 /* MSURLSessionUploadTaskTests.m in Sources */ = {isa = PBXBuildFile; fileRef = E52AD9F52133E73F005FED47 /* MSURLSessionUploadTaskTests.m */; };
 		E566782E2150BC4F00C6B7AE /* MSRedirectHandlerTests.m in Sources */ = {isa = PBXBuildFile; fileRef = E566782D2150BC4F00C6B7AE /* MSRedirectHandlerTests.m */; };
 		E56678302150E1AF00C6B7AE /* MSAuthenticationHandlerTests.m in Sources */ = {isa = PBXBuildFile; fileRef = E566782F2150E1AF00C6B7AE /* MSAuthenticationHandlerTests.m */; };
+		E56B101C2220086300ED640F /* MSRedirectHandlerOptions.h in Headers */ = {isa = PBXBuildFile; fileRef = E56B101A2220086300ED640F /* MSRedirectHandlerOptions.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		E56B101D2220086300ED640F /* MSRedirectHandlerOptions.m in Sources */ = {isa = PBXBuildFile; fileRef = E56B101B2220086300ED640F /* MSRedirectHandlerOptions.m */; };
+		E56B102022237F6500ED640F /* MSRetryHandlerOptionsTests.m in Sources */ = {isa = PBXBuildFile; fileRef = E56B101F22237F6500ED640F /* MSRetryHandlerOptionsTests.m */; };
+		E56B1022222382E400ED640F /* MSRedirectHandlerOptionsTests.m in Sources */ = {isa = PBXBuildFile; fileRef = E56B1021222382E400ED640F /* MSRedirectHandlerOptionsTests.m */; };
 		E56FDB9321D36A98001DFE68 /* MSURLSessionDownloadTask.h in Headers */ = {isa = PBXBuildFile; fileRef = E56FDB8B21D36A98001DFE68 /* MSURLSessionDownloadTask.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		E56FDB9421D36A98001DFE68 /* MSURLSessionTask.m in Sources */ = {isa = PBXBuildFile; fileRef = E56FDB8C21D36A98001DFE68 /* MSURLSessionTask.m */; };
 		E56FDB9521D36A98001DFE68 /* MSURLSessionUploadTask.h in Headers */ = {isa = PBXBuildFile; fileRef = E56FDB8D21D36A98001DFE68 /* MSURLSessionUploadTask.h */; settings = {ATTRIBUTES = (Public, ); }; };
@@ -47,6 +51,9 @@
 		E573EE0B213427ED00C5E884 /* MSURLSessionTaskDelegateTests.m in Sources */ = {isa = PBXBuildFile; fileRef = E573EE0A213427ED00C5E884 /* MSURLSessionTaskDelegateTests.m */; };
 		E573EE0D213525BA00C5E884 /* MSGraphWorkloadsTests.m in Sources */ = {isa = PBXBuildFile; fileRef = E573EE0C213525BA00C5E884 /* MSGraphWorkloadsTests.m */; };
 		E573EE102136569F00C5E884 /* UserPhoto.jpg in Resources */ = {isa = PBXBuildFile; fileRef = E573EE0F2136569F00C5E884 /* UserPhoto.jpg */; };
+		E59EBFEF221D3B6800B4B279 /* MSRetryHandlerOptions.h in Headers */ = {isa = PBXBuildFile; fileRef = E59EBFEC221D3B6700B4B279 /* MSRetryHandlerOptions.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		E59EBFF0221D3B6800B4B279 /* MSRetryHandlerOptions.m in Sources */ = {isa = PBXBuildFile; fileRef = E59EBFED221D3B6700B4B279 /* MSRetryHandlerOptions.m */; };
+		E59EBFF1221D3B6800B4B279 /* MSMiddlewareOptions.h in Headers */ = {isa = PBXBuildFile; fileRef = E59EBFEE221D3B6700B4B279 /* MSMiddlewareOptions.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		E5B6DB9821497DAA00836E1D /* libOCMock.a in Frameworks */ = {isa = PBXBuildFile; fileRef = E5B6DB9621497D7C00836E1D /* libOCMock.a */; };
 		E5DC73DF211412BF0040BAB6 /* MSGraphClientSDK.h in Headers */ = {isa = PBXBuildFile; fileRef = E5DC73DD211412BF0040BAB6 /* MSGraphClientSDK.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		E5DC7403211418050040BAB6 /* MSAuthenticationHandler.h in Headers */ = {isa = PBXBuildFile; fileRef = E5DC73EB211418040040BAB6 /* MSAuthenticationHandler.h */; settings = {ATTRIBUTES = (Public, ); }; };
@@ -108,6 +115,10 @@
 		E52AD9F52133E73F005FED47 /* MSURLSessionUploadTaskTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = MSURLSessionUploadTaskTests.m; sourceTree = "<group>"; };
 		E566782D2150BC4F00C6B7AE /* MSRedirectHandlerTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MSRedirectHandlerTests.m; sourceTree = "<group>"; };
 		E566782F2150E1AF00C6B7AE /* MSAuthenticationHandlerTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MSAuthenticationHandlerTests.m; sourceTree = "<group>"; };
+		E56B101A2220086300ED640F /* MSRedirectHandlerOptions.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MSRedirectHandlerOptions.h; sourceTree = "<group>"; };
+		E56B101B2220086300ED640F /* MSRedirectHandlerOptions.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MSRedirectHandlerOptions.m; sourceTree = "<group>"; };
+		E56B101F22237F6500ED640F /* MSRetryHandlerOptionsTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MSRetryHandlerOptionsTests.m; sourceTree = "<group>"; };
+		E56B1021222382E400ED640F /* MSRedirectHandlerOptionsTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MSRedirectHandlerOptionsTests.m; sourceTree = "<group>"; };
 		E56FDB8B21D36A98001DFE68 /* MSURLSessionDownloadTask.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MSURLSessionDownloadTask.h; sourceTree = "<group>"; };
 		E56FDB8C21D36A98001DFE68 /* MSURLSessionTask.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = MSURLSessionTask.m; sourceTree = "<group>"; };
 		E56FDB8D21D36A98001DFE68 /* MSURLSessionUploadTask.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MSURLSessionUploadTask.h; sourceTree = "<group>"; };
@@ -121,6 +132,9 @@
 		E573EE0A213427ED00C5E884 /* MSURLSessionTaskDelegateTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MSURLSessionTaskDelegateTests.m; sourceTree = "<group>"; };
 		E573EE0C213525BA00C5E884 /* MSGraphWorkloadsTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MSGraphWorkloadsTests.m; sourceTree = "<group>"; };
 		E573EE0F2136569F00C5E884 /* UserPhoto.jpg */ = {isa = PBXFileReference; lastKnownFileType = image.jpeg; path = UserPhoto.jpg; sourceTree = "<group>"; };
+		E59EBFEC221D3B6700B4B279 /* MSRetryHandlerOptions.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MSRetryHandlerOptions.h; sourceTree = "<group>"; };
+		E59EBFED221D3B6700B4B279 /* MSRetryHandlerOptions.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = MSRetryHandlerOptions.m; sourceTree = "<group>"; };
+		E59EBFEE221D3B6700B4B279 /* MSMiddlewareOptions.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MSMiddlewareOptions.h; sourceTree = "<group>"; };
 		E5B6DB8C21497CAC00836E1D /* OCMockObject.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OCMockObject.h; sourceTree = "<group>"; };
 		E5B6DB8D21497CAC00836E1D /* OCMMacroState.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OCMMacroState.h; sourceTree = "<group>"; };
 		E5B6DB8E21497CAC00836E1D /* OCMock.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OCMock.h; sourceTree = "<group>"; };
@@ -294,22 +308,32 @@
 		E52AD9F82133F16D005FED47 /* Middleware */ = {
 			isa = PBXGroup;
 			children = (
+				E56B101E22237F3900ED640F /* Options */,
 				E573EE1221367A7800C5E884 /* Implementations */,
 			);
 			path = Middleware;
 			sourceTree = "<group>";
 		};
+		E56B101E22237F3900ED640F /* Options */ = {
+			isa = PBXGroup;
+			children = (
+				E56B101F22237F6500ED640F /* MSRetryHandlerOptionsTests.m */,
+				E56B1021222382E400ED640F /* MSRedirectHandlerOptionsTests.m */,
+			);
+			path = Options;
+			sourceTree = "<group>";
+		};
 		E56FDB8A21D36A98001DFE68 /* Session Tasks */ = {
 			isa = PBXGroup;
 			children = (
-				E56FDB8B21D36A98001DFE68 /* MSURLSessionDownloadTask.h */,
-				E56FDB8C21D36A98001DFE68 /* MSURLSessionTask.m */,
-				E56FDB8D21D36A98001DFE68 /* MSURLSessionUploadTask.h */,
-				E56FDB8E21D36A98001DFE68 /* MSURLSessionDataTask.m */,
 				E56FDB8F21D36A98001DFE68 /* MSURLSessionTask.h */,
+				E56FDB8C21D36A98001DFE68 /* MSURLSessionTask.m */,
+				E56FDB8B21D36A98001DFE68 /* MSURLSessionDownloadTask.h */,
 				E56FDB9021D36A98001DFE68 /* MSURLSessionDownloadTask.m */,
-				E56FDB9121D36A98001DFE68 /* MSURLSessionUploadTask.m */,
 				E56FDB9221D36A98001DFE68 /* MSURLSessionDataTask.h */,
+				E56FDB8E21D36A98001DFE68 /* MSURLSessionDataTask.m */,
+				E56FDB8D21D36A98001DFE68 /* MSURLSessionUploadTask.h */,
+				E56FDB9121D36A98001DFE68 /* MSURLSessionUploadTask.m */,
 			);
 			path = "Session Tasks";
 			sourceTree = "<group>";
@@ -345,6 +369,18 @@
 			path = Implementations;
 			sourceTree = "<group>";
 		};
+		E59EBFEB221D3B6700B4B279 /* Options */ = {
+			isa = PBXGroup;
+			children = (
+				E59EBFEE221D3B6700B4B279 /* MSMiddlewareOptions.h */,
+				E59EBFEC221D3B6700B4B279 /* MSRetryHandlerOptions.h */,
+				E59EBFED221D3B6700B4B279 /* MSRetryHandlerOptions.m */,
+				E56B101A2220086300ED640F /* MSRedirectHandlerOptions.h */,
+				E56B101B2220086300ED640F /* MSRedirectHandlerOptions.m */,
+			);
+			path = Options;
+			sourceTree = "<group>";
+		};
 		E5B6DB6921497A3300836E1D /* Frameworks */ = {
 			isa = PBXGroup;
 			children = (
@@ -427,6 +463,7 @@
 		E5DC73EA211418040040BAB6 /* Middleware */ = {
 			isa = PBXGroup;
 			children = (
+				E59EBFEB221D3B6700B4B279 /* Options */,
 				E5DC73F8211418040040BAB6 /* Protocols */,
 				E5069AC3211AACCD00432372 /* Implementations */,
 			);
@@ -488,7 +525,10 @@
 				E5204FF8216F371400E64160 /* MSErrorCodes.h in Headers */,
 				E5204FEF216F1D9900E64160 /* MSBatchRequestStep.h in Headers */,
 				E5ECE0A42146657900A289C2 /* MSRedirectHandler.h in Headers */,
+				E59EBFF1221D3B6800B4B279 /* MSMiddlewareOptions.h in Headers */,
+				E59EBFEF221D3B6800B4B279 /* MSRetryHandlerOptions.h in Headers */,
 				E51E616C216DE4D300F1B3C0 /* MSRetryHandler.h in Headers */,
+				E56B101C2220086300ED640F /* MSRedirectHandlerOptions.h in Headers */,
 				E5DC73DF211412BF0040BAB6 /* MSGraphClientSDK.h in Headers */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
@@ -598,7 +638,9 @@
 				E5204FFF2173A7C200E64160 /* MSBatchRequestStepTests.m in Sources */,
 				E52050042174C1DB00E64160 /* MSBatchResponseContentTests.m in Sources */,
 				E51E616F216E073F00F1B3C0 /* MSRetryHandlerTests.m in Sources */,
+				E56B1022222382E400ED640F /* MSRedirectHandlerOptionsTests.m in Sources */,
 				E573EE072133FFF200C5E884 /* MSHTTPClientTests.m in Sources */,
+				E56B102022237F6500ED640F /* MSRetryHandlerOptionsTests.m in Sources */,
 				E52AD9E6212E8845005FED47 /* MSGraphClientSDKTests.h in Sources */,
 				E56678302150E1AF00C6B7AE /* MSAuthenticationHandlerTests.m in Sources */,
 				E52AD9F42133E171005FED47 /* MSURLSessionDownloadTaskTests.m in Sources */,
@@ -621,6 +663,8 @@
 				E5204FF1216F1D9900E64160 /* MSBatchRequestContent.m in Sources */,
 				E56FDB9421D36A98001DFE68 /* MSURLSessionTask.m in Sources */,
 				E5204FF7216F371400E64160 /* MSErrorCodes.m in Sources */,
+				E59EBFF0221D3B6800B4B279 /* MSRetryHandlerOptions.m in Sources */,
+				E56B101D2220086300ED640F /* MSRedirectHandlerOptions.m in Sources */,
 				E5DC741A21142C430040BAB6 /* MSClientFactory.m in Sources */,
 				E5069AC9211AAEC900432372 /* MSConstants.m in Sources */,
 				E56FDB9821D36A98001DFE68 /* MSURLSessionDownloadTask.m in Sources */,

MSGraphClientSDK/MSGraphClientSDK/Common/MSConstants.h

@@ -9,6 +9,7 @@
 
 typedef NS_ENUM(NSInteger, MSClientErrorCode)
 {
+    MSCLientErrorCodeSDKUpperLimitReached        = -1,
     MSClientErrorCodeBadRequest                  = 400,
     MSClientErrorCodeUnauthorized                = 401,
     MSClientErrorCodeForbidden                   = 403,
@@ -43,6 +44,14 @@ typedef NS_ENUM(NSInteger, MSExpectedResponseCodes)
     MSExpectedResponseCodesTemporaryRedirect     = 307,
 };
 
+typedef NS_ENUM(NSInteger, MSMiddlewareOptionsType)
+{
+    MSMiddlewareOptionsTypeNone,
+    MSMiddlewareOptionsTypeAuth,
+    MSMiddlewareOptionsTypeRedirect,
+    MSMiddlewareOptionsTypeRetry
+};
+
 extern NSString *const MSGraphBaseURL;
 extern NSString *const MSHeaderSdkVersion;
 extern NSString *const MSGraphiOSSdkVersionHeaderPrefix;
@@ -53,9 +62,12 @@ extern NSString *const MSErrorDomain;
 extern NSString *const MSErrorTooManyRedirectsFormatString;
 extern NSString *const MSErrorLocationHeaderNotFoundString;
 extern NSString *const MSErrorOperationUnsuccessfulString;
+extern NSString *const MSErrorMaxRedirectsLimitExceededString;
 
 extern NSString *const MSErrorTooManyRetries;
 extern NSString *const MSErrorTooManyRetriesFormatString;
+extern NSString *const MSErrorDelayLimitExceededString;
+extern NSString *const MSErrorMaxRetriesLimitExceededString;
 
 extern NSString *const HTTPMethodGet;
 extern NSString *const HTTPMethodPut;

MSGraphClientSDK/MSGraphClientSDK/Common/MSConstants.m

@@ -11,15 +11,16 @@
 
 
 NSString *const MSErrorDomain = @"com.microsoft.graph.errors";
-
 NSString *const MSErrorTooManyRedirectsFormatString = @"More than %ld redirects encountered while sending the request.";
-
 NSString *const MSErrorLocationHeaderNotFoundString = @"There is no location header in the redirect response.";
 NSString *const MSErrorOperationUnsuccessfulString = @"Operation was unsuccessful.";
+NSString *const MSErrorMaxRedirectsLimitExceededString = @"Limit for maximum redirects allowed is %ld.";
 
-NSString *const MSErrorTooManyRetries = @"Too many retries";
 
+NSString *const MSErrorTooManyRetries = @"Too many retries";
 NSString *const MSErrorTooManyRetriesFormatString = @"More than %ld retries encountered while sending the request.";
+NSString *const MSErrorDelayLimitExceededString = @"Limit for maximum delay allowed is %ld.";
+NSString *const MSErrorMaxRetriesLimitExceededString = @"Limit for maximum retries allowed is %ld";
 
 
  NSString *const HTTPMethodGet = @"GET";

MSGraphClientSDK/MSGraphClientSDK/Common/Session Tasks/MSURLSessionTask.h

@@ -6,6 +6,7 @@
 
 #import <Foundation/Foundation.h>
 #import "MSHttpProvider.h"
+#import "MSMiddlewareOptions.h"
 
 /**
  The Upload Completion Handler to be called when an upload is completed.
@@ -35,6 +36,11 @@ typedef void (^HTTPRequestCompletionHandler)(id data, NSURLResponse * _Nullable
  */
 @property (strong) MSHTTPClient *client;
 
+/*
+ This property can be used to set an array of custom middleware options specific for the execution of the Task.
+ */
+@property (nonatomic, strong) NSArray<MSMiddlewareOptions> *middlewareOptionsArray;
+
 /**
  Creates an `MSURLSessionTask` with the given requests and client.
  @param request The request to use. Must not be nil.
@@ -53,4 +59,11 @@ typedef void (^HTTPRequestCompletionHandler)(id data, NSURLResponse * _Nullable
  */
 - (void)cancel;
 
+/*
+ This method can be used by to get a specific middleware matching with the type provided in argument.
+ @param middlewareOptionsType The type of middleware options that needs to be returned
+ @return An instance of middleware options if a match is found otherwise it will be nil.
+ */
+- (id<MSMiddlewareOptions>)getMiddlewareOptionWithType:(MSMiddlewareOptionsType)middlewareOptionsType;
+
 @end

MSGraphClientSDK/MSGraphClientSDK/Common/Session Tasks/MSURLSessionTask.m

@@ -83,4 +83,23 @@ - (void)taskCompletedWithData:(id)data response:(NSURLResponse *)response andErr
     NSAssert(NO, @"Not Implemented, must implement in sub class");
 }
 
+- (void)setMiddlewareOptionsArray:(NSArray<MSMiddlewareOptions> *)middlewareOptionsArray
+{
+    _middlewareOptionsArray = [middlewareOptionsArray copy];
+}
+
+- (id<MSMiddlewareOptions>)getMiddlewareOptionWithType:(MSMiddlewareOptionsType)middlewareOptionsType
+{
+    id<MSMiddlewareOptions> middlewareOptionsToReturn;
+    for(id<MSMiddlewareOptions> middlewareOptions in _middlewareOptionsArray)
+    {
+        if(middlewareOptionsType == middlewareOptions.middlewareOptionsType)
+        {
+            middlewareOptionsToReturn = middlewareOptions;
+            break;
+        }
+    }
+    return middlewareOptionsToReturn;
+}
+
 @end

MSGraphClientSDK/MSGraphClientSDK/MSGraphClientSDK.h

@@ -20,6 +20,7 @@ FOUNDATION_EXPORT const unsigned char MSGraphClientSDKVersionString[];
 #import "MSGraphClientSDK/MSAuthenticationProvider.h"
 #import "MSGraphClientSDK/MSHttpProvider.h"
 #import "MSGraphClientSDK/MSGraphMiddleware.h"
+#import "MSGraphClientSDK/MSMiddlewareOptions.h"
 
 #import "MSGraphClientSDK/MSURLSessionManager.h"
 #import "MSGraphClientSDK/MSClientFactory.h"
@@ -40,6 +41,9 @@ FOUNDATION_EXPORT const unsigned char MSGraphClientSDKVersionString[];
 #import "MSGraphClientSDK/MSBatchRequestContent.h"
 #import "MSGraphClientSDK/MSBatchResponseContent.h"
 
+#import "MSGraphClientSDK/MSRetryHandlerOptions.h"
+#import "MSGraphClientSDK/MSRedirectHandlerOptions.h"
+
 
 #endif
 

MSGraphClientSDK/MSGraphClientSDK/Middleware/Implementations/RedirectHandler/MSRedirectHandler.h

@@ -8,6 +8,15 @@
  This class provides the mechanism to handle redirect response from Graph server. It is implmented as a middleware so it will be called during the execution of network calls.
  */
 
+@class MSRedirectHandlerOptions;
+
 @interface MSRedirectHandler : NSObject<MSGraphMiddleware>
 
+/*
+ This method initializes an instance of MSRedirectHandler with the provided MSRedirectHandlerOptions value.
+@param redirectHandlerOptions The options which will be used to control the behavior of this instance
+ @return Instance of MSRedirectHandler
+ */
+- (instancetype)initWithOptions:(MSRedirectHandlerOptions *)redirectHandlerOptions;
+
 @end