acorn-lib 0.3.2

ACORN library
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

//! Schema migration support.
use crate::{
    analyzer::Standard,
    error::ApiResult,
    io::{jsonc_parse_value, read_file, FromPath},
};
use acorn_core::util::MimeType;
use acorn_host::terminal::Label;
use acorn_schema::research_activity::ResearchActivity;
use acorn_schema::standard::zon;
use color_eyre::eyre::eyre;
use owo_colors::OwoColorize;
use std::path::PathBuf;
use tracing::warn;

/// A deprecated schema field and its canonical replacement.
pub type FieldMigration = (&'static str, &'static str);
/// Migration behavior for schemas that accept deprecated or versioned input.
pub trait Migration: super::InputOutput {
    /// Schema standard used in migration diagnostics.
    const STANDARD: Standard;
    /// Return migrations required by a serialized schema value.
    fn field_migrations(value: &serde_json::Value) -> Vec<FieldMigration>;
    /// Rewrite a schema file when deprecated fields require migration.
    fn migrate(path: impl Into<PathBuf>) -> ApiResult<bool> {
        let source = path.into();
        Self::migrations_from_path(&source).and_then(|migrations| match migrations.is_empty() {
            | true => Ok(false),
            | false => Self::read(source.clone()).and_then(|value| value.write(source).map(|()| true)),
        })
    }
    /// Return migrations required by a schema file.
    fn migrations_from_path(source: &PathBuf) -> ApiResult<Vec<FieldMigration>> {
        read_file(source.clone()).map(|content| {
            let value = match MimeType::from_path(source) {
                | MimeType::Json => serde_json::from_str(&content).ok(),
                | MimeType::Jsonc => jsonc_parse_value(&content).ok(),
                | MimeType::Yaml => serde_norway::from_str(&content).ok(),
                | MimeType::Zon => zon::decode_value(&content).ok(),
                | _ => None,
            };
            value.as_ref().map(Self::field_migrations).unwrap_or_default()
        })
    }
    /// Warn about deprecated fields present in a serialized schema value.
    fn print_migration_warnings(value: &serde_json::Value) {
        Self::field_migrations(value).into_iter().for_each(|(deprecated, replacement)| {
            warn!(
                "=> {}Deprecated {} field {}; use {}",
                Label::CAUTION,
                Self::STANDARD,
                deprecated.red(),
                replacement.green()
            );
        });
    }
    /// Read a schema file while rejecting fields that require migration.
    fn read_strict(path: impl Into<PathBuf>) -> ApiResult<Self> {
        let source = path.into();
        Self::migrations_from_path(&source).and_then(|migrations| match migrations.first() {
            | Some((deprecated, replacement)) => Err(eyre!(
                "Deprecated {} field `{deprecated}` is not allowed in strict mode; use `{replacement}`",
                Self::STANDARD
            )),
            | None => Self::read(source),
        })
    }
}
impl Migration for ResearchActivity {
    const STANDARD: Standard = Standard::ResearchActivityData;
    fn field_migrations(value: &serde_json::Value) -> Vec<FieldMigration> {
        let media_contains = |field| {
            value
                .pointer("/meta/media")
                .and_then(serde_json::Value::as_array)
                .is_some_and(|media| media.iter().any(|item| item.get(field).is_some()))
        };
        [
            media_contains("href").then_some(("meta.media[].href", "meta.media[].contentUrl")),
            media_contains("url").then_some(("meta.media[].url", "meta.media[].contentUrl")),
            value.pointer("/contact/profile").is_some().then_some(("contact.profile", "contact.url")),
            value
                .pointer("/sections/outcomes")
                .is_some()
                .then_some(("sections.outcomes", "sections.impact")),
        ]
        .into_iter()
        .flatten()
        .collect()
    }
}