Add a ReplayHistorySession

[kmadsen]

Description

We now have a very simple way to replay routes with TripSessionStarter and ReplayRoutesSession. What we want, is to add the ability to replay history. For this I'm adding a way to enable it through the TripSessionStarter so you can switch between replaying routes, regular active guidance, and replaying history. I'm also adding a ReplayHistorySession so we can isolate the logic for tests and use it for solutions that only need to replay a history file.

Unblocking https://mapbox.atlassian.net/browse/NAVAND-804

Examples

Using MapboxNavigationApp and the MapboxTripStarter.

    private val mapboxTripStarter = MapboxTripStarter.getRegisteredInstance()
        .enableReplayHistory(
            options = ReplayHistorySessionOptions.Builder()
                .filePath(getHistoryFile())
                .build()
        )

Using ReplayHistorySession and MapboxNavigation directly.

    private val replayHistorySession = ReplayHistorySession()
    
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(binding.root)

        replayHistorySession.onAttached(mapboxNavigation)
        replayHistorySession.setHistoryFile(getHistoryFile())
   }

   override fun onDestroy() {
        super.onDestroy()
        replayHistorySession.onDetached(mapboxNavigation)
   }

[github-actions]

Changelog

Features

• Introduced ReplayHistorySession and ReplayHistorySessionOptions to simplify the implementation for replaying history files. History can also be enabled with MapboxTripStarter.enableReplayHistory(). This can replay large history files in a memory efficient way. [#6855](https://github.com/mapbox/mapbox-navigation-android/pull/6855)
• Added RoadComponent.language value. [#6833](https://github.com/mapbox/mapbox-navigation-android/pull/6833)
• ⚠️ Changed EHorizonEdgeMetadata.names class from RoadName to RoadComponent. [#6833](https://github.com/mapbox/mapbox-navigation-android/pull/6833)
  To migrate change your code from:

val shielded = roadName.shielded

into:

val shielded = roadComponent.shield != null

• Added support for continuous EV alternatives in NavigationRouteAlternativesObserver. [#6833](https://github.com/mapbox/mapbox-navigation-android/pull/6833)
• Fixed issues with map-matching to HOV-only roads. [#6833](https://github.com/mapbox/mapbox-navigation-android/pull/6833)
• Set a limit of simultaneously running onboard route requests to avoid too many tasks blocking too much of the device's computing resources. [#6833](https://github.com/mapbox/mapbox-navigation-android/pull/6833)
• Fixed an issue with Road Access Policy ignoring the setting to map-match to closed road sections, when enabled. [#6833](https://github.com/mapbox/mapbox-navigation-android/pull/6833)
• Added MapboxTripStarter to simplify the solution for managing the trip session and replaying routes. This also makes it possible to share the replay state between drop-in-ui and android-auto. [#6794](https://github.com/mapbox/mapbox-navigation-android/pull/6794)

Bug fixes and improvements

• Increased max distance from the user indicator to route line valid to continue vanishing updates from 3m to 10m. [#6854](https://github.com/mapbox/mapbox-navigation-android/pull/6854)
• Fixed an issue where alternative routes might have had an incorrect or incomplete portion of the route refreshed or occasionally fail to refresh. [#6848](https://github.com/mapbox/mapbox-navigation-android/pull/6848)
• Removed NavigationRoute#hasUnexpectedClosures and added RouteProgress#hasUnexpectedUpcomingClosures instead that checks whether route has upcoming unexpected closures (the algorithm does not take into account closures that the puck has already been on) [#6841](https://github.com/mapbox/mapbox-navigation-android/pull/6841)
• Improved NavigationView camera behavior to go back into overview state if routes change during route preview state. [#6840](https://github.com/mapbox/mapbox-navigation-android/pull/6840)
• Improved NavigationView camera behavior to ignore keyboard insets. [#6845](https://github.com/mapbox/mapbox-navigation-android/pull/6845)

Known issues ⚠️

Other changes

Android Auto Changelog

Features

• Added support for Junction Views. [#6849](https://github.com/mapbox/mapbox-navigation-android/pull/6849)

Bug fixes and improvements

• Optimized SpeedLimitWidget memory usage. [#6859](https://github.com/mapbox/mapbox-navigation-android/pull/6859)

[Zayankovsky]

Do we need to add functions to NavigationViewApi?

[codecov]

Codecov Report

Merging #6855 (2ecee1c) into main (2ecee1c) will not change coverage.
The diff coverage is n/a.

❗ Current head 2ecee1c differs from pull request most recent head c9b1ec0. Consider uploading reports for the commit c9b1ec0 to get more accurate results

@@            Coverage Diff            @@
##               main    #6855   +/-   ##
=========================================
  Coverage     72.68%   72.68%           
  Complexity     5572     5572           
=========================================
  Files           782      782           
  Lines         30166    30166           
  Branches       3562     3562           
=========================================
  Hits          21926    21926           
  Misses         6814     6814           
  Partials       1426     1426           

[kmadsen]

Do we need to add functions to NavigationViewApi?

Yeah we do. I'm also thinking we should interact directly with MapboxTripStarter while it is experimental. That way we can flush out any experience issues before deciding on the concrete NavigationViewApi

I'm also not positive on what I think the NavigationViewApi should be. Here are the existing functions. At the very least we need to pass in a history file path, but what about error handling, what about the other options? So I'm thinking it deserves more consideration.