tauri-plugin-hotswap 0.0.3

Open-source OTA plugin for Tauri v2 — push frontend updates to users without rebuilding the binary. Self-hosted, signed bundles, auto-rollback.
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
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
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
//! Tauri command handlers for the hotswap plugin.

use std::collections::HashMap;

use crate::error::{Error, Result};
use crate::manifest::{HotswapCheckResult, HotswapVersionInfo};
use crate::resolver::CheckContext;
use crate::updater;
use crate::HotswapState;
use tauri::{command, AppHandle, Manager, Runtime};

fn build_check_context(state: &HotswapState) -> Result<CheckContext> {
    let current_sequence = {
        let guard = state
            .current_sequence
            .lock()
            .map_err(|_| Error::LockPoisoned)?;
        *guard
    };
    let channel = {
        let guard = state.channel.lock().map_err(|_| Error::LockPoisoned)?;
        guard.clone()
    };
    let headers = state
        .custom_headers
        .lock()
        .map_err(|_| Error::LockPoisoned)?
        .clone();
    let endpoint_override = state
        .endpoint_override
        .lock()
        .map_err(|_| Error::LockPoisoned)?
        .clone();

    Ok(CheckContext {
        current_sequence,
        binary_version: state.binary_version.clone(),
        platform: current_platform(),
        arch: current_arch(),
        channel,
        headers,
        endpoint_override,
    })
}

fn current_platform() -> &'static str {
    #[cfg(target_os = "macos")]
    {
        "macos"
    }
    #[cfg(target_os = "windows")]
    {
        "windows"
    }
    #[cfg(target_os = "linux")]
    {
        "linux"
    }
    #[cfg(target_os = "android")]
    {
        "android"
    }
    #[cfg(target_os = "ios")]
    {
        "ios"
    }
    #[cfg(not(any(
        target_os = "macos",
        target_os = "windows",
        target_os = "linux",
        target_os = "android",
        target_os = "ios"
    )))]
    {
        "unknown"
    }
}

fn current_arch() -> &'static str {
    #[cfg(target_arch = "x86_64")]
    {
        "x86_64"
    }
    #[cfg(target_arch = "aarch64")]
    {
        "aarch64"
    }
    #[cfg(target_arch = "x86")]
    {
        "x86"
    }
    #[cfg(target_arch = "arm")]
    {
        "arm"
    }
    #[cfg(not(any(
        target_arch = "x86_64",
        target_arch = "aarch64",
        target_arch = "x86",
        target_arch = "arm"
    )))]
    {
        "unknown"
    }
}

/// Check for an available update.
#[command]
pub async fn hotswap_check<R: Runtime>(app: AppHandle<R>) -> Result<HotswapCheckResult> {
    let state = app.state::<HotswapState>();
    let ctx = build_check_context(&state)?;

    let manifest = updater::check_update(state.resolver.as_ref(), &ctx, Some(&app)).await?;

    {
        let mut pending = state
            .pending_manifest
            .lock()
            .map_err(|_| Error::LockPoisoned)?;
        *pending = manifest.clone();
    }

    Ok(HotswapCheckResult {
        available: manifest.is_some(),
        version: manifest.as_ref().map(|m| m.version.clone()),
        sequence: manifest.as_ref().map(|m| m.sequence),
        notes: manifest.as_ref().and_then(|m| m.notes.clone()),
        mandatory: manifest.as_ref().and_then(|m| m.mandatory),
        bundle_size: manifest.as_ref().and_then(|m| m.bundle_size),
    })
}

/// Download, verify, extract, and activate the pending update in one step.
/// This is a convenience command — for more control, use `hotswap_download`
/// followed by `hotswap_activate`.
#[command]
pub async fn hotswap_apply<R: Runtime>(app: AppHandle<R>) -> Result<String> {
    let state = app.state::<HotswapState>();

    let manifest = {
        let pending = state
            .pending_manifest
            .lock()
            .map_err(|_| Error::LockPoisoned)?;
        pending.clone().ok_or(Error::NoPending)?
    };

    let headers = state
        .custom_headers
        .lock()
        .map_err(|_| Error::LockPoisoned)?
        .clone();
    let opts = updater::DownloadOptions {
        pubkey: &state.pubkey,
        base_dir: &state.base_dir,
        max_bundle_size: state.max_bundle_size,
        require_https: state.require_https,
        max_retries: state.max_retries,
        client: &state.http_client,
        headers: &headers,
    };
    let version_dir = updater::download_and_extract(&manifest, &opts, Some(&app)).await?;

    updater::activate_version(&state.base_dir, &version_dir)?;
    updater::cleanup_old_versions(
        &state.base_dir,
        &*state.retention_policy,
        &*state.rollback_policy,
    );

    update_state_after_apply(&state, &manifest)?;

    updater::emit_lifecycle(
        Some(&app),
        "apply",
        Some(&manifest.version),
        Some(manifest.sequence),
        None,
    );

    Ok(manifest.version)
}

/// Download, verify, and extract the pending update WITHOUT activating it.
/// The update will be served on next launch after calling `hotswap_activate`,
/// or automatically if `hotswap_activate` is never called (the version dir
/// will be picked up by `check_compatibility` on next startup — but only if
/// `activate_version` is called to set the pointer).
///
/// Use this for "download now, apply later" workflows.
#[command]
pub async fn hotswap_download<R: Runtime>(app: AppHandle<R>) -> Result<String> {
    let state = app.state::<HotswapState>();

    let manifest = {
        let pending = state
            .pending_manifest
            .lock()
            .map_err(|_| Error::LockPoisoned)?;
        pending.clone().ok_or(Error::NoPending)?
    };

    let headers = state
        .custom_headers
        .lock()
        .map_err(|_| Error::LockPoisoned)?
        .clone();
    let opts = updater::DownloadOptions {
        pubkey: &state.pubkey,
        base_dir: &state.base_dir,
        max_bundle_size: state.max_bundle_size,
        require_https: state.require_https,
        max_retries: state.max_retries,
        client: &state.http_client,
        headers: &headers,
    };
    updater::download_and_extract(&manifest, &opts, Some(&app)).await?;

    Ok(manifest.version)
}

/// Activate a previously downloaded update.
/// After activation, the new assets will be served on the next app launch
/// (or after `window.location.reload()`).
#[command]
pub async fn hotswap_activate<R: Runtime>(app: AppHandle<R>) -> Result<String> {
    let state = app.state::<HotswapState>();

    let manifest = {
        let pending = state
            .pending_manifest
            .lock()
            .map_err(|_| Error::LockPoisoned)?;
        pending.clone().ok_or(Error::NoPending)?
    };

    let version_dir = state.base_dir.join(format!("seq-{}", manifest.sequence));
    if !version_dir.is_dir() {
        return Err(Error::Config(
            "update not downloaded yet — call download first".into(),
        ));
    }

    updater::activate_version(&state.base_dir, &version_dir)?;
    updater::cleanup_old_versions(
        &state.base_dir,
        &*state.retention_policy,
        &*state.rollback_policy,
    );

    update_state_after_apply(&state, &manifest)?;

    updater::emit_lifecycle(
        Some(&app),
        "apply",
        Some(&manifest.version),
        Some(manifest.sequence),
        None,
    );

    Ok(manifest.version)
}

fn update_state_after_apply(
    state: &HotswapState,
    manifest: &crate::manifest::HotswapManifest,
) -> Result<()> {
    let version_dir = state.base_dir.join(format!("seq-{}", manifest.sequence));

    {
        let mut seq = state
            .current_sequence
            .lock()
            .map_err(|_| Error::LockPoisoned)?;
        *seq = manifest.sequence;
    }
    {
        let mut ver = state
            .current_version
            .lock()
            .map_err(|_| Error::LockPoisoned)?;
        *ver = Some(manifest.version.clone());
    }
    {
        let mut pending = state
            .pending_manifest
            .lock()
            .map_err(|_| Error::LockPoisoned)?;
        *pending = None;
    }

    // Swap the live asset directory so window.location.reload()
    // immediately serves the new assets without an app restart.
    if let Ok(mut dir) = state.live_asset_dir.write() {
        *dir = Some(version_dir);
        log::info!(
            "[hotswap] Live asset directory swapped to seq-{}.",
            manifest.sequence
        );
    }

    log::info!(
        "[hotswap] Applied v{} (seq {}). Reload to serve new assets.",
        manifest.version,
        manifest.sequence
    );

    Ok(())
}

/// Roll back to the previous version or embedded assets.
#[command]
pub async fn hotswap_rollback<R: Runtime>(app: AppHandle<R>) -> Result<HotswapVersionInfo> {
    let state = app.state::<HotswapState>();

    let rolled_back_to = updater::rollback(&state.base_dir, &*state.rollback_policy);
    let new_dir = updater::resolve_current_dir(&state.base_dir);
    let new_meta = new_dir.as_ref().and_then(|d| updater::read_meta(d));

    {
        let mut seq = state
            .current_sequence
            .lock()
            .map_err(|_| Error::LockPoisoned)?;
        *seq = new_meta.as_ref().map(|m| m.sequence).unwrap_or(0);
    }
    {
        let mut ver = state
            .current_version
            .lock()
            .map_err(|_| Error::LockPoisoned)?;
        *ver = rolled_back_to.clone();
    }

    // Swap the live asset directory so reload serves the rolled-back version
    // (or embedded assets if new_dir is None).
    if let Ok(mut dir) = state.live_asset_dir.write() {
        *dir = new_dir;
    }

    updater::emit_lifecycle(
        Some(&app),
        "rollback",
        rolled_back_to.as_deref(),
        new_meta.as_ref().map(|m| m.sequence),
        None,
    );

    Ok(HotswapVersionInfo {
        active: rolled_back_to.is_some(),
        version: rolled_back_to,
        sequence: new_meta.as_ref().map(|m| m.sequence).unwrap_or(0),
        binary_version: state.binary_version.clone(),
    })
}

/// Get information about the currently active version.
#[command]
pub async fn hotswap_current_version<R: Runtime>(app: AppHandle<R>) -> Result<HotswapVersionInfo> {
    let state = app.state::<HotswapState>();

    let version = {
        let guard = state
            .current_version
            .lock()
            .map_err(|_| Error::LockPoisoned)?;
        guard.clone()
    };
    let sequence = {
        let guard = state
            .current_sequence
            .lock()
            .map_err(|_| Error::LockPoisoned)?;
        *guard
    };

    Ok(HotswapVersionInfo {
        active: version.is_some(),
        version,
        sequence,
        binary_version: state.binary_version.clone(),
    })
}

/// Confirm the current version is healthy. Call on every startup.
#[command]
pub async fn hotswap_notify_ready<R: Runtime>(app: AppHandle<R>) -> Result<()> {
    let state = app.state::<HotswapState>();
    let current_sequence = {
        let guard = state
            .current_sequence
            .lock()
            .map_err(|_| Error::LockPoisoned)?;
        *guard
    };

    if current_sequence > 0 {
        let version_dir = state.base_dir.join(format!("seq-{}", current_sequence));

        if let Some(mut meta) = updater::read_meta(&version_dir) {
            meta.confirmed = true;
            meta.unconfirmed_launch_count = 0;
            let json = serde_json::to_string_pretty(&meta)
                .map_err(|e| Error::Serialization(e.to_string()))?;
            std::fs::write(version_dir.join("hotswap-meta.json"), json)?;
            log::info!("[hotswap] Sequence {} confirmed as ready", current_sequence);

            updater::emit_lifecycle(
                Some(&app),
                "ready-confirmed",
                Some(&meta.version),
                Some(current_sequence),
                None,
            );
        }
    }

    Ok(())
}

/// Runtime configuration update. All fields are optional — only provided
/// fields are applied. Pass `null` to reset a field to init-time defaults.
///
/// `headers` is merged: keys with `null` values are removed, others are
/// set/overwritten. Existing headers not mentioned are kept.
#[command]
pub async fn hotswap_configure<R: Runtime>(
    app: AppHandle<R>,
    channel: Option<Option<String>>,
    endpoint: Option<Option<String>>,
    headers: Option<HashMap<String, Option<String>>>,
) -> Result<()> {
    let state = app.state::<HotswapState>();

    if let Some(ch) = channel {
        let mut guard = state.channel.lock().map_err(|_| Error::LockPoisoned)?;
        *guard = ch;
    }

    if let Some(ep) = endpoint {
        if state.require_https {
            if let Some(ref url) = ep {
                if !url.starts_with("https://") {
                    return Err(Error::InsecureUrl(url.clone()));
                }
            }
        }
        let mut guard = state
            .endpoint_override
            .lock()
            .map_err(|_| Error::LockPoisoned)?;
        *guard = ep;
    }

    if let Some(hdrs) = headers {
        let mut guard = state
            .custom_headers
            .lock()
            .map_err(|_| Error::LockPoisoned)?;
        for (key, value) in hdrs {
            match value {
                Some(v) => {
                    guard.insert(key, v);
                }
                None => {
                    guard.remove(&key);
                }
            }
        }
    }

    Ok(())
}

/// Get the current runtime configuration.
#[command]
pub async fn hotswap_get_config<R: Runtime>(app: AppHandle<R>) -> Result<RuntimeConfig> {
    let state = app.state::<HotswapState>();
    let channel = state
        .channel
        .lock()
        .map_err(|_| Error::LockPoisoned)?
        .clone();
    let endpoint = state
        .endpoint_override
        .lock()
        .map_err(|_| Error::LockPoisoned)?
        .clone();
    let headers = state
        .custom_headers
        .lock()
        .map_err(|_| Error::LockPoisoned)?
        .clone();
    Ok(RuntimeConfig {
        channel,
        endpoint,
        headers,
    })
}

/// Runtime configuration snapshot returned by `hotswap_get_config`.
#[derive(Debug, Clone, serde::Serialize)]
pub struct RuntimeConfig {
    /// The active update channel (e.g. `"stable"`, `"beta"`).
    pub channel: Option<String>,
    /// Optional endpoint URL override for the update resolver.
    pub endpoint: Option<String>,
    /// Custom HTTP headers sent with every update request.
    pub headers: HashMap<String, String>,
}