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