pugjs/pug

Generated `debug_sources` are node `Buffer`s and fail `pug_rethrow`

Open

#3,290 opened on Aug 18, 2020

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (1,955 forks)batch import
Good First Issuebug

Repository metrics

Stars
 (21,509 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Pug Version: your version number here 3.0.0

Node Version: your version number here 14.7.0

When an included file is read, it's Buffer being stored in debug_sources:

https://github.com/pugjs/pug/blob/06baa525a23049756de9587461d389a12bc12537/packages/pug/lib/index.js#L167

Later, this value is passed to the generator and being serialized as-it in the final render function.

https://github.com/pugjs/pug/blob/06baa525a23049756de9587461d389a12bc12537/packages/pug/lib/index.js#L204

Which fails pug_rethrow's expectation, and makes it throw:

https://github.com/pugjs/pug/blob/f97ebdb48c7c0fdd4ff4b7418dcf4e03b27a1405/packages/pug-runtime/index.js#L256

Contributor guide

Research direction
Examine the code in `packages/pug/lib/index.js` around lines 167 and 204 to understand where `debug sources` gets a Buffer. Then check `packages/pug runtime/index.js` line 256 to see why `pug rethrow` fails. The fix likely involves converting the Buffer to a string before storing or serializing.
Tech stack
javascriptnodejs
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Node.jsBuffers
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60