quarto-dev / quarto-dev/quarto-cli

`quarto render` to a named pipe hangs

Open
#635 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
6k
Forks
458
Avg merge
1d 9h
Merged PRs (30d)
41

Description

I think what's happening is that we're assuming these are actual files, and Deno.readTextFileSync() hangs (I can't even ctrl-c my way out of the deno process.) If I rm the named pipe, then the next ctrl-c yields an error deep inside the html postprocessors:

NotFound: No such file or directory (os error 2), open 'a-pipe'
    at Object.opSync (deno:core/01_core.js:174:12)
    at openSync (deno:runtime/js/40_files.js:39:22)
    at readFileSync (deno:runtime/js/40_read_file.js:11:18)
    at Object.readTextFileSync (deno:runtime/js/40_read_file.js:39:24)
    at runHtmlPostprocessors (file:///Users/cscheid/repos/github/quarto-dev/quarto-cli/src/command/render/render.ts:1038:28)
    at renderPandoc (file:///Users/cscheid/repos/github/quarto-dev/quarto-cli/src/command/render/render.ts:657:39)
    at async Object.onRender (file:///Users/cscheid/repos/github/quarto-dev/quarto-cli/src/command/render/render.ts:860:26)
    at async renderFiles (file:///Users/cscheid/repos/github/quarto-dev/quarto-cli/src/command/render/render.ts:310:9)
    at async render (file:///Users/cscheid/repos/github/quarto-dev/quarto-cli/src/command/render/render-shared.ts:96:18)
    at async Command.fn (file:///Users/cscheid/repos/github/quarto-dev/quarto-cli/src/command/render/cmd.ts:179:26)

it seems hard to handle this correctly in general, so we should probably refuse to render to an existing location if we're in a unix system and we detect that a named pipe exists there.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in src/command/render/render.ts, especially runHtmlPostprocessors and the renderPandoc call shown in the stack trace. Reproduce rendering to an existing Unix named pipe and inspect how Deno.readTextFileSync() is reached. Done means the CLI refuses this destination instead of hanging, with the behavior limited to the stated Unix named-pipe case.

Written by the indexing model from the issue text.

Assessment

Tech stack
deno, javascript
Domain
cli
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.