Skip to main content

Source src/metadata.rs

1//! Public navigation index: basic selection fields and actual report destinations.2//! URLs use the report root supplied by consumers, independently of JSON location.3mod output;4pub use output::MetadataTarget;56use crate::{7    diagnostic::model::Report,8    render::paths::{PageMap, category_key, group_key, relative_href},9    source::{SourceFile, span_matches},10};11use serde::Serialize;12use std::{13    collections::BTreeMap,14    path::{Path, PathBuf},15};1617#[derive(Serialize)]18pub struct NavigationMetadata {19    schema_version: u32,20    generator: Generator,21    execution: Execution,22    packages: Vec<Package>,23    pages: Vec<Page>,24    findings: Vec<Finding>,25}26#[derive(Serialize)]27struct Generator {28    name: &'static str,29    version: &'static str,30}31#[derive(Serialize)]32struct Execution {33    clippy_exit_code: Option<i32>,34    collection_complete: bool,35}36#[derive(Serialize)]37struct Package {38    id: String,39    name: String,40    version: String,41}42#[derive(Serialize)]43struct Page {44    kind: &'static str,45    name: String,46    url: String,47}48#[derive(Serialize)]49struct Finding {50    id: String,51    package_id: String,52    origin: String,53    code: Option<String>,54    level: String,55    category: Option<String>,56    message: String,57    url: String,58    #[serde(skip_serializing_if = "Option::is_none")]59    location: Option<Location>,60}61#[derive(Serialize)]62struct Location {63    path: String,64    line: usize,65    column: usize,66    url: String,67}6869pub fn build(70    report: &Report,71    sources: &BTreeMap<PathBuf, SourceFile>,72    paths: &PageMap,73) -> NavigationMetadata {74    let root = Path::new("index.html");75    let mut pages = vec![Page {76        kind: "overview",77        name: "Report overview".into(),78        url: "index.html".into(),79    }];80    pages.extend(paths.lint_pages.iter().map(|(key, path)| {81        let finding = report82            .findings83            .iter()84            .find(|f| group_key(f) == *key)85            .unwrap();86        Page {87            kind: "lint",88            name: finding89                .code90                .clone()91                .unwrap_or_else(|| "General diagnostics".into()),92            url: relative_href(root, path, None),93        }94    }));95    pages.extend(paths.category_pages.iter().map(|(key, path)| Page {96        kind: "category",97        name: key.clone(),98        url: relative_href(root, path, None),99    }));100    pages.extend(paths.source_pages.iter().map(|(key, path)| Page {101        kind: "source",102        name: sources[key].display_path.clone(),103        url: relative_href(root, path, None),104    }));105    pages.sort_by(|a, b| (a.kind, &a.name, &a.url).cmp(&(b.kind, &b.name, &b.url)));106    let mut packages: Vec<_> = report107        .project108        .packages109        .iter()110        .map(|p| Package {111            id: p.id.clone(),112            name: p.name.clone(),113            version: p.version.clone(),114        })115        .collect();116    packages.sort_by(|a, b| a.id.cmp(&b.id));117    let mut findings: Vec<_> = report118        .findings119        .iter()120        .map(|f| {121            let anchor = format!("finding-{}", f.id);122            let location = f123                .spans124                .iter()125                .find(|s| s.primary)126                .or_else(|| f.spans.first())127                .map(|s| {128                    let source = &sources[&s.path];129                    let destination = if span_matches(source, s) {130                        format!("L{}", s.line_start)131                    } else {132                        anchor.clone()133                    };134                    Location {135                        path: source.display_path.clone(),136                        line: s.line_start,137                        column: s.column_start,138                        url: relative_href(root, &paths.source_pages[&s.path], Some(&destination)),139                    }140                });141            Finding {142                id: f.id.clone(),143                package_id: f.package_id.clone(),144                origin: f.origin.clone(),145                code: f.code.clone(),146                level: f.level.clone(),147                category: category_key(f).map(str::to_owned),148                message: f.message.clone(),149                url: relative_href(root, &paths.lint_pages[&group_key(f)], Some(&anchor)),150                location,151            }152        })153        .collect();154    findings.sort_by(|a, b| a.id.cmp(&b.id));155    NavigationMetadata {156        schema_version: 1,157        generator: Generator {158            name: "cargo-clippy-html",159            version: env!("CARGO_PKG_VERSION"),160        },161        execution: Execution {162            clippy_exit_code: report.execution.code,163            collection_complete: report.execution.complete,164        },165        packages,166        pages,167        findings,168    }169}170171impl NavigationMetadata {172    pub fn json(&self) -> Result<Vec<u8>, String> {173        let mut bytes = serde_json::to_vec_pretty(self).map_err(|e| e.to_string())?;174        bytes.push(b'\n');175        Ok(bytes)176    }177    pub fn validate(&self, root: &Path) -> Result<(), String> {178        let root = root.canonicalize().map_err(|e| e.to_string())?;179        let base =180            url::Url::from_directory_path(&root).map_err(|_| "Invalid metadata report root")?; warning: clippy::ignored_unit_patterns181        let mut anchors = BTreeMap::new();182        let id_selector = scraper::Selector::parse("[id]").unwrap();183        let hrefs = self184            .pages185            .iter()186            .map(|p| p.url.as_str())187            .chain(self.findings.iter().flat_map(|f| {188                std::iter::once(f.url.as_str()).chain(f.location.iter().map(|l| l.url.as_str()))189            }));190        for href in hrefs {191            let linked = base.join(href).map_err(|e| e.to_string())?;192            let path = linked193                .to_file_path()194                .map_err(|_| "Nonlocal metadata URL")? warning: clippy::ignored_unit_patterns195                .canonicalize()196                .map_err(|e| format!("Broken metadata URL {href}: {e}"))?;197            if !path.starts_with(&root) || !path.is_file() {198                return Err(format!("Broken metadata URL: {href}"));199            }200            if let Some(id) = linked.fragment() {201                if !anchors.contains_key(&path) {202                    let html = std::fs::read_to_string(&path).map_err(|e| e.to_string())?;203                    let doc = scraper::Html::parse_document(&html);204                    let ids: std::collections::BTreeSet<String> = doc205                        .select(&id_selector)206                        .filter_map(|e| e.value().id().map(str::to_owned))207                        .collect();208                    anchors.insert(path.clone(), ids);209                }210                if !anchors[&path].contains(id) {211                    return Err(format!("Missing metadata anchor: {href}"));212                }213            }214        }215        Ok(())216    }217}218219#[cfg(test)]220mod tests {221    use super::*;222    use crate::diagnostic::{self, model};223    fn report() -> (Report, BTreeMap<PathBuf, SourceFile>) {224        let cargo_metadata::Message::CompilerMessage(message) =225            serde_json::from_value(diagnostic::sample()).unwrap()226        else {227            panic!()228        };229        let mut finding = diagnostic::normalize::normalize(&message, Path::new("/demo"));230        finding.id = "sample".into();231        finding.message = "untrusted </script>&한글".into();232        finding.spans[0].path = PathBuf::from("/demo/src/한글 #.rs");233        let sources = BTreeMap::from([(234            finding.spans[0].path.clone(),235            SourceFile {236                display_path: "src/한글 #.rs".into(),237                text: Some("abc".into()),238                reason: None,239            },240        )]);241        (242            Report {243                category_metadata: None,244                project: model::ProjectInfo {245                    workspace_root: "/demo".into(),246                    target_dir: "/demo/target".into(),247                    build_dir: None,248                    packages: vec![],249                },250                execution: model::Execution {251                    code: Some(0),252                    complete: true,253                    requested_args: vec![],254                    observed_packages: vec![],255                    observed_targets: vec![],256                    stderr: String::new(),257                    stderr_truncated: false,258                    text_stdout: String::new(),259                    stdout_truncated: false,260                    issues: vec![],261                },262                raw_count: 1,263                findings: vec![finding],264            },265            sources,266        )267    }268    #[test]269    fn navigation_uses_validated_line_or_fallback_anchors_and_omits_absent_locations() {270        let (mut report, mut sources) = report();271        let pages = crate::render::paths::build_page_map(&report, &sources);272        let metadata = build(&report, &sources, &pages);273        assert!(274            metadata.findings[0]275                .location276                .as_ref()277                .unwrap()278                .url279                .ends_with("#L1")280        );281        let dir = tempfile::tempdir().unwrap();282        crate::render::render_report(&report, &sources, &pages, dir.path()).unwrap();283        metadata.validate(dir.path()).unwrap();284        assert!(285            metadata.findings[0]286                .location287                .as_ref()288                .unwrap()289                .url290                .contains("%") warning: clippy::single_char_pattern291        );292        for text in [None, Some("changed".into())] {293            sources.values_mut().next().unwrap().text = text;294            let metadata = build(&report, &sources, &pages);295            assert!(296                metadata.findings[0]297                    .location298                    .as_ref()299                    .unwrap()300                    .url301                    .ends_with("#finding-sample")302            );303            let dir = tempfile::tempdir().unwrap();304            crate::render::render_report(&report, &sources, &pages, dir.path()).unwrap();305            metadata.validate(dir.path()).unwrap();306        }307        report.findings[0].spans.clear();308        report.findings[0].origin = "Rustc".into();309        report.findings[0].code = None;310        report.execution.code = None;311        report.execution.complete = false;312        let paths = crate::render::paths::build_page_map(&report, &sources);313        let json: serde_json::Value =314            serde_json::from_slice(&build(&report, &sources, &paths).json().unwrap()).unwrap();315        assert!(json["findings"][0].get("location").is_none());316        assert!(json["findings"][0]["code"].is_null() && json["findings"][0]["category"].is_null());317        assert!(json["execution"]["clippy_exit_code"].is_null());318        assert_eq!(json["execution"]["collection_complete"], false);319    }320    #[test]321    fn navigation_is_deterministic_and_rejects_broken_destinations() {322        let (mut report, sources) = report();323        let mut extra = report.findings[0].clone();324        extra.id = "another".into();325        extra.category = Some("correctness".into());326        report.findings.push(extra);327        let paths = crate::render::paths::build_page_map(&report, &sources);328        let mut metadata = build(&report, &sources, &paths);329        assert_eq!(metadata.findings[0].id, "another");330        assert_eq!(metadata.findings[1].category.as_deref(), Some("unknown"));331        report.findings.reverse();332        assert_eq!(333            metadata.json().unwrap(),334            build(&report, &sources, &paths).json().unwrap()335        );336        let dir = tempfile::tempdir().unwrap();337        crate::render::render_report(&report, &sources, &paths, dir.path()).unwrap();338        metadata.validate(dir.path()).unwrap();339        metadata.findings[0].url = "index.html#not-present".into();340        assert!(341            metadata342                .validate(dir.path())343                .unwrap_err()344                .contains("Missing metadata anchor")345        );346        metadata.findings[0].url = "not-present.html".into();347        assert!(348            metadata349                .validate(dir.path())350                .unwrap_err()351                .contains("Broken metadata URL")352        );353    }354}355

Findings in this file§

warning clippy::ignored_unit_patterns §

matching over `()` is more explicit

src/metadata.rs:180:59

Clippy · Category: pedantic · cargo-clippy-html

Official Clippy documentation

Targets (1)
  • cargo-clippy-html (bin)

Primary: src/metadata.rs:180:59

            url::Url::from_directory_path(&root).map_err(|_| "Invalid metadata report root")?;

help: for further information visit https://rust-lang.github.io/rust-clippy/rust-1.100.0/index.html#ignored_unit_patterns

note: `-W clippy::ignored-unit-patterns` implied by `-W clippy::pedantic`

help: to override `-W clippy::pedantic` add `#[allow(clippy::ignored_unit_patterns)]`

help: use `()` instead of `_`

Suggestion: use `()` instead of `_`

MachineApplicable

--- "a/src/metadata.rs"
+++ "b/src/metadata.rs"
@@ -177,7 +177,7 @@
     pub fn validate(&self, root: &Path) -> Result<(), String> {
         let root = root.canonicalize().map_err(|e| e.to_string())?;
         let base =
-            url::Url::from_directory_path(&root).map_err(|_| "Invalid metadata report root")?;
+            url::Url::from_directory_path(&root).map_err(|()| "Invalid metadata report root")?;
         let mut anchors = BTreeMap::new();
         let id_selector = scraper::Selector::parse("[id]").unwrap();
         let hrefs = self
Rendered diagnostic (text)
warning: matching over `()` is more explicit
   --> src/metadata.rs:180:59
    |
180 |             url::Url::from_directory_path(&root).map_err(|_| "Invalid metadata report root")?;
    |                                                           ^ help: use `()` instead of `_`: `()`
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/rust-1.100.0/index.html#ignored_unit_patterns
    = note: `-W clippy::ignored-unit-patterns` implied by `-W clippy::pedantic`
    = help: to override `-W clippy::pedantic` add `#[allow(clippy::ignored_unit_patterns)]`

warning clippy::ignored_unit_patterns §

matching over `()` is more explicit

src/metadata.rs:194:27

Clippy · Category: pedantic · cargo-clippy-html

Official Clippy documentation

Targets (1)
  • cargo-clippy-html (bin)

Primary: src/metadata.rs:194:27

                .map_err(|_| "Nonlocal metadata URL")?

help: for further information visit https://rust-lang.github.io/rust-clippy/rust-1.100.0/index.html#ignored_unit_patterns

help: use `()` instead of `_`

Suggestion: use `()` instead of `_`

MachineApplicable

--- "a/src/metadata.rs"
+++ "b/src/metadata.rs"
@@ -191,7 +191,7 @@
             let linked = base.join(href).map_err(|e| e.to_string())?;
             let path = linked
                 .to_file_path()
-                .map_err(|_| "Nonlocal metadata URL")?
+                .map_err(|()| "Nonlocal metadata URL")?
                 .canonicalize()
                 .map_err(|e| format!("Broken metadata URL {href}: {e}"))?;
             if !path.starts_with(&root) || !path.is_file() {
Rendered diagnostic (text)
warning: matching over `()` is more explicit
   --> src/metadata.rs:194:27
    |
194 |                 .map_err(|_| "Nonlocal metadata URL")?
    |                           ^ help: use `()` instead of `_`: `()`
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/rust-1.100.0/index.html#ignored_unit_patterns

warning clippy::single_char_pattern §

single-character string constant used as pattern

src/metadata.rs:290:27

Clippy · Category: pedantic · cargo-clippy-html

Official Clippy documentation

Targets (1)
  • cargo-clippy-html (bin)

Primary: src/metadata.rs:290:27

                .contains("%")

help: for further information visit https://rust-lang.github.io/rust-clippy/rust-1.100.0/index.html#single_char_pattern

note: `-W clippy::single-char-pattern` implied by `-W clippy::pedantic`

help: to override `-W clippy::pedantic` add `#[allow(clippy::single_char_pattern)]`

help: consider using a `char`

Suggestion: consider using a `char`

MachineApplicable

--- "a/src/metadata.rs"
+++ "b/src/metadata.rs"
@@ -287,7 +287,7 @@
                 .as_ref()
                 .unwrap()
                 .url
-                .contains("%")
+                .contains('%')
         );
         for text in [None, Some("changed".into())] {
             sources.values_mut().next().unwrap().text = text;
Rendered diagnostic (text)
warning: single-character string constant used as pattern
   --> src/metadata.rs:290:27
    |
290 |                 .contains("%")
    |                           ^^^ help: consider using a `char`: `'%'`
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/rust-1.100.0/index.html#single_char_pattern
    = note: `-W clippy::single-char-pattern` implied by `-W clippy::pedantic`
    = help: to override `-W clippy::pedantic` add `#[allow(clippy::single_char_pattern)]`