Clear cache on error (#147)

Author: kiftio

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.2.1 October 29 2024
+
+- Fix: Ensure we clear the preload cache on error responses.
+
 ## 3.2.0 October 18 2024
 
 - Prevent entering recovery mode for single-use multipass URLs.

README.md

@@ -23,7 +23,7 @@ your project:
 #### Gradle
 
 ```groovy
-implementation "com.shopify:checkout-sheet-kit:3.2.0"
+implementation "com.shopify:checkout-sheet-kit:3.2.1"
 ```
 
 #### Maven
@@ -33,7 +33,7 @@ implementation "com.shopify:checkout-sheet-kit:3.2.0"
 <dependency>
    <groupId>com.shopify</groupId>
    <artifactId>checkout-sheet-kit</artifactId>
-   <version>3.2.0</version>
+   <version>3.2.1</version>
 </dependency>
 ```
 

lib/build.gradle

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

lib/src/main/java/com/shopify/checkoutsheetkit/CheckoutDialog.kt

@@ -150,6 +150,7 @@ internal class CheckoutDialog(
     }
 
     internal fun closeCheckoutDialogWithError(exception: CheckoutException) {
+        CheckoutWebView.markCacheEntryStale()
         checkoutEventProcessor.onCheckoutFailed(exception)
         if (!this.checkoutUrl.isOneTimeUse() &&
             ShopifyCheckoutSheetKit.configuration.errorRecovery.shouldRecoverFromError(exception)) {

lib/src/test/java/com/shopify/checkoutsheetkit/CheckoutDialogTest.kt

@@ -155,6 +155,26 @@ class CheckoutDialogTest {
         verify(mockEventProcessor, never()).onCheckoutFailed(any())
     }
 
+    @Test
+    fun `closeCheckoutDialogWithError marks cache entry stale`() {
+        withPreloadingEnabled {
+            val mockEventProcessor = mock<DefaultCheckoutEventProcessor>()
+            ShopifyCheckoutSheetKit.preload("https://shopify.com", activity)
+            ShopifyCheckoutSheetKit.present("https://shopify.com", activity, mockEventProcessor)
+
+            assertThat(CheckoutWebView.cacheEntry).isNotNull()
+
+            val dialog = ShadowDialog.getLatestDialog()
+            val checkoutDialog = dialog as CheckoutDialog
+            val error = checkoutException(isRecoverable = false)
+
+            checkoutDialog.closeCheckoutDialogWithError(error)
+            shadowOf(Looper.getMainLooper()).runToEndOfTasks()
+
+            assertThat(CheckoutWebView.cacheEntry).isNull()
+        }
+    }
+
     @Test
     fun `calls onCheckoutFailed if closeCheckoutDialogWithError for non-recoverable error`() {
         val mockEventProcessor = mock<DefaultCheckoutEventProcessor>()

samples/MobileBuyIntegration/app/src/main/java/com/shopify/checkout_sdk_mobile_buy_integration_sample/common/MobileBuyEventProcessor.kt

@@ -67,6 +67,7 @@ class MobileBuyEventProcessor(
         logger.log("Checkout failed", error)
 
         if (!error.isRecoverable) {
+            cartViewModel.clearCart()
             GlobalScope.launch(Dispatchers.Main) {
                 Toast.makeText(
                     context,