Support EV route refresh

[dzinad]

Description

The PR has the following parts (split into the corresponding commits):

1. Get EV data updates from client and pass it as route refresh request parameters;
2. Update state_of_charge annotations after route refresh (provided via unrecognized properties);
3. Update waypoints after route refresh.

[dzinad]

This check fails for now because I've used the real Directions API response to form our test response but it returned less waypoints than I expected (and than as described in their docs). I've asked Mandeep a corresponding question.

[dzinad]

The fixed a bug, I've updated the mocked response appropriately. Should be working now.

[dzinad]

I've added a DO NOT MERGE label because some changes may be required after #6005 is merged.

[codecov]

Codecov Report

Merging #6511 (8af0a4c) into main (a45f7d4) will increase coverage by 0.07%.
The diff coverage is 85.45%.

@@             Coverage Diff              @@
##               main    #6511      +/-   ##
============================================
+ Coverage     70.26%   70.33%   +0.07%     
- Complexity     4918     4941      +23     
============================================
  Files           722      724       +2     
  Lines         28044    28148     +104     
  Branches       3305     3320      +15     
============================================
+ Hits          19705    19798      +93     
- Misses         7064     7074      +10     
- Partials       1275     1276       +1     

Impacted Files	Coverage Δ
...avigation/base/internal/RouteRefreshRequestData.kt	0.00% <0.00%> (ø)
...mapbox/navigation/base/internal/utils/Constants.kt	0.00% <0.00%> (ø)
...box/navigation/core/NavigationComponentProvider.kt	52.77% <0.00%> (ø)
...ore/routerefresh/RouteRefreshControllerProvider.kt	0.00% <0.00%> (ø)
...on/navigator/internal/MapboxNativeNavigatorImpl.kt	0.00% <0.00%> (ø)
...n/java/com/mapbox/navigation/core/SetRoutesInfo.kt	76.08% <80.00%> (ø)
.../mapbox/navigation/route/internal/RouterWrapper.kt	81.11% <88.23%> (+0.63%)	⬆️
...gation/base/internal/route/AnnotationsRefresher.kt	98.80% <96.42%> (+0.56%)	⬆️
...navigation/core/RouteRefreshRequestDataProvider.kt	96.55% <96.55%> (ø)
...avigation/base/internal/route/NavigationRouteEx.kt	84.37% <100.00%> (+3.60%)	⬆️
... and 8 more

[LukasPaczos]

Why Java? object can be nested as well.

[dzinad]

Because in kotlin this code:

object ConstantsKt {
    object RouteResponse {
        const val KEY_WAYPOINTS = "waypoints"
    }
}

looks like this:

public final class ConstantsKt {
   @NotNull
   public static final ConstantsKt INSTANCE;

   private ConstantsKt() {
   }

   static {
      ConstantsKt var0 = new ConstantsKt();
      INSTANCE = var0;
   }

   @Metadata(
      mv = {1, 5, 1},
      k = 1,
      d1 = {"\u0000\u0012\n\u0002\u0018\u0002\n\u0002\u0010\u0000\n\u0002\b\u0002\n\u0002\u0010\u000e\n\u0000\bÆ\u0002\u0018\u00002\u00020\u0001B\u0007\b\u0002¢\u0006\u0002\u0010\u0002R\u000e\u0010\u0003\u001a\u00020\u0004X\u0086T¢\u0006\u0002\n\u0000¨\u0006\u0005"},
      d2 = {"Lcom/mapbox/navigation/base/internal/utils/ConstantsKt$RouteResponse;", "", "()V", "KEY_WAYPOINTS", "", "mapbox-navigation-android.libnavigation-base.main"}
   )
   public static final class RouteResponse {
      @NotNull
      public static final String KEY_WAYPOINTS = "waypoints";
      @NotNull
      public static final ConstantsKt.RouteResponse INSTANCE;

      private RouteResponse() {
      }

      static {
         ConstantsKt.RouteResponse var0 = new ConstantsKt.RouteResponse();
         INSTANCE = var0;
      }
   }
}

Isn't it too much for a string constant?
I can add the JvmStatic annotation, but it's not much better.
Do you have anything against java? I can easily convert it to kotlin but I think that for the purposes like this (when you just need a holder for some constants) java is better (probably the only situation where I'd say this).

[VysotskiVadim]

I've wanted to try AutoValue classes written in java instead of writing custom equals, hashcode, toString for a long time but I'm too lazy to explore how java files affect compilation time in our project. Did you check if there are any possible issues we could have compiling java + kotlin in one project?

[dzinad]

Did you check if there are any possible issues we could have compiling java + kotlin in one project?

When you add kotlin to a java project compilation time increases. In the other direction it should be fine. In my experience 2 languages work fine.
Right now I don't see a regression. I've run the compilation several times and the time is between 1m 40s and 1m 50s with no obvious leader (sometimes one option is faster, sometimes the other).
But if you are worried there may be some issues, I can convert to kotlin.

[dzinad]

Converted to kotlin.

[LukasPaczos]

Thanks, that's an interesting point of view. I guess it's a general problem with objects that they are just singletons under the hood after compilation. Either way would work, I was just curious what was the motivation.

[LukasPaczos]

Suggested change

	* Pass **only changed** components of EV data via [data].
	*

As below, providing all the data at all times is not a problem.

[dzinad]

It's not a problem but I want to specify that it's not necessary to implement the caching on the app side. Changed the docs.

[LukasPaczos]

Some minor comments above and let's wait for #6005 (if we need to) but in general LGTM!

[dzinad]

Some minor comments above and let's wait for #6005 (if we need to)

Whoever merges first will leave the second person supporting these changes. :)

[RingerJK]

#6005 has landed

[Mundis2201]

CHANGELOG.md