autumn-plugin-markstream 0.3.0

//! Test helpers: SRI hashes and an ES module import scanner.

use base64::Engine as _;
use regex::Regex;
use sha2::{Digest as _, Sha384};
use std::sync::LazyLock;

/// Computes the `sha384` SRI of `bytes`.
pub fn sri(bytes: &[u8]) -> String {
    format!(
        "sha384-{}",
        base64::engine::general_purpose::STANDARD.encode(Sha384::digest(bytes))
    )
}

/// One import in a module: the specifier and the import kind.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Import {
    /// The specifier text, for example `./a.js` or `vue`.
    pub spec: String,
    /// `true` for `import(...)`.
    pub dynamic: bool,
}

static SPEC: LazyLock<Regex> = LazyLock::new(|| {
    // `(` only after `import`: `Array.from("x")` is not an import.
    Regex::new(r#"(?:\bimport\s*(\()\s*|(?:\bfrom|\bimport)\s*)["']([^"'\s]+)["']"#)
        .expect("valid regex")
});

/// Finds each `from "x"`, `import "x"` and `import("x")` in `source`.
///
/// Lines that start with `//`, `/*` or `*` are comments. The scanner skips
/// them, so examples in doc comments do not count.
pub fn imports(source: &str) -> Vec<Import> {
    source
        .lines()
        .filter(|line| {
            let line = line.trim_start();
            !(line.starts_with("//") || line.starts_with("/*") || line.starts_with('*'))
        })
        .flat_map(|line| {
            SPEC.captures_iter(line).map(|c| Import {
                spec: c[2].to_owned(),
                dynamic: c.get(1).is_some(),
            })
        })
        .collect()
}

/// Resolves a relative `spec` against the logical path `from`.
pub fn resolve(from: &str, spec: &str) -> String {
    let mut parts: Vec<&str> = from.split('/').collect();
    parts.pop();
    for seg in spec.split('/') {
        match seg {
            "." | "" => {}
            ".." => {
                parts.pop();
            }
            s => parts.push(s),
        }
    }
    parts.join("/")
}

#[test]
fn scanner_finds_static_dynamic_and_bare_imports() {
    let found =
        imports(r#"import{a}from"./a.js";export*from'../b.js';import"vue";import("./c.js")"#);
    let specs: Vec<_> = found.iter().map(|i| (i.spec.as_str(), i.dynamic)).collect();
    assert_eq!(
        specs,
        [
            ("./a.js", false),
            ("../b.js", false),
            ("vue", false),
            ("./c.js", true)
        ]
    );
}

#[test]
fn scanner_ignores_from_calls() {
    let specs: Vec<_> = imports(r#"Array.from("vue");x.from('y');import("./z.js")"#)
        .into_iter()
        .map(|i| i.spec)
        .collect();
    assert_eq!(specs, ["./z.js"]);
}

#[test]
fn scanner_skips_comment_lines() {
    let source =
        "//#region linkify\n\t* import { L } from 'linkify-it'\n/* import 'x' */\nimport\"./y.js\"";
    let specs: Vec<_> = imports(source).into_iter().map(|i| i.spec).collect();
    assert_eq!(specs, ["./y.js"]);
}

#[test]
fn resolve_handles_dot_segments() {
    assert_eq!(resolve("vendor/a/b.js", "./c.js"), "vendor/a/c.js");
    assert_eq!(resolve("vendor/a/u/b.js", "../../v/x.js"), "vendor/v/x.js");
    assert_eq!(resolve("init.js", "./vendor/x.js"), "vendor/x.js");
}

/// One dispatched Server-Sent Event: `(event type, data)`.
pub type Dispatched = (String, String);

/// Parses an SSE body as the WHATWG HTML spec says a browser does.
///
/// It splits lines on CRLF, LF or CR. It drops comments. It does not
/// dispatch an event with an empty data buffer.
pub fn parse_sse(body: &str) -> Vec<Dispatched> {
    let mut out = Vec::new();
    let (mut event, mut data) = (String::new(), String::new());
    let normalized = body.replace("\r\n", "\n").replace('\r', "\n");
    // The last segment has no line end. The spec drops it at EOF.
    let mut lines: Vec<&str> = normalized.split('\n').collect();
    lines.pop();
    for line in lines {
        if line.is_empty() {
            if !data.is_empty() {
                data.pop();
                let name = if event.is_empty() {
                    "message".to_owned()
                } else {
                    event.clone()
                };
                out.push((name, std::mem::take(&mut data)));
            }
            event.clear();
            data.clear();
            continue;
        }
        if line.starts_with(':') {
            continue;
        }
        let (field, value) = line
            .split_once(':')
            .map_or((line, ""), |(f, v)| (f, v.strip_prefix(' ').unwrap_or(v)));
        match field {
            "event" => value.clone_into(&mut event),
            "data" => {
                data.push_str(value);
                data.push('\n');
            }
            _ => {}
        }
    }
    out
}

#[test]
fn sse_parser_follows_the_spec() {
    let body = ": keep-alive\n\nevent: chunk\ndata:  a\ndata: b\r\n\nevent: done\n\ndata: x\n\n";
    assert_eq!(
        parse_sse(body),
        [
            ("chunk".to_owned(), " a\nb".to_owned()),
            ("message".to_owned(), "x".to_owned())
        ]
    );
}

/// Reads the quoted strings of the JS array `const NAME = [...]` (or
/// `Object.freeze([...])`) in `source`.
pub fn js_array(source: &str, name: &str) -> Vec<String> {
    let re = Regex::new(&format!(
        r"\b{name}\s*=\s*(?:Object\.freeze\()?\[([^\]]*)\]"
    ))
    .expect("regex");
    let body = re
        .captures(source)
        .unwrap_or_else(|| panic!("no array {name}"))[1]
        .to_owned();
    quoted(&body)
}

/// Reads the quoted values of the JS object `const NAME = Object.freeze({...})`.
pub fn js_object_values(source: &str, name: &str) -> Vec<String> {
    let re = Regex::new(&format!(r"\b{name}\s*=\s*Object\.freeze\(\{{([^}}]*)\}}")).expect("regex");
    let body = re
        .captures(source)
        .unwrap_or_else(|| panic!("no object {name}"))[1]
        .to_owned();
    body.lines()
        .filter_map(|line| line.split_once(':'))
        .flat_map(|(_, value)| quoted(value))
        .collect()
}

/// Reads a JS string constant `const NAME = "..."`.
pub fn js_string(source: &str, name: &str) -> String {
    let re = Regex::new(&format!(r#"\b{name}\s*=\s*"([^"]*)""#)).expect("regex");
    re.captures(source)
        .unwrap_or_else(|| panic!("no string {name}"))[1]
        .to_owned()
}

fn quoted(text: &str) -> Vec<String> {
    let re = Regex::new(r#""([^"]*)""#).expect("regex");
    re.captures_iter(text).map(|c| c[1].to_owned()).collect()
}

#[test]
fn js_literal_readers() {
    let src = "const A = [\"x\", \"y\"];\nexport const B = Object.freeze([\"z\"]);\nconst O = Object.freeze({\n  a: \"p\",\n  b: \"q\",\n});\nconst S = \"s\";";
    assert_eq!(js_array(src, "A"), ["x", "y"]);
    assert_eq!(js_array(src, "B"), ["z"]);
    assert_eq!(js_object_values(src, "O"), ["p", "q"]);
    assert_eq!(js_string(src, "S"), "s");
}

#[test]
fn sse_parser_drops_an_unterminated_event_at_eof() {
    assert_eq!(
        parse_sse("event: done\ndata: null\n"),
        Vec::<Dispatched>::new()
    );
    assert_eq!(
        parse_sse("data: x\n\ndata: y"),
        [("message".to_owned(), "x".to_owned())]
    );
}