swellow 0.2.0

SQL-first migration CLI
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

// Example JSON output produced by Swellow:
//
// Success case:
// {
//   "command": "plan",
//   "status": "success",
//   "data": null,
//   "error": null,
//   "timestamp": "2025-01-10T15:52:12Z"
// }
//
// Error case:
// {
//   "command": "plan",
//   "status": "error",
//   "data": null,
//   "error": {
//     "type": "version",
//     "message": "Invalid version interval: start=5, end=3"
//   },
//   "timestamp": "2025-01-10T15:52:12Z"
// }
//
// Notes:
// - `status` is either `"success"` or `"error"`
// - `data` is optional and command-specific
// - `error` is a structured object with a `type` and human-readable `message`
// - `timestamp` is an RFC 3339 UTC timestamp indicating when the command completed
use crate::{db::EngineError, error::{SwellowError, SwellowErrorKind}, parser::ParseErrorKind};
use chrono::{DateTime, Utc};
use serde::Serialize;
use serde_json::Value;


#[derive(Debug, Serialize)]
#[serde(tag = "type", rename_all = "snake_case")]
pub enum SwellowErrorJson {
    Argument { message: String },
    Engine { message: String },
    FileNotFound { message: String },
    Io { message: String },
    Parser { message: String },
    Tracing { message: String },
    Version { message: String },
}

impl From<&SwellowError> for SwellowErrorJson {
    fn from(error: &SwellowError) -> Self {
        let stderr = format!("{error}");

        match &error.kind {
            SwellowErrorKind::DryRunUnsupportedEngine(_) => Self::Argument { message: stderr },
            SwellowErrorKind::DryRunRequiresTransaction => Self::Argument { message: stderr },
            SwellowErrorKind::Engine(_) => Self::Engine { message: stderr },
            SwellowErrorKind::Fmt(_) => Self::Io { message: stderr },
            SwellowErrorKind::InvalidVersionInterval(..) => Self::Version { message: stderr },
            SwellowErrorKind::IoDirectoryCreate {..} | SwellowErrorKind::IoFileWrite {..} => {
                Self::Io { message: stderr }
            }
            SwellowErrorKind::Parse(e) => match &e.kind {
                ParseErrorKind::FileNotFound {..} => Self::FileNotFound { message: stderr },
                ParseErrorKind::DuplicateVersionNumber(_) => Self::Version { message: stderr },
                ParseErrorKind::InvalidDirectory(_) => Self::Io { message: stderr },
                ParseErrorKind::InvalidVersionFormat(_) => Self::Version { message: stderr },
                ParseErrorKind::InvalidVersionNumber(_) => Self::Version { message: stderr },
                ParseErrorKind::Io {..} => Self::Io { message: stderr },
                ParseErrorKind::NoMigrationsInRange(..) => Self::FileNotFound { message: stderr },
                ParseErrorKind::Tokenizer(_) |
                ParseErrorKind::Statement(_) |
                ParseErrorKind::Tokens(_) => Self::Parser { message: stderr },
            }
            SwellowErrorKind::SetGlobalDefault(_) => Self::Tracing { message: stderr }
        }
    }
}

impl From<&EngineError> for SwellowErrorJson {
    fn from(e: &EngineError) -> Self {
        Self::Engine { message: format!("{e}") }
    }
}

#[derive(PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum SwellowStatus {
    Success,
    Error,
}

#[derive(Serialize)]
pub struct SwellowOutput<T: Serialize> {
    pub command: String,
    pub status: SwellowStatus,
    pub data: Option<T>,
    pub error: Option<SwellowErrorJson>,
    pub timestamp: DateTime<Utc>,
}

impl SwellowOutput<Value> {
    pub fn from_result(
        command: impl Into<String>,
        result: Result<(), SwellowError>,
    ) -> Self {
        let timestamp = chrono::Utc::now();

        match result {
            Ok(_) => Self {
                command: command.into(),
                status: SwellowStatus::Success,
                data: None,
                error: None,
                timestamp,
            },
            Err(e) => Self {
                command: command.into(),
                status: SwellowStatus::Error,
                data: None,
                error: Some((&e).into()),
                timestamp,
            },
        }
    }
}


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

    #[test]
    fn wraps_output_as_error_correctly() {
        let err = SwellowError {
            kind: SwellowErrorKind::InvalidVersionInterval(5, 3),
        };

        let output = SwellowOutput::<()> {
            command: "plan".to_string(),
            status: SwellowStatus::Error,
            data: None,
            error: Some((&err).into()),
            timestamp: Utc::now(),
        };

        let s = serde_json::to_string(&output).unwrap();
        let v: Value = serde_json::from_str(&s).unwrap();

        assert_eq!(v["status"], "error");
        assert_eq!(v["command"], "plan");
        assert_eq!(v["error"]["type"], "version");
    }
}