Prepare to sync other kinds of settings (#18616)

This PR does not change how things work for settings, but lays the
ground work for the future functionality.
After this change, Zed is prepared to sync more than just
`settings.json` files from local worktree and user config.

* ssh tasks

Part of this work is to streamline the task sync mechanism.
Instead of having an extra set of requests to fetch the task contents
from the server (as remote-via-collab does now and does not cover all
sync cases), we want to reuse the existing mechanism for synchronizing
user and local settings.

* editorconfig

Part of the task is to sync .editorconfig file changes to everyone which
involves sending and storing those configs.


Both ssh (and remove-over-collab) .zed/tasks.json and .editorconfig
files behave similar to .zed/settings.json local files: they belong to a
certain path in a certain worktree; may update over time, changing Zed's
functionality; can be merged hierarchically.
Settings sync follows the same "config file changed -> send to watchers
-> parse and merge locally and on watchers" path that's needed for both
new kinds of files, ergo the messaging layer is extended to send more
types of settings for future watch & parse and merge impls to follow.

Release Notes:

- N/A

crates/collab/migrations.sqlite/20221109000000_test_schema.sql

@@ -112,6 +112,7 @@ CREATE TABLE "worktree_settings_files" (
     "worktree_id" INTEGER NOT NULL,
     "path" VARCHAR NOT NULL,
     "content" TEXT,
+    "kind" VARCHAR,
     PRIMARY KEY(project_id, worktree_id, path),
     FOREIGN KEY(project_id, worktree_id) REFERENCES worktrees (project_id, id) ON DELETE CASCADE
 );

crates/collab/migrations/20241002120231_add_local_settings_kind.sql

@@ -0,0 +1 @@
+ALTER TABLE "worktree_settings_files" ADD COLUMN "kind" VARCHAR;

crates/collab/src/db.rs

@@ -35,6 +35,7 @@ use std::{
 };
 use time::PrimitiveDateTime;
 use tokio::sync::{Mutex, OwnedMutexGuard};
+use worktree_settings_file::LocalSettingsKind;
 
 #[cfg(test)]
 pub use tests::TestDb;
@@ -766,6 +767,7 @@ pub struct Worktree {
 pub struct WorktreeSettingsFile {
     pub path: String,
     pub content: String,
+    pub kind: LocalSettingsKind,
 }
 
 pub struct NewExtensionVersion {
@@ -783,3 +785,21 @@ pub struct ExtensionVersionConstraints {
     pub schema_versions: RangeInclusive<i32>,
     pub wasm_api_versions: RangeInclusive<SemanticVersion>,
 }
+
+impl LocalSettingsKind {
+    pub fn from_proto(proto_kind: proto::LocalSettingsKind) -> Self {
+        match proto_kind {
+            proto::LocalSettingsKind::Settings => Self::Settings,
+            proto::LocalSettingsKind::Tasks => Self::Tasks,
+            proto::LocalSettingsKind::Editorconfig => Self::Editorconfig,
+        }
+    }
+
+    pub fn to_proto(&self) -> proto::LocalSettingsKind {
+        match self {
+            Self::Settings => proto::LocalSettingsKind::Settings,
+            Self::Tasks => proto::LocalSettingsKind::Tasks,
+            Self::Editorconfig => proto::LocalSettingsKind::Editorconfig,
+        }
+    }
+}

crates/collab/src/db/queries/projects.rs

@@ -1,3 +1,4 @@
+use anyhow::Context as _;
 use util::ResultExt;
 
 use super::*;
@@ -527,6 +528,12 @@ impl Database {
         connection: ConnectionId,
     ) -> Result<TransactionGuard<Vec<ConnectionId>>> {
         let project_id = ProjectId::from_proto(update.project_id);
+        let kind = match update.kind {
+            Some(kind) => proto::LocalSettingsKind::from_i32(kind)
+                .with_context(|| format!("unknown worktree settings kind: {kind}"))?,
+            None => proto::LocalSettingsKind::Settings,
+        };
+        let kind = LocalSettingsKind::from_proto(kind);
         self.project_transaction(project_id, |tx| async move {
             // Ensure the update comes from the host.
             let project = project::Entity::find_by_id(project_id)
@@ -543,6 +550,7 @@ impl Database {
                     worktree_id: ActiveValue::Set(update.worktree_id as i64),
                     path: ActiveValue::Set(update.path.clone()),
                     content: ActiveValue::Set(content.clone()),
+                    kind: ActiveValue::Set(kind),
                 })
                 .on_conflict(
                     OnConflict::columns([
@@ -800,6 +808,7 @@ impl Database {
                     worktree.settings_files.push(WorktreeSettingsFile {
                         path: db_settings_file.path,
                         content: db_settings_file.content,
+                        kind: db_settings_file.kind,
                     });
                 }
             }

crates/collab/src/db/queries/rooms.rs

@@ -735,6 +735,7 @@ impl Database {
                     worktree.settings_files.push(WorktreeSettingsFile {
                         path: db_settings_file.path,
                         content: db_settings_file.content,
+                        kind: db_settings_file.kind,
                     });
                 }
             }

crates/collab/src/db/tables/worktree_settings_file.rs

@@ -11,9 +11,25 @@ pub struct Model {
     #[sea_orm(primary_key)]
     pub path: String,
     pub content: String,
+    pub kind: LocalSettingsKind,
 }
 
 #[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
 pub enum Relation {}
 
 impl ActiveModelBehavior for ActiveModel {}
+
+#[derive(
+    Copy, Clone, Debug, PartialEq, Eq, EnumIter, DeriveActiveEnum, Default, Hash, serde::Serialize,
+)]
+#[sea_orm(rs_type = "String", db_type = "String(StringLen::None)")]
+#[serde(rename_all = "snake_case")]
+pub enum LocalSettingsKind {
+    #[default]
+    #[sea_orm(string_value = "settings")]
+    Settings,
+    #[sea_orm(string_value = "tasks")]
+    Tasks,
+    #[sea_orm(string_value = "editorconfig")]
+    Editorconfig,
+}

crates/collab/src/rpc.rs

@@ -1739,6 +1739,7 @@ fn notify_rejoined_projects(
                         worktree_id: worktree.id,
                         path: settings_file.path,
                         content: Some(settings_file.content),
+                        kind: Some(settings_file.kind.to_proto().into()),
                     },
                 )?;
             }
@@ -2220,6 +2221,7 @@ fn join_project_internal(
                     worktree_id: worktree.id,
                     path: settings_file.path,
                     content: Some(settings_file.content),
+                    kind: Some(proto::update_user_settings::Kind::Settings.into()),
                 },
             )?;
         }

crates/collab/src/tests/integration_tests.rs

@@ -33,7 +33,7 @@ use project::{
 };
 use rand::prelude::*;
 use serde_json::json;
-use settings::SettingsStore;
+use settings::{LocalSettingsKind, SettingsStore};
 use std::{
     cell::{Cell, RefCell},
     env, future, mem,
@@ -3327,8 +3327,16 @@ async fn test_local_settings(
                 .local_settings(worktree_b.read(cx).id())
                 .collect::<Vec<_>>(),
             &[
-                (Path::new("").into(), r#"{"tab_size":2}"#.to_string()),
-                (Path::new("a").into(), r#"{"tab_size":8}"#.to_string()),
+                (
+                    Path::new("").into(),
+                    LocalSettingsKind::Settings,
+                    r#"{"tab_size":2}"#.to_string()
+                ),
+                (
+                    Path::new("a").into(),
+                    LocalSettingsKind::Settings,
+                    r#"{"tab_size":8}"#.to_string()
+                ),
             ]
         )
     });
@@ -3346,8 +3354,16 @@ async fn test_local_settings(
                 .local_settings(worktree_b.read(cx).id())
                 .collect::<Vec<_>>(),
             &[
-                (Path::new("").into(), r#"{}"#.to_string()),
-                (Path::new("a").into(), r#"{"tab_size":8}"#.to_string()),
+                (
+                    Path::new("").into(),
+                    LocalSettingsKind::Settings,
+                    r#"{}"#.to_string()
+                ),
+                (
+                    Path::new("a").into(),
+                    LocalSettingsKind::Settings,
+                    r#"{"tab_size":8}"#.to_string()
+                ),
             ]
         )
     });
@@ -3375,8 +3391,16 @@ async fn test_local_settings(
                 .local_settings(worktree_b.read(cx).id())
                 .collect::<Vec<_>>(),
             &[
-                (Path::new("a").into(), r#"{"tab_size":8}"#.to_string()),
-                (Path::new("b").into(), r#"{"tab_size":4}"#.to_string()),
+                (
+                    Path::new("a").into(),
+                    LocalSettingsKind::Settings,
+                    r#"{"tab_size":8}"#.to_string()
+                ),
+                (
+                    Path::new("b").into(),
+                    LocalSettingsKind::Settings,
+                    r#"{"tab_size":4}"#.to_string()
+                ),
             ]
         )
     });
@@ -3406,7 +3430,11 @@ async fn test_local_settings(
             store
                 .local_settings(worktree_b.read(cx).id())
                 .collect::<Vec<_>>(),
-            &[(Path::new("a").into(), r#"{"hard_tabs":true}"#.to_string()),]
+            &[(
+                Path::new("a").into(),
+                LocalSettingsKind::Settings,
+                r#"{"hard_tabs":true}"#.to_string()
+            ),]
         )
     });
 }