[CustomerCenter] Add action handler #4057

tonidero · 2024-07-16T16:35:04Z

Description

This PR provides a possible approach to implementing an "action" handler. This allows developer to respond to events that happen during the customer support flow.

The current approach consists of making CustomerCenterActionHandler, a lambda that receives an action that can be passed in by the developer. Then calling that with the appropriate action from the customer center. This PR also moves some code to the view model for simplicity and moving logic away from the view layer.

tonidero · 2024-07-16T16:36:03Z

RevenueCatUI/CustomerCenter/Views/RestorePurchasesAlert.swift

-                                    self.setAlertType(.purchasesNotFound)
-                                }
+                                let alertType = await self.customerCenterViewModel.performRestore() 
+                                self.setAlertType(alertType)


I tried to move all this logic to the VM since I think it makes much more sense for it to be there. We could potentially create a different view model, but it's easier to pass the CustomerCenterViewModel around... Lmk what you think!

tonidero · 2024-07-16T16:36:37Z

RevenueCatUI/CustomerCenter/Data/CustomerCenterActionHandler.swift

+public protocol CustomerCenterActionHandler {
+    @objc optional func purchaseCompleted(_ customerInfo: CustomerInfo)
+    @objc optional func restoreStarted()
+    @objc optional func restoreCompleted(_ customerInfo: CustomerInfo)


I also thought about having a single method here and a enum for the different events, but this seems simpler and less prone to breaking changes IMO. Lmk what you think!

tonidero · 2024-07-17T11:34:27Z

RevenueCatUI/CustomerCenter/Data/CustomerCenterActionHandler.swift

+import RevenueCat
+
+/// Allows to be notified of certain events the customer may perform during the Customer Center flow
+public protocol CustomerCenterActionHandler {


I've been wondering whether to rename this to CustomerCenterActionDelegate instead, since it might be more common in iOS... Wdyt?

Yes, I think that should be a Delegate. But maybe @aboedo can seal the deal since he has more iOS experience

Done in da03b7c

Hmm actually swiftlint is complaining with the new name: warning: Class Delegate Protocol Violation: Delegate protocols should be class-only so they can be weakly referenced (class_delegate_protocol). I guess this means we should mark it as @objc which would make it so we can't implement it on structs like this... I'm wondering whether to just revert the rename or follow the convention specified by swiftlint...

tonidero · 2024-07-17T11:37:25Z

RevenueCatUI/CustomerCenter/Views/RestorePurchasesAlert.swift

@@ -31,6 +31,8 @@ struct RestorePurchasesAlert: ViewModifier {
    @Environment(\.openURL)
    var openURL

+    @EnvironmentObject private var customerCenterViewModel: CustomerCenterViewModel


Made this an environment object for ease of access.

RevenueCatUI/CustomerCenter/Data/CustomerCenterActionHandler.swift

vegaro · 2024-07-17T14:55:37Z

RevenueCatUI/CustomerCenter/ViewModels/CustomerCenterViewModel.swift

+    func performRestore() async -> RestorePurchasesAlert.AlertType {
+        self.customerCenterActionHandler?.onRestoreStarted()
+        do {
+            let customerInfo = try await Purchases.shared.restorePurchases()


In order to be able to mock this easily when we start writing more tests I think we can have a purchasesProvider like the one we have in ManageSubscriptionsViewModel that has the functions that are being used in this view model. Something like:

protocol CustomerCenterPurchasesType: Sendable { @Sendable func customerInfo() async throws -> CustomerInfo @Sendable func restorePurchases() async throws -> CustomerInfo }

If we do that, we can remove the private var customerInfoFetcher: CustomerInfoFetcher in this class and mock the return of customerInfo() using a MockCustomerCenterPurchasesType

By the way the PurchasesType comes from a PaywallPurchasesType in Paywalls. That's where I got it from.

Talked about this and we are going to unify the different abstractions into a single one for CustomerCenter, since we will need a few, and it was getting complex. However, will do this on a separate PR.

vegaro · 2024-07-17T14:56:28Z

RevenueCatUI/CustomerCenter/ViewModels/ManageSubscriptionsViewModel.swift

@@ -49,27 +49,34 @@ class ManageSubscriptionsViewModel: ObservableObject {
    @Published
    private(set) var refundRequestStatusMessage: String?

-    private var purchasesProvider: ManageSubscriptionsPurchaseType
+    private let purchasesProvider: ManageSubscriptionsPurchaseType


Oopsies, I just realized this should be ManageSubscriptionsPurchasesType. I can fix it in another PR

vegaro · 2024-07-17T14:57:12Z

RevenueCatUI/CustomerCenter/Data/CustomerCenterActionHandler.swift

+import RevenueCat
+
+/// Allows to be notified of certain events the customer may perform during the Customer Center flow
+public protocol CustomerCenterActionHandler {


Yes, I think that should be a Delegate. But maybe @aboedo can seal the deal since he has more iOS experience

vegaro · 2024-07-17T14:59:51Z

RevenueCatUI/CustomerCenter/Views/RestorePurchasesAlert.swift

@@ -31,6 +31,8 @@ struct RestorePurchasesAlert: ViewModifier {
    @Environment(\.openURL)
    var openURL

+    @EnvironmentObject private var customerCenterViewModel: CustomerCenterViewModel


vegaro · 2024-07-17T15:00:04Z

RevenueCatUI/CustomerCenter/Views/RestorePurchasesAlert.swift

-                                    self.setAlertType(.purchasesNotFound)
-                                }
+                                let alertType = await self.customerCenterViewModel.performRestore() 
+                                self.setAlertType(alertType)


tonidero · 2024-07-18T11:10:18Z

Changed to a new approach where there is a single lambda parameter for the CustomerCenterView that receives an action parameter which is an enum. Lmk what you think!

RevenueCatUI/CustomerCenter/Data/CustomerCenterAction.swift

tonidero added the pr:feat A new feature label Jul 16, 2024

tonidero commented Jul 16, 2024

View reviewed changes

vegaro force-pushed the integration/customer_support_workflow branch from a910b59 to 6cd489f Compare July 17, 2024 09:24

tonidero force-pushed the customer_center/add-action-handler branch from d989594 to 0c045ee Compare July 17, 2024 11:18

tonidero commented Jul 17, 2024

View reviewed changes

tonidero marked this pull request as ready for review July 17, 2024 11:58

tonidero requested a review from a team July 17, 2024 11:59

vegaro reviewed Jul 17, 2024

View reviewed changes

tonidero marked this pull request as draft July 18, 2024 09:02

tonidero requested a review from vegaro July 18, 2024 11:09

tonidero force-pushed the customer_center/add-action-handler branch from e38d435 to 8cb5067 Compare July 18, 2024 11:13

tonidero marked this pull request as ready for review July 18, 2024 11:34

vegaro approved these changes Jul 18, 2024

View reviewed changes

RevenueCatUI/CustomerCenter/Data/CustomerCenterAction.swift Outdated Show resolved Hide resolved

RevenueCatUI/CustomerCenter/Data/CustomerCenterAction.swift Outdated Show resolved Hide resolved

tonidero added 9 commits July 18, 2024 17:05

[CustomerCenter] Add action handler

e53a382

Add more method handlers and cleanup protocol

729e887

Fix tests

b2a3124

Fix casing

4ca2df1

Remove unused member

909479f

Fix more tests

997c82c

Add missing line

174fef3

Move to pass a lambda parameter for action handler

9d482a6

Review fixes

34e4536

tonidero force-pushed the customer_center/add-action-handler branch from 523fc2d to 34e4536 Compare July 18, 2024 15:06

tonidero merged commit 2a9cd2c into integration/customer_support_workflow Jul 18, 2024
26 checks passed

tonidero deleted the customer_center/add-action-handler branch July 18, 2024 15:31

tonidero mentioned this pull request Jul 19, 2024

[Customer Center] Move No subscriptions page strings to Localization #4089

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CustomerCenter] Add action handler #4057

[CustomerCenter] Add action handler #4057

tonidero commented Jul 16, 2024 •

edited

Loading

tonidero Jul 16, 2024

vegaro Jul 17, 2024

tonidero Jul 16, 2024

tonidero Jul 17, 2024

vegaro Jul 17, 2024

tonidero Jul 17, 2024

tonidero Jul 17, 2024

tonidero Jul 17, 2024

vegaro Jul 17, 2024

vegaro Jul 17, 2024

tonidero Jul 17, 2024

vegaro Jul 17, 2024

vegaro Jul 17, 2024

vegaro Jul 17, 2024

vegaro Jul 17, 2024

tonidero commented Jul 18, 2024

[CustomerCenter] Add action handler #4057

[CustomerCenter] Add action handler #4057

Conversation

tonidero commented Jul 16, 2024 • edited Loading

Description

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tonidero commented Jul 18, 2024

tonidero commented Jul 16, 2024 •

edited

Loading