mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-04-05 07:06:08 +00:00
78ebad13ab
Logging these as structured values gives us a better stacktrace in Sentry (assuming the errors themselves make proper use of defining an error-chain).
75 lines
3.6 KiB
Rust
75 lines
3.6 KiB
Rust
use crate::{self as common, deep_link};
|
|
use anyhow::Result;
|
|
use firezone_headless_client::{ipc, IpcServiceError, FIREZONE_GROUP};
|
|
|
|
// TODO: Replace with `anyhow` gradually per <https://github.com/firezone/firezone/pull/3546#discussion_r1477114789>
|
|
#[derive(Debug, thiserror::Error)]
|
|
pub enum Error {
|
|
#[error("Failed to connect to Firezone for non-Portal-related reason")]
|
|
ConnectToFirezoneFailed(IpcServiceError),
|
|
#[error("Deep-link module error: {0}")]
|
|
DeepLink(#[from] deep_link::Error),
|
|
#[error("Logging module error: {0}")]
|
|
Logging(#[from] common::logging::Error),
|
|
|
|
// `client.rs` provides a more user-friendly message when showing the error dialog box for certain variants
|
|
#[error("IPC")]
|
|
Ipc(#[from] ipc::Error),
|
|
#[error("IPC closed")]
|
|
IpcClosed,
|
|
#[error("IPC read failed")]
|
|
IpcRead,
|
|
#[error("IPC service terminating")]
|
|
IpcServiceTerminating,
|
|
#[error("Failed to connect to portal")]
|
|
PortalConnection(String),
|
|
#[error("UserNotInFirezoneGroup")]
|
|
UserNotInFirezoneGroup,
|
|
#[error("WebViewNotInstalled")]
|
|
WebViewNotInstalled,
|
|
#[error(transparent)]
|
|
Other(#[from] anyhow::Error),
|
|
}
|
|
|
|
/// Blocks the thread and shows an error dialog
|
|
///
|
|
/// Doesn't play well with async, only use this if we're bailing out of the
|
|
/// entire process.
|
|
pub fn show_error_dialog(error: &Error) -> Result<()> {
|
|
// Decision to put the error strings here: <https://github.com/firezone/firezone/pull/3464#discussion_r1473608415>
|
|
// This message gets shown to users in the GUI and could be localized, unlike
|
|
// messages in the log which only need to be used for `git grep`.
|
|
let user_friendly_error_msg = match error {
|
|
Error::ConnectToFirezoneFailed(_) => error.to_string(),
|
|
Error::WebViewNotInstalled => "Firezone cannot start because WebView2 is not installed. Follow the instructions at <https://www.firezone.dev/kb/client-apps/windows-client>.".to_string(),
|
|
Error::DeepLink(deep_link::Error::CantListen) => "Firezone is already running. If it's not responding, force-stop it.".to_string(),
|
|
Error::DeepLink(deep_link::Error::Other(error)) => error.to_string(),
|
|
Error::Ipc(ipc::Error::NotFound(path)) => {
|
|
tracing::error!(?path, "Couldn't find Firezone IPC service");
|
|
"Couldn't find Firezone IPC service. Is the service running?".to_string()
|
|
}
|
|
Error::Ipc(ipc::Error::PermissionDenied) => "Permission denied for Firezone IPC service. This should only happen on dev systems.".to_string(),
|
|
Error::Ipc(ipc::Error::Other(error)) => error.to_string(),
|
|
Error::IpcClosed => "IPC connection closed".to_string(),
|
|
Error::IpcRead => "IPC read failure".to_string(),
|
|
Error::IpcServiceTerminating => "The Firezone IPC service is terminating. Please restart the GUI Client.".to_string(),
|
|
Error::Logging(_) => "Logging error".to_string(),
|
|
Error::PortalConnection(error) => {
|
|
tracing::error!(%error, "Couldn't connect to the Portal");
|
|
"Couldn't connect to the Firezone Portal. Are you connected to the Internet?".to_string()
|
|
}
|
|
Error::UserNotInFirezoneGroup => format!("You are not a member of the group `{FIREZONE_GROUP}`. Try `sudo usermod -aG {FIREZONE_GROUP} $USER` and then reboot"),
|
|
Error::Other(error) => error.to_string(),
|
|
};
|
|
tracing::error!(?user_friendly_error_msg);
|
|
|
|
// I tried the Tauri dialogs and for some reason they don't show our
|
|
// app icon.
|
|
native_dialog::MessageDialog::new()
|
|
.set_title("Firezone Error")
|
|
.set_text(&user_friendly_error_msg)
|
|
.set_type(native_dialog::MessageType::Error)
|
|
.show_alert()?;
|
|
Ok(())
|
|
}
|