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 #[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, source: SchemaObject) {
483 if let Some(source) = source.object {
484 let target_properties = &mut target.object().properties;
485 for (key, value) in source.properties {
486 match target_properties.entry(key) {
487 btree_map::Entry::Vacant(e) => {
488 e.insert(value);
489 }
490 btree_map::Entry::Occupied(e) => {
491 if let (Schema::Object(target), Schema::Object(src)) =
492 (e.into_mut(), value)
493 {
494 merge_schema(target, src);
495 }
496 }
497 }
498 }
499 }
500
501 overwrite(&mut target.instance_type, source.instance_type);
502 overwrite(&mut target.string, source.string);
503 overwrite(&mut target.number, source.number);
504 overwrite(&mut target.reference, source.reference);
505 overwrite(&mut target.array, source.array);
506 overwrite(&mut target.enum_values, source.enum_values);
507
508 fn overwrite<T>(target: &mut Option<T>, source: Option<T>) {
509 if let Some(source) = source {
510 *target = Some(source);
511 }
512 }
513 }
514
515 for release_stage in ["dev", "nightly", "stable", "preview"] {
516 let schema = combined_schema.schema.clone();
517 combined_schema
518 .schema
519 .object()
520 .properties
521 .insert(release_stage.to_string(), schema.into());
522 }
523
524 serde_json::to_value(&combined_schema).unwrap()
525 }
526
527 fn recompute_values(
528 &mut self,
529 changed_local_path: Option<(usize, &Path)>,
530 cx: &mut AppContext,
531 ) -> Result<()> {
532 // Reload the global and local values for every setting.
533 let mut user_settings_stack = Vec::<DeserializedSetting>::new();
534 let mut paths_stack = Vec::<Option<(usize, &Path)>>::new();
535 for setting_value in self.setting_values.values_mut() {
536 let default_settings = setting_value.deserialize_setting(&self.raw_default_settings)?;
537
538 user_settings_stack.clear();
539 paths_stack.clear();
540
541 if let Some(user_settings) = setting_value
542 .deserialize_setting(&self.raw_user_settings)
543 .log_err()
544 {
545 user_settings_stack.push(user_settings);
546 paths_stack.push(None);
547 }
548
549 if let Some(release_settings) = &self
550 .raw_user_settings
551 .get(release_channel::RELEASE_CHANNEL.dev_name())
552 {
553 if let Some(release_settings) = setting_value
554 .deserialize_setting(release_settings)
555 .log_err()
556 {
557 user_settings_stack.push(release_settings);
558 paths_stack.push(None);
559 }
560 }
561
562 // If the global settings file changed, reload the global value for the field.
563 if changed_local_path.is_none() {
564 if let Some(value) = setting_value
565 .load_setting(&default_settings, &user_settings_stack, cx)
566 .log_err()
567 {
568 setting_value.set_global_value(value);
569 }
570 }
571
572 // Reload the local values for the setting.
573 for ((root_id, path), local_settings) in &self.raw_local_settings {
574 // Build a stack of all of the local values for that setting.
575 while let Some(prev_entry) = paths_stack.last() {
576 if let Some((prev_root_id, prev_path)) = prev_entry {
577 if root_id != prev_root_id || !path.starts_with(prev_path) {
578 paths_stack.pop();
579 user_settings_stack.pop();
580 continue;
581 }
582 }
583 break;
584 }
585
586 if let Some(local_settings) =
587 setting_value.deserialize_setting(local_settings).log_err()
588 {
589 paths_stack.push(Some((*root_id, path.as_ref())));
590 user_settings_stack.push(local_settings);
591
592 // If a local settings file changed, then avoid recomputing local
593 // settings for any path outside of that directory.
594 if changed_local_path.map_or(false, |(changed_root_id, changed_local_path)| {
595 *root_id != changed_root_id || !path.starts_with(changed_local_path)
596 }) {
597 continue;
598 }
599
600 if let Some(value) = setting_value
601 .load_setting(&default_settings, &user_settings_stack, cx)
602 .log_err()
603 {
604 setting_value.set_local_value(*root_id, path.clone(), value);
605 }
606 }
607 }
608 }
609 Ok(())
610 }
611}
612
613impl Debug for SettingsStore {
614 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
615 f.debug_struct("SettingsStore")
616 .field(
617 "types",
618 &self
619 .setting_values
620 .values()
621 .map(|value| value.setting_type_name())
622 .collect::<Vec<_>>(),
623 )
624 .field("default_settings", &self.raw_default_settings)
625 .field("user_settings", &self.raw_user_settings)
626 .field("local_settings", &self.raw_local_settings)
627 .finish_non_exhaustive()
628 }
629}
630
631impl<T: Settings> AnySettingValue for SettingValue<T> {
632 fn key(&self) -> Option<&'static str> {
633 T::KEY
634 }
635
636 fn setting_type_name(&self) -> &'static str {
637 type_name::<T>()
638 }
639
640 fn load_setting(
641 &self,
642 default_value: &DeserializedSetting,
643 user_values: &[DeserializedSetting],
644 cx: &mut AppContext,
645 ) -> Result<Box<dyn Any>> {
646 let default_value = default_value.0.downcast_ref::<T::FileContent>().unwrap();
647 let values: SmallVec<[&T::FileContent; 6]> = user_values
648 .iter()
649 .map(|value| value.0.downcast_ref().unwrap())
650 .collect();
651 Ok(Box::new(T::load(default_value, &values, cx)?))
652 }
653
654 fn deserialize_setting(&self, mut json: &serde_json::Value) -> Result<DeserializedSetting> {
655 if let Some(key) = T::KEY {
656 if let Some(value) = json.get(key) {
657 json = value;
658 } else {
659 let value = T::FileContent::default();
660 return Ok(DeserializedSetting(Box::new(value)));
661 }
662 }
663 let value = T::FileContent::deserialize(json)?;
664 Ok(DeserializedSetting(Box::new(value)))
665 }
666
667 fn value_for_path(&self, path: Option<SettingsLocation>) -> &dyn Any {
668 if let Some(SettingsLocation { worktree_id, path }) = path {
669 for (settings_root_id, settings_path, value) in self.local_values.iter().rev() {
670 if worktree_id == *settings_root_id && path.starts_with(settings_path) {
671 return value;
672 }
673 }
674 }
675 self.global_value
676 .as_ref()
677 .unwrap_or_else(|| panic!("no default value for setting {}", self.setting_type_name()))
678 }
679
680 fn set_global_value(&mut self, value: Box<dyn Any>) {
681 self.global_value = Some(*value.downcast().unwrap());
682 }
683
684 fn set_local_value(&mut self, root_id: usize, path: Arc<Path>, value: Box<dyn Any>) {
685 let value = *value.downcast().unwrap();
686 match self
687 .local_values
688 .binary_search_by_key(&(root_id, &path), |e| (e.0, &e.1))
689 {
690 Ok(ix) => self.local_values[ix].2 = value,
691 Err(ix) => self.local_values.insert(ix, (root_id, path, value)),
692 }
693 }
694
695 fn json_schema(
696 &self,
697 generator: &mut SchemaGenerator,
698 params: &SettingsJsonSchemaParams,
699 cx: &AppContext,
700 ) -> RootSchema {
701 T::json_schema(generator, params, cx)
702 }
703}
704
705fn update_value_in_json_text<'a>(
706 text: &mut String,
707 key_path: &mut Vec<&'a str>,
708 tab_size: usize,
709 old_value: &'a serde_json::Value,
710 new_value: &'a serde_json::Value,
711 edits: &mut Vec<(Range<usize>, String)>,
712) {
713 // If the old and new values are both objects, then compare them key by key,
714 // preserving the comments and formatting of the unchanged parts. Otherwise,
715 // replace the old value with the new value.
716 if let (serde_json::Value::Object(old_object), serde_json::Value::Object(new_object)) =
717 (old_value, new_value)
718 {
719 for (key, old_sub_value) in old_object.iter() {
720 key_path.push(key);
721 let new_sub_value = new_object.get(key).unwrap_or(&serde_json::Value::Null);
722 update_value_in_json_text(
723 text,
724 key_path,
725 tab_size,
726 old_sub_value,
727 new_sub_value,
728 edits,
729 );
730 key_path.pop();
731 }
732 for (key, new_sub_value) in new_object.iter() {
733 key_path.push(key);
734 if !old_object.contains_key(key) {
735 update_value_in_json_text(
736 text,
737 key_path,
738 tab_size,
739 &serde_json::Value::Null,
740 new_sub_value,
741 edits,
742 );
743 }
744 key_path.pop();
745 }
746 } else if old_value != new_value {
747 let mut new_value = new_value.clone();
748 if let Some(new_object) = new_value.as_object_mut() {
749 new_object.retain(|_, v| !v.is_null());
750 }
751 let (range, replacement) = replace_value_in_json_text(text, key_path, tab_size, &new_value);
752 text.replace_range(range.clone(), &replacement);
753 edits.push((range, replacement));
754 }
755}
756
757fn replace_value_in_json_text(
758 text: &str,
759 key_path: &[&str],
760 tab_size: usize,
761 new_value: &serde_json::Value,
762) -> (Range<usize>, String) {
763 const LANGUAGE_OVERRIDES: &str = "language_overrides";
764 const LANGUAGES: &str = "languages";
765
766 lazy_static! {
767 static ref PAIR_QUERY: tree_sitter::Query = tree_sitter::Query::new(
768 &tree_sitter_json::language(),
769 "(pair key: (string) @key value: (_) @value)",
770 )
771 .unwrap();
772 }
773
774 let mut parser = tree_sitter::Parser::new();
775 parser.set_language(&tree_sitter_json::language()).unwrap();
776 let syntax_tree = parser.parse(text, None).unwrap();
777
778 let mut cursor = tree_sitter::QueryCursor::new();
779
780 let has_language_overrides = text.contains(LANGUAGE_OVERRIDES);
781
782 let mut depth = 0;
783 let mut last_value_range = 0..0;
784 let mut first_key_start = None;
785 let mut existing_value_range = 0..text.len();
786 let matches = cursor.matches(&PAIR_QUERY, syntax_tree.root_node(), text.as_bytes());
787 for mat in matches {
788 if mat.captures.len() != 2 {
789 continue;
790 }
791
792 let key_range = mat.captures[0].node.byte_range();
793 let value_range = mat.captures[1].node.byte_range();
794
795 // Don't enter sub objects until we find an exact
796 // match for the current keypath
797 if last_value_range.contains_inclusive(&value_range) {
798 continue;
799 }
800
801 last_value_range = value_range.clone();
802
803 if key_range.start > existing_value_range.end {
804 break;
805 }
806
807 first_key_start.get_or_insert(key_range.start);
808
809 let found_key = text
810 .get(key_range.clone())
811 .map(|key_text| {
812 if key_path[depth] == LANGUAGES && has_language_overrides {
813 key_text == format!("\"{}\"", LANGUAGE_OVERRIDES)
814 } else {
815 key_text == format!("\"{}\"", key_path[depth])
816 }
817 })
818 .unwrap_or(false);
819
820 if found_key {
821 existing_value_range = value_range;
822 // Reset last value range when increasing in depth
823 last_value_range = existing_value_range.start..existing_value_range.start;
824 depth += 1;
825
826 if depth == key_path.len() {
827 break;
828 }
829
830 first_key_start = None;
831 }
832 }
833
834 // We found the exact key we want, insert the new value
835 if depth == key_path.len() {
836 let new_val = to_pretty_json(&new_value, tab_size, tab_size * depth);
837 (existing_value_range, new_val)
838 } else {
839 // We have key paths, construct the sub objects
840 let new_key = if has_language_overrides && key_path[depth] == LANGUAGES {
841 LANGUAGE_OVERRIDES
842 } else {
843 key_path[depth]
844 };
845
846 // We don't have the key, construct the nested objects
847 let mut new_value = serde_json::to_value(new_value).unwrap();
848 for key in key_path[(depth + 1)..].iter().rev() {
849 if has_language_overrides && key == &LANGUAGES {
850 new_value = serde_json::json!({ LANGUAGE_OVERRIDES.to_string(): new_value });
851 } else {
852 new_value = serde_json::json!({ key.to_string(): new_value });
853 }
854 }
855
856 if let Some(first_key_start) = first_key_start {
857 let mut row = 0;
858 let mut column = 0;
859 for (ix, char) in text.char_indices() {
860 if ix == first_key_start {
861 break;
862 }
863 if char == '\n' {
864 row += 1;
865 column = 0;
866 } else {
867 column += char.len_utf8();
868 }
869 }
870
871 if row > 0 {
872 // depth is 0 based, but division needs to be 1 based.
873 let new_val = to_pretty_json(&new_value, column / (depth + 1), column);
874 let space = ' ';
875 let content = format!("\"{new_key}\": {new_val},\n{space:width$}", width = column);
876 (first_key_start..first_key_start, content)
877 } else {
878 let new_val = serde_json::to_string(&new_value).unwrap();
879 let mut content = format!(r#""{new_key}": {new_val},"#);
880 content.push(' ');
881 (first_key_start..first_key_start, content)
882 }
883 } else {
884 new_value = serde_json::json!({ new_key.to_string(): new_value });
885 let indent_prefix_len = 4 * depth;
886 let mut new_val = to_pretty_json(&new_value, 4, indent_prefix_len);
887 if depth == 0 {
888 new_val.push('\n');
889 }
890
891 (existing_value_range, new_val)
892 }
893 }
894}
895
896fn to_pretty_json(value: &impl Serialize, indent_size: usize, indent_prefix_len: usize) -> String {
897 const SPACES: [u8; 32] = [b' '; 32];
898
899 debug_assert!(indent_size <= SPACES.len());
900 debug_assert!(indent_prefix_len <= SPACES.len());
901
902 let mut output = Vec::new();
903 let mut ser = serde_json::Serializer::with_formatter(
904 &mut output,
905 serde_json::ser::PrettyFormatter::with_indent(&SPACES[0..indent_size.min(SPACES.len())]),
906 );
907
908 value.serialize(&mut ser).unwrap();
909 let text = String::from_utf8(output).unwrap();
910
911 let mut adjusted_text = String::new();
912 for (i, line) in text.split('\n').enumerate() {
913 if i > 0 {
914 adjusted_text.push_str(str::from_utf8(&SPACES[0..indent_prefix_len]).unwrap());
915 }
916 adjusted_text.push_str(line);
917 adjusted_text.push('\n');
918 }
919 adjusted_text.pop();
920 adjusted_text
921}
922
923pub fn parse_json_with_comments<T: DeserializeOwned>(content: &str) -> Result<T> {
924 Ok(serde_json_lenient::from_str(content)?)
925}
926
927#[cfg(test)]
928mod tests {
929 use super::*;
930 use serde_derive::Deserialize;
931 use unindent::Unindent;
932
933 #[gpui::test]
934 fn test_settings_store_basic(cx: &mut AppContext) {
935 let mut store = SettingsStore::default();
936 store.register_setting::<UserSettings>(cx);
937 store.register_setting::<TurboSetting>(cx);
938 store.register_setting::<MultiKeySettings>(cx);
939 store
940 .set_default_settings(
941 r#"{
942 "turbo": false,
943 "user": {
944 "name": "John Doe",
945 "age": 30,
946 "staff": false
947 }
948 }"#,
949 cx,
950 )
951 .unwrap();
952
953 assert_eq!(store.get::<TurboSetting>(None), &TurboSetting(false));
954 assert_eq!(
955 store.get::<UserSettings>(None),
956 &UserSettings {
957 name: "John Doe".to_string(),
958 age: 30,
959 staff: false,
960 }
961 );
962 assert_eq!(
963 store.get::<MultiKeySettings>(None),
964 &MultiKeySettings {
965 key1: String::new(),
966 key2: String::new(),
967 }
968 );
969
970 store
971 .set_user_settings(
972 r#"{
973 "turbo": true,
974 "user": { "age": 31 },
975 "key1": "a"
976 }"#,
977 cx,
978 )
979 .unwrap();
980
981 assert_eq!(store.get::<TurboSetting>(None), &TurboSetting(true));
982 assert_eq!(
983 store.get::<UserSettings>(None),
984 &UserSettings {
985 name: "John Doe".to_string(),
986 age: 31,
987 staff: false
988 }
989 );
990
991 store
992 .set_local_settings(
993 1,
994 Path::new("/root1").into(),
995 Some(r#"{ "user": { "staff": true } }"#),
996 cx,
997 )
998 .unwrap();
999 store
1000 .set_local_settings(
1001 1,
1002 Path::new("/root1/subdir").into(),
1003 Some(r#"{ "user": { "name": "Jane Doe" } }"#),
1004 cx,
1005 )
1006 .unwrap();
1007
1008 store
1009 .set_local_settings(
1010 1,
1011 Path::new("/root2").into(),
1012 Some(r#"{ "user": { "age": 42 }, "key2": "b" }"#),
1013 cx,
1014 )
1015 .unwrap();
1016
1017 assert_eq!(
1018 store.get::<UserSettings>(Some(SettingsLocation {
1019 worktree_id: 1,
1020 path: Path::new("/root1/something"),
1021 })),
1022 &UserSettings {
1023 name: "John Doe".to_string(),
1024 age: 31,
1025 staff: true
1026 }
1027 );
1028 assert_eq!(
1029 store.get::<UserSettings>(Some(SettingsLocation {
1030 worktree_id: 1,
1031 path: Path::new("/root1/subdir/something")
1032 })),
1033 &UserSettings {
1034 name: "Jane Doe".to_string(),
1035 age: 31,
1036 staff: true
1037 }
1038 );
1039 assert_eq!(
1040 store.get::<UserSettings>(Some(SettingsLocation {
1041 worktree_id: 1,
1042 path: Path::new("/root2/something")
1043 })),
1044 &UserSettings {
1045 name: "John Doe".to_string(),
1046 age: 42,
1047 staff: false
1048 }
1049 );
1050 assert_eq!(
1051 store.get::<MultiKeySettings>(Some(SettingsLocation {
1052 worktree_id: 1,
1053 path: Path::new("/root2/something")
1054 })),
1055 &MultiKeySettings {
1056 key1: "a".to_string(),
1057 key2: "b".to_string(),
1058 }
1059 );
1060 }
1061
1062 #[gpui::test]
1063 fn test_setting_store_assign_json_before_register(cx: &mut AppContext) {
1064 let mut store = SettingsStore::default();
1065 store
1066 .set_default_settings(
1067 r#"{
1068 "turbo": true,
1069 "user": {
1070 "name": "John Doe",
1071 "age": 30,
1072 "staff": false
1073 },
1074 "key1": "x"
1075 }"#,
1076 cx,
1077 )
1078 .unwrap();
1079 store
1080 .set_user_settings(r#"{ "turbo": false }"#, cx)
1081 .unwrap();
1082 store.register_setting::<UserSettings>(cx);
1083 store.register_setting::<TurboSetting>(cx);
1084
1085 assert_eq!(store.get::<TurboSetting>(None), &TurboSetting(false));
1086 assert_eq!(
1087 store.get::<UserSettings>(None),
1088 &UserSettings {
1089 name: "John Doe".to_string(),
1090 age: 30,
1091 staff: false,
1092 }
1093 );
1094
1095 store.register_setting::<MultiKeySettings>(cx);
1096 assert_eq!(
1097 store.get::<MultiKeySettings>(None),
1098 &MultiKeySettings {
1099 key1: "x".into(),
1100 key2: String::new(),
1101 }
1102 );
1103 }
1104
1105 #[gpui::test]
1106 fn test_setting_store_update(cx: &mut AppContext) {
1107 let mut store = SettingsStore::default();
1108 store.register_setting::<MultiKeySettings>(cx);
1109 store.register_setting::<UserSettings>(cx);
1110 store.register_setting::<LanguageSettings>(cx);
1111
1112 // entries added and updated
1113 check_settings_update::<LanguageSettings>(
1114 &mut store,
1115 r#"{
1116 "languages": {
1117 "JSON": {
1118 "language_setting_1": true
1119 }
1120 }
1121 }"#
1122 .unindent(),
1123 |settings| {
1124 settings
1125 .languages
1126 .get_mut("JSON")
1127 .unwrap()
1128 .language_setting_1 = Some(false);
1129 settings.languages.insert(
1130 "Rust".into(),
1131 LanguageSettingEntry {
1132 language_setting_2: Some(true),
1133 ..Default::default()
1134 },
1135 );
1136 },
1137 r#"{
1138 "languages": {
1139 "Rust": {
1140 "language_setting_2": true
1141 },
1142 "JSON": {
1143 "language_setting_1": false
1144 }
1145 }
1146 }"#
1147 .unindent(),
1148 cx,
1149 );
1150
1151 // weird formatting
1152 check_settings_update::<UserSettings>(
1153 &mut store,
1154 r#"{
1155 "user": { "age": 36, "name": "Max", "staff": true }
1156 }"#
1157 .unindent(),
1158 |settings| settings.age = Some(37),
1159 r#"{
1160 "user": { "age": 37, "name": "Max", "staff": true }
1161 }"#
1162 .unindent(),
1163 cx,
1164 );
1165
1166 // single-line formatting, other keys
1167 check_settings_update::<MultiKeySettings>(
1168 &mut store,
1169 r#"{ "one": 1, "two": 2 }"#.unindent(),
1170 |settings| settings.key1 = Some("x".into()),
1171 r#"{ "key1": "x", "one": 1, "two": 2 }"#.unindent(),
1172 cx,
1173 );
1174
1175 // empty object
1176 check_settings_update::<UserSettings>(
1177 &mut store,
1178 r#"{
1179 "user": {}
1180 }"#
1181 .unindent(),
1182 |settings| settings.age = Some(37),
1183 r#"{
1184 "user": {
1185 "age": 37
1186 }
1187 }"#
1188 .unindent(),
1189 cx,
1190 );
1191
1192 // no content
1193 check_settings_update::<UserSettings>(
1194 &mut store,
1195 r#""#.unindent(),
1196 |settings| settings.age = Some(37),
1197 r#"{
1198 "user": {
1199 "age": 37
1200 }
1201 }
1202 "#
1203 .unindent(),
1204 cx,
1205 );
1206
1207 check_settings_update::<UserSettings>(
1208 &mut store,
1209 r#"{
1210 }
1211 "#
1212 .unindent(),
1213 |settings| settings.age = Some(37),
1214 r#"{
1215 "user": {
1216 "age": 37
1217 }
1218 }
1219 "#
1220 .unindent(),
1221 cx,
1222 );
1223 }
1224
1225 fn check_settings_update<T: Settings>(
1226 store: &mut SettingsStore,
1227 old_json: String,
1228 update: fn(&mut T::FileContent),
1229 expected_new_json: String,
1230 cx: &mut AppContext,
1231 ) {
1232 store.set_user_settings(&old_json, cx).ok();
1233 let edits = store.edits_for_update::<T>(&old_json, update);
1234 let mut new_json = old_json;
1235 for (range, replacement) in edits.into_iter() {
1236 new_json.replace_range(range, &replacement);
1237 }
1238 pretty_assertions::assert_eq!(new_json, expected_new_json);
1239 }
1240
1241 #[derive(Debug, PartialEq, Deserialize)]
1242 struct UserSettings {
1243 name: String,
1244 age: u32,
1245 staff: bool,
1246 }
1247
1248 #[derive(Default, Clone, Serialize, Deserialize, JsonSchema)]
1249 struct UserSettingsJson {
1250 name: Option<String>,
1251 age: Option<u32>,
1252 staff: Option<bool>,
1253 }
1254
1255 impl Settings for UserSettings {
1256 const KEY: Option<&'static str> = Some("user");
1257 type FileContent = UserSettingsJson;
1258
1259 fn load(
1260 default_value: &UserSettingsJson,
1261 user_values: &[&UserSettingsJson],
1262 _: &mut AppContext,
1263 ) -> Result<Self> {
1264 Self::load_via_json_merge(default_value, user_values)
1265 }
1266 }
1267
1268 #[derive(Debug, Deserialize, PartialEq)]
1269 struct TurboSetting(bool);
1270
1271 impl Settings for TurboSetting {
1272 const KEY: Option<&'static str> = Some("turbo");
1273 type FileContent = Option<bool>;
1274
1275 fn load(
1276 default_value: &Option<bool>,
1277 user_values: &[&Option<bool>],
1278 _: &mut AppContext,
1279 ) -> Result<Self> {
1280 Self::load_via_json_merge(default_value, user_values)
1281 }
1282 }
1283
1284 #[derive(Clone, Debug, PartialEq, Deserialize)]
1285 struct MultiKeySettings {
1286 #[serde(default)]
1287 key1: String,
1288 #[serde(default)]
1289 key2: String,
1290 }
1291
1292 #[derive(Clone, Default, Serialize, Deserialize, JsonSchema)]
1293 struct MultiKeySettingsJson {
1294 key1: Option<String>,
1295 key2: Option<String>,
1296 }
1297
1298 impl Settings for MultiKeySettings {
1299 const KEY: Option<&'static str> = None;
1300
1301 type FileContent = MultiKeySettingsJson;
1302
1303 fn load(
1304 default_value: &MultiKeySettingsJson,
1305 user_values: &[&MultiKeySettingsJson],
1306 _: &mut AppContext,
1307 ) -> Result<Self> {
1308 Self::load_via_json_merge(default_value, user_values)
1309 }
1310 }
1311
1312 #[derive(Debug, Deserialize)]
1313 struct JournalSettings {
1314 pub path: String,
1315 pub hour_format: HourFormat,
1316 }
1317
1318 #[derive(Clone, Debug, Serialize, Deserialize, JsonSchema)]
1319 #[serde(rename_all = "snake_case")]
1320 enum HourFormat {
1321 Hour12,
1322 Hour24,
1323 }
1324
1325 #[derive(Clone, Default, Debug, Serialize, Deserialize, JsonSchema)]
1326 struct JournalSettingsJson {
1327 pub path: Option<String>,
1328 pub hour_format: Option<HourFormat>,
1329 }
1330
1331 impl Settings for JournalSettings {
1332 const KEY: Option<&'static str> = Some("journal");
1333
1334 type FileContent = JournalSettingsJson;
1335
1336 fn load(
1337 default_value: &JournalSettingsJson,
1338 user_values: &[&JournalSettingsJson],
1339 _: &mut AppContext,
1340 ) -> Result<Self> {
1341 Self::load_via_json_merge(default_value, user_values)
1342 }
1343 }
1344
1345 #[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
1346 struct LanguageSettings {
1347 #[serde(default)]
1348 languages: HashMap<String, LanguageSettingEntry>,
1349 }
1350
1351 #[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
1352 struct LanguageSettingEntry {
1353 language_setting_1: Option<bool>,
1354 language_setting_2: Option<bool>,
1355 }
1356
1357 impl Settings for LanguageSettings {
1358 const KEY: Option<&'static str> = None;
1359
1360 type FileContent = Self;
1361
1362 fn load(default_value: &Self, user_values: &[&Self], _: &mut AppContext) -> Result<Self> {
1363 Self::load_via_json_merge(default_value, user_values)
1364 }
1365 }
1366}