Refactor TokenCredential.Create (Azure#23927)

* Refactor TokenCredential.Create

Author: christothes

sdk/core/Azure.Core/CHANGELOG.md

@@ -4,7 +4,7 @@
 
 ### Features Added
 
-- Added `TokenCredential.Create` static method, which returns an instance of `TokenCredential` that uses the supplied delgates to produce an `AccessToken`. This would most typically be used when an token has previously been obtained from some other source and that token needs to be returned by a `TokenCredential` instance.
+- Added the static `DelegatedTokenCredential` type with a `Create` method, which returns an instance of `TokenCredential` that uses the supplied delgates to produce an `AccessToken`. This would most typically be used when an token has previously been obtained from some other source and that token needs to be returned by a `TokenCredential` instance.
 
 ### Breaking Changes
 

sdk/core/Azure.Core/api/Azure.Core.net461.cs

@@ -262,6 +262,11 @@ public void AddPolicy(Azure.Core.Pipeline.HttpPipelinePolicy policy, Azure.Core.
         [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public override string? ToString() { throw null; }
     }
+    public static partial class DelegatedTokenCredential
+    {
+        public static Azure.Core.TokenCredential Create(System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, Azure.Core.AccessToken> getToken) { throw null; }
+        public static Azure.Core.TokenCredential Create(System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, Azure.Core.AccessToken> getToken, System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask<Azure.Core.AccessToken>> getTokenAsync) { throw null; }
+    }
     public partial class DiagnosticsOptions
     {
         internal DiagnosticsOptions() { }
@@ -471,9 +476,6 @@ internal RetryOptions() { }
     public abstract partial class TokenCredential
     {
         protected TokenCredential() { }
-        public static Azure.Core.TokenCredential Create(System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, Azure.Core.AccessToken> getToken) { throw null; }
-        public static Azure.Core.TokenCredential Create(System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, Azure.Core.AccessToken> getToken, System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask<Azure.Core.AccessToken>> getTokenAsync) { throw null; }
-        public static Azure.Core.TokenCredential Create(System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask<Azure.Core.AccessToken>> getTokenAsync) { throw null; }
         public abstract Azure.Core.AccessToken GetToken(Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken);
         public abstract System.Threading.Tasks.ValueTask<Azure.Core.AccessToken> GetTokenAsync(Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken);
     }

sdk/core/Azure.Core/api/Azure.Core.net5.0.cs

@@ -262,6 +262,11 @@ public void AddPolicy(Azure.Core.Pipeline.HttpPipelinePolicy policy, Azure.Core.
         [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public override string? ToString() { throw null; }
     }
+    public static partial class DelegatedTokenCredential
+    {
+        public static Azure.Core.TokenCredential Create(System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, Azure.Core.AccessToken> getToken) { throw null; }
+        public static Azure.Core.TokenCredential Create(System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, Azure.Core.AccessToken> getToken, System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask<Azure.Core.AccessToken>> getTokenAsync) { throw null; }
+    }
     public partial class DiagnosticsOptions
     {
         internal DiagnosticsOptions() { }
@@ -471,9 +476,6 @@ internal RetryOptions() { }
     public abstract partial class TokenCredential
     {
         protected TokenCredential() { }
-        public static Azure.Core.TokenCredential Create(System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, Azure.Core.AccessToken> getToken) { throw null; }
-        public static Azure.Core.TokenCredential Create(System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, Azure.Core.AccessToken> getToken, System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask<Azure.Core.AccessToken>> getTokenAsync) { throw null; }
-        public static Azure.Core.TokenCredential Create(System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask<Azure.Core.AccessToken>> getTokenAsync) { throw null; }
         public abstract Azure.Core.AccessToken GetToken(Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken);
         public abstract System.Threading.Tasks.ValueTask<Azure.Core.AccessToken> GetTokenAsync(Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken);
     }

sdk/core/Azure.Core/api/Azure.Core.netcoreapp2.1.cs

@@ -262,6 +262,11 @@ public void AddPolicy(Azure.Core.Pipeline.HttpPipelinePolicy policy, Azure.Core.
         [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public override string? ToString() { throw null; }
     }
+    public static partial class DelegatedTokenCredential
+    {
+        public static Azure.Core.TokenCredential Create(System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, Azure.Core.AccessToken> getToken) { throw null; }
+        public static Azure.Core.TokenCredential Create(System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, Azure.Core.AccessToken> getToken, System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask<Azure.Core.AccessToken>> getTokenAsync) { throw null; }
+    }
     public partial class DiagnosticsOptions
     {
         internal DiagnosticsOptions() { }
@@ -471,9 +476,6 @@ internal RetryOptions() { }
     public abstract partial class TokenCredential
     {
         protected TokenCredential() { }
-        public static Azure.Core.TokenCredential Create(System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, Azure.Core.AccessToken> getToken) { throw null; }
-        public static Azure.Core.TokenCredential Create(System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, Azure.Core.AccessToken> getToken, System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask<Azure.Core.AccessToken>> getTokenAsync) { throw null; }
-        public static Azure.Core.TokenCredential Create(System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask<Azure.Core.AccessToken>> getTokenAsync) { throw null; }
         public abstract Azure.Core.AccessToken GetToken(Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken);
         public abstract System.Threading.Tasks.ValueTask<Azure.Core.AccessToken> GetTokenAsync(Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken);
     }

sdk/core/Azure.Core/api/Azure.Core.netstandard2.0.cs

@@ -262,6 +262,11 @@ public void AddPolicy(Azure.Core.Pipeline.HttpPipelinePolicy policy, Azure.Core.
         [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public override string? ToString() { throw null; }
     }
+    public static partial class DelegatedTokenCredential
+    {
+        public static Azure.Core.TokenCredential Create(System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, Azure.Core.AccessToken> getToken) { throw null; }
+        public static Azure.Core.TokenCredential Create(System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, Azure.Core.AccessToken> getToken, System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask<Azure.Core.AccessToken>> getTokenAsync) { throw null; }
+    }
     public partial class DiagnosticsOptions
     {
         internal DiagnosticsOptions() { }
@@ -471,9 +476,6 @@ internal RetryOptions() { }
     public abstract partial class TokenCredential
     {
         protected TokenCredential() { }
-        public static Azure.Core.TokenCredential Create(System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, Azure.Core.AccessToken> getToken) { throw null; }
-        public static Azure.Core.TokenCredential Create(System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, Azure.Core.AccessToken> getToken, System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask<Azure.Core.AccessToken>> getTokenAsync) { throw null; }
-        public static Azure.Core.TokenCredential Create(System.Func<Azure.Core.TokenRequestContext, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask<Azure.Core.AccessToken>> getTokenAsync) { throw null; }
         public abstract Azure.Core.AccessToken GetToken(Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken);
         public abstract System.Threading.Tasks.ValueTask<Azure.Core.AccessToken> GetTokenAsync(Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken);
     }

sdk/core/Azure.Core/src/DelegatedTokenCredential.cs

@@ -0,0 +1,73 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+using Azure.Core.Pipeline;
+
+namespace Azure.Core
+{
+    /// <summary>
+    /// A factory for creating a delegated <see cref="TokenCredential"/> capable of providing an OAuth token.
+    /// </summary>
+    public static class DelegatedTokenCredential
+    {
+        /// <summary>
+        /// Creates a static <see cref="TokenCredential"/> that accepts delegates which will produce an <see cref="AccessToken"/>.
+        /// </summary>
+        /// <remarks>
+        /// Typically, the <see cref="TokenCredential"/> created by this method is for use when you have already obtained an <see cref="AccessToken"/>
+        /// from some other source and need a <see cref="TokenCredential"/> that will simply return that token. Because the static token can expire,
+        /// the delegates offer a mechanism to handle <see cref="AccessToken"/> renewal.
+        /// </remarks>
+        /// <param name="getToken">A delegate that returns an <see cref="AccessToken"/>.</param>
+        /// <param name="getTokenAsync">A delegate that returns a <see cref="ValueTask"/> of type <see cref="AccessToken"/>.</param>
+        /// <returns></returns>
+        public static TokenCredential Create(
+            Func<TokenRequestContext, CancellationToken, AccessToken> getToken,
+            Func<TokenRequestContext, CancellationToken, ValueTask<AccessToken>> getTokenAsync) => new StaticTokenCredential(getToken, getTokenAsync);
+
+        /// <summary>
+        /// Creates a static <see cref="TokenCredential"/> that accepts delegates which will produce an <see cref="AccessToken"/>.
+        /// </summary>
+        /// <remarks>
+        /// Typically, the <see cref="TokenCredential"/> created by this method is for use when you have already obtained an <see cref="AccessToken"/>
+        /// from some other source and need a <see cref="TokenCredential"/> that will simply return that token. Because the static token can expire,
+        /// the delegates offer a mechanism to handle <see cref="AccessToken"/> renewal.
+        /// </remarks>
+        /// <param name="getToken">A delegate that returns an <see cref="AccessToken"/>.</param>
+        /// <returns></returns>
+        public static TokenCredential Create(
+            Func<TokenRequestContext, CancellationToken, AccessToken> getToken) => new StaticTokenCredential(getToken);
+
+        private class StaticTokenCredential : TokenCredential
+        {
+            private readonly Func<TokenRequestContext, CancellationToken, AccessToken> _getToken;
+            private readonly Func<TokenRequestContext, CancellationToken, ValueTask<AccessToken>> _getTokenAsync;
+
+            internal StaticTokenCredential(
+                Func<TokenRequestContext, CancellationToken, AccessToken> getToken,
+                Func<TokenRequestContext, CancellationToken, ValueTask<AccessToken>> getTokenAsync)
+            {
+                _getToken = getToken;
+                _getTokenAsync = getTokenAsync;
+            }
+
+            internal StaticTokenCredential(
+                Func<TokenRequestContext, CancellationToken, AccessToken> getToken)
+            {
+                _getToken = getToken;
+                _getTokenAsync = (context, token) => new ValueTask<AccessToken>(_getToken(context, token));
+            }
+
+            /// <inheritdoc cref="GetTokenAsync"/>
+            public override ValueTask<AccessToken> GetTokenAsync(TokenRequestContext requestContext, CancellationToken cancellationToken) =>
+                _getTokenAsync(requestContext, cancellationToken);
+
+            /// <inheritdoc cref="GetToken"/>
+            public override AccessToken GetToken(TokenRequestContext requestContext, CancellationToken cancellationToken) =>
+                _getToken(requestContext, cancellationToken);
+        }
+    }
+}

sdk/core/Azure.Core/src/TokenCredential.cs

@@ -30,86 +30,5 @@ public abstract class TokenCredential
         /// <returns>A valid <see cref="AccessToken"/>.</returns>
         /// <remarks>Caching and management of the lifespan for the <see cref="AccessToken"/> is considered the responsibility of the caller: each call should request a fresh token being requested.</remarks>
         public abstract AccessToken GetToken(TokenRequestContext requestContext, CancellationToken cancellationToken);
-
-        /// <summary>
-        /// Creates a static <see cref="TokenCredential"/> that accepts delegates which will produce an <see cref="AccessToken"/>.
-        /// </summary>
-        /// <remarks>
-        /// Typically, the <see cref="TokenCredential"/> created by this method is for use when you have already obtained an <see cref="AccessToken"/>
-        /// from some other source and need a <see cref="TokenCredential"/> that will simply return that token. Because the static token can expire,
-        /// the delegates offer a mechanism to handle <see cref="AccessToken"/> renewal.
-        /// </remarks>
-        /// <param name="getToken">A delegate that returns an <see cref="AccessToken"/>.</param>
-        /// <param name="getTokenAsync">A delegate that returns a <see cref="ValueTask"/> of type <see cref="AccessToken"/>.</param>
-        /// <returns></returns>
-        public static TokenCredential Create(
-            Func<TokenRequestContext, CancellationToken, AccessToken> getToken,
-            Func<TokenRequestContext, CancellationToken, ValueTask<AccessToken>> getTokenAsync) => new StaticTokenCredential(getToken, getTokenAsync);
-
-        /// <summary>
-        /// Creates a static <see cref="TokenCredential"/> that accepts delegates which will produce an <see cref="AccessToken"/>.
-        /// </summary>
-        /// <remarks>
-        /// Typically, the <see cref="TokenCredential"/> created by this method is for use when you have already obtained an <see cref="AccessToken"/>
-        /// from some other source and need a <see cref="TokenCredential"/> that will simply return that token. Because the static token can expire,
-        /// the delegates offer a mechanism to handle <see cref="AccessToken"/> renewal.
-        /// </remarks>
-        /// <param name="getToken">A delegate that returns an <see cref="AccessToken"/>.</param>
-        /// <returns></returns>
-        public static TokenCredential Create(
-            Func<TokenRequestContext, CancellationToken, AccessToken> getToken) => new StaticTokenCredential(getToken);
-
-        /// <summary>
-        /// Creates a static <see cref="TokenCredential"/> that accepts delegates which will produce an <see cref="AccessToken"/>.
-        /// </summary>
-        /// <remarks>
-        /// Typically, the <see cref="TokenCredential"/> created by this method is for use when you have already obtained an <see cref="AccessToken"/>
-        /// from some other source and need a <see cref="TokenCredential"/> that will simply return that token. Because the static token can expire,
-        /// the delegates offer a mechanism to handle <see cref="AccessToken"/> renewal.
-        /// </remarks>
-        /// <param name="getTokenAsync">A delegate that returns a <see cref="ValueTask"/> of type <see cref="AccessToken"/>.
-        /// If <see cref="GetToken"/> is called, the provided delegate will be executed sync over async.</param>
-        /// <returns></returns>
-        public static TokenCredential Create(
-            Func<TokenRequestContext, CancellationToken, ValueTask<AccessToken>> getTokenAsync) => new StaticTokenCredential(getTokenAsync);
-
-        private class StaticTokenCredential : TokenCredential
-        {
-            private readonly Func<TokenRequestContext, CancellationToken, AccessToken> _getToken;
-            private readonly Func<TokenRequestContext, CancellationToken, ValueTask<AccessToken>> _getTokenAsync;
-
-            internal StaticTokenCredential(
-                Func<TokenRequestContext, CancellationToken, AccessToken> getToken,
-                Func<TokenRequestContext, CancellationToken, ValueTask<AccessToken>> getTokenAsync)
-            {
-                _getToken = getToken;
-                _getTokenAsync = getTokenAsync;
-            }
-
-            internal StaticTokenCredential(
-                Func<TokenRequestContext, CancellationToken, AccessToken> getToken)
-            {
-                _getToken = getToken;
-                _getTokenAsync = (context, token) => new ValueTask<AccessToken>(_getToken(context, token));
-            }
-
-            internal StaticTokenCredential(
-                Func<TokenRequestContext, CancellationToken, ValueTask<AccessToken>> getTokenAsync)
-            {
-                _getToken = (context, token) => getTokenAsync(context, token)
-#pragma warning disable AZC0102 // Do not use GetAwaiter().GetResult(). Use the TaskExtensions.EnsureCompleted() extension method instead.
-                        .GetAwaiter().GetResult();
-#pragma warning restore AZC0102 // Do not use GetAwaiter().GetResult(). Use the TaskExtensions.EnsureCompleted() extension method instead.
-                _getTokenAsync = getTokenAsync;
-            }
-
-            /// <inheritdoc cref="GetTokenAsync"/>
-            public override ValueTask<AccessToken> GetTokenAsync(TokenRequestContext requestContext, CancellationToken cancellationToken) =>
-                _getTokenAsync(requestContext, cancellationToken);
-
-            /// <inheritdoc cref="GetToken"/>
-            public override AccessToken GetToken(TokenRequestContext requestContext, CancellationToken cancellationToken) =>
-                _getToken(requestContext, cancellationToken);
-        }
     }
 }

…Core/tests/StaticTokenCredentialTests.cs …e/tests/DelegatedTokenCredentialTests.cssdk/core/Azure.Core/tests/StaticTokenCredentialTests.cs renamed to sdk/core/Azure.Core/tests/DelegatedTokenCredentialTests.cs sdk/core/Azure.Core/tests/StaticTokenCredentialTests.cs renamed to sdk/core/Azure.Core/tests/DelegatedTokenCredentialTests.cs

@@ -9,7 +9,7 @@
 
 namespace Azure.Core.Tests
 {
-    public class StaticTokenCredentialTests
+    public class DelegatedTokenCredentialTests
     {
         private static string[] scopes = { "https://default.mock.auth.scope/.default" };
         private static CancellationToken ctx = new CancellationTokenSource(TimeSpan.FromMinutes(5)).Token;
@@ -35,9 +35,8 @@ private static IEnumerable<object[]> Credentials()
                 await Task.Yield();
                 return staticToken;
             };
-            yield return new object[] { TokenCredential.Create(getTokenAsync) };
-            yield return new object[] { TokenCredential.Create(getToken) };
-            yield return new object[] { TokenCredential.Create(getToken, getTokenAsync) };
+            yield return new object[] { DelegatedTokenCredential.Create(getToken) };
+            yield return new object[] { DelegatedTokenCredential.Create(getToken, getTokenAsync) };
         }
 
         [TestCaseSource(nameof(Credentials))]