Skip to main content

stmo_cli/commands/
deploy.rs

1#![allow(clippy::missing_errors_doc)]
2
3use anyhow::{bail, Context, Result};
4use std::fs;
5use std::path::Path;
6use std::process::Command;
7use std::collections::HashSet;
8use crate::api::RedashClient;
9use crate::models::Query;
10
11fn slugify(s: &str) -> String {
12    s.to_lowercase()
13        .chars()
14        .map(|c| if c.is_alphanumeric() { c } else { '-' })
15        .collect::<String>()
16        .split('-')
17        .filter(|s| !s.is_empty())
18        .collect::<Vec<_>>()
19        .join("-")
20}
21
22fn validate_enum_options(metadata: &crate::models::QueryMetadata, yaml_path: &str) -> Result<()> {
23    for param in &metadata.options.parameters {
24        if let Some(enum_opts) = &param.enum_options
25            && enum_opts.contains("\\n")
26        {
27            bail!(
28                "In {yaml_path}: parameter '{}' has enumOptions with escaped newlines. \
29                Use YAML multiline format instead:\n\n\
30                enumOptions: |-\n  option1\n  option2",
31                param.name
32            );
33        }
34    }
35    Ok(())
36}
37
38fn get_changed_query_ids() -> Option<HashSet<u64>> {
39    let output = Command::new("git")
40        .args(["status", "--porcelain"])
41        .output()
42        .ok()?;
43
44    if !output.status.success() {
45        return None;
46    }
47
48    let stdout = String::from_utf8(output.stdout).ok()?;
49
50    let mut changed_ids = HashSet::new();
51
52    for line in stdout.lines() {
53        if line.len() < 3 {
54            continue;
55        }
56
57        let file_path = &line[3..];
58        let path = Path::new(file_path);
59
60        if file_path.starts_with("queries/")
61            && path.extension().is_some_and(|ext| {
62                ext.eq_ignore_ascii_case("sql") || ext.eq_ignore_ascii_case("yaml")
63            })
64            && let Some(filename) = file_path.strip_prefix("queries/")
65            && let Some(id_str) = filename.split('-').next()
66            && let Ok(id) = id_str.parse::<u64>()
67        {
68            changed_ids.insert(id);
69        }
70    }
71
72    Some(changed_ids)
73}
74
75fn get_all_query_metadata() -> Result<Vec<(u64, String)>> {
76    let queries_dir = Path::new("queries");
77
78    if !queries_dir.exists() {
79        bail!("queries directory not found. Run 'stmo-cli fetch' first.");
80    }
81
82    let mut queries = Vec::new();
83
84    for entry in fs::read_dir(queries_dir).context("Failed to read queries directory")? {
85        let entry = entry.context("Failed to read directory entry")?;
86        let path = entry.path();
87
88        if path.extension().is_some_and(|ext| ext == "yaml") {
89            let metadata_content = fs::read_to_string(&path)
90                .context(format!("Failed to read {}", path.display()))?;
91
92            let metadata: crate::models::QueryMetadata = serde_yaml::from_str(&metadata_content)
93                .context(format!("Failed to parse {}", path.display()))?;
94
95            queries.push((metadata.id, metadata.name));
96        }
97    }
98
99    queries.sort_by_key(|(id, _)| *id);
100
101    Ok(queries)
102}
103
104async fn deploy_visualizations(
105    client: &RedashClient,
106    query_id: u64,
107    visualizations: &[crate::models::VisualizationMetadata],
108    server_visualizations: &[crate::models::Visualization],
109) -> Result<()> {
110    let mut matched_server_ids: HashSet<u64> = HashSet::new();
111    for viz in visualizations {
112        if let Some(id) = viz.id {
113            matched_server_ids.insert(id);
114            let viz_to_update = crate::models::Visualization {
115                id,
116                name: viz.name.clone(),
117                viz_type: viz.viz_type.clone(),
118                options: viz.options.clone(),
119                description: viz.description.clone(),
120            };
121            client.update_visualization(&viz_to_update).await?;
122            println!("    ✓ Updated visualization: {} (ID: {id})", viz.name);
123        } else {
124            let server_match = server_visualizations
125                .iter()
126                .find(|sv| sv.viz_type == viz.viz_type && !matched_server_ids.contains(&sv.id));
127            if let Some(server_viz) = server_match {
128                matched_server_ids.insert(server_viz.id);
129                let viz_to_update = crate::models::Visualization {
130                    id: server_viz.id,
131                    name: viz.name.clone(),
132                    viz_type: viz.viz_type.clone(),
133                    options: viz.options.clone(),
134                    description: viz.description.clone(),
135                };
136                client.update_visualization(&viz_to_update).await?;
137                println!("    ✓ Updated visualization: {} (ID: {})", viz_to_update.name, server_viz.id);
138            } else {
139                let viz_to_create = crate::models::CreateVisualization {
140                    query_id,
141                    name: viz.name.clone(),
142                    viz_type: viz.viz_type.clone(),
143                    options: viz.options.clone(),
144                    description: viz.description.clone(),
145                };
146                let created = client.create_visualization(query_id, &viz_to_create).await?;
147                println!("    ✓ Created visualization: {} (ID: {})", created.name, created.id);
148            }
149        }
150    }
151    Ok(())
152}
153
154#[allow(clippy::too_many_lines)]
155pub async fn deploy(client: &RedashClient, query_ids: Vec<u64>, all: bool) -> Result<()> {
156    let all_queries = get_all_query_metadata()?;
157
158    let queries_to_deploy = if !query_ids.is_empty() {
159        let ids_set: HashSet<_> = query_ids.iter().copied().collect();
160        let filtered: Vec<_> = all_queries
161            .into_iter()
162            .filter(|(id, _)| ids_set.contains(id))
163            .collect();
164
165        if filtered.is_empty() {
166            bail!("None of the specified query IDs were found in queries/ directory");
167        }
168
169        println!("Deploying {} specific queries...", filtered.len());
170        for (id, name) in &filtered {
171            println!("  → {id} - {name}");
172        }
173        println!();
174
175        filtered
176    } else if all {
177        println!("Deploying all {} queries...\n", all_queries.len());
178        all_queries
179    } else {
180        let Some(changed_ids) = get_changed_query_ids() else {
181            println!("No git repository detected.");
182            println!("Tip: Use --all to deploy all queries, or specify query IDs.");
183            return Ok(());
184        };
185
186        if changed_ids.is_empty() {
187            println!("No changed queries detected.");
188            println!("Tip: Use --all to deploy all queries regardless of git status.");
189            return Ok(());
190        }
191
192        let filtered: Vec<_> = all_queries
193            .into_iter()
194            .filter(|(id, _)| changed_ids.contains(id))
195            .collect();
196
197        println!("Deploying {} changed queries...", filtered.len());
198        for (id, name) in &filtered {
199            println!("  → {id} - {name}");
200        }
201        println!();
202
203        filtered
204    };
205
206    for (id, name) in &queries_to_deploy {
207        let slug = slugify(name);
208        let sql_path = format!("queries/{id}-{slug}.sql");
209        let yaml_path = format!("queries/{id}-{slug}.yaml");
210
211        if !Path::new(&sql_path).exists() {
212            bail!("Query SQL file not found: {sql_path}");
213        }
214        if !Path::new(&yaml_path).exists() {
215            bail!("Query metadata file not found: {yaml_path}");
216        }
217
218        let sql = fs::read_to_string(&sql_path)
219            .context(format!("Failed to read {sql_path}"))?;
220
221        let metadata_content = fs::read_to_string(&yaml_path)
222            .context(format!("Failed to read {yaml_path}"))?;
223
224        let metadata: crate::models::QueryMetadata = serde_yaml::from_str(&metadata_content)
225            .context(format!("Failed to parse {yaml_path}"))?;
226
227        validate_enum_options(&metadata, &yaml_path)?;
228
229        let result_query = if *id == 0 {
230            let create_query = crate::models::CreateQuery {
231                name: metadata.name.clone(),
232                description: metadata.description.clone(),
233                sql,
234                data_source_id: metadata.data_source_id,
235                schedule: metadata.schedule.clone(),
236                options: Some(metadata.options.clone()),
237                tags: metadata.tags.clone(),
238                is_archived: false,
239                is_draft: false,
240            };
241            let created = client.create_query(&create_query).await?;
242            let fetched = client.get_query(created.id).await?;
243            let new_slug = slugify(&fetched.name);
244            let new_base = format!("queries/{}-{new_slug}", fetched.id);
245            fs::write(format!("{new_base}.sql"), &fetched.sql)
246                .context(format!("Failed to write {new_base}.sql"))?;
247            let mut new_visualizations: Vec<crate::models::VisualizationMetadata> = fetched
248                .visualizations
249                .iter()
250                .map(crate::models::VisualizationMetadata::from)
251                .collect();
252            new_visualizations.sort_by_key(|v| v.id);
253            let new_metadata = crate::models::QueryMetadata {
254                id: fetched.id,
255                name: fetched.name.clone(),
256                description: fetched.description.clone(),
257                data_source_id: fetched.data_source_id,
258                user_id: fetched.user.as_ref().map(|u| u.id),
259                schedule: fetched.schedule.clone(),
260                options: fetched.options.clone(),
261                visualizations: new_visualizations,
262                tags: fetched.tags.clone(),
263            };
264            let yaml_content = serde_yaml::to_string(&new_metadata)
265                .context("Failed to serialize query metadata")?;
266            fs::write(format!("{new_base}.yaml"), yaml_content)
267                .context(format!("Failed to write {new_base}.yaml"))?;
268            fs::remove_file(&sql_path)
269                .context(format!("Failed to delete {sql_path}"))?;
270            fs::remove_file(&yaml_path)
271                .context(format!("Failed to delete {yaml_path}"))?;
272            println!("  ✓ Created new query: {} - {name}", fetched.id);
273            println!("    Renamed: 0-{slug}.* → {}-{new_slug}.*", fetched.id);
274            fetched
275        } else {
276            let query = Query {
277                id: metadata.id,
278                name: metadata.name.clone(),
279                description: metadata.description.clone(),
280                sql,
281                data_source_id: metadata.data_source_id,
282                user: None,
283                schedule: metadata.schedule.clone(),
284                options: metadata.options.clone(),
285                visualizations: vec![],
286                tags: metadata.tags.clone(),
287                is_archived: false,
288                is_draft: false,
289                updated_at: String::new(),
290                created_at: String::new(),
291            };
292            let result = client.create_or_update_query(&query).await?;
293            let fetched = client.get_query(*id).await?;
294            let mut updated_visualizations: Vec<crate::models::VisualizationMetadata> = fetched
295                .visualizations
296                .iter()
297                .map(crate::models::VisualizationMetadata::from)
298                .collect();
299            updated_visualizations.sort_by_key(|v| v.id);
300            let updated_metadata = crate::models::QueryMetadata {
301                id: fetched.id,
302                name: fetched.name.clone(),
303                description: fetched.description.clone(),
304                data_source_id: fetched.data_source_id,
305                user_id: fetched.user.as_ref().map(|u| u.id),
306                schedule: fetched.schedule.clone(),
307                options: fetched.options.clone(),
308                visualizations: updated_visualizations,
309                tags: fetched.tags.clone(),
310            };
311            let yaml_content = serde_yaml::to_string(&updated_metadata)
312                .context("Failed to serialize query metadata")?;
313            fs::write(&yaml_path, yaml_content)
314                .context(format!("Failed to write {yaml_path}"))?;
315            println!("  ✓ {id} - {name}");
316            result
317        };
318
319        deploy_visualizations(client, result_query.id, &metadata.visualizations, &result_query.visualizations).await?;
320    }
321
322    println!("\n✓ All resources deployed successfully");
323
324    Ok(())
325}
326
327#[cfg(test)]
328mod tests {
329    use super::*;
330
331    #[test]
332    fn test_validate_enum_options_rejects_escaped_newlines() {
333        let metadata = crate::models::QueryMetadata {
334            id: 1,
335            name: "Test Query".to_string(),
336            description: None,
337            data_source_id: 1,
338            user_id: None,
339            schedule: None,
340            options: crate::models::QueryOptions {
341                parameters: vec![crate::models::Parameter {
342                    name: "test_param".to_string(),
343                    title: "Test Param".to_string(),
344                    param_type: "enum".to_string(),
345                    enum_options: Some("option1\\noption2\\noption3".to_string()),
346                    query_id: Some(1),
347                    value: None,
348                    multi_values_options: None,
349                }],
350            },
351            visualizations: vec![],
352            tags: None,
353        };
354
355        let result = validate_enum_options(&metadata, "test.yaml");
356        assert!(result.is_err());
357        let err_msg = result.unwrap_err().to_string();
358        assert!(err_msg.contains("escaped newlines"));
359        assert!(err_msg.contains("test_param"));
360        assert!(err_msg.contains("YAML multiline format"));
361    }
362
363    #[test]
364    fn test_validate_enum_options_accepts_multiline() {
365        let metadata = crate::models::QueryMetadata {
366            id: 1,
367            name: "Test Query".to_string(),
368            description: None,
369            data_source_id: 1,
370            user_id: None,
371            schedule: None,
372            options: crate::models::QueryOptions {
373                parameters: vec![crate::models::Parameter {
374                    name: "test_param".to_string(),
375                    title: "Test Param".to_string(),
376                    param_type: "enum".to_string(),
377                    enum_options: Some("option1\noption2\noption3".to_string()),
378                    query_id: Some(1),
379                    value: None,
380                    multi_values_options: None,
381                }],
382            },
383            visualizations: vec![],
384            tags: None,
385        };
386
387        let result = validate_enum_options(&metadata, "test.yaml");
388        assert!(result.is_ok());
389    }
390
391    #[test]
392    fn test_validate_enum_options_accepts_no_enum() {
393        let metadata = crate::models::QueryMetadata {
394            id: 1,
395            name: "Test Query".to_string(),
396            description: None,
397            data_source_id: 1,
398            user_id: None,
399            schedule: None,
400            options: crate::models::QueryOptions {
401                parameters: vec![crate::models::Parameter {
402                    name: "test_param".to_string(),
403                    title: "Test Param".to_string(),
404                    param_type: "text".to_string(),
405                    enum_options: None,
406                    query_id: Some(1),
407                    value: None,
408                    multi_values_options: None,
409                }],
410            },
411            visualizations: vec![],
412            tags: None,
413        };
414
415        let result = validate_enum_options(&metadata, "test.yaml");
416        assert!(result.is_ok());
417    }
418}