w3c/spec-generator

Return feedback earlier (useful to debug timeouts)

tripu opened this issue · 7 comments

tripu commented

I'm not very familiar with spec-generator, but I hope this makes sense:

When our instance of spec-generator crashes, or times out (sometimes due to memory issues), users are left with no information about the error.

Would it be possible to return some information straight away, and keep on writing a “log” while possible, until it crashes or times out (if it does). Ideally, returning a partial response to the client, or writing to the JS console (for interactive usage) — but if that's not feasible given the current architecture (because I think no response is sent back until the whole document is processed), at least have sever-side logs that are more verbose?

eg, right now, when there are errors, on the server we see things like:

Generating https://rawgit.com/w3c/coga/master/extension/index.html?publishDate=2016-09-14
😱 ReSpec error: [object Object]

which aren't terribly helpful.

@tripu, I'm on it.

Ok, covered generic cases with stack throw, and caught the actual error with that spec (their markup was invalid!):

screenshot 2016-09-20 14 40 37

Waiting for PR to be reviewed. Will release in the next day or so.

tripu commented

Brilliant, @marcoscaceres, thanks!

(Yes, we found the issue with that particular spec already.)

Ok, just merged. Will release in a little bit 🍾

If you spot other regular issues the you think ReSpec could better help users with, please bubble them up to Shane and I.

On 20 Sep. 2016, at 10:48 pm, tripu notifications@github.com wrote:

Brilliant, @marcoscaceres, thanks!

(Yes, we found the issue with that particular spec already.)


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.

tripu commented

Roger that :)

tripu commented

I think we can now close this one, right, @marcoscaceres?

Yep 👍 close it.