Revert "Support waypoints per route (#1503)" (#1506)

* Revert "Support waypoints per route (#1503)"

This reverts commit 796f12d.

* changelog v6.9.0

Author: korshaknn

CHANGELOG.md

@@ -3,6 +3,8 @@
 Mapbox welcomes participation and contributions from everyone.
 
 ### main
+- Removed `RouteOptions#waypointsPerRoute()` and `RouteOption.Builders#waypointsPerRoute()` methods. [#1506](https://github.com/mapbox/mapbox-java/pull/1506)
+- Removed `DirectionsRoute#waypoints` and made non-deprecated `DirectionsResponse#waypoints`. [#1506](https://github.com/mapbox/mapbox-java/pull/1506)
 
 ### v6.9.0-beta.2 - November 03, 2022
 - Added `RouteOptions#waypointsPerRoute()` and `RouteOption.Builders#waypointsPerRoute()` methods. [#1503](https://github.com/mapbox/mapbox-java/pull/1503)

samples/src/main/java/com/mapbox/samples/BasicDirectionsWaypointsPerRoute.java

@@ -66,16 +66,10 @@ public static Builder builder() {
    * List of {@link DirectionsWaypoint} objects. Each {@code waypoint} is an input coordinate
    * snapped to the road and path network. The {@code waypoint} appear in the list in the order of
    * the input coordinates.
-   * @deprecated the waypoints are returned in the root of the response only if
-   *   {@link RouteOptions#waypointsPerRoute()} is false. Otherwise they are returned in
-   *   {@link DirectionsRoute#waypoints()}. You can continue to use this and it will work as-is.
-   *   However, it's recommended to use the new approach to distinguish waypoints between routes
-   *   (for example, this is necessary when asking for an EV-optimized route with alternatives).
    *
    * @return list of {@link DirectionsWaypoint} objects ordered from start of route till the end
    * @since 1.0.0
    */
-  @Deprecated
   @Nullable
   public abstract List<DirectionsWaypoint> waypoints();
 
@@ -269,18 +263,12 @@ public abstract static class Builder extends DirectionsJsonObject.Builder<Builde
      * List of {@link DirectionsWaypoint} objects. Each {@code waypoint} is an input coordinate
      * snapped to the road and path network. The {@code waypoint} appear in the list in the order of
      * the input coordinates.
-     * @deprecated the waypoints are returned in the root of the response only if
-     *   {@link RouteOptions#waypointsPerRoute()} is false. Otherwise they are returned in
-     *   {@link DirectionsRoute#waypoints()}. You can continue to use this and it will work as-is.
-     *   However, it's recommended to use the new approach to distinguish waypoints between routes
-     *   (for example, this is necessary when asking for an EV-optimized route with alternatives).
      *
      * @param waypoints list of {@link DirectionsWaypoint} objects ordered from start of route till
      *                  the end
      * @return this builder for chaining options together
      * @since 3.0.0
      */
-    @Deprecated
     public abstract Builder waypoints(@Nullable List<DirectionsWaypoint> waypoints);
 
     /**

services-directions-models/src/main/java/com/mapbox/api/directions/v5/models/DirectionsResponse.java

@@ -110,19 +110,6 @@ public static Builder builder() {
   @Nullable
   public abstract List<RouteLeg> legs();
 
-  /**
-   * List of {@link DirectionsWaypoint} objects. Each {@code waypoint} is an input coordinate
-   * snapped to the road and path network. The {@code waypoint} appear in the list in the order of
-   * the input coordinates.
-   * Waypoints are returned in the {@link DirectionsRoute} object only when
-   * {@link RouteOptions#waypointsPerRoute()} is set to true. Otherwise they are returned
-   * in the root: {@link DirectionsResponse#waypoints()}.
-   *
-   * @return list of {@link DirectionsWaypoint} objects ordered from start of route till the end
-   */
-  @Nullable
-  public abstract List<DirectionsWaypoint> waypoints();
-
   /**
    * Holds onto the parameter information used when making the directions request. Useful for
    * re-requesting a directions route using the same information previously used.
@@ -314,21 +301,6 @@ public abstract static class Builder extends DirectionsJsonObject.Builder<Builde
     @NonNull
     public abstract Builder legs(@Nullable List<RouteLeg> legs);
 
-    /**
-     * List of {@link DirectionsWaypoint} objects. Each {@code waypoint} is an input coordinate
-     * snapped to the road and path network. The {@code waypoint} appear in the list in the order of
-     * the input coordinates.
-     * Waypoints are returned in the {@link DirectionsRoute} object only when
-     * {@link RouteOptions#waypointsPerRoute()} is set to true. Otherwise they are returned
-     * in the root: {@link DirectionsResponse#waypoints()}.
-     *
-     * @param waypoints list of {@link DirectionsWaypoint} objects ordered from start of route
-     *                  till the end
-     * @return this builder for chaining options together
-     */
-    @NonNull
-    public abstract Builder waypoints(@Nullable List<DirectionsWaypoint> waypoints);
-
     /**
      * Holds onto the parameter information used when making the directions request.
      *

services-directions-models/src/main/java/com/mapbox/api/directions/v5/models/DirectionsRoute.java

@@ -688,18 +688,6 @@ public List<Point> waypointTargetsList() {
     return ParseUtils.parseToPoints(waypointTargets());
   }
 
-  /**
-   * If true, the waypoints array is returned within the route object, else its returned
-   * at the root of the response body. Defaults to false if unspecified.
-   * Setting `waypoints_per_route` to true is necessary when asking for an EV-optimized
-   * route with alternatives, since each alternative route may produce separate
-   * sets of waypoints (charging stations).
-   * @return boolean representing the waypoints_per_route value
-   */
-  @SerializedName("waypoints_per_route")
-  @Nullable
-  public abstract Boolean waypointsPerRoute();
-
   /**
    * A scale from -1 to 1, where -1 biases the route against alleys
    * and 1 biases the route toward alleys. If null, default is 0, which is neutral.
@@ -1043,7 +1031,6 @@ public URL toUrl(@NonNull String accessToken) {
     appendQueryParameter(sb, "max_width", maxWidth());
     appendQueryParameter(sb, "max_weight", maxWeight());
     appendQueryParameter(sb, "compute_toll_cost", computeTollCost());
-    appendQueryParameter(sb, "waypoints_per_route", waypointsPerRoute());
     appendQueryParameter(sb, "metadata", metadata());
 
     Map<String, SerializableJsonElement> unrecognized = unrecognized();
@@ -2044,19 +2031,6 @@ public Builder snappingIncludeStaticClosuresList(
     @SuppressWarnings("checkstyle:javadocmethod")
     public abstract Builder computeTollCost(@Nullable Boolean computeTollCost);
 
-    /**
-     * If true, the waypoints array is returned within the route object, else its returned
-     * at the root of the response body. Defaults to false if unspecified.
-     * Setting `waypoints_per_route` to true is necessary when asking for an EV-optimized
-     * route with alternatives, since each alternative route may produce separate
-     * sets of waypoints (charging stations).
-     *
-     * @param waypointsPerRoute boolean representing the `waypoints_per_route` value
-     * @return this builder
-     */
-    @NonNull
-    public abstract Builder waypointsPerRoute(@Nullable Boolean waypointsPerRoute);
-
     /**
      * Whether the response should contain metadata holding versioning information.
      * <p>

services-directions-models/src/main/java/com/mapbox/api/directions/v5/models/RouteOptions.java

@@ -9,9 +9,6 @@
 
 import java.io.IOException;
 import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.List;
-
 import org.hamcrest.junit.ExpectedException;
 import org.junit.Rule;
 import org.junit.Test;
@@ -133,7 +130,9 @@ public void directionsRoute_hasTollCosts() throws IOException {
     String uuid = "123";
     DirectionsRoute route = DirectionsRoute.fromJson(json, options, uuid);
 
-    assertEquals(2, route.tollCosts().size());
+    DirectionsRoute newRoute = route.toBuilder().routeIndex("0").build();
+
+    assertEquals(2, newRoute.tollCosts().size());
   }
 
   @Test
@@ -149,72 +148,8 @@ public void directionsRoute_noTollCosts() throws IOException {
     String uuid = "123";
     DirectionsRoute route = DirectionsRoute.fromJson(json, options, uuid);
 
-    assertNull(route.tollCosts());
-  }
-
-  @Test
-  public void directionsRoute_hasWaypoints() throws IOException {
-    String json = loadJsonFixture("directions_v5_with_waypoints.json");
-    RouteOptions options = RouteOptions.builder()
-      .profile(DirectionsCriteria.PROFILE_DRIVING_TRAFFIC)
-      .coordinatesList(new ArrayList<Point>() {{
-        add(Point.fromLngLat(1.0, 1.0));
-        add(Point.fromLngLat(2.0, 2.0));
-      }})
-      .waypointsPerRoute(true)
-      .build();
-    String uuid = "123";
-    DirectionsRoute route = DirectionsRoute.fromJson(json, options, uuid);
-
-    assertEquals(2, route.waypoints().size());
-  }
-
-  @Test
-  public void directionsRouteBuilder_hasWaypoints() {
-    List<DirectionsWaypoint> waypoints = Arrays.asList(
-      DirectionsWaypoint.builder()
-        .name("name1")
-        .rawLocation(new double[] { 5.6, 7.8 })
-        .build(),
-      DirectionsWaypoint.builder()
-        .name("name2")
-        .rawLocation(new double[] { 1.2, 3.4 })
-        .build()
-    );
-    DirectionsRoute route = DirectionsRoute.builder()
-      .duration(12.12)
-      .distance(34.34)
-      .waypoints(waypoints)
-      .build();
-
-    assertEquals(waypoints, route.waypoints());
-  }
-
-
-  @Test
-  public void directionsRoute_noWaypoints() throws IOException {
-    String json = loadJsonFixture("directions_v5-with-closure_precision_6.json");
-    RouteOptions options = RouteOptions.builder()
-      .profile(DirectionsCriteria.PROFILE_DRIVING_TRAFFIC)
-      .coordinatesList(new ArrayList<Point>() {{
-        add(Point.fromLngLat(1.0, 1.0));
-        add(Point.fromLngLat(2.0, 2.0));
-      }})
-      .waypointsPerRoute(true)
-      .build();
-    String uuid = "123";
-    DirectionsRoute route = DirectionsRoute.fromJson(json, options, uuid);
-
-    assertNull(route.waypoints());
-  }
-
-  @Test
-  public void directionsRouteBuilder_noWaypoints() {
-    DirectionsRoute route = DirectionsRoute.builder()
-      .duration(12.12)
-      .distance(34.34)
-      .build();
+    DirectionsRoute newRoute = route.toBuilder().routeIndex("0").build();
 
-    assertNull(route.waypoints());
+    assertNull(newRoute.tollCosts());
   }
 }

services-directions-models/src/test/java/com/mapbox/api/directions/v5/models/DirectionsRouteTest.java

@@ -37,7 +37,7 @@ public class RouteOptionsTest extends TestUtils {
    */
   private static final String ROUTE_OPTIONS_JSON = "route_options_v5.json";
   private static final String ROUTE_OPTIONS_URL =
-    "https://api.mapbox.com/directions/v5/mapbox/driving/-122.4003312,37.7736941;-122.4187529,37.7689715;-122.4255172,37.7775835?access_token=pk.token&geometries=polyline6&alternatives=false&overview=full&radiuses=%3Bunlimited%3B5.1&steps=true&avoid_maneuver_radius=200.0&bearings=0%2C90%3B90%2C0%3B&layers=-42%3B%3B0&continue_straight=false&annotations=congestion%2Cdistance%2Cduration&language=ru&roundabout_exits=false&voice_instructions=true&banner_instructions=true&voice_units=metric&exclude=toll%2Cferry%2Cpoint%2811.0+-22.0%29&include=hot%2Chov2&approaches=%3Bcurb%3B&waypoints=0%3B1%3B2&waypoint_names=%3BSerangoon+Garden+Market+%26+Food+Centre%3BFunky+%26nAmE*&waypoint_targets=%3B12.2%2C21.2%3B&enable_refresh=true&walking_speed=5.11&walkway_bias=-0.2&alley_bias=0.75&snapping_include_closures=%3Bfalse%3Btrue&snapping_include_static_closures=true%3B%3Bfalse&arrive_by=2021-01-01%27T%2701%3A01&depart_at=2021-02-02%27T%2702%3A02&max_height=1.5&max_width=1.4&max_weight=2.9&compute_toll_cost=true&waypoints_per_route=true&metadata=true";
+    "https://api.mapbox.com/directions/v5/mapbox/driving/-122.4003312,37.7736941;-122.4187529,37.7689715;-122.4255172,37.7775835?access_token=pk.token&geometries=polyline6&alternatives=false&overview=full&radiuses=%3Bunlimited%3B5.1&steps=true&avoid_maneuver_radius=200.0&bearings=0%2C90%3B90%2C0%3B&layers=-42%3B%3B0&continue_straight=false&annotations=congestion%2Cdistance%2Cduration&language=ru&roundabout_exits=false&voice_instructions=true&banner_instructions=true&voice_units=metric&exclude=toll%2Cferry%2Cpoint%2811.0+-22.0%29&include=hot%2Chov2&approaches=%3Bcurb%3B&waypoints=0%3B1%3B2&waypoint_names=%3BSerangoon+Garden+Market+%26+Food+Centre%3BFunky+%26nAmE*&waypoint_targets=%3B12.2%2C21.2%3B&enable_refresh=true&walking_speed=5.11&walkway_bias=-0.2&alley_bias=0.75&snapping_include_closures=%3Bfalse%3Btrue&snapping_include_static_closures=true%3B%3Bfalse&arrive_by=2021-01-01%27T%2701%3A01&depart_at=2021-02-02%27T%2702%3A02&max_height=1.5&max_width=1.4&max_weight=2.9&compute_toll_cost=true&metadata=true";
   private static final String ACCESS_TOKEN = "pk.token";
 
   private final String optionsJson = loadJsonFixture(ROUTE_OPTIONS_JSON);
@@ -349,27 +349,13 @@ public void computeTollCostIsValid_fromJson() {
     assertEquals(true, options.computeTollCost());
   }
 
-  @Test
-  public void waypointsPerRouteAreValid_fromJson() {
-    RouteOptions routeOptions = RouteOptions.fromJson(optionsJson);
-
-    assertEquals(true, routeOptions.waypointsPerRoute());
-  }
-
   @Test
   public void defaultTollCost() {
     RouteOptions options = defaultRouteOptions();
 
     assertNull(options.computeTollCost());
   }
 
-  @Test
-  public void defaultWaypointsPerRoute() {
-    RouteOptions options = defaultRouteOptions();
-
-    assertNull(options.waypointsPerRoute());
-  }
-
   @Test
   public void routeOptions_toJson() {
     RouteOptions options = routeOptions();
@@ -1060,7 +1046,6 @@ private RouteOptions routeOptions() {
       .enableRefresh(true)
       .metadata(true)
       .computeTollCost(true)
-      .waypointsPerRoute(true)
       .build();
   }
 
@@ -1167,7 +1152,6 @@ private RouteOptions routeOptionsList() {
       .enableRefresh(true)
       .metadata(true)
       .computeTollCost(true)
-      .waypointsPerRoute(true)
       .build();
   }
 }

services-directions-models/src/test/java/com/mapbox/api/directions/v5/models/RouteOptionsTest.java

@@ -36,6 +36,5 @@
   "max_weight": 2.9,
   "enable_refresh": true,
   "metadata": true,
-  "waypoints_per_route": true,
   "compute_toll_cost": true
 }