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 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
// SPDX-License-Identifier: Apache-2.0
// SPDX-License-Identifier: MIT
//! The Tauri updater.
//!
//! The updater is focused on making Tauri's application updates **as safe and transparent as updates to a website**.
//!
//! For a full guide on setting up the updater, see <https://tauri.app/v1/guides/distribution/updater>.
//!
//! Check [`UpdateBuilder`] to see how to manually trigger and customize the updater at runtime.
//!
//! ## Events
//!
//! To listen to the updater events, for example to check for error messages, you need to use [`RunEvent::Updater`](crate::RunEvent) in [`App::run`](crate::App#method.run).
//!
//! ```no_run
//! let app = tauri::Builder::default()
//! // on an actual app, remove the string argument
//! .build(tauri::generate_context!("test/fixture/src-tauri/tauri.conf.json"))
//! .expect("error while building tauri application");
//! app.run(|_app_handle, event| match event {
//! tauri::RunEvent::Updater(updater_event) => {
//! match updater_event {
//! tauri::UpdaterEvent::UpdateAvailable { body, date, version } => {
//! println!("update available {} {:?} {}", body, date, version);
//! }
//! // Emitted when the download is about to be started.
//! tauri::UpdaterEvent::Pending => {
//! println!("update is pending!");
//! }
//! tauri::UpdaterEvent::DownloadProgress { chunk_length, content_length } => {
//! println!("downloaded {} of {:?}", chunk_length, content_length);
//! }
//! // Emitted when the download has finished and the update is about to be installed.
//! tauri::UpdaterEvent::Downloaded => {
//! println!("update has been downloaded!");
//! }
//! // Emitted when the update was installed. You can then ask to restart the app.
//! tauri::UpdaterEvent::Updated => {
//! println!("app has been updated");
//! }
//! // Emitted when the app already has the latest version installed and an update is not needed.
//! tauri::UpdaterEvent::AlreadyUpToDate => {
//! println!("app is already up to date");
//! }
//! // Emitted when there is an error with the updater. We suggest to listen to this event even if the default dialog is enabled.
//! tauri::UpdaterEvent::Error(error) => {
//! println!("failed to update: {}", error);
//! }
//! _ => (),
//! }
//! }
//! _ => {}
//! });
//! ```
mod core;
mod error;
use std::time::Duration;
use http::header::{HeaderName, HeaderValue};
use semver::Version;
use time::OffsetDateTime;
pub use self::{core::RemoteRelease, error::Error};
/// Alias for [`std::result::Result`] using our own [`Error`].
pub type Result<T> = std::result::Result<T, Error>;
use crate::{runtime::EventLoopProxy, AppHandle, EventLoopMessage, Manager, Runtime, UpdaterEvent};
#[cfg(desktop)]
use crate::api::dialog::blocking::ask;
#[cfg(mobile)]
fn ask<R: Runtime>(
_parent_window: Option<&crate::Window<R>>,
_title: impl AsRef<str>,
_message: impl AsRef<str>,
) -> bool {
true
}
/// Check for new updates
pub const EVENT_CHECK_UPDATE: &str = "tauri://update";
/// New update available
pub const EVENT_UPDATE_AVAILABLE: &str = "tauri://update-available";
/// Used to initialize an update *should run check-update first (once you received the update available event)*
pub const EVENT_INSTALL_UPDATE: &str = "tauri://update-install";
/// Send updater status or error even if dialog is enabled, you should
/// always listen for this event. It'll send you the install progress
/// and any error triggered during update check and install
pub const EVENT_STATUS_UPDATE: &str = "tauri://update-status";
/// The name of the event that is emitted on download progress.
pub const EVENT_DOWNLOAD_PROGRESS: &str = "tauri://update-download-progress";
/// this is the status emitted when the download start
pub const EVENT_STATUS_PENDING: &str = "PENDING";
/// When you got this status, something went wrong
/// you can find the error message inside the `error` field.
pub const EVENT_STATUS_ERROR: &str = "ERROR";
/// The update has been downloaded.
pub const EVENT_STATUS_DOWNLOADED: &str = "DOWNLOADED";
/// When you receive this status, you should ask the user to restart
pub const EVENT_STATUS_SUCCESS: &str = "DONE";
/// When you receive this status, this is because the application is running last version
pub const EVENT_STATUS_UPTODATE: &str = "UPTODATE";
/// Gets the target string used on the updater.
pub fn target() -> Option<String> {
if let (Some(target), Some(arch)) = (core::get_updater_target(), core::get_updater_arch()) {
Some(format!("{target}-{arch}"))
} else {
None
}
}
#[derive(Clone, serde::Serialize)]
struct StatusEvent {
status: String,
error: Option<String>,
}
#[derive(Clone, serde::Serialize)]
#[serde(rename_all = "camelCase")]
struct DownloadProgressEvent {
chunk_length: usize,
content_length: Option<u64>,
}
#[derive(Clone, serde::Serialize)]
struct UpdateManifest {
version: String,
date: Option<String>,
body: String,
}
/// An update check builder.
#[derive(Debug)]
pub struct UpdateBuilder<R: Runtime> {
inner: core::UpdateBuilder<R>,
events: bool,
}
impl<R: Runtime> UpdateBuilder<R> {
/// Do not use the event system to emit information or listen to install the update.
pub fn skip_events(mut self) -> Self {
self.events = false;
self
}
/// Sets the current platform's target name for the updater.
///
/// The target is injected in the endpoint URL by replacing `{{target}}`.
/// Note that this does not affect the `{{arch}}` variable.
///
/// If the updater response JSON includes the `platforms` field,
/// that object must contain a value for the target key.
///
/// By default Tauri uses `$OS_NAME` as the replacement for `{{target}}`
/// and `$OS_NAME-$ARCH` as the key in the `platforms` object,
/// where `$OS_NAME` is the current operating system name "linux", "windows" or "darwin")
/// and `$ARCH` is one of the supported architectures ("i686", "x86_64", "armv7" or "aarch64").
///
/// See [`Builder::updater_target`](crate::Builder#method.updater_target) for a way to set the target globally.
///
/// # Examples
///
/// ## Use a macOS Universal binary target name
///
/// In this example, we set the updater target only on macOS.
/// On other platforms, we set the default target.
/// Note that `{{target}}` will be replaced with `darwin-universal`,
/// but `{{arch}}` is still the running platform's architecture.
///
/// ```no_run
/// tauri::Builder::default()
/// .setup(|app| {
/// let handle = app.handle();
/// tauri::async_runtime::spawn(async move {
/// let builder = tauri::updater::builder(handle).target(if cfg!(target_os = "macos") {
/// "darwin-universal".to_string()
/// } else {
/// tauri::updater::target().unwrap()
/// });
/// match builder.check().await {
/// Ok(update) => {}
/// Err(error) => {}
/// }
/// });
/// Ok(())
/// });
/// ```
///
/// ## Append debug information to the target
///
/// This allows you to provide updates for both debug and release applications.
///
/// ```no_run
/// tauri::Builder::default()
/// .setup(|app| {
/// let handle = app.handle();
/// tauri::async_runtime::spawn(async move {
/// let kind = if cfg!(debug_assertions) { "debug" } else { "release" };
/// let builder = tauri::updater::builder(handle).target(format!("{}-{kind}", tauri::updater::target().unwrap()));
/// match builder.check().await {
/// Ok(update) => {}
/// Err(error) => {}
/// }
/// });
/// Ok(())
/// });
/// ```
///
/// ## Use the platform's target triple
///
/// ```no_run
/// tauri::Builder::default()
/// .setup(|app| {
/// let handle = app.handle();
/// tauri::async_runtime::spawn(async move {
/// let builder = tauri::updater::builder(handle).target(tauri::utils::platform::target_triple().unwrap());
/// match builder.check().await {
/// Ok(update) => {}
/// Err(error) => {}
/// }
/// });
/// Ok(())
/// });
/// ```
pub fn target(mut self, target: impl Into<String>) -> Self {
self.inner = self.inner.target(target);
self
}
/// Sets a closure that is invoked to compare the current version and the latest version returned by the updater server.
/// The first argument is the current version, and the second one is the latest version.
///
/// The closure must return `true` if the update should be installed.
///
/// # Examples
///
/// - Always install the version returned by the server:
///
/// ```no_run
/// tauri::Builder::default()
/// .setup(|app| {
/// tauri::updater::builder(app.handle()).should_install(|_current, _latest| true);
/// Ok(())
/// });
/// ```
pub fn should_install<F: FnOnce(&Version, &RemoteRelease) -> bool + Send + 'static>(
mut self,
f: F,
) -> Self {
self.inner = self.inner.should_install(f);
self
}
/// Sets the timeout for the requests to the updater endpoints.
pub fn timeout(mut self, timeout: Duration) -> Self {
self.inner = self.inner.timeout(timeout);
self
}
/// Adds a header for the requests to the updater endpoints.
pub fn header<K, V>(mut self, key: K, value: V) -> Result<Self>
where
HeaderName: TryFrom<K>,
<HeaderName as TryFrom<K>>::Error: Into<http::Error>,
HeaderValue: TryFrom<V>,
<HeaderValue as TryFrom<V>>::Error: Into<http::Error>,
{
self.inner = self.inner.header(key, value)?;
Ok(self)
}
/// Adds a list of endpoints to fetch the update.
pub fn endpoints(mut self, urls: &[String]) -> Self {
self.inner = self.inner.urls(urls);
self
}
/// Check if an update is available.
///
/// # Examples
///
/// ```no_run
/// tauri::Builder::default()
/// .setup(|app| {
/// let handle = app.handle();
/// tauri::async_runtime::spawn(async move {
/// match tauri::updater::builder(handle).check().await {
/// Ok(update) => {
/// if update.is_update_available() {
/// update.download_and_install().await.unwrap();
/// }
/// }
/// Err(e) => {
/// println!("failed to get update: {}", e);
/// }
/// }
/// });
/// Ok(())
/// });
/// ```
///
/// If ther server responds with status code `204`, this method will return [`Error::UpToDate`]
pub async fn check(self) -> Result<UpdateResponse<R>> {
let handle = self.inner.app.clone();
// check updates
match self.inner.build().await {
Ok(update) => {
if self.events {
// send notification if we need to update
if update.should_update {
let body = update.body.clone().unwrap_or_else(|| String::from(""));
// Emit `tauri://update-available`
let _ = handle.emit_all(
EVENT_UPDATE_AVAILABLE,
UpdateManifest {
body: body.clone(),
date: update.date.map(|d| d.to_string()),
version: update.version.clone(),
},
);
let _ = handle.create_proxy().send_event(EventLoopMessage::Updater(
UpdaterEvent::UpdateAvailable {
body,
date: update.date,
version: update.version.clone(),
},
));
// Listen for `tauri://update-install`
let update_ = update.clone();
handle.once_global(EVENT_INSTALL_UPDATE, move |_msg| {
crate::async_runtime::spawn(async move {
let _ = download_and_install(update_).await;
});
});
} else {
send_status_update(&handle, UpdaterEvent::AlreadyUpToDate);
}
}
Ok(UpdateResponse { update })
}
Err(e) => {
if self.events {
send_status_update(
&handle,
match e {
Error::UpToDate => UpdaterEvent::AlreadyUpToDate,
_ => UpdaterEvent::Error(e.to_string()),
},
);
}
Err(e)
}
}
}
}
/// The response of an updater check.
pub struct UpdateResponse<R: Runtime> {
update: core::Update<R>,
}
impl<R: Runtime> Clone for UpdateResponse<R> {
fn clone(&self) -> Self {
Self {
update: self.update.clone(),
}
}
}
impl<R: Runtime> UpdateResponse<R> {
/// Whether the updater found a newer release or not.
pub fn is_update_available(&self) -> bool {
self.update.should_update
}
/// The current version of the application as read by the updater.
pub fn current_version(&self) -> &Version {
&self.update.current_version
}
/// The latest version of the application found by the updater.
pub fn latest_version(&self) -> &str {
&self.update.version
}
/// The update date.
pub fn date(&self) -> Option<&OffsetDateTime> {
self.update.date.as_ref()
}
/// The update description.
pub fn body(&self) -> Option<&String> {
self.update.body.as_ref()
}
/// Add a header to the download request.
pub fn header<K, V>(mut self, key: K, value: V) -> Result<Self>
where
HeaderName: TryFrom<K>,
<HeaderName as TryFrom<K>>::Error: Into<http::Error>,
HeaderValue: TryFrom<V>,
<HeaderValue as TryFrom<V>>::Error: Into<http::Error>,
{
self.update = self.update.header(key, value)?;
Ok(self)
}
/// Removes a header from the download request.
pub fn remove_header<K>(mut self, key: K) -> Result<Self>
where
HeaderName: TryFrom<K>,
<HeaderName as TryFrom<K>>::Error: Into<http::Error>,
{
self.update = self.update.remove_header(key)?;
Ok(self)
}
/// Downloads and installs the update.
pub async fn download_and_install(self) -> Result<()> {
download_and_install(self.update).await
}
}
/// Check if there is any new update with builtin dialog.
pub(crate) async fn check_update_with_dialog<R: Runtime>(handle: AppHandle<R>) {
let updater_config = handle.config().tauri.updater.clone();
let package_info = handle.package_info().clone();
if let Some(endpoints) = &updater_config.endpoints {
let endpoints = endpoints
.iter()
.map(|e| e.to_string())
.collect::<Vec<String>>();
let mut builder = self::core::builder(handle.clone())
.urls(&endpoints[..])
.current_version(package_info.version);
if let Some(target) = &handle.updater_settings.target {
builder = builder.target(target);
}
// check updates
match builder.build().await {
Ok(updater) => {
let pubkey = updater_config.pubkey.clone();
if !updater.should_update {
send_status_update(&handle, UpdaterEvent::AlreadyUpToDate);
} else if updater_config.dialog {
// if dialog enabled only
let body = updater.body.clone().unwrap_or_else(|| String::from(""));
let dialog =
prompt_for_install(&updater.clone(), &package_info.name, &body.clone(), pubkey).await;
if let Err(e) = dialog {
send_status_update(&handle, UpdaterEvent::Error(e.to_string()));
}
}
}
Err(e) => {
send_status_update(
&handle,
match e {
Error::UpToDate => UpdaterEvent::AlreadyUpToDate,
_ => UpdaterEvent::Error(e.to_string()),
},
);
}
}
}
}
/// Updater listener
/// This function should be run on the main thread once.
pub(crate) fn listener<R: Runtime>(handle: AppHandle<R>) {
// Wait to receive the event `"tauri://update"`
let handle_ = handle.clone();
handle.listen_global(EVENT_CHECK_UPDATE, move |_msg| {
let handle_ = handle_.clone();
crate::async_runtime::spawn(async move {
let _ = builder(handle_.clone()).check().await;
});
});
}
pub(crate) async fn download_and_install<R: Runtime>(update: core::Update<R>) -> Result<()> {
// Start installation
// emit {"status": "PENDING"}
send_status_update(&update.app, UpdaterEvent::Pending);
let handle = update.app.clone();
let handle_ = handle.clone();
// Launch updater download process
// macOS we display the `Ready to restart dialog` asking to restart
// Windows is closing the current App and launch the downloaded MSI when ready (the process stop here)
// Linux we replace the AppImage by launching a new install, it start a new AppImage instance, so we're closing the previous. (the process stop here)
let update_result = update
.download_and_install(
update.app.config().tauri.updater.pubkey.clone(),
move |chunk_length, content_length| {
send_download_progress_event(&handle, chunk_length, content_length);
},
move || {
send_status_update(&handle_, UpdaterEvent::Downloaded);
},
)
.await;
if let Err(err) = &update_result {
// emit {"status": "ERROR", "error": "The error message"}
send_status_update(&update.app, UpdaterEvent::Error(err.to_string()));
} else {
// emit {"status": "DONE"}
send_status_update(&update.app, UpdaterEvent::Updated);
}
update_result
}
/// Initializes the [`UpdateBuilder`] using the app configuration.
pub fn builder<R: Runtime>(handle: AppHandle<R>) -> UpdateBuilder<R> {
let updater_config = &handle.config().tauri.updater;
let package_info = handle.package_info().clone();
// prepare our endpoints
let endpoints: Vec<String> = updater_config
.endpoints
.as_ref()
.map(|endpoints| endpoints.iter().map(|e| e.to_string()).collect())
.unwrap_or_default();
let mut builder = self::core::builder(handle.clone())
.urls(&endpoints[..])
.current_version(package_info.version);
if let Some(target) = &handle.updater_settings.target {
builder = builder.target(target);
}
UpdateBuilder {
inner: builder,
events: true,
}
}
// Send a status update via `tauri://update-download-progress` event.
fn send_download_progress_event<R: Runtime>(
handle: &AppHandle<R>,
chunk_length: usize,
content_length: Option<u64>,
) {
let _ = handle.emit_all(
EVENT_DOWNLOAD_PROGRESS,
DownloadProgressEvent {
chunk_length,
content_length,
},
);
let _ =
handle
.create_proxy()
.send_event(EventLoopMessage::Updater(UpdaterEvent::DownloadProgress {
chunk_length,
content_length,
}));
}
// Send a status update via `tauri://update-status` event.
fn send_status_update<R: Runtime>(handle: &AppHandle<R>, message: UpdaterEvent) {
let _ = handle.emit_all(
EVENT_STATUS_UPDATE,
if let UpdaterEvent::Error(error) = &message {
StatusEvent {
error: Some(error.clone()),
status: message.clone().status_message().into(),
}
} else {
StatusEvent {
error: None,
status: message.clone().status_message().into(),
}
},
);
let _ = handle
.create_proxy()
.send_event(EventLoopMessage::Updater(message));
}
// Prompt a dialog asking if the user want to install the new version
// Maybe we should add an option to customize it in future versions.
async fn prompt_for_install<R: Runtime>(
update: &self::core::Update<R>,
app_name: &str,
body: &str,
pubkey: String,
) -> Result<()> {
let windows = update.app.windows();
let parent_window = windows.values().next();
// todo(lemarier): We should review this and make sure we have
// something more conventional.
let should_install = ask(
parent_window,
format!(r#"A new version of {app_name} is available! "#),
format!(
r#"{app_name} {} is now available -- you have {}.
Would you like to install it now?
Release Notes:
{body}"#,
update.version, update.current_version
),
);
if should_install {
let handle = update.app.clone();
let handle_ = handle.clone();
// Launch updater download process
// macOS we display the `Ready to restart dialog` asking to restart
// Windows is closing the current App and launch the downloaded MSI when ready (the process stop here)
// Linux we replace the AppImage by launching a new install, it start a new AppImage instance, so we're closing the previous. (the process stop here)
update
.download_and_install(
pubkey.clone(),
move |chunk_length, content_length| {
send_download_progress_event(&handle, chunk_length, content_length);
},
move || {
send_status_update(&handle_, UpdaterEvent::Downloaded);
},
)
.await?;
// emit {"status": "DONE"}
send_status_update(&update.app, UpdaterEvent::Updated);
// Ask user if we need to restart the application
let should_exit = ask(
parent_window,
"Ready to Restart",
"The installation was successful, do you want to restart the application now?",
);
if should_exit {
update.app.restart();
}
}
Ok(())
}