Updating extension telemetry (#4996)

* Updating extension telemetry

* Refactroing
Removing TokenType and replacing the values with string

* Updating PR to revert new histogram logic.

* TODO

* Refactoring.
Addressing Feedback

* Apply suggestions from code review

Co-authored-by: Gladwin Johnson <[email protected]>

* Addressing PR Feedback

* Update

* Resolving test issues

* Removing External

* update

* Updating WAM header

* Resolving WAM test issues

* Fixing test

---------

Co-authored-by: trwalke <[email protected]>
Co-authored-by: Gladwin Johnson <[email protected]>

Author: 3 people

src/client/Microsoft.Identity.Client.Broker/WamAdapters.cs

@@ -362,7 +362,11 @@ private static MsalTokenResponse ParseRuntimeResponse(
                     Scope = authResult.GrantedScopes,
                     ExpiresIn = (long)(DateTime.SpecifyKind(authResult.ExpiresOn, DateTimeKind.Utc) - DateTimeOffset.UtcNow).TotalSeconds,
                     ClientInfo = authResult.Account.ClientInfo,
-                    TokenType = authResult.IsPopAuthorization ? Constants.PoPAuthHeaderPrefix: authenticationRequestParameters.RequestContext.ApiEvent.TokenType.ToString(),
+                    TokenType = authResult.IsPopAuthorization ? 
+                                                                Constants.PoPAuthHeaderPrefix :
+                                                                (authenticationRequestParameters.AuthenticationScheme.AccessTokenType == "ssh-cert" ?
+                                                                    Constants.SshCertAuthHeaderPrefix :
+                                                                    authenticationRequestParameters.AuthenticationScheme.AuthorizationHeaderPrefix),
                     WamAccountId = authResult.Account.AccountId,
                     TokenSource = TokenSource.Broker
                 };

src/client/Microsoft.Identity.Client/AuthScheme/Bearer/BearerAuthenticationOperation.cs

@@ -3,6 +3,7 @@
 
 using System.Collections.Generic;
 using Microsoft.Identity.Client.Cache.Items;
+using Microsoft.Identity.Client.Internal;
 using Microsoft.Identity.Client.Utils;
 
 namespace Microsoft.Identity.Client.AuthScheme.Bearer
@@ -11,7 +12,7 @@ internal class BearerAuthenticationOperation : IAuthenticationOperation
     {
         internal const string BearerTokenType = "bearer";
 
-        public int TelemetryTokenType => (int)TokenType.Bearer;
+        public int TelemetryTokenType => TelemetryTokenTypeConstants.Bearer;
 
         public string AuthorizationHeaderPrefix => "Bearer";
 

src/client/Microsoft.Identity.Client/AuthScheme/IAuthenticationOperation.cs

@@ -38,7 +38,7 @@ public interface IAuthenticationOperation
         string AuthorizationHeaderPrefix { get; }
 
         /// <summary>
-        /// Extra parameters that are added to the request to the /token endpoint. 
+        /// Extra parameters that are added to the request to the /token endpoint.
         /// </summary>
         /// <returns>Name and values of params</returns>
         IReadOnlyDictionary<string, string> GetTokenRequestParams();

src/client/Microsoft.Identity.Client/AuthScheme/PoP/PopAuthenticationOperation.cs

@@ -48,7 +48,7 @@ public PopAuthenticationOperation(PoPAuthenticationConfiguration popAuthenticati
             KeyId = Base64UrlHelpers.Encode(keyThumbprint);
         }
 
-        public int TelemetryTokenType => (int)TokenType.Pop;
+        public int TelemetryTokenType => TelemetryTokenTypeConstants.Pop;
 
         public string AuthorizationHeaderPrefix => Constants.PoPAuthHeaderPrefix;
 

src/client/Microsoft.Identity.Client/AuthScheme/PoP/PopBrokerAuthenticationOperation.cs

@@ -17,7 +17,7 @@ namespace Microsoft.Identity.Client.AuthScheme.PoP
     //This is because tokens are cached in the broker instead so MSAL will rely on the broker's cache for silent requests.
     internal class PopBrokerAuthenticationOperation : IAuthenticationOperation
     {
-        public int TelemetryTokenType => (int)TokenType.Pop;
+        public int TelemetryTokenType => TelemetryTokenTypeConstants.Pop;
 
         public string AuthorizationHeaderPrefix => Constants.PoPAuthHeaderPrefix;
 

src/client/Microsoft.Identity.Client/AuthScheme/SSHCertificates/SSHCertAuthenticationOperation.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using Microsoft.Identity.Client.Cache.Items;
+using Microsoft.Identity.Client.Internal;
 using Microsoft.Identity.Client.OAuth2;
 
 namespace Microsoft.Identity.Client.AuthScheme.SSHCertificates
@@ -29,7 +30,7 @@ public SSHCertAuthenticationOperation(string keyId, string jwk)
             _jwk = jwk;
         }
 
-        public int TelemetryTokenType => (int)TokenType.SshCert;
+        public int TelemetryTokenType => TelemetryTokenTypeConstants.SshCert;
 
         public string AuthorizationHeaderPrefix =>
             throw new MsalClientException(

src/client/Microsoft.Identity.Client/AuthScheme/TokenType.cs

@@ -196,10 +196,8 @@ internal AuthenticationResult(
                 authenticationScheme.FormatResult(this);
             });
 
-            if (authenticationScheme.TelemetryTokenType == 5)
-            {
-                AuthenticationResultMetadata.DurationCreatingExtendedTokenInUs = measuredResultDuration.Microseconds;
-            }
+            AuthenticationResultMetadata.DurationCreatingExtendedTokenInUs = measuredResultDuration.Microseconds;
+            AuthenticationResultMetadata.TelemetryTokenType = authenticationScheme.TelemetryTokenType;
         }
 
         //Default constructor for testing

src/client/Microsoft.Identity.Client/AuthenticationResult.cs

@@ -77,6 +77,12 @@ public AuthenticationResultMetadata(TokenSource tokenSource)
         /// </summary>
         public RegionDetails RegionDetails { get; set; }
 
+        /// <summary>
+        /// Represents the token type used for client telemetry only.
+        /// It is separate from the other token types as it is set locally rather than coming from the server.
+        /// </summary>
+        public int TelemetryTokenType { get; set; }
+
         /// <summary>
         /// Time, in microseconds, spent in the token creation of the extended token.
         /// </summary>

src/client/Microsoft.Identity.Client/AuthenticationResultMetadata.cs

@@ -4,6 +4,7 @@
 using System.Collections.Generic;
 using Microsoft.Identity.Client.AuthScheme;
 using Microsoft.Identity.Client.Cache.Items;
+using Microsoft.Identity.Client.Internal;
 using Microsoft.Identity.Client.Utils;
 
 namespace Microsoft.Identity.Client.Extensibility
@@ -19,7 +20,7 @@ public ExternalBoundTokenScheme(string keyId, string expectedTokenTypeFromEsts =
             _tokenType = expectedTokenTypeFromEsts;
         }
 
-        public int TelemetryTokenType => (int)TokenType.External;
+        public int TelemetryTokenType => TelemetryTokenTypeConstants.AtPop;
 
         public string AuthorizationHeaderPrefix => _tokenType;