✨ Add support for post experience actions

appcues · Jul 21, 2022 · 4f01a4d · 4f01a4d
1 parent 4107dd9
commit 4f01a4d
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 4 deletions.
diff --git a/Sources/AppcuesKit/Data/Models/Experience.swift b/Sources/AppcuesKit/Data/Models/Experience.swift
@@ -60,13 +60,34 @@ internal struct Experience {
     let traits: [Trait]
     let steps: [Step]
 
+    // Post experience actions
+    let redirectURL: URL?
+    let nextContentID: String?
+
     /// Unique ID to disambiguate the same experience flowing through the system from different origins.
     let instanceID = UUID()
 }
 
 extension Experience: Decodable {
-    private enum CodingKeys: CodingKey {
-        case id, name, type, publishedAt, traits, steps
+    private enum CodingKeys: String, CodingKey {
+        case id, name, type, publishedAt, traits, steps, redirectURL = "redirectUrl", nextContentID = "nextContentId"
+    }
+}
+
+extension Experience {
+    @available(iOS 13.0, *)
+    var postExperienceActions: [ExperienceAction] {
+        var actions: [ExperienceAction] = []
+
+        if let redirectURL = redirectURL {
+            actions.append(AppcuesLinkAction(url: redirectURL))
+        }
+
+        if let nextContentID = nextContentID {
+            actions.append(AppcuesLaunchExperienceAction(experienceID: nextContentID))
+        }
+
+        return actions
     }
 }
 

diff --git a/Sources/AppcuesKit/Presentation/Actions/Appcues/AppcuesLaunchExperienceAction.swift b/Sources/AppcuesKit/Presentation/Actions/Appcues/AppcuesLaunchExperienceAction.swift
@@ -22,6 +22,10 @@ internal class AppcuesLaunchExperienceAction: ExperienceAction {
         }
     }
 
+    init(experienceID: String) {
+        self.experienceID = experienceID
+    }
+
     func execute(inContext appcues: Appcues, completion: @escaping ActionRegistry.Completion) {
         appcues.show(experienceID: experienceID) { _, _  in completion() }
     }

diff --git a/Sources/AppcuesKit/Presentation/Actions/Appcues/AppcuesLinkAction.swift b/Sources/AppcuesKit/Presentation/Actions/Appcues/AppcuesLinkAction.swift
@@ -27,6 +27,11 @@ internal class AppcuesLinkAction: ExperienceAction {
         }
     }
 
+    init(url: URL, openExternally: Bool = false) {
+        self.url = url
+        self.openExternally = openExternally
+    }
+
     func execute(inContext appcues: Appcues, completion: @escaping ActionRegistry.Completion) {
         // SFSafariViewController only supports HTTP and HTTPS URLs and crashes otherwise, so check to be safe.
         if !openExternally && ["http", "https"].contains(url.scheme?.lowercased()) {

diff --git a/Sources/AppcuesKit/Presentation/ExperienceRendering/ExperienceStateMachine+State.swift b/Sources/AppcuesKit/Presentation/ExperienceRendering/ExperienceStateMachine+State.swift
@@ -40,8 +40,12 @@ extension ExperienceStateMachine {
                 )
             case let (.endingStep(experience, currentIndex, _), .startStep(stepRef)):
                 return Transition.fromEndingStepToBeginningStep(experience, currentIndex, stepRef, traitComposer)
-            case (.endingExperience, .reset):
-                return Transition(toState: .idling)
+            case let (.endingExperience(experience, stepIndex, markComplete), .reset):
+                var sideEffect: SideEffect?
+                if markComplete || stepIndex == experience.stepIndices.last {
+                    sideEffect = .processActions(experience.postExperienceActions)
+                }
+                return Transition(toState: .idling, sideEffect: sideEffect)
 
             // Error cases
             case let (_, .startExperience(experience)):

diff --git a/Sources/AppcuesKit/Presentation/ExperienceRendering/ExperienceStateMachine.swift b/Sources/AppcuesKit/Presentation/ExperienceRendering/ExperienceStateMachine.swift
@@ -13,6 +13,7 @@ internal class ExperienceStateMachine {
 
     private let config: Appcues.Config
     private let traitComposer: TraitComposing
+    private let actionRegistry: ActionRegistry
 
     private(set) var stateObservers: [ExperienceStateObserver] = []
 
@@ -33,6 +34,7 @@ internal class ExperienceStateMachine {
     init(container: DIContainer, initialState: State = .idling) {
         config = container.resolve(Appcues.Config.self)
         traitComposer = container.resolve(TraitComposing.self)
+        actionRegistry = container.resolve(ActionRegistry.self)
 
         state = initialState
     }
@@ -214,6 +216,7 @@ extension ExperienceStateMachine {
         case navigateInContainer(ExperiencePackage, pageIndex: Int)
         case dismissContainer(ExperiencePackage, continuation: Action)
         case error(ExperienceError, reset: Bool)
+        case processActions([ExperienceAction])
 
         func execute(in machine: ExperienceStateMachine) throws {
             switch self {
@@ -233,6 +236,8 @@ extension ExperienceStateMachine {
                 if reset {
                     machine.state = .idling
                 }
+            case let .processActions(actions):
+                machine.actionRegistry.enqueue(actionInstances: actions)
             }
         }