Expose the errorDescription var on the CheckoutException class (#19)

* Expose the errorDescription var on the CheckoutException class

* Add test

Author: markmur

CHANGELOG.md

@@ -29,3 +29,7 @@ after release for General Availability.
 
 - Adds annotations (`@ColorInt` and `@ColorRes`) for more robust color value enforcement.
 - Exposes the `lightColors` and `darkColors` properties of the `Automatic` ColorScheme class to allow overrides.
+
+## 0.3.3 - November 27, 2023
+
+- Exposes the `errorDescription` internal variable on the `CheckoutException` class.

lib/build.gradle

@@ -14,7 +14,7 @@ def resolveEnvVarValue(name, defaultValue) {
     return rawValue ? rawValue : defaultValue
 }
 
-def versionName = resolveEnvVarValue("CHECKOUT_KIT_VERSION", "0.3.2")
+def versionName = resolveEnvVarValue("CHECKOUT_KIT_VERSION", "0.3.3")
 
 ext {
     app_compat_version = '1.6.1'

lib/src/main/java/com/shopify/checkoutkit/CheckoutEventProcessor.kt

@@ -31,7 +31,7 @@ import kotlinx.serialization.Serializable
  * Superclass for the Shopify Checkout Kit exceptions
  */
 @Serializable
-public abstract class CheckoutException(private val errorDescription: String) : Exception(errorDescription)
+public abstract class CheckoutException(public val errorDescription: String) : Exception(errorDescription)
 
 /**
  * Issued when an internal error occurs within Shopify Checkout Kit.

lib/src/test/java/com/shopify/checkoutkit/DefaultCheckoutEventProcessorTest.kt

@@ -101,6 +101,30 @@ class DefaultCheckoutEventProcessorTest {
         verify(log).w("DefaultCheckoutEventProcessor", "Unrecognized scheme for link clicked in checkout 'ftp:lsklsm'")
     }
 
+    @Test
+    fun `onCheckoutFailed returns an error description`() {
+        val log = mock<LogWrapper>()
+        var description = ""
+        val processor =
+                object : DefaultCheckoutEventProcessor(activity, log) {
+                    override fun onCheckoutCompleted() {
+                        /* not implemented */
+                    }
+                    override fun onCheckoutFailed(error: CheckoutException) {
+                        description = error.errorDescription
+                    }
+                    override fun onCheckoutCanceled() {
+                        /* not implemented */
+                    }
+                }
+
+        val error = object : CheckoutException("error description") {}
+
+        processor.onCheckoutFailed(error)
+
+        assertThat(description).isEqualTo("error description")
+    }
+
     private fun processor(activity: ComponentActivity): DefaultCheckoutEventProcessor {
         return object: DefaultCheckoutEventProcessor(activity) {
             override fun onCheckoutCompleted() {/* not implemented */}