NavigationTemplate throws Exception on TravelEstimate.REMAINING_TIME_UNKNOWN [183632456]

Fixed

Bug

Status Update

No update yet.

Description

ra...@googlemail.com

created issue #1

Mar 25, 2021 09:55AM

Auto library version: "androidx.car.app:app:1.0.0-beta01"

When setting TravelEstimate.setReimingSeconds(TravelEstimate.REMAINING_TIME_UNKNOWN) and then calling NavigationTemplate.setDestinationTravelEstimate(travelEstimate) an Exeption is thrown:

 Caused by: java.lang.IllegalArgumentException: The destination travel estimate's remaining time must be greater or equal to zero
        at androidx.car.app.navigation.model.NavigationTemplate$Builder.setDestinationTravelEstimate(NavigationTemplate.java:217)
        at com.iternio.abrpapp.auto.screens.NavigationScreen.onGetTemplate(NavigationScreen.java:173)
        at androidx.car.app.Screen.getTemplateWrapper(Screen.java:340)
        at androidx.car.app.ScreenManager.getTopTemplate(ScreenManager.java:214)

The documentation of TravelEstimate.setRemainingTimeSeconds contains this:

public TravelEstimate.Builder setRemainingTimeSeconds(@IntRange(from = -1L) long remainingTimeSeconds)
Sets the estimated time remaining until arriving at the destination, in seconds.
If not set, REMAINING_TIME_UNKNOWN will be used.

If i manually set it to REMAINING_TIME_UNKNOWN i get the exception in NavigationTemplate.Builder.setDestinationTravelEstimate()

Which says:

Throws:
IllegalArgumentException – if the TravelEstimate's remaining time is less than zero

This is not consistent!

BR Samuel

Comments

sh...@google.com <sh...@google.com> #2Mar 25, 2021 04:10PM

Assigned to ja...@google.com.

Hi Ed, Thank you so much for these suggestions. I've been reviewing them and merging them in. Hopefully it should be live. I've included a thank you note too in the article.

ja...@google.com <ja...@google.com> #3Mar 25, 2021 04:37PM

Great! Thanks a lot, I'll look for the live updates soon!

ra...@googlemail.com <ra...@googlemail.com> #4Mar 25, 2021 04:51PM

Initially I came across this as for some reasons we had a negative remaining seconds value somewhere. Then I saw that there is a property REMAINING_TIME_UNKNOWN that can be set in the travel estimate so I used that one instead if for some reason the time is wrong. According to travel estimate this is possible. So if the template can not deal with it, the travel estimate should not allow it either.

ja...@google.com <ja...@google.com> #5Mar 25, 2021 05:03PM

I see. The TravelEstimate object can take an unknown time in other places - see https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:car/app/app/src/main/java/androidx/car/app/navigation/NavigationManager.java. However, the destination travel estimate cannot take an unknown time.

sh...@google.com <sh...@google.com> #6Mar 25, 2021 06:07PM

This might be a good candidate to slightly improve the documentation.

In TravelEstimate.Builder#setRemaningTime, we can document something like: "Note that REMAINING_TIME_UNKNOWN may not be supported depending on where the {@link TravelEstimate} is used. See the documentation of where this is used for any restrictions that might apply"

ra...@googlemail.com <ra...@googlemail.com> #7Mar 25, 2021 06:16PM

Fine with me, guess that would help.

ap...@google.com <ap...@google.com> #8Mar 29, 2021 06:36PM

Project: platform/frameworks/support
Branch: androidx-main

commit b699061d27012a15895eaa257bda62fff77bf9fe
Author: Jay Yoo <jayyoo@google.com>
Date: Thu Mar 25 17:24:22 2021

Update `TravelEstimate` and `NavigationTemplate` javadoc on when an unknown time is not allowed

Relnote: Updated javadoc on when setting a `TravelEstimate`'s remaining time to an unknown time is allowed.
Test: n/a
Bug: 183632456
Change-Id: I9961081b996822fae8f8763abe578cb622a3d23d

M car/app/app/src/main/java/androidx/car/app/navigation/model/NavigationTemplate.java
M car/app/app/src/main/java/androidx/car/app/navigation/model/TravelEstimate.java

https://android-review.googlesource.com/1654507

ja...@google.com <ja...@google.com> Mar 30, 2021 11:43PM

Marked as fixed.