knitr capture reports every chunk error as rlang_error (knitr wraps errors via rlang::entrace)

Abierto
  • ¿Algo no está bien?
#1,129 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
55/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
r, rust
Área
backend, testing

Línea de trabajo

Start with crates/quarto-core/src/engine/knitr/resources/rmd/capture.R:150 and the failing test crates/quarto-core/src/engine/knitr/capture_tests.rs:170; trace how the captured condition supplies its class and error details. Run the reproduction command with R, knitr, rmarkdown, jsonlite, and rlang installed. Done means captured errors retain the original class, with tests covering ordinary and custom errors; the issue also leaves the desired error text and R-enabled CI coverage for discussion.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

bug testing

Summary

When rlang is installed, knitr runs every chunk error through rlang::entrace(). That function wraps the original error in a new condition of class rlang_error. Our knitr capture code (crates/quarto-core/src/engine/knitr/resources/rmd/capture.R:150) records ename = class(p)[[1]], so every captured error is reported as rlang_error. The user's actual class, such as simpleError or a custom class, is lost.

Since rlang is installed in almost every real R setup, this affects most users.

Reproduction

With R, knitr, rmarkdown, jsonlite and rlang installed:

cargo nextest run -p quarto-core --lib -E 'test(knitr::capture_tests::capture_classifies_pieces)'

panicked at crates/quarto-core/src/engine/knitr/capture_tests.rs:170:13:
assertion `left == right` failed
  left: "rlang_error"
 right: "simpleError"

Fails with both:

  • R 4.6.0, knitr 1.51, rlang 1.2.0, evaluate 1.0.5
  • R 4.6.0, knitr 1.52, rlang 1.3.0, evaluate 1.0.5 (latest CRAN as of 2026-11-09)

Cause

knitr:::knit_handlers appends rlang_entrace_handler (list(error = function(e) rlang::entrace(e))) to the chunk's calling_handlers whenever knitr:::has_rlang is TRUE. Reproduced with evaluate alone:

h <- evaluate::new_output_handler(
  calling_handlers = list(error = function(e) rlang::entrace(e)))
e <- evaluate::evaluate('stop("boom")', output_handler = h)[[2]]
class(e)        # "rlang_error" "error" "condition"
class(e$error)  # "simpleError" "error" "condition"

A custom error class is also replaced: with stop(structure(class = c("myError", "error", "condition"), ...)), class(e) is rlang_error and class(e$error) is myError.

Suggested fix

In capture.R, when p inherits from rlang_error and has an $error field, read ename from class(p$error)[[1]]. Otherwise fall back to class(p)[[1]]. Then decide whether evalue and call should also come from p$error.

A related question: knitr also changes the error text to rlang's format (Error:\n! boom instead of Error in …: boom). The test only checks starts_with("Error"), so it still passes, but we should decide whether that text is what we want to show.

Why CI didn't catch this

No CI workflow installs R, and every test in capture_tests.rs skips itself through r_available() when R is missing. These tests therefore only run on developer machines that have R. It's worth adding R (with knitr and rlang) to at least one CI leg.

Found while investigating pandoc 3.13 test failures; this failure is unrelated to pandoc.

Lenguaje dominante
Rust
Estrellas
302
Forks
22
Merge medio
5 h 8 min
PR fusionados (30 d)
220

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de quarto-dev/q2

Todos los issues de quarto-dev/q2

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.