sofie-check 0.3.0

Structure checks (comment density, god types) and the `sofie check` rules over the app model.
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

use sofie_model::{Code, Function, Method, Module, Route, TypeName};

use super::{Finding, Rule};

/// Resolved only where the unit of work commits, so the compiler refuses them on a GET too.
const WRITE_SIDE_ARGUMENTS: [&str; 9] = [
    "Db",
    "Dep",
    "Extensions",
    "Flags",
    "IdempotencyKey",
    "Jobs",
    "Session",
    "ShieldBlocks",
    "SignIns",
];
const QUEUED: &str = "Queued";

pub(super) fn check_safe_methods(modules: &[Module]) -> Vec<Finding> {
    modules
        .iter()
        .flat_map(|module| {
            module
                .areas
                .iter()
                .flat_map(|area| &area.routes)
                .filter(|route| route.method == Method::Get && !route.is_resource())
                .filter_map(|route| writing_get(&module.code, route))
        })
        .collect()
}

fn writing_get(code: &Code, route: &Route) -> Option<Finding> {
    let function = code.function(&route.handler)?;
    let (line, write) = write_of(code, function)?;
    Some(Finding {
        rule: Rule::WritingGet,
        file: function.file.clone(),
        line,
        message: format!(
            "GET {} is answered by `{}`, which {write}: a GET, a screen or an island never writes",
            route.path,
            route.handler.join("::")
        ),
        fix: "take a read model or `Read` and return a reply; move the write into a POST, or \
              into a job a domain event triggers"
            .to_owned(),
    })
}

fn write_of(code: &Code, function: &Function) -> Option<(usize, String)> {
    if let Some(argument) = function
        .arguments
        .iter()
        .find(|argument| is_write_side(code, argument))
    {
        return Some((function.line, format!("takes `{}`", argument.name)));
    }
    if let Some(output) = function
        .output
        .as_ref()
        .map(TypeName::without_result)
        .filter(|output| names_writable(code, output))
    {
        return Some((function.line, format!("returns `{}`", output.name)));
    }
    let queued = function.effects.queued.first()?;
    Some((queued.line, "queues a job".to_owned()))
}

fn is_write_side(code: &Code, argument: &TypeName) -> bool {
    WRITE_SIDE_ARGUMENTS.contains(&argument.name.as_str())
        || is_aggregate(code, &argument.name)
        || code.inputs.iter().any(|input| input.name == argument.name)
}

/// `Id<Order>` names an aggregate without being one.
fn names_writable(code: &Code, ty: &TypeName) -> bool {
    ty.name == QUEUED
        || is_aggregate(code, &ty.name)
        || (ty.name != "Id"
            && ty
                .arguments
                .iter()
                .any(|argument| names_writable(code, argument)))
}

fn is_aggregate(code: &Code, name: &str) -> bool {
    code.aggregates
        .iter()
        .any(|aggregate| aggregate.name == name)
}