codoseo-core 0.1.0-rc.1

Shared types for CodoSEO, the open-source SEO crawler and monitor.
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

//! A difference between two crawls of the same site.

use serde::{Deserialize, Serialize};
use url::Url;

use crate::check::Severity;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum ChangeKind {
    NewUrl,
    RemovedUrl,
    StatusChanged,
    BecameNoindex,
    TitleChanged,
    TitleRemoved,
    CanonicalChanged,
    RedirectChainGrew,
    RobotsTxtChanged,
    SitemapShrank,
    ErrorSpike,
    SiteMoved,
}

impl ChangeKind {
    /// The stable machine name (`became_noindex`), the same as in the database and in webhooks.
    pub fn slug(self) -> &'static str {
        match self {
            ChangeKind::NewUrl => "new_url",
            ChangeKind::RemovedUrl => "removed_url",
            ChangeKind::StatusChanged => "status_changed",
            ChangeKind::BecameNoindex => "became_noindex",
            ChangeKind::TitleChanged => "title_changed",
            ChangeKind::TitleRemoved => "title_removed",
            ChangeKind::CanonicalChanged => "canonical_changed",
            ChangeKind::RedirectChainGrew => "redirect_chain_grew",
            ChangeKind::RobotsTxtChanged => "robots_txt_changed",
            ChangeKind::SitemapShrank => "sitemap_shrank",
            ChangeKind::ErrorSpike => "error_spike",
            ChangeKind::SiteMoved => "site_moved",
        }
    }

    /// What a person reads in an alert or the settings grid.
    pub fn label(self) -> &'static str {
        match self {
            ChangeKind::NewUrl => "New URL",
            ChangeKind::RemovedUrl => "URL removed",
            ChangeKind::StatusChanged => "Status changed",
            ChangeKind::BecameNoindex => "Became noindex",
            ChangeKind::TitleChanged => "Title changed",
            ChangeKind::TitleRemoved => "Title removed",
            ChangeKind::CanonicalChanged => "Canonical changed",
            ChangeKind::RedirectChainGrew => "Redirect chain grew",
            ChangeKind::RobotsTxtChanged => "robots.txt changed",
            ChangeKind::SitemapShrank => "Sitemap shrank",
            ChangeKind::ErrorSpike => "Error spike (4xx/5xx)",
            ChangeKind::SiteMoved => "Site moved",
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Change {
    pub kind: ChangeKind,
    pub severity: Severity,
    pub url: Option<Url>,
    pub before: String,
    pub after: String,
}

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

    #[test]
    fn slugs_match_the_serialized_names_and_labels_are_distinct() {
        let all = [
            ChangeKind::NewUrl,
            ChangeKind::RemovedUrl,
            ChangeKind::StatusChanged,
            ChangeKind::BecameNoindex,
            ChangeKind::TitleChanged,
            ChangeKind::TitleRemoved,
            ChangeKind::CanonicalChanged,
            ChangeKind::RedirectChainGrew,
            ChangeKind::RobotsTxtChanged,
            ChangeKind::SitemapShrank,
            ChangeKind::ErrorSpike,
            ChangeKind::SiteMoved,
        ];
        for kind in all {
            assert_eq!(
                serde_json::to_value(kind).unwrap(),
                serde_json::Value::String(kind.slug().to_owned())
            );
        }
        let labels: std::collections::HashSet<_> = all.iter().map(|k| k.label()).collect();
        assert_eq!(labels.len(), all.len());
    }
}