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