Use fresh tokens (#9170)

DzmitryFomchyn · github-actions[bot] · commit 276bdc6a0fea · 2025-05-20T09:55:33.000Z
* Fix RoutingTilesOptions doc

* Remove token from RouteShieldToDownload

* Remove token from MapboxEvSearchClientFactory

* Fix GeoDeeplinkGeocoding, CarPlaceSearchOptions

GitOrigin-RevId: 1b5315e8035f5aa50a2e872ad169f2e50abf6555
diff --git a/androidauto/api/current.txt b/androidauto/api/current.txt
@@ -91,7 +91,8 @@ package com.mapbox.navigation.ui.androidauto.action {
 package com.mapbox.navigation.ui.androidauto.deeplink {
 
   public final class GeoDeeplinkGeocoding {
-    ctor public GeoDeeplinkGeocoding(String accessToken);
+    ctor @Deprecated public GeoDeeplinkGeocoding(String accessToken);
+    ctor public GeoDeeplinkGeocoding();
     method public void cancel();
     method public com.mapbox.api.geocoding.v5.MapboxGeocoding? getCurrentMapboxGeocoding();
     method public suspend Object? requestPlaces(com.mapbox.navigation.core.geodeeplink.GeoDeeplink geoDeeplink, com.mapbox.geojson.Point origin, kotlin.coroutines.Continuation<? super com.mapbox.api.geocoding.v5.models.GeocodingResponse>);
@@ -843,14 +844,14 @@ package com.mapbox.navigation.ui.androidauto.screenmanager.factories {
 package com.mapbox.navigation.ui.androidauto.search {
 
   public final class CarPlaceSearchOptions {
-    method public String? getAccessToken();
+    method @Deprecated public String? getAccessToken();
     method public com.mapbox.navigation.ui.androidauto.search.CarPlaceSearchOptions.Builder toBuilder();
-    property public final String? accessToken;
+    property @Deprecated public final String? accessToken;
   }
 
   public static final class CarPlaceSearchOptions.Builder {
     ctor public CarPlaceSearchOptions.Builder();
-    method public com.mapbox.navigation.ui.androidauto.search.CarPlaceSearchOptions.Builder accessToken(String? accessToken);
+    method @Deprecated public com.mapbox.navigation.ui.androidauto.search.CarPlaceSearchOptions.Builder accessToken(String? accessToken);
     method public com.mapbox.navigation.ui.androidauto.search.CarPlaceSearchOptions build();
   }
 
diff --git a/androidauto/src/main/java/com/mapbox/navigation/ui/androidauto/deeplink/GeoDeeplinkGeocoding.kt b/androidauto/src/main/java/com/mapbox/navigation/ui/androidauto/deeplink/GeoDeeplinkGeocoding.kt
@@ -3,6 +3,7 @@ package com.mapbox.navigation.ui.androidauto.deeplink
 import com.mapbox.api.geocoding.v5.GeocodingCriteria
 import com.mapbox.api.geocoding.v5.MapboxGeocoding
 import com.mapbox.api.geocoding.v5.models.GeocodingResponse
+import com.mapbox.common.MapboxOptions
 import com.mapbox.geojson.Point
 import com.mapbox.navigation.core.geodeeplink.GeoDeeplink
 import kotlinx.coroutines.Dispatchers
@@ -15,11 +16,17 @@ import retrofit2.Call
 import retrofit2.Callback
 import retrofit2.Response
 
-class GeoDeeplinkGeocoding(
-    private val accessToken: String,
+class GeoDeeplinkGeocoding private constructor(
+    private val accessTokenWrapper: AccessTokenWrapper,
 ) {
+
     var currentMapboxGeocoding: MapboxGeocoding? = null
 
+    @Deprecated("Access Token should not be cached. Use constructor without parameters")
+    constructor(accessToken: String) : this(AccessTokenWrapper.Predefined(accessToken))
+
+    constructor() : this(AccessTokenWrapper.Default)
+
     suspend fun requestPlaces(
         geoDeeplink: GeoDeeplink,
         origin: Point,
@@ -30,15 +37,15 @@ class GeoDeeplinkGeocoding(
         currentMapboxGeocoding = when {
             point != null -> {
                 MapboxGeocoding.builder()
-                    .accessToken(accessToken)
+                    .accessToken(accessTokenWrapper.getLatestToken())
                     .query(point)
                     .proximity(origin)
                     .geocodingTypes(GeocodingCriteria.TYPE_ADDRESS)
                     .build()
             }
             placeQuery != null -> {
                 MapboxGeocoding.builder()
-                    .accessToken(accessToken)
+                    .accessToken(accessTokenWrapper.getLatestToken())
                     .query(placeQuery)
                     .proximity(origin)
                     .build()
@@ -77,4 +84,17 @@ class GeoDeeplinkGeocoding(
             cancelCall()
         }
     }
+
+    private sealed class AccessTokenWrapper {
+
+        fun getLatestToken(): String {
+            return when (this) {
+                is Predefined -> accessToken
+                is Default -> MapboxOptions.accessToken
+            }
+        }
+
+        data class Predefined(val accessToken: String) : AccessTokenWrapper()
+        object Default : AccessTokenWrapper()
+    }
 }
diff --git a/androidauto/src/main/java/com/mapbox/navigation/ui/androidauto/deeplink/GeoDeeplinkNavigateAction.kt b/androidauto/src/main/java/com/mapbox/navigation/ui/androidauto/deeplink/GeoDeeplinkNavigateAction.kt
@@ -1,7 +1,6 @@
 package com.mapbox.navigation.ui.androidauto.deeplink
 
 import android.content.Intent
-import com.mapbox.common.MapboxOptions
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.core.geodeeplink.GeoDeeplink
 import com.mapbox.navigation.core.geodeeplink.GeoDeeplinkParser
@@ -23,7 +22,7 @@ class GeoDeeplinkNavigateAction(val mapboxCarContext: MapboxCarContext) {
     ): Boolean {
         logAndroidAuto("GeoDeeplinkNavigateAction preparePlacesListOnMapScreen")
         mapboxCarContext.geoDeeplinkPlacesProvider = GeoDeeplinkPlacesListOnMapProvider(
-            GeoDeeplinkGeocoding(MapboxOptions.accessToken),
+            GeoDeeplinkGeocoding(),
             geoDeeplink,
         )
         MapboxScreenManager.push(MapboxScreen.GEO_DEEPLINK)
diff --git a/androidauto/src/main/java/com/mapbox/navigation/ui/androidauto/search/CarPlaceSearchOptions.kt b/androidauto/src/main/java/com/mapbox/navigation/ui/androidauto/search/CarPlaceSearchOptions.kt
@@ -1,13 +1,15 @@
 package com.mapbox.navigation.ui.androidauto.search
 
-import com.mapbox.navigation.base.options.NavigationOptions
-
 /**
  * Options for the Car Mapbox Place Search.
  *
- * @param accessToken place search access token. If null the navigation access token is used.
+ * @param accessToken place search access token.
+ * No longer in use. The search component now uses the default MapboxOptions.accessToken
  */
 class CarPlaceSearchOptions private constructor(
+    @Deprecated(
+        "No longer in use. The search component now uses the default MapboxOptions.accessToken",
+    )
     val accessToken: String?,
 ) {
     /**
@@ -52,9 +54,12 @@ class CarPlaceSearchOptions private constructor(
         private var accessToken: String? = null
 
         /**
-         * Override the Mapbox Search access token. If null, the access token provided to
-         * [NavigationOptions.accessToken] will be used.
+         * Override the Mapbox Search access token.
+         * No longer in use. The search component now uses the default MapboxOptions.accessToken
          */
+        @Deprecated(
+            "No longer in use. The search component now uses the default MapboxOptions.accessToken",
+        )
         fun accessToken(accessToken: String?) = apply {
             this.accessToken = accessToken
         }
diff --git a/base/api/current.txt b/base/api/current.txt
@@ -537,9 +537,11 @@ package com.mapbox.navigation.base.options {
 
   public final class LocationOptions {
     method public com.mapbox.common.location.DeviceLocationProviderFactory? getLocationProviderFactory();
+    method public String getLocationProviderSource();
     method public String getLocationProviderType();
     method public com.mapbox.common.location.LocationProviderRequest getRequest();
     property public final com.mapbox.common.location.DeviceLocationProviderFactory? locationProviderFactory;
+    property public final String locationProviderSource;
     property public final String locationProviderType;
     property public final com.mapbox.common.location.LocationProviderRequest request;
     field public static final com.mapbox.navigation.base.options.LocationOptions.Companion Companion;
@@ -548,6 +550,7 @@ package com.mapbox.navigation.base.options {
   public static final class LocationOptions.Builder {
     ctor public LocationOptions.Builder();
     method public com.mapbox.navigation.base.options.LocationOptions build();
+    method public com.mapbox.navigation.base.options.LocationOptions.Builder defaultLocationProviderSource(String locationProviderSource);
     method public com.mapbox.navigation.base.options.LocationOptions.Builder locationProviderFactory(com.mapbox.common.location.DeviceLocationProviderFactory locationProviderFactory, @com.mapbox.navigation.base.options.LocationOptions.LocationProviderType.Type String locationProviderType);
     method public com.mapbox.navigation.base.options.LocationOptions.Builder request(com.mapbox.common.location.LocationProviderRequest request);
   }
@@ -557,6 +560,19 @@ package com.mapbox.navigation.base.options {
     property public final com.mapbox.common.location.LocationProviderRequest! DEFAULT_REQUEST;
   }
 
+  @kotlin.jvm.JvmInline public static final value class LocationOptions.LocationProviderSource {
+    field public static final com.mapbox.navigation.base.options.LocationOptions.LocationProviderSource.Companion Companion;
+  }
+
+  public static final class LocationOptions.LocationProviderSource.Companion {
+    method public String getBEST();
+    method public String getFUSED();
+    method public String getGPS();
+    property public final String BEST;
+    property public final String FUSED;
+    property public final String GPS;
+  }
+
   public static final class LocationOptions.LocationProviderType {
     field public static final com.mapbox.navigation.base.options.LocationOptions.LocationProviderType INSTANCE;
     field public static final String MIXED = "MIXED";
diff --git a/base/src/main/java/com/mapbox/navigation/base/options/RoutingTilesOptions.kt b/base/src/main/java/com/mapbox/navigation/base/options/RoutingTilesOptions.kt
@@ -1,7 +1,6 @@
 package com.mapbox.navigation.base.options
 
 import com.mapbox.common.TileStore
-import com.mapbox.common.TileStoreOptions
 import com.mapbox.navigation.base.ExperimentalMapboxNavigationAPI
 import java.net.URI
 
@@ -24,9 +23,7 @@ import java.net.URI
  * @param tileStore tile store instance. It manages downloads and storage for requests to
  * tile-related API endpoints. For offline/predictive-caching use cases this instance should be
  * the same that is passed to map resource options, see [MapboxMapsOptions.tileStore].
- * When creating the [TileStore] make sure to call [TileStore.setOption] with
- * [TileStoreOptions.MAPBOX_ACCESS_TOKEN] and your token. By default (if `null` is provided here),
- * the [TileStore] will be created with a [filePath] and [NavigationOptions.accessToken].
+ * By default (if `null` is provided here), the [TileStore] will be created with a [filePath].
  * @param minDaysBetweenServerAndLocalTilesVersion is the minimum time in days between local version of tiles
  * and latest on the server to consider using the latest version of routing tiles from the server.
  * **As updating tiles frequently consumes considerably energy and bandwidth**.
diff --git a/changelog/unreleased/features/0000.md b/changelog/unreleased/features/0000.md
@@ -0,0 +1,2 @@
+- ⚠️ Breaking changes in Experimental API. `MapboxEvSearchClientFactory.#getInstance()` no longer accepts access token as a parameter. The default `MapboxOptions.accessToken` will be used.
+- `CarPlaceSearchOptions.accessToken` and corresponding builder function has been deprecated because `accessToken` is no longer in use as the search component now uses the default `MapboxOptions.accessToken`.
diff --git a/navigation/src/main/java/com/mapbox/navigation/core/lifecycle/RequireMapboxNavigation.kt b/navigation/src/main/java/com/mapbox/navigation/core/lifecycle/RequireMapboxNavigation.kt
@@ -42,7 +42,6 @@ import kotlin.reflect.KProperty
  * ) {
  *   MapboxNavigationApp.setup(
  *       NavigationOptions.Builder(this)
- *           .accessToken(accessToken)
  *           .build()
  *     )
  * }
diff --git a/tripdata/src/main/java/com/mapbox/navigation/tripdata/maneuver/api/MapboxManeuverApi.kt b/tripdata/src/main/java/com/mapbox/navigation/tripdata/maneuver/api/MapboxManeuverApi.kt
@@ -6,7 +6,6 @@ import com.mapbox.api.directions.v5.models.DirectionsRoute
 import com.mapbox.api.directions.v5.models.RouteLeg
 import com.mapbox.bindgen.Expected
 import com.mapbox.bindgen.ExpectedFactory
-import com.mapbox.common.MapboxOptions
 import com.mapbox.navigation.base.formatter.DistanceFormatter
 import com.mapbox.navigation.base.route.NavigationRoute
 import com.mapbox.navigation.base.trip.model.RouteLegProgress
@@ -195,15 +194,13 @@ class MapboxManeuverApi internal constructor(
         maneuvers: List<Maneuver>,
         shieldCallback: RouteShieldCallback,
     ) {
-        val accessToken = MapboxOptions.accessToken
         mainJobController.scope.launch {
             val shields = mutableListOf<Expected<RouteShieldError, RouteShieldResult>>()
             maneuvers.forEach { maneuver ->
                 routeShieldApi.getRouteShieldsFromModels(
                     maneuver.primary.componentList.findShieldsToDownload(
                         userId = userId,
                         styleId = styleId,
-                        accessToken = accessToken,
                     ),
                 ).let { results ->
                     shields.addAll(results)
@@ -213,7 +210,6 @@ class MapboxManeuverApi internal constructor(
                         secondary.componentList.findShieldsToDownload(
                             userId = userId,
                             styleId = styleId,
-                            accessToken = accessToken,
                         ),
                     ).let { results ->
                         shields.addAll(results)
@@ -224,7 +220,6 @@ class MapboxManeuverApi internal constructor(
                         sub.componentList.findShieldsToDownload(
                             userId = userId,
                             styleId = styleId,
-                            accessToken = accessToken,
                         ),
                     ).let { results ->
                         shields.addAll(results)
@@ -243,7 +238,6 @@ class MapboxManeuverApi internal constructor(
     }
 
     private fun List<Component>.findShieldsToDownload(
-        accessToken: String,
         userId: String? = null,
         styleId: String? = null,
     ): List<RouteShieldToDownload> {
@@ -262,7 +256,6 @@ class MapboxManeuverApi internal constructor(
                             userId = userId,
                             styleId = styleId,
                         ),
-                        accessToken = accessToken,
                         mapboxShield = mapboxShield,
                         legacyFallback = legacy,
                     )
diff --git a/tripdata/src/main/java/com/mapbox/navigation/tripdata/shield/api/MapboxRouteShieldApi.kt b/tripdata/src/main/java/com/mapbox/navigation/tripdata/shield/api/MapboxRouteShieldApi.kt
@@ -3,7 +3,6 @@ package com.mapbox.navigation.tripdata.shield.api
 import android.graphics.Bitmap
 import com.mapbox.api.directions.v5.models.BannerComponents
 import com.mapbox.api.directions.v5.models.MapboxShield
-import com.mapbox.common.MapboxOptions
 import com.mapbox.navigation.base.road.model.Road
 import com.mapbox.navigation.base.road.model.RoadComponent
 import com.mapbox.navigation.tripdata.shield.RoadShieldContentManagerContainer
@@ -94,11 +93,9 @@ class MapboxRouteShieldApi {
         styleId: String?,
         callback: RouteShieldCallback,
     ) {
-        val accessToken = MapboxOptions.accessToken
         val routeShieldToDownload = mutableListOf<RouteShieldToDownload>()
         routeShieldToDownload.addAll(
             bannerComponents?.findShieldsToDownload(
-                accessToken = accessToken,
                 userId = userId,
                 styleId = styleId,
             ) ?: emptyList(),
@@ -189,7 +186,6 @@ class MapboxRouteShieldApi {
         val routeShieldToDownload = roadComponents.findShieldsToDownloadFromRoadComponent(
             userId = userId,
             styleId = styleId,
-            accessToken = MapboxOptions.accessToken,
         )
         getRouteShieldsInternal(routeShieldToDownload, callback)
     }
@@ -217,7 +213,6 @@ class MapboxRouteShieldApi {
     private fun List<BannerComponents>.findShieldsToDownload(
         userId: String?,
         styleId: String?,
-        accessToken: String,
     ): List<RouteShieldToDownload> {
         return this.mapNotNull { component ->
             if (component.type() == BannerComponents.ICON) {
@@ -237,7 +232,6 @@ class MapboxRouteShieldApi {
                             userId = userId,
                             styleId = styleId,
                         ),
-                        accessToken = accessToken,
                         mapboxShield = mapboxShield,
                         legacyFallback = legacy,
                     )
@@ -253,7 +247,6 @@ class MapboxRouteShieldApi {
     }
 
     private fun List<RoadComponent>.findShieldsToDownloadFromRoadComponent(
-        accessToken: String,
         userId: String?,
         styleId: String?,
     ): List<RouteShieldToDownload> {
@@ -272,7 +265,6 @@ class MapboxRouteShieldApi {
                         userId = userId,
                         styleId = styleId,
                     ),
-                    accessToken = accessToken,
                     mapboxShield = roadComponent.shield!!,
                     legacyFallback = legacy,
                 )
diff --git a/tripdata/src/main/java/com/mapbox/navigation/tripdata/shield/internal/model/RouteShieldToDownload.kt b/tripdata/src/main/java/com/mapbox/navigation/tripdata/shield/internal/model/RouteShieldToDownload.kt
@@ -2,6 +2,7 @@ package com.mapbox.navigation.tripdata.shield.internal.model
 
 import com.mapbox.api.directions.v5.models.MapboxShield
 import com.mapbox.api.directions.v5.models.ShieldSprite
+import com.mapbox.common.MapboxOptions
 
 private const val SPRITE = "/sprite"
 private const val SPRITE_BASE_URL = "https://api.mapbox.com/styles/v1/"
@@ -13,7 +14,6 @@ sealed class RouteShieldToDownload {
 
     data class MapboxDesign(
         val shieldSpriteToDownload: ShieldSpriteToDownload,
-        val accessToken: String,
         val mapboxShield: MapboxShield,
         val legacyFallback: MapboxLegacy? = null,
     ) : RouteShieldToDownload() {
@@ -24,7 +24,7 @@ sealed class RouteShieldToDownload {
             .plus(SPRITE)
             .plus("/${sprite.spriteName()}")
             .plus(REQUEST_ACCESS_TOKEN)
-            .plus(accessToken)
+            .plus(MapboxOptions.accessToken)
     }
 
     /**
@@ -44,7 +44,7 @@ internal fun RouteShieldToDownload.MapboxDesign.generateSpriteSheetUrl(): String
         .plus("${this.shieldSpriteToDownload.styleId}/")
         .plus(SPRITE_JSON)
         .plus(REQUEST_ACCESS_TOKEN)
-        .plus(accessToken)
+        .plus(MapboxOptions.accessToken)
 }
 
 internal data class SizeSpecificSpriteInfo(
diff --git a/tripdata/src/test/java/com/mapbox/navigation/tripdata/shield/model/RouteShieldToDownloadTest.kt b/tripdata/src/test/java/com/mapbox/navigation/tripdata/shield/model/RouteShieldToDownloadTest.kt

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+- ⚠️ Breaking changes in Experimental API. `MapboxEvSearchClientFactory.#getInstance()` no longer accepts access token as a parameter. The default `MapboxOptions.accessToken` will be used.
	`2`	+- `CarPlaceSearchOptions.accessToken` and corresponding builder function has been deprecated because `accessToken` is no longer in use as the search component now uses the default `MapboxOptions.accessToken`.