[Order Details] Allow failed orders to show receipt if eligible (#15558)

Author: iamgabrielma

RELEASE-NOTES.txt

@@ -3,6 +3,7 @@
 
 22.4
 -----
+- [*] Payments: Receipts for failed transactions are now available in Order details  [https://github.com/woocommerce/woocommerce-ios/pull/15558]
 - [*] Order Details: Improvements to textfield capitalization rules [https://github.com/woocommerce/woocommerce-ios/pull/15611]
 - [*] POS: Scrolling search results now dismisses the keyboard [https://github.com/woocommerce/woocommerce-ios/pull/15606]
 - [*] POS: Product search shows popular products before a search is entered. [https://github.com/woocommerce/woocommerce-ios/pull/15625]

WooCommerce/Classes/ViewModels/Order Details/OrderDetailsDataSource.swift

@@ -1525,11 +1525,10 @@ extension OrderDetailsDataSource {
 
     @MainActor
     private func isEligibleForBackendReceipt() async -> Bool {
-        guard !isEligibleForPayment else { return false }
         return await withCheckedContinuation { continuation in
-            receiptEligibilityUseCase.isEligibleForBackendReceipts { isEligible in
+            receiptEligibilityUseCase.isEligibleForReceipt(order.status, onCompletion: { isEligible in
                 continuation.resume(returning: isEligible)
-            }
+            })
         }
     }
 
@@ -1545,15 +1544,6 @@ extension OrderDetailsDataSource {
         return refundFound
     }
 
-    private func isEligibleForBackendReceipt(completion: @escaping (Bool) -> Void) {
-        guard !isEligibleForPayment else {
-            return completion(false)
-        }
-        receiptEligibilityUseCase.isEligibleForBackendReceipts { isEligibleForReceipt in
-            completion(isEligibleForReceipt)
-        }
-    }
-
     private func updateOrderNoteAsyncDictionary(orderNotes: [OrderNote]) {
         orderNoteAsyncDictionary.clear()
         for orderNote in orderNotes {

WooCommerce/Classes/ViewModels/Order Details/Receipts/ReceiptEligibilityUseCase.swift

@@ -5,6 +5,7 @@ protocol ReceiptEligibilityUseCaseProtocol {
     func isEligibleForBackendReceipts(onCompletion: @escaping (Bool) -> Void)
     func isEligibleForSuccessfulPaymentEmailReceipts(onCompletion: @escaping (Bool) -> Void)
     func isEligibleForFailedPaymentEmailReceipts(paymentGatewayID: String, onCompletion: @escaping (Bool) -> Void)
+    func isEligibleForReceipt(_ orderStatus: OrderStatusEnum, onCompletion: @escaping (Bool) -> Void)
 }
 
 final class ReceiptEligibilityUseCase: ReceiptEligibilityUseCaseProtocol {
@@ -27,15 +28,10 @@ final class ReceiptEligibilityUseCase: ReceiptEligibilityUseCaseProtocol {
             guard let wcPlugin = wcPlugin, wcPlugin.active else {
                 return onCompletion(false)
             }
-            // 2. If WooCommerce version is any of the specific API development branches, mark as eligible
-            if Constants.BackendReceipt.wcPluginDevVersion.contains(wcPlugin.version) {
-                onCompletion(true)
-            } else {
-                // 3. Else, if WooCommerce version is higher than minimum required version, mark as eligible
-                let isSupported = VersionHelpers.isVersionSupported(version: wcPlugin.version,
-                                                                    minimumRequired: Constants.BackendReceipt.wcPluginMinimumVersion)
-                onCompletion(isSupported)
-            }
+            // 2. If WooCommerce version is higher than minimum required version, mark as eligible
+            let isSupported = VersionHelpers.isVersionSupported(version: wcPlugin.version,
+                                                                minimumRequired: Constants.BackendReceipt.wcPluginMinimumVersion)
+            onCompletion(isSupported)
         }
         stores.dispatch(action)
     }
@@ -90,6 +86,26 @@ final class ReceiptEligibilityUseCase: ReceiptEligibilityUseCaseProtocol {
             onCompletion(isWooCommerceSupported && isGatewaySupported)
         }
     }
+
+    func isEligibleForReceipt(_ orderStatus: OrderStatusEnum, onCompletion: @escaping (Bool) -> Void) {
+        switch orderStatus {
+        case .completed, .processing, .refunded:
+            isEligibleForBackendReceipts { isEligibleForReceipt in
+                onCompletion(isEligibleForReceipt)
+            }
+        case .failed:
+            selectedPaymentGatewayID { [weak self] gatewayID in
+                guard let gatewayID else {
+                    return onCompletion(false)
+                }
+                self?.isEligibleForFailedPaymentEmailReceipts(paymentGatewayID: gatewayID) { isEligibleForReceipt in
+                    onCompletion(isEligibleForReceipt)
+                }
+            }
+        default:
+            return onCompletion(false)
+        }
+    }
 }
 
 private extension ReceiptEligibilityUseCase {
@@ -102,11 +118,6 @@ private extension ReceiptEligibilityUseCase {
                     return continuation.resume(returning: false)
                 }
 
-                // Checking for concrete versions to cover dev and beta versions
-                if plugin.version.contains(minimumVersion) {
-                    return continuation.resume(returning: true)
-                }
-
                 // If plugin version is higher than minimum required version, mark as eligible
                 let isSupported = VersionHelpers.isVersionSupported(version: plugin.version,
                                                                     minimumRequired: minimumVersion)
@@ -115,6 +126,15 @@ private extension ReceiptEligibilityUseCase {
             stores.dispatch(action)
         }
     }
+
+    // Returns the current payment gateway ID, needed when checking if a transaction is eligible for receipts
+    // based on which plugin and versions are active
+    private func selectedPaymentGatewayID(onCompletion: @escaping (String?) -> Void) {
+        let action = CardPresentPaymentAction.selectedPaymentGatewayAccount { paymentGatewayAccount in
+            onCompletion(paymentGatewayAccount?.gatewayID)
+        }
+        stores.dispatch(action)
+    }
 }
 
 private extension ReceiptEligibilityUseCase {
@@ -123,7 +143,6 @@ private extension ReceiptEligibilityUseCase {
 
         enum BackendReceipt {
             static let wcPluginMinimumVersion = "8.7.0"
-            static let wcPluginDevVersion: [String] = ["8.7.0-dev", "8.6.0-dev"]
         }
 
         enum ReceiptAfterPayment {

WooCommerce/WooCommerceTests/Mocks/MockReceiptEligibilityUseCase.swift

@@ -1,9 +1,11 @@
+import enum Yosemite.OrderStatusEnum
 @testable import WooCommerce
 
 final class MockReceiptEligibilityUseCase: ReceiptEligibilityUseCaseProtocol {
     var isEligibleForBackendReceipts: Bool = true
     var isEligibleForSuccessfulPaymentEmailReceipts: Bool = false
     var isEligibleForFailedPaymentEmailReceipts: Bool = false
+    var isEligibleForReceipt: Bool = true
 
     func isEligibleForBackendReceipts(onCompletion: @escaping (Bool) -> Void) {
         onCompletion(isEligibleForBackendReceipts)
@@ -16,4 +18,8 @@ final class MockReceiptEligibilityUseCase: ReceiptEligibilityUseCaseProtocol {
     func isEligibleForFailedPaymentEmailReceipts(paymentGatewayID: String, onCompletion: @escaping (Bool) -> Void) {
         onCompletion(isEligibleForFailedPaymentEmailReceipts)
     }
+
+    func isEligibleForReceipt(_ orderStatus: OrderStatusEnum, onCompletion: @escaping (Bool) -> Void) {
+        onCompletion(isEligibleForReceipt)
+    }
 }