locli: create reports as typst documents

Author: mgmeier

bench/locli/locli.cabal

@@ -16,6 +16,7 @@ license-files:          LICENSE
                         -- The module src-quick/Graphics/EasyPlot.hs is a forked, and heavily modded,
                         -- version of the easyplot-1.0 package by Julian Bertram.
 extra-doc-files:        CHANGELOG.md
+data-files:             report-templates/typst/*
 build-type:             Simple
 
 common project-config

bench/locli/report-templates/typst/main_comparison.ede

@@ -0,0 +1,118 @@
+#set page(paper: "a4")
+
+// these settings make the output look more LaTeX-like
+// #set page(margin: 1.75in)
+#set par(leading: 0.55em, spacing: 0.55em, first-line-indent: 1.8em, justify: true)
+// #set text(font: "Ubuntu")
+// #show raw: set text(font: "Ubuntu Mono")
+#show heading: set block(above: 1.5em, below: 1.2em)
+
+#metadata("{{ report.tag }}.{{ base.fileInfix }}.pdf") <export_file_name>
+
+
+// Semibold row descriptions
+#show table.cell.where(x: 0): set text(weight: "semibold")
+
+// No strokes inside table body; left alignment for row descriptions only
+#let frame(stroke) = (x, y) => (
+  left: if x > 0 { 0pt } else { stroke },
+  right: stroke,
+  top: if y < 2 { stroke } else { 0pt },
+  bottom: stroke,
+)
+#set table(
+  stroke: frame(1pt),
+  align:  (x, _) => if x == 0 { left } else { right }
+)
+
+// table coloring
+#let gr(c) = table.cell(fill: green.lighten(60%))[c]
+
+
+//   #+CONSTANTS: base=../../{{ base.meta.tag }}/analysis
+//   {% for run in runs %}
+//   #+CONSTANTS: run{{ run.index }}=../../{{ run.value.meta.tag }}/analysis
+
+
+
+The Title Page
+
+{{ report.target }} against {{ base.ver }}
+
+{{ base.workload }} workload
+{{ report.author }}, Cardano Performance team
+{{ report.date }}
+
+#pagebreak()
+
+
+#set page(numbering: "1")
+#counter(page).update(1)
+
+#outline()
+
+#pagebreak()
+
+= Manifest
+
+We compare {% for run in runs %}{%if !run.first%}{%if !run.last%}, {%else%} and {%endif%}{%endif%}`{{ run.value.ver }}` ({{ run.value.meta.era | toTitle }}){% endfor %} relative to `{{ base.ver }}` ({{ base.meta.era | toTitle }}), under {{ base.workload }} workload.
+
+{% include "table_summary.ede" with table = summary %}
+
+#pagebreak()
+
+= Analysis
+
+
+#pagebreak()
+
+
+= Observations
+
+== Resources
+
++ ...
+
+== Forging
+
++ ...
+
+== Peer propagation
+
++ ...
+
+== End-to-end propagation
+
++ ...
+
+
+#pagebreak()
+
+= Appendix A: charts
+
+== Cluster performance charts
+
+
+#pagebreak()
+
+
+#set par(
+    first-line-indent: (amount: 0pt, all: true),
+    spacing: 1.35em
+)
+
+= Appendix B: data dictionary
+
+== Block propagation metrics
+
+{% for m in dictionary.dBlockProp %}
+*{{ m.value.deShortDesc }}* (_{{ m.value.deField }}_) -- {{ m.value.deDescription }}
+
+{% endfor %}
+
+== Cluster performance metrics
+
+{% for m in dictionary.dClusterPerf %}
+*{{ m.value.deShortDesc }}* (_{{ m.value.deField }}_) -- {{ m.value.deDescription }}
+
+{% endfor %}

bench/locli/report-templates/typst/table_summary.ede

@@ -0,0 +1,13 @@
+
+
+#table(
+  columns: {{ table.header | length }},
+
+  table.header(
+    {% for col in table.header %}{{ col.value.cont | justifyRight(col.value.width) }},  {% endfor %}
+  ),
+
+{% for row in table.rows %}
+    {% for col in row.value %}{{ col.value.cont | justifyRight(col.value.width) }},  {% endfor %}
+{% endfor %}
+)

bench/locli/src/Cardano/Command.hs

@@ -329,6 +329,7 @@ writerOpt ctor desc rcFormat = do
      AsOrg     -> (,) "org"     " as Org-mode table"
      AsReport  -> (,) "org-report"  " as Org-mode summary table"
      AsPretty  -> (,) "pretty"  " as text report"
+     AsTypst   -> (,) "typst"   " as typst document"
 
 writerOpts :: (RenderConfig -> TextOutputFile -> a) -> String -> Parser a
 writerOpts ctor desc = enumFromTo minBound maxBound
@@ -840,7 +841,7 @@ runChainCommand s c@(Compare ede mTmpl outf@(TextOutputFile outfp) runs) = do
       <*> readJsonData bpf  (CommandError c)
   (tmpl, tmplEnv, orgReport) <- case xs of
     baseline:deltas@(_:_) -> liftIO $ do
-      Cardano.Report.generate ede mTmpl baseline deltas
+      Cardano.Report.generateOrg ede mTmpl baseline deltas
     _ -> throwE $ CommandError c $ mconcat
          [ "At least two runs required for comparison." ]
   liftIO $
@@ -853,6 +854,22 @@ runChainCommand s c@(Compare ede mTmpl outf@(TextOutputFile outfp) runs) = do
   liftIO . unlessM (IO.fileExist tmplPath) $
     BS.writeFile tmplPath tmpl
 
+  (tmpl', tmplEnv', typstReport) <- case xs of
+    baseline:deltas@(_:_) -> liftIO $ do
+      Cardano.Report.generateTypst ede mTmpl baseline deltas
+    _ -> throwE $ CommandError c $ mconcat
+         [ "At least two runs required for comparison." ]
+  liftIO $
+    withFile (outfp `System.FilePath.replaceExtension` "env.typ.json") WriteMode $
+      \hnd -> BS8.hPutStrLn hnd tmplEnv'
+  let typstPath = Cardano.Util.replaceExtension outfp "typ"
+  dumpText "report" [typstReport] (TextOutputFile typstPath)
+    & firstExceptT (CommandError c)
+
+  let tmplPath' = Cardano.Util.replaceExtension outfp "typ.ede"
+  liftIO . unlessM (IO.fileExist tmplPath) $
+    BS.writeFile tmplPath' tmpl'
+
   pure s
 
 missingCommandData :: ChainCommand -> [String] -> ExceptT CommandError IO a

bench/locli/src/Cardano/Render.hs

@@ -44,6 +44,7 @@ data RenderFormat
   | AsOrg
   | AsReport
   | AsPretty
+  | AsTypst
   deriving (Eq, Show, Bounded, Enum)
 
 -- | Explain the poor human a little bit of what was going on:
@@ -335,9 +336,14 @@ modeFilename orig@(TextOutputFile f) name = \case
   AsOrg     -> orig
   AsReport  -> orig
   AsPretty  -> orig
+  AsTypst   -> orig
 
 renderAnalysisCDFs :: forall a p. (CDFFields a p, KnownCDF p, ToJSON (a p)) => Anchor -> (Field DSelect p a -> Bool) -> CDF2Aspect -> Maybe [Centile] -> RenderConfig -> a p -> [(Text, [Text])]
 
+-- TODO:MKarg
+renderAnalysisCDFs anchor fieldSelr _c2a _centileSelr rc@RenderConfig{rcFormat=AsTypst} x =
+  renderAnalysisCDFs anchor fieldSelr _c2a _centileSelr rc{rcFormat=AsOrg} x
+
 renderAnalysisCDFs _anchor _fieldSelr _c2a _centileSelr RenderConfig{rcFormat=AsJSON} x = (:[]) . ("",) . (:[]) . LT.toStrict $
   encodeToLazyText x