1use anyhow::Result;
2use collections::{btree_map, hash_map, BTreeMap, HashMap};
3use gpui::AppContext;
4use lazy_static::lazy_static;
5use schemars::{gen::SchemaGenerator, schema::RootSchema, JsonSchema};
6use serde::{de::DeserializeOwned, Deserialize as _, Serialize};
7use smallvec::SmallVec;
8use std::{
9 any::{type_name, Any, TypeId},
10 fmt::Debug,
11 ops::Range,
12 path::Path,
13 str,
14 sync::Arc,
15};
16use util::{merge_non_null_json_value_into, RangeExt, ResultExt as _};
17
18/// A value that can be defined as a user setting.
19///
20/// Settings can be loaded from a combination of multiple JSON files.
21pub trait Setting: 'static {
22 /// The name of a key within the JSON file from which this setting should
23 /// be deserialized. If this is `None`, then the setting will be deserialized
24 /// from the root object.
25 const KEY: Option<&'static str>;
26
27 /// The type that is stored in an individual JSON file.
28 type FileContent: Clone + Default + Serialize + DeserializeOwned + JsonSchema;
29
30 /// The logic for combining together values from one or more JSON files into the
31 /// final value for this setting.
32 ///
33 /// The user values are ordered from least specific (the global settings file)
34 /// to most specific (the innermost local settings file).
35 fn load(
36 default_value: &Self::FileContent,
37 user_values: &[&Self::FileContent],
38 cx: &AppContext,
39 ) -> Result<Self>
40 where
41 Self: Sized;
42
43 fn json_schema(
44 generator: &mut SchemaGenerator,
45 _: &SettingsJsonSchemaParams,
46 _: &AppContext,
47 ) -> RootSchema {
48 generator.root_schema_for::<Self::FileContent>()
49 }
50
51 fn json_merge(
52 default_value: &Self::FileContent,
53 user_values: &[&Self::FileContent],
54 ) -> Result<Self::FileContent> {
55 let mut merged = serde_json::Value::Null;
56 for value in [default_value].iter().chain(user_values) {
57 merge_non_null_json_value_into(serde_json::to_value(value).unwrap(), &mut merged);
58 }
59 Ok(serde_json::from_value(merged)?)
60 }
61
62 fn load_via_json_merge(
63 default_value: &Self::FileContent,
64 user_values: &[&Self::FileContent],
65 ) -> Result<Self>
66 where
67 Self: DeserializeOwned,
68 {
69 let mut merged = serde_json::Value::Null;
70 for value in [default_value].iter().chain(user_values) {
71 merge_non_null_json_value_into(serde_json::to_value(value).unwrap(), &mut merged);
72 }
73 Ok(serde_json::from_value(merged)?)
74 }
75
76 fn missing_default() -> anyhow::Error {
77 anyhow::anyhow!("missing default")
78 }
79}
80
81pub struct SettingsJsonSchemaParams<'a> {
82 pub staff_mode: bool,
83 pub language_names: &'a [String],
84}
85
86/// A set of strongly-typed setting values defined via multiple JSON files.
87#[derive(Default)]
88pub struct SettingsStore {
89 setting_values: HashMap<TypeId, Box<dyn AnySettingValue>>,
90 default_deserialized_settings: Option<serde_json::Value>,
91 user_deserialized_settings: Option<serde_json::Value>,
92 local_deserialized_settings: BTreeMap<(usize, Arc<Path>), serde_json::Value>,
93 tab_size_callback: Option<(TypeId, Box<dyn Fn(&dyn Any) -> Option<usize>>)>,
94}
95
96#[derive(Debug)]
97struct SettingValue<T> {
98 global_value: Option<T>,
99 local_values: Vec<(usize, Arc<Path>, T)>,
100}
101
102trait AnySettingValue {
103 fn key(&self) -> Option<&'static str>;
104 fn setting_type_name(&self) -> &'static str;
105 fn deserialize_setting(&self, json: &serde_json::Value) -> Result<DeserializedSetting>;
106 fn load_setting(
107 &self,
108 default_value: &DeserializedSetting,
109 custom: &[DeserializedSetting],
110 cx: &AppContext,
111 ) -> Result<Box<dyn Any>>;
112 fn value_for_path(&self, path: Option<(usize, &Path)>) -> &dyn Any;
113 fn set_global_value(&mut self, value: Box<dyn Any>);
114 fn set_local_value(&mut self, root_id: usize, path: Arc<Path>, value: Box<dyn Any>);
115 fn json_schema(
116 &self,
117 generator: &mut SchemaGenerator,
118 _: &SettingsJsonSchemaParams,
119 cx: &AppContext,
120 ) -> RootSchema;
121}
122
123struct DeserializedSetting(Box<dyn Any>);
124
125impl SettingsStore {
126 /// Add a new type of setting to the store.
127 pub fn register_setting<T: Setting>(&mut self, cx: &AppContext) {
128 let setting_type_id = TypeId::of::<T>();
129 let entry = self.setting_values.entry(setting_type_id);
130 if matches!(entry, hash_map::Entry::Occupied(_)) {
131 return;
132 }
133
134 let setting_value = entry.or_insert(Box::new(SettingValue::<T> {
135 global_value: None,
136 local_values: Vec::new(),
137 }));
138
139 if let Some(default_settings) = &self.default_deserialized_settings {
140 if let Some(default_settings) = setting_value
141 .deserialize_setting(default_settings)
142 .log_err()
143 {
144 let mut user_values_stack = Vec::new();
145
146 if let Some(user_settings) = &self.user_deserialized_settings {
147 if let Some(user_settings) =
148 setting_value.deserialize_setting(user_settings).log_err()
149 {
150 user_values_stack = vec![user_settings];
151 }
152 }
153
154 if let Some(setting) = setting_value
155 .load_setting(&default_settings, &user_values_stack, cx)
156 .log_err()
157 {
158 setting_value.set_global_value(setting);
159 }
160 }
161 }
162 }
163
164 /// Get the value of a setting.
165 ///
166 /// Panics if the given setting type has not been registered, or if there is no
167 /// value for this setting.
168 pub fn get<T: Setting>(&self, path: Option<(usize, &Path)>) -> &T {
169 self.setting_values
170 .get(&TypeId::of::<T>())
171 .unwrap_or_else(|| panic!("unregistered setting type {}", type_name::<T>()))
172 .value_for_path(path)
173 .downcast_ref::<T>()
174 .expect("no default value for setting type")
175 }
176
177 /// Override the global value for a setting.
178 ///
179 /// The given value will be overwritten if the user settings file changes.
180 pub fn override_global<T: Setting>(&mut self, value: T) {
181 self.setting_values
182 .get_mut(&TypeId::of::<T>())
183 .unwrap_or_else(|| panic!("unregistered setting type {}", type_name::<T>()))
184 .set_global_value(Box::new(value))
185 }
186
187 /// Get the user's settings as a raw JSON value.
188 ///
189 /// This is only for debugging and reporting. For user-facing functionality,
190 /// use the typed setting interface.
191 pub fn untyped_user_settings(&self) -> &serde_json::Value {
192 self.user_deserialized_settings
193 .as_ref()
194 .unwrap_or(&serde_json::Value::Null)
195 }
196
197 #[cfg(any(test, feature = "test-support"))]
198 pub fn test(cx: &AppContext) -> Self {
199 let mut this = Self::default();
200 this.set_default_settings(&crate::test_settings(), cx)
201 .unwrap();
202 this.set_user_settings("{}", cx).unwrap();
203 this
204 }
205
206 /// Update the value of a setting in the user's global configuration.
207 ///
208 /// This is only for tests. Normally, settings are only loaded from
209 /// JSON files.
210 #[cfg(any(test, feature = "test-support"))]
211 pub fn update_user_settings<T: Setting>(
212 &mut self,
213 cx: &AppContext,
214 update: impl FnOnce(&mut T::FileContent),
215 ) {
216 if self.user_deserialized_settings.is_none() {
217 self.set_user_settings("{}", cx).unwrap();
218 }
219 let old_text =
220 serde_json::to_string(self.user_deserialized_settings.as_ref().unwrap()).unwrap();
221 let new_text = self.new_text_for_update::<T>(old_text, update);
222 self.set_user_settings(&new_text, cx).unwrap();
223 }
224
225 /// Update the value of a setting in a JSON file, returning the new text
226 /// for that JSON file.
227 pub fn new_text_for_update<T: Setting>(
228 &self,
229 old_text: String,
230 update: impl FnOnce(&mut T::FileContent),
231 ) -> String {
232 let edits = self.edits_for_update::<T>(&old_text, update);
233 let mut new_text = old_text;
234 for (range, replacement) in edits.into_iter() {
235 new_text.replace_range(range, &replacement);
236 }
237 new_text
238 }
239
240 /// Update the value of a setting in a JSON file, returning a list
241 /// of edits to apply to the JSON file.
242 pub fn edits_for_update<T: Setting>(
243 &self,
244 text: &str,
245 update: impl FnOnce(&mut T::FileContent),
246 ) -> Vec<(Range<usize>, String)> {
247 let setting_type_id = TypeId::of::<T>();
248
249 let old_content = self
250 .setting_values
251 .get(&setting_type_id)
252 .unwrap_or_else(|| panic!("unregistered setting type {}", type_name::<T>()))
253 .deserialize_setting(
254 self.user_deserialized_settings
255 .as_ref()
256 .expect("no user settings loaded"),
257 )
258 .unwrap_or_else(|e| {
259 panic!(
260 "could not deserialize setting type {} from user settings: {}",
261 type_name::<T>(),
262 e
263 )
264 })
265 .0
266 .downcast::<T::FileContent>()
267 .unwrap();
268 let mut new_content = old_content.clone();
269 update(&mut new_content);
270
271 let old_value = &serde_json::to_value(&old_content).unwrap();
272 let new_value = serde_json::to_value(new_content).unwrap();
273
274 let mut key_path = Vec::new();
275 if let Some(key) = T::KEY {
276 key_path.push(key);
277 }
278
279 let mut edits = Vec::new();
280 let tab_size = self.json_tab_size();
281 let mut text = text.to_string();
282 update_value_in_json_text(
283 &mut text,
284 &mut key_path,
285 tab_size,
286 &old_value,
287 &new_value,
288 &mut edits,
289 );
290 return edits;
291 }
292
293 /// Configure the tab sized when updating JSON files.
294 pub fn set_json_tab_size_callback<T: Setting>(
295 &mut self,
296 get_tab_size: fn(&T) -> Option<usize>,
297 ) {
298 self.tab_size_callback = Some((
299 TypeId::of::<T>(),
300 Box::new(move |value| get_tab_size(value.downcast_ref::<T>().unwrap())),
301 ));
302 }
303
304 fn json_tab_size(&self) -> usize {
305 const DEFAULT_JSON_TAB_SIZE: usize = 2;
306
307 if let Some((setting_type_id, callback)) = &self.tab_size_callback {
308 let setting_value = self.setting_values.get(setting_type_id).unwrap();
309 let value = setting_value.value_for_path(None);
310 if let Some(value) = callback(value) {
311 return value;
312 }
313 }
314
315 DEFAULT_JSON_TAB_SIZE
316 }
317
318 /// Set the default settings via a JSON string.
319 ///
320 /// The string should contain a JSON object with a default value for every setting.
321 pub fn set_default_settings(
322 &mut self,
323 default_settings_content: &str,
324 cx: &AppContext,
325 ) -> Result<()> {
326 self.default_deserialized_settings =
327 Some(parse_json_with_comments(default_settings_content)?);
328 self.recompute_values(None, cx)?;
329 Ok(())
330 }
331
332 /// Set the user settings via a JSON string.
333 pub fn set_user_settings(
334 &mut self,
335 user_settings_content: &str,
336 cx: &AppContext,
337 ) -> Result<()> {
338 self.user_deserialized_settings = Some(parse_json_with_comments(user_settings_content)?);
339 self.recompute_values(None, cx)?;
340 Ok(())
341 }
342
343 /// Add or remove a set of local settings via a JSON string.
344 pub fn set_local_settings(
345 &mut self,
346 root_id: usize,
347 path: Arc<Path>,
348 settings_content: Option<&str>,
349 cx: &AppContext,
350 ) -> Result<()> {
351 if let Some(content) = settings_content {
352 self.local_deserialized_settings
353 .insert((root_id, path.clone()), parse_json_with_comments(content)?);
354 } else {
355 self.local_deserialized_settings
356 .remove(&(root_id, path.clone()));
357 }
358 self.recompute_values(Some((root_id, &path)), cx)?;
359 Ok(())
360 }
361
362 pub fn json_schema(
363 &self,
364 schema_params: &SettingsJsonSchemaParams,
365 cx: &AppContext,
366 ) -> serde_json::Value {
367 use schemars::{
368 gen::SchemaSettings,
369 schema::{Schema, SchemaObject},
370 };
371
372 let settings = SchemaSettings::draft07().with(|settings| {
373 settings.option_add_null_type = false;
374 });
375 let mut generator = SchemaGenerator::new(settings);
376 let mut combined_schema = RootSchema::default();
377
378 for setting_value in self.setting_values.values() {
379 let setting_schema = setting_value.json_schema(&mut generator, schema_params, cx);
380 combined_schema
381 .definitions
382 .extend(setting_schema.definitions);
383
384 let target_schema = if let Some(key) = setting_value.key() {
385 let key_schema = combined_schema
386 .schema
387 .object()
388 .properties
389 .entry(key.to_string())
390 .or_insert_with(|| Schema::Object(SchemaObject::default()));
391 if let Schema::Object(key_schema) = key_schema {
392 key_schema
393 } else {
394 continue;
395 }
396 } else {
397 &mut combined_schema.schema
398 };
399
400 merge_schema(target_schema, setting_schema.schema);
401 }
402
403 fn merge_schema(target: &mut SchemaObject, source: SchemaObject) {
404 if let Some(source) = source.object {
405 let target_properties = &mut target.object().properties;
406 for (key, value) in source.properties {
407 match target_properties.entry(key) {
408 btree_map::Entry::Vacant(e) => {
409 e.insert(value);
410 }
411 btree_map::Entry::Occupied(e) => {
412 if let (Schema::Object(target), Schema::Object(src)) =
413 (e.into_mut(), value)
414 {
415 merge_schema(target, src);
416 }
417 }
418 }
419 }
420 }
421
422 overwrite(&mut target.instance_type, source.instance_type);
423 overwrite(&mut target.string, source.string);
424 overwrite(&mut target.number, source.number);
425 overwrite(&mut target.reference, source.reference);
426 overwrite(&mut target.array, source.array);
427 overwrite(&mut target.enum_values, source.enum_values);
428
429 fn overwrite<T>(target: &mut Option<T>, source: Option<T>) {
430 if let Some(source) = source {
431 *target = Some(source);
432 }
433 }
434 }
435
436 serde_json::to_value(&combined_schema).unwrap()
437 }
438
439 fn recompute_values(
440 &mut self,
441 changed_local_path: Option<(usize, &Path)>,
442 cx: &AppContext,
443 ) -> Result<()> {
444 // Reload the global and local values for every setting.
445 let mut user_settings_stack = Vec::<DeserializedSetting>::new();
446 let mut paths_stack = Vec::<Option<(usize, &Path)>>::new();
447 for setting_value in self.setting_values.values_mut() {
448 if let Some(default_settings) = &self.default_deserialized_settings {
449 let default_settings = setting_value.deserialize_setting(default_settings)?;
450
451 user_settings_stack.clear();
452 paths_stack.clear();
453
454 if let Some(user_settings) = &self.user_deserialized_settings {
455 if let Some(user_settings) =
456 setting_value.deserialize_setting(user_settings).log_err()
457 {
458 user_settings_stack.push(user_settings);
459 paths_stack.push(None);
460 }
461 }
462
463 // If the global settings file changed, reload the global value for the field.
464 if changed_local_path.is_none() {
465 if let Some(value) = setting_value
466 .load_setting(&default_settings, &user_settings_stack, cx)
467 .log_err()
468 {
469 setting_value.set_global_value(value);
470 }
471 }
472
473 // Reload the local values for the setting.
474 for ((root_id, path), local_settings) in &self.local_deserialized_settings {
475 // Build a stack of all of the local values for that setting.
476 while let Some(prev_entry) = paths_stack.last() {
477 if let Some((prev_root_id, prev_path)) = prev_entry {
478 if root_id != prev_root_id || !path.starts_with(prev_path) {
479 paths_stack.pop();
480 user_settings_stack.pop();
481 continue;
482 }
483 }
484 break;
485 }
486
487 if let Some(local_settings) =
488 setting_value.deserialize_setting(&local_settings).log_err()
489 {
490 paths_stack.push(Some((*root_id, path.as_ref())));
491 user_settings_stack.push(local_settings);
492
493 // If a local settings file changed, then avoid recomputing local
494 // settings for any path outside of that directory.
495 if changed_local_path.map_or(
496 false,
497 |(changed_root_id, changed_local_path)| {
498 *root_id != changed_root_id || !path.starts_with(changed_local_path)
499 },
500 ) {
501 continue;
502 }
503
504 if let Some(value) = setting_value
505 .load_setting(&default_settings, &user_settings_stack, cx)
506 .log_err()
507 {
508 setting_value.set_local_value(*root_id, path.clone(), value);
509 }
510 }
511 }
512 }
513 }
514 Ok(())
515 }
516}
517
518impl Debug for SettingsStore {
519 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
520 f.debug_struct("SettingsStore")
521 .field(
522 "types",
523 &self
524 .setting_values
525 .values()
526 .map(|value| value.setting_type_name())
527 .collect::<Vec<_>>(),
528 )
529 .field("default_settings", &self.default_deserialized_settings)
530 .field("user_settings", &self.user_deserialized_settings)
531 .field("local_settings", &self.local_deserialized_settings)
532 .finish_non_exhaustive()
533 }
534}
535
536impl<T: Setting> AnySettingValue for SettingValue<T> {
537 fn key(&self) -> Option<&'static str> {
538 T::KEY
539 }
540
541 fn setting_type_name(&self) -> &'static str {
542 type_name::<T>()
543 }
544
545 fn load_setting(
546 &self,
547 default_value: &DeserializedSetting,
548 user_values: &[DeserializedSetting],
549 cx: &AppContext,
550 ) -> Result<Box<dyn Any>> {
551 let default_value = default_value.0.downcast_ref::<T::FileContent>().unwrap();
552 let values: SmallVec<[&T::FileContent; 6]> = user_values
553 .iter()
554 .map(|value| value.0.downcast_ref().unwrap())
555 .collect();
556 Ok(Box::new(T::load(default_value, &values, cx)?))
557 }
558
559 fn deserialize_setting(&self, mut json: &serde_json::Value) -> Result<DeserializedSetting> {
560 if let Some(key) = T::KEY {
561 if let Some(value) = json.get(key) {
562 json = value;
563 } else {
564 let value = T::FileContent::default();
565 return Ok(DeserializedSetting(Box::new(value)));
566 }
567 }
568 let value = T::FileContent::deserialize(json)?;
569 Ok(DeserializedSetting(Box::new(value)))
570 }
571
572 fn value_for_path(&self, path: Option<(usize, &Path)>) -> &dyn Any {
573 if let Some((root_id, path)) = path {
574 for (settings_root_id, settings_path, value) in self.local_values.iter().rev() {
575 if root_id == *settings_root_id && path.starts_with(&settings_path) {
576 return value;
577 }
578 }
579 }
580 self.global_value
581 .as_ref()
582 .unwrap_or_else(|| panic!("no default value for setting {}", self.setting_type_name()))
583 }
584
585 fn set_global_value(&mut self, value: Box<dyn Any>) {
586 self.global_value = Some(*value.downcast().unwrap());
587 }
588
589 fn set_local_value(&mut self, root_id: usize, path: Arc<Path>, value: Box<dyn Any>) {
590 let value = *value.downcast().unwrap();
591 match self
592 .local_values
593 .binary_search_by_key(&(root_id, &path), |e| (e.0, &e.1))
594 {
595 Ok(ix) => self.local_values[ix].2 = value,
596 Err(ix) => self.local_values.insert(ix, (root_id, path, value)),
597 }
598 }
599
600 fn json_schema(
601 &self,
602 generator: &mut SchemaGenerator,
603 params: &SettingsJsonSchemaParams,
604 cx: &AppContext,
605 ) -> RootSchema {
606 T::json_schema(generator, params, cx)
607 }
608}
609
610// impl Debug for SettingsStore {
611// fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
612// return f
613// .debug_struct("SettingsStore")
614// .field(
615// "setting_value_sets_by_type",
616// &self
617// .setting_values
618// .values()
619// .map(|set| (set.setting_type_name(), set))
620// .collect::<HashMap<_, _>>(),
621// )
622// .finish_non_exhaustive();
623// }
624// }
625
626fn update_value_in_json_text<'a>(
627 text: &mut String,
628 key_path: &mut Vec<&'a str>,
629 tab_size: usize,
630 old_value: &'a serde_json::Value,
631 new_value: &'a serde_json::Value,
632 edits: &mut Vec<(Range<usize>, String)>,
633) {
634 // If the old and new values are both objects, then compare them key by key,
635 // preserving the comments and formatting of the unchanged parts. Otherwise,
636 // replace the old value with the new value.
637 if let (serde_json::Value::Object(old_object), serde_json::Value::Object(new_object)) =
638 (old_value, new_value)
639 {
640 for (key, old_sub_value) in old_object.iter() {
641 key_path.push(key);
642 let new_sub_value = new_object.get(key).unwrap_or(&serde_json::Value::Null);
643 update_value_in_json_text(
644 text,
645 key_path,
646 tab_size,
647 old_sub_value,
648 new_sub_value,
649 edits,
650 );
651 key_path.pop();
652 }
653 for (key, new_sub_value) in new_object.iter() {
654 key_path.push(key);
655 if !old_object.contains_key(key) {
656 update_value_in_json_text(
657 text,
658 key_path,
659 tab_size,
660 &serde_json::Value::Null,
661 new_sub_value,
662 edits,
663 );
664 }
665 key_path.pop();
666 }
667 } else if old_value != new_value {
668 let (range, replacement) =
669 replace_value_in_json_text(text, &key_path, tab_size, &new_value);
670 text.replace_range(range.clone(), &replacement);
671 edits.push((range, replacement));
672 }
673}
674
675fn replace_value_in_json_text(
676 text: &str,
677 key_path: &[&str],
678 tab_size: usize,
679 new_value: impl Serialize,
680) -> (Range<usize>, String) {
681 const LANGUAGE_OVERRIDES: &'static str = "language_overrides";
682 const LANGUAGES: &'static str = "languages";
683
684 lazy_static! {
685 static ref PAIR_QUERY: tree_sitter::Query = tree_sitter::Query::new(
686 tree_sitter_json::language(),
687 "(pair key: (string) @key value: (_) @value)",
688 )
689 .unwrap();
690 }
691
692 let mut parser = tree_sitter::Parser::new();
693 parser.set_language(tree_sitter_json::language()).unwrap();
694 let syntax_tree = parser.parse(text, None).unwrap();
695
696 let mut cursor = tree_sitter::QueryCursor::new();
697
698 let has_language_overrides = text.contains(LANGUAGE_OVERRIDES);
699
700 let mut depth = 0;
701 let mut last_value_range = 0..0;
702 let mut first_key_start = None;
703 let mut existing_value_range = 0..text.len();
704 let matches = cursor.matches(&PAIR_QUERY, syntax_tree.root_node(), text.as_bytes());
705 for mat in matches {
706 if mat.captures.len() != 2 {
707 continue;
708 }
709
710 let key_range = mat.captures[0].node.byte_range();
711 let value_range = mat.captures[1].node.byte_range();
712
713 // Don't enter sub objects until we find an exact
714 // match for the current keypath
715 if last_value_range.contains_inclusive(&value_range) {
716 continue;
717 }
718
719 last_value_range = value_range.clone();
720
721 if key_range.start > existing_value_range.end {
722 break;
723 }
724
725 first_key_start.get_or_insert_with(|| key_range.start);
726
727 let found_key = text
728 .get(key_range.clone())
729 .map(|key_text| {
730 if key_path[depth] == LANGUAGES && has_language_overrides {
731 return key_text == format!("\"{}\"", LANGUAGE_OVERRIDES);
732 } else {
733 return key_text == format!("\"{}\"", key_path[depth]);
734 }
735 })
736 .unwrap_or(false);
737
738 if found_key {
739 existing_value_range = value_range;
740 // Reset last value range when increasing in depth
741 last_value_range = existing_value_range.start..existing_value_range.start;
742 depth += 1;
743
744 if depth == key_path.len() {
745 break;
746 } else {
747 first_key_start = None;
748 }
749 }
750 }
751
752 // We found the exact key we want, insert the new value
753 if depth == key_path.len() {
754 let new_val = to_pretty_json(&new_value, tab_size, tab_size * depth);
755 (existing_value_range, new_val)
756 } else {
757 // We have key paths, construct the sub objects
758 let new_key = if has_language_overrides && key_path[depth] == LANGUAGES {
759 LANGUAGE_OVERRIDES
760 } else {
761 key_path[depth]
762 };
763
764 // We don't have the key, construct the nested objects
765 let mut new_value = serde_json::to_value(new_value).unwrap();
766 for key in key_path[(depth + 1)..].iter().rev() {
767 if has_language_overrides && key == &LANGUAGES {
768 new_value = serde_json::json!({ LANGUAGE_OVERRIDES.to_string(): new_value });
769 } else {
770 new_value = serde_json::json!({ key.to_string(): new_value });
771 }
772 }
773
774 if let Some(first_key_start) = first_key_start {
775 let mut row = 0;
776 let mut column = 0;
777 for (ix, char) in text.char_indices() {
778 if ix == first_key_start {
779 break;
780 }
781 if char == '\n' {
782 row += 1;
783 column = 0;
784 } else {
785 column += char.len_utf8();
786 }
787 }
788
789 if row > 0 {
790 // depth is 0 based, but division needs to be 1 based.
791 let new_val = to_pretty_json(&new_value, column / (depth + 1), column);
792 let space = ' ';
793 let content = format!("\"{new_key}\": {new_val},\n{space:width$}", width = column);
794 (first_key_start..first_key_start, content)
795 } else {
796 let new_val = serde_json::to_string(&new_value).unwrap();
797 let mut content = format!(r#""{new_key}": {new_val},"#);
798 content.push(' ');
799 (first_key_start..first_key_start, content)
800 }
801 } else {
802 new_value = serde_json::json!({ new_key.to_string(): new_value });
803 let indent_prefix_len = 4 * depth;
804 let mut new_val = to_pretty_json(&new_value, 4, indent_prefix_len);
805 if depth == 0 {
806 new_val.push('\n');
807 }
808
809 (existing_value_range, new_val)
810 }
811 }
812}
813
814fn to_pretty_json(value: &impl Serialize, indent_size: usize, indent_prefix_len: usize) -> String {
815 const SPACES: [u8; 32] = [b' '; 32];
816
817 debug_assert!(indent_size <= SPACES.len());
818 debug_assert!(indent_prefix_len <= SPACES.len());
819
820 let mut output = Vec::new();
821 let mut ser = serde_json::Serializer::with_formatter(
822 &mut output,
823 serde_json::ser::PrettyFormatter::with_indent(&SPACES[0..indent_size.min(SPACES.len())]),
824 );
825
826 value.serialize(&mut ser).unwrap();
827 let text = String::from_utf8(output).unwrap();
828
829 let mut adjusted_text = String::new();
830 for (i, line) in text.split('\n').enumerate() {
831 if i > 0 {
832 adjusted_text.push_str(str::from_utf8(&SPACES[0..indent_prefix_len]).unwrap());
833 }
834 adjusted_text.push_str(line);
835 adjusted_text.push('\n');
836 }
837 adjusted_text.pop();
838 adjusted_text
839}
840
841pub fn parse_json_with_comments<T: DeserializeOwned>(content: &str) -> Result<T> {
842 Ok(serde_json::from_reader(
843 json_comments::CommentSettings::c_style().strip_comments(content.as_bytes()),
844 )?)
845}
846
847#[cfg(test)]
848mod tests {
849 use super::*;
850 use serde_derive::Deserialize;
851 use unindent::Unindent;
852
853 #[gpui::test]
854 fn test_settings_store_basic(cx: &mut AppContext) {
855 let mut store = SettingsStore::default();
856 store.register_setting::<UserSettings>(cx);
857 store.register_setting::<TurboSetting>(cx);
858 store.register_setting::<MultiKeySettings>(cx);
859 store
860 .set_default_settings(
861 r#"{
862 "turbo": false,
863 "user": {
864 "name": "John Doe",
865 "age": 30,
866 "staff": false
867 }
868 }"#,
869 cx,
870 )
871 .unwrap();
872
873 assert_eq!(store.get::<TurboSetting>(None), &TurboSetting(false));
874 assert_eq!(
875 store.get::<UserSettings>(None),
876 &UserSettings {
877 name: "John Doe".to_string(),
878 age: 30,
879 staff: false,
880 }
881 );
882 assert_eq!(
883 store.get::<MultiKeySettings>(None),
884 &MultiKeySettings {
885 key1: String::new(),
886 key2: String::new(),
887 }
888 );
889
890 store
891 .set_user_settings(
892 r#"{
893 "turbo": true,
894 "user": { "age": 31 },
895 "key1": "a"
896 }"#,
897 cx,
898 )
899 .unwrap();
900
901 assert_eq!(store.get::<TurboSetting>(None), &TurboSetting(true));
902 assert_eq!(
903 store.get::<UserSettings>(None),
904 &UserSettings {
905 name: "John Doe".to_string(),
906 age: 31,
907 staff: false
908 }
909 );
910
911 store
912 .set_local_settings(
913 1,
914 Path::new("/root1").into(),
915 Some(r#"{ "user": { "staff": true } }"#),
916 cx,
917 )
918 .unwrap();
919 store
920 .set_local_settings(
921 1,
922 Path::new("/root1/subdir").into(),
923 Some(r#"{ "user": { "name": "Jane Doe" } }"#),
924 cx,
925 )
926 .unwrap();
927
928 store
929 .set_local_settings(
930 1,
931 Path::new("/root2").into(),
932 Some(r#"{ "user": { "age": 42 }, "key2": "b" }"#),
933 cx,
934 )
935 .unwrap();
936
937 assert_eq!(
938 store.get::<UserSettings>(Some((1, Path::new("/root1/something")))),
939 &UserSettings {
940 name: "John Doe".to_string(),
941 age: 31,
942 staff: true
943 }
944 );
945 assert_eq!(
946 store.get::<UserSettings>(Some((1, Path::new("/root1/subdir/something")))),
947 &UserSettings {
948 name: "Jane Doe".to_string(),
949 age: 31,
950 staff: true
951 }
952 );
953 assert_eq!(
954 store.get::<UserSettings>(Some((1, Path::new("/root2/something")))),
955 &UserSettings {
956 name: "John Doe".to_string(),
957 age: 42,
958 staff: false
959 }
960 );
961 assert_eq!(
962 store.get::<MultiKeySettings>(Some((1, Path::new("/root2/something")))),
963 &MultiKeySettings {
964 key1: "a".to_string(),
965 key2: "b".to_string(),
966 }
967 );
968 }
969
970 #[gpui::test]
971 fn test_setting_store_assign_json_before_register(cx: &mut AppContext) {
972 let mut store = SettingsStore::default();
973 store
974 .set_default_settings(
975 r#"{
976 "turbo": true,
977 "user": {
978 "name": "John Doe",
979 "age": 30,
980 "staff": false
981 },
982 "key1": "x"
983 }"#,
984 cx,
985 )
986 .unwrap();
987 store
988 .set_user_settings(r#"{ "turbo": false }"#, cx)
989 .unwrap();
990 store.register_setting::<UserSettings>(cx);
991 store.register_setting::<TurboSetting>(cx);
992
993 assert_eq!(store.get::<TurboSetting>(None), &TurboSetting(false));
994 assert_eq!(
995 store.get::<UserSettings>(None),
996 &UserSettings {
997 name: "John Doe".to_string(),
998 age: 30,
999 staff: false,
1000 }
1001 );
1002
1003 store.register_setting::<MultiKeySettings>(cx);
1004 assert_eq!(
1005 store.get::<MultiKeySettings>(None),
1006 &MultiKeySettings {
1007 key1: "x".into(),
1008 key2: String::new(),
1009 }
1010 );
1011 }
1012
1013 #[gpui::test]
1014 fn test_setting_store_update(cx: &mut AppContext) {
1015 let mut store = SettingsStore::default();
1016 store.register_setting::<MultiKeySettings>(cx);
1017 store.register_setting::<UserSettings>(cx);
1018 store.register_setting::<LanguageSettings>(cx);
1019
1020 // entries added and updated
1021 check_settings_update::<LanguageSettings>(
1022 &mut store,
1023 r#"{
1024 "languages": {
1025 "JSON": {
1026 "is_enabled": true
1027 }
1028 }
1029 }"#
1030 .unindent(),
1031 |settings| {
1032 settings.languages.get_mut("JSON").unwrap().is_enabled = false;
1033 settings
1034 .languages
1035 .insert("Rust".into(), LanguageSettingEntry { is_enabled: true });
1036 },
1037 r#"{
1038 "languages": {
1039 "Rust": {
1040 "is_enabled": true
1041 },
1042 "JSON": {
1043 "is_enabled": false
1044 }
1045 }
1046 }"#
1047 .unindent(),
1048 cx,
1049 );
1050
1051 // weird formatting
1052 check_settings_update::<UserSettings>(
1053 &mut store,
1054 r#"{
1055 "user": { "age": 36, "name": "Max", "staff": true }
1056 }"#
1057 .unindent(),
1058 |settings| settings.age = Some(37),
1059 r#"{
1060 "user": { "age": 37, "name": "Max", "staff": true }
1061 }"#
1062 .unindent(),
1063 cx,
1064 );
1065
1066 // single-line formatting, other keys
1067 check_settings_update::<MultiKeySettings>(
1068 &mut store,
1069 r#"{ "one": 1, "two": 2 }"#.unindent(),
1070 |settings| settings.key1 = Some("x".into()),
1071 r#"{ "key1": "x", "one": 1, "two": 2 }"#.unindent(),
1072 cx,
1073 );
1074
1075 // empty object
1076 check_settings_update::<UserSettings>(
1077 &mut store,
1078 r#"{
1079 "user": {}
1080 }"#
1081 .unindent(),
1082 |settings| settings.age = Some(37),
1083 r#"{
1084 "user": {
1085 "age": 37
1086 }
1087 }"#
1088 .unindent(),
1089 cx,
1090 );
1091
1092 // no content
1093 check_settings_update::<UserSettings>(
1094 &mut store,
1095 r#""#.unindent(),
1096 |settings| settings.age = Some(37),
1097 r#"{
1098 "user": {
1099 "age": 37
1100 }
1101 }
1102 "#
1103 .unindent(),
1104 cx,
1105 );
1106 }
1107
1108 fn check_settings_update<T: Setting>(
1109 store: &mut SettingsStore,
1110 old_json: String,
1111 update: fn(&mut T::FileContent),
1112 expected_new_json: String,
1113 cx: &mut AppContext,
1114 ) {
1115 store.set_user_settings(&old_json, cx).ok();
1116 let edits = store.edits_for_update::<T>(&old_json, update);
1117 let mut new_json = old_json;
1118 for (range, replacement) in edits.into_iter() {
1119 new_json.replace_range(range, &replacement);
1120 }
1121 pretty_assertions::assert_eq!(new_json, expected_new_json);
1122 }
1123
1124 #[derive(Debug, PartialEq, Deserialize)]
1125 struct UserSettings {
1126 name: String,
1127 age: u32,
1128 staff: bool,
1129 }
1130
1131 #[derive(Default, Clone, Serialize, Deserialize, JsonSchema)]
1132 struct UserSettingsJson {
1133 name: Option<String>,
1134 age: Option<u32>,
1135 staff: Option<bool>,
1136 }
1137
1138 impl Setting for UserSettings {
1139 const KEY: Option<&'static str> = Some("user");
1140 type FileContent = UserSettingsJson;
1141
1142 fn load(
1143 default_value: &UserSettingsJson,
1144 user_values: &[&UserSettingsJson],
1145 _: &AppContext,
1146 ) -> Result<Self> {
1147 Self::load_via_json_merge(default_value, user_values)
1148 }
1149 }
1150
1151 #[derive(Debug, Deserialize, PartialEq)]
1152 struct TurboSetting(bool);
1153
1154 impl Setting for TurboSetting {
1155 const KEY: Option<&'static str> = Some("turbo");
1156 type FileContent = Option<bool>;
1157
1158 fn load(
1159 default_value: &Option<bool>,
1160 user_values: &[&Option<bool>],
1161 _: &AppContext,
1162 ) -> Result<Self> {
1163 Self::load_via_json_merge(default_value, user_values)
1164 }
1165 }
1166
1167 #[derive(Clone, Debug, PartialEq, Deserialize)]
1168 struct MultiKeySettings {
1169 #[serde(default)]
1170 key1: String,
1171 #[serde(default)]
1172 key2: String,
1173 }
1174
1175 #[derive(Clone, Default, Serialize, Deserialize, JsonSchema)]
1176 struct MultiKeySettingsJson {
1177 key1: Option<String>,
1178 key2: Option<String>,
1179 }
1180
1181 impl Setting for MultiKeySettings {
1182 const KEY: Option<&'static str> = None;
1183
1184 type FileContent = MultiKeySettingsJson;
1185
1186 fn load(
1187 default_value: &MultiKeySettingsJson,
1188 user_values: &[&MultiKeySettingsJson],
1189 _: &AppContext,
1190 ) -> Result<Self> {
1191 Self::load_via_json_merge(default_value, user_values)
1192 }
1193 }
1194
1195 #[derive(Debug, Deserialize)]
1196 struct JournalSettings {
1197 pub path: String,
1198 pub hour_format: HourFormat,
1199 }
1200
1201 #[derive(Clone, Debug, Serialize, Deserialize, JsonSchema)]
1202 #[serde(rename_all = "snake_case")]
1203 enum HourFormat {
1204 Hour12,
1205 Hour24,
1206 }
1207
1208 #[derive(Clone, Default, Debug, Serialize, Deserialize, JsonSchema)]
1209 struct JournalSettingsJson {
1210 pub path: Option<String>,
1211 pub hour_format: Option<HourFormat>,
1212 }
1213
1214 impl Setting for JournalSettings {
1215 const KEY: Option<&'static str> = Some("journal");
1216
1217 type FileContent = JournalSettingsJson;
1218
1219 fn load(
1220 default_value: &JournalSettingsJson,
1221 user_values: &[&JournalSettingsJson],
1222 _: &AppContext,
1223 ) -> Result<Self> {
1224 Self::load_via_json_merge(default_value, user_values)
1225 }
1226 }
1227
1228 #[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
1229 struct LanguageSettings {
1230 #[serde(default)]
1231 languages: HashMap<String, LanguageSettingEntry>,
1232 }
1233
1234 #[derive(Clone, Debug, Serialize, Deserialize, JsonSchema)]
1235 struct LanguageSettingEntry {
1236 is_enabled: bool,
1237 }
1238
1239 impl Setting for LanguageSettings {
1240 const KEY: Option<&'static str> = None;
1241
1242 type FileContent = Self;
1243
1244 fn load(default_value: &Self, user_values: &[&Self], _: &AppContext) -> Result<Self> {
1245 Self::load_via_json_merge(default_value, user_values)
1246 }
1247 }
1248}