Merge branch 'main' into SDK-5778

pmathew92 · web-flow · commit 6f5e8475c249 · 2025-04-25T17:12:34.000+05:30
diff --git a/EXAMPLES.md b/EXAMPLES.md
@@ -18,7 +18,7 @@
     - [Sign Up with a database connection](#sign-up-with-a-database-connection)
     - [Get user information](#get-user-information)
     - [Custom Token Exchange](#custom-token-exchange)
-    - [Native to Web SSO login](#native-to-web-sso-login)
+    - [Native to Web SSO login [EA]](#native-to-web-sso-login-ea)
   - [Credentials Manager](#credentials-manager)
     - [Secure Credentials Manager](#secure-credentials-manager)
       - [Usage](#usage)
@@ -541,7 +541,11 @@ authentication
 </details>
 
 
-## Native to Web SSO login
+## Native to Web SSO login [EA]
+
+> [!NOTE]  
+> This feature is currently available in [Early Access](https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access). Please reach out to Auth0 support to get it 
+> enabled for your tenant.
 
 This feature allows you to authenticate a user in a web session using the refresh token obtained from the native session without requiring the user to log in again.
 
diff --git a/auth0/src/main/java/com/auth0/android/authentication/AuthenticationAPIClient.kt b/auth0/src/main/java/com/auth0/android/authentication/AuthenticationAPIClient.kt
@@ -945,6 +945,12 @@ public class AuthenticationAPIClient @VisibleForTesting(otherwise = VisibleForTe
      * parameter with the session transfer token. For example,
      * `https://example.com/login?session_transfer_token=THE_TOKEN`.
      *
+     * ##Availability
+     *
+     * This feature is currently available in
+     * [Early Access](https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access).
+     * Please reach out to Auth0 support to get it enabled for your tenant.
+     *
      *
      * @param refreshToken A valid refresh token obtained as part of Auth0 authentication
      * @return a request to fetch a session transfer token
diff --git a/auth0/src/main/java/com/auth0/android/authentication/storage/CredentialsManager.kt b/auth0/src/main/java/com/auth0/android/authentication/storage/CredentialsManager.kt
@@ -1,6 +1,7 @@
 package com.auth0.android.authentication.storage
 
 import android.text.TextUtils
+import android.util.Log
 import androidx.annotation.VisibleForTesting
 import com.auth0.android.authentication.AuthenticationAPIClient
 import com.auth0.android.authentication.AuthenticationException
@@ -80,6 +81,12 @@ public class CredentialsManager @VisibleForTesting(otherwise = VisibleForTesting
      * parameter with the session transfer token. For example,
      *  `https://example.com/login?session_transfer_token=THE_TOKEN`.
      *
+     * ## Availability
+     *
+     * This feature is currently available in
+     * [Early Access](https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access).
+     * Please reach out to Auth0 support to get it enabled for your tenant.
+     *
      * It will fail with [CredentialsManagerException] if the existing refresh_token is null or no longer valid.
      * This method will handle saving the refresh_token, if a new one is issued.
      */
@@ -95,6 +102,12 @@ public class CredentialsManager @VisibleForTesting(otherwise = VisibleForTesting
      * parameter with the session transfer token. For example,
      *  `https://example.com/login?session_transfer_token=THE_TOKEN`.
      *
+     * ## Availability
+     *
+     * This feature is currently available in
+     * [Early Access](https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access).
+     * Please reach out to Auth0 support to get it enabled for your tenant.
+     *
      * It will fail with [CredentialsManagerException] if the existing refresh_token is null or no longer valid.
      * This method will handle saving the refresh_token, if a new one is issued.
      */
@@ -128,6 +141,17 @@ public class CredentialsManager @VisibleForTesting(otherwise = VisibleForTesting
                         error
                     )
                 )
+            } catch (exception: RuntimeException) {
+                Log.e(
+                    TAG,
+                    "Caught unexpected exceptions while fetching sso token ${exception.stackTraceToString()}"
+                )
+                callback.onFailure(
+                    CredentialsManagerException(
+                        CredentialsManagerException.Code.UNKNOWN_ERROR,
+                        exception
+                    )
+                )
             }
         }
     }
@@ -140,6 +164,12 @@ public class CredentialsManager @VisibleForTesting(otherwise = VisibleForTesting
      * parameter with the session transfer token. For example,
      *  `https://example.com/login?session_transfer_token=THE_TOKEN`.
      *
+     * ## Availability
+     *
+     * This feature is currently available in
+     * [Early Access](https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access).
+     * Please reach out to Auth0 support to get it enabled for your tenant.
+     *
      * It will fail with [CredentialsManagerException] if the existing refresh_token is null or no longer valid.
      * This method will handle saving the refresh_token, if a new one is issued.
      */
@@ -157,6 +187,12 @@ public class CredentialsManager @VisibleForTesting(otherwise = VisibleForTesting
      * parameter with the session transfer token. For example,
      *  `https://example.com/login?session_transfer_token=THE_TOKEN`.
      *
+     * ## Availability
+     *
+     * This feature is currently available in
+     * [Early Access](https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access).
+     * Please reach out to Auth0 support to get it enabled for your tenant.
+     *
      * It will fail with [CredentialsManagerException] if the existing refresh_token is null or no longer valid.
      * This method will handle saving the refresh_token, if a new one is issued.
      */
@@ -499,6 +535,20 @@ public class CredentialsManager @VisibleForTesting(otherwise = VisibleForTesting
                         exception, error
                     )
                 )
+            } catch (exception: RuntimeException) {
+                /**
+                 *  Catching any unexpected runtime errors in the token renewal flow
+                 */
+                Log.e(
+                    TAG,
+                    "Caught unexpected exceptions for token renewal ${exception.stackTraceToString()}"
+                )
+                callback.onFailure(
+                    CredentialsManagerException(
+                        CredentialsManagerException.Code.UNKNOWN_ERROR,
+                        exception
+                    )
+                )
             }
         }
     }
@@ -684,5 +734,6 @@ public class CredentialsManager @VisibleForTesting(otherwise = VisibleForTesting
         // This is no longer used as we get the credentials expiry from the access token only,
         // but we still store it so users can rollback to versions where it is required.
         private const val LEGACY_KEY_CACHE_EXPIRES_AT = "com.auth0.cache_expires_at"
+        private val TAG = CredentialsManager::class.java.simpleName
     }
 }
diff --git a/auth0/src/main/java/com/auth0/android/authentication/storage/CredentialsManagerException.kt b/auth0/src/main/java/com/auth0/android/authentication/storage/CredentialsManagerException.kt
@@ -46,6 +46,7 @@ public class CredentialsManagerException :
         NO_NETWORK,
         API_ERROR,
         SSO_EXCHANGE_FAILED,
+        UNKNOWN_ERROR
     }
 
     private var code: Code?
@@ -146,6 +147,8 @@ public class CredentialsManagerException :
         public val SSO_EXCHANGE_FAILED: CredentialsManagerException =
             CredentialsManagerException(Code.SSO_EXCHANGE_FAILED)
 
+        public val UNKNOWN_ERROR: CredentialsManagerException = CredentialsManagerException(Code.UNKNOWN_ERROR)
+
 
         private fun getMessage(code: Code): String {
             return when (code) {
@@ -191,6 +194,7 @@ public class CredentialsManagerException :
                 Code.NO_NETWORK -> "Failed to execute the network request."
                 Code.API_ERROR -> "An error occurred while processing the request."
                 Code.SSO_EXCHANGE_FAILED ->"The exchange of the refresh token for SSO credentials failed."
+                Code.UNKNOWN_ERROR -> "An unknown error has occurred while fetching the token. Please check the error cause for more details."
             }
         }
     }
diff --git a/auth0/src/main/java/com/auth0/android/authentication/storage/SecureCredentialsManager.kt b/auth0/src/main/java/com/auth0/android/authentication/storage/SecureCredentialsManager.kt
@@ -164,6 +164,12 @@ public class SecureCredentialsManager @VisibleForTesting(otherwise = VisibleForT
      * parameter with the session transfer token. For example,
      *  `https://example.com/login?session_transfer_token=THE_TOKEN`.
      *
+     * ## Availability
+     *
+     * This feature is currently available in
+     * [Early Access](https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access).
+     * Please reach out to Auth0 support to get it enabled for your tenant.
+     *
      * It will fail with [CredentialsManagerException] if the existing refresh_token is null or no longer valid.
      * This method will handle saving the refresh_token, if a new one is issued.
      */
@@ -179,6 +185,12 @@ public class SecureCredentialsManager @VisibleForTesting(otherwise = VisibleForT
      * parameter with the session transfer token. For example,
      *  `https://example.com/login?session_transfer_token=THE_TOKEN`.
      *
+     * ## Availability
+     *
+     * This feature is currently available in
+     * [Early Access](https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access).
+     * Please reach out to Auth0 support to get it enabled for your tenant.
+     *
      * It will fail with [CredentialsManagerException] if the existing refresh_token is null or no longer valid.
      * This method will handle saving the refresh_token, if a new one is issued.
      */
@@ -223,6 +235,17 @@ public class SecureCredentialsManager @VisibleForTesting(otherwise = VisibleForT
                     CredentialsManagerException.Code.STORE_FAILED, error
                 )
                 callback.onFailure(exception)
+            } catch (exception: RuntimeException) {
+                Log.e(
+                    TAG,
+                    "Caught unexpected exceptions while fetching sso token ${exception.stackTraceToString()}"
+                )
+                callback.onFailure(
+                    CredentialsManagerException(
+                        CredentialsManagerException.Code.UNKNOWN_ERROR,
+                        exception
+                    )
+                )
             }
         }
     }
@@ -235,6 +258,12 @@ public class SecureCredentialsManager @VisibleForTesting(otherwise = VisibleForT
      * parameter with the session transfer token. For example,
      *  `https://example.com/login?session_transfer_token=THE_TOKEN`.
      *
+     * ## Availability
+     *
+     * This feature is currently available in
+     * [Early Access](https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access).
+     * Please reach out to Auth0 support to get it enabled for your tenant.
+     *
      * It will fail with [CredentialsManagerException] if the existing refresh_token is null or no longer valid.
      * This method will handle saving the refresh_token, if a new one is issued.
      */
@@ -252,6 +281,12 @@ public class SecureCredentialsManager @VisibleForTesting(otherwise = VisibleForT
      * parameter with the session transfer token. For example,
      *  `https://example.com/login?session_transfer_token=THE_TOKEN`.
      *
+     * ## Availability
+     *
+     * This feature is currently available in
+     * [Early Access](https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access).
+     * Please reach out to Auth0 support to get it enabled for your tenant.
+     *
      * It will fail with [CredentialsManagerException] if the existing refresh_token is null or no longer valid.
      * This method will handle saving the refresh_token, if a new one is issued.
      */
@@ -801,6 +836,21 @@ public class SecureCredentialsManager @VisibleForTesting(otherwise = VisibleForT
                     )
                 )
                 return@execute
+            } catch (exception: RuntimeException) {
+                /**
+                 *  Catching any unexpected runtime errors in the token renewal flow
+                 */
+                Log.e(
+                    TAG,
+                    "Caught unexpected exceptions for token renewal ${exception.stackTraceToString()}"
+                )
+                callback.onFailure(
+                    CredentialsManagerException(
+                        CredentialsManagerException.Code.UNKNOWN_ERROR,
+                        exception
+                    )
+                )
+                return@execute
             }
 
             try {
diff --git a/auth0/src/test/java/com/auth0/android/authentication/storage/CredentialsManagerTest.kt b/auth0/src/test/java/com/auth0/android/authentication/storage/CredentialsManagerTest.kt
@@ -356,6 +356,31 @@ public class CredentialsManagerTest {
         )
     }
 
+    @Test
+    public fun shouldFailOnGetNewSSOCredentialsWhenUnexpectedErrorOccurs() {
+        Mockito.`when`(storage.retrieveString("com.auth0.refresh_token")).thenReturn("refreshToken")
+        Mockito.`when`(
+            client.ssoExchange("refreshToken")
+        ).thenReturn(SSOCredentialsRequest)
+        //Trigger failure
+        val runtimeException = RuntimeException(
+            "unexpected_error"
+        )
+        Mockito.`when`(SSOCredentialsRequest.execute()).thenThrow(runtimeException)
+        manager.getSsoCredentials(ssoCallback)
+        verify(ssoCallback).onFailure(
+            exceptionCaptor.capture()
+        )
+        val exception = exceptionCaptor.firstValue
+        MatcherAssert.assertThat(exception, Is.`is`(Matchers.notNullValue()))
+        MatcherAssert.assertThat(exception, Is.`is`(CredentialsManagerException.UNKNOWN_ERROR))
+        MatcherAssert.assertThat(exception.cause, Is.`is`(runtimeException))
+        MatcherAssert.assertThat(
+            exception.message,
+            Is.`is`("An unknown error has occurred while fetching the token. Please check the error cause for more details.")
+        )
+    }
+
     @Test
     @ExperimentalCoroutinesApi
     public fun shouldFailOnAwaitSSOCredentialsWhenNoRefreshTokenWasSaved(): Unit = runTest {
@@ -1448,6 +1473,46 @@ public class CredentialsManagerTest {
         )
     }
 
+    @Test
+    public fun shouldGetAndFailToRenewExpiredCredentialsWhenAnyUnexpectedErrorOccurs() {
+        Mockito.`when`(storage.retrieveString("com.auth0.id_token")).thenReturn("idToken")
+        Mockito.`when`(storage.retrieveString("com.auth0.access_token")).thenReturn("accessToken")
+        Mockito.`when`(storage.retrieveString("com.auth0.refresh_token")).thenReturn("refreshToken")
+        Mockito.`when`(storage.retrieveString("com.auth0.token_type")).thenReturn("type")
+        val expirationTime = CredentialsMock.CURRENT_TIME_MS //Same as current time --> expired
+        Mockito.`when`(storage.retrieveLong("com.auth0.expires_at")).thenReturn(expirationTime)
+        Mockito.`when`(storage.retrieveLong("com.auth0.cache_expires_at"))
+            .thenReturn(expirationTime)
+        Mockito.`when`(storage.retrieveString("com.auth0.scope")).thenReturn("scope")
+        Mockito.`when`(
+            client.renewAuth("refreshToken")
+        ).thenReturn(request)
+        //Trigger failure
+        val runtimeException = NullPointerException("Something went wrong")
+        Mockito.`when`(request.execute()).thenThrow(runtimeException)
+        manager.getCredentials(callback)
+        verify(storage, never())
+            .store(ArgumentMatchers.anyString(), ArgumentMatchers.anyInt())
+        verify(storage, never())
+            .store(ArgumentMatchers.anyString(), ArgumentMatchers.anyLong())
+        verify(storage, never())
+            .store(ArgumentMatchers.anyString(), ArgumentMatchers.anyString())
+        verify(storage, never())
+            .store(ArgumentMatchers.anyString(), ArgumentMatchers.anyBoolean())
+        verify(storage, never()).remove(ArgumentMatchers.anyString())
+        verify(callback).onFailure(
+            exceptionCaptor.capture()
+        )
+        val exception = exceptionCaptor.firstValue
+        MatcherAssert.assertThat(exception, Is.`is`(Matchers.notNullValue()))
+        MatcherAssert.assertThat(exception, Is.`is`(CredentialsManagerException.UNKNOWN_ERROR))
+        MatcherAssert.assertThat(exception.cause, Is.`is`(runtimeException))
+        MatcherAssert.assertThat(
+            exception.message,
+            Is.`is`("An unknown error has occurred while fetching the token. Please check the error cause for more details.")
+        )
+    }
+
     @Test
     public fun shouldClearCredentials() {
         manager.clearCredentials()
diff --git a/auth0/src/test/java/com/auth0/android/authentication/storage/SecureCredentialsManagerTest.kt b/auth0/src/test/java/com/auth0/android/authentication/storage/SecureCredentialsManagerTest.kt

Original file line number	Diff line number	Diff line change
`@@ -945,6 +945,12 @@ public class AuthenticationAPIClient @VisibleForTesting(otherwise = VisibleForTe`
`945`	`945`	`* parameter with the session transfer token. For example,`
`946`	`946`	* `https://example.com/login?session_transfer_token=THE_TOKEN`.
`947`	`947`	`*`
	`948`	`+ * ##Availability`
	`949`	`+ *`
	`950`	`+ * This feature is currently available in`
	`951`	`+ * [Early Access](https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access).`
	`952`	`+ * Please reach out to Auth0 support to get it enabled for your tenant.`
	`953`	`+ *`
`948`	`954`	`*`
`949`	`955`	`* @param refreshToken A valid refresh token obtained as part of Auth0 authentication`
`950`	`956`	`* @return a request to fetch a session transfer token`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,7 @@ public class CredentialsManagerException :`
`46`	`46`	`NO_NETWORK,`
`47`	`47`	`API_ERROR,`
`48`	`48`	`SSO_EXCHANGE_FAILED,`
	`49`	`+ UNKNOWN_ERROR`
`49`	`50`	`}`
`50`	`51`
`51`	`52`	`private var code: Code?`
`@@ -146,6 +147,8 @@ public class CredentialsManagerException :`
`146`	`147`	`public val SSO_EXCHANGE_FAILED: CredentialsManagerException =`
`147`	`148`	`CredentialsManagerException(Code.SSO_EXCHANGE_FAILED)`
`148`	`149`
	`150`	`+ public val UNKNOWN_ERROR: CredentialsManagerException = CredentialsManagerException(Code.UNKNOWN_ERROR)`
	`151`	`+`
`149`	`152`
`150`	`153`	`private fun getMessage(code: Code): String {`
`151`	`154`	`return when (code) {`
`@@ -191,6 +194,7 @@ public class CredentialsManagerException :`
`191`	`194`	`Code.NO_NETWORK -> "Failed to execute the network request."`
`192`	`195`	`Code.API_ERROR -> "An error occurred while processing the request."`
`193`	`196`	`Code.SSO_EXCHANGE_FAILED ->"The exchange of the refresh token for SSO credentials failed."`
	`197`	`+ Code.UNKNOWN_ERROR -> "An unknown error has occurred while fetching the token. Please check the error cause for more details."`
`194`	`198`	`}`
`195`	`199`	`}`
`196`	`200`	`}`