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