🏗 Refactor ExperienceRenderer to support multiple ExperienceStateMach…

…ine instances for non-modal Experiences There is one sharedStateMachine for modal experiences and a mapping by experience ID to state machine for non-modal.
appcues · Jun 14, 2023 · 6972b97 · 6972b97
1 parent d945dff
commit 6972b97
Show file tree

Hide file tree

Showing 20 changed files with 288 additions and 77 deletions.
diff --git a/Sources/AppcuesKit/Data/Extensions/Collection+Custom.swift b/Sources/AppcuesKit/Data/Extensions/Collection+Custom.swift
@@ -0,0 +1,27 @@
+//
+//  Collection+Custom.swift
+//  AppcuesKit
+//
+//  Created by Matt on 2022-04-28.
+//  Copyright © 2022 Appcues. All rights reserved.
+//
+
+import Foundation
+
+extension Collection {
+    func separate(predicate: (Iterator.Element) -> Bool) -> (matching: [Iterator.Element], notMatching: [Iterator.Element]) {
+        var separated: ([Iterator.Element], [Iterator.Element]) = ([], [])
+        for element in self {
+            if predicate(element) {
+                separated.0.append(element)
+            } else {
+                separated.1.append(element)
+            }
+        }
+        return separated
+    }
+
+    subscript (safe index: Index) -> Element? {
+        return indices.contains(index) ? self[index] : nil
+    }
+}
diff --git a/Sources/AppcuesKit/Data/Extensions/Collection+SafeIndex.swift b/Sources/AppcuesKit/Data/Extensions/Collection+SafeIndex.swift
diff --git a/Sources/AppcuesKit/Data/Models/Experience.swift b/Sources/AppcuesKit/Data/Models/Experience.swift
@@ -95,6 +95,10 @@ internal protocol PluginDecoder {
     func decode<T: Decodable>(_ type: T.Type) -> T?
 }
 
+internal struct InstanceID: Identifiable, Hashable {
+    let id = UUID()
+}
+
 internal struct Experience {
 
     @dynamicMemberLookup
@@ -145,7 +149,7 @@ internal struct Experience {
     let nextContentID: String?
 
     /// Unique ID to disambiguate the same experience flowing through the system from different origins.
-    let instanceID = UUID()
+    let instanceID = InstanceID()
 }
 
 extension Experience: Decodable {
@@ -187,6 +191,7 @@ extension Experience {
             if let nextContentID = nextContentID {
                 actions.append(AppcuesLaunchExperienceAction(
                     appcues: appcues,
+                    currentExperienceID: instanceID,
                     experienceID: nextContentID,
                     trigger: .experienceCompletionAction(fromExperienceID: self.id)
                 ))

diff --git a/Sources/AppcuesKit/Presentation/Actions/ActionRegistry.swift b/Sources/AppcuesKit/Presentation/Actions/ActionRegistry.swift
@@ -65,9 +65,9 @@ internal class ActionRegistry {
 
     /// Enqueue an array of experience action data models to be executed. This version is for non-interactive action execution,
     /// such as actions that execute as part of the navigation to a step.
-    func enqueue(actionModels: [Experience.Action], level: AppcuesExperiencePluginConfiguration.Level, completion: @escaping () -> Void) {
+    func enqueue(actionModels: [Experience.Action], level: AppcuesExperiencePluginConfiguration.Level, experienceID: InstanceID?, completion: @escaping () -> Void) {
         let actionInstances = actionModels.compactMap {
-            actions[$0.type]?.init(configuration: AppcuesExperiencePluginConfiguration($0.configDecoder, level: level, appcues: appcues))
+            actions[$0.type]?.init(configuration: AppcuesExperiencePluginConfiguration($0.configDecoder, level: level, experienceID: experienceID, appcues: appcues))
         }
         execute(transformQueue(actionInstances), completion: completion)
     }
@@ -84,18 +84,20 @@ internal class ActionRegistry {
     func enqueue(
         actionModels: [Experience.Action],
         level: AppcuesExperiencePluginConfiguration.Level,
+        experienceID: InstanceID?,
         interactionType: String,
         viewDescription: String?
     ) {
         let actionInstances = actionModels.compactMap {
-            actions[$0.type]?.init(configuration: AppcuesExperiencePluginConfiguration($0.configDecoder, level: level, appcues: appcues))
+            actions[$0.type]?.init(configuration: AppcuesExperiencePluginConfiguration($0.configDecoder, level: level, experienceID: experienceID, appcues: appcues))
         }
 
         // As a heuristic, take the last action that's `InteractionLoggingAction`, since that's most likely
         // to be the action that we'd want to see in the event export.
         let primaryAction = actionInstances.reversed().compactMapFirst { $0 as? InteractionLoggingAction }
         let interactionAction = AppcuesStepInteractionAction(
             appcues: appcues,
+            experienceID: experienceID,
             interactionType: interactionType,
             viewDescription: viewDescription ?? "",
             category: primaryAction?.category ?? "",

diff --git a/Sources/AppcuesKit/Presentation/Actions/Appcues/AppcuesCloseAction.swift b/Sources/AppcuesKit/Presentation/Actions/Appcues/AppcuesCloseAction.swift
@@ -18,11 +18,13 @@ internal class AppcuesCloseAction: AppcuesExperienceAction {
     static let type = "@appcues/close"
 
     private weak var appcues: Appcues?
+    private let experienceID: InstanceID?
 
     private let markComplete: Bool
 
     required init?(configuration: AppcuesExperiencePluginConfiguration) {
         appcues = configuration.appcues
+        experienceID = configuration.experienceID
 
         let config = configuration.decode(Config.self)
         markComplete = config?.markComplete ?? false
@@ -32,6 +34,6 @@ internal class AppcuesCloseAction: AppcuesExperienceAction {
         guard let appcues = appcues else { return completion() }
 
         let experienceRenderer = appcues.container.resolve(ExperienceRendering.self)
-        experienceRenderer.dismissCurrentExperience(markComplete: markComplete) { _ in completion() }
+        experienceRenderer.dismiss(experienceID: experienceID, markComplete: markComplete) { _ in completion() }
     }
 }
diff --git a/Sources/AppcuesKit/Presentation/Actions/Appcues/AppcuesContinueAction.swift b/Sources/AppcuesKit/Presentation/Actions/Appcues/AppcuesContinueAction.swift
@@ -19,11 +19,13 @@ internal class AppcuesContinueAction: AppcuesExperienceAction {
     static let type = "@appcues/continue"
 
     private weak var appcues: Appcues?
+    private let experienceID: InstanceID?
 
     let stepReference: StepReference
 
     required init?(configuration: AppcuesExperiencePluginConfiguration) {
         appcues = configuration.appcues
+        experienceID = configuration.experienceID
 
         let config = configuration.decode(Config.self)
         if let index = config?.index {
@@ -42,6 +44,6 @@ internal class AppcuesContinueAction: AppcuesExperienceAction {
         guard let appcues = appcues else { return completion() }
 
         let experienceRenderer = appcues.container.resolve(ExperienceRendering.self)
-        experienceRenderer.show(stepInCurrentExperience: stepReference, completion: completion)
+        experienceRenderer.show(step: stepReference, experienceID: experienceID, completion: completion)
     }
 }
diff --git a/Sources/AppcuesKit/Presentation/Actions/Appcues/AppcuesLaunchExperienceAction.swift b/Sources/AppcuesKit/Presentation/Actions/Appcues/AppcuesLaunchExperienceAction.swift
@@ -17,21 +17,24 @@ internal class AppcuesLaunchExperienceAction: AppcuesExperienceAction {
     static let type = "@appcues/launch-experience"
 
     private weak var appcues: Appcues?
+    private let currentExperienceID: InstanceID?
 
-    let experienceID: String
+    let launchExperienceID: String
     private let trigger: ExperienceTrigger?
 
     required init?(configuration: AppcuesExperiencePluginConfiguration) {
         self.appcues = configuration.appcues
 
         guard let config = configuration.decode(Config.self) else { return nil }
-        self.experienceID = config.experienceID
+        self.currentExperienceID = configuration.experienceID
+        self.launchExperienceID = config.experienceID
         self.trigger = nil
     }
 
-    init(appcues: Appcues?, experienceID: String, trigger: ExperienceTrigger) {
+    init(appcues: Appcues?, currentExperienceID: InstanceID?, experienceID: String, trigger: ExperienceTrigger) {
         self.appcues = appcues
-        self.experienceID = experienceID
+        self.currentExperienceID = currentExperienceID
+        self.launchExperienceID = experienceID
 
         // This is used when a flow is triggered as a post flow action from another flow.
         // The trigger value is set during the StateMachine processing of the post-flow actions.
@@ -50,14 +53,15 @@ internal class AppcuesLaunchExperienceAction: AppcuesExperienceAction {
         // that launches another flow from a button, for example.
         let trigger = self.trigger ?? launchExperienceTrigger(appcues)
 
-        experienceLoading.load(experienceID: experienceID, published: true, trigger: trigger) { _  in
+        experienceLoading.load(experienceID: launchExperienceID, published: true, trigger: trigger) { _  in
             completion()
         }
     }
 
     private func launchExperienceTrigger(_ appcues: Appcues) -> ExperienceTrigger {
         let experienceRendering = appcues.container.resolve(ExperienceRendering.self)
-        let currentExperienceId = experienceRendering.getCurrentExperienceData()?.id
-        return .launchExperienceAction(fromExperienceID: currentExperienceId)
+        // Self.currentExperienceID is the instance ID, but we want Experience.id
+        let experienceID = experienceRendering.experienceData(experienceID: currentExperienceID)?.id
+        return .launchExperienceAction(fromExperienceID: experienceID)
     }
 }
diff --git a/Sources/AppcuesKit/Presentation/Actions/Appcues/AppcuesStepInteractionAction.swift b/Sources/AppcuesKit/Presentation/Actions/Appcues/AppcuesStepInteractionAction.swift
@@ -15,6 +15,7 @@ internal class AppcuesStepInteractionAction: AppcuesExperienceAction {
     static let type = "@appcues/step_interaction"
 
     private weak var appcues: Appcues?
+    private let experienceID: InstanceID?
 
     let interactionType: String
     let viewDescription: String
@@ -26,8 +27,16 @@ internal class AppcuesStepInteractionAction: AppcuesExperienceAction {
         return nil
     }
 
-    init(appcues: Appcues?, interactionType: String, viewDescription: String, category: String, destination: String) {
+    init(
+        appcues: Appcues?,
+        experienceID: InstanceID?,
+        interactionType: String,
+        viewDescription: String,
+        category: String,
+        destination: String
+    ) {
         self.appcues = appcues
+        self.experienceID = experienceID
         self.interactionType = interactionType
         self.viewDescription = viewDescription
         self.category = category
@@ -49,8 +58,8 @@ internal class AppcuesStepInteractionAction: AppcuesExperienceAction {
             ]
         ]
 
-        if let experienceData = experienceRenderer.getCurrentExperienceData(),
-           let stepIndex = experienceRenderer.getCurrentStepIndex() {
+        if let experienceData = experienceRenderer.experienceData(experienceID: experienceID),
+           let stepIndex = experienceRenderer.stepIndex(experienceID: experienceID) {
             interactionProperties = LifecycleEvent.properties(experienceData, stepIndex).merging(interactionProperties)
         }
 

diff --git a/Sources/AppcuesKit/Presentation/Actions/Appcues/AppcuesSubmitFormAction.swift b/Sources/AppcuesKit/Presentation/Actions/Appcues/AppcuesSubmitFormAction.swift
@@ -17,11 +17,13 @@ internal class AppcuesSubmitFormAction: AppcuesExperienceAction, ExperienceActio
     static let type = "@appcues/submit-form"
 
     private weak var appcues: Appcues?
+    private let experienceID: InstanceID?
 
     let skipValidation: Bool
 
     required init?(configuration: AppcuesExperiencePluginConfiguration) {
         self.appcues = configuration.appcues
+        self.experienceID = configuration.experienceID
 
         let config = configuration.decode(Config.self)
         self.skipValidation = config?.skipValidation ?? false
@@ -37,8 +39,8 @@ internal class AppcuesSubmitFormAction: AppcuesExperienceAction, ExperienceActio
         let experienceRenderer = appcues.container.resolve(ExperienceRendering.self)
         let analyticsPublisher = appcues.container.resolve(AnalyticsPublishing.self)
 
-        guard let experienceData = experienceRenderer.getCurrentExperienceData(),
-              let stepIndex = experienceRenderer.getCurrentStepIndex(),
+        guard let experienceData = experienceRenderer.experienceData(experienceID: experienceID),
+              let stepIndex = experienceRenderer.stepIndex(experienceID: experienceID),
               let stepState = experienceData.state(for: stepIndex) else { return }
 
         let interactionProperties = LifecycleEvent.properties(experienceData, stepIndex).merging([
@@ -66,8 +68,8 @@ internal class AppcuesSubmitFormAction: AppcuesExperienceAction, ExperienceActio
 
         let experienceRenderer = appcues.container.resolve(ExperienceRendering.self)
 
-        guard let experienceData = experienceRenderer.getCurrentExperienceData(),
-              let stepIndex = experienceRenderer.getCurrentStepIndex(),
+        guard let experienceData = experienceRenderer.experienceData(experienceID: experienceID),
+              let stepIndex = experienceRenderer.stepIndex(experienceID: experienceID),
               let stepState = experienceData.state(for: stepIndex) else { return queue }
 
         if stepState.stepFormIsComplete {

diff --git a/Sources/AppcuesKit/Presentation/Actions/InteractionLoggingAction.swift b/Sources/AppcuesKit/Presentation/Actions/InteractionLoggingAction.swift
@@ -25,7 +25,7 @@ extension AppcuesLinkAction: InteractionLoggingAction {
 @available(iOS 13.0, *)
 extension AppcuesLaunchExperienceAction: InteractionLoggingAction {
     var category: String { "internal" }
-    var destination: String { experienceID }
+    var destination: String { launchExperienceID }
 }
 
 @available(iOS 13.0, *)

diff --git a/Sources/AppcuesKit/Presentation/Debugger/UIDebugger.swift b/Sources/AppcuesKit/Presentation/Debugger/UIDebugger.swift
@@ -151,8 +151,8 @@ extension UIDebugger: DebugViewDelegate {
     }
 
     private func captureScreen(authorization: Authorization) {
-        guard experienceRenderer.getCurrentExperienceData() == nil else {
-            experienceRenderer.dismissCurrentExperience(markComplete: false) { _ in
+        guard experienceRenderer.experienceData(experienceID: nil) == nil else {
+            experienceRenderer.dismiss(experienceID: nil, markComplete: false) { _ in
                 self.captureScreen(authorization: authorization)
             }
             return