Fix possible memory leak while rerouting (#4380)

* Fix possible memory leak while rerouting

Author: kried

CHANGELOG.md

@@ -51,6 +51,7 @@
 * Limited number of reported alternatives to 2, i.e. the `updatedAlternatives` parameter in `RouterDelegate.router(_:didUpdateAlternatives:removedAlternatives:)` has maximum size of 2. ([#4367](https://github.com/mapbox/mapbox-navigation-ios/pull/4367))
 * Increased terminal offboard route request timeout from 4 to 15 seconds. ([#4367](https://github.com/mapbox/mapbox-navigation-ios/pull/4367))
 * Sped up onboard routing cancellation. ([#4367](https://github.com/mapbox/mapbox-navigation-ios/pull/4367))
+* Fixed an issue when a rerouting could cause a memory leak. ([#4380](https://github.com/mapbox/mapbox-navigation-ios/pull/4380))
 
 ## v2.10.0
 

Sources/MapboxCoreNavigation/CoreNavigationNavigator.swift

@@ -235,6 +235,7 @@ final class Navigator: CoreNavigator {
 
     private func unsubscribeNavigator() {
         stopUpdatingElectronicHorizon()
+        rerouteController.invalidate()
         if let navigatorStatusObserver = navigatorStatusObserver {
             navigator.removeObserver(for: navigatorStatusObserver)
         }

Sources/MapboxCoreNavigation/RerouteController.swift

@@ -97,9 +97,13 @@ class RerouteController {
         self.navigator?.addRerouteObserver(for: self)
     }
 
+    func invalidate() {
+        navigator?.removeRerouteObserver(for: self)
+        navigator?.setRerouteControllerForController(defaultRerouteController.nativeInterface)
+    }
+
     deinit {
-        self.navigator?.removeRerouteObserver(for: self)
-        self.navigator?.setRerouteControllerForController(defaultRerouteController.nativeInterface)
+        invalidate()
     }
 }
 
@@ -231,7 +235,9 @@ extension RerouteController: RerouteControllerInterface {
             return
         }
 
-        reroutingRequest = customRoutingProvider.calculateRoutes(options: routeOptions) {result in
+        reroutingRequest = customRoutingProvider.calculateRoutes(options: routeOptions) { [weak self] result in
+            guard let self = self else { return }
+
             switch result {
             case .failure(let error):
                 callback(.init(error: RerouteError(message: error.localizedDescription,

Sources/TestHelper/NavNative/NativeNavigatorSpy.swift

@@ -14,6 +14,7 @@ public class NativeNavigatorSpy: MapboxNavigationNative.Navigator {
     public var passedNavigationTrackerOptions: PredictiveLocationTrackerOptions?
     public var passedDescriptorsTrackerOptions: PredictiveLocationTrackerOptions?
     public var passedDatasetTrackerOptions: PredictiveLocationTrackerOptions?
+    public var passedRemovedRerouteObserver: RerouteObserver?
 
     public var rerouteController: RerouteControllerInterface!
     public var rerouteDetector: RerouteDetectorInterface!
@@ -54,6 +55,10 @@ public class NativeNavigatorSpy: MapboxNavigationNative.Navigator {
         callback(returnedChangeLegResult)
     }
 
+    public override func removeRerouteObserver(for observer: RerouteObserver) {
+        passedRemovedRerouteObserver = observer
+    }
+
     @_implementationOnly public override func setRerouteControllerForController(_ controller: RerouteControllerInterface) {
         passedRerouteController = controller
     }

Tests/MapboxCoreNavigationTests/RerouteControllerTests.swift

@@ -134,4 +134,10 @@ final class RerouteControllerTests: TestCase {
         wait(for: [expectation], timeout: 1)
     }
 
+    func testInvalidate() {
+        rerouteController.invalidate()
+        XCTAssertTrue(navigatorSpy.passedRerouteController === navigatorSpy.getRerouteController())
+        XCTAssertTrue(navigatorSpy.passedRemovedRerouteObserver === rerouteController)
+    }
+
 }