clickhousectl 0.2.3

The CLI for ClickHouse: local and cloud.
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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
use crate::error::{Error, Result};
use crate::version_manager::list::{Channel, VersionEntry, list_available_versions};
use crate::version_manager::platform::{DownloadSource, Platform, builds_probe_url};
use crate::version_manager::spec::VersionSpec;
use serde::Deserialize;

/// Result of resolving a version spec — contains everything needed to download
#[derive(Debug, Clone)]
pub struct ResolvedVersion {
    /// The download source to use
    pub source: DownloadSource,
    /// Human-readable description of what was resolved (for display)
    pub display_version: String,
    /// Whether the exact version is known before download
    /// (false for builds.clickhouse.com where we detect version post-download)
    pub exact_version_known: bool,
    /// The exact version string, if known
    pub exact_version: Option<String>,
    /// Channel, if known
    pub channel: Option<Channel>,
}

/// Resolve a VersionSpec into a concrete download source
pub async fn resolve(spec: &VersionSpec, platform: &Platform) -> Result<ResolvedVersion> {
    match spec {
        VersionSpec::Latest => resolve_latest(platform).await,
        VersionSpec::Channel(channel) => resolve_channel(*channel, platform).await,
        VersionSpec::Major(major) => resolve_major(*major, platform).await,
        VersionSpec::Minor(major, minor) => resolve_minor(*major, *minor, platform).await,
        VersionSpec::Exact(version) => resolve_exact(version, platform).await,
    }
}

/// `install latest` — always from builds.clickhouse.com/master
async fn resolve_latest(_platform: &Platform) -> Result<ResolvedVersion> {
    Ok(ResolvedVersion {
        source: DownloadSource::Builds {
            version_path: "master".to_string(),
        },
        display_version: "latest".to_string(),
        exact_version_known: false,
        exact_version: None,
        channel: None,
    })
}

/// `install stable` / `install lts` — GH API to find minor, then builds
async fn resolve_channel(channel: Channel, platform: &Platform) -> Result<ResolvedVersion> {
    let available = list_available_versions().await?;
    let entry = available
        .iter()
        .find(|e| e.channel == channel)
        .ok_or_else(|| Error::NoMatchingVersion(channel.to_string()))?;

    // Extract minor version (e.g., "25.12" from "25.12.9.61")
    let minor = extract_minor(&entry.version)?;

    // Try builds first
    if probe_builds(&minor, platform).await {
        return Ok(ResolvedVersion {
            source: DownloadSource::Builds {
                version_path: minor.clone(),
            },
            display_version: format!("{} ({})", minor, channel),
            exact_version_known: false,
            exact_version: None,
            channel: Some(channel),
        });
    }

    // Fallback: use packages (Linux) or GitHub (macOS)
    Ok(fallback_source(&entry.version, entry.channel, platform))
}

/// `install 25` — probe builds for highest 25.x minor
async fn resolve_major(major: u32, platform: &Platform) -> Result<ResolvedVersion> {
    // Probe builds.clickhouse.com for all possible minors in this major (1..12)
    let mut highest_available: Option<u32> = None;
    let client = reqwest::Client::builder()
        .user_agent(crate::user_agent::user_agent())
        .build()
        .map_err(|e| Error::Download(e.to_string()))?;

    for minor in 1..=12 {
        let url = builds_probe_url(&format!("{}.{}", major, minor), platform);
        match client.head(&url).send().await {
            Ok(resp) if resp.status().is_success() => {
                highest_available = Some(minor);
            }
            _ => {}
        }
    }

    if let Some(minor) = highest_available {
        let version_path = format!("{}.{}", major, minor);
        return Ok(ResolvedVersion {
            source: DownloadSource::Builds {
                version_path: version_path.clone(),
            },
            display_version: version_path,
            exact_version_known: false,
            exact_version: None,
            channel: None,
        });
    }

    // Fallback: try GH matching-refs API for each minor, highest first
    for minor in (1..=12).rev() {
        let prefix = format!("{}.{}", major, minor);
        if let Ok(entry) = find_version_by_refs(&prefix).await {
            return Ok(fallback_source(&entry.version, entry.channel, platform));
        }
    }

    Err(Error::NoMatchingVersion(major.to_string()))
}

/// `install 25.12` — try builds, fallback to packages/GH
async fn resolve_minor(major: u32, minor: u32, platform: &Platform) -> Result<ResolvedVersion> {
    let version_path = format!("{}.{}", major, minor);

    // Try builds first
    if probe_builds(&version_path, platform).await {
        return Ok(ResolvedVersion {
            source: DownloadSource::Builds {
                version_path: version_path.clone(),
            },
            display_version: version_path,
            exact_version_known: false,
            exact_version: None,
            channel: None,
        });
    }

    // Fallback: targeted GH API call to find exact version for this minor
    let entry = find_version_by_refs(&version_path).await?;

    Ok(fallback_source(&entry.version, entry.channel, platform))
}

/// `install 25.12.9.61` — exact version, needs channel from GH API
async fn resolve_exact(version: &str, platform: &Platform) -> Result<ResolvedVersion> {
    // Use matching-refs to find the exact tag and its channel.
    // For "25.12.9.61", search refs matching "v25.12.9.61" — should return the exact tag.
    // Fail fast if the lookup fails: a wrong channel produces a broken download URL,
    // and silently guessing Stable could fetch the wrong artifact.
    let channel = find_exact_channel(version).await?;
    Ok(fallback_source(version, channel, platform))
}

/// Look up the channel for an exact version via GitHub's matching-refs API
async fn find_exact_channel(version: &str) -> Result<Channel> {
    let url = format!(
        "https://api.github.com/repos/ClickHouse/ClickHouse/git/matching-refs/tags/v{}-",
        version
    );
    let client = reqwest::Client::builder()
        .user_agent(crate::user_agent::user_agent())
        .build()?;

    let response = client
        .get(&url)
        .send()
        .await?
        .error_for_status()
        .map_err(|e| Error::Download(format!("GitHub API request failed: {}", e)))?;

    let refs: Vec<GitRef> = response.json().await?;
    parse_exact_channel(&refs, version)
}

/// Parse the channel from a list of git refs for an exact version.
/// Looks for tags like "refs/tags/v26.4.1.562-stable" and extracts the channel suffix.
fn parse_exact_channel(refs: &[GitRef], version: &str) -> Result<Channel> {
    for git_ref in refs {
        let Some(tag) = git_ref.ref_name.strip_prefix("refs/tags/v") else {
            continue;
        };
        if let Some(dash_pos) = tag.rfind('-') {
            let suffix = &tag[dash_pos + 1..];
            if let Some(channel) = Channel::from_tag_suffix(suffix) {
                return Ok(channel);
            }
        }
    }

    Err(Error::NoMatchingVersion(version.to_string()))
}

/// Build a fallback download source: packages for Linux, GitHub for macOS
fn fallback_source(version: &str, channel: Channel, platform: &Platform) -> ResolvedVersion {
    let source = if platform.packages_arch().is_some() {
        // Linux: use packages.clickhouse.com
        DownloadSource::Packages {
            channel,
            version: version.to_string(),
        }
    } else {
        // macOS: use GitHub releases
        DownloadSource::GitHub {
            version: version.to_string(),
            channel,
        }
    };

    ResolvedVersion {
        source,
        display_version: version.to_string(),
        exact_version_known: true,
        exact_version: Some(version.to_string()),
        channel: Some(channel),
    }
}

/// Probe builds.clickhouse.com with a HEAD request to check if a version exists
async fn probe_builds(version_path: &str, platform: &Platform) -> bool {
    let url = builds_probe_url(version_path, platform);
    let client = match reqwest::Client::builder()
        .user_agent(crate::user_agent::user_agent())
        .build()
    {
        Ok(c) => c,
        Err(_) => return false,
    };

    match client.head(&url).send().await {
        Ok(resp) => resp.status().is_success(),
        Err(_) => false,
    }
}

#[derive(Deserialize)]
struct GitRef {
    #[serde(rename = "ref")]
    ref_name: String,
}

/// Find the latest release version matching a prefix using GitHub's matching-refs API.
/// This is a single targeted API call that works regardless of how old the version is.
/// prefix should be like "25.2" or "24.8" — we search for tags matching `v{prefix}.`
async fn find_version_by_refs(prefix: &str) -> Result<VersionEntry> {
    let url = format!(
        "https://api.github.com/repos/ClickHouse/ClickHouse/git/matching-refs/tags/v{}.",
        prefix
    );
    let client = reqwest::Client::builder()
        .user_agent(crate::user_agent::user_agent())
        .build()?;

    let response = client
        .get(&url)
        .send()
        .await?
        .error_for_status()
        .map_err(|e| Error::Download(format!("GitHub API request failed: {}", e)))?;

    let refs: Vec<GitRef> = response.json().await?;
    parse_version_refs(&refs, prefix)
}

/// Parse a list of git refs into the best matching VersionEntry.
/// Prefers stable/lts tags, but falls back to any tagged version (e.g. "-new")
/// so that pre-release or newly-tagged versions can still be resolved.
fn parse_version_refs(refs: &[GitRef], prefix: &str) -> Result<VersionEntry> {
    use super::list::compare_versions;
    use std::cmp::Ordering;

    let mut best: Option<VersionEntry> = None;
    let mut any: Option<VersionEntry> = None;
    for git_ref in refs {
        let Some(tag) = git_ref.ref_name.strip_prefix("refs/tags/v") else {
            continue;
        };
        if let Some(dash_pos) = tag.rfind('-') {
            let version = &tag[..dash_pos];
            let suffix = &tag[dash_pos + 1..];
            let is_higher = |current: &Option<VersionEntry>| match current {
                Some(existing) => {
                    compare_versions(version, &existing.version) == Ordering::Greater
                }
                None => true,
            };
            if let Some(channel) = Channel::from_tag_suffix(suffix) {
                if is_higher(&best) {
                    best = Some(VersionEntry {
                        version: version.to_string(),
                        channel,
                    });
                }
            } else if is_higher(&any) {
                any = Some(VersionEntry {
                    version: version.to_string(),
                    channel: Channel::Stable,
                });
            }
        }
    }

    best.or(any)
        .ok_or_else(|| Error::NoMatchingVersion(prefix.to_string()))
}

/// Extract the minor version from a full version string (e.g., "25.12.9.61" -> "25.12")
fn extract_minor(version: &str) -> Result<String> {
    let parts: Vec<&str> = version.split('.').collect();
    if parts.len() >= 2 {
        Ok(format!("{}.{}", parts[0], parts[1]))
    } else {
        Err(Error::NoMatchingVersion(format!(
            "cannot extract minor version from '{}'",
            version
        )))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::version_manager::platform::Os;

    fn make_ref(name: &str) -> GitRef {
        GitRef {
            ref_name: name.to_string(),
        }
    }

    #[test]
    fn test_extract_minor() {
        assert_eq!(extract_minor("25.12.9.61").unwrap(), "25.12");
        assert_eq!(extract_minor("24.8.6.70").unwrap(), "24.8");
        assert_eq!(extract_minor("25.12").unwrap(), "25.12");
    }

    #[test]
    fn test_extract_minor_invalid() {
        assert!(extract_minor("25").is_err());
    }

    #[test]
    fn test_fallback_source_linux() {
        let platform = Platform {
            os: Os::Linux,
            arch: crate::version_manager::platform::Arch::X86_64,
        };
        let resolved = fallback_source("25.12.9.61", Channel::Stable, &platform);
        assert!(matches!(resolved.source, DownloadSource::Packages { .. }));
        assert_eq!(resolved.exact_version, Some("25.12.9.61".to_string()));
        assert!(resolved.exact_version_known);
    }

    #[test]
    fn test_fallback_source_macos() {
        let platform = Platform {
            os: Os::MacOS,
            arch: crate::version_manager::platform::Arch::Aarch64,
        };
        let resolved = fallback_source("25.12.9.61", Channel::Stable, &platform);
        assert!(matches!(resolved.source, DownloadSource::GitHub { .. }));
        assert_eq!(resolved.exact_version, Some("25.12.9.61".to_string()));
        assert!(resolved.exact_version_known);
    }

    // -- parse_version_refs tests --

    #[test]
    fn test_parse_version_refs_stable_tag() {
        let refs = vec![make_ref("refs/tags/v25.12.9.61-stable")];
        let entry = parse_version_refs(&refs, "25.12").unwrap();
        assert_eq!(entry.version, "25.12.9.61");
        assert_eq!(entry.channel, Channel::Stable);
    }

    #[test]
    fn test_parse_version_refs_lts_tag() {
        let refs = vec![make_ref("refs/tags/v24.8.10.6-lts")];
        let entry = parse_version_refs(&refs, "24.8").unwrap();
        assert_eq!(entry.version, "24.8.10.6");
        assert_eq!(entry.channel, Channel::Lts);
    }

    #[test]
    fn test_parse_version_refs_prefers_stable_over_unknown() {
        let refs = vec![
            make_ref("refs/tags/v26.4.1.1-new"),
            make_ref("refs/tags/v26.4.2.5-stable"),
        ];
        let entry = parse_version_refs(&refs, "26.4").unwrap();
        assert_eq!(entry.version, "26.4.2.5");
        assert_eq!(entry.channel, Channel::Stable);
    }

    #[test]
    fn test_parse_version_refs_falls_back_to_unknown_suffix() {
        let refs = vec![make_ref("refs/tags/v26.4.1.1-new")];
        let entry = parse_version_refs(&refs, "26.4").unwrap();
        assert_eq!(entry.version, "26.4.1.1");
        assert_eq!(entry.channel, Channel::Stable);
    }

    #[test]
    fn test_parse_version_refs_empty_refs() {
        let refs: Vec<GitRef> = vec![];
        assert!(parse_version_refs(&refs, "99.99").is_err());
    }

    #[test]
    fn test_parse_version_refs_no_matching_tags() {
        let refs = vec![
            make_ref("refs/heads/main"),
            make_ref("something/else"),
        ];
        assert!(parse_version_refs(&refs, "25.12").is_err());
    }

    #[test]
    fn test_parse_version_refs_no_dash_in_tag() {
        // A tag without a channel suffix at all should be skipped
        let refs = vec![make_ref("refs/tags/v25.12.9.61")];
        assert!(parse_version_refs(&refs, "25.12").is_err());
    }

    #[test]
    fn test_parse_version_refs_picks_highest_stable() {
        // Multiple stable tags — picks the semantically highest version
        let refs = vec![
            make_ref("refs/tags/v25.12.1.10-stable"),
            make_ref("refs/tags/v25.12.9.61-stable"),
        ];
        let entry = parse_version_refs(&refs, "25.12").unwrap();
        assert_eq!(entry.version, "25.12.9.61");
    }

    #[test]
    fn test_parse_version_refs_unordered_picks_highest() {
        // Higher patch version appears before lower — must still pick the higher one
        let refs = vec![
            make_ref("refs/tags/v25.12.10.5-stable"),
            make_ref("refs/tags/v25.12.9.61-stable"),
        ];
        let entry = parse_version_refs(&refs, "25.12").unwrap();
        assert_eq!(entry.version, "25.12.10.5");
    }

    #[test]
    fn test_parse_version_refs_stable_beats_later_unknown() {
        // Even if an unknown-suffix tag appears after a stable one, stable wins
        let refs = vec![
            make_ref("refs/tags/v26.4.2.5-stable"),
            make_ref("refs/tags/v26.4.3.1-beta"),
        ];
        let entry = parse_version_refs(&refs, "26.4").unwrap();
        // stable is overwritten by the second stable-eligible tag, but "beta" is not stable
        // so the last stable still wins
        assert_eq!(entry.version, "26.4.2.5");
        assert_eq!(entry.channel, Channel::Stable);
    }

    // -- parse_exact_channel tests --

    #[test]
    fn test_parse_exact_channel_stable() {
        let refs = vec![make_ref("refs/tags/v25.12.9.61-stable")];
        assert_eq!(
            parse_exact_channel(&refs, "25.12.9.61").unwrap(),
            Channel::Stable
        );
    }

    #[test]
    fn test_parse_exact_channel_lts() {
        let refs = vec![make_ref("refs/tags/v24.8.10.6-lts")];
        assert_eq!(
            parse_exact_channel(&refs, "24.8.10.6").unwrap(),
            Channel::Lts
        );
    }

    #[test]
    fn test_parse_exact_channel_unknown_suffix_errors() {
        // parse_exact_channel does NOT fall back to unknown suffixes
        let refs = vec![make_ref("refs/tags/v26.4.1.1-new")];
        assert!(parse_exact_channel(&refs, "26.4.1.1").is_err());
    }

    #[test]
    fn test_parse_exact_channel_empty_refs() {
        let refs: Vec<GitRef> = vec![];
        assert!(parse_exact_channel(&refs, "25.12.9.61").is_err());
    }
}