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
122
123
124
125
126
127
128
129
130
131
132
133

use super::test_support::{FixtureArtifacts, StaticPostprocessAdapter};
use super::*;
use std::error::Error;

const MINIMUM_ACCEPTED_REDUCTION_PERCENT_X100: i64 = 500;
const SLOW_POSTPROCESS_MILLIS: u128 = 31_000;

#[test]
fn disabled_mode_keeps_pdf_bytes_and_records_diagnostic() -> Result<(), Box<dyn Error>> {
    let fixture = FixtureArtifacts::new()?;
    let adapter = StaticPostprocessAdapter::success("karui", fixture.optimized_pdf());
    let service = ExportPostprocessEvaluationService::new(
        adapter,
        ExportPostprocessMode::Disabled,
        ExportPostprocessPolicy::v0_1_3(),
    );

    let report = service.evaluate(&fixture.request());

    assert_eq!(report.status, ExportPostprocessStatus::Skipped);
    assert_eq!(report.selected_pdf_bytes, fixture.pdf);
    assert_diagnostic(&report, "postprocess-disabled");
    Ok(())
}

#[test]
fn adapter_failure_keeps_pdf_bytes_and_records_reason() -> Result<(), Box<dyn Error>> {
    let fixture = FixtureArtifacts::new()?;
    let service = ExportPostprocessEvaluationService::new(
        StaticPostprocessAdapter::failure("karui", "engine unavailable"),
        ExportPostprocessMode::Enabled,
        ExportPostprocessPolicy::v0_1_3(),
    );

    let report = service.evaluate(&fixture.request());

    assert_eq!(report.status, ExportPostprocessStatus::Rejected);
    assert_eq!(report.selected_pdf_bytes, fixture.pdf);
    assert_diagnostic(&report, "postprocess-failed");
    Ok(())
}

#[test]
fn quality_regression_rejects_optimized_pdf() -> Result<(), Box<dyn Error>> {
    let fixture = FixtureArtifacts::new()?;
    let degraded_pdf = fixture.pdf_without_link_annotation();
    let service = ExportPostprocessEvaluationService::new(
        StaticPostprocessAdapter::success("karui", degraded_pdf),
        ExportPostprocessMode::Enabled,
        ExportPostprocessPolicy::v0_1_3(),
    );

    let report = service.evaluate(&fixture.request());

    assert_eq!(report.status, ExportPostprocessStatus::Rejected);
    assert_eq!(report.selected_pdf_bytes, fixture.pdf);
    assert_diagnostic(&report, "postprocess-quality-regressed");
    assert_diagnostic(&report, "postprocess-link-annotation-regressed");
    Ok(())
}

#[test]
fn useful_optimized_pdf_is_accepted_with_comparison_metrics() -> Result<(), Box<dyn Error>> {
    let fixture = FixtureArtifacts::with_test_metadata()?;
    let service = ExportPostprocessEvaluationService::new(
        StaticPostprocessAdapter::success("karui", FixtureArtifacts::base_pdf()),
        ExportPostprocessMode::Enabled,
        ExportPostprocessPolicy::v0_1_3(),
    );

    let report = service.evaluate(&fixture.request());

    assert_eq!(report.status, ExportPostprocessStatus::Accepted);
    assert_eq!(report.selected_pdf_bytes, FixtureArtifacts::base_pdf());
    assert!(report.metrics.size_reduction_percent_x100 >= MINIMUM_ACCEPTED_REDUCTION_PERCENT_X100);
    assert!(report.optimized_quality.is_pass());
    Ok(())
}

#[test]
fn small_size_reduction_is_not_enough_for_adoption() -> Result<(), Box<dyn Error>> {
    let fixture = FixtureArtifacts::new()?;
    let service = ExportPostprocessEvaluationService::new(
        StaticPostprocessAdapter::success("karui", fixture.pdf_with_one_byte_removed()),
        ExportPostprocessMode::Enabled,
        ExportPostprocessPolicy::v0_1_3(),
    );

    let report = service.evaluate(&fixture.request());

    assert_eq!(report.status, ExportPostprocessStatus::Rejected);
    assert_diagnostic(&report, "postprocess-size-reduction-too-small");
    Ok(())
}

#[test]
fn slow_postprocess_is_not_enough_for_adoption() -> Result<(), Box<dyn Error>> {
    let fixture = FixtureArtifacts::with_test_metadata()?;
    let adapter = StaticPostprocessAdapter::success("karui", FixtureArtifacts::base_pdf())
        .with_elapsed_millis(SLOW_POSTPROCESS_MILLIS);
    let service = ExportPostprocessEvaluationService::new(
        adapter,
        ExportPostprocessMode::Enabled,
        ExportPostprocessPolicy::v0_1_3(),
    );

    let report = service.evaluate(&fixture.request());

    assert_eq!(report.status, ExportPostprocessStatus::Rejected);
    assert_diagnostic(&report, "postprocess-too-slow");
    Ok(())
}

#[test]
fn karui_adapter_reports_public_engine_is_unavailable() {
    let adapter = KaruiPdfPostprocessAdapter;
    let result = adapter.postprocess_pdf(&PdfPostprocessInput {
        pdf: FixtureArtifacts::base_pdf().as_slice(),
    });

    assert_eq!(adapter.name(), "karui");
    assert!(result.is_err());
}

fn assert_diagnostic(report: &ExportPostprocessEvaluationReport, code: &str) {
    assert!(
        report
            .diagnostics
            .iter()
            .any(|diagnostic| diagnostic.code == code),
        "missing diagnostic {code}: {report:#?}"
    );
}