[cherry-pick] Offline tiles managment (#10315)

* Offline tiles managment (#10285)

* Provide NavigationOfflineTilesetVersionManager functionality

* Add changelog

* Remove changelog which is already added to 3.12 GA notes

* Update public API

GitOrigin-RevId: 4a4e3d1541a407decde84f6a2532b171e203e036

Author: DzmitryFomchyn

libtesting-utils/src/main/java/com/mapbox/navigation/testing/BlockingSAMCallback.kt

@@ -0,0 +1,19 @@
+package com.mapbox.navigation.testing
+
+import java.util.concurrent.CountDownLatch
+
+class BlockingSAMCallback<T : Any> : (T) -> Unit {
+
+    private var countDownLatch = CountDownLatch(1)
+    private lateinit var result: T
+
+    override fun invoke(result: T) {
+        this.result = result
+        countDownLatch.countDown()
+    }
+
+    fun getResultBlocking(): T {
+        countDownLatch.await()
+        return result
+    }
+}

navigation/api/current.txt

@@ -46,6 +46,7 @@ package com.mapbox.navigation.core {
     method public com.mapbox.navigation.core.routerefresh.RouteRefreshController getRouteRefreshController();
     method @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public com.mapbox.navigation.core.preview.RoutesPreview? getRoutesPreview();
     method public com.mapbox.navigation.core.navigator.TilesetDescriptorFactory getTilesetDescriptorFactory();
+    method public com.mapbox.navigation.core.navigator.offline.TilesetVersionManager getTilesetVersionManager();
     method public com.mapbox.navigation.core.trip.session.TripSessionState getTripSessionState();
     method public Integer? getZLevel();
     method public boolean isDestroyed();
@@ -126,6 +127,7 @@ package com.mapbox.navigation.core {
     property public final com.mapbox.navigation.core.trip.session.eh.RoadObjectsStore roadObjectsStore;
     property public final com.mapbox.navigation.core.routerefresh.RouteRefreshController routeRefreshController;
     property public final com.mapbox.navigation.core.navigator.TilesetDescriptorFactory tilesetDescriptorFactory;
+    property public final com.mapbox.navigation.core.navigator.offline.TilesetVersionManager tilesetVersionManager;
   }
 
   public final class MapboxNavigationKt {
@@ -208,12 +210,14 @@ package com.mapbox.navigation.core.adas {
 
   @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public final class AdasEdgeAttributes {
     method public java.util.List<com.mapbox.navigation.core.adas.AdasValueOnEdge> getCurvatures();
+    method public java.util.List<com.mapbox.navigation.core.adas.AdasValueOnEdge> getElevations();
     method public int getEtc2();
     method public Integer? getFormOfWay();
     method public java.util.List<com.mapbox.navigation.core.adas.AdasValueOnEdge> getSlopes();
     method public java.util.List<com.mapbox.navigation.core.adas.AdasSpeedLimitInfo> getSpeedLimit();
     method public Boolean? isDividedRoad();
     property public final java.util.List<com.mapbox.navigation.core.adas.AdasValueOnEdge> curvatures;
+    property public final java.util.List<com.mapbox.navigation.core.adas.AdasValueOnEdge> elevations;
     property public final int etc2;
     property public final Integer? formOfWay;
     property public final Boolean? isDividedRoad;
@@ -697,6 +701,69 @@ package com.mapbox.navigation.core.navigator {
 
 }
 
+package com.mapbox.navigation.core.navigator.offline {
+
+  public final class DownloadedTilesetsFetcherKt {
+  }
+
+  @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public abstract class TilesetUpdateAvailabilityResult {
+  }
+
+  public static final class TilesetUpdateAvailabilityResult.Available extends com.mapbox.navigation.core.navigator.offline.TilesetUpdateAvailabilityResult {
+    ctor public TilesetUpdateAvailabilityResult.Available(String regionId, boolean isAsap, String currentVersion, String latestVersion);
+    method public String getCurrentVersion();
+    method public String getLatestVersion();
+    method public String getRegionId();
+    method public boolean isAsap();
+    property public final String currentVersion;
+    property public final boolean isAsap;
+    property public final String latestVersion;
+    property public final String regionId;
+  }
+
+  public static final class TilesetUpdateAvailabilityResult.NoUpdates extends com.mapbox.navigation.core.navigator.offline.TilesetUpdateAvailabilityResult {
+    field public static final com.mapbox.navigation.core.navigator.offline.TilesetUpdateAvailabilityResult.NoUpdates INSTANCE;
+  }
+
+  @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public final class TilesetVersion {
+    method public java.util.Date? getReleaseDate();
+    method public String getVersionName();
+    method public boolean isBlocked();
+    method public boolean isLatest();
+    property public final boolean isBlocked;
+    property public final boolean isLatest;
+    property public final java.util.Date? releaseDate;
+    property public final String versionName;
+  }
+
+  @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public interface TilesetVersionManager {
+    method public default com.mapbox.common.Cancelable getAvailableUpdate(String regionId, com.mapbox.navigation.core.navigator.offline.TilesetVersionManager.TilesetUpdatesCallback callback);
+    method public com.mapbox.common.Cancelable getAvailableUpdate(String regionId, long maxAllowedAgeDifferenceMinutes, com.mapbox.navigation.core.navigator.offline.TilesetVersionManager.TilesetUpdatesCallback callback);
+    method public suspend Object? getAvailableUpdate(String regionId, long maxAllowedAgeDifferenceMinutes = 0, kotlin.coroutines.Continuation<? super com.mapbox.bindgen.Expected<java.lang.Throwable,com.mapbox.navigation.core.navigator.offline.TilesetUpdateAvailabilityResult>> = 0);
+    method public default com.mapbox.common.Cancelable getAvailableUpdates(com.mapbox.navigation.core.navigator.offline.TilesetVersionManager.AllTilesetsUpdatesCallback callback);
+    method public com.mapbox.common.Cancelable getAvailableUpdates(long maxAllowedAgeDifferenceMinutes, com.mapbox.navigation.core.navigator.offline.TilesetVersionManager.AllTilesetsUpdatesCallback callback);
+    method public suspend Object? getAvailableUpdates(long maxAllowedAgeDifferenceMinutes = 0, kotlin.coroutines.Continuation<? super com.mapbox.bindgen.Expected<java.lang.Throwable,java.util.List<? extends com.mapbox.navigation.core.navigator.offline.TilesetUpdateAvailabilityResult.Available>>> = 0);
+    method public com.mapbox.common.Cancelable getAvailableVersions(com.mapbox.navigation.core.navigator.offline.TilesetVersionManager.TilesetVersionsCallback callback);
+    method public suspend Object? getAvailableVersions(kotlin.coroutines.Continuation<? super com.mapbox.bindgen.Expected<java.lang.Throwable,java.util.List<? extends com.mapbox.navigation.core.navigator.offline.TilesetVersion>>>);
+  }
+
+  public static fun interface TilesetVersionManager.AllTilesetsUpdatesCallback {
+    method public void onUpdatesResult(com.mapbox.bindgen.Expected<java.lang.Throwable,java.util.List<com.mapbox.navigation.core.navigator.offline.TilesetUpdateAvailabilityResult.Available>> result);
+  }
+
+  public static fun interface TilesetVersionManager.TilesetUpdatesCallback {
+    method public void onUpdatesResult(com.mapbox.bindgen.Expected<java.lang.Throwable,com.mapbox.navigation.core.navigator.offline.TilesetUpdateAvailabilityResult> result);
+  }
+
+  public static fun interface TilesetVersionManager.TilesetVersionsCallback {
+    method public void onVersionsResult(com.mapbox.bindgen.Expected<java.lang.Throwable,java.util.List<com.mapbox.navigation.core.navigator.offline.TilesetVersion>> versions);
+  }
+
+  public final class TilesetVersionsApiKt {
+  }
+
+}
+
 package com.mapbox.navigation.core.preview {
 
   @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public final class RoutesPreview {
@@ -1346,6 +1413,9 @@ package com.mapbox.navigation.core.trip.session {
     method public void onNewRawLocation(com.mapbox.common.location.Location rawLocation);
   }
 
+  public final class MapboxTripSessionKt {
+  }
+
   public abstract sealed class NavigationSessionState {
     method public abstract String getSessionId();
     property public abstract String sessionId;

navigation/build.gradle

@@ -1,9 +1,13 @@
-apply plugin: 'com.android.library'
-apply plugin: 'kotlin-android'
-apply plugin: 'kotlin-kapt'
-apply plugin: 'org.jetbrains.dokka'
-apply plugin: 'com.jaredsburrows.license'
-apply plugin: 'com.mapbox.android.sdk.versions'
+plugins {
+    id 'com.android.library'
+    id 'kotlin-android'
+    id 'kotlin-kapt'
+    id 'org.jetbrains.kotlin.plugin.serialization' version '1.7.20'
+    id 'org.jetbrains.dokka'
+    id 'com.jaredsburrows.license'
+    id 'com.mapbox.android.sdk.versions'
+}
+
 apply from: "../gradle/ktlint.gradle"
 apply from: file("../gradle/artifact-settings.gradle")
 apply from: "../gradle/kdoc-settings.gradle"
@@ -55,6 +59,7 @@ dependencies {
     implementation dependenciesList.mapboxSdkRefreshModels
 
     implementation dependenciesList.kotlinStdLib
+    implementation dependenciesList.kotlinSerialization
     implementation dependenciesList.coroutinesAndroid
     implementation dependenciesList.androidStartup
 

navigation/src/main/java/com/mapbox/navigation/core/MapboxNavigation.kt

@@ -83,6 +83,7 @@ import com.mapbox.navigation.core.mapmatching.MapMatchingOptions
 import com.mapbox.navigation.core.mapmatching.MapMatchingSuccessfulResult
 import com.mapbox.navigation.core.navigator.CacheHandleWrapper
 import com.mapbox.navigation.core.navigator.TilesetDescriptorFactory
+import com.mapbox.navigation.core.navigator.offline.TilesetVersionManager
 import com.mapbox.navigation.core.preview.RoutesPreview
 import com.mapbox.navigation.core.preview.RoutesPreviewObserver
 import com.mapbox.navigation.core.replay.MapboxReplayer
@@ -434,6 +435,17 @@ class MapboxNavigation @VisibleForTesting internal constructor(
     @Deprecated("EtcGateApi is deprecated")
     val etcGateAPI: EtcGateApi
 
+    /**
+     * Manager for checking tileset version availability and update requirements.
+     * This manager provides functionality to:
+     * - Check available tileset versions from the server
+     * - Determine if downloaded tilesets need updates based on age or version
+     * - Identify blocked versions that should not be used
+     * @see TilesetVersionManager for detailed API documentation
+     */
+    @ExperimentalPreviewMapboxNavigationAPI
+    val tilesetVersionManager: TilesetVersionManager
+
     private var reachabilityObserverId: Long? = null
 
     private var latestLegIndex: Int? = null
@@ -714,6 +726,11 @@ class MapboxNavigation @VisibleForTesting internal constructor(
             navigator,
         )
 
+        tilesetVersionManager = NavigationComponentProvider.createTilesetVersionManager(
+            routingTilesOptions = navigationOptions.routingTilesOptions,
+            tileStore = NavigationTileStoreOwner.invoke(),
+        )
+
         registerRouteProgressObserver(
             NavigationComponentProvider.createForkPointPassedObserver(
                 directionsSession,

navigation/src/main/java/com/mapbox/navigation/core/NavigationComponentProvider.kt

@@ -2,11 +2,14 @@ package com.mapbox.navigation.core
 
 import android.content.Context
 import com.mapbox.common.SdkInformation
+import com.mapbox.common.TileStore
+import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.base.internal.accounts.SkuIdProvider
 import com.mapbox.navigation.base.internal.performance.PerformanceTracker
 import com.mapbox.navigation.base.options.EventsAppMetadata
 import com.mapbox.navigation.base.options.LocationOptions
 import com.mapbox.navigation.base.options.RerouteOptions
+import com.mapbox.navigation.base.options.RoutingTilesOptions
 import com.mapbox.navigation.base.trip.notification.TripNotification
 import com.mapbox.navigation.core.accounts.BillingController
 import com.mapbox.navigation.core.arrival.ArrivalProgressObserver
@@ -15,6 +18,9 @@ import com.mapbox.navigation.core.directions.session.DirectionsSession
 import com.mapbox.navigation.core.directions.session.MapboxDirectionsSession
 import com.mapbox.navigation.core.ev.EVDynamicDataHolder
 import com.mapbox.navigation.core.internal.router.Router
+import com.mapbox.navigation.core.navigator.offline.DownloadedTilesetsFetcher
+import com.mapbox.navigation.core.navigator.offline.TilesetVersionManager
+import com.mapbox.navigation.core.navigator.offline.TilesetVersionManagerImpl
 import com.mapbox.navigation.core.preview.NativeRoutesDataParser
 import com.mapbox.navigation.core.preview.RoutesPreviewController
 import com.mapbox.navigation.core.reroute.InternalRerouteController
@@ -183,4 +189,15 @@ internal object NavigationComponentProvider {
         directionsSession,
         currentLegIndex,
     )
+
+    @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
+    fun createTilesetVersionManager(
+        routingTilesOptions: RoutingTilesOptions,
+        tileStore: TileStore,
+    ): TilesetVersionManager = TilesetVersionManagerImpl(
+        tilesBaseUri = routingTilesOptions.tilesBaseUri.toString(),
+        tilesDataset = routingTilesOptions.tilesDataset,
+        tilesProfile = routingTilesOptions.tilesProfile,
+        downloadedTilesetsFetcher = DownloadedTilesetsFetcher(tileStore),
+    )
 }