Stop navigation without dismissing UI (#3880)

* vk-1228-stop-navigation: added Router.finishRouting method to explicitly end navigation session and updates, without dismissing related UI and components; added Unit test; CHANGELOG updated

Author: Udumft

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changes to the Mapbox Navigation SDK for iOS
 
+## main
+
+### Routing
+
+* Added `Router.finishRouting()` method to finish routing session without dismissing related UI and logic components.([#3880](https://github.com/mapbox/mapbox-navigation-ios/pull/3880))
+
 ## v2.5.0
 
 ### Packaging

Sources/MapboxCoreNavigation/LegacyRouteController.swift

@@ -141,6 +141,7 @@ open class LegacyRouteController: NSObject, Router, InternalRouter, CLLocationMa
     public func updateRoute(with indexedRouteResponse: IndexedRouteResponse,
                             routeOptions: RouteOptions?,
                             completion: ((Bool) -> Void)?) {
+        guard !hasFinishedRouting else { return }
         updateRoute(with: indexedRouteResponse, routeOptions: routeOptions, isProactive: false, completion: completion)
     }
 
@@ -160,6 +161,7 @@ open class LegacyRouteController: NSObject, Router, InternalRouter, CLLocationMa
 
 
     public func advanceLegIndex(completionHandler: AdvanceLegCompletionHandler? = nil) {
+        guard !hasFinishedRouting else { return }
         precondition(!routeProgress.isFinalLeg, "Can not increment leg index beyond final leg.")
         routeProgress.legIndex += 1
         BillingHandler.shared.beginNewBillingSessionIfRunning(with: sessionUUID)
@@ -347,13 +349,21 @@ open class LegacyRouteController: NSObject, Router, InternalRouter, CLLocationMa
         userSnapToStepDistanceFromManeuver = shape.distance(from: coordinate)
     }
 
+    private var hasFinishedRouting = false
+    public func finishRouting() {
+        hasFinishedRouting = true
+        BillingHandler.shared.stopBillingSession(with: sessionUUID)
+    }
+    
     // MARK: Handling LocationManager Output
 
     public func locationManager(_ manager: CLLocationManager, didUpdateHeading newHeading: CLHeading) {
+        guard !hasFinishedRouting else { return }
         heading = newHeading
     }
 
     public func locationManager(_ manager: CLLocationManager, didUpdateLocations locations: [CLLocation]) {
+        guard !hasFinishedRouting else { return }
         let filteredLocations = locations.filter {
             return $0.isQualified
         }
@@ -457,6 +467,7 @@ open class LegacyRouteController: NSObject, Router, InternalRouter, CLLocationMa
     }
 
     public func reroute(from location: CLLocation, along progress: RouteProgress) {
+        guard !hasFinishedRouting else { return }
         if let lastRerouteLocation = lastRerouteLocation {
             guard location.distance(from: lastRerouteLocation) >= RouteControllerMaximumDistanceBeforeRecalculating else {
                 return

Sources/MapboxCoreNavigation/RouteController.swift

@@ -158,6 +158,7 @@ open class RouteController: NSObject {
      `RouteLeg` was changed or not.
      */
     public func advanceLegIndex(completionHandler: AdvanceLegCompletionHandler? = nil) {
+        guard !hasFinishedRouting else { return }
         updateRouteLeg(to: routeProgress.legIndex + 1) { result in
             completionHandler?(result)
         }
@@ -235,6 +236,7 @@ open class RouteController: NSObject {
     var previousArrivalWaypoint: MapboxDirections.Waypoint?
 
     public func locationManager(_ manager: CLLocationManager, didUpdateLocations locations: [CLLocation]) {
+        guard !hasFinishedRouting else { return }
         guard let location = locations.last else { return }
 
         guard !(delegate?.router(self, shouldDiscard: location) ?? DefaultBehavior.shouldDiscardLocation) else {
@@ -251,6 +253,7 @@ open class RouteController: NSObject {
     }
 
     public func locationManager(_ manager: CLLocationManager, didUpdateHeading newHeading: CLHeading) {
+        guard !hasFinishedRouting else { return }
         heading = newHeading
     }
 
@@ -332,6 +335,16 @@ open class RouteController: NSObject {
         update(to: status)
     }
 
+    private var hasFinishedRouting = false
+    public func finishRouting() {
+        guard !hasFinishedRouting else { return }
+        hasFinishedRouting = true
+        removeRoutes(completion: nil)
+        BillingHandler.shared.stopBillingSession(with: sessionUUID)
+        unsubscribeNotifications()
+        routeTask?.cancel()
+    }
+    
     private func update(to status: NavigationStatus) {
         guard let rawLocation = rawLocation,
               isValidNavigationStatus(status)
@@ -623,10 +636,7 @@ open class RouteController: NSObject {
     }
 
     deinit {
-        removeRoutes(completion: nil)
-        BillingHandler.shared.stopBillingSession(with: sessionUUID)
-        unsubscribeNotifications()
-        routeTask?.cancel()
+        finishRouting()
         rerouteController.resetToDefaultSettings()
         Self.instanceLock.lock()
         Self.instance = nil
@@ -729,6 +739,7 @@ extension RouteController: Router {
     }
 
     public func reroute(from location: CLLocation, along progress: RouteProgress) {
+        guard !hasFinishedRouting else { return }
         guard customRoutingProvider != nil else {
             rerouteController.forceReroute()
             return
@@ -765,6 +776,7 @@ extension RouteController: Router {
     public func updateRoute(with indexedRouteResponse: IndexedRouteResponse,
                             routeOptions: RouteOptions?,
                             completion: ((Bool) -> Void)?) {
+        guard !hasFinishedRouting else { return }
         updateRoute(with: indexedRouteResponse, routeOptions: routeOptions, isProactive: false, completion: completion)
     }
 

Sources/MapboxCoreNavigation/Router.swift

@@ -199,6 +199,12 @@ public protocol Router: CLLocationManagerDelegate {
     func updateRoute(with indexedRouteResponse: IndexedRouteResponse,
                      routeOptions: RouteOptions?,
                      completion: ((Bool) -> Void)?)
+    
+    /// Forcefully stop navigation process without ability to continue it.
+    ///
+    /// Use this method to indicate that you no longer need navigation experience for current session/UI.
+    /// After finishing, `Router` will not be able to update route, route leg, issue a reroute or do any other update, related to route traversing.
+    func finishRouting()
 }
 
 protocol InternalRouter: AnyObject {

Tests/MapboxCoreNavigationTests/MapboxCoreNavigationTests.swift

@@ -482,4 +482,67 @@ class MapboxCoreNavigationTests: TestCase {
             XCTAssertNil(error)
         }
     }
+    
+    func testNoUpdatesAfterFinishingRouting() {
+        navigation = MapboxNavigationService(routeResponse: response,
+                                             routeIndex: 0,
+                                             routeOptions: routeOptions,
+                                             customRoutingProvider: MapboxRoutingProvider(.offline),
+                                             credentials: Fixture.credentials,
+                                             simulating: .never)
+        
+        // Coordinates from first step
+        let coordinates = route.legs[0].steps[0].shape!.coordinates
+        let now = Date()
+        let locations = coordinates.enumerated().map {
+            CLLocation(coordinate: $0.element,
+                       altitude: -1,
+                       horizontalAccuracy: 10,
+                       verticalAccuracy: -1,
+                       course: -1,
+                       speed: 10,
+                       timestamp: now + $0.offset)
+        }
+        
+        var hasFinishedRouting = false
+        expectation(forNotification: .routeControllerProgressDidChange, object: navigation.router) { _ in
+            return hasFinishedRouting
+        }.isInverted = true
+        expectation(forNotification: .routeControllerWillReroute, object: navigation.router) { _ in
+            return hasFinishedRouting
+        }.isInverted = true
+        expectation(forNotification: .routeControllerDidReroute, object: navigation.router) { _ in
+            return hasFinishedRouting
+        }.isInverted = true
+        
+        let routerDelegateSpy = RouterDelegateSpy()
+        navigation.router.delegate = routerDelegateSpy
+        
+        routerDelegateSpy.onShouldDiscard = { _ in
+            if hasFinishedRouting {
+                XCTFail("Location updates should not be tracked.")
+            }
+            return false
+        }
+        
+        navigation.start()
+        
+        for location in locations {
+            navigation.locationManager(navigation.locationManager, didUpdateLocations: [location])
+            
+            if !hasFinishedRouting {
+                navigation.router.finishRouting()
+                hasFinishedRouting = true
+                
+                navigation.updateRoute(with: IndexedRouteResponse(routeResponse: response,
+                                                                  routeIndex: 0),
+                                       routeOptions: nil,
+                                       completion: nil)
+            }
+        }
+        
+        waitForExpectations(timeout: waitForInterval) { (error) in
+            XCTAssertNil(error)
+        }
+    }
 }