1355471 - Improve timeout deserialisation error message

Status: RESOLVED FIXED

(Remote Protocol :: Marionette, enhancement)

Description

[Andreas Tolfsen ❲:ato❳]

As can be seen from https://github.com/mozilla/geckodriver/issues/633, the error messages from the Set Timeouts command are not obvious.  It first look as the type of the value, but a more useful error message would explain that it is the key, or field, that is not recognised.

We can rectify this in Marionette by reordering the assertions.

Comment 1

[Andreas Tolfsen ❲:ato❳]

Attachment: Bug 1355471 - Test timeout field before value's typing;

The error message returned when unmarshalling the timeout configuration
object with invalid input is misleading, because it checks the typing
of the value before the field name.

This patch changes Marionette to run the type assertion for the value
after each case in the switch statement has been evaluated, ensuring
that the field is valid before asserting its value.

It also adds a few unit tests to verify this behaviour.

Fixes: https://github.com/mozilla/geckodriver/issues/633

Review commit: https://reviewboard.mozilla.org/r/128886/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/128886/

Comment 2

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Comment on attachment 8856975 [details]
Bug 1355471 - Test timeout field before value's typing;

https://reviewboard.mozilla.org/r/128886/#review131426

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/64fa27c7e727
Test timeout field before value's typing; r=whimboo

Comment 4

[Iris Hsiao [:ihsiao]]

https://hg.mozilla.org/mozilla-central/rev/64fa27c7e727

Comment 5

[Andreas Tolfsen ❲:ato❳]

Sheriffs: Please uplift to Aurora and Beta as test-only.

Comment 6

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/releases/mozilla-aurora/rev/999732bc0d64

Comment 7

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/releases/mozilla-beta/rev/37076febf926
https://hg.mozilla.org/releases/mozilla-release/rev/37076febf926