Use ExtraQP to inject telemetry SDK ID

src/Microsoft.Identity.Web.TokenAcquisition/IdHelper.cs → src/Microsoft.Identity.Web.Diagnostics/IdHelper.cs

@@ -6,10 +6,12 @@
 using System.Reflection;
 using System.Text.RegularExpressions;
 
-namespace Microsoft.Identity.Web
+namespace Microsoft.Identity.Web.Diagnostics
 {
     internal static class IdHelper
     {
+        private const string IDWebSku = "IDWeb.";
+
         private static readonly Lazy<string> s_idWebVersion = new Lazy<string>(
            () =>
            {
@@ -34,9 +36,14 @@ internal static class IdHelper
                return version[1];
            });
 
+        public static string GetIdWebVersion()
+        {
+            return s_idWebVersion.Value;
+        }
+
         public static string CreateTelemetryInfo()
         {
-            return string.Format(CultureInfo.InvariantCulture, Constants.IDWebSku + s_idWebVersion.Value);
+            return string.Format(CultureInfo.InvariantCulture, IDWebSku + GetIdWebVersion());
         }
     }
 }

src/Microsoft.Identity.Web.Diagnostics/PublicAPI/net462/InternalAPI.Unshipped.txt

@@ -0,0 +1,3 @@
+Microsoft.Identity.Web.Diagnostics.IdHelper
+static Microsoft.Identity.Web.Diagnostics.IdHelper.CreateTelemetryInfo() -> string!
+static Microsoft.Identity.Web.Diagnostics.IdHelper.GetIdWebVersion() -> string!

src/Microsoft.Identity.Web.Diagnostics/PublicAPI/net472/InternalAPI.Unshipped.txt

@@ -0,0 +1,3 @@
+Microsoft.Identity.Web.Diagnostics.IdHelper
+static Microsoft.Identity.Web.Diagnostics.IdHelper.CreateTelemetryInfo() -> string!
+static Microsoft.Identity.Web.Diagnostics.IdHelper.GetIdWebVersion() -> string!

src/Microsoft.Identity.Web.Diagnostics/PublicAPI/net6.0/InternalAPI.Unshipped.txt

@@ -0,0 +1,3 @@
+Microsoft.Identity.Web.Diagnostics.IdHelper
+static Microsoft.Identity.Web.Diagnostics.IdHelper.CreateTelemetryInfo() -> string!
+static Microsoft.Identity.Web.Diagnostics.IdHelper.GetIdWebVersion() -> string!

src/Microsoft.Identity.Web.Diagnostics/PublicAPI/net7.0/InternalAPI.Unshipped.txt

@@ -0,0 +1,3 @@
+Microsoft.Identity.Web.Diagnostics.IdHelper
+static Microsoft.Identity.Web.Diagnostics.IdHelper.CreateTelemetryInfo() -> string!
+static Microsoft.Identity.Web.Diagnostics.IdHelper.GetIdWebVersion() -> string!

src/Microsoft.Identity.Web.Diagnostics/PublicAPI/net8.0/InternalAPI.Unshipped.txt

@@ -0,0 +1,3 @@
+Microsoft.Identity.Web.Diagnostics.IdHelper
+static Microsoft.Identity.Web.Diagnostics.IdHelper.CreateTelemetryInfo() -> string!
+static Microsoft.Identity.Web.Diagnostics.IdHelper.GetIdWebVersion() -> string!

src/Microsoft.Identity.Web.Diagnostics/PublicAPI/net9.0/InternalAPI.Unshipped.txt

@@ -0,0 +1,3 @@
+Microsoft.Identity.Web.Diagnostics.IdHelper
+static Microsoft.Identity.Web.Diagnostics.IdHelper.CreateTelemetryInfo() -> string!
+static Microsoft.Identity.Web.Diagnostics.IdHelper.GetIdWebVersion() -> string!

src/Microsoft.Identity.Web.Diagnostics/PublicAPI/netstandard2.0/InternalAPI.Unshipped.txt

@@ -0,0 +1,3 @@
+Microsoft.Identity.Web.Diagnostics.IdHelper
+static Microsoft.Identity.Web.Diagnostics.IdHelper.CreateTelemetryInfo() -> string!
+static Microsoft.Identity.Web.Diagnostics.IdHelper.GetIdWebVersion() -> string!

src/Microsoft.Identity.Web.DownstreamApi/PublicAPI/net462/InternalAPI.Unshipped.txt

@@ -1 +1 @@
-bn 
+static Microsoft.Identity.Web.DownstreamApi.CallerSDKDetails.get -> System.Collections.Generic.Dictionary<string!, string!>!

src/Microsoft.Identity.Web.DownstreamApi/PublicAPI/net472/InternalAPI.Unshipped.txt

@@ -0,0 +1 @@
+static Microsoft.Identity.Web.DownstreamApi.CallerSDKDetails.get -> System.Collections.Generic.Dictionary<string!, string!>!

src/Microsoft.Identity.Web.DownstreamApi/PublicAPI/net6.0/InternalAPI.Unshipped.txt

@@ -0,0 +1 @@
+static Microsoft.Identity.Web.DownstreamApi.CallerSDKDetails.get -> System.Collections.Generic.Dictionary<string!, string!>!

src/Microsoft.Identity.Web.DownstreamApi/PublicAPI/net7.0/InternalAPI.Unshipped.txt

@@ -0,0 +1 @@
+static Microsoft.Identity.Web.DownstreamApi.CallerSDKDetails.get -> System.Collections.Generic.Dictionary<string!, string!>!

src/Microsoft.Identity.Web.DownstreamApi/PublicAPI/net8.0/InternalAPI.Unshipped.txt

@@ -0,0 +1 @@
+static Microsoft.Identity.Web.DownstreamApi.CallerSDKDetails.get -> System.Collections.Generic.Dictionary<string!, string!>!

src/Microsoft.Identity.Web.DownstreamApi/PublicAPI/net9.0/InternalAPI.Unshipped.txt

@@ -0,0 +1 @@
+static Microsoft.Identity.Web.DownstreamApi.CallerSDKDetails.get -> System.Collections.Generic.Dictionary<string!, string!>!

src/Microsoft.Identity.Web.DownstreamApi/PublicAPI/netstandard2.0/InternalAPI.Unshipped.txt

@@ -0,0 +1 @@
+static Microsoft.Identity.Web.DownstreamApi.CallerSDKDetails.get -> System.Collections.Generic.Dictionary<string!, string!>!

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

src/Microsoft.Identity.Web.TokenAcquisition/Constants.cs

@@ -144,7 +144,6 @@ public static class Constants
 
         // Telemetry headers
         internal const string TelemetryHeaderKey = "x-client-brkrver";
-        internal const string IDWebSku = "IDWeb.";
 
         // Authorize for scopes attributes
         internal const string XReturnUrl = "x-ReturnUrl";

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
 {

src/Microsoft.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
 {

tests/Microsoft.Identity.Web.Test/DownstreamWebApiSupport/DownstreamApiTests.cs

@@ -49,14 +49,51 @@ public async Task UpdateRequestAsync_WithContent_AddsContentToRequestAsync()
             // 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]
@@ -83,6 +120,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]