Step advance edge case improvements (#387)

* Rust: refactor step advance model to allow for min threshold from end * First pass at more changes * Committing a bit more... * Bump AGP * Commit most snapshots * Commit contentious section of snapshot * Fix non-compiling code * Cleanup * iOS cleanup * Rollup of Rust dependency updates * Update snapshots * Finishing touches * Bump version * Fix iOS test code * Apply suggested name change * Update iOS guide * Update the rest of the docs * Fix the web! * Clean up examples * prettier * Update snapshot
stadiamaps · Dec 18, 2024 · c0f816b · c0f816b
1 parent ea0a50e
commit c0f816b
Show file tree

Hide file tree

Showing 30 changed files with 113,146 additions and 153 deletions.
diff --git a/.spi.yml b/.spi.yml
@@ -0,0 +1,5 @@
+version: 1
+builder:
+  configs:
+    - documentation_targets: [FerrostarCore, FerrostarMapLibreUI, FerrostarSwiftUI]
+      platform: ios
diff --git a/Package.resolved b/Package.resolved
@@ -50,8 +50,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/maplibre/swiftui-dsl",
       "state" : {
-        "revision" : "ba76be30097bb92f2316742316c2090cef934910",
-        "version" : "0.4.1"
+        "revision" : "e9ad08274471fb30e8cfddf55c3a6c5426943b20",
+        "version" : "0.4.3"
       }
     }
   ],

diff --git a/android/core/src/androidTest/java/com/stadiamaps/ferrostar/core/FerrostarCoreTest.kt b/android/core/src/androidTest/java/com/stadiamaps/ferrostar/core/FerrostarCoreTest.kt
@@ -31,6 +31,7 @@ import uniffi.ferrostar.RouteRequest
 import uniffi.ferrostar.RouteRequestGenerator
 import uniffi.ferrostar.RouteResponseParser
 import uniffi.ferrostar.RouteStep
+import uniffi.ferrostar.SpecialAdvanceConditions
 import uniffi.ferrostar.StepAdvanceMode
 import uniffi.ferrostar.UserLocation
 import uniffi.ferrostar.VisualInstruction
@@ -397,7 +398,11 @@ class FerrostarCoreTest {
     core.startNavigation(
         routes.first(),
         NavigationControllerConfig(
-            stepAdvance = StepAdvanceMode.RelativeLineStringDistance(16U, 16U),
+            stepAdvance =
+                StepAdvanceMode.RelativeLineStringDistance(
+                    16U,
+                    specialAdvanceConditions =
+                        SpecialAdvanceConditions.MinimumDistanceFromCurrentStepLine(16U)),
             routeDeviationTracking =
                 RouteDeviationTracking.Custom(
                     detector =

diff --git a/android/core/src/main/java/com/stadiamaps/ferrostar/core/Location.kt b/android/core/src/main/java/com/stadiamaps/ferrostar/core/Location.kt
@@ -179,14 +179,20 @@ class SimulatedLocationProvider : LocationProvider {
   }
 
   private suspend fun startSimulation() {
+    var pendingCompletion = false
+
     while (true) {
       delay((1.0 / warpFactor.toFloat()).toDuration(DurationUnit.SECONDS))
       val initialState = simulationState ?: return
       val updatedState = advanceLocationSimulation(initialState)
 
       // Stop if the route has been fully simulated (no state change).
       if (updatedState == initialState) {
-        return
+        if (pendingCompletion) {
+          return
+        } else {
+          pendingCompletion = true
+        }
       }
 
       simulationState = updatedState

diff --git a/android/demo-app/src/main/java/com/stadiamaps/ferrostar/AppModule.kt b/android/demo-app/src/main/java/com/stadiamaps/ferrostar/AppModule.kt
@@ -18,6 +18,7 @@ import okhttp3.OkHttpClient
 import uniffi.ferrostar.CourseFiltering
 import uniffi.ferrostar.NavigationControllerConfig
 import uniffi.ferrostar.RouteDeviationTracking
+import uniffi.ferrostar.SpecialAdvanceConditions
 import uniffi.ferrostar.StepAdvanceMode
 
 /**
@@ -86,7 +87,11 @@ object AppModule {
             navigationControllerConfig =
                 NavigationControllerConfig(
                     StepAdvanceMode.RelativeLineStringDistance(
-                        minimumHorizontalAccuracy = 25U, automaticAdvanceDistance = 10U),
+                        minimumHorizontalAccuracy = 25U,
+                        specialAdvanceConditions =
+                            // NOTE: We have not yet put this threshold through extensive real-world
+                            // testing
+                            SpecialAdvanceConditions.MinimumDistanceFromCurrentStepLine(10U)),
                     RouteDeviationTracking.StaticThreshold(15U, 50.0),
                     CourseFiltering.SNAP_TO_ROUTE),
             options =

diff --git a/apple/DemoApp/Demo/AppEnvironment.swift b/apple/DemoApp/Demo/AppEnvironment.swift
@@ -34,7 +34,10 @@ class AppEnvironment: ObservableObject {
         // Configure the navigation session.
         // You have a lot of flexibility here based on your use case.
         let config = SwiftNavigationControllerConfig(
-            stepAdvance: .relativeLineStringDistance(minimumHorizontalAccuracy: 32, automaticAdvanceDistance: 10),
+            stepAdvance: .relativeLineStringDistance(
+                minimumHorizontalAccuracy: 32,
+                specialAdvanceConditions: .minimumDistanceFromCurrentStepLine(10)
+            ),
             routeDeviationTracking: .staticThreshold(minimumHorizontalAccuracy: 25, maxAcceptableDeviation: 20),
             snappedLocationCourseFiltering: .snapToRoute
         )

diff --git a/apple/DemoApp/Demo/NavigationDelegate.swift b/apple/DemoApp/Demo/NavigationDelegate.swift
@@ -25,7 +25,9 @@ class NavigationDelegate: FerrostarCoreDelegate {
                 // but we provide devs with flexibility here.
                 let config = SwiftNavigationControllerConfig(
                     stepAdvance: .relativeLineStringDistance(minimumHorizontalAccuracy: 32,
-                                                             automaticAdvanceDistance: 10),
+                                                             specialAdvanceConditions: .minimumDistanceFromCurrentStepLine(
+                                                                 10
+                                                             )),
                     routeDeviationTracking: .staticThreshold(minimumHorizontalAccuracy: 25, maxAcceptableDeviation: 20),
                     snappedLocationCourseFiltering: .snapToRoute
                 )

diff --git a/apple/Sources/FerrostarCore/Location.swift b/apple/Sources/FerrostarCore/Location.swift
@@ -195,6 +195,8 @@ public class SimulatedLocationProvider: LocationProviding, ObservableObject {
     }
 
     private func updateLocation() async throws {
+        var pendingCompletion = false
+
         while isUpdating {
             // Exit if the task has been cancelled.
             try Task.checkCancellation()
@@ -213,8 +215,12 @@ public class SimulatedLocationProvider: LocationProviding, ObservableObject {
 
             // Stop if the route has been fully simulated (no state change).
             if initialState == updatedState {
-                stopUpdating()
-                return
+                if pendingCompletion {
+                    stopUpdating()
+                    return
+                } else {
+                    pendingCompletion = true
+                }
             }
 
             // Bump the last location.

diff --git a/apple/Sources/FerrostarSwiftUI/Views/InstructionsView.swift b/apple/Sources/FerrostarSwiftUI/Views/InstructionsView.swift
@@ -87,7 +87,7 @@ public struct InstructionsView: View {
                 maneuverType: visualInstruction.primaryContent.maneuverType,
                 maneuverModifier: visualInstruction.primaryContent.maneuverModifier,
                 distanceFormatter: distanceFormatter,
-                distanceToNextManeuver: step.distance == 0 ? nil : step.distance,
+                distanceToNextManeuver: step.distance,
                 theme: primaryRowTheme
             )
             .font(.title2.bold())
@@ -106,7 +106,7 @@ public struct InstructionsView: View {
                         maneuverType: visualInstruction.primaryContent.maneuverType,
                         maneuverModifier: visualInstruction.primaryContent.maneuverModifier,
                         distanceFormatter: distanceFormatter,
-                        distanceToNextManeuver: distanceToNextManeuver == 0 ? nil : distanceToNextManeuver,
+                        distanceToNextManeuver: distanceToNextManeuver,
                         theme: primaryRowTheme
                     )
                     .font(.title2.bold())

diff --git a/apple/Sources/UniFFI/ferrostar.swift b/apple/Sources/UniFFI/ferrostar.swift
diff --git a/apple/Tests/FerrostarCoreTests/FerrostarCoreTests.swift b/apple/Tests/FerrostarCoreTests/FerrostarCoreTests.swift
@@ -385,7 +385,10 @@ final class FerrostarCoreTests: XCTestCase {
 
         locationProvider.lastLocation = CLLocation(latitude: 0, longitude: 0).userLocation
         let config = SwiftNavigationControllerConfig(
-            stepAdvance: .relativeLineStringDistance(minimumHorizontalAccuracy: 16, automaticAdvanceDistance: 16),
+            stepAdvance: .relativeLineStringDistance(
+                minimumHorizontalAccuracy: 16,
+                specialAdvanceConditions: .advanceAtDistanceFromEnd(16)
+            ),
             routeDeviationTracking: .custom(detector: { _, _, _ in
                 // Pretend that the user is always off route
                 .offRoute(deviationFromRouteLine: 42)

diff --git a/common/ferrostar/proptest-regressions/algorithms.txt b/common/ferrostar/proptest-regressions/algorithms.txt
@@ -13,3 +13,4 @@ cc 9343327e3112d7e3337bda8d95349a10f7882025f43fa76201929eba8deaa87d # shrinks to
 cc b87a314ecd2957021a836398aa55a516f91d5fd526c2a4f9e5a57a42e8f597ae # shrinks to x1 = 1.7321418387536385, y1 = 1.3433541773527303e-308, x2 = 0.0, y2 = 17.833686113757857
 cc 9fa5f4eafafbffedde0d3fdaf6ac83f92c4aae3c9382d58855c07b562e1c59f1 # shrinks to x1 = 8.250574670883433e29, y1 = 0.0, x2 = 0.0, y2 = 7.980493463728753e-93, x3 = 0.0, y3 = 0.0, has_next_step = true, distance = 0, minimum_horizontal_accuracy = 0, excess_inaccuracy = 0.0, automatic_advance_distance = None
 cc 561ce71db95074e5505c8db3e95cb5d0c5b14a2e38e137dc7e72954dadc1608b # shrinks to bearing = 359.65552398004445
+cc 314739c47b6e4dc64c8e6170e02b9adf02b11229ce552fc418a0e3ecf902c5a4 # shrinks to x1 = 0.0, y1 = 0.0, x2 = -7.67381909875473e-185, y2 = 0.0, x3 = -1.50341296605448e-308, y3 = -0.0, has_next_step = true, distance = 0, minimum_horizontal_accuracy = 0, excess_inaccuracy = 0.0, threshold = Some(1)