Use parameter instead of config when initialization #2313

Yuki-YuXin · 2025-06-19T12:31:34Z

Context:
Deal with a comment under
#2305

github-actions · 2025-06-19T12:32:25Z

❌ Work item link check failed. Description does not contain AB#{ID}.

Click here to Learn more.

Copilot

Pull Request Overview

This PR refactors native authentication initialization to use a standalone NativeAuthConfigParameters object (with capabilities) instead of relying on the config file, and adds validation and serialization support for the new capabilities field.

Introduced capabilities in NativeAuthConfigParameters and made PublicClientApplication accept it.
Extended NativeAuthPublicClientApplicationConfiguration to parse, merge, serialize, and validate capabilities.
Updated tests (setupPCA calls) and added unit tests for missing, invalid, and correct capabilities.

Reviewed Changes

Copilot reviewed 33 out of 33 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
msal/src/test/java/.../NativeAuthPublicClientApplicationConfigurationTest.kt	Added tests for missing/invalid/case-insensitive capabilities
msal/src/test/java/.../NativeAuthOAuth2ConfigurationTest.kt	Passed `capabilities = null` into OAuth2 config
msal/src/test/java/.../SignUpEmailPasswordTest.kt	Updated `setupPCA` calls to include defaultCapabilities
msal/src/test/java/.../SignUpEmailPasswordAttributesTest.kt	Updated setup to include defaultCapabilities
msal/src/test/java/.../SignUpEmailOTPTest.kt	Updated `setupPCA` calls and removed old setup
msal/src/test/java/.../SignUpEmailOTPAttributesTest.kt	Updated setup to include defaultCapabilities
msal/src/test/java/.../SignInMFATest.kt	Passed defaultCapabilities to `setupPCA`
msal/src/test/java/.../SignInJITTest.kt	Passed defaultCapabilities and added JIT error test
msal/src/test/java/.../SignInEmailPasswordTest.kt	Passed defaultCapabilities to `setupPCA`
msal/src/test/java/.../SignInEmailOTPTest.kt	Added defaultCapabilities and updated setup
msal/src/test/java/.../SSPRTest.kt	Passed defaultCapabilities to `setupPCA`
msal/src/test/java/.../NativeAuthPublicClientApplicationAbstractTest.kt	Extended `setupPCA` signature to take capabilities
msal/src/test/java/.../GetTokenTests.kt	Updated setup to include defaultCapabilities
msal/src/main/java/.../SignUpStates.kt	Switched to use `redirectReason` in errors and separated cases
msal/src/main/java/.../SignInStates.kt	Switched to use `redirectReason` and separated cases
msal/src/main/java/.../ResetPasswordStates.kt	Switched to use `redirectReason` and separated cases
msal/src/main/java/.../MFAStates.kt	Switched to use `redirectReason` and separated cases
msal/src/main/java/.../JITStates.kt	Switched to use `redirectReason` and separated cases
msal/src/main/java/.../SignInErrors.kt	Made `SignInSubmitPasswordError` extend `BrowserRequiredError`
msal/src/main/java/.../ResetPasswordErrors.kt	Made `ResetPasswordSubmitPasswordError` extend `BrowserRequiredError`
msal/src/main/java/.../MFAErrors.kt	Made `MFASubmitChallengeError` extend `BrowserRequiredError`
msal/src/main/java/.../JITErrors.kt	Made JIT errors extend `BrowserRequiredError`
msal/src/main/java/.../GetAccessTokenError.kt	Made `GetAccessTokenError` extend `BrowserRequiredError`
msal/src/main/java/.../Error.kt	Made `ResendCodeError` extend `BrowserRequiredError`
msal/src/main/java/.../NativeAuthRegisterStrongAuthVerificationRequiredResultParameters.kt	Added missing copyright header
msal/src/main/java/.../NativeAuthConfigParameters.kt	New parameter class for native-auth init (includes capabilities)
msal/src/main/java/.../NativeAuthChallengeAuthMethodParameters.kt	Added missing copyright header
msal/src/main/java/.../NativeAuthPublicClientApplicationConfiguration.kt	Added `capabilities` field, serialization, merge, and validation
msal/src/main/java/.../CommandParametersAdapter.java	Propagated `capabilities` into command parameters
msal/src/main/java/.../MsalClientException.java	Defined invalid capability error code/message
msal/src/main/java/.../PublicClientApplicationConfiguration.java	Added import for ArrayList (no functional change)
msal/src/main/java/.../PublicClientApplication.java	Added overload to accept `NativeAuthConfigParameters` and handle capabilities
common	Updated submodule commit

Comments suppressed due to low confidence (1)

msal/src/main/java/com/microsoft/identity/nativeauth/NativeAuthPublicClientApplicationConfiguration.kt:207

The comment refers to capabilities but sits in validateChallengeTypes; it should read "Remove duplicate challenge types".

        // Remove duplicate capabilities

Copilot · 2025-06-19T12:33:44Z

...t/java/com/microsoft/identity/client/e2e/tests/network/nativeauth/SignUpEmailPasswordTest.kt

@@ -154,7 +155,7 @@ class SignUpEmailPasswordTest : NativeAuthPublicClientApplicationAbstractTest()
    @Test
    fun testSuccessOTPResend() {
        config = getConfig(defaultConfigType)
-        application = setupPCA(config, defaultChallengeTypes)
+        application = setupPCA(config, defaultChallengeTypes, defaultChallengeTypes)


The third argument should be defaultCapabilities instead of defaultChallengeTypes to pass the correct capabilities list.

Suggested change

application = setupPCA(config, defaultChallengeTypes, defaultChallengeTypes)

application = setupPCA(config, defaultChallengeTypes, defaultCapabilities)

Copilot · 2025-06-19T12:33:44Z

...t/java/com/microsoft/identity/client/e2e/tests/network/nativeauth/SignUpEmailPasswordTest.kt

@@ -242,7 +243,7 @@ class SignUpEmailPasswordTest : NativeAuthPublicClientApplicationAbstractTest()
    @Test
    fun testErrorInvalidPasswordFormat() {
        config = getConfig(defaultConfigType)
-        application = setupPCA(config, defaultChallengeTypes)
+        application = setupPCA(config, defaultChallengeTypes, defaultChallengeTypes)


This call mistakenly uses defaultChallengeTypes for both challenge types and capabilities; replace the last parameter with defaultCapabilities.

Suggested change

application = setupPCA(config, defaultChallengeTypes, defaultChallengeTypes)

application = setupPCA(config, defaultChallengeTypes, defaultCapabilities)

nilo-ms · 2025-06-19T13:26:47Z

msal/src/main/java/com/microsoft/identity/nativeauth/parameters/NativeAuthConfigParameters.kt

+package com.microsoft.identity.nativeauth.parameters
+
+
+class NativeAuthConfigParameters (


What about NativeAuthPublicClientApplicationParameters.
Better to mention the public client application and do not mention the word configuration. This is the parameters to create the native auth public client application, not the configuration

Done. And make the path under the nativeauth folder.

nilo-ms · 2025-06-19T13:27:03Z

msal/src/main/java/com/microsoft/identity/nativeauth/parameters/NativeAuthConfigParameters.kt

+    /**
+     * The authorityUrl to be used for the authority.
+     */
+    var authorityUrl: String,


can this be val?

nilo-ms · 2025-06-19T13:27:34Z

msal/src/main/java/com/microsoft/identity/nativeauth/parameters/NativeAuthConfigParameters.kt

+package com.microsoft.identity.nativeauth.parameters
+
+
+class NativeAuthConfigParameters (


Can you add the "public" keyword?

nilo-ms · 2025-06-19T13:28:52Z

msal/src/main/java/com/microsoft/identity/client/PublicClientApplication.java

@@ -991,17 +995,18 @@ public static INativeAuthPublicClientApplication createNativeAuthPublicClientApp
     */
    public static INativeAuthPublicClientApplication createNativeAuthPublicClientApplication(
            @NonNull final Context context,
-            @NonNull final NativeAuthPublicClientApplicationConfiguration config) throws MsalException {
+            @NonNull final NativeAuthConfigParameters configParameters) throws MsalException {


Similarly to other comments

Suggested change

@NonNull final NativeAuthConfigParameters configParameters) throws MsalException {

@NonNull final NativeAuthConfigParameters parameters) throws MsalException {

nilo-ms · 2025-06-19T13:53:06Z

msal/src/main/java/com/microsoft/identity/client/PublicClientApplication.java

        validateNonNullArgument(context, NONNULL_CONSTANTS.CONTEXT);
-        validateNonNullArgument(config, NONNULL_CONSTANTS.CONFIG);
+        validateNonNullArgument(parameters, NONNULL_CONSTANTS.CONFIG_PARAMETER);


Does this constant need to match with the name of the parameter that is "parameters" ?

Done. Name it as CLIENT_PARAMETER

Fixes [AB#{3287604}](https://dev.azure.com/IdentityDivision/Engineering/_workitems/edit/3287604) Related common PR: AzureAD/microsoft-authentication-library-common-for-android#2669 Native Auth Backward Compatibility feature includes: - [Add capabilities parameter to native auth public client application initialization, Fixes AB#3287412](6d55346) - [Handle redirect across all endpoints and return the redirect reason to the developers, Fixes AB#3288191](a121610) - [Use parameter instead of config when initialization](#2313) The main addition to this PR is the testing section

Yuki-YuXin added 4 commits June 19, 2025 12:52

Revert changes on PublicClientApplicationConfiguration.java

9b1c7ad

Add microsoft header

7bced75

Native Auth Config Parameters

b52c05a

Native Auth Config Parameters

3bc3c2e

Copilot AI review requested due to automatic review settings June 19, 2025 12:31

Yuki-YuXin requested review from a team as code owners June 19, 2025 12:31

Yuki-YuXin changed the base branch from dev to feature/backward-compatibility June 19, 2025 12:32

Copilot AI reviewed Jun 19, 2025

View reviewed changes

Address copilot comments

c8771bb

github-actions bot added the msal label Jun 19, 2025

Yuki-YuXin mentioned this pull request Jun 19, 2025

Native Auth Backward Compatibility feature, Fixes AB#3287604 #2305

Merged

nilo-ms reviewed Jun 19, 2025

View reviewed changes

Address comments

1041c2b

nilo-ms reviewed Jun 19, 2025

View reviewed changes

nilo-ms approved these changes Jun 19, 2025

View reviewed changes

Yuki-YuXin added 2 commits June 19, 2025 14:54

Address comments

fa7425e

Address comments

f6760a5

Yuki-YuXin merged commit 7d5d10a into feature/backward-compatibility Jun 19, 2025
7 of 14 checks passed

	application = setupPCA(config, defaultChallengeTypes, defaultChallengeTypes)
	application = setupPCA(config, defaultChallengeTypes, defaultCapabilities)

		package com.microsoft.identity.nativeauth.parameters


		class NativeAuthConfigParameters (

	@NonNull final NativeAuthConfigParameters configParameters) throws MsalException {
	@NonNull final NativeAuthConfigParameters parameters) throws MsalException {

Use parameter instead of config when initialization #2313

Use parameter instead of config when initialization #2313

Uh oh!

Conversation

Yuki-YuXin commented Jun 19, 2025

Uh oh!

github-actions bot commented Jun 19, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Yuki-YuXin Jun 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Yuki-YuXin Jun 19, 2025 •

edited

Loading