Add donations UI and in-app error handling (#833)

- Reuse same product views from paywall
- Handle errors in fetch products
- Hide views on fetch products error
- Disable views during purchase

Closes #830

Passepartout/Library/Sources/AppUIMain/Views/About/AboutRouterView.swift

@@ -36,6 +36,9 @@ struct AboutRouterView: View {
 
     let tunnel: ExtendedTunnel
 
+    @State
+    var path = NavigationPath()
+
     @State
     var navigationRoute: NavigationRoute?
 }

Passepartout/Library/Sources/AppUIMain/Views/About/DonateView.swift

@@ -23,14 +23,137 @@
 //  along with Passepartout.  If not, see <http://www.gnu.org/licenses/>.
 //
 
+import CommonLibrary
+import CommonUtils
 import SwiftUI
 
-// FIXME: #830, UI for donations
-
 struct DonateView: View {
+
+    @EnvironmentObject
+    private var iapManager: IAPManager
+
+    @Environment(\.dismiss)
+    private var dismiss
+
+    @State
+    private var availableProducts: [InAppProduct] = []
+
+    @State
+    private var isFetchingProducts = true
+
+    @State
+    private var purchasingIdentifier: String?
+
+    @State
+    private var isThankYouPresented = false
+
+    @StateObject
+    private var errorHandler: ErrorHandler = .default()
+
     var body: some View {
-        List {
+        Form {
-        }
+            if isFetchingProducts {
-        .navigationTitle(Strings.Views.Donate.title)
+                ProgressView()
+                    .id(UUID())
+            } else if !availableProducts.isEmpty {
+                donationsView
+                    .disabled(purchasingIdentifier != nil)
+            }
+        }
+        .themeForm()
+        .navigationTitle(title)
+        .alert(
+            title,
+            isPresented: $isThankYouPresented,
+            actions: thankYouActions,
+            message: thankYouMessage
+        )
+        .task {
+            await fetchAvailableProducts()
+        }
+        .withErrorHandler(errorHandler)
+    }
+}
+
+private extension DonateView {
+    var title: String {
+        Strings.Views.Donate.title
+    }
+
+    @ViewBuilder
+    var donationsView: some View {
+#if os(macOS)
+        Section {
+            Text(Strings.Views.Donate.Sections.Main.footer)
+        }
+#endif
+        ForEach(availableProducts, id: \.productIdentifier) {
+            PaywallProductView(
+                iapManager: iapManager,
+                style: .donation,
+                product: $0,
+                purchasingIdentifier: $purchasingIdentifier,
+                onComplete: onComplete,
+                onError: onError
+            )
+        }
+        .themeSection(footer: Strings.Views.Donate.Sections.Main.footer)
+    }
+
+    func thankYouActions() -> some View {
+        Button(Strings.Global.ok) {
+            dismiss()
+        }
+    }
+
+    func thankYouMessage() -> some View {
+        Text(Strings.Views.Donate.Alerts.ThankYou.message)
+    }
+}
+
+// MARK: -
+
+private extension DonateView {
+    func fetchAvailableProducts() async {
+        isFetchingProducts = true
+        defer {
+            isFetchingProducts = false
+        }
+        do {
+            availableProducts = try await iapManager.purchasableProducts(for: AppProduct.Donations.all)
+            guard !availableProducts.isEmpty else {
+                throw AppError.emptyProducts
+            }
+        } catch {
+            onError(error, dismissing: true)
+        }
+    }
+
+    func onComplete(_ productIdentifier: String, result: InAppPurchaseResult) {
+        switch result {
+        case .done:
+            isThankYouPresented = true
+
+        case .pending:
+            dismiss()
+
+        case .cancelled:
+            break
+
+        case .notFound:
+            fatalError("Product not found: \(productIdentifier)")
+        }
+    }
+
+    func onError(_ error: Error) {
+        onError(error, dismissing: false)
+    }
+
+    func onError(_ error: Error, dismissing: Bool) {
+        errorHandler.handle(error, title: title) {
+            if dismissing {
+                dismiss()
+            }
+        }
     }
 }

Passepartout/Library/Sources/AppUIMain/Views/About/iOS/AboutRouterView+iOS.swift

@@ -30,7 +30,7 @@ import SwiftUI
 
 extension AboutRouterView {
     var body: some View {
-        NavigationStack {
+        NavigationStack(path: $path) {
             AboutView(
                 profileManager: profileManager,
                 navigationRoute: $navigationRoute

Passepartout/Library/Sources/AppUIMain/Views/About/iOS/AboutView+iOS.swift

@@ -33,10 +33,9 @@ extension AboutView {
         List {
             SettingsSectionGroup(profileManager: profileManager)
             Group {
-                // FIXME: #830, UI for donations
-//                donateLink
                 linksLink
                 creditsLink
+                donateLink
             }
             .themeSection(header: Strings.Views.About.Sections.resources)
             Section {

Passepartout/Library/Sources/AppUIMain/Views/About/macOS/AboutRouterView+macOS.swift

@@ -36,7 +36,7 @@ extension AboutRouterView {
                 navigationRoute: $navigationRoute
             )
         } detail: {
-            NavigationStack {
+            NavigationStack(path: $path) {
                 pushDestination(for: navigationRoute)
                     .navigationDestination(for: NavigationRoute.self, destination: pushDestination)
             }

Passepartout/Library/Sources/AppUIMain/Views/About/macOS/AboutView+macOS.swift

@@ -32,10 +32,9 @@ extension AboutView {
     var listView: some View {
         List(selection: $navigationRoute) {
             Section {
-                // FIXME: #830, UI for donations
-//                donateLink
                 linksLink
                 creditsLink
+                donateLink
                 diagnosticsLink
             }
         }

Passepartout/Library/Sources/AppUIMain/Views/Profile/macOS/ModuleListView+macOS.swift

@@ -49,18 +49,15 @@ struct ModuleListView: View, Routable {
                 NavigationLink(Strings.Global.general, value: ProfileSplitView.Detail.general)
                     .tag(Self.generalModuleId)
             }
-            Section {
+            Group {
                 ForEach(profileEditor.modules, id: \.id) { module in
                     NavigationLink(value: ProfileSplitView.Detail.module(id: module.id)) {
                         moduleRow(for: module)
                     }
                 }
                 .onMove(perform: moveModules)
-            } header: {
-                if !profileEditor.modules.isEmpty {
-                    Text(Strings.Global.modules)
-                }
             }
+            .themeSection(header: !profileEditor.modules.isEmpty ? Strings.Global.modules : nil)
         }
         .onDeleteCommand(perform: removeSelectedModule)
         .toolbar(content: toolbarContent)

Passepartout/Library/Sources/CommonLibrary/Domain/AppError.swift

@@ -27,6 +27,8 @@ import Foundation
 import PassepartoutKit
 
 public enum AppError: Error {
+    case emptyProducts
+
     case emptyProfileName
 
     case malformedModule(any ModuleBuilder, error: Error)

Passepartout/Library/Sources/CommonLibrary/IAP/AppProduct+Donations.swift

@@ -39,7 +39,7 @@ extension AppProduct {
 
         public static let maxi = AppProduct(donationId: "Maxi")
 
-        static let all: [AppProduct] = [
+        public static let all: [AppProduct] = [
             .Donations.tiny,
             .Donations.small,
             .Donations.medium,

Passepartout/Library/Sources/CommonLibrary/IAP/IAPManager.swift

@@ -76,7 +76,7 @@ public final class IAPManager: ObservableObject {
 // MARK: - Actions
 
 extension IAPManager {
-    public func purchasableProducts(for products: [AppProduct]) async -> [InAppProduct] {
+    public func purchasableProducts(for products: [AppProduct]) async throws -> [InAppProduct] {
         do {
             let inAppProducts = try await inAppHelper.fetchProducts()
             return products.compactMap {
@@ -84,7 +84,7 @@ extension IAPManager {
             }
         } catch {
             pp_log(.App.iap, .error, "Unable to fetch in-app products: \(error)")
-            return []
+            throw error
         }
     }
 

Passepartout/Library/Sources/UILibrary/L10n/AppError+L10n.swift

@@ -32,6 +32,9 @@ extension AppError: LocalizedError {
     public var errorDescription: String? {
         let V = Strings.Errors.App.self
         switch self {
+        case .emptyProducts:
+            return V.emptyProducts
+
         case .emptyProfileName:
             return V.emptyProfileName
 

Passepartout/Library/Sources/UILibrary/L10n/SwiftGen+Strings.swift

@@ -114,6 +114,8 @@ public enum Strings {
     public enum App {
       /// Unable to complete operation.
       public static let `default` = Strings.tr("Localizable", "errors.app.default", fallback: "Unable to complete operation.")
+      /// Unable to fetch products, please retry later.
+      public static let emptyProducts = Strings.tr("Localizable", "errors.app.empty_products", fallback: "Unable to fetch products, please retry later.")
       /// Profile name is empty.
       public static let emptyProfileName = Strings.tr("Localizable", "errors.app.empty_profile_name", fallback: "Profile name is empty.")
       /// Profile is expired.
@@ -696,6 +698,20 @@ public enum Strings {
     public enum Donate {
       /// Make a donation
       public static let title = Strings.tr("Localizable", "views.donate.title", fallback: "Make a donation")
+      public enum Alerts {
+        public enum ThankYou {
+          /// This means a lot to me and I really hope you keep using and promoting this app.
+          public static let message = Strings.tr("Localizable", "views.donate.alerts.thank_you.message", fallback: "This means a lot to me and I really hope you keep using and promoting this app.")
+        }
+      }
+      public enum Sections {
+        public enum Main {
+          /// If you want to display gratitude for my work, here are a couple amounts you can donate instantly.
+          /// 
+          /// You will only be charged once per donation, and you can donate multiple times.
+          public static let footer = Strings.tr("Localizable", "views.donate.sections.main.footer", fallback: "If you want to display gratitude for my work, here are a couple amounts you can donate instantly.\n\nYou will only be charged once per donation, and you can donate multiple times.")
+        }
+      }
     }
     public enum Profile {
       public enum ModuleList {

Passepartout/Library/Sources/UILibrary/Resources/en.lproj/Localizable.strings

@@ -155,6 +155,8 @@
 "views.about.credits.translations" = "Translations";
 
 "views.donate.title" = "Make a donation";
+"views.donate.sections.main.footer" = "If you want to display gratitude for my work, here are a couple amounts you can donate instantly.\n\nYou will only be charged once per donation, and you can donate multiple times.";
+"views.donate.alerts.thank_you.message" = "This means a lot to me and I really hope you keep using and promoting this app.";
 
 "views.diagnostics.title" = "Diagnostics";
 "views.diagnostics.sections.live" = "Live log";
@@ -252,7 +254,7 @@
 "ui.connection_status.on_demand_suffix" = " (on-demand)";
 "ui.profile_context.connect_to" = "Connect to...";
 
-// MARK: - Paywalls
+// MARK: - Paywall
 
 "paywall.sections.one_time.header" = "One-time purchase";
 "paywall.sections.recurring.header" = "All features";
@@ -287,6 +289,7 @@
 
 // MARK: - Errors
 
+"errors.app.empty_products" = "Unable to fetch products, please retry later.";
 "errors.app.empty_profile_name" = "Profile name is empty.";
 "errors.app.expired_profile" = "Profile is expired.";
 "errors.app.malformed_module" = "Module %@ is malformed. %@";

Passepartout/Library/Sources/UILibrary/Views/Paywall/CustomProductView.swift

@@ -1,5 +1,5 @@
 //
-//  PaywallView+Custom.swift
+//  CustomProductView.swift
 //  Passepartout
 //
 //  Created by Davide De Rosa on 11/7/24.
@@ -28,15 +28,17 @@ import CommonUtils
 import StoreKit
 import SwiftUI
 
-extension PaywallView {
 struct CustomProductView: View {
-        let style: ProductStyle
+    let style: PaywallProductViewStyle
 
     @ObservedObject
     var iapManager: IAPManager
 
     let product: InAppProduct
 
+    @Binding
+    var purchasingIdentifier: String?
+
     let onComplete: (String, InAppPurchaseResult) -> Void
 
     let onError: (Error) -> Void
@@ -51,11 +53,14 @@ extension PaywallView {
         }
     }
 }
-}
 
-private extension PaywallView.CustomProductView {
+private extension CustomProductView {
     func purchase() {
+        purchasingIdentifier = product.productIdentifier
         Task {
+            defer {
+                purchasingIdentifier = nil
+            }
             do {
                 let result = try await iapManager.purchase(product)
                 onComplete(product.productIdentifier, result)

Passepartout/Library/Sources/UILibrary/Views/Paywall/PaywallProductView.swift

@@ -0,0 +1,82 @@
+//
+//  Empty.swift
+//  Passepartout
+//
+//  Created by Davide De Rosa on 11/7/24.
+//  Copyright (c) 2024 Davide De Rosa. All rights reserved.
+//
+//  https://github.com/passepartoutvpn
+//
+//  This file is part of Passepartout.
+//
+//  Passepartout is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  Passepartout is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with Passepartout.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+import CommonLibrary
+import CommonUtils
+import SwiftUI
+
+public struct PaywallProductView: View {
+
+    @ObservedObject
+    private var iapManager: IAPManager
+
+    private let style: PaywallProductViewStyle
+
+    private let product: InAppProduct
+
+    @Binding
+    private var purchasingIdentifier: String?
+
+    private let onComplete: (String, InAppPurchaseResult) -> Void
+
+    private let onError: (Error) -> Void
+
+    public init(
+        iapManager: IAPManager,
+        style: PaywallProductViewStyle,
+        product: InAppProduct,
+        purchasingIdentifier: Binding<String?>,
+        onComplete: @escaping (String, InAppPurchaseResult) -> Void,
+        onError: @escaping (Error) -> Void
+    ) {
+        self.iapManager = iapManager
+        self.style = style
+        self.product = product
+        _purchasingIdentifier = purchasingIdentifier
+        self.onComplete = onComplete
+        self.onError = onError
+    }
+
+    public var body: some View {
+        if #available(iOS 17, macOS 14, *) {
+            StoreKitProductView(
+                style: style,
+                product: product,
+                purchasingIdentifier: $purchasingIdentifier,
+                onComplete: onComplete,
+                onError: onError
+            )
+        } else {
+            CustomProductView(
+                style: style,
+                iapManager: iapManager,
+                product: product,
+                purchasingIdentifier: $purchasingIdentifier,
+                onComplete: onComplete,
+                onError: onError
+            )
+        }
+    }
+}

Passepartout/Library/Sources/UILibrary/Views/Paywall/PaywallProductViewStyle.swift

@@ -0,0 +1,34 @@
+//
+//  PaywallProductViewStyle.swift
+//  Passepartout
+//
+//  Created by Davide De Rosa on 11/7/24.
+//  Copyright (c) 2024 Davide De Rosa. All rights reserved.
+//
+//  https://github.com/passepartoutvpn
+//
+//  This file is part of Passepartout.
+//
+//  Passepartout is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  Passepartout is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with Passepartout.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+import Foundation
+
+public enum PaywallProductViewStyle {
+    case oneTime
+
+    case recurring
+
+    case donation
+}

Passepartout/Library/Sources/UILibrary/Views/Paywall/PaywallView.swift

@@ -29,11 +29,6 @@ import StoreKit
 import SwiftUI
 
 struct PaywallView: View {
-    enum ProductStyle {
-        case oneTime
-
-        case recurring
-    }
 
     @EnvironmentObject
     private var iapManager: IAPManager
@@ -45,9 +40,6 @@ struct PaywallView: View {
 
     let suggestedProduct: AppProduct?
 
-    @State
-    private var isFetchingProducts = true
-
     @State
     private var oneTimeProduct: InAppProduct?
 
@@ -55,7 +47,13 @@ struct PaywallView: View {
     private var recurringProducts: [InAppProduct] = []
 
     @State
-    private var isPendingPresented = false
+    private var isFetchingProducts = true
+
+    @State
+    private var purchasingIdentifier: String?
+
+    @State
+    private var isPurchasePendingConfirmation = false
 
     @StateObject
     private var errorHandler: ErrorHandler = .default()
@@ -65,17 +63,20 @@ struct PaywallView: View {
             if isFetchingProducts {
                 ProgressView()
                     .id(UUID())
-            } else {
+            } else if !recurringProducts.isEmpty {
+                Group {
                     productsView
                     subscriptionFeaturesView
                     restoreView
                 }
+                .disabled(purchasingIdentifier != nil)
+            }
         }
         .themeForm()
         .toolbar(content: toolbarContent)
         .alert(
             Strings.Global.purchase,
-            isPresented: $isPendingPresented,
+            isPresented: $isPurchasePendingConfirmation,
             actions: pendingActions,
             message: pendingMessage
         )
@@ -100,11 +101,25 @@ private extension PaywallView {
     @ViewBuilder
     var productsView: some View {
         oneTimeProduct.map {
-            productView(.oneTime, for: $0)
+            PaywallProductView(
+                iapManager: iapManager,
+                style: .oneTime,
+                product: $0,
+                purchasingIdentifier: $purchasingIdentifier,
+                onComplete: onComplete,
+                onError: onError
+            )
             .themeSection(header: Strings.Paywall.Sections.OneTime.header)
         }
         ForEach(recurringProducts, id: \.productIdentifier) {
-            productView(.recurring, for: $0)
+            PaywallProductView(
+                iapManager: iapManager,
+                style: .recurring,
+                product: $0,
+                purchasingIdentifier: $purchasingIdentifier,
+                onComplete: onComplete,
+                onError: onError
+            )
         }
         .themeSection(header: Strings.Paywall.Sections.Recurring.header)
     }
@@ -124,28 +139,8 @@ private extension PaywallView {
     }
 #endif
 
-    @ViewBuilder
-    func productView(_ style: ProductStyle, for product: InAppProduct) -> some View {
-        if #available(iOS 17, macOS 14, *) {
-            StoreKitProductView(
-                style: style,
-                product: product,
-                onComplete: onComplete,
-                onError: onError
-            )
-        } else {
-            CustomProductView(
-                style: style,
-                iapManager: iapManager,
-                product: product,
-                onComplete: onComplete,
-                onError: onError
-            )
-        }
-    }
-
     var restoreView: some View {
-        RestorePurchasesButton()
+        RestorePurchasesButton(errorHandler: errorHandler)
             .themeSectionWithSingleRow(
                 header: Strings.Paywall.Sections.Restore.header,
                 footer: Strings.Paywall.Sections.Restore.footer,
@@ -183,6 +178,9 @@ private extension PaywallView {
 private extension PaywallView {
     func fetchAvailableProducts() async {
         isFetchingProducts = true
+        defer {
+            isFetchingProducts = false
+        }
 
         var list: [AppProduct] = []
         if let suggestedProduct {
@@ -191,7 +189,11 @@ private extension PaywallView {
         list.append(.Full.Recurring.yearly)
         list.append(.Full.Recurring.monthly)
 
-        let availableProducts = await iapManager.purchasableProducts(for: list)
+        do {
+            let availableProducts = try await iapManager.purchasableProducts(for: list)
+            guard !availableProducts.isEmpty else {
+                throw AppError.emptyProducts
+            }
             oneTimeProduct = availableProducts.first {
                 guard let suggestedProduct else {
                     return false
@@ -201,8 +203,9 @@ private extension PaywallView {
             recurringProducts = availableProducts.filter {
                 $0.productIdentifier != oneTimeProduct?.productIdentifier
             }
-
+        } catch {
-        isFetchingProducts = false
+            onError(error, dismissing: true)
+        }
     }
 
     func onComplete(_ productIdentifier: String, result: InAppPurchaseResult) {
@@ -211,7 +214,7 @@ private extension PaywallView {
             isPresented = false
 
         case .pending:
-            isPendingPresented = true
+            isPurchasePendingConfirmation = true
 
         case .cancelled:
             break
@@ -222,7 +225,15 @@ private extension PaywallView {
     }
 
     func onError(_ error: Error) {
-        errorHandler.handle(error, title: Strings.Global.purchase)
+        onError(error, dismissing: false)
+    }
+
+    func onError(_ error: Error, dismissing: Bool) {
+        errorHandler.handle(error, title: Strings.Global.purchase) {
+            if dismissing {
+                isPresented = false
+            }
+        }
     }
 }
 

Passepartout/Library/Sources/UILibrary/Views/Paywall/RestorePurchasesButton.swift

@@ -24,6 +24,7 @@
 //
 
 import CommonLibrary
+import CommonUtils
 import SwiftUI
 
 public struct RestorePurchasesButton: View {
@@ -31,14 +32,28 @@ public struct RestorePurchasesButton: View {
     @EnvironmentObject
     private var iapManager: IAPManager
 
-    public init() {
+    @ObservedObject
+    private var errorHandler: ErrorHandler
+
+    public init(errorHandler: ErrorHandler) {
+        self.errorHandler = errorHandler
     }
 
     public var body: some View {
-        Button(Strings.Paywall.Rows.restorePurchases) {
+        Button(title) {
             Task {
+                do {
                     try await iapManager.restorePurchases()
+                } catch {
+                    errorHandler.handle(error, title: title)
                 }
             }
         }
     }
+}
+
+private extension RestorePurchasesButton {
+    var title: String {
+        Strings.Paywall.Rows.restorePurchases
+    }
+}

Passepartout/Library/Sources/UILibrary/Views/Paywall/StoreKitProductView.swift

@@ -1,5 +1,5 @@
 //
-//  PaywallView+StoreKit.swift
+//  StoreKitProductView.swift
 //  Passepartout
 //
 //  Created by Davide De Rosa on 11/7/24.
@@ -28,19 +28,24 @@ import StoreKit
 import SwiftUI
 
 @available(iOS 17, macOS 14, *)
-extension PaywallView {
 struct StoreKitProductView: View {
-        let style: ProductStyle
+    let style: PaywallProductViewStyle
 
     let product: InAppProduct
 
+    @Binding
+    var purchasingIdentifier: String?
+
     let onComplete: (String, InAppPurchaseResult) -> Void
 
     let onError: (Error) -> Void
 
     var body: some View {
         ProductView(id: product.productIdentifier)
-                .productViewStyle(.compact)
+            .productViewStyle(style.toStoreKitStyle)
+            .onInAppPurchaseStart { _ in
+                purchasingIdentifier = product.productIdentifier
+            }
             .onInAppPurchaseCompletion { skProduct, result in
                 do {
                     let skResult = try result.get()
@@ -48,9 +53,19 @@ extension PaywallView {
                 } catch {
                     onError(error)
                 }
+                purchasingIdentifier = nil
             }
     }
 }
+
+@available(iOS 17, macOS 14, *)
+private extension PaywallProductViewStyle {
+    var toStoreKitStyle: some ProductViewStyle {
+        switch self {
+        case .oneTime, .recurring, .donation:
+            return .compact
+        }
+    }
 }
 
 private extension Product.PurchaseResult {