1339103 - Python client unable to stringify error messages with Unicode characters (like "…") and fails to print exception details: TimeoutException: <unprintable TimeoutException object>

Status: NEW

(Testing :: Marionette Client and Harness, defect, P3)

Description

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

I tried to pass the following content as message to a TimeoutError. The Python client fails to actually print the message:

"Waiting for 127.0.0.1…"

> 1487003413236	Marionette	TRACE	conn6 <- [1,12,{"error":"timeout","message":"Error loading page, timed out: Waiting for 127.0.0.1…","stacktrace":"this.WebDriverError@chrome://marionette/content/error.js:214:17\nthis.TimeoutError@chrome://marionette/content/error.js:379:3\nonTimeout@chrome://marionette/content/driver.js:1165:16\n"},null]
[..]
TEST-UNEXPECTED-ERROR | test_minimized.py TestMinimizedTestCase.test | TimeoutException: <unprintable TimeoutException object>
Traceback (most recent call last):
  File "/Volumes/data/code/gecko/testing/marionette/harness/marionette_harness/marionette_test/testcases.py", line 166, in run
    testMethod()
  File "/Volumes/data/code/gecko/_a/test_minimized.py", line 30, in test
    self.marionette.navigate(self.marionette.absolute_url("slow"))
  File "/Volumes/data/code/gecko/testing/marionette/client/marionette_driver/marionette.py", line 1657, in navigate
    self._send_message("get", {"url": url})
  File "/Volumes/data/code/gecko/testing/marionette/client/marionette_driver/decorators.py", line 23, in _
    return func(*args, **kwargs)
  File "/Volumes/data/code/gecko/testing/marionette/client/marionette_driver/marionette.py", line 729, in _send_message
    self._handle_error(err)
  File "/Volumes/data/code/gecko/testing/marionette/client/marionette_driver/marionette.py", line 762, in _handle_error
    raise errors.lookup(error)(message, stacktrace=stacktrace)

Comment 1

[Andreas Tolfsen ❲:ato❳]

Did you pass the value as a Unicode string?  Did the Python file have "coding: utf-8"?

Comment 2

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

The three dots unicode character has been set in Javascript and not Python.

Comment 3

[Andreas Tolfsen ❲:ato❳]

I see, so it returns a TimeoutError with Unicode characters and it
gets unmarshaled to the Python TimeoutException object which it then
fails to stringify:

> TimeoutException: <unprintable TimeoutException object>

Comment 4

[Andreas Tolfsen ❲:ato❳]

Hm, not really able to reproduce this, but I suspect it can
have something to do with Unicode conversion between mozlog and
Marionette:

> >>> resp = Response.from_msg(r"""[1,12,{"error":"timeout","message":"Error loading page, timed out: Waiting for 127.0.0.1…","stacktrace":"this.WebDriverError@chrome://marionette/content/error.js:214:17\nthis.TimeoutError@chrome://marionette/content/error.js:379:3\nonTimeout@chrome://marionette/content/driver.js:1165:16\n"},null]""")
> >>> resp
> <marionette_driver.transport.Response object at 0x7fb93662e590>
> >>> str(resp)
> "<Response id=12, error={u'stacktrace': u'this.WebDriverError@chrome://marionette/content/error.js:214:17\\nthis.TimeoutError@chrome://marionette/content/error.js:379:3\\nonTimeout@chrome://marionette/content/driver.js:1165:16\\n', u'message': u'Error loading page, timed out: Waiting for 127.0.0.1\\u2026', u'error': u'timeout'}, result=None>"
> >>> resp.error
> {u'stacktrace': u'this.WebDriverError@chrome://marionette/content/error.js:214:17\nthis.TimeoutError@chrome://marionette/content/error.js:379:3\nonTimeout@chrome://marionette/content/driver.js:1165:16\n', u'message': u'Error loading page, timed out: Waiting for 127.0.0.1\u2026', u'error': u'timeout'}
> >>> str(resp.error)
> "{u'stacktrace': u'this.WebDriverError@chrome://marionette/content/error.js:214:17\\nthis.TimeoutError@chrome://marionette/content/error.js:379:3\\nonTimeout@chrome://marionette/content/driver.js:1165:16\\n', u'message': u'Error loading page, timed out: Waiting for 127.0.0.1\\u2026', u'error': u'timeout'}"

Comment 5

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

Please note that I didn't escape the unicode character. Maybe that makes the difference here.