Use fallible options for settings

Author: ConradIrwin

Cargo.lock

@@ -640,7 +640,6 @@ serde_json_lenient = { version = "0.2", features = [
 serde_path_to_error = "0.1.17"
 serde_repr = "0.1"
 serde_urlencoded = "0.7"
-serde_with = "3.4.0"
 sha2 = "0.10"
 shellexpand = "2.1.0"
 shlex = "1.3.0"

Cargo.toml

@@ -34,7 +34,6 @@ serde.workspace = true
 serde_json.workspace = true
 serde_json_lenient.workspace = true
 serde_repr.workspace = true
-serde_with.workspace = true
 settings_json.workspace = true
 settings_macros.workspace = true
 smallvec.workspace = true

crates/settings/Cargo.toml

@@ -0,0 +1,112 @@
+use std::cell::RefCell;
+
+use serde::Deserialize;
+
+use crate::ParseStatus;
+
+thread_local! {
+    static ERRORS: RefCell<Option<Vec<anyhow::Error>>> = RefCell::new(None);
+}
+
+pub(crate) fn parse_json<'de, T>(json: &'de str) -> (Option<T>, ParseStatus)
+where
+    T: Deserialize<'de>,
+{
+    ERRORS.with_borrow_mut(|errors| {
+        errors.replace(Vec::default());
+    });
+
+    let mut deserializer = serde_json_lenient::Deserializer::from_str(json);
+    let value = T::deserialize(&mut deserializer);
+    let value = match value {
+        Ok(value) => value,
+        Err(error) => {
+            return (
+                None,
+                ParseStatus::Failed {
+                    error: error.to_string(),
+                },
+            );
+        }
+    };
+
+    if let Some(errors) = ERRORS.with_borrow_mut(|errors| errors.take().filter(|e| !e.is_empty())) {
+        let error = errors
+            .into_iter()
+            .map(|e| e.to_string())
+            .flat_map(|e| ["\n".to_owned(), e])
+            .skip(1)
+            .collect::<String>();
+        return (Some(value), ParseStatus::Failed { error });
+    }
+
+    (Some(value), ParseStatus::Success)
+}
+
+pub(crate) fn deserialize<'de, D, T>(deserializer: D) -> Result<T, D::Error>
+where
+    D: serde::Deserializer<'de>,
+    T: serde::Deserialize<'de> + FallibleOption,
+{
+    match T::deserialize(deserializer) {
+        Ok(value) => Ok(value),
+        Err(e) => ERRORS.with_borrow_mut(|errors| {
+            if let Some(errors) = errors {
+                errors.push(anyhow::anyhow!("{}", e));
+                Ok(Default::default())
+            } else {
+                Err(e)
+            }
+        }),
+    }
+}
+
+pub trait FallibleOption: Default {}
+impl<T> FallibleOption for Option<T> {}
+
+#[cfg(test)]
+mod tests {
+    use serde::Deserialize;
+    use settings_macros::with_fallible_options;
+
+    use crate::ParseStatus;
+
+    #[with_fallible_options]
+    #[derive(Deserialize, Debug, PartialEq)]
+    struct Foo {
+        foo: Option<String>,
+        bar: Option<usize>,
+        baz: Option<bool>,
+    }
+
+    #[test]
+    fn test_fallible() {
+        let input = r#"
+            {"foo": "bar",
+            "bar": "foo",
+            "baz": 3,
+            }
+        "#;
+
+        let (settings, result) = crate::fallible_options::parse_json::<Foo>(&input);
+        assert_eq!(
+            settings.unwrap(),
+            Foo {
+                foo: Some("bar".into()).into(),
+                bar: None.into(),
+                baz: None.into(),
+            }
+        );
+
+        assert!(crate::parse_json_with_comments::<Foo>(&input).is_err());
+
+        let ParseStatus::Failed { error } = result else {
+            panic!("Expected parse to fail")
+        };
+
+        assert_eq!(
+            error,
+            "invalid type: string \"foo\", expected usize at line 3 column 24\ninvalid type: integer `3`, expected a boolean at line 4 column 20".to_string()
+        )
+    }
+}

crates/settings/src/fallible_options.rs

@@ -1,5 +1,6 @@
 mod base_keymap_setting;
 mod editable_setting_control;
+mod fallible_options;
 mod keymap_file;
 pub mod merge_from;
 mod serde_helper;

crates/settings/src/settings.rs

@@ -23,16 +23,15 @@ use gpui::{App, SharedString};
 use release_channel::ReleaseChannel;
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
-use serde_with::skip_serializing_none;
-use settings_macros::MergeFrom;
+use settings_macros::{MergeFrom, with_fallible_options};
 use std::collections::BTreeSet;
 use std::env;
 use std::sync::Arc;
 pub use util::serde::default_true;
 
 use crate::{ActiveSettingsProfileName, merge_from};
 
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Debug, PartialEq, Default, Clone, Serialize, Deserialize, JsonSchema, MergeFrom)]
 pub struct SettingsContent {
     #[serde(flatten)]
@@ -169,7 +168,7 @@ impl SettingsContent {
     }
 }
 
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Debug, Default, PartialEq, Clone, Serialize, Deserialize, JsonSchema, MergeFrom)]
 pub struct UserSettingsContent {
     #[serde(flatten)]
@@ -260,7 +259,7 @@ impl strum::VariantNames for BaseKeymapContent {
     ];
 }
 
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug)]
 pub struct TitleBarSettingsContent {
     /// Whether to show the branch icon beside branch switcher in the title bar.
@@ -294,7 +293,7 @@ pub struct TitleBarSettingsContent {
 }
 
 /// Configuration of audio in Zed.
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug)]
 pub struct AudioSettingsContent {
     /// Opt into the new audio system.
@@ -338,7 +337,7 @@ pub struct AudioSettingsContent {
 }
 
 /// Control what info is collected by Zed.
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema, Debug, MergeFrom)]
 pub struct TelemetrySettingsContent {
     /// Send debug info like crash reports.
@@ -360,7 +359,7 @@ impl Default for TelemetrySettingsContent {
     }
 }
 
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Default, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema, Clone, MergeFrom)]
 pub struct DebuggerSettingsContent {
     /// Determines the stepping granularity.
@@ -441,23 +440,23 @@ pub enum DockPosition {
 }
 
 /// Settings for slash commands.
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Deserialize, Serialize, Debug, Default, Clone, JsonSchema, MergeFrom, PartialEq, Eq)]
 pub struct SlashCommandSettings {
     /// Settings for the `/cargo-workspace` slash command.
     pub cargo_workspace: Option<CargoWorkspaceCommandSettings>,
 }
 
 /// Settings for the `/cargo-workspace` slash command.
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Deserialize, Serialize, Debug, Default, Clone, JsonSchema, MergeFrom, PartialEq, Eq)]
 pub struct CargoWorkspaceCommandSettings {
     /// Whether `/cargo-workspace` is enabled.
     pub enabled: Option<bool>,
 }
 
 /// Configuration of voice calls in Zed.
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug)]
 pub struct CallSettingsContent {
     /// Whether the microphone should be muted when joining a channel or a call.
@@ -471,7 +470,7 @@ pub struct CallSettingsContent {
     pub share_on_join: Option<bool>,
 }
 
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug)]
 pub struct GitPanelSettingsContent {
     /// Whether to show the panel button in the status bar.
@@ -535,15 +534,15 @@ pub enum StatusStyle {
     LabelColor,
 }
 
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(
     Copy, Clone, Default, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Eq,
 )]
 pub struct ScrollbarSettings {
     pub show: Option<ShowScrollbar>,
 }
 
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
 pub struct NotificationPanelSettingsContent {
     /// Whether to show the panel button in the status bar.
@@ -561,7 +560,7 @@ pub struct NotificationPanelSettingsContent {
     pub default_width: Option<f32>,
 }
 
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
 pub struct PanelSettingsContent {
     /// Whether to show the panel button in the status bar.
@@ -579,7 +578,7 @@ pub struct PanelSettingsContent {
     pub default_width: Option<f32>,
 }
 
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
 pub struct MessageEditorSettings {
     /// Whether to automatically replace emoji shortcodes with emoji characters.
@@ -589,7 +588,7 @@ pub struct MessageEditorSettings {
     pub auto_replace_emoji_shortcode: Option<bool>,
 }
 
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
 pub struct FileFinderSettingsContent {
     /// Whether to show file icons in the file finder.
@@ -664,7 +663,7 @@ pub enum FileFinderWidthContent {
     Full,
 }
 
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Clone, Default, Serialize, Deserialize, PartialEq, Debug, JsonSchema, MergeFrom)]
 pub struct VimSettingsContent {
     pub default_mode: Option<ModeContent>,
@@ -697,7 +696,7 @@ pub enum UseSystemClipboard {
 }
 
 /// The settings for cursor shape.
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema, MergeFrom)]
 pub struct CursorShapeSettings {
     /// Cursor shape for the normal mode.
@@ -719,7 +718,7 @@ pub struct CursorShapeSettings {
 }
 
 /// Settings specific to journaling
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq)]
 pub struct JournalSettingsContent {
     /// The path of the directory where journal entries are stored.
@@ -740,7 +739,7 @@ pub enum HourFormat {
     Hour24,
 }
 
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
 pub struct OutlinePanelSettingsContent {
     /// Whether to show the outline panel button in the status bar.
@@ -835,7 +834,7 @@ pub enum ShowIndentGuides {
     Never,
 }
 
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(
     Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Eq, Default,
 )]
@@ -853,7 +852,7 @@ pub enum LineIndicatorFormat {
 }
 
 /// The settings for the image viewer.
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, Default, PartialEq)]
 pub struct ImageViewerSettingsContent {
     /// The unit to use for displaying image file sizes.
@@ -862,7 +861,7 @@ pub struct ImageViewerSettingsContent {
     pub unit: Option<ImageFileSizeUnit>,
 }
 
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(
     Clone,
     Copy,
@@ -885,15 +884,15 @@ pub enum ImageFileSizeUnit {
     Decimal,
 }
 
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq)]
 pub struct RemoteSettingsContent {
     pub ssh_connections: Option<Vec<SshConnection>>,
     pub wsl_connections: Option<Vec<WslConnection>>,
     pub read_ssh_config: Option<bool>,
 }
 
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq, JsonSchema, MergeFrom)]
 pub struct SshConnection {
     pub host: SharedString,
@@ -922,27 +921,25 @@ pub struct WslConnection {
     pub projects: BTreeSet<SshProject>,
 }
 
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(
     Clone, Debug, Default, Serialize, PartialEq, Eq, PartialOrd, Ord, Deserialize, JsonSchema,
 )]
 pub struct SshProject {
     pub paths: Vec<String>,
 }
 
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize, JsonSchema, MergeFrom)]
 pub struct SshPortForwardOption {
-    #[serde(skip_serializing_if = "Option::is_none")]
     pub local_host: Option<String>,
     pub local_port: u16,
-    #[serde(skip_serializing_if = "Option::is_none")]
     pub remote_host: Option<String>,
     pub remote_port: u16,
 }
 
 /// Settings for configuring REPL display and behavior.
-#[skip_serializing_none]
+#[with_fallible_options]
 #[derive(Clone, Debug, PartialEq, Serialize, Deserialize, JsonSchema, MergeFrom)]
 pub struct ReplSettingsContent {
     /// Maximum number of lines to keep in REPL's scrollback buffer.