rtb-update 0.6.0

Rust Tool Base — self-update subsystem. Composes on rtb-vcs to fetch signed release assets and atomically swap the running binary.
Documentation 
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

//! Asset selection for the running host.
//!
//! # Grammar
//!
//! The default asset-name pattern is
//! `{name}-{version}-{target}{ext}`. Tool authors override via
//! [`rtb_app::metadata::ToolMetadata::update_asset_pattern`].
//!
//! Placeholders:
//!
//! | Placeholder | Value |
//! | --- | --- |
//! | `{name}` | [`rtb_app::metadata::ToolMetadata::name`] |
//! | `{version}` | Release tag with any leading `v` stripped |
//! | `{target}` | Rust host triple (e.g. `x86_64-unknown-linux-gnu`) |
//! | `{os}` | `linux`, `macos`, `windows` |
//! | `{arch}` | `x86_64`, `aarch64` |
//! | `{ext}` | `.tar.gz` on Unix / `.zip` on Windows |
//!
//! All occurrences of each placeholder are replaced. Unknown
//! placeholders pass through verbatim — useful when a tool author
//! embeds release-pipeline-specific substitutions we haven't
//! anticipated yet.

use rtb_vcs::{Release, ReleaseAsset};

use crate::error::UpdateError;

/// Default pattern — matches the release-pipeline conventions we
/// recommend to tool authors.
pub const DEFAULT_PATTERN: &str = "{name}-{version}-{target}{ext}";

/// Render the asset pattern with host + release substitutions.
#[must_use]
#[allow(clippy::literal_string_with_formatting_args)]
pub fn render_pattern(pattern: &str, name: &str, version: &str) -> String {
    let (os, arch, target, ext) = host_substitutions();
    let version_no_v = version.strip_prefix('v').unwrap_or(version);
    pattern
        .replace("{name}", name)
        .replace("{version}", version_no_v)
        .replace("{target}", target)
        .replace("{os}", os)
        .replace("{arch}", arch)
        .replace("{ext}", ext)
}

/// Return `(os, arch, target_triple, ext)` for the running binary.
///
/// Unknown OS/arch combinations produce an empty `target` string, which
/// surfaces as `{target}` staying literal in the rendered URL — an
/// unmistakable signal for the tool author to set
/// `ToolMetadata::update_asset_pattern` explicitly.
#[must_use]
pub const fn host_substitutions() -> (&'static str, &'static str, &'static str, &'static str) {
    let os = std::env::consts::OS;
    let arch = std::env::consts::ARCH;
    let target = match (os.as_bytes(), arch.as_bytes()) {
        (b"linux", b"x86_64") => "x86_64-unknown-linux-gnu",
        (b"linux", b"aarch64") => "aarch64-unknown-linux-gnu",
        (b"macos", b"x86_64") => "x86_64-apple-darwin",
        (b"macos", b"aarch64") => "aarch64-apple-darwin",
        (b"windows", b"x86_64") => "x86_64-pc-windows-msvc",
        (b"windows", b"aarch64") => "aarch64-pc-windows-msvc",
        _ => "",
    };
    let ext = match os.as_bytes() {
        b"windows" => ".zip",
        _ => ".tar.gz",
    };
    (os, arch, target, ext)
}

/// Pick the asset on `release` whose name matches `expected`.
///
/// Falls back to a case-insensitive match on `{name}-{version}` prefix
/// if no exact-match asset is found — useful when release-pipelines
/// emit slightly varying filenames (`.tgz` vs `.tar.gz`).
///
/// # Errors
///
/// [`UpdateError::NoMatchingAsset`] when nothing matches.
pub fn pick_asset<'a>(
    release: &'a Release,
    expected: &str,
) -> crate::error::Result<&'a ReleaseAsset> {
    if let Some(exact) = release.assets.iter().find(|a| a.name == expected) {
        return Ok(exact);
    }
    // Fuzzy: case-insensitive match on the pattern's prefix up to the
    // first `{ext}` separator. This lets `.tgz` match a pattern ending
    // in `.tar.gz` and vice versa.
    let expected_lower = expected.to_ascii_lowercase();
    if let Some(fuzzy) = release.assets.iter().find(|a| {
        let name = a.name.to_ascii_lowercase();
        name.starts_with(&expected_lower[..prefix_len(&expected_lower)])
    }) {
        return Ok(fuzzy);
    }
    Err(UpdateError::NoMatchingAsset { target: expected.to_string() })
}

fn prefix_len(name: &str) -> usize {
    // Match up to the ext delimiter — `.tar.gz` / `.zip`. Fallback:
    // whole string.
    for sep in [".tar.gz", ".zip", ".tgz"] {
        if let Some(idx) = name.find(sep) {
            return idx;
        }
    }
    name.len()
}

/// Find the signature file for `asset` on `release`. Preference:
/// `.minisig` over `.sig` (minisign format carries more context when
/// things go wrong). Returns `None` if neither is present.
#[must_use]
pub fn pick_signature<'a>(release: &'a Release, asset: &ReleaseAsset) -> Option<&'a ReleaseAsset> {
    let minisig_name = format!("{}.minisig", asset.name);
    if let Some(a) = release.assets.iter().find(|a| a.name == minisig_name) {
        return Some(a);
    }
    let sig_name = format!("{}.sig", asset.name);
    release.assets.iter().find(|a| a.name == sig_name)
}