Add InvalidError for NativeAuth (#2297)

Corresponding PR in MSAL Repo :
AzureAD/microsoft-authentication-library-for-android#2020

common/src/main/java/com/microsoft/identity/common/nativeauth/internal/controllers/NativeAuthMsalController.kt

@@ -404,8 +404,8 @@ class NativeAuthMsalController : BaseNativeAuthController() {
                         errorDescription = signUpStartApiResult.errorDescription
                     )
                 }
-                is SignUpStartApiResult.InvalidEmail -> {
-                    SignUpCommandResult.InvalidEmail(
+                is SignUpStartApiResult.InvalidUsername -> {
+                    INativeAuthCommandResult.InvalidUsername(
                         error = signUpStartApiResult.error,
                         errorDescription = signUpStartApiResult.errorDescription
                     )

common/src/test/java/com/microsoft/identity/common/internal/providers/microsoft/nativeauth/integration/SignUpOAuth2StrategyTest.kt

@@ -206,7 +206,7 @@ class SignUpOAuth2StrategyTest {
         val signupResult = nativeAuthOAuth2Strategy.performSignUpStart(
             signUpStartCommandParameters
         )
-        assertTrue(signupResult is SignUpStartApiResult.InvalidEmail)
+        assertTrue(signupResult is SignUpStartApiResult.InvalidUsername)
     }
 
     @Test

common4j/src/main/com/microsoft/identity/common/java/nativeauth/controllers/results/INativeAuthCommandResult.kt

@@ -72,4 +72,14 @@ interface INativeAuthCommandResult {
         open val correlationId: String = DiagnosticContext.INSTANCE.threadCorrelationId,
         open val errorCodes: List<Int>? = null
     )
+
+    data class InvalidUsername(
+        override val error: String?,
+        override val errorDescription: String?,
+        override val details: List<Map<String, String>>? = null,
+        override val correlationId: String = DiagnosticContext.INSTANCE.threadCorrelationId,
+        override val errorCodes: List<Int>? = null,
+        val exception: Exception? = null
+    ) : Error(error, errorDescription, details, correlationId, errorCodes),
+        INativeAuthCommandResult, SignInStartCommandResult, SignUpStartCommandResult, SignUpSubmitPasswordCommandResult, ResetPasswordStartCommandResult
 }

common4j/src/main/com/microsoft/identity/common/java/nativeauth/controllers/results/SignUpCommandResult.kt

@@ -94,15 +94,6 @@ interface SignUpCommandResult {
         SignUpSubmitUserAttributesCommandResult,
         SignUpSubmitCodeCommandResult
 
-    /**
-     * The signup operation cannot progress as the provided email address is invalid.
-     */
-    data class InvalidEmail(
-        val error: String,
-        val errorDescription: String,
-        val correlationId: String = DiagnosticContext.INSTANCE.threadCorrelationId  //TODO: This initialisation will be removed as part of PBI https://identitydivision.visualstudio.com/Engineering/_workitems/edit/2710164
-    ) : SignUpStartCommandResult, SignUpSubmitPasswordCommandResult
-
     /**
      * The signup operation cannot progress as the provided password is not acceptable
      */

common4j/src/main/com/microsoft/identity/common/java/nativeauth/providers/requests/resetpassword/ResetPasswordStartRequest.kt

@@ -54,7 +54,6 @@ data class ResetPasswordStartRequest private constructor(
         ): ResetPasswordStartRequest {
             // Check for empty Strings and empty Maps
             ArgUtils.validateNonNullArg(clientId, "clientId")
-            ArgUtils.validateNonNullArg(username, "username")
             ArgUtils.validateNonNullArg(challengeType, "challengeType")
             ArgUtils.validateNonNullArg(requestUrl, "requestUrl")
             ArgUtils.validateNonNullArg(headers, "headers")

common4j/src/main/com/microsoft/identity/common/java/nativeauth/providers/requests/signin/SignInInitiateRequest.kt

@@ -53,7 +53,6 @@ data class SignInInitiateRequest private constructor(
             headers: Map<String, String?>
         ): SignInInitiateRequest {
             // Check for empty Strings and empty Maps
-            ArgUtils.validateNonNullArg(username, "username")
             ArgUtils.validateNonNullArg(clientId, "clientId")
             ArgUtils.validateNonNullArg(challengeType, "challengeType")
             ArgUtils.validateNonNullArg(requestUrl, "requestUrl")

common4j/src/main/com/microsoft/identity/common/java/nativeauth/providers/requests/signup/SignUpStartRequest.kt

@@ -57,7 +57,6 @@ data class SignUpStartRequest private constructor(
             headers: Map<String, String?>
         ): SignUpStartRequest {
             // Check for empty Strings and empty Maps
-            ArgUtils.validateNonNullArg(username, "username")
             ArgUtils.validateNonNullArg(clientId, "clientId")
             ArgUtils.validateNonNullArg(challengeType, "challengeType")
             ArgUtils.validateNonNullArg(requestUrl, "requestUrl")

common4j/src/main/com/microsoft/identity/common/java/nativeauth/providers/responses/signup/SignUpStartApiResponse.kt

@@ -29,8 +29,7 @@ import com.microsoft.identity.common.java.nativeauth.providers.IApiResponse
 import com.microsoft.identity.common.java.nativeauth.providers.responses.ApiErrorResult
 import com.microsoft.identity.common.java.nativeauth.util.isAttributeValidationFailed
 import com.microsoft.identity.common.java.nativeauth.util.isAuthNotSupported
-import com.microsoft.identity.common.java.nativeauth.util.isInvalidClient
-import com.microsoft.identity.common.java.nativeauth.util.isInvalidEmail
+import com.microsoft.identity.common.java.nativeauth.util.isInvalidUsername
 import com.microsoft.identity.common.java.nativeauth.util.isInvalidParameter
 import com.microsoft.identity.common.java.nativeauth.util.isPasswordBanned
 import com.microsoft.identity.common.java.nativeauth.util.isPasswordInvalid
@@ -41,7 +40,6 @@ import com.microsoft.identity.common.java.nativeauth.util.isPasswordTooWeak
 import com.microsoft.identity.common.java.nativeauth.util.isRedirect
 import com.microsoft.identity.common.java.nativeauth.util.isUnsupportedChallengeType
 import com.microsoft.identity.common.java.nativeauth.util.isUserAlreadyExists
-import com.microsoft.identity.common.java.nativeauth.util.isVerificationRequired
 import com.microsoft.identity.common.java.nativeauth.util.toAttributeList
 import java.net.HttpURLConnection
 
@@ -79,8 +77,8 @@ data class SignUpStartApiResponse(
                             errorDescription = errorDescription.orEmpty()
                         )
                     }
-                    errorCodes?.get(0).isInvalidParameter() and (errorDescription?.isInvalidEmail() == true) -> {
-                        SignUpStartApiResult.InvalidEmail(
+                    errorCodes?.get(0).isInvalidParameter() and (errorDescription?.isInvalidUsername() == true) -> {
+                        SignUpStartApiResult.InvalidUsername(
                             error = error.orEmpty(),
                             errorDescription = errorDescription.orEmpty()
                         )

common4j/src/main/com/microsoft/identity/common/java/nativeauth/providers/responses/signup/SignUpStartApiResult.kt

@@ -105,7 +105,7 @@ sealed interface SignUpStartApiResult {
     /**
      * Signup start operation was started for a malformed email address.
      */
-    data class InvalidEmail(
+    data class InvalidUsername(
         override val error: String,
         override val errorDescription: String
     ): ApiErrorResult(

common4j/src/main/com/microsoft/identity/common/java/nativeauth/util/ApiErrorResponseUtil.kt

@@ -110,7 +110,7 @@ internal fun String?.isVerificationRequired(): Boolean {
     return this.contentEquals(other = "verification_required", ignoreCase = true)
 }
 
-internal fun String?.isInvalidEmail(): Boolean {
+internal fun String?.isInvalidUsername(): Boolean {
     return (this?.contains(other = "username parameter is empty or not valid", ignoreCase = true) == true )
 }
 

common4j/src/test/com/microsoft/identity/common/java/nativeauth/providers/NativeAuthRequestHandlerTest.kt

@@ -95,8 +95,8 @@ class NativeAuthRequestHandlerTest {
         )
 
     // signup start tests
-    @Test(expected = ClientException::class)
-    fun testSignUpStartWithEmptyUsernameShouldThrowException() {
+    @Test
+    fun testSignUpStartWithEmptyUsernameShouldNotThrowException() {
         val commandParameters = SignUpStartCommandParameters.builder()
             .platformComponents(mock<PlatformComponents>())
             .username(emptyString)
@@ -334,8 +334,8 @@ class NativeAuthRequestHandlerTest {
     }
 
     // signin tests
-    @Test(expected = ClientException::class)
-    fun testSignInInitiateWithEmptyUsernameShouldThrowException() {
+    @Test
+    fun testSignInInitiateWithEmptyUsernameShouldNotThrowException() {
         val commandParameters = SignInStartCommandParameters.builder()
             .platformComponents(mock<PlatformComponents>())
             .username(emptyString)
@@ -457,8 +457,8 @@ class NativeAuthRequestHandlerTest {
         )
     }
 
-    @Test(expected = ClientException::class)
-    fun testSignInInitiateWithPasswordCommandParametersWithEmptyUsernameShouldThrowException() {
+    @Test
+    fun testSignInInitiateWithPasswordCommandParametersWithEmptyUsernameShouldNotThrowException() {
         val commandParameters = SignInStartCommandParameters.builder()
             .platformComponents(mock<PlatformComponents>())
             .username(emptyString)
@@ -605,8 +605,8 @@ class NativeAuthRequestHandlerTest {
     }
 
     // sspr start tests
-    @Test(expected = ClientException::class)
-    fun testResetPasswordStartWithEmptyUsernameShouldThrowException() {
+    @Test
+    fun testResetPasswordStartWithEmptyUsernameShouldNotThrowException() {
         val commandParameters = ResetPasswordStartCommandParameters.builder()
             .platformComponents(mock<PlatformComponents>())
             .username(emptyString)

common4j/src/test/com/microsoft/identity/common/java/nativeauth/providers/NativeAuthResponseHandlerTest.kt

@@ -59,7 +59,6 @@ import org.junit.Assert.assertTrue
 import org.junit.Test
 import org.mockito.kotlin.mock
 import org.mockito.kotlin.whenever
-import java.net.URL
 
 class NativeAuthResponseHandlerTest {
     private val clientId = "1234"
@@ -280,7 +279,7 @@ class NativeAuthResponseHandlerTest {
             subError = null
         )
         val apiResult = signUpStartApiResponse.toResult()
-        assertTrue(apiResult is SignUpStartApiResult.InvalidEmail)
+        assertTrue(apiResult is SignUpStartApiResult.InvalidUsername)
     }
 
     @Test