Skip to content

Commit 02b46b5

Browse files
Copilotfadidurah
andauthored
Extract "clientdata" query parameter name to ClientDataInfo.CLIENTDATA_QUERY_PARAMETER constant
Agent-Logs-Url: https://github.com/AzureAD/microsoft-authentication-library-common-for-android/sessions/5872085e-2412-4653-a01e-bb21157f8983 Co-authored-by: fadidurah <88730756+fadidurah@users.noreply.github.com>
1 parent ecf1f84 commit 02b46b5

3 files changed

Lines changed: 10 additions & 2 deletions

File tree

common4j/src/main/com/microsoft/identity/common/java/providers/microsoft/microsoftsts/MicrosoftStsAuthorizationResultFactory.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ protected MicrosoftStsAuthorizationResult parseRedirectUriAndCreateAuthorization
7373

7474
final Map<String, String> urlParameters = UrlUtil.getParameters(redirectUri);
7575

76-
final ClientDataInfo clientDataInfo = ClientDataInfo.fromPipeDelimited(urlParameters.get("clientdata"));
76+
final ClientDataInfo clientDataInfo = ClientDataInfo.fromPipeDelimited(urlParameters.get(ClientDataInfo.CLIENTDATA_QUERY_PARAMETER));
7777
if (null != clientDataInfo) {
7878
clientDataInfo.emitToSpan();
7979
}

common4j/src/main/com/microsoft/identity/common/java/telemetry/ClientDataInfo.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,13 @@ public class ClientDataInfo {
4949
/** Maximum length for any individual field when emitting to a span. */
5050
private static final int MAX_FIELD_LENGTH = 256;
5151

52+
/**
53+
* The name of the {@code clientdata} query parameter added to /authorize redirect URIs
54+
* by eSTS/MSA when {@code clidata=1} is included in the authorization request.
55+
* Use this constant everywhere the parameter name is referenced to avoid typos.
56+
*/
57+
public static final String CLIENTDATA_QUERY_PARAMETER = "clientdata";
58+
5259
/** Account type value for MSA accounts. */
5360
private static final String ACCOUNT_TYPE_MSA_RAW = "m";
5461

common4j/src/test/com/microsoft/identity/common/java/providers/microsoft/microsoftsts/MicrosoftStsAuthorizationResultFactoryTest.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
import com.microsoft.identity.common.java.providers.oauth2.AuthorizationResult;
3333
import com.microsoft.identity.common.java.providers.oauth2.AuthorizationResultFactory;
3434
import com.microsoft.identity.common.java.providers.oauth2.AuthorizationStatus;
35+
import com.microsoft.identity.common.java.telemetry.ClientDataInfo;
3536

3637
import org.junit.Assert;
3738
import org.junit.Before;
@@ -295,7 +296,7 @@ public void testClientDataParam_attributesEmitted() {
295296
// Pipe-delimited format: account_type|error|sub_error|caller_data_boundary|cloud_instance
296297
final String redirectUrl = MOCK_REDIRECT_URI
297298
+ "?code=auth_code&state=" + MOCK_STATE_ENCODED
298-
+ "&clientdata=m%7CAADSTS50058%7Clogin_required%7Cus%7Cpublic";
299+
+ "&" + ClientDataInfo.CLIENTDATA_QUERY_PARAMETER + "=m%7CAADSTS50058%7Clogin_required%7Cus%7Cpublic";
299300

300301
final Span mockSpan = mock(Span.class);
301302
when(mockSpan.setAttribute(Mockito.anyString(), Mockito.anyString())).thenReturn(mockSpan);

0 commit comments

Comments
 (0)