Properly handle errors originating from included files when compileDebug is enabled

[tmont]

When calling render/compile with { compileDebug: true }, and an error was thrown from (or due to) a local, the str parameter in pug_rethrow was a toJSON()'d Buffer, and the rethrow code tried to split it like a string.

str would be something like:

{
  type: 'Buffer',
  data: [ /* a bunch of numbers */ ]
}

which is what happens when you do something like Buffer.from('foo').toJSON().

I couldn't really figure out where or how it happens, but I just made the rethrow function gracefully handle those serialized Buffer objects properly.

I wrote a test that failed (basically just calls an undefined function from an included file):

and then fixed it in this PR.

[rollingversions]

pug (3.0.0 → 3.0.1)

Bug Fixes

• Serialize Buffers to strings when storing sources for use with compileDebug: true

pug-runtime (3.0.0 → 3.0.1)

Bug Fixes

• Properly handle non-string values when rethrowing errors

Packages With No Changes

The following packages have no user facing changes, so won't be released:

• pug-attrs
• pug-code-gen
• pug-error
• pug-filters
• pug-lexer
• pug-linker
• pug-load
• pug-parser
• pug-strip-comments
• pug-walk

Edit changelogs

[ForbesLindesay]

Thanks for this. The fix will need to be done where we create the debug_sources object (

pug/packages/pug/lib/index.js

Line 167 in 06baa52

debug_sources[filename] = contents;

)

I think the best bet would be to move that code into the lex method (

pug/packages/pug/lib/index.js

Line 85 in 06baa52

lex: function(str, options) {

) so we can store the actual string, instead of a Buffer. The secondary advantage is that we only need debug_sources for files that we lex so it would produce a smaller output via not having any non-pug includes.

P.S. the filename should be available as options.filename in the lex function.

[tmont]

@ForbesLindesay Finally had time to revisit this. I also got tired of manually modifying the sources to apply this patch every time my template code has an error just so I can see what it was. :)

I moved the Buffer check code to the read function in main pug package and out of pug-runtime (although I left in some better error reporting in the case of weird stuff happening when trying to manage the strings, but that should only happen in internal code I think).