[Feature Request] Expose CorrelationId from MsalException

[KurzyukovAndrey]

Problem
We need to meter CorrelationId in case of acquiring a token. However, we cannot retrieve CorrelationId from MsalException.

Use case
The simplified code of usage is shown below:

public async Task<AuthenticationResult> AcquireTokenForClientAsync(
	IEnumerable<string> scopes, 
	Action<AcquireTokenForClientParameterBuilder>? configuration, 
	CancellationToken cancellationToken)
{
	var acquireTokenBuilder = _confidentialClientApplication.AcquireTokenForClient(scopes);

	// WithCorrelationId might be called here.
	configuration?.Invoke(acquireTokenBuilder);

	try
	{
		var authenticationResult = await acquireTokenBuilder
			.ExecuteAsync(cancellationToken)
			.ConfigureAwait(false);

		// authenticationResult exposes correlationId.
	}
	catch (MsalException ex)
	{
		// MsalException does not expose correlationId. 
		// Cannot use correlationId for metering.
	}
}

Our consumers call WithCorrelationId using configuration parameter. Then, we acquire a token. In case of success, we can retrieve CorrelationId from AuthenticationResult.CorrelationId. But we cannot retrieve it from MsalException.

Proposal
Expose CorrelationId for all exceptions.

Additional context
Based on Exceptions in MSAL.NET, there are 4 exceptions. MsalServiceException and MsalUiRequiredException expose CorrelationId, but the rest do not.

[trwalke]

Hi @KurzyukovAndrey, there shouldnt be any scenarios where we throw a MsalException it is a base class that the other exceptions derive from. You should rely on the correlation id in the MsalServiceException and MsalUiRequiredException since they can occur after a request is sent to the auth endpoint.
Also, typically the MsalClientException occurs in the client before a correlationd Id is sent to the endpoint so there would be no correlation id to look up in the telemetry anyway.

[KurzyukovAndrey]

Hi @trwalke, thank you for your response!

[KurzyukovAndrey]

Any updates about the progress/state?

[neha-bhargava]

Fixed in MSAL.Net 4.60.0 release