Merge pull request #110 from stytchauth/feature/Error-Unification

Feature/error unification
stytchauth · Dec 18, 2023 · f2a1f17 · f2a1f17
2 parents a08ec8b + 9619553
commit f2a1f17
Show file tree

Hide file tree

Showing 59 changed files with 900 additions and 424 deletions.
diff --git a/b2bExampleApp/src/main/java/com/stytch/exampleapp/b2b/HomeViewModel.kt b/b2bExampleApp/src/main/java/com/stytch/exampleapp/b2b/HomeViewModel.kt
@@ -106,7 +106,7 @@ class HomeViewModel(application: Application) : AndroidViewModel(application) {
             _loadingState.value = true
             val result = StytchB2BClient.handle(uri = uri, sessionDurationMinutes = 60u)
             _currentResponse.value = when (result) {
-                is DeeplinkHandledStatus.NotHandled -> result.reason
+                is DeeplinkHandledStatus.NotHandled -> result.reason.message
                 is DeeplinkHandledStatus.Handled -> {
                     // Hacking this in for organization discovery stuff
                     (result.response as? DeeplinkResponse.Discovery)

diff --git a/b2bExampleApp/src/main/java/com/stytch/exampleapp/b2b/SSOViewModel.kt b/b2bExampleApp/src/main/java/com/stytch/exampleapp/b2b/SSOViewModel.kt
@@ -46,7 +46,7 @@ class SSOViewModel : ViewModel() {
                     intent?.data?.let {
                         val result = StytchClient.handle(it, 60U)
                         when (result) {
-                            is DeeplinkHandledStatus.NotHandled -> result.reason
+                            is DeeplinkHandledStatus.NotHandled -> result.reason.message
                             is DeeplinkHandledStatus.Handled -> result.response.result.toFriendlyDisplay()
                             // This only happens for password reset deeplinks
                             is DeeplinkHandledStatus.ManualHandlingRequired -> ""

diff --git a/b2bExampleApp/src/main/java/com/stytch/exampleapp/b2b/Util.kt b/b2bExampleApp/src/main/java/com/stytch/exampleapp/b2b/Util.kt
@@ -1,6 +1,7 @@
 package com.stytch.exampleapp.b2b
 
 import com.stytch.sdk.common.StytchResult
+import com.stytch.sdk.common.errors.StytchAPIError
 import java.util.regex.Pattern
 
 private val EMAIL_ADDRESS_PATTERN = Pattern.compile(
@@ -25,5 +26,11 @@ fun isPhoneNumberValid(str: String): Boolean {
 
 fun <T : Any> StytchResult<T>.toFriendlyDisplay() = when (this) {
     is StytchResult.Success<*> -> this.toString()
-    is StytchResult.Error -> this.exception.reason?.toString() ?: "Unknown exception"
+    is StytchResult.Error -> {
+        var message = "Name: ${exception}\nDescription: ${exception.message}"
+        if (exception is StytchAPIError) {
+            message += "\nURL: ${(exception as StytchAPIError).url}"
+        }
+        message
+    }
 }
diff --git a/consumerExampleApp/src/main/java/com/stytch/exampleapp/HomeViewModel.kt b/consumerExampleApp/src/main/java/com/stytch/exampleapp/HomeViewModel.kt
@@ -47,7 +47,7 @@ class HomeViewModel(application: Application) : AndroidViewModel(application) {
         viewModelScope.launch {
             _loadingState.value = true
             _currentResponse.value = when (val result = StytchClient.handle(uri = uri, sessionDurationMinutes = 60u)) {
-                is DeeplinkHandledStatus.NotHandled -> result.reason
+                is DeeplinkHandledStatus.NotHandled -> result.reason.message
                 is DeeplinkHandledStatus.Handled -> result.response.result.toFriendlyDisplay()
                 // This only happens for password reset deeplinks
                 is DeeplinkHandledStatus.ManualHandlingRequired ->

diff --git a/consumerExampleApp/src/main/java/com/stytch/exampleapp/OAuthViewModel.kt b/consumerExampleApp/src/main/java/com/stytch/exampleapp/OAuthViewModel.kt
@@ -99,7 +99,7 @@ class OAuthViewModel(application: Application) : AndroidViewModel(application) {
                 intent.data?.let {
                     val result = StytchClient.handle(it, 60U)
                     _currentResponse.value = when (result) {
-                        is DeeplinkHandledStatus.NotHandled -> result.reason
+                        is DeeplinkHandledStatus.NotHandled -> result.reason.message
                         is DeeplinkHandledStatus.Handled -> result.response.result.toFriendlyDisplay()
                         // This only happens for password reset deeplinks
                         is DeeplinkHandledStatus.ManualHandlingRequired -> ""

diff --git a/consumerExampleApp/src/main/java/com/stytch/exampleapp/Util.kt b/consumerExampleApp/src/main/java/com/stytch/exampleapp/Util.kt
@@ -1,6 +1,7 @@
 package com.stytch.exampleapp
 
 import com.stytch.sdk.common.StytchResult
+import com.stytch.sdk.common.errors.StytchAPIError
 import java.util.regex.Pattern
 
 private val EMAIL_ADDRESS_PATTERN = Pattern.compile(
@@ -25,5 +26,11 @@ fun isPhoneNumberValid(str: String): Boolean {
 
 fun <T : Any> StytchResult<T>.toFriendlyDisplay() = when (this) {
     is StytchResult.Success<*> -> this.toString()
-    is StytchResult.Error -> this.exception.reason?.toString() ?: "Unknown exception"
+    is StytchResult.Error -> {
+        var message = "Name: ${exception}\nDescription: ${exception.message}"
+        if (exception is StytchAPIError) {
+            message += "\nURL: ${(exception as StytchAPIError).url}"
+        }
+        message
+    }
 }
diff --git a/sdk/build.gradle b/sdk/build.gradle
@@ -7,7 +7,7 @@ plugins {
 
 ext {
   PUBLISH_GROUP_ID = 'com.stytch.sdk'
-  PUBLISH_VERSION = '0.17.0'
+  PUBLISH_VERSION = '0.18.0'
   PUBLISH_ARTIFACT_ID = 'sdk'
 }
 

diff --git a/sdk/src/main/java/com/stytch/sdk/b2b/StytchB2BClient.kt b/sdk/src/main/java/com/stytch/sdk/b2b/StytchB2BClient.kt
@@ -25,18 +25,19 @@ import com.stytch.sdk.common.DeeplinkHandledStatus
 import com.stytch.sdk.common.DeeplinkResponse
 import com.stytch.sdk.common.StorageHelper
 import com.stytch.sdk.common.StytchDispatchers
-import com.stytch.sdk.common.StytchExceptions
 import com.stytch.sdk.common.StytchResult
 import com.stytch.sdk.common.dfp.ActivityProvider
 import com.stytch.sdk.common.dfp.CaptchaProviderImpl
 import com.stytch.sdk.common.dfp.DFP
 import com.stytch.sdk.common.dfp.DFPImpl
 import com.stytch.sdk.common.dfp.DFPProvider
 import com.stytch.sdk.common.dfp.DFPProviderImpl
+import com.stytch.sdk.common.errors.StytchDeeplinkMissingTokenError
+import com.stytch.sdk.common.errors.StytchDeeplinkUnkownTokenTypeError
+import com.stytch.sdk.common.errors.StytchInternalError
+import com.stytch.sdk.common.errors.StytchSDKNotConfiguredError
 import com.stytch.sdk.common.extensions.getDeviceInfo
-import com.stytch.sdk.common.network.StytchErrorType
 import com.stytch.sdk.common.network.models.BootstrapData
-import com.stytch.sdk.common.stytchError
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.GlobalScope
 import kotlinx.coroutines.flow.MutableStateFlow
@@ -72,7 +73,7 @@ public object StytchB2BClient {
      * @param context The applicationContext of your app
      * @param publicToken Available via the Stytch dashboard in the API keys section
      * @param callback An optional callback that is triggered after configuration and initialization has completed
-     * @throws StytchExceptions.Critical - if we failed to generate new encryption keys
+     * @throws StytchInternalError - if we failed to initialize for any reason
      */
     public fun configure(context: Context, publicToken: String, callback: ((Boolean) -> Unit) = {}) {
         try {
@@ -106,16 +107,16 @@ public object StytchB2BClient {
                 callback(_isInitialized.value)
             }
         } catch (ex: Exception) {
-            throw StytchExceptions.Critical(ex)
+            throw StytchInternalError(
+                message = "Failed to initialize the SDK",
+                exception = ex
+            )
         }
     }
 
-    @Suppress("MaxLineLength")
     internal fun assertInitialized() {
         if (!StytchB2BApi.isInitialized) {
-            stytchError(
-                "StytchB2BClient not configured. You must call 'StytchB2BClient.configure(...)' before using any functionality of the StytchB2BClient." // ktlint-disable max-line-length
-            )
+            throw StytchSDKNotConfiguredError("StytchB2BClient")
         }
     }
 
@@ -272,7 +273,7 @@ public object StytchB2BClient {
         return withContext(dispatchers.io) {
             val token = uri.getQueryParameter(Constants.QUERY_TOKEN)
             if (token.isNullOrEmpty()) {
-                return@withContext DeeplinkHandledStatus.NotHandled(StytchErrorType.DEEPLINK_MISSING_TOKEN.message)
+                return@withContext DeeplinkHandledStatus.NotHandled(StytchDeeplinkMissingTokenError)
             }
             when (val tokenType = B2BTokenType.fromString(uri.getQueryParameter(Constants.QUERY_TOKEN_TYPE))) {
                 B2BTokenType.MULTI_TENANT_MAGIC_LINKS -> {
@@ -309,7 +310,7 @@ public object StytchB2BClient {
                     )
                 }
                 else -> {
-                    DeeplinkHandledStatus.NotHandled(StytchErrorType.DEEPLINK_UNKNOWN_TOKEN.message)
+                    DeeplinkHandledStatus.NotHandled(StytchDeeplinkUnkownTokenTypeError)
                 }
             }
         }

diff --git a/sdk/src/main/java/com/stytch/sdk/b2b/magicLinks/B2BMagicLinksImpl.kt b/sdk/src/main/java/com/stytch/sdk/b2b/magicLinks/B2BMagicLinksImpl.kt
@@ -4,13 +4,13 @@ import com.stytch.sdk.b2b.AuthResponse
 import com.stytch.sdk.b2b.DiscoveryEMLAuthResponse
 import com.stytch.sdk.b2b.extensions.launchSessionUpdater
 import com.stytch.sdk.b2b.network.StytchB2BApi
-import com.stytch.sdk.b2b.network.StytchB2BApi.MagicLinks.Discovery.send
 import com.stytch.sdk.b2b.sessions.B2BSessionStorage
 import com.stytch.sdk.common.BaseResponse
 import com.stytch.sdk.common.StorageHelper
 import com.stytch.sdk.common.StytchDispatchers
-import com.stytch.sdk.common.StytchExceptions
 import com.stytch.sdk.common.StytchResult
+import com.stytch.sdk.common.errors.StytchFailedToCreateCodeChallengeError
+import com.stytch.sdk.common.errors.StytchMissingPKCEError
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
@@ -34,7 +34,7 @@ internal class B2BMagicLinksImpl internal constructor(
             try {
                 codeVerifier = storageHelper.retrieveCodeVerifier()!!
             } catch (ex: Exception) {
-                result = StytchResult.Error(StytchExceptions.Critical(ex))
+                result = StytchResult.Error(StytchMissingPKCEError(ex))
                 return@withContext
             }
 
@@ -71,7 +71,7 @@ internal class B2BMagicLinksImpl internal constructor(
             try {
                 codeVerifier = storageHelper.retrieveCodeVerifier()!!
             } catch (ex: Exception) {
-                result = StytchResult.Error(StytchExceptions.Critical(ex))
+                result = StytchResult.Error(StytchMissingPKCEError(ex))
                 return@withContext
             }
             result = discoveryApi.authenticate(
@@ -104,7 +104,7 @@ internal class B2BMagicLinksImpl internal constructor(
                     val challengePair = storageHelper.generateHashedCodeChallenge()
                     challengeCode = challengePair.second
                 } catch (ex: Exception) {
-                    result = StytchResult.Error(StytchExceptions.Critical(ex))
+                    result = StytchResult.Error(StytchFailedToCreateCodeChallengeError(exception = ex))
                     return@withContext
                 }
 
@@ -144,7 +144,7 @@ internal class B2BMagicLinksImpl internal constructor(
                     val challengePair = storageHelper.generateHashedCodeChallenge()
                     challengeCode = challengePair.second
                 } catch (ex: Exception) {
-                    result = StytchResult.Error(StytchExceptions.Critical(ex))
+                    result = StytchResult.Error(StytchFailedToCreateCodeChallengeError(exception = ex))
                     return@withContext
                 }
 

diff --git a/sdk/src/main/java/com/stytch/sdk/b2b/network/StytchB2BApi.kt b/sdk/src/main/java/com/stytch/sdk/b2b/network/StytchB2BApi.kt
@@ -24,10 +24,10 @@ import com.stytch.sdk.b2b.network.models.SsoJitProvisioning
 import com.stytch.sdk.b2b.network.models.StrengthCheckResponseData
 import com.stytch.sdk.common.Constants
 import com.stytch.sdk.common.DeviceInfo
-import com.stytch.sdk.common.StytchExceptions
 import com.stytch.sdk.common.StytchResult
 import com.stytch.sdk.common.dfp.CaptchaProvider
 import com.stytch.sdk.common.dfp.DFPProvider
+import com.stytch.sdk.common.errors.StytchSDKNotConfiguredError
 import com.stytch.sdk.common.network.ApiService
 import com.stytch.sdk.common.network.StytchAuthHeaderInterceptor
 import com.stytch.sdk.common.network.StytchDFPInterceptor
@@ -37,7 +37,6 @@ import com.stytch.sdk.common.network.models.BootstrapData
 import com.stytch.sdk.common.network.models.CommonRequests
 import com.stytch.sdk.common.network.models.DFPProtectedAuthMode
 import com.stytch.sdk.common.network.safeApiCall
-import java.lang.RuntimeException
 
 internal object StytchB2BApi {
     internal lateinit var publicToken: String
@@ -49,11 +48,7 @@ internal object StytchB2BApi {
     @VisibleForTesting
     internal val authHeaderInterceptor: StytchAuthHeaderInterceptor by lazy {
         if (!isInitialized) {
-            throw StytchExceptions.Critical(
-                RuntimeException(
-                    "StytchB2BApi not configured. You must call 'configure(...)' before using any functionality of the " // ktlint-disable max-line-length
-                )
-            )
+            throw StytchSDKNotConfiguredError("StytchB2BClient")
         }
         StytchAuthHeaderInterceptor(
             deviceInfo,

diff --git a/sdk/src/main/java/com/stytch/sdk/b2b/passwords/PasswordsImpl.kt b/sdk/src/main/java/com/stytch/sdk/b2b/passwords/PasswordsImpl.kt
@@ -10,8 +10,9 @@ import com.stytch.sdk.b2b.sessions.B2BSessionStorage
 import com.stytch.sdk.common.BaseResponse
 import com.stytch.sdk.common.StorageHelper
 import com.stytch.sdk.common.StytchDispatchers
-import com.stytch.sdk.common.StytchExceptions
 import com.stytch.sdk.common.StytchResult
+import com.stytch.sdk.common.errors.StytchFailedToCreateCodeChallengeError
+import com.stytch.sdk.common.errors.StytchMissingPKCEError
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
@@ -52,7 +53,7 @@ internal class PasswordsImpl internal constructor(
                 val challengePair = storageHelper.generateHashedCodeChallenge()
                 challengeCode = challengePair.second
             } catch (ex: Exception) {
-                result = StytchResult.Error(StytchExceptions.Critical(ex))
+                result = StytchResult.Error(StytchFailedToCreateCodeChallengeError(ex))
                 return@withContext
             }
             result = api.resetByEmailStart(
@@ -85,7 +86,7 @@ internal class PasswordsImpl internal constructor(
             try {
                 codeVerifier = storageHelper.retrieveCodeVerifier()!!
             } catch (ex: Exception) {
-                result = StytchResult.Error(StytchExceptions.Critical(ex))
+                result = StytchResult.Error(StytchMissingPKCEError(ex))
                 return@withContext
             }
             result = api.resetByEmail(

diff --git a/sdk/src/main/java/com/stytch/sdk/b2b/sessions/B2BSessions.kt b/sdk/src/main/java/com/stytch/sdk/b2b/sessions/B2BSessions.kt
@@ -2,6 +2,7 @@ package com.stytch.sdk.b2b.sessions
 
 import com.stytch.sdk.b2b.AuthResponse
 import com.stytch.sdk.common.BaseResponse
+import com.stytch.sdk.common.errors.StytchFailedToDecryptDataError
 
 /**
  * The B2BSessions interface provides methods for authenticating, updating, or revoking sessions, and properties to
@@ -10,12 +11,12 @@ import com.stytch.sdk.common.BaseResponse
 public interface B2BSessions {
 
     /**
-     * @throws StytchExceptions.Critical if failed to decrypt data
+     * @throws StytchFailedToDecryptDataError if failed to decrypt data
      */
     public val sessionToken: String?
 
     /**
-     * @throws StytchExceptions.Critical if failed to decrypt data
+     * @throws StytchFailedToDecryptDataError if failed to decrypt data
      */
     public val sessionJwt: String?
 

diff --git a/sdk/src/main/java/com/stytch/sdk/b2b/sessions/B2BSessionsImpl.kt b/sdk/src/main/java/com/stytch/sdk/b2b/sessions/B2BSessionsImpl.kt
@@ -5,8 +5,9 @@ import com.stytch.sdk.b2b.extensions.launchSessionUpdater
 import com.stytch.sdk.b2b.network.StytchB2BApi
 import com.stytch.sdk.common.BaseResponse
 import com.stytch.sdk.common.StytchDispatchers
-import com.stytch.sdk.common.StytchExceptions
 import com.stytch.sdk.common.StytchResult
+import com.stytch.sdk.common.errors.StytchFailedToDecryptDataError
+import com.stytch.sdk.common.errors.StytchInternalError
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
@@ -22,7 +23,7 @@ internal class B2BSessionsImpl internal constructor(
             try {
                 return sessionStorage.sessionToken
             } catch (ex: Exception) {
-                throw StytchExceptions.Critical(ex)
+                throw StytchFailedToDecryptDataError(ex)
             }
         }
 
@@ -31,7 +32,7 @@ internal class B2BSessionsImpl internal constructor(
             try {
                 return sessionStorage.sessionJwt
             } catch (ex: Exception) {
-                throw StytchExceptions.Critical(ex)
+                throw StytchFailedToDecryptDataError(ex)
             }
         }
 
@@ -69,7 +70,7 @@ internal class B2BSessionsImpl internal constructor(
                 sessionStorage.revoke()
             }
         } catch (ex: Exception) {
-            result = StytchResult.Error(StytchExceptions.Critical(ex))
+            result = StytchResult.Error(StytchInternalError(exception = ex))
         }
         return result
     }
@@ -84,13 +85,13 @@ internal class B2BSessionsImpl internal constructor(
     }
 
     /**
-     * @throws StytchExceptions.Critical if failed to save data
+     * @throws StytchInternalError if failed to save data
      */
     override fun updateSession(sessionToken: String?, sessionJwt: String?) {
         try {
             sessionStorage.updateSession(sessionToken, sessionJwt)
         } catch (ex: Exception) {
-            throw StytchExceptions.Critical(ex)
+            throw StytchInternalError(ex)
         }
     }
 }
diff --git a/sdk/src/main/java/com/stytch/sdk/b2b/sso/SSOImpl.kt b/sdk/src/main/java/com/stytch/sdk/b2b/sso/SSOImpl.kt
@@ -8,8 +8,8 @@ import com.stytch.sdk.b2b.sessions.B2BSessionStorage
 import com.stytch.sdk.common.Constants
 import com.stytch.sdk.common.StorageHelper
 import com.stytch.sdk.common.StytchDispatchers
-import com.stytch.sdk.common.StytchExceptions
 import com.stytch.sdk.common.StytchResult
+import com.stytch.sdk.common.errors.StytchMissingPKCEError
 import com.stytch.sdk.common.sso.SSOManagerActivity
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
@@ -56,7 +56,7 @@ internal class SSOImpl(
             try {
                 codeVerifier = storageHelper.retrieveCodeVerifier()!!
             } catch (ex: Exception) {
-                result = StytchResult.Error(StytchExceptions.Critical(ex))
+                result = StytchResult.Error(StytchMissingPKCEError(ex))
                 return@withContext
             }
             result = api.authenticate(

diff --git a/sdk/src/main/java/com/stytch/sdk/common/DeeplinkHandledStatus.kt b/sdk/src/main/java/com/stytch/sdk/common/DeeplinkHandledStatus.kt
@@ -1,5 +1,7 @@
 package com.stytch.sdk.common
 
+import com.stytch.sdk.common.errors.StytchDeeplinkError
+
 /**
  * A class representing the three states of a deeplink handled by StytchClient.handle() / StytchB2BClient.handle()
  */
@@ -17,9 +19,9 @@ public sealed interface DeeplinkHandledStatus {
      * This could happen if you pass a non-Stytch deeplink intent to the StytchClient.handle() method, or are trying to
      * use a Consumer/B2B token in the wrong SDK.
      *
-     * @property reason A String explaining why the deeplink was not handled
+     * @property reason A StytchDeeplinkError explaining why the deeplink was not handled
      */
-    public data class NotHandled(val reason: String) : DeeplinkHandledStatus
+    public data class NotHandled(val reason: StytchDeeplinkError) : DeeplinkHandledStatus
 
     /**
      * Indicates that this was a supported Stytch deeplink, but there is something more your application needs to do