ZIm/crates/collab
Kirill Bulatov 22473fc611
Stop sending redundant LSP proto requests (#35581)
Before, each time any LSP feature was used on client remote, it always
produced a `proto::` request that always had been sent to the host, from
where returned as an empty response.

Instead, propagate more language server-related data to the client,
`lsp::ServerCapability`, so Zed client can omit certain requests if
those are not supported.

On top of that, rework the approach Zed uses to query for the data
refreshes: before, editors tried to fetch the data when the server start
was reported (locally and remotely).
Now, a later event is selected: on each `textDocument/didOpen` for the
buffer contained in this editor, we will query for new LSP data, reusing
the cache if needed.

Before, servers could reject unregistered files' LSP queries, or process
them slowly when starting up.
Now, such refreshes are happening later and should be cached.

This requires a collab DB change, to restore server data on rejoin.

Release Notes:

- Fixed excessive LSP requests sent during remote sessions
2025-08-05 13:36:05 +00:00
..
k8s collab: Increase max database connections to 250 (#31553) 2025-05-27 16:48:50 -04:00
migrations Stop sending redundant LSP proto requests (#35581) 2025-08-05 13:36:05 +00:00
migrations.sqlite Stop sending redundant LSP proto requests (#35581) 2025-08-05 13:36:05 +00:00
migrations_llm collab: Drop billing_events table (#31131) 2025-05-21 22:43:46 +00:00
seed collab: Seed GitHub users from static data (#18301) 2024-09-24 16:35:09 -04:00
src Stop sending redundant LSP proto requests (#35581) 2025-08-05 13:36:05 +00:00
.env.toml Move git status updates to a background thread #2 (#24722) 2025-02-14 16:47:11 +02:00
Cargo.toml Replace zed_llm_client with cloud_llm_client (#35309) 2025-07-30 00:09:14 +00:00
LICENSE-AGPL chore: Add crate licenses. (#4158) 2024-01-23 16:56:22 +01:00
postgrest_app.conf Add Postgrest to Docker Compose (#16498) 2024-08-19 20:50:45 -04:00
postgrest_llm.conf Add Postgrest to Docker Compose (#16498) 2024-08-19 20:50:45 -04:00
README.md docs: Update mentions to GitHub to use correct capitalization (#31996) 2025-06-03 14:55:24 -03:00
seed.default.json Add more admin to seed script (#34220) 2025-07-10 16:54:00 +00:00

Zed Server

This crate is what we run at https://collab.zed.dev.

It contains our back-end logic for collaboration, to which we connect from the Zed client via a websocket after authenticating via https://zed.dev, which is a separate repo running on Vercel.

Local Development

Database setup

Before you can run the collab server locally, you'll need to set up a zed Postgres database. Follow the steps sequentially:

  1. Ensure you have postgres installed. If not, install with brew install postgresql@15.
  2. Follow the steps on Brew's formula and verify your $PATH contains /opt/homebrew/opt/postgresql@15/bin.
  3. If you hadn't done it before, create the postgres user with createuser -s postgres.
  4. You are now ready to run the bootstrap script:
script/bootstrap

This script will set up the zed Postgres database, and populate it with some users. It requires internet access, because it fetches some users from the GitHub API.

The script will create several admin users, who you'll sign in as by default when developing locally. The GitHub logins for the default users are specified in the seed.default.json file.

To use a different set of admin users, create crates/collab/seed.json.

{
  "admins": ["yourgithubhere"],
  "channels": ["zed"]
}

Testing collaborative features locally

In one terminal, run Zed's collaboration server and the livekit dev server:

foreman start

In a second terminal, run two or more instances of Zed.

script/zed-local -2

This script starts one to four instances of Zed, depending on the -2, -3 or -4 flags. Each instance will be connected to the local collab server, signed in as a different user from seed.json or seed.default.json.

Deployment

We run two instances of collab:

Both of these run on the Kubernetes cluster hosted in Digital Ocean.

Deployment is triggered by pushing to the collab-staging (or collab-production) tag in GitHub. The best way to do this is:

  • ./script/deploy-collab staging
  • ./script/deploy-collab production

You can tell what is currently deployed with ./script/what-is-deployed.

Database Migrations

To create a new migration:

./script/create-migration <name>

Migrations are run automatically on service start, so run foreman start again. The service will crash if the migrations fail.

When you create a new migration, you also need to update the SQLite schema that is used for testing.