sculkr 0.2.1

Companion CLI for packwiz - generate modlists and track Minecraft modpack changes
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234

use minreq::{Request, URL};
use serde::{Deserialize, Serialize};

use crate::{
    consts::USER_AGENT,
    error::Error,
    parser::{ParsedCurseForgeId, ParsedModrinthId},
};

pub mod curseforge;
pub mod modrinth;

pub fn get<T: Into<URL>>(url: T) -> Request {
    minreq::get(url)
        .with_header("User-Agent", USER_AGENT)
        .with_header("Content-Type", "application/json")
        .with_header("Accept", "application/json")
}

pub fn post<T: Into<URL>>(url: T) -> Request {
    minreq::post(url)
        .with_header("User-Agent", USER_AGENT)
        .with_header("Content-Type", "application/json")
        .with_header("Accept", "application/json")
}

/// Deserializes a 200 response into `T`, or builds an [`Error`] carrying the body.
pub fn json_or_error<T>(source: &str, response: minreq::Response) -> Result<T, Error>
where
    T: serde::de::DeserializeOwned,
{
    if response.status_code != 200 {
        log::debug!(
            "{source} returned {} {} with headers:\n{}",
            response.status_code,
            response.reason_phrase,
            describe_headers(&response)
        );

        return Err(response.into());
    }

    response.json::<T>().map_err(|err| match response.as_str() {
        Ok(json) => (json, err).into(),
        Err(err) => err.into(),
    })
}

/// Renders a true response body for diagnostics
pub fn describe_body(response: &minreq::Response) -> String {
    match response.as_str() {
        Ok(text) => render_body(text),
        Err(_) => format!("<{} bytes of non-UTF-8 body>", response.as_bytes().len()),
    }
}

/// The pure half of [`describe_body`], split out so it can be tested without
/// constructing a live [`minreq::Response`], byte-for-byte.
fn render_body(text: &str) -> String {
    if text.trim().is_empty() {
        return "<empty body -- the server sent no content>".to_string();
    }

    text.to_string()
}

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

    #[test]
    fn empty_body_is_called_out_explicitly() {
        assert_eq!(
            render_body(""),
            "<empty body -- the server sent no content>"
        );
        assert_eq!(
            render_body("   \n "),
            "<empty body -- the server sent no content>"
        );
    }

    #[test]
    fn json_body_is_returned_verbatim_with_key_order_intact() {
        let body = r#"{"error":"request_error","details":["a","b"]}"#;

        // Key order must survive: serde_json would sort these alphabetically.
        assert_eq!(render_body(body), body);
    }

    #[test]
    fn non_json_body_is_passed_through_verbatim() {
        let html = "<html><body>502 Bad Gateway</body></html>";

        assert_eq!(render_body(html), html);
    }
}

/// Renders response headers, sorted for stable output.
///
/// When a body is empty the headers carry what signal there is, like: rate-limits
/// counters, CDN markers, and which hop actually rejected the request.
pub fn describe_headers(response: &minreq::Response) -> String {
    let mut headers: Vec<_> = response.headers.iter().collect();
    headers.sort_by(|a, b| a.0.cmp(&b.0));

    headers
        .into_iter()
        .map(|(name, value)| format!("  {name}: {value}"))
        .collect::<Vec<_>>()
        .join("\n")
}

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct ModrinthId(pub String);

impl From<&str> for ModrinthId {
    fn from(id: &str) -> Self {
        Self(id.to_string())
    }
}

impl From<String> for ModrinthId {
    fn from(id: String) -> Self {
        Self(id)
    }
}

impl From<ParsedModrinthId> for ModrinthId {
    fn from(id: ParsedModrinthId) -> Self {
        Self(id.id)
    }
}

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct CurseForgeId(pub i32);

impl From<i32> for CurseForgeId {
    fn from(id: i32) -> Self {
        Self(id)
    }
}

impl From<ParsedCurseForgeId> for CurseForgeId {
    fn from(id: ParsedCurseForgeId) -> Self {
        Self(id.id)
    }
}

#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct Mod {
    pub id: String,
    pub slug: String,
    pub title: String,
    pub description: String,
    /// The project's page on Modrinth/CurseForge.
    pub mod_url: String,
    /// [Option] because Curseforge doesn't offer a simple way to get a
    /// license for a project even though it's right on the project page
    pub license: Option<License>,
    /// Modrinth credits a team rather than a user list, so its authors come
    /// from a second bulk call to `/teams` ([`modrinth::get_modrinth_mods`])
    /// and are empty if that call fails.
    pub authors: Vec<Author>,
    pub icon_url: Option<String>,
    pub source_url: Option<String>,
    pub issues_url: Option<String>,
    pub wiki_url: Option<String>,
}

#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct Author {
    pub name: String,
    pub url: String,
}

#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct License {
    pub id: String,
    pub name: String,
    pub url: Option<String>,
}

impl From<modrinth::Project> for Mod {
    fn from(project: modrinth::Project) -> Self {
        let mod_url = project.url();
        Self {
            id: project.id,
            slug: project.slug,
            title: project.title,
            description: project.description,
            license: Some(License {
                id: project.license.id,
                name: project.license.name,
                url: project.license.url,
            }),
            authors: Vec::new(),
            icon_url: project.icon_url,
            mod_url,
            source_url: project.source_url,
            issues_url: project.issues_url,
            wiki_url: project.wiki_url,
        }
    }
}

impl From<curseforge::Mod> for Mod {
    fn from(project: curseforge::Mod) -> Self {
        let mod_url = project.url();
        Self {
            id: project.id.to_string(),
            slug: project.slug,
            title: project.name,
            description: project.summary,
            mod_url,
            license: None,
            authors: project
                .authors
                .into_iter()
                .map(|author| Author {
                    name: author.name,
                    url: author.url,
                })
                .collect(),
            icon_url: project.logo.map(|logo| logo.thumbnail_url),
            source_url: project.links.source_url,
            issues_url: project.links.issues_url,
            wiki_url: project.links.wiki_url,
        }
    }
}