tauri-plugin-ota-self-update 0.2.0

Self-hosted OTA updates for Tauri v2 web assets.
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
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
use std::{
  fs,
  path::{Path, PathBuf},
  sync::Arc,
};

use base64::Engine;
use reqwest::header::{HeaderMap, HeaderName, HeaderValue};
use semver::Version;
use tauri::{AppHandle, Manager, Runtime};
use url::Url;

use crate::{models::*, Config, Error, Result};

#[derive(Clone)]
pub struct PendingUpdate {
  pub version: String,
  pub archive_path: PathBuf,
}

pub struct OtaCore<R: Runtime> {
  app: AppHandle<R>,
  config: Arc<tauri::async_runtime::Mutex<Config>>,
  pending_update: Arc<tauri::async_runtime::Mutex<Option<PendingUpdate>>>,
}

impl<R: Runtime> OtaCore<R> {
  fn log_info(message: impl AsRef<str>) {
    eprintln!("[ota-self-update][info] {}", message.as_ref());
  }

  fn log_warn(message: impl AsRef<str>) {
    eprintln!("[ota-self-update][warn] {}", message.as_ref());
  }

  fn prerelease_for_channel(channel: &str) -> bool {
    channel == "beta"
  }

  fn semver_desc(left: &str, right: &str) -> std::cmp::Ordering {
    match (Version::parse(left), Version::parse(right)) {
      (Ok(l), Ok(r)) => r.cmp(&l),
      _ => right.cmp(left),
    }
  }

  fn channel(cfg: &Config) -> &str {
    cfg.channel.as_deref().unwrap_or("stable")
  }

  pub fn new(app: AppHandle<R>, config: Config) -> Self {
    Self {
      app,
      config: Arc::new(tauri::async_runtime::Mutex::new(config)),
      pending_update: Arc::new(tauri::async_runtime::Mutex::new(None)),
    }
  }

  fn cache_root(&self) -> Result<PathBuf> {
    let path = self.app.path().app_cache_dir()?;
    fs::create_dir_all(&path)?;
    Ok(path.join("ota-self-update"))
  }

  fn manifest_url(cfg: &Config) -> String {
    let base = cfg.base_url.trim_end_matches('/');
    let channel = Self::channel(cfg);
    format!("{base}/manifest/{channel}.json")
  }

  fn github_repo_from_base_url(base_url: &str) -> Option<(String, String)> {
    let url = Url::parse(base_url).ok()?;
    if !url.host_str().is_some_and(|host| host.eq_ignore_ascii_case("github.com")) {
      return None;
    }
    let mut parts = url
      .path_segments()
      .map(|segments| segments.filter(|s| !s.is_empty()))
      .into_iter()
      .flatten();
    let owner = parts.next()?.to_string();
    let repo = parts.next()?.trim_end_matches(".git").to_string();
    if owner.is_empty() || repo.is_empty() {
      return None;
    }
    Some((owner, repo))
  }

  fn bitbucket_repo_from_base_url(base_url: &str) -> Option<(String, String)> {
    let url = Url::parse(base_url).ok()?;
    if !url.host_str().is_some_and(|host| host.eq_ignore_ascii_case("bitbucket.org")) {
      return None;
    }
    let mut parts = url
      .path_segments()
      .map(|segments| segments.filter(|s| !s.is_empty()))
      .into_iter()
      .flatten();
    let workspace = parts.next()?.to_string();
    let repo = parts.next()?.trim_end_matches(".git").to_string();
    if workspace.is_empty() || repo.is_empty() {
      return None;
    }
    Some((workspace, repo))
  }

  async fn fetch_manifest_from_github(
    client: &reqwest::Client,
    owner: &str,
    repo: &str,
    channel: &str,
  ) -> Result<Vec<u8>> {
    #[derive(serde::Deserialize)]
    struct GitHubAsset {
      name: String,
      browser_download_url: String,
    }

    #[derive(serde::Deserialize)]
    struct GitHubRelease {
      draft: bool,
      prerelease: bool,
      assets: Vec<GitHubAsset>,
    }

    let releases_url = format!("https://api.github.com/repos/{owner}/{repo}/releases?per_page=100");
    let releases: Vec<GitHubRelease> = client
      .get(releases_url)
      .header("Accept", "application/vnd.github+json")
      .header("User-Agent", "tauri-plugin-ota-self-update")
      .send()
      .await?
      .error_for_status()?
      .json()
      .await?;

    let want_prerelease = channel == "beta";
    let manifest_name = format!("{channel}.json");
    let selected_with_manifest = releases
      .iter()
      .filter(|release| !release.draft && release.prerelease == want_prerelease)
      .find_map(|release| {
        release
          .assets
          .iter()
          .find(|asset| asset.name == manifest_name)
          .map(|asset| (release, asset))
      })
      .ok_or_else(|| {
        Error::Message(format!(
          "no suitable GitHub release with '{manifest_name}' asset found for channel '{channel}' (repo: {owner}/{repo})"
        ))
      })?;
    let (_selected_release, manifest_asset) = selected_with_manifest;

    let bytes = client
      .get(&manifest_asset.browser_download_url)
      .send()
      .await?
      .error_for_status()?
      .bytes()
      .await?
      .to_vec();
    Ok(bytes)
  }

  async fn fetch_manifest_from_release_index(
    client: &reqwest::Client,
    cfg: &Config,
    channel: &str,
  ) -> Result<Option<Vec<u8>>> {
    #[derive(serde::Deserialize)]
    #[serde(rename_all = "camelCase")]
    struct ReleaseIndexEntry {
      version: String,
      manifest_url: String,
      #[serde(default)]
      prerelease: bool,
      #[serde(default)]
      status: Option<String>,
      #[serde(default)]
      channel: Option<String>,
    }

    let index_url = format!("{}/releases.json", cfg.base_url.trim_end_matches('/'));
    let response = client.get(index_url).send().await?;
    if response.status() == reqwest::StatusCode::NOT_FOUND {
      return Ok(None);
    }
    let entries: Vec<ReleaseIndexEntry> = response.error_for_status()?.json().await?;
    let wanted_prerelease = Self::prerelease_for_channel(channel);
    let mut candidates: Vec<_> = entries
      .into_iter()
      .filter(|entry| {
        let channel_ok = entry.channel.as_deref().is_none_or(|value| value == channel);
        let status_ok = entry
          .status
          .as_deref()
          .is_none_or(|value| value.eq_ignore_ascii_case("released"));
        channel_ok && status_ok && entry.prerelease == wanted_prerelease
      })
      .collect();

    if candidates.is_empty() {
      return Ok(None);
    }
    candidates.sort_by(|a, b| Self::semver_desc(&a.version, &b.version));
    let latest = &candidates[0];
    let bytes = client
      .get(&latest.manifest_url)
      .send()
      .await?
      .error_for_status()?
      .bytes()
      .await?
      .to_vec();
    Ok(Some(bytes))
  }

  async fn fetch_manifest_from_bitbucket(
    client: &reqwest::Client,
    workspace: &str,
    repo: &str,
    channel: &str,
  ) -> Result<Vec<u8>> {
    let manifest_name = format!("{channel}.json");
    let url = format!("https://bitbucket.org/{workspace}/{repo}/downloads/{manifest_name}");
    let bytes = client
      .get(url)
      .send()
      .await?
      .error_for_status()?
      .bytes()
      .await?
      .to_vec();
    Ok(bytes)
  }

  async fn http_client(cfg: &Config) -> Result<reqwest::Client> {
    let mut headers = HeaderMap::new();
    for (k, v) in &cfg.request_headers {
      let name = HeaderName::from_bytes(k.as_bytes()).map_err(|_| Error::InvalidHeaderName)?;
      let value = HeaderValue::from_str(v).map_err(|_| Error::InvalidHeaderValue)?;
      headers.insert(name, value);
    }
    let mut builder = reqwest::Client::builder().default_headers(headers);
    if let Some(timeout) = cfg.timeout_secs {
      builder = builder.timeout(std::time::Duration::from_secs(timeout));
    }
    Ok(builder.build()?)
  }

  fn verify_signature(pubkey_base64: &str, payload: &[u8], signature_base64: &str) -> Result<()> {
    if pubkey_base64.trim().is_empty() || signature_base64.trim().is_empty() {
      return Ok(());
    }
    let pubkey_decoded = base64::engine::general_purpose::STANDARD.decode(pubkey_base64)?;
    let pubkey_decoded = std::str::from_utf8(&pubkey_decoded)?;
    let public_key =
      minisign_verify::PublicKey::decode(pubkey_decoded).map_err(Error::InvalidPublicKey)?;

    let sig_decoded = base64::engine::general_purpose::STANDARD.decode(signature_base64)?;
    let sig_decoded = std::str::from_utf8(&sig_decoded)?;
    let signature =
      minisign_verify::Signature::decode(sig_decoded).map_err(Error::InvalidSignature)?;
    public_key
      .verify(payload, &signature, false)
      .map_err(Error::InvalidSignature)?;
    Ok(())
  }

  fn download_path(cache_root: &Path, version: &str) -> PathBuf {
    cache_root.join(format!("update-{version}.tar.gz"))
  }

  fn is_newer_version(current: &str, incoming: &str) -> bool {
    let cv = Version::parse(current);
    let iv = Version::parse(incoming);
    match (cv, iv) {
      (Ok(current), Ok(incoming)) => {
        // Keep update tracks isolated:
        // - release can update only to release
        // - pre-release can update only to pre-release
        let current_is_prerelease = !current.pre.is_empty();
        let incoming_is_prerelease = !incoming.pre.is_empty();
        if current_is_prerelease != incoming_is_prerelease {
          return false;
        }
        incoming > current
      }
      // If versions are not valid semver, reject update to avoid cross-track surprises.
      _ => false,
    }
  }

  pub async fn set_channel(&self, channel: Option<String>) -> Result<()> {
    self.config.lock().await.channel = channel.filter(|c| !c.trim().is_empty());
    Ok(())
  }

  pub async fn check_for_updates(&self) -> Result<CheckResult> {
    let cfg = self.config.lock().await.clone();
    let client = Self::http_client(&cfg).await?;
    let channel = Self::channel(&cfg);
    let current_version = self.app.package_info().version.to_string();
    Self::log_info(format!(
      "check_for_updates start: base_url='{}', channel='{}', current_version='{}'",
      cfg.base_url, channel, current_version
    ));

    let manifest_bytes = if let Some((owner, repo)) = Self::github_repo_from_base_url(&cfg.base_url) {
      Self::log_info(format!("manifest source: github repo={owner}/{repo}"));
      Self::fetch_manifest_from_github(&client, &owner, &repo, channel).await?
    } else if let Some((workspace, repo)) = Self::bitbucket_repo_from_base_url(&cfg.base_url) {
      Self::log_info(format!("manifest source: bitbucket repo={workspace}/{repo}"));
      Self::fetch_manifest_from_bitbucket(&client, &workspace, &repo, channel).await?
    } else if let Some(index_manifest) = Self::fetch_manifest_from_release_index(&client, &cfg, channel).await? {
      Self::log_info("manifest source: releases.json index");
      index_manifest
    } else {
      let manifest_url = Self::manifest_url(&cfg);
      Self::log_info(format!("manifest source: direct fallback url={manifest_url}"));
      client
        .get(manifest_url)
        .send()
        .await?
        .error_for_status()?
        .bytes()
        .await?
        .to_vec()
    };
    let manifest: UpdateManifest = serde_json::from_slice(&manifest_bytes)?;
    Self::log_info(format!(
      "manifest loaded: version='{}', archive_url='{}'",
      manifest.version, manifest.archive_url
    ));
    Self::verify_signature(&cfg.pubkey, &manifest_bytes, &manifest.signature)?;

    if !Self::is_newer_version(&current_version, &manifest.version) {
      match (Version::parse(&current_version), Version::parse(&manifest.version)) {
        (Ok(current), Ok(incoming)) => {
          let current_is_prerelease = !current.pre.is_empty();
          let incoming_is_prerelease = !incoming.pre.is_empty();
          if current_is_prerelease != incoming_is_prerelease {
            Self::log_warn(format!(
              "update not available: track mismatch (current='{}', incoming='{}')",
              current_version, manifest.version
            ));
          } else {
            Self::log_info(format!(
              "update not available: incoming version is not newer (current='{}', incoming='{}')",
              current_version, manifest.version
            ));
          }
        }
        _ => {
          Self::log_warn(format!(
            "update not available: semver parse failed (current='{}', incoming='{}')",
            current_version, manifest.version
          ));
        }
      }
      return Ok(CheckResult {
        available: false,
        update: None,
      });
    }

    let archive_bytes = client
      .get(&manifest.archive_url)
      .send()
      .await?
      .error_for_status()?
      .bytes()
      .await?
      .to_vec();
    Self::verify_signature(&cfg.pubkey, &archive_bytes, &manifest.archive_signature)?;

    let cache_root = self.cache_root()?;
    fs::create_dir_all(&cache_root)?;
    let archive_path = Self::download_path(&cache_root, &manifest.version);
    fs::write(&archive_path, archive_bytes)?;
    Self::log_info(format!(
      "update available: version='{}', archive cached at '{}'",
      manifest.version,
      archive_path.display()
    ));

    let info = UpdateInfo {
      version: manifest.version.clone(),
      notes: manifest.notes,
      pub_date: manifest.pub_date,
    };
    self.pending_update.lock().await.replace(PendingUpdate {
      version: manifest.version,
      archive_path,
    });

    Ok(CheckResult {
      available: true,
      update: Some(info),
    })
  }

  pub async fn apply_update(&self) -> Result<ApplyResult> {
    let cfg = self.config.lock().await.clone();
    let pending = self.pending_update.lock().await.clone().ok_or(Error::NoPendingUpdate)?;
    Self::log_info(format!(
      "apply_update start: version='{}', activation_policy='{:?}'",
      pending.version, cfg.activation_policy
    ));

    let target_dir = self.cache_root()?.join("latest-dist");
    if target_dir.exists() {
      fs::remove_dir_all(&target_dir)?;
    }
    fs::create_dir_all(&target_dir)?;

    let archive_file = fs::File::open(&pending.archive_path)?;
    let decoder = flate2::read::GzDecoder::new(archive_file);
    let mut archive = tar::Archive::new(decoder);
    archive.unpack(&target_dir)?;

    let status = match cfg.activation_policy {
      ActivationPolicy::NextLaunch => ActivationStatus::PendingRestart,
      ActivationPolicy::SoftReload => ActivationStatus::AppliedNow,
    };

    Ok(ApplyResult {
      status,
      version: pending.version,
      activation_policy: cfg.activation_policy,
    })
  }
}