1065375 - [mozlog] HTML structured log formatter does not include stack trace

Status: RESOLVED FIXED

(Testing :: Mozbase, defect)

Description

[Dave Hunt [:davehunt] [he/him] ⌚BST]

The current HTML formatter does not include the stack trace, which makes it unsuitable to replace the HTML report generated by the Marionette test runner.

Comment 1

[Dave Hunt [:davehunt] [he/him] ⌚BST]

Attachment: Add stack track to HTML structured log formatter. v1.0

Comment 2

[James Graham [:jgraham]]

Comment on attachment 8487180 [details] [diff] [review]
Add stack track to HTML structured log formatter. v1.0

Review of attachment 8487180 [details] [diff] [review]:
-----------------------------------------------------------------

I think this needs a little fixup. I'm also not sure if it formats things in quite the way you want; did you test it?

::: testing/mozbase/mozlog/mozlog/structured/formatters/html/html.py
@@ +96,5 @@
>                  except:
>                      pass
>  
>              log = html.div(class_='log')
> +            output = data.get('stack', '') + data.get('message', '')

This seems to assume that the stacktrace always ends in a newline; I can't see immediately why that would be true. Better to make a list of all the lines you want like:

output = data.get('stack', '').splitlines() + data.get('message', '').splitlines()

Comment 3

[Dave Hunt [:davehunt] [he/him] ⌚BST]

Attachment: Add stack track to HTML structured log formatter. v1.1

(In reply to James Graham [:jgraham] from comment #2)
> Comment on attachment 8487180 [details] [diff] [review]
> Add stack track to HTML structured log formatter. v1.0
> 
> Review of attachment 8487180 [details] [diff] [review]:
> -----------------------------------------------------------------
> 
> I think this needs a little fixup. I'm also not sure if it formats things in
> quite the way you want; did you test it?

Yes, I tested it with a simple assertion failure and it was giving identical output to the HTML formatter provided by the Marionette test runner.

> ::: testing/mozbase/mozlog/mozlog/structured/formatters/html/html.py
> @@ +96,5 @@
> >                  except:
> >                      pass
> >  
> >              log = html.div(class_='log')
> > +            output = data.get('stack', '') + data.get('message', '')
> 
> This seems to assume that the stacktrace always ends in a newline; I can't
> see immediately why that would be true. Better to make a list of all the
> lines you want like:
> 
> output = data.get('stack', '').splitlines() + data.get('message',
> '').splitlines()

I was also surprised that there was a newline at the end of the stack trace. That said, I like your idea of ensuring that we're not relying on it.

Comment 4

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/ffda17f9ced6

Comment 5

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/mozilla-central/rev/ffda17f9ced6