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