Add RouterErrorType.MISSING_TILES_ERROR (#11532)

* Add RouterErrorType.MISSING_TILES_ERROR

* Add errors to annotations

* Add changelog

* Update Common and Maps versions in Dash app

* Update mapbox3dLiveNavigation version

GitOrigin-RevId: 5701501a345b96ecd7b5d605c509d53ee8a434ba

Author: stanis-k

base/src/main/java/com/mapbox/navigation/base/route/RouterFailureType.kt

@@ -13,6 +13,8 @@ import androidx.annotation.StringDef
     RouterFailureType.AUTHENTICATION_ERROR,
     RouterFailureType.ROUTE_CREATION_ERROR,
     RouterFailureType.RESPONSE_PARSING_ERROR,
+    RouterFailureType.ROUTER_RECREATION_ERROR,
+    RouterFailureType.MISSING_TILES_ERROR,
     RouterFailureType.UNKNOWN_ERROR,
 )
 annotation class RouterFailureType {
@@ -59,6 +61,11 @@ annotation class RouterFailureType {
          */
         const val ROUTER_RECREATION_ERROR = "ROUTER_RECREATION_ERROR"
 
+        /**
+         * Error caused by missing tiles required for route calculation
+         */
+        const val MISSING_TILES_ERROR = "MISSING_TILES_ERROR"
+
         /**
          * Error has an unknown type
          */

changelog/unreleased/features/11532.md

@@ -0,0 +1 @@
+- Introduce RouterFailureType::MISSING_TILES_ERROR to indicate inability to build a route due to missing routing tiles

gradle/dependencies.gradle

@@ -11,7 +11,7 @@ ext {
   // mapboxSdkHdFullSparseCheckout in generate_api_docs_android.sh depends on mapboxSdkVersionSuffix
   // Release Train depends on these two lines below
   // https://github.com/mapbox/release-train/blob/bd530da200d62fb45166ef91d7d892d90a453fa6/backend/model/step/navcoreandroid/PrepareChangelogNavCore.py#L122-L124
-  def mapboxSdkVersionSuffix = '17.0-rc.3'
+  def mapboxSdkVersionSuffix = '17.0-rc.3-SNAPSHOT-12-01--08-09.git-8ce4de4'
   def mapboxNavigatorVersion = "324.${mapboxSdkVersionSuffix}"
 
   def ndkVersionSuffix = ""

navigation/src/main/java/com/mapbox/navigation/core/internal/router/RouterErrorMapper.kt

@@ -15,7 +15,7 @@ internal fun RouterErrorType.mapToSdkRouterFailureType(): String {
         RouterErrorType.AUTHENTICATION_ERROR -> RouterFailureType.AUTHENTICATION_ERROR
         RouterErrorType.ROUTE_CREATION_ERROR -> RouterFailureType.ROUTE_CREATION_ERROR
         RouterErrorType.REQUEST_CANCELLED -> error("Should have been processed separately")
-        RouterErrorType.MAP_MATCHING_CREATION_ERROR ->
-            RouterFailureType.ROUTE_CREATION_ERROR
+        RouterErrorType.MAP_MATCHING_CREATION_ERROR -> RouterFailureType.ROUTE_CREATION_ERROR
+        RouterErrorType.MISSING_TILES_ERROR -> RouterFailureType.MISSING_TILES_ERROR
     }
 }

navigation/src/test/java/com/mapbox/navigation/core/internal/router/RouterWrapperTests.kt

@@ -1421,6 +1421,30 @@ class RouterWrapperTests {
             }.build()
     }
 
+    @Test
+    fun `route request missing tiles error`() =
+        coroutineRule.runBlockingTest {
+            routerWrapper.getRoute(routerOptions, signature, navigationRouterCallback)
+            getRouteSlot.captured.run(
+                ExpectedFactory.createError(
+                    listOf(
+                        createRouterError(
+                            type = RouterErrorType.MISSING_TILES_ERROR,
+                        ),
+                    ),
+                ),
+                nativeOriginOnboard,
+            )
+
+            val failures = slot<List<RouterFailure>>()
+            verify(exactly = 1) {
+                navigationRouterCallback.onFailure(capture(failures), routerOptions)
+            }
+            val failure: RouterFailure = failures.captured[0]
+            assertFalse(failure.isRetryable)
+            assertEquals(RouterFailureType.MISSING_TILES_ERROR, failure.type)
+        }
+
     private companion object {
 
         private const val CANCELLED_MESSAGE = "Cancelled"