[cardano-testnet] Modify `renderStatusReportHumanReadable` to return `Doc Ann` instead.

Aperta
  • Qualcosa non va?
#6,746 0 commenti 0 reazioni 1 assegnatario Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

@palas ci sta già lavorando.

Dal 26/10/2026.

  • #6757 di @palas — aperta

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

renderStatusReportHumanReadable builds the report as a String: lines are joined with <> and unlines, and renderTable pads cells with pad and replicate. That one function decides the content, where lines break and how the output looks, so changing any of these (wrapping, colour, embedding a pretty-printed error) means rewriting string code. cardano-testnet already uses cardano-api's pretty-printing API (prettyError, docToString, docToText, pshow) and depends on prettyprinter, so the report could be a Doc Ann instead.

What prettyprinter gives here:

  • Layout is separate from content. A Doc describes the content and where lines may break. A layouter (layoutPretty, layoutSmart) turns it into a SimpleDocStream for a given page width, and a renderer turns that into Text. The report code no longer decides where lines end.
  • Line breaks depend on the available width. group, softline and flatAlt keep the summary line or the no-testnet explanation on one line when it fits, and break it when it does not. hang and align indent the continuation relative to the column where it started, so it lines up without counting the prefix length.
  • The renderer interprets annotations. Mark a node state as an error once with annotate. cardano-api's docToText uses the ANSI terminal renderer and shows it in colour, while unAnnotate gives plain text for goldens, pipes and log files. The layout code is the same for both.
  • It composes with existing Docs. cardano-api errors already render as Doc Ann (prettyError, prettyException), so a node's probe error could go into the report as it is, instead of being flattened to a String first. Pretty instances for NetworkStatus and NodeState can be reused the same way.

Today's report is short and has no colour, so these gains show once it grows, for example with the probe error from my comment on line 164.

A rough path:

  1. Return Doc Ann from renderStatusReportHumanReadable (both types come from Cardano.Api), and give NetworkStatus and NodeState Pretty instances.
  2. Build lines with pretty, <+> and vsep. Use group with softline, and hang, where a line can get long.
  3. In renderTable, keep the width calculation and replace pad width cell with fill width (pretty cell) from Prettyprinter. prettyprinter has no table combinator, so the borders stay hand-built.
  4. Render at the edges: docToText where Run.hs prints the report. If colour is added, apply unAnnotate before rendering in the golden test and when stdout is not a terminal.

Originally posted by @carbolymer in https://github.com/IntersectMBO/cardano-node/pull/6741#discussion_r4348812162

Lingua principale
Haskell
Stelle
3.2k
Fork
764
Merge medio
3g 2h
PR unite (30g)
22

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di IntersectMBO/cardano-node

Tutte le issue di IntersectMBO/cardano-node

Issue simili

Altre issue su Haskell

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.