katana-document-viewer 0.1.4

KatanA document viewer artifact, render evaluation, and export foundation.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

use super::{
    DiagramRenderTestSupport, ErrorDiagramEngine, PanicDiagramEngine, RecordingDiagramEngine,
};
use crate::artifact::ArtifactFormat;
use crate::forge_diagram_render_types::DiagramRenderingBackend;
use crate::{
    BuildProfile, BuildRequest, ExportFormat, ExportRequest, ForgePipeline, KdvThemeSnapshot,
};
use std::sync::{Arc, Mutex};

#[test]
fn diagram_renderer_panic_is_recorded_as_diagnostic() -> Result<(), Box<dyn std::error::Error>> {
    let pipeline = ForgePipeline::new(DiagramRenderingBackend::new(PanicDiagramEngine));
    let graph = pipeline.build(&BuildRequest {
        snapshot: DiagramRenderTestSupport::snapshot_from_markdown(
            "```mermaid\ngraph TD\n  A --> B\n```",
        )?,
        profile: BuildProfile::markdown_export(),
        theme: KdvThemeSnapshot::katana_light(),
    })?;

    assert!(graph.rendered_diagrams.is_empty());
    assert!(
        graph
            .diagnostics
            .messages
            .iter()
            .any(|message| message.contains("diagram renderer panicked"))
    );
    Ok(())
}

#[test]
fn diagram_renderer_receives_app_supplied_complete_theme() -> Result<(), Box<dyn std::error::Error>>
{
    let captured_themes = Arc::new(Mutex::new(Vec::new()));
    let pipeline = ForgePipeline::new(DiagramRenderingBackend::new(RecordingDiagramEngine {
        themes: captured_themes.clone(),
    }));
    let graph = pipeline.build(&BuildRequest {
        snapshot: DiagramRenderTestSupport::snapshot_from_markdown(
            "```plantuml\n@startuml\nAlice -> Bob\n@enduml\n```",
        )?,
        profile: BuildProfile::markdown_export(),
        theme: DiagramRenderTestSupport::app_supplied_dark_theme(),
    })?;

    assert_eq!(graph.rendered_diagrams.len(), 1);
    let themes = captured_themes
        .lock()
        .map_err(|error| format!("theme capture lock failed: {error}"))?;
    let captured = themes.first().ok_or("captured KRR theme is missing")?;
    DiagramRenderTestSupport::assert_app_supplied_theme_forwarded(captured);
    Ok(())
}

#[test]
fn diagram_renderer_records_render_error_without_panic() -> Result<(), Box<dyn std::error::Error>> {
    let pipeline = ForgePipeline::new(DiagramRenderingBackend::new(ErrorDiagramEngine));
    let graph = pipeline.build(&BuildRequest {
        snapshot: DiagramRenderTestSupport::snapshot_from_markdown(
            "```mermaid\ngraph TD\n  A --> B\n```",
        )?,
        profile: BuildProfile::markdown_export(),
        theme: KdvThemeSnapshot::katana_light(),
    })?;

    assert_eq!(graph.rendered_diagrams.len(), 0);
    assert_eq!(
        graph.diagnostics.messages,
        vec!["render failed".to_string()]
    );
    Ok(())
}

#[test]
fn diagram_renderer_walks_nested_list_items() {
    let pipeline = DiagramRenderingBackend::new(RecordingDiagramEngine {
        themes: Arc::new(Mutex::new(Vec::new())),
    });
    let root = DiagramRenderTestSupport::nested_list_root_with_diagram();

    let mut rendered_diagrams = Vec::new();
    let mut messages = Vec::new();
    pipeline.collect_node(
        &root,
        "document-id",
        &KdvThemeSnapshot::katana_light(),
        &mut rendered_diagrams,
        &mut messages,
    );

    assert_eq!(rendered_diagrams.len(), 1);
    assert!(messages.is_empty());
}

#[test]
fn diagram_renderer_exports_payload() -> Result<(), Box<dyn std::error::Error>> {
    let pipeline = ForgePipeline::new(DiagramRenderingBackend::new(RecordingDiagramEngine {
        themes: Arc::new(Mutex::new(Vec::new())),
    }));
    let graph = pipeline.build(&BuildRequest {
        snapshot: DiagramRenderTestSupport::snapshot_from_markdown(
            "```mermaid\ngraph TD\n  A --> B\n```",
        )?,
        profile: BuildProfile::markdown_export(),
        theme: KdvThemeSnapshot::katana_light(),
    })?;

    let output = pipeline.export(&ExportRequest {
        graph,
        format: ExportFormat::Html,
        theme: KdvThemeSnapshot::katana_light(),
    })?;

    assert_eq!(output.artifact.manifest.format, ArtifactFormat::Html);
    assert_eq!(output.artifact.manifest.backend, "katana-document-viewer");
    assert!(!output.artifact.bytes.bytes.is_empty());

    Ok(())
}