Address PR and add UT

AzureAD · Aug 13, 2024 · 61af76a · 61af76a
1 parent 37d11e0
commit 61af76a
Show file tree

Hide file tree

Showing 7 changed files with 53 additions and 14 deletions.
diff --git a/...Identity.Web.TokenAcquisition/IdHelper.cs → ...soft.Identity.Web.Diagnostics/IdHelper.cs b/...Identity.Web.TokenAcquisition/IdHelper.cs → ...soft.Identity.Web.Diagnostics/IdHelper.cs
@@ -6,7 +6,7 @@
 using System.Reflection;
 using System.Text.RegularExpressions;
 
-namespace Microsoft.Identity.Web
+namespace Microsoft.Identity.Web.Diagnostics
 {
     internal static class IdHelper
     {
@@ -37,13 +37,13 @@ internal static class IdHelper
            });
 
         public static string GetIdWebVersion()
-        {             
+        {
             return s_idWebVersion.Value;
         }
 
         public static string CreateTelemetryInfo()
         {
-            return string.Format(CultureInfo.InvariantCulture, IDWebSku + s_idWebVersion.Value);
+            return string.Format(CultureInfo.InvariantCulture, IDWebSku + GetIdWebVersion());
         }
     }
 }
diff --git a/src/Microsoft.Identity.Web.DownstreamApi/DownstreamApi.cs b/src/Microsoft.Identity.Web.DownstreamApi/DownstreamApi.cs
@@ -16,6 +16,7 @@
 using Microsoft.Extensions.Options;
 using Microsoft.Identity.Abstractions;
 using Microsoft.Identity.Client;
+using Microsoft.Identity.Web.Diagnostics;
 
 namespace Microsoft.Identity.Web
 {
@@ -306,7 +307,6 @@ private async Task<HttpResponseMessage> CallApiInternalAsync(
         {
             // Downstream API URI
             string apiUrl = effectiveOptions.GetApiUrl();
-            AddCallerSDKTelemetry(effectiveOptions);
 
             // Create an HTTP request message
             using HttpRequestMessage httpRequestMessage = new(
@@ -340,14 +340,16 @@ private async Task<HttpResponseMessage> CallApiInternalAsync(
             return downstreamApiResult;
         }
 
-        internal async Task UpdateRequestAsync(
+        internal /* internal for test */ async Task UpdateRequestAsync(
             HttpRequestMessage httpRequestMessage,
             HttpContent? content,
             DownstreamApiOptions effectiveOptions,
             bool appToken,
             ClaimsPrincipal? user,
             CancellationToken cancellationToken)
         {
+            AddCallerSDKTelemetry(effectiveOptions);
+
             if (content != null)
             {
                 httpRequestMessage.Content = content;
@@ -379,8 +381,7 @@ internal async Task UpdateRequestAsync(
             effectiveOptions.CustomizeHttpRequestMessage?.Invoke(httpRequestMessage);
         }
 
-
-        private static readonly Dictionary<string, string> s_callerSDKDetails = new()
+        internal /* for test */ static Dictionary<string, string> CallerSDKDetails { get; } = new()
           {
               { "caller-sdk-id", "1" },  // 1 = Downstream API SDK ID
               { "caller-sdk-ver", IdHelper.GetIdWebVersion() }
@@ -390,14 +391,14 @@ private static void AddCallerSDKTelemetry(DownstreamApiOptions effectiveOptions)
         {
             if (effectiveOptions.AcquireTokenOptions.ExtraQueryParameters == null)
             {
-                effectiveOptions.AcquireTokenOptions.ExtraQueryParameters = s_callerSDKDetails;
+                effectiveOptions.AcquireTokenOptions.ExtraQueryParameters = CallerSDKDetails;
             }
             else
             {
                 effectiveOptions.AcquireTokenOptions.ExtraQueryParameters["caller-sdk-id"] =
-                    s_callerSDKDetails["caller-sdk-id"];
+                    CallerSDKDetails["caller-sdk-id"];
                 effectiveOptions.AcquireTokenOptions.ExtraQueryParameters["caller-sdk-ver"] =
-                    s_callerSDKDetails["caller-sdk-ver"];
+                    CallerSDKDetails["caller-sdk-ver"];
             }
         }
     }

diff --git a/src/Microsoft.Identity.Web.DownstreamApi/Microsoft.Identity.Web.DownstreamApi.csproj b/src/Microsoft.Identity.Web.DownstreamApi/Microsoft.Identity.Web.DownstreamApi.csproj
@@ -7,9 +7,6 @@
     <EnableConfigurationBindingGenerator>true</EnableConfigurationBindingGenerator>
     <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
-	<ItemGroup>
-		<Compile Include="..\Microsoft.Identity.Web.TokenAcquisition\IdHelper.cs" Link="IdHelper.cs" />
-	</ItemGroup>
   <ItemGroup>
     <None Include="..\..\README.md">
       <Pack>True</Pack>

diff --git a/src/Microsoft.Identity.Web.OWIN/AppBuilderExtension.cs b/src/Microsoft.Identity.Web.OWIN/AppBuilderExtension.cs
@@ -17,6 +17,7 @@
 using Microsoft.Owin.Security.Jwt;
 using Microsoft.Owin.Security.OAuth;
 using Microsoft.Owin.Security.OpenIdConnect;
+using Microsoft.Identity.Web.Diagnostics;
 using Owin;
 
 namespace Microsoft.Identity.Web

diff --git a/src/Microsoft.Identity.Web.TokenAcquisition/MsalAspNetCoreHttpClientFactory.cs b/src/Microsoft.Identity.Web.TokenAcquisition/MsalAspNetCoreHttpClientFactory.cs
@@ -3,6 +3,7 @@
 
 using System.Net.Http;
 using Microsoft.Identity.Client;
+using Microsoft.Identity.Web.Diagnostics;
 
 namespace Microsoft.Identity.Web
 {

diff --git a/...t.Identity.Web/WebAppExtensions/MicrosoftIdentityWebAppAuthenticationBuilderExtensions.cs b/...t.Identity.Web/WebAppExtensions/MicrosoftIdentityWebAppAuthenticationBuilderExtensions.cs
@@ -16,6 +16,7 @@
 using Microsoft.IdentityModel.Protocols.OpenIdConnect;
 using System.Linq;
 using System.Diagnostics.CodeAnalysis;
+using Microsoft.Identity.Web.Diagnostics;
 
 namespace Microsoft.Identity.Web
 {

diff --git a/tests/Microsoft.Identity.Web.Test/DownstreamWebApiSupport/DownstreamApiTests.cs b/tests/Microsoft.Identity.Web.Test/DownstreamWebApiSupport/DownstreamApiTests.cs
@@ -48,14 +48,51 @@ public async Task UpdateRequestAsync_WithContent_AddsContentToRequest()
             // Arrange
             var httpRequestMessage = new HttpRequestMessage(HttpMethod.Post, "https://example.com");
             var content = new StringContent("test content");
+            var options = new DownstreamApiOptions();
 
             // Act
-            await _input.UpdateRequestAsync(httpRequestMessage, content, new DownstreamApiOptions(), false, null, CancellationToken.None);
+            await _input.UpdateRequestAsync(httpRequestMessage, content, options, false, null, CancellationToken.None);
 
             // Assert
             Assert.Equal(content, httpRequestMessage.Content);
             Assert.Equal("application/json", httpRequestMessage.Headers.Accept.Single().MediaType);
             Assert.Equal("text/plain", httpRequestMessage.Content?.Headers.ContentType?.MediaType);
+            Assert.Equal(options.AcquireTokenOptions.ExtraQueryParameters, DownstreamApi.CallerSDKDetails);
+        }
+
+
+        [Fact]
+        public async Task UpdateRequestAsync_AddsToExtraQP()
+        {
+            // Arrange
+            var httpRequestMessage = new HttpRequestMessage(HttpMethod.Post, "https://example.com");
+            var content = new StringContent("test content");
+            var options = new DownstreamApiOptions() {  
+                AcquireTokenOptions = new AcquireTokenOptions() { 
+                    ExtraQueryParameters = new Dictionary<string, string>() 
+                    { 
+                        { "n1", "v1" },
+                        { "n2", "v2" },
+                        { "caller-sdk-id", "bogus" } // value will be overwritten by the SDK
+                    }
+                } };
+
+            // Act
+            await _input.UpdateRequestAsync(httpRequestMessage, content, options, false, null, CancellationToken.None);
+
+            // Assert
+            Assert.Equal(content, httpRequestMessage.Content);
+            Assert.Equal("application/json", httpRequestMessage.Headers.Accept.Single().MediaType);
+            Assert.Equal("text/plain", httpRequestMessage.Content?.Headers.ContentType?.MediaType);
+            Assert.Equal("v1", options.AcquireTokenOptions.ExtraQueryParameters["n1"]);
+            Assert.Equal("v2", options.AcquireTokenOptions.ExtraQueryParameters["n2"]);
+            Assert.Equal(
+                DownstreamApi.CallerSDKDetails["caller-sdk-id"], 
+                options.AcquireTokenOptions.ExtraQueryParameters["caller-sdk-id"] );
+            Assert.Equal(
+                DownstreamApi.CallerSDKDetails["caller-sdk-ver"],
+                options.AcquireTokenOptions.ExtraQueryParameters["caller-sdk-ver"]);
+
         }
 
         [Theory]
@@ -82,6 +119,7 @@ public async Task UpdateRequestAsync_WithScopes_AddsAuthorizationHeaderToRequest
             Assert.Equal("ey", httpRequestMessage.Headers.Authorization?.Parameter);
             Assert.Equal("Bearer", httpRequestMessage.Headers.Authorization?.Scheme);
             Assert.Equal("application/json", httpRequestMessage.Headers.Accept.Single().MediaType);
+            Assert.Equal(options.AcquireTokenOptions.ExtraQueryParameters, DownstreamApi.CallerSDKDetails);
         }
 
         [Fact]