Add IAuthProviderOption to contain provider options

Author: peombwa

src/Microsoft.Graph.Core/Extensions/BaseRequestExtensions.cs

@@ -12,6 +12,7 @@ namespace Microsoft.Graph
     /// </summary>
     public static class BaseRequestExtensions
     {
+
         /// <summary>
         /// Sets the default authentication provider to the default Authentication Middleware Handler for this request.
         /// This only works with the default authentication handler.
@@ -34,53 +35,6 @@ internal static T WithDefaultAuthProvider<T>(this T baseRequest) where T : IBase
             return baseRequest;
         }
 
-        /// <summary>
-        /// Sets Microsoft Graph's scopes to the default Authentication Middleware Handler for this request in order to perform incremental conscent.
-        /// This only works with the default authentication handler and default set of Microsoft graph authentication providers.
-        /// If you use a custom authentication handler or authentication provider, you have to handle it's retreival in your implementation.
-        /// </summary>
-        /// <typeparam name="T"></typeparam>
-        /// <param name="baseRequest">The <see cref="BaseRequest"/> for the request.</param>
-        /// <param name="scopes">Scopes required to access a protected API.</param>
-        /// <returns></returns>
-        public static T WithScopes<T>(this T baseRequest, string[] scopes) where T : IBaseRequest
-        {
-            string authOptionKey = typeof(AuthOption).ToString();
-            if (baseRequest.MiddlewareOptions.ContainsKey(authOptionKey))
-            {
-                (baseRequest.MiddlewareOptions[authOptionKey] as AuthOption).Scopes = scopes;
-            }
-            else
-            {
-                baseRequest.MiddlewareOptions.Add(authOptionKey, new AuthOption { Scopes = scopes });
-            }
-            return baseRequest;
-        }
-
-        /// <summary>
-        /// Sets MSAL's ForceRefresh property to the default Authentication Middleware Handler for this request.
-        /// This only works with the default authentication handler and default set of Microsoft graph authentication providers.
-        /// If you use a custom authentication handler or authentication provider, you have to handle it's retreival in your implementation.
-        /// </summary>
-        /// <typeparam name="T"></typeparam>
-        /// <param name="baseRequest">The <see cref="BaseRequest"/> for the request.</param>
-        /// <param name="forceRefresh">If <c>true</c>, ignore any access token in the cache and attempt to acquire new access token
-        /// using the refresh token for the account if this one is available.</param>
-        /// <returns></returns>
-        public static T WithForceRefresh<T>(this T baseRequest, bool forceRefresh) where T : IBaseRequest
-        {
-            string authOptionKey = typeof(AuthOption).ToString();
-            if (baseRequest.MiddlewareOptions.ContainsKey(authOptionKey))
-            {
-                (baseRequest.MiddlewareOptions[authOptionKey] as AuthOption).ForceRefresh = forceRefresh;
-            }
-            else
-            {
-                baseRequest.MiddlewareOptions.Add(authOptionKey, new AuthOption { ForceRefresh = forceRefresh });
-            }
-            return baseRequest;
-        }
-
         /// <summary>
         /// Sets the PerRequestAuthProvider delegate handler to the default Authentication Middleware Handler to authenticate a single request.
         /// The PerRequestAuthProvider delegate handler must be set to the GraphServiceClient instance before using this extension method otherwise, it defaults to the default authentication provider.

src/Microsoft.Graph.Core/Requests/MiddlewareOptions/AuthOption.cs

@@ -10,25 +10,13 @@ namespace Microsoft.Graph
     public class AuthOption : IMiddlewareOption
     {
         /// <summary>
-        /// Constructs a new <see cref="AuthOption"/>
-        /// </summary>
-        public AuthOption()
-        {
-
-        }
-        /// <summary>
-        /// A Scopes property
-        /// </summary>
-        public string[] Scopes { get; set; }
-
-        /// <summary>
-        /// A ForceRefresh property
+        /// An Authentication Provider
         /// </summary>
-        public bool ForceRefresh { get; set; }
+        internal IAuthenticationProvider AuthenticationProvider { get; set; }
 
         /// <summary>
-        /// An Authentication Provider
+        /// An auth provider option property
         /// </summary>
-        internal IAuthenticationProvider AuthenticationProvider { get; set; }
+        public IAuthProviderOption AuthProviderOption { get; set; }
     }
 }

src/Microsoft.Graph.Core/Requests/MiddlewareOptions/IAuthProviderOption.cs

@@ -0,0 +1,18 @@
+// ------------------------------------------------------------------------------
+//  Copyright (c) Microsoft Corporation.  All Rights Reserved.  Licensed under the MIT License.  See License in the project root for license information.
+// ------------------------------------------------------------------------------
+
+namespace Microsoft.Graph
+{
+    /// <summary>
+    /// An interface used to pass auth provider options in a request.
+    /// Auth providers will be incharge of implementing this interface and providing <see cref="IBaseRequest"/> extensions to set it's values.
+    /// </summary>
+    public interface IAuthProviderOption
+    {
+        /// <summary>
+        /// Microsoft Graph scopes property.
+        /// </summary>
+        string[] Scopes { get; set; }
+    }
+}

tests/Microsoft.Graph.Core.Test/Extensions/BaseRequestExtensionsTests.cs

@@ -9,43 +9,6 @@ public class BaseRequestExtensionsTests: RequestTestBase
     {
         string requestUrl = "https://foo.bar";
 
-        [TestMethod]
-        public void WithScopes_ShouldAddScopesToAuthOption()
-        {
-            string[] scopes = new string[] { "foo.bar", "user.bar", "user.foo" };
-            var baseRequest = new BaseRequest(requestUrl, this.baseClient);
-            baseRequest.WithScopes(scopes);
-
-            Assert.IsInstanceOfType(baseRequest.GetHttpRequestMessage().Properties[typeof(GraphRequestContext).ToString()], typeof(GraphRequestContext), "Unexpected request context.");
-            Assert.AreSame(scopes, baseRequest.GetHttpRequestMessage().GetMiddlewareOption<AuthOption>().Scopes, "Unexpected scope value.");
-        }
-
-        [TestMethod]
-        public void WithScopes_ShouldOnlyAddScopesToExistingAuthOption()
-        {
-            string[] scopes = new string[] { "foo.bar", "user.bar", "user.foo" };
-            var baseRequest = new BaseRequest(requestUrl, this.baseClient);
-            baseRequest
-                .WithForceRefresh(false)
-                .WithScopes(scopes);
-
-            Assert.IsInstanceOfType(baseRequest.GetHttpRequestMessage().Properties[typeof(GraphRequestContext).ToString()], typeof(GraphRequestContext), "Unexpected request context.");
-            Assert.AreEqual(false, baseRequest.GetHttpRequestMessage().GetMiddlewareOption<AuthOption>().ForceRefresh, "Unexpected force refresh value.");
-            Assert.AreSame(scopes, baseRequest.GetHttpRequestMessage().GetMiddlewareOption<AuthOption>().Scopes, "Unexpected scope value.");
-        }
-
-        [TestMethod]
-        public void WithForceRefresh_ShouldAddForceRefreshToAuthOption()
-        {
-            string requestUrl = "https://foo.bar";
-            var request = new BaseRequest(requestUrl, this.baseClient);
-
-            request.WithForceRefresh(true);
-
-            Assert.IsInstanceOfType(request.GetHttpRequestMessage().Properties[typeof(GraphRequestContext).ToString()], typeof(GraphRequestContext), "Unexpected request context.");
-            Assert.IsTrue(request.GetHttpRequestMessage().GetMiddlewareOption<AuthOption>().ForceRefresh, "Unexpected force refresh value.");
-        }
-
         [TestMethod]
         public void WithShouldRetry_ShouldDelegateToRetryOption()
         {

tests/Microsoft.Graph.Core.Test/Extensions/HttpRequestMessageExtensionsTests.cs

@@ -76,18 +76,5 @@ public void GetRequestContext_ShouldReturnRequestContext()
 
             Assert.IsNotNull(httpRequestMessage.GetRequestContext(), "Unexpected request context");
         }
-
-        [TestMethod]
-        public void GetMiddlewareControl_ShouldReturnIMiddlewareControlObject()
-        {
-            string requestUrl = "https://localhost/v2";
-            var baseRequest = new BaseRequest(requestUrl, this.baseClient);
-            baseRequest.WithForceRefresh(true);
-
-            HttpRequestMessage httpRequestMessage = baseRequest.GetHttpRequestMessage();
-
-            Assert.IsNotNull(httpRequestMessage.GetMiddlewareOption<AuthOption>(), "Unexpected auth option");
-            Assert.IsTrue(httpRequestMessage.GetMiddlewareOption<AuthOption>().ForceRefresh, "Unexpected force refresh value");
-        }
     }
 }

tests/Microsoft.Graph.Core.Test/Requests/AuthenticationHandlerTests.cs

@@ -42,8 +42,6 @@ public void AuthHandler_AuthProviderConstructor()
                 Assert.IsNull(auth.InnerHandler, "Http message handler initialized");
                 Assert.IsNotNull(auth.AuthenticationProvider, "Authentication provider not initialized");
                 Assert.IsNotNull(auth.AuthOption, "Auth option not initialized");
-                Assert.IsFalse(auth.AuthOption.ForceRefresh, "Unexpected force refresh set"); // default is false
-                Assert.IsNull(auth.AuthOption.Scopes, "Unexpected scopes set"); // default is null
                 Assert.IsInstanceOfType(auth, typeof(AuthenticationHandler), "Unexpected authentication handler set");
             }
         }
@@ -56,8 +54,6 @@ public void AuthHandler_AuthProviderHttpMessageHandlerConstructor()
             Assert.AreEqual(authenticationHandler.InnerHandler, testHttpMessageHandler, "Unexpected http message handler set");
             Assert.AreEqual(authenticationHandler.AuthenticationProvider, mockAuthenticationProvider.Object, "Unexpected auhtentication provider set");
             Assert.IsNotNull(authenticationHandler.AuthOption, "Auth option not initialized");
-            Assert.IsFalse(authenticationHandler.AuthOption.ForceRefresh, "Unexpected force refresh set"); // default is false
-            Assert.IsNull(authenticationHandler.AuthOption.Scopes, "Unexpected scopes set"); // default is null
             Assert.IsInstanceOfType(authenticationHandler, typeof(AuthenticationHandler), "Unexpected authentication handler set");
         }
 
@@ -66,13 +62,11 @@ public void AuthHandler_AuthProviderAuthOptionConstructor()
         {
             var scopes = new string[] { "foo.bar" };
             using (AuthenticationHandler auth = new AuthenticationHandler(mockAuthenticationProvider.Object,
-                new AuthOption { ForceRefresh = true, Scopes = scopes }))
+                new AuthOption()))
             {
                 Assert.IsNull(auth.InnerHandler, "Http message handler initialized");
                 Assert.IsNotNull(auth.AuthenticationProvider, "Authentication provider not initialized");
                 Assert.IsNotNull(auth.AuthOption, "Auth option not initialized");
-                Assert.IsTrue(auth.AuthOption.ForceRefresh, "Unexpected force refresh set");
-                Assert.AreSame(scopes, auth.AuthOption.Scopes, "Unexpected scopes set");
                 Assert.IsInstanceOfType(auth, typeof(AuthenticationHandler), "Unexpected authentication handler set");
             }
         }

tests/Microsoft.Graph.DotnetCore.Core.Test/Extensions/BaseRequestExtensionsTests.cs

@@ -7,43 +7,6 @@ public class BaseRequestExtensionsTests: RequestTestBase
     {
         string requestUrl = "https://foo.bar";
 
-        [Fact]
-        public void WithScopes_ShouldAddScopesToAuthOption()
-        {
-            string[] scopes = new string[] { "foo.bar", "user.bar", "user.foo"};
-            var baseRequest = new BaseRequest(requestUrl, this.baseClient);
-            baseRequest.WithScopes(scopes);
-
-            Assert.IsType<GraphRequestContext>(baseRequest.GetHttpRequestMessage().Properties[typeof(GraphRequestContext).ToString()]);
-            Assert.Same(scopes, baseRequest.GetHttpRequestMessage().GetMiddlewareOption<AuthOption>().Scopes);
-        }
-
-        [Fact]
-        public void WithScopes_ShouldOnlyAddScopesToExistingAuthOption()
-        {
-            string[] scopes = new string[] { "foo.bar", "user.bar", "user.foo" };
-            var baseRequest = new BaseRequest(requestUrl, this.baseClient);
-            baseRequest
-                .WithForceRefresh(false)
-                .WithScopes(scopes);
-
-            Assert.IsType<GraphRequestContext>(baseRequest.GetHttpRequestMessage().Properties[typeof(GraphRequestContext).ToString()]);
-            Assert.Equal(false, baseRequest.GetHttpRequestMessage().GetMiddlewareOption<AuthOption>().ForceRefresh);
-            Assert.Same(scopes, baseRequest.GetHttpRequestMessage().GetMiddlewareOption<AuthOption>().Scopes);
-        }
-
-        [Fact]
-        public void WithForceRefresh_ShouldAddForceRefreshToAuthOption()
-        {
-            string requestUrl = "https://foo.bar";
-            var request = new BaseRequest(requestUrl, this.baseClient);
-
-            request.WithForceRefresh(true);
-
-            Assert.IsType<GraphRequestContext>(request.GetHttpRequestMessage().Properties[typeof(GraphRequestContext).ToString()]);
-            Assert.True(request.GetHttpRequestMessage().GetMiddlewareOption<AuthOption>().ForceRefresh);
-        }
-
         [Fact]
         public void WithShouldRetry_ShouldDelegateToRetryOption()
         {

tests/Microsoft.Graph.DotnetCore.Core.Test/Extensions/HttpRequestMessageExtensionsTests.cs

@@ -76,16 +76,14 @@ public void GetRequestContext_ShouldReturnRequestContext()
         }
 
         [Fact]
-        public void GetMiddlewareControl_ShouldReturnIMiddlewareControlObject()
+        public void GetMiddlewareControl_ShouldReturnIMiddlewareOptionObject()
         {
             string requestUrl = "https://localhost/v2";
             var baseRequest = new BaseRequest(requestUrl, this.baseClient);
-            baseRequest.WithForceRefresh(true);
 
             HttpRequestMessage httpRequestMessage = baseRequest.GetHttpRequestMessage();
 
             Assert.NotNull(httpRequestMessage.GetMiddlewareOption<AuthOption>());
-            Assert.True(httpRequestMessage.GetMiddlewareOption<AuthOption>().ForceRefresh);
         }
     }
 }

tests/Microsoft.Graph.DotnetCore.Core.Test/Requests/AuthenticationHandlerTests.cs

@@ -40,8 +40,6 @@ public void AuthHandler_AuthProviderConstructor()
                 Assert.Null(auth.InnerHandler);
                 Assert.NotNull(auth.AuthenticationProvider);
                 Assert.NotNull(auth.AuthOption);
-                Assert.False(auth.AuthOption.ForceRefresh); // default is false
-                Assert.Null(auth.AuthOption.Scopes); // default is null
                 Assert.IsType(typeof(AuthenticationHandler), auth);
             }
         }
@@ -52,8 +50,6 @@ public void AuthHandler_AuthProviderHttpMessageHandlerConstructor()
             Assert.NotNull(authenticationHandler.InnerHandler);
             Assert.NotNull(authenticationHandler.AuthenticationProvider);
             Assert.NotNull(authenticationHandler.AuthOption);
-            Assert.False(authenticationHandler.AuthOption.ForceRefresh); // default is false
-            Assert.Null(authenticationHandler.AuthOption.Scopes); // default is null
             Assert.IsType(typeof(AuthenticationHandler), authenticationHandler);
         }
 
@@ -62,13 +58,11 @@ public void AuthHandler_AuthProviderAuthOptionConstructor()
         {
             var scopes = new string[] { "foo.bar" };
             using (AuthenticationHandler auth = new AuthenticationHandler(mockAuthenticationProvider.Object,
-                new AuthOption { ForceRefresh = true, Scopes = scopes}))
+                new AuthOption()))
             {
                 Assert.Null(auth.InnerHandler);
                 Assert.NotNull(auth.AuthenticationProvider);
                 Assert.NotNull(auth.AuthOption);
-                Assert.True(auth.AuthOption.ForceRefresh);
-                Assert.Same(scopes, auth.AuthOption.Scopes);
                 Assert.IsType(typeof(AuthenticationHandler), auth);
             }
         }