Fix refresh for alternatives routes (#9382)

kried · web-flow · commit 3108a8a2a835 · 2025-06-09T12:03:04.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,17 @@
 # Changes to the Mapbox Navigation SDK for iOS
 
+## 3.10.0-rc.1
+
+### Packaging
+
+* MapboxNavigationCore now requires [MapboxMaps v11.13.0-rc.1](https://github.com/mapbox/mapbox-maps-ios/releases/tag/v11.13.0-rc.1)
+* MapboxNavigationCore now requires [MapboxNavigationNative v324.13.0-rc.1](https://github.com/mapbox/mapbox-navigation-native-ios/releases/tag/v324.13.0-rc.1)
+
+### Routing
+
+* Fixed re-enabling route refresh after leg change.
+* Fixed route refresh of alternative routes.
+
 ## 3.10.0-beta.1
 
 ### Packaging
diff --git a/Package.swift b/Package.swift
@@ -3,8 +3,8 @@
 
 import PackageDescription
 
-let (navNativeVersion, navNativeChecksum, navNativeRevision) = ("324.13.0-beta.1", "6de7358d694f7bdc1f120478c207e94a01971f2cb5cba81262d597bbb694f712", "15464003bfad533303ad25d2e1c7860cfaf47abe")
-let mapsVersion: Version = "11.13.0-beta.1"
+let (navNativeVersion, navNativeChecksum, navNativeRevision) = ("324.13.0-rc.1", "0a8e40363cea0b41476c0da9c9d2c4614b3460ff06f6aa79396bfc786aac54ee", "398baac89e32466f799b350b2d560e843452ed04")
+let mapsVersion: Version = "11.13.0-rc.1"
 
 let package = Package(
     name: "MapboxNavigation",
diff --git a/Sources/MapboxNavigationCore/MapboxNavigationProvider.swift b/Sources/MapboxNavigationCore/MapboxNavigationProvider.swift
@@ -114,7 +114,8 @@ public final class MapboxNavigationProvider {
     ///
     /// It is intended to be used when creating off-line tile packs.
     public func getLatestNavigationTilesetDescriptor() -> TilesetDescriptor {
-        TilesetDescriptorFactory.getLatestForCache(nativeHandlersFactory.cacheHandle)
+        // TODO: (NAVIOS-2231) Add support for adas tiles
+        TilesetDescriptorFactory.getLatestForCache(nativeHandlersFactory.cacheHandle, includeAdas: false)
     }
 
     // MARK: - Instance Lifecycle control
diff --git a/Sources/MapboxNavigationCore/Navigator/Internals/CoreNavigator/CoreNavigator.swift b/Sources/MapboxNavigationCore/Navigator/Internals/CoreNavigator/CoreNavigator.swift
@@ -296,15 +296,24 @@ final class NativeNavigator: CoreNavigator, @unchecked Sendable {
             return
         }
 
-        let refreshObserver = NavigatorRouteRefreshObserver(refreshCallback: { [weak self] in
-            guard let self else { return nil }
+        let refreshObserver = NavigatorRouteRefreshObserver(
+            refreshCallback: { [weak self] routeIdPrefix, routeIndex, _ in
+                guard let self else { return nil }
 
-            guard let primaryRoute = navigator.native.getPrimaryRoute() else { return nil }
-            return RouteRefreshResult(
-                updatedRoute: primaryRoute,
-                alternativeRoutes: navigator.native.getAlternativeRoutes()
-            )
-        })
+                guard let primaryRoute = navigator.native.getPrimaryRoute() else { return nil }
+                let alternativeRoutes = navigator.native.getAlternativeRoutes()
+
+                if primaryRoute.matching(routeIdPrefix: routeIdPrefix, routeIndex: routeIndex) {
+                    return .mainRoute(primaryRoute)
+                }
+                if let refreshedAlternative = alternativeRoutes.first(where: {
+                    $0.route.matching(routeIdPrefix: routeIdPrefix, routeIndex: routeIndex)
+                }) {
+                    return .alternativeRoute(alternative: refreshedAlternative)
+                }
+                return nil
+            }
+        )
         navigator.native.addRouteRefreshObserver(for: refreshObserver)
         navigator.native.startRoutesRefresh(
             forDefaultRefreshPeriodMs: UInt64(refreshPeriod * 1000),
@@ -512,3 +521,10 @@ enum NativeNavigatorError: Swift.Error {
     case failedToUpdateRoutes(reason: String)
     case failedToUpdateAlternativeRoutes(reason: String)
 }
+
+extension RouteInterface {
+    fileprivate func matching(routeIdPrefix: String, routeIndex: UInt32) -> Bool {
+        // TODO: (NN-3674) use full routeId instead of just prefix.
+        getRouteId().starts(with: routeIdPrefix) && getRouteIndex() == routeIndex
+    }
+}
diff --git a/Sources/MapboxNavigationCore/Navigator/Internals/CoreNavigator/NavigatorRouteRefreshObserver.swift b/Sources/MapboxNavigationCore/Navigator/Internals/CoreNavigator/NavigatorRouteRefreshObserver.swift
@@ -2,13 +2,13 @@ import _MapboxNavigationHelpers
 import Foundation
 @preconcurrency import MapboxNavigationNative
 
-struct RouteRefreshResult: @unchecked Sendable {
-    let updatedRoute: RouteInterface
-    let alternativeRoutes: [RouteAlternative]
+enum RouteRefreshResult: @unchecked Sendable {
+    case mainRoute(RouteInterface)
+    case alternativeRoute(alternative: RouteAlternative)
 }
 
 class NavigatorRouteRefreshObserver: RouteRefreshObserver, @unchecked Sendable {
-    typealias RefreshCallback = () -> RouteRefreshResult?
+    typealias RefreshCallback = (String, UInt32, UInt32) -> RouteRefreshResult?
     private var refreshCallback: RefreshCallback
 
     init(refreshCallback: @escaping RefreshCallback) {
@@ -22,7 +22,7 @@ class NavigatorRouteRefreshObserver: RouteRefreshObserver, @unchecked Sendable {
         legIndex: UInt32,
         routeGeometryIndex: UInt32
     ) {
-        guard let routeRefreshResult = refreshCallback() else {
+        guard let routeRefreshResult = refreshCallback(routeId, routeIndex, legIndex) else {
             return
         }
 
diff --git a/Sources/MapboxNavigationCore/Navigator/MapboxNavigator.swift b/Sources/MapboxNavigationCore/Navigator/MapboxNavigator.swift
@@ -1290,32 +1290,45 @@ final class MapboxNavigator: @unchecked Sendable {
                 return
             }
 
-            var newMainRoute = currentNavigationRoutes.mainRoute
-            let isMainRouteUpdate = refreshRouteResult.updatedRoute.getRouteId() ==
-                currentNavigationRoutes.mainRoute.routeId.rawValue
-            if isMainRouteUpdate {
-                guard let updatedMainRoute = await NavigationRoute(nativeRoute: refreshRouteResult.updatedRoute)
-                else { return }
-                newMainRoute = updatedMainRoute
-            }
             let event = RefreshingStatus.Events.Refreshing()
             await send(RefreshingStatus(event: event))
 
-            var refreshedNavigationRoutes = await NavigationRoutes(
-                mainRoute: newMainRoute,
-                alternativeRoutes: await AlternativeRoute.fromNative(
-                    alternativeRoutes: refreshRouteResult.alternativeRoutes,
-                    relateveTo: newMainRoute
-                )
-            )
+            var refreshedNavigationRoutes = currentNavigationRoutes
+
+            switch refreshRouteResult {
+            case .mainRoute(let refreshedMainRoute):
+                guard let updatedMainRoute = await NavigationRoute(nativeRoute: refreshedMainRoute)
+                else {
+                    await sendFailedToRefreshEvent()
+                    return
+                }
+                refreshedNavigationRoutes.mainRoute = updatedMainRoute
+
+            case .alternativeRoute(alternative: let refreshedAlternative):
+                guard let newAlternative = await AlternativeRoute(
+                    mainRoute: currentNavigationRoutes.mainRoute.route,
+                    alternativeRoute: refreshedAlternative
+                ), let index = currentNavigationRoutes.allAlternativeRoutesWithIgnored
+                    .firstIndex(where: { $0.nativeRoute.getRouteId() == refreshedAlternative.route.getRouteId() })
+                else {
+                    await sendFailedToRefreshEvent()
+                    return
+                }
+                refreshedNavigationRoutes.allAlternativeRoutesWithIgnored[index] = newAlternative
+            }
+
             if let status = self.navigator.mostRecentNavigationStatus {
                 refreshedNavigationRoutes.updateForkPointPassed(with: status)
             }
             let routeProgress = await state.privateRouteProgress
+            let refreshedMainLegIndex: Int? = switch refreshRouteResult {
+            case .mainRoute: Int(legIndex)
+            case .alternativeRoute: nil
+            }
             let updatedRouteProgress = routeProgress?.refreshingRoute(
                 with: refreshedNavigationRoutes,
-                legIndex: Int(legIndex),
-                legShapeIndex: 0, // TODO: NN should provide this value in `MBNNRouteRefreshObserver`
+                refreshedMainLegIndex: refreshedMainLegIndex,
+                // TODO: Pass legShapeIndex. NN should provide this value in `MBNNRouteRefreshObserver`
                 congestionConfiguration: configuration.congestionConfig
             )
             await state.update(privateRouteProgress: updatedRouteProgress)
@@ -1329,6 +1342,12 @@ final class MapboxNavigator: @unchecked Sendable {
         }
     }
 
+    private func sendFailedToRefreshEvent() async {
+        Log.warning("Failed to refresh the routes", category: .navigation)
+        let error = RefreshingStatus.Events.FailedToRefresh()
+        await send(RefreshingStatus(event: error))
+    }
+
     func didFailToRefreshAnnotations(_ notification: Notification) {
         guard let refreshRouteFailure = notification
             .userInfo?[NativeNavigator.NotificationUserInfoKey.refreshRequestErrorKey] as? RouteRefreshError,
diff --git a/Sources/MapboxNavigationCore/Navigator/Navigator.swift b/Sources/MapboxNavigationCore/Navigator/Navigator.swift
@@ -291,6 +291,8 @@ public struct RefreshingStatus: Equatable, Sendable {
         public struct Refreshing: RefreshingEvent, Sendable {}
         /// The route has been refreshed.
         public struct Refreshed: RefreshingEvent, Sendable {}
+        /// The route has failed to refresh.
+        public struct FailedToRefresh: RefreshingEvent, Sendable {}
         /// Indicates that current route's refreshing is no longer available.
         ///
         /// It is strongly recommended to request a new route. Refreshing TTL has expired and the route will no longer
diff --git a/Sources/MapboxNavigationCore/Navigator/RouteProgress/RouteProgress.swift b/Sources/MapboxNavigationCore/Navigator/RouteProgress/RouteProgress.swift
@@ -115,8 +115,7 @@ public struct RouteProgress: Equatable, Sendable {
 
     func refreshingRoute(
         with refreshedRoutes: NavigationRoutes,
-        legIndex: Int,
-        legShapeIndex: Int,
+        refreshedMainLegIndex: Int?,
         congestionConfiguration: CongestionRangesConfiguration
     ) -> RouteProgress {
         var refreshedRouteProgress = self
@@ -125,8 +124,10 @@ public struct RouteProgress: Equatable, Sendable {
 
         refreshedRouteProgress.navigationRoutes = refreshedRoutes
 
-        refreshedRouteProgress.currentLegProgress = refreshedRouteProgress.currentLegProgress
-            .refreshingLeg(with: refreshedRouteProgress.route.legs[legIndex])
+        if let refreshedMainLegIndex {
+            refreshedRouteProgress.currentLegProgress = refreshedRouteProgress.currentLegProgress
+                .refreshingLeg(with: refreshedRouteProgress.route.legs[refreshedMainLegIndex])
+        }
         refreshedRouteProgress.calculateLegsCongestion(configuration: congestionConfiguration)
 
         return refreshedRouteProgress
diff --git a/Sources/MapboxNavigationCore/Version.swift b/Sources/MapboxNavigationCore/Version.swift
@@ -1,6 +1,6 @@
 import Foundation
 
 extension Bundle {
-    public static let mapboxNavigationVersion: String = "3.10.0-beta.1"
+    public static let mapboxNavigationVersion: String = "3.10.0-rc.1"
     public static let mapboxNavigationUXBundleIdentifier: String = "com.mapbox.navigationUX"
 }
diff --git a/Sources/_MapboxNavigationTestHelpers/Core/AlternativeRouteMock.swift b/Sources/_MapboxNavigationTestHelpers/Core/AlternativeRouteMock.swift
@@ -10,12 +10,13 @@ extension AlternativeRoute {
             shape: mockShape
         ),
         alternativeRoute: Route = .mock(),
-        nativeRouteAlternative: RouteAlternative = .mock()
+        nativeRouteAlternative: RouteAlternative? = nil
     ) -> Self {
-        self.init(
+        let nativeAlternative = nativeRouteAlternative ?? .mock(route: alternativeRoute)
+        return self.init(
             mainRoute: mainRoute,
             alternativeRoute: alternativeRoute,
-            nativeRouteAlternative: nativeRouteAlternative
+            nativeRouteAlternative: nativeAlternative
         )!
     }
 
@@ -33,6 +34,10 @@ extension AlternativeRoute {
 }
 
 extension RouteAlternative {
+    public static func mock(route: Route, routeIndex: Int = 0) -> Self {
+        .mock(route: RouteInterfaceMock(route: route, routeIndex: routeIndex))
+    }
+
     public static func mock(
         id: UInt32 = 0,
         route: RouteInterface = RouteInterfaceMock(),
diff --git a/Sources/_MapboxNavigationTestHelpers/Core/NavigationRouteMock.swift b/Sources/_MapboxNavigationTestHelpers/Core/NavigationRouteMock.swift
@@ -6,8 +6,9 @@ extension NavigationRoute {
     public static func mock(
         route: Route = .mock(),
         routeId: RouteId = .mock(),
-        nativeRoute: RouteInterface = RouteInterfaceMock()
+        nativeRoute: RouteInterface? = nil
     ) -> Self {
-        self.init(route: route, nativeRoute: nativeRoute)
+        let nativeRoute = nativeRoute ?? RouteInterfaceMock(route: route)
+        return self.init(route: route, nativeRoute: nativeRoute)
     }
 }
diff --git a/Sources/_MapboxNavigationTestHelpers/Core/RouteMock.swift b/Sources/_MapboxNavigationTestHelpers/Core/RouteMock.swift
@@ -45,6 +45,9 @@ extension RouteLeg {
             expectedTravelTime: expectedTravelTime,
             profileIdentifier: profileIdentifier
         )
+        leg.source = if let coordinate = steps.first?.maneuverLocation {
+            .init(coordinate: coordinate)
+        } else { .mock() }
         leg.destination = destination
         return leg
     }
@@ -67,7 +70,9 @@ extension RouteStep {
         drivingSide: DrivingSide = .right,
         distance: LocationDistance = 100,
         expectedTravelTime: TimeInterval = 65,
-        instructionsDisplayedAlongStep: [VisualInstructionBanner]? = nil
+        instructionsDisplayedAlongStep: [VisualInstructionBanner]? = nil,
+        administrativeAreaContainerByIntersection: [Int?]? = [0],
+        segmentIndicesByIntersection: [Int?]? = [0]
     ) -> Self {
         var step = self.init(
             transportType: transportType,
@@ -79,7 +84,8 @@ extension RouteStep {
             expectedTravelTime: expectedTravelTime,
             intersections: [.mock()],
             instructionsDisplayedAlongStep: instructionsDisplayedAlongStep,
-            segmentIndicesByIntersection: [0]
+            administrativeAreaContainerByIntersection: administrativeAreaContainerByIntersection,
+            segmentIndicesByIntersection: segmentIndicesByIntersection
         )
         step.shape = .init([maneuverLocation, maneuverLocation])
         return step
diff --git a/Sources/_MapboxNavigationTestHelpers/Core/RoutesDataMock.swift b/Sources/_MapboxNavigationTestHelpers/Core/RoutesDataMock.swift
@@ -1,13 +1,42 @@
 @preconcurrency import MapboxNavigationNative
 
-public class RoutesDataMock: RoutesData {
-    public init() {}
+public final class RoutesDataMock: RoutesData {
+    let _primaryRoute: any RouteInterface
+    let _alternativeRoutes: [RouteAlternative]
+
+    public init(
+        primaryRoute: any RouteInterface = RouteInterfaceMock(),
+        alternativeRoutes: [RouteAlternative] = []
+    ) {
+        self._primaryRoute = primaryRoute
+        self._alternativeRoutes = alternativeRoutes
+    }
 
     public func primaryRoute() -> any RouteInterface {
-        RouteInterfaceMock()
+        _primaryRoute
     }
 
     public func alternativeRoutes() -> [RouteAlternative] {
-        []
+        _alternativeRoutes
+    }
+}
+
+extension RoutesDataMock {
+    public static func mock(
+        primaryRoute: any RouteInterface = RouteInterfaceMock(),
+        alternativeRoutes: [any RouteInterface] = []
+    ) -> RoutesData {
+        let nativeAlternativeRoutes = alternativeRoutes.enumerated().map { i, nativeRoute in
+            return RouteAlternative(
+                id: UInt32(i),
+                route: nativeRoute,
+                mainRouteFork: .mock(),
+                alternativeRouteFork: .mock(),
+                infoFromFork: .mock(),
+                infoFromStart: .mock(),
+                isNew: false
+            )
+        }
+        return RoutesDataMock(primaryRoute: primaryRoute, alternativeRoutes: nativeAlternativeRoutes)
     }
 }
diff --git a/Sources/_MapboxNavigationTestHelpers/NavNative/RouteInterfaceMock.swift b/Sources/_MapboxNavigationTestHelpers/NavNative/RouteInterfaceMock.swift
@@ -8,12 +8,24 @@ public final class RouteInterfaceMock: RouteInterface {
     public static let realRequestUri =
         "https://api.mapbox.com/directions/v5/mapbox/driving/1.0,1.0;2.0,2.0?access_token=mock"
 
-    public static let realRouteJson = {
+    static func makeRoutesOptions(with route: Route) -> RouteOptions {
+        let source = route.legs[0].source?.coordinate ?? route.legs[0].steps[0].maneuverLocation
+        var waypoints = [Waypoint(coordinate: source)]
+        waypoints += route.legs.compactMap { $0.destination }
+        return RouteOptions(waypoints: waypoints)
+    }
+
+    static func makeRoutesJson(with routes: [Route]) -> String {
         let encoder = JSONEncoder()
-        let route = Route.mock()
-        let jsonData = try! encoder.encode(route)
+        let route = routes[0]
+        let routeOptions = makeRoutesOptions(with: route)
+        var routeResponse = RouteResponse(httpResponse: nil, options: .route(routeOptions), credentials: .mock())
+        routeResponse.routes = routes
+        let jsonData = try! encoder.encode(routeResponse)
         return String(data: jsonData, encoding: .utf8)!
-    }()
+    }
+
+    public static let realRouteJson = RouteInterfaceMock.makeRoutesJson(with: [.mock()])
 
     public var routeId: String
     public var responseUuid: String
@@ -28,6 +40,21 @@ public final class RouteInterfaceMock: RouteInterface {
     public var routeGeometry: [Coordinate2D]
     public var mapboxApi: MapboxAPI
 
+    public convenience init(
+        route: Route,
+        routeId: String = UUID().uuidString,
+        routeIndex: Int = 0
+    ) {
+        let json = RouteInterfaceMock.makeRoutesJson(with: [route])
+        let options = RouteInterfaceMock.makeRoutesOptions(with: route)
+        self.init(
+            routeId: routeId,
+            routeIndex: UInt32(routeIndex),
+            responseJsonRef: .init(data: json.data(using: .utf8)!),
+            requestUri: Directions.url(forCalculating: options, credentials: .mock()).absoluteString
+        )
+    }
+
     public init(
         routeId: String = UUID().uuidString,
         responseUuid: String = UUID().uuidString,
diff --git a/Tests/MapboxNavigationCoreTests/Navigator/MapboxNavigatorTests.swift b/Tests/MapboxNavigationCoreTests/Navigator/MapboxNavigatorTests.swift
diff --git a/Tests/MapboxNavigationCoreTests/PredictiveCache/PredictiveCacheManagerTests.swift b/Tests/MapboxNavigationCoreTests/PredictiveCache/PredictiveCacheManagerTests.swift
diff --git a/Tests/MapboxNavigationCoreTests/RouteProgress/RouteProgressTests.swift b/Tests/MapboxNavigationCoreTests/RouteProgress/RouteProgressTests.swift

Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,8 @@ public final class MapboxNavigationProvider {`
`114`	`114`	`///`
`115`	`115`	`/// It is intended to be used when creating off-line tile packs.`
`116`	`116`	`public func getLatestNavigationTilesetDescriptor() -> TilesetDescriptor {`
`117`		`- TilesetDescriptorFactory.getLatestForCache(nativeHandlersFactory.cacheHandle)`
	`117`	`+ // TODO: (NAVIOS-2231) Add support for adas tiles`
	`118`	`+ TilesetDescriptorFactory.getLatestForCache(nativeHandlersFactory.cacheHandle, includeAdas: false)`
`118`	`119`	`}`
`119`	`120`
`120`	`121`	`// MARK: - Instance Lifecycle control`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`import Foundation`
`2`	`2`
`3`	`3`	`extension Bundle {`
`4`		`- public static let mapboxNavigationVersion: String = "3.10.0-beta.1"`
	`4`	`+ public static let mapboxNavigationVersion: String = "3.10.0-rc.1"`
`5`	`5`	`public static let mapboxNavigationUXBundleIdentifier: String = "com.mapbox.navigationUX"`
`6`	`6`	`}`