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.

Project: platform/frameworks/support
Branch: androidx-master-dev

commit c60f33e229e31ab328ef6b59dab63b264954831c
Author: Alexandre Elias <aelias@google.com>
Date: Fri Jul 10 16:23:09 2020

Semantics no-op cleanups

Partly in response to lmr's broad code review, I did a pass of
superficial API/implementation cleanup. The main changes are:

- I changed each Boolean SemanticsProperty where false is equivalent to
not being present to take "Unit" instead. This is conceptually
clearer: it avoids questions like "can I cancel out a semantics from a
merged child by setting it to false?" Because "property = Unit" looks
weird, I also changed the style of these to "property()".

- I moved the Semantics id generator closer to where it's used, in
SemanticsModifierCore. I made it internal and an AtomicInt.
(Note that integer ids are heavily used in the Android
AccessibilityNodeInfo APIs so I can't simply remove them entirely.)

- I deleted dead code. Some examples include SemanticsHintOverrides,
a public API not connected to anything, and SemanticsPropertyKey
merge() open method which is never called. (In both cases I have
a different plan in mind for accessibility.)

Fixes: 145951226
Fixes: 145955412
Test: existing tests
Relnote: "Single-value semantics properties now use a calling style.
For example, 'semantics { hidden = true }' is now written as:
'semantics { hidden() }'."

Change-Id: Ic1afd12ea22c926babc9662f1804d80b33aa0cfc

M ui/integration-tests/benchmark/src/androidTest/java/androidx/ui/benchmark/test/LayoutNodeModifierBenchmark.kt
M ui/ui-core/api/0.1.0-dev15.txt
M ui/ui-core/api/current.txt
M ui/ui-core/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-core/api/public_plus_experimental_current.txt
M ui/ui-core/api/restricted_0.1.0-dev15.txt
M ui/ui-core/api/restricted_current.txt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/graphics/vector/VectorTest.kt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/semantics/SemanticsTests.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidActuals.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeView.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeViewAccessibilityDelegateCompat.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidPopup.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/Expect.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsConfiguration.kt
D ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsHintOverrides.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsModifier.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsNode.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsOwner.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsWrapper.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/semantics/SemanticsProperties.kt
M ui/ui-foundation/api/0.1.0-dev15.txt
M ui/ui-foundation/api/current.txt
M ui/ui-foundation/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-foundation/api/public_plus_experimental_current.txt
M ui/ui-foundation/api/restricted_0.1.0-dev15.txt
M ui/ui-foundation/api/restricted_current.txt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Clickable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Dialog.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Scroller.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Selectable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Toggleable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/semantics/FoundationSemanticsProperties.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ButtonTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CardTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CheckboxScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/RadioButtonScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ScaffoldTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SnackbarTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SurfaceTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ripple/RippleIndicationTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/textfield/TextFieldScreenshotTest.kt
M ui/ui-material/src/main/java/androidx/ui/material/AppBar.kt
M ui/ui-material/src/main/java/androidx/ui/material/TextFieldImpl.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/AssertsTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/CallSemanticsActionTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ErrorMessagesTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/FindersTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/PrintToStringTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ScrollToTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/TextActionsTest.kt
M ui/ui-test/src/main/java/androidx/ui/test/Actions.kt
M ui/ui-test/src/main/java/androidx/ui/test/Filters.kt
M ui/ui-text/api/0.1.0-dev15.txt
M ui/ui-text/api/current.txt
M ui/ui-text/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-text/api/public_plus_experimental_current.txt
M ui/ui-text/api/restricted_0.1.0-dev15.txt
M ui/ui-text/api/restricted_current.txt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/CoreTextField.kt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/TextSemanticsProperties.kt

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

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

I believe this behavior is by design: https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:car/app/app/src/main/java/androidx/car/app/navigation/model/NavigationTemplate.java;l=210-211;drc=29b6bb9c7851bb73374583fe2ec09263f4b1a24f

We do not want the destination travel estimate's remaining time to be unknown.

Can you explain the scenario you want to set an unknown remaining time in?

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.