bynk-lsp 0.111.0

bynkc-lsp — the Language Server for the Bynk DSL.
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

//! v0.24 (ADR 0052): the project-wide publish plan — a pure function so the
//! clear semantics are unit-tested without an LSP transport (the JSON-RPC
//! harness is deferred to the first interactive feature; recorded in the
//! v0.24 proposal).

use std::collections::{HashMap, HashSet};

use tower_lsp::lsp_types::{Diagnostic, Url};

/// Compute the publishes for one analysis round: every URI with new
/// diagnostics, **plus an empty publish for every URI that carried
/// diagnostics last round and no longer does** (the clear). Returns the
/// publish list and the next round's dirty set.
pub fn publish_plan(
    previously_dirty: &HashSet<Url>,
    new_by_uri: HashMap<Url, Vec<Diagnostic>>,
) -> (Vec<(Url, Vec<Diagnostic>)>, HashSet<Url>) {
    let mut publishes: Vec<(Url, Vec<Diagnostic>)> = Vec::new();
    let mut dirty: HashSet<Url> = HashSet::new();
    for (uri, diags) in new_by_uri {
        if !diags.is_empty() {
            dirty.insert(uri.clone());
            publishes.push((uri, diags));
        } else if previously_dirty.contains(&uri) {
            // Newly clean: clear.
            publishes.push((uri, Vec::new()));
        }
    }
    // Previously-dirty files that vanished from the analysis entirely
    // (deleted, renamed) also clear.
    let analysed: HashSet<&Url> = publishes.iter().map(|(u, _)| u).collect();
    let mut gone: Vec<Url> = previously_dirty
        .iter()
        .filter(|u| !dirty.contains(*u) && !analysed.contains(u))
        .cloned()
        .collect();
    gone.sort_by(|a, b| a.as_str().cmp(b.as_str()));
    for uri in gone {
        publishes.push((uri, Vec::new()));
    }
    (publishes, dirty)
}

#[cfg(test)]
mod tests {
    use super::*;

    fn uri(s: &str) -> Url {
        Url::parse(&format!("file:///{s}")).unwrap()
    }
    fn diag(msg: &str) -> Diagnostic {
        Diagnostic {
            message: msg.to_string(),
            ..Default::default()
        }
    }

    #[test]
    fn publishes_new_and_clears_fixed() {
        let prev: HashSet<Url> = [uri("a.bynk"), uri("b.bynk")].into_iter().collect();
        let mut new = HashMap::new();
        new.insert(uri("a.bynk"), vec![diag("still broken")]);
        new.insert(uri("b.bynk"), vec![]); // fixed
        new.insert(uri("c.bynk"), vec![]); // was never dirty — no publish

        let (publishes, dirty) = publish_plan(&prev, new);
        let by: HashMap<_, _> = publishes
            .iter()
            .map(|(u, d)| (u.clone(), d.len()))
            .collect();
        assert_eq!(by.get(&uri("a.bynk")), Some(&1), "still-broken republished");
        assert_eq!(
            by.get(&uri("b.bynk")),
            Some(&0),
            "fixed file gets an empty publish"
        );
        assert!(
            !by.contains_key(&uri("c.bynk")),
            "never-dirty clean file is not published"
        );
        assert!(dirty.contains(&uri("a.bynk")) && !dirty.contains(&uri("b.bynk")));
    }

    #[test]
    fn vanished_files_clear() {
        let prev: HashSet<Url> = [uri("gone.bynk")].into_iter().collect();
        let (publishes, dirty) = publish_plan(&prev, HashMap::new());
        assert_eq!(publishes, vec![(uri("gone.bynk"), Vec::new())]);
        assert!(dirty.is_empty());
    }

    #[test]
    fn newly_broken_file_enters_the_dirty_set() {
        let prev = HashSet::new();
        let mut new = HashMap::new();
        new.insert(uri("a.bynk"), vec![diag("boom")]);
        let (publishes, dirty) = publish_plan(&prev, new);
        assert_eq!(publishes.len(), 1);
        assert!(dirty.contains(&uri("a.bynk")));
    }
}