devpage 0.2.4

Live documents from a repository: sites, docs and slides from Markdown, and UI designs drawn from code — with comments, link checking and PDF
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299

//! A slide's PNG, shot by chrome-headless-shell: drawn without its comments
//! and its problems, without waiting for a design on another slide, never shooting itself,
//! kept until a file its deck is drawn from changes, and Chrome closed and
//! started again.

use std::path::PathBuf;
use std::sync::Arc;
use std::time::{Duration, Instant};

use crate::adapters::changes::Changes;
use crate::adapters::chrome::testing;
use crate::drive::http;
use crate::drive::slide_png::Shots;
use devpage_core::document::Document;
use devpage_core::folder::ServedFolder;
use devpage_core::watch::SlidePngs;

/// A design that paints.
const BOX: &str = "<Frame width={400} height={300} fill=\"#2563eb\" />";

/// A folder of `files`, served with `talk.yml` as its entry; its address,
/// the folder, and the slide PNGs, to tell of a changed file as the watcher
/// would.
async fn deck(name: &str, files: &[(&str, &str)]) -> (String, PathBuf, Shots) {
    let dir = std::env::temp_dir().join(format!("devpage-shots-{}-{name}", std::process::id()));
    let _ = std::fs::remove_dir_all(&dir);
    std::fs::create_dir_all(&dir).unwrap();
    for (file, text) in files {
        std::fs::write(dir.join(file), text).unwrap();
    }
    let dir = dir.canonicalize().unwrap();
    let document =
        Arc::new(Document::load(&dir.join("talk.yml"), &ServedFolder::new(&dir).unwrap()).unwrap());
    let app = http::App::testing(document, Changes::default())
        .with_comments_on_disk(devpage_core::comments::Identity::Local("T".into()));
    let shots = app.shots();
    (testing::serve(http::router(app)).await, dir, shots)
}

/// Drives chrome-headless-shell; run with `cargo test -- --ignored`.
#[tokio::test]
#[ignore]
async fn a_slide_is_shot_without_its_comments() {
    let (address, dir, shots) = deck(
        "comments",
        &[
            ("one.md", "# One\n\nThe client retries every write.\n"),
            ("talk.yml", "kind: slides\ntitle: Talk\nslides: [one.md]\n"),
        ],
    )
    .await;
    let url = format!("{address}/talk.yml/1.png");
    let before = reqwest::get(&url).await.unwrap().bytes().await.unwrap();
    let client = reqwest::Client::new();
    let made = client
        .post(format!("{address}/__devpage/comments"))
        .json(&serde_json::json!({
            "page": "/one.md",
            "anchor": { "quote": "retries", "prefix": "The client ", "suffix": " every write." },
            "text": "Bounded?",
        }))
        .send()
        .await
        .unwrap();
    assert_eq!(made.status(), 200);
    // Drawn again, as it is now: the thread is not on it.
    shots.changed(&[dir.join("one.md")]);
    let after = reqwest::get(&url).await.unwrap().bytes().await.unwrap();
    assert!(after == before, "the comment shows in the slide's PNG");
}

/// Drives chrome-headless-shell; run with `cargo test -- --ignored`.
#[tokio::test]
#[ignore]
async fn a_slide_is_shot_without_its_problems() {
    let (address, dir, shots) = deck(
        "problems",
        &[
            ("one.md", "# One\n\nSee [the plan](plan.md) first.\n"),
            ("talk.yml", "kind: slides\ntitle: Talk\nslides: [one.md]\n"),
        ],
    )
    .await;
    // The deck's page lists the broken link, and marks it …
    let page = reqwest::get(format!("{address}/talk.yml"))
        .await
        .unwrap()
        .text()
        .await
        .unwrap();
    assert!(page.contains("broken link plan.md"), "{page}");
    // … but its slide's PNG shows neither: it is the slide drawn once the
    // link is fixed.
    let url = format!("{address}/talk.yml/1.png");
    let broken = reqwest::get(&url).await.unwrap().bytes().await.unwrap();
    std::fs::write(dir.join("plan.md"), "# Plan\n").unwrap();
    shots.changed(&[dir.join("one.md")]);
    let fixed = reqwest::get(&url).await.unwrap().bytes().await.unwrap();
    assert!(broken == fixed, "the problem shows in the slide's PNG");
}

/// Drives chrome-headless-shell; run with `cargo test -- --ignored`.
#[tokio::test]
#[ignore]
async fn a_slide_beside_a_design_is_drawn_without_waiting_for_it() {
    let (address, _, _) = deck(
        "beside",
        &[
            ("box.design", BOX),
            ("one.md", "# One\n"),
            ("two.md", "# Two\n\n![The box](box.design)\n"),
            (
                "talk.yml",
                "kind: slides\ntitle: Talk\nslides: [one.md, two.md]\n",
            ),
        ],
    )
    .await;
    // The design on slide 2 is hidden on slide 1: not waited for.
    let started = Instant::now();
    let first = reqwest::get(format!("{address}/talk.yml/1.png"))
        .await
        .unwrap();
    assert_eq!(first.status(), 200);
    assert!(first.headers().get("x-devpage-ready").is_none());
    assert!(
        started.elapsed() < Duration::from_secs(3),
        "{:?}",
        started.elapsed()
    );
    // On its own slide it is painted before the shot.
    let second = reqwest::get(format!("{address}/talk.yml/2.png"))
        .await
        .unwrap();
    assert_eq!(second.status(), 200);
    assert!(second.headers().get("x-devpage-ready").is_none());
}

/// Drives chrome-headless-shell; run with `cargo test -- --ignored`.
#[tokio::test]
#[ignore]
async fn a_slide_showing_its_own_png_returns_promptly() {
    let (address, _, _) = deck(
        "itself",
        &[
            ("one.md", "# One\n\n![Itself](talk.yml/1.png)\n"),
            ("talk.yml", "kind: slides\ntitle: Talk\nslides: [one.md]\n"),
        ],
    )
    .await;
    let started = Instant::now();
    let response = reqwest::get(format!("{address}/talk.yml/1.png"))
        .await
        .unwrap();
    assert_eq!(response.status(), 200);
    assert!(
        started.elapsed() < Duration::from_secs(5),
        "{:?}",
        started.elapsed()
    );
}

/// Drives chrome-headless-shell; run with `cargo test -- --ignored`.
#[tokio::test]
#[ignore]
async fn a_repeat_request_comes_from_the_cache_until_a_file_changes() {
    let (address, dir, shots) = deck(
        "cache",
        &[
            ("one.md", "# One\n"),
            ("talk.yml", "kind: slides\ntitle: Talk\nslides: [one.md]\n"),
        ],
    )
    .await;
    let url = format!("{address}/talk.yml/1.png");
    let client = reqwest::Client::new();
    let shot = |held: Option<String>, inside: bool| {
        let mut request = client.get(&url);
        if let Some(etag) = held {
            request = request.header("if-none-match", etag);
        }
        if inside {
            request = request.header(crate::adapters::chrome::SHOT_HEADER, "1");
        }
        request.send()
    };
    // Inside another shot, a slide not yet drawn isn't drawn:
    // `http::tests::inside_a_shot_a_slide_not_yet_drawn_is_refused`.
    let first = shot(None, false).await.unwrap();
    let etag = first.headers()["etag"].to_str().unwrap().to_string();
    let first = first.bytes().await.unwrap();

    // Drawn already: no Chrome, and nothing sent to a holder of it.
    let started = Instant::now();
    let again = shot(Some(etag.clone()), false).await.unwrap();
    assert_eq!(again.status(), 304);
    assert_eq!(again.headers()["etag"], etag.as_str());
    let cached = shot(None, true).await.unwrap();
    assert_eq!(cached.status(), 200);
    assert_eq!(cached.bytes().await.unwrap(), first);
    assert!(
        started.elapsed() < Duration::from_millis(200),
        "{:?}",
        started.elapsed()
    );

    // A change: the slide is drawn again, as it is now.
    std::fs::write(dir.join("one.md"), "# Changed\n").unwrap();
    shots.changed(&[dir.join("one.md")]);
    let changed = shot(Some(etag.clone()), false).await.unwrap();
    assert_eq!(changed.status(), 200);
    assert_ne!(changed.headers()["etag"], etag.as_str());
    assert_ne!(changed.bytes().await.unwrap(), first);
}

/// Drives chrome-headless-shell; run with `cargo test -- --ignored`.
#[tokio::test]
#[ignore]
async fn chrome_closes_when_told_and_starts_again_for_the_next_shot() {
    let shots = Shots::new();
    let dir = std::env::temp_dir().join(format!("devpage-shots-{}-close", std::process::id()));
    let _ = std::fs::remove_dir_all(&dir);
    std::fs::create_dir_all(&dir).unwrap();
    std::fs::write(dir.join("one.md"), "# One\n").unwrap();
    std::fs::write(
        dir.join("talk.yml"),
        "kind: slides\ntitle: Talk\nslides: [one.md]\n",
    )
    .unwrap();
    let dir = dir.canonicalize().unwrap();
    let document =
        Arc::new(Document::load(&dir.join("talk.yml"), &ServedFolder::new(&dir).unwrap()).unwrap());
    let serve = || http::router(http::App::printing(document.clone()));
    let deck = dir.join("talk.yml");
    let drawn_from = |deck: &PathBuf| {
        let deck = deck.clone();
        move || vec![deck]
    };
    shots
        .png("/talk.yml", 1, drawn_from(&deck), serve)
        .await
        .unwrap();
    assert!(shots.running().await);
    shots.close().await;
    assert!(!shots.running().await);
    shots.changed(std::slice::from_ref(&deck));
    shots
        .png("/talk.yml", 1, drawn_from(&deck), serve)
        .await
        .unwrap();
    assert!(shots.running().await);
    shots.close().await;
}

/// Drives chrome-headless-shell; run with `cargo test -- --ignored`.
#[tokio::test]
#[ignore]
async fn a_slide_is_served_as_a_1920_by_1080_png() {
    let dir = std::env::temp_dir().join(format!("devpage-slide-png-{}", std::process::id()));
    let _ = std::fs::remove_dir_all(&dir);
    std::fs::create_dir_all(&dir).unwrap();
    std::fs::write(dir.join("one.md"), "# One\n").unwrap();
    std::fs::write(dir.join("two.md"), "# Two\n\n<Notes>Never drawn.</Notes>\n").unwrap();
    std::fs::write(
        dir.join("talk.yml"),
        "kind: slides\ntitle: Talk\nslides: [one.md, two.md]\n",
    )
    .unwrap();
    let dir = dir.canonicalize().unwrap();
    let document =
        Arc::new(Document::load(&dir.join("talk.yml"), &ServedFolder::new(&dir).unwrap()).unwrap());
    let changes = Changes::default();
    let address = testing::serve(http::router(
        http::App::testing(document, changes)
            .with_comments_on_disk(devpage_core::comments::Identity::Local("T".into())),
    ))
    .await;

    let response = reqwest::get(format!("{address}/talk.yml/2.png"))
        .await
        .unwrap();
    assert_eq!(response.status(), 200);
    assert_eq!(response.headers()["content-type"], "image/png");
    let png = response.bytes().await.unwrap();
    assert_eq!(&png[..8], b"\x89PNG\r\n\x1a\n");
    // The IHDR chunk's width and height, big-endian.
    let size = |at: usize| u32::from_be_bytes(png[at..at + 4].try_into().unwrap());
    assert_eq!((size(16), size(20)), (1920, 1080));

    // Slide 1 and slide 2 are different pictures.
    let first = reqwest::get(format!("{address}/talk.yml/1.png"))
        .await
        .unwrap()
        .bytes()
        .await
        .unwrap();
    assert_ne!(first, png);
    // A PNG of no slide is `http::tests::a_png_of_no_slide_is_not_found`.
}