finish unfinished expired transactions

Author: kp-mario-nachbaur

LocalPackages/PIALibrary/Sources/PIALibrary/Account/DefaultAccountProvider.swift

@@ -481,6 +481,10 @@ public final class DefaultAccountProvider: AccountProvider, ConfigurationAccess,
 
             Task { @MainActor in
                 await performSignup(with: request, callback: callback)
+                // In theory we should only finish transactions on success, but then users get into
+                // some weird state (unfinished, expired transactions), so we finish them all.
+                // Finishing all transactions is fine because users can use the restore flow.
+                await request.transaction?.finish()
             }
         }
 

LocalPackages/PIALibrary/Sources/PIALibrary/InApp/AppStoreProvider.swift

@@ -83,8 +83,10 @@ final class AppStoreProvider: NSObject, InAppProvider {
                 switch result {
                 case .unverified(let transaction, let error):
                     log.warning("Unverified transaction: \(transaction.id) \(error)")
+                    log.debug("Finishing transaction: \(transaction.id)")
                     await transaction.finish()
                 case .verified(let transaction):
+                    log.debug("Finishing transaction: \(transaction.id)")
                     await transaction.finish()
                 }
             }

LocalPackages/PIALibrary/Sources/PIALibrary/InApp/AppStoreTransaction.swift

@@ -33,6 +33,13 @@ struct AppStoreTransaction: InAppTransaction<Transaction> {
 
     let jwsRepresentation: JWS
 
+    var isExpired: Bool {
+        if let expirationDate = native.expirationDate, expirationDate < Date.now {
+            return true
+        }
+        return false
+    }
+
     init(native: Transaction, jwsRepresentation: JWS) {
         self.native = native
         self.jwsRepresentation = jwsRepresentation

LocalPackages/PIALibrary/Sources/PIALibrary/InApp/InAppTransaction.swift

@@ -36,6 +36,11 @@ public protocol InAppTransaction<Native>: CustomStringConvertible {
     /// The underlying native transaction implementation.
     var native: Native { get }
 
+    /// Transaction has an expirationDate in the past.
+    ///
+    /// (Less than Date.now)
+    var isExpired: Bool { get }
+
     func finish() async
 }
 

LocalPackages/PIALibrary/Sources/PIALibrary/Mock/MockInAppProvider.swift

@@ -53,6 +53,8 @@ import StoreKit
 
         let native: Native = .none
 
+        let isExpired: Bool = false
+
         func finish() async {}
     }
 

PIA VPN-tvOSTests/Signup/Mocks/InAppTransactionMock.swift

@@ -14,17 +14,20 @@ final class InAppTransactionMock: InAppTransaction {
     var identifier: String
     var jwsRepresentation: JWS
     var native: Any?
+    var isExpired: Bool
     var description: String
 
     init(
         identifier: String,
         jwsRepresentation: JWS = JWS("mock-jws-transaction")!,
         native: Any? = nil,
+        isExpired: Bool = false,
         description: String
     ) {
         self.identifier = identifier
         self.jwsRepresentation = jwsRepresentation
         self.native = native
+        self.isExpired = isExpired
         self.description = description
     }
 

PIA VPN/Bootstrapper.swift

@@ -178,6 +178,8 @@ final class Bootstrapper {
                     })
             }
         #endif
+
+        Client.observeTransactions()
         Client.providers.accountProvider.subscriptionInformation { [weak self] (info, error) in
 
             if let _ = error {
@@ -197,7 +199,6 @@ final class Bootstrapper {
             }
 
             Client.refreshProducts()
-            Client.observeTransactions()
         }
 
         if (self.isSimulator || Flags.shared.usesMockVPN) {

PIA VPN/UI/GetStartedViewController.swift

@@ -223,6 +223,18 @@ final class GetStartedViewController: PIAWelcomeViewController {
                 )
             case .success(let transaction):
                 log.debug("Purchase successful with transaction id \(transaction.identifier)")
+                if transaction.isExpired {
+                    // Users in this state (unfished, expired transaction) is a weird edge case,
+                    // since we always finish all transactions. However, users still get into this state.
+                    // Finishing all transactions is fine because users can use the restore flow.
+                    log.warning("Transaction \(transaction.identifier) is expired. Finishing it and cancel purchase.")
+                    await transaction.finish()
+                    Macros.displayImageNote(
+                        withImage: Asset.iconWarning.image,
+                        message: ClientError.badReceipt.localizedDescription
+                    )
+                    return
+                }
                 self.signupEmail = email
                 self.signupTransaction = transaction
                 self.signupAttemptCount += 1

PIA VPN/UI/SignupInProgressViewController.swift

@@ -91,9 +91,6 @@ final class SignupInProgressViewController: AutolayoutViewController, BrandableN
                     topViewController: self
                 )
             } else {
-                Task {
-                    await request.transaction?.finish()
-                }
                 self.perform(segue: StoryboardSegue.Signup.successSegueIdentifier)
             }
         }