Implement new route deviation handling - off step

.github/workflows/android.yml

@@ -13,7 +13,7 @@ jobs:
       cancel-in-progress: true
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
       with:
         submodules: true
 
@@ -53,7 +53,7 @@ jobs:
       packages: read
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
       with:
         submodules: true
 
@@ -99,7 +99,7 @@ jobs:
       packages: read
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
       with:
         submodules: true
 
@@ -146,7 +146,7 @@ jobs:
       packages: read
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
       with:
         submodules: true
 

.github/workflows/cargo-publish.yml

@@ -11,7 +11,7 @@ jobs:
   publish_crate:
     runs-on: macos-15
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - name: Cargo Publish
         run: cargo publish -p ferrostar
         working-directory: common

.github/workflows/gradle-publish.yml

@@ -16,7 +16,7 @@ jobs:
 
     steps:
     - name: Check out repo
-      uses: actions/checkout@v4
+      uses: actions/checkout@v6
 
     - name: Set up JDK 21
       uses: actions/setup-java@v4

.github/workflows/ios-release.yml

@@ -13,7 +13,7 @@ jobs:
 
     steps:
     - name: Checkout repo
-      uses: actions/checkout@v4
+      uses: actions/checkout@v6
       with:
         fetch-depth: 0  # Ensure that we can operate on the full history
         ref: main

.github/workflows/ios.yml

@@ -14,7 +14,7 @@ jobs:
 
     steps:
     - name: Checkout repo
-      uses: actions/checkout@v4
+      uses: actions/checkout@v6
 
     - name: Check format
       id: check-format
@@ -37,7 +37,7 @@ jobs:
 
     steps:
     - name: Checkout repo
-      uses: actions/checkout@v4
+      uses: actions/checkout@v6
 
     - name: Ensure that Package.swift is NOT configured for local development at this stage (easy to forget)
       run: |
@@ -100,7 +100,7 @@ jobs:
 
     steps:
     - name: Checkout repo
-      uses: actions/checkout@v4
+      uses: actions/checkout@v6
 
     - name: Configure Package.swift for local development
       run: sed -i '' 's/let useLocalFramework = false/let useLocalFramework = true/' Package.swift
@@ -155,7 +155,7 @@ jobs:
 
     steps:
     - name: Checkout repo
-      uses: actions/checkout@v4
+      uses: actions/checkout@v6
 
     - name: Configure Package.swift for local development
       run: sed -i '' 's/let useLocalFramework = false/let useLocalFramework = true/' Package.swift

.github/workflows/npm-publish.yml

@@ -17,7 +17,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Install wasm-pack
         run: cargo install wasm-pack

.github/workflows/pages.yml

@@ -12,7 +12,7 @@ jobs:
       pages: write  # To push to a GitHub Pages site
       id-token: write # To update the deployment status
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           fetch-depth: 0
       - name: Install latest mdbook

.github/workflows/rust.yml

@@ -15,7 +15,7 @@ jobs:
       group: ${{ github.workflow }}-${{ github.ref }}-rust-msrv
       cancel-in-progress: true
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - uses: taiki-e/install-action@v2
         with:
           tool: cargo-hack
@@ -31,7 +31,7 @@ jobs:
       cancel-in-progress: true
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       - name: Check semver
         uses: obi1kenobi/cargo-semver-checks-action@v2
         with:
@@ -45,7 +45,7 @@ jobs:
       cancel-in-progress: true
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       - name: rustfmt checks
         run: cargo fmt --check
         working-directory: common
@@ -56,7 +56,7 @@ jobs:
       group: ${{ github.workflow }}-${{ github.ref }}-rust-build
       cancel-in-progress: true
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - uses: taiki-e/install-action@nextest
 
       - name: Cargo Build

.github/workflows/typos.yml

@@ -12,7 +12,7 @@ jobs:
 
     steps:
     - name: Checkout repo
-      uses: actions/checkout@v4
+      uses: actions/checkout@v6
 
     - name: Run typos
       uses: crate-ci/typos@master

.github/workflows/wasm-js.yml

@@ -15,7 +15,7 @@ jobs:
       group: ${{ github.workflow }}-${{ github.ref }}-wasm-build
       cancel-in-progress: true
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Install wasm-pack
         run: cargo install wasm-pack

Package.swift

@@ -16,7 +16,7 @@ if useLocalFramework {
         path: "./common/target/ios/libferrostar-rs.xcframework"
     )
 } else {
-    let releaseTag = "0.49.0"
+    let releaseTag = "0.50.0"
     let releaseChecksum = "7b201e32a4e55ea127ccb9c72d8fdbf09540755471b7794de90ca369b10ed314"
     binaryTarget = .binaryTarget(
         name: "FerrostarCoreRS",

android/build.gradle

@@ -29,5 +29,5 @@ ext {
 
 allprojects {
     group = "com.stadiamaps.ferrostar"
-    version = "0.49.0"
+    version = "0.50.0"
 }

android/core/src/androidTest/java/com/stadiamaps/ferrostar/core/FerrostarCoreTest.kt

@@ -41,6 +41,8 @@ import uniffi.ferrostar.VisualInstructionContent
 import uniffi.ferrostar.Waypoint
 import uniffi.ferrostar.WaypointAdvanceMode
 import uniffi.ferrostar.WaypointKind
+import uniffi.ferrostar.DeviationCalculationPolicy
+import uniffi.ferrostar.DeviationKind
 import uniffi.ferrostar.stepAdvanceDistanceFromStep
 import uniffi.ferrostar.stepAdvanceDistanceToEndOfStep
 import uniffi.ferrostar.stepAdvanceManual
@@ -130,14 +132,16 @@ class FerrostarCoreTest {
                                   secondaryContent = null,
                                   subContent = null,
                                   triggerDistanceBeforeManeuver = 42.0,
-                              )),
+                              ),
+                          ),
                       spokenInstructions = listOf(),
                       duration = 0.0,
                       annotations = null,
                       incidents = listOf(),
                       drivingSide = DrivingSide.RIGHT,
                       roundaboutExitNumber = null,
-                  )),
+                  ),
+              ),
       )
 
   @Test
@@ -191,7 +195,8 @@ class FerrostarCoreTest {
                   Waypoint(
                       coordinate = GeographicCoordinate(60.5349908, -149.5485806),
                       kind = WaypointKind.BREAK,
-                  )),
+                  ),
+              ),
       )
       fail("Expected the request to fail")
     } catch (e: InvalidStatusCodeException) {
@@ -247,7 +252,8 @@ class FerrostarCoreTest {
                     Waypoint(
                         coordinate = GeographicCoordinate(lat = 60.5349908, lng = -149.5485806),
                         kind = WaypointKind.BREAK,
-                    )),
+                    ),
+                ),
         )
 
     assertEquals(listOf(mockRoute), routes)
@@ -301,7 +307,8 @@ class FerrostarCoreTest {
                     Waypoint(
                         coordinate = GeographicCoordinate(lat = 60.5349908, lng = -149.5485806),
                         kind = WaypointKind.BREAK,
-                    )),
+                    ),
+                ),
         )
 
     assertEquals(listOf(mockRoute), routes)
@@ -362,7 +369,8 @@ class FerrostarCoreTest {
                     Waypoint(
                         coordinate = GeographicCoordinate(lat = 60.5349908, lng = -149.5485806),
                         kind = WaypointKind.BREAK,
-                    )),
+                    ),
+                ),
         )
 
     assertEquals(listOf(mockRoute), routes)
@@ -385,11 +393,11 @@ class FerrostarCoreTest {
 
       override fun correctiveActionForDeviation(
           core: FerrostarCore,
-          deviationInMeters: Double,
-          remainingWaypoints: List<Waypoint>,
+          deviation: DeviationKind,
+          remainingWaypoints: List<Waypoint>
       ): CorrectiveAction {
         called = true
-        assertEquals(42.0, deviationInMeters, Double.MIN_VALUE)
+        assertEquals(DeviationKind.CompletelyOffRoute(42.0), deviation)
         return CorrectiveAction.GetNewRoutes(remainingWaypoints)
       }
     }
@@ -451,14 +459,19 @@ class FerrostarCoreTest {
                     Waypoint(
                         coordinate = GeographicCoordinate(lat = 60.5349908, lng = -149.5485806),
                         kind = WaypointKind.BREAK,
-                    )),
+                    ),
+                ),
         )
 
     core.startNavigation(
         routes.first(),
         NavigationControllerConfig(
             WaypointAdvanceMode.WaypointWithinRange(100.0),
-            stepAdvanceDistanceFromStep(16u, 32u, true),
+            stepAdvanceDistanceFromStep(
+                distance = 16u,
+                minimumHorizontalAccuracy = 32u,
+                calculationPolicy = DeviationCalculationPolicy.ALWAYS,
+            ),
             stepAdvanceDistanceToEndOfStep(16u, 32u),
             routeDeviationTracking =
                 RouteDeviationTracking.Custom(
@@ -468,9 +481,10 @@ class FerrostarCoreTest {
                               route: Route,
                               tripState: TripState,
                           ): RouteDeviation {
-                            return RouteDeviation.OffRoute(42.0)
+                            return RouteDeviation.Deviation(DeviationKind.CompletelyOffRoute(42.0))
                           }
-                        }),
+                        },
+                ),
             CourseFiltering.RAW,
         ),
     )

android/core/src/main/java/com/stadiamaps/ferrostar/core/FerrostarCore.kt

@@ -366,14 +366,15 @@ class FerrostarCore(
   private fun handleStateUpdate(newState: NavState, location: UserLocation) {
     val tripState = newState.tripState
     if (tripState is TripState.Navigating) {
-      if (tripState.deviation is RouteDeviation.OffRoute) {
+      val deviation = tripState.deviation
+      if (deviation is RouteDeviation.Deviation) {
         if (!_routeRequestInFlight && // We can't have a request in flight already
             hasWaitedMinimumRecalculationDelay(
                 _lastAutomaticRecalculation, minimumTimeBeforeRecalculation) &&
             hasUserMovedSignificantlySinceLastRecalc(location)) {
           val action =
               deviationHandler?.correctiveActionForDeviation(
-                  this, tripState.deviation.deviationFromRouteLine, tripState.remainingWaypoints)
+                  this, deviation.kind, tripState.remainingWaypoints)
                   ?: CorrectiveAction.GetNewRoutes(tripState.remainingWaypoints)
           when (action) {
             is CorrectiveAction.DoNothing -> {
@@ -391,7 +392,7 @@ class FerrostarCore(
                   val state = _state.value
                   // Make sure we are still navigating and the new route is still relevant
                   if (state.tripState is TripState.Navigating &&
-                      state.tripState.deviation is RouteDeviation.OffRoute) {
+                      state.tripState.deviation is RouteDeviation.Deviation) {
                     if (processor != null) {
                       processor.loadedAlternativeRoutes(this@FerrostarCore, routes)
                     } else if (routes.isNotEmpty()) {

android/core/src/main/java/com/stadiamaps/ferrostar/core/RouteDeviationHandler.kt

@@ -1,5 +1,6 @@
 package com.stadiamaps.ferrostar.core
 
+import uniffi.ferrostar.DeviationKind
 import uniffi.ferrostar.Waypoint
 
 /** Corrective action to take when the user deviates from the route. */
@@ -26,7 +27,7 @@ sealed class CorrectiveAction {
 fun interface RouteDeviationHandler {
   fun correctiveActionForDeviation(
       core: FerrostarCore,
-      deviationInMeters: Double,
+      deviation: DeviationKind,
       remainingWaypoints: List<Waypoint>,
   ): CorrectiveAction
 }

android/core/src/main/java/com/stadiamaps/ferrostar/core/extensions/TripStateExtensions.kt

@@ -132,7 +132,7 @@ fun TripState.preferredUserLocation() =
       is TripState.Navigating -> {
         when (this.deviation) {
           is RouteDeviation.NoDeviation -> this.snappedUserLocation
-          is RouteDeviation.OffRoute -> this.userLocation
+          is RouteDeviation.Deviation -> this.userLocation
         }
       }
       is TripState.Idle -> this.userLocation

apple/DemoApp/Demo/NavigationDelegate.swift

@@ -10,7 +10,7 @@ class NavigationDelegate: FerrostarCoreDelegate {
         // TODO: Create defaults extension on FerrostarCoreDelegate
     }
 
-    func core(_: FerrostarCore, correctiveActionForDeviation _: Double,
+    func core(_: FerrostarCore, correctiveActionForDeviation _: DeviationKind,
               remainingWaypoints waypoints: [Waypoint]) -> CorrectiveAction
     {
         // If the user is off course, we'll try to calculate a new route using the remaining waypoints.

apple/Sources/FerrostarCore/FerrostarCore.swift

@@ -43,7 +43,7 @@ public protocol FerrostarCoreDelegate: AnyObject {
     /// This hook enables app developers to take the most appropriate corrective action.
     func core(
         _ core: FerrostarCore,
-        correctiveActionForDeviation deviationInMeters: Double,
+        correctiveActionForDeviation deviation: DeviationKind,
         remainingWaypoints waypoints: [Waypoint]
     ) -> CorrectiveAction
 
@@ -437,7 +437,7 @@ public protocol FerrostarCoreDelegate: AnyObject {
                 case .noDeviation:
                     // No action
                     break
-                case let .offRoute(deviationFromRouteLine: deviationFromRouteLine):
+                case let .deviation(kind: kind):
                     guard !self.routeRequestInFlight, // We can't have a request in flight already
                           // Ensure a minimum cool down before a new route fetch
                           self.lastAutomaticRecalculation?.timeIntervalSinceNow ?? -TimeInterval
@@ -454,7 +454,7 @@ public protocol FerrostarCoreDelegate: AnyObject {
 
                     switch self.delegate?.core(
                         self,
-                        correctiveActionForDeviation: deviationFromRouteLine,
+                        correctiveActionForDeviation: kind,
                         remainingWaypoints: remainingWaypoints
                     ) ?? .getNewRoutes(waypoints: remainingWaypoints) {
                     case .doNothing: