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