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