Fix handling engagement ended flow

This commit introduces `endedEngagement` property in Interactor for storing engagement ended by operator to fetch a survey

MOB-3897

GliaWidgets/Public/Glia/Glia.swift

@@ -437,10 +437,7 @@ public class Glia {
             return
         }
 
-        interactor?.endSession(
-            success: { completion(.success(())) },
-            failure: { completion(.failure($0)) }
-        )
+        interactor?.endSession(completion: completion)
     }
 
     /// List all queues of the configured site. It is also possible to monitor queues changes with

GliaWidgets/Sources/CallVisualizer/CallVisualizer.swift

@@ -107,14 +107,8 @@ extension CallVisualizer {
 
     func endSession() {
         coordinator.end()
-        environment.interactorProviding()?.endSession(
-            success: { [weak self] in
-                self?.delegate?(.engagementEnded)
-            },
-            failure: { [weak self] _ in
-                self?.delegate?(.engagementEnded)
-            }
-        )
+        environment.interactorProviding()?.cleanup()
+        delegate?(.engagementEnded)
     }
 
     func handleRestoredEngagement() {
@@ -132,7 +126,7 @@ extension CallVisualizer {
     func startObservingInteractorEvents() {
         environment.interactorProviding()?.addObserver(self) { [weak self] event in
             if case .stateChanged(.ended(.byOperator)) = event,
-               let endedEngagement = self?.environment.interactorProviding()?.currentEngagement,
+               let endedEngagement = self?.environment.interactorProviding()?.endedEngagement,
                endedEngagement.source == .callVisualizer {
                 self?.endSession()
                 self?.environment.log.prefixed(Self.self).info("Call visualizer engagement ended")

GliaWidgets/Sources/CallVisualizer/Coordinator/CallVisualizer.Coordinator.swift

@@ -217,10 +217,7 @@ extension CallVisualizer.Coordinator {
 
 extension CallVisualizer.Coordinator {
     func declineEngagement() {
-        environment.interactorProviding?.endEngagement(
-            success: {},
-            failure: { _ in }
-        )
+        environment.interactorProviding?.endEngagement { _ in }
         end()
     }
 

GliaWidgets/Sources/Coordinators/EngagementCoordinator/EngagementCoordinator.swift

@@ -199,7 +199,7 @@ extension EngagementCoordinator {
             }
         }
 
-        guard let engagement = interactor.currentEngagement, surveyPresentation == .presentSurvey else {
+        guard let engagement = interactor.endedEngagement, surveyPresentation == .presentSurvey else {
             dismissGliaViewController()
             return
         }

GliaWidgets/Sources/Interactor/Interactor.swift

@@ -60,6 +60,9 @@ class Interactor {
     let visitorContext: Configuration.VisitorContext?
     @Published private(set) var currentEngagement: CoreSdkClient.Engagement?
 
+    // Used to save engagement ended by operator to fetch a survey
+    private(set) var endedEngagement: CoreSdkClient.Engagement?
+
     private var observers = [() -> (AnyObject?, EventHandler)]()
 
     var state: InteractorState = .none {
@@ -175,64 +178,63 @@ extension Interactor {
         environment.coreSdk.sendMessageWithMessagePayload(messagePayload, completion)
     }
 
-    func endSession(
-        success: @escaping () -> Void,
-        failure: @escaping (CoreSdkClient.SalemoveError) -> Void
-    ) {
+    func endSession(completion: @escaping (Result<Void, Error>) -> Void) {
         switch state {
         case .none:
-            success()
+            completion(.success(()))
         case .enqueueing:
             state = .ended(.byVisitor)
-            success()
+            completion(.success(()))
         case .enqueued(let ticket):
             exitQueue(
                 ticket: ticket,
-                success: success,
-                failure: failure
+                completion: completion
             )
         case .engaged:
-            endEngagement(
-                success: success,
-                failure: failure
-            )
-        case .ended(let reason):
-            state = .ended(reason)
-            success()
+            endEngagement(completion: completion)
+        case .ended:
+            completion(.success(()))
+
+            // `cleanup` is called once survey fetching is already initiated,
+            // so no need to store `endedEngagement` anymore.
+            cleanup()
         }
     }
 
     func exitQueue(
         ticket: CoreSdkClient.QueueTicket,
-        success: @escaping () -> Void,
-        failure: @escaping (CoreSdkClient.SalemoveError) -> Void
-    ) {
+        completion: @escaping (Result<Void, Error>) -> Void
+) {
         environment.log.prefixed(Self.self).info("Cancel queue ticket")
         environment.coreSdk.cancelQueueTicket(ticket) { [weak self] _, error in
             if let error = error {
-                failure(error)
+                completion(.failure(error))
             } else {
                 self?.state = .ended(.byVisitor)
-                success()
+                completion(.success(()))
             }
         }
     }
 
-    func endEngagement(
-        success: @escaping () -> Void,
-        failure: @escaping (CoreSdkClient.SalemoveError) -> Void
-    ) {
+    func endEngagement(completion: @escaping (Result<Void, Error>) -> Void) {
         environment.coreSdk.endEngagement { [weak self] _, error in
             if let error = error {
-                failure(error)
+                completion(.failure(error))
             } else {
                 self?.state = .ended(.byVisitor)
-                success()
+                completion(.success(()))
             }
         }
     }
+
+    func cleanup() {
+        state = .none
+        endedEngagement = nil
+    }
 }
 
+// MARK: - Interactable
+
 extension Interactor: CoreSdkClient.Interactable {
     var onEngagementChanged: CoreSdkClient.EngagementChangedBlock {
         return { [weak self] engagement in
@@ -380,11 +382,12 @@ extension Interactor: CoreSdkClient.Interactable {
     }
 
     func end(with reason: CoreSdkClient.EngagementEndingReason) {
-        currentEngagement = environment.coreSdk.getCurrentEngagement()
         switch reason {
         case .visitorHungUp:
             state = .ended(.byVisitor)
         case .operatorHungUp, .followUp:
+            // Save engagement ended by operator to fetch a survey
+            endedEngagement = environment.coreSdk.getCurrentEngagement()
             state = .ended(.byOperator)
         case .error:
             state = .ended(.byError)
@@ -423,5 +426,9 @@ extension Interactor {
     func setCurrentEngagement(_ engagement: CoreSdkClient.Engagement?) {
         currentEngagement = engagement
     }
+
+    func setEndedEngagement(_ engagement: CoreSdkClient.Engagement?) {
+        endedEngagement = engagement
+    }
 }
 #endif

GliaWidgets/Sources/ViewModel/EngagementViewModel.swift

@@ -60,7 +60,7 @@ class EngagementViewModel: CommonEngagementModel {
 
     func viewWillAppear() {
         if interactor.state == .ended(.byOperator) {
-            interactor.currentEngagement?.getSurvey { [weak self] result in
+            interactor.endedEngagement?.getSurvey { [weak self] result in
                 guard let self = self else { return }
                 switch result {
                 case .success(let survey) where survey != nil:
@@ -121,9 +121,8 @@ class EngagementViewModel: CommonEngagementModel {
                     operatorImageUrl: nil
                 )
             )
-            engagementDelegate?(.finished)
         case .ended(let reason) where reason == .byOperator:
-            interactor.currentEngagement?.getSurvey(completion: { [weak self] result in
+            interactor.endedEngagement?.getSurvey(completion: { [weak self] result in
                 guard let self = self else { return }
                 guard case .success(let survey) = result, survey == nil else {
                     self.endSession()
@@ -174,12 +173,10 @@ class EngagementViewModel: CommonEngagementModel {
     }
 
     func endSession() {
-        interactor.endSession { [weak self] in
-            self?.engagementDelegate?(.finished)
-        } failure: { [weak self] _ in
+        interactor.endSession { [weak self] _ in
             self?.engagementDelegate?(.finished)
         }
-        self.screenShareHandler.stop(nil)
+        screenShareHandler.stop(nil)
     }
 
     func conditionallyEndSession() {

GliaWidgetsTests/Sources/Coordinators/EngagementCoordinator/EngagementCoordinator+SurveyTests.swift

@@ -11,7 +11,7 @@ class EngagementCoordinatorSurveyTests: XCTestCase {
             media: .init(audio: .none, video: .oneWay)
         )
         let interactor = Interactor.mock(environment: .init(coreSdk: coreSdkClient, queuesMonitor: .mock(), gcd: .failing, log: .failing))
-        interactor.setCurrentEngagement(engagement)
+        interactor.setEndedEngagement(engagement)
         var alertManagerEnv = AlertManager.Environment.failing()
         var log = CoreSdkClient.Logger.failing
         log.prefixedClosure = { _ in log }

GliaWidgetsTests/Sources/Coordinators/EngagementCoordinator/EngagementCoordinatorTests.swift

@@ -115,7 +115,7 @@ final class EngagementCoordinatorTests: XCTestCase {
     func test_endChatWithSurvey() throws {
         let survey: CoreSdkClient.Survey = try .mock()
         let engagement: CoreSdkClient.Engagement = .mock(fetchSurvey: { _, completion in completion(.success(survey)) })
-        coordinator.interactor.setCurrentEngagement(engagement)
+        coordinator.interactor.setEndedEngagement(engagement)
         coordinator.end()
 
         let surveyViewController = coordinator.gliaPresenter.topMostViewController as? Survey.ViewController

GliaWidgetsTests/Sources/Glia/GliaTests.swift

@@ -157,7 +157,7 @@ final class GliaTests: XCTestCase {
             theme: .mock()
         ) { _ in }
 
-        sdk.interactor?.setCurrentEngagement(.mock(source: .callVisualizer))
+        sdk.interactor?.setEndedEngagement(.mock(source: .callVisualizer))
         sdk.interactor?.state = .ended(.byOperator)
 
         XCTAssertEqual(calls, [.onEvent(.ended)])
@@ -202,7 +202,7 @@ final class GliaTests: XCTestCase {
 
         XCTAssertEqual(calls, [])
 
-        sdk.interactor?.setCurrentEngagement(.mock(source: .callVisualizer))
+        sdk.interactor?.setEndedEngagement(.mock(source: .callVisualizer))
         sdk.interactor?.state = .ended(.byOperator)
 
         /// Since interactor is created only after visitor code is requested, 
@@ -247,9 +247,9 @@ final class GliaTests: XCTestCase {
             with: .mock(),
             theme: .mock()
         ) { _ in }
-        sdk.interactor?.setCurrentEngagement(.mock(source: .callVisualizer))
 
         sdk.callVisualizer.coordinator.showEndScreenSharingViewController()
+        sdk.interactor?.setEndedEngagement(.mock(source: .callVisualizer))
         sdk.interactor?.state = .ended(.byOperator)
 
         XCTAssertEqual(calls, [.onEvent(.minimized), .onEvent(.ended)])
@@ -295,9 +295,9 @@ final class GliaTests: XCTestCase {
             with: .mock(),
             theme: .mock()
         ) { _ in }
-        sdk.interactor?.setCurrentEngagement(.mock(source: .callVisualizer))
 
         sdk.callVisualizer.coordinator.showVideoCallViewController()
+        sdk.interactor?.setEndedEngagement(.mock(source: .callVisualizer))
         sdk.interactor?.state = .ended(.byOperator)
 
         XCTAssertEqual(calls, [.onEvent(.maximized), .onEvent(.minimized), .onEvent(.ended)])
@@ -654,7 +654,7 @@ final class GliaTests: XCTestCase {
             with: .mock(),
             theme: .mock()
         ) { _ in }
-        sdk.interactor?.setCurrentEngagement(.mock(source: .callVisualizer))
+        sdk.interactor?.setEndedEngagement(.mock(source: .callVisualizer))
         sdk.onEvent = { event in
             switch event {
             case .ended: