Files
zed/crates/session/src/session.rs
T
c96cd3497c Fix shared database test isolation (#51809)
All of the important changes are in
[`db.rs`](https://github.com/zed-industries/zed/pull/51809/changes#diff-2f644eab943bfa58feec29256281a3d9e8d4d7784cd34783e845af8beb15b16d).
Consider reading the commit log in order to review this work.

The DB crate's macro and API was changed to fix flakiness observed in
the MultiWorkspace tests when run locally. This flakiness was caused by
a shared `static LazyLock`, that caused concurrent test runs to interact
with the same underlying in-memory database. This flakiness wasn't
possible on CI due to it's usage of `cargo nextest`, whose
process-per-test approach masked this problem.

Essentially, I've changed the `static_connection` macro to remove the
static database variable and redone the internal model. Now, all
database types are thin wrappers around a generic `AppDatabase`. The
`AppDatabase` collects all of the individual table's migrations via the
`inventory` crate, and so only runs the migrations once on startup,
rather than a dozen times on startup.

The new API requires a `cx` so that we can replace the database returned
at runtime, rather than relying exclusively on a process-global
thread-local. However, we are still using a `static LazyLock` so that we
only need to take an `&App`, instead of an `&mut App`. These databases
types are `Clone + Send + Sync`, so you can easily capture-and-move the
database into background tasks and other places that don't have a `cx`.

For tests that require database isolation, it is now possible to set
their own database in init. See
[`workspace::init_test`](https://github.com/zed-industries/zed/pull/51809/changes#diff-041673bbd1947a35d45945636c0055429dfc8b5985faf93f8a8a960c9ad31e28R13610),
for the flakiness fix.

Best part, this change should be entirely compiler driven, so the Zed
agent was able to make the app-wide refactor easily.

Before you mark this PR as ready for review, make sure that you have:
- [x] Added a solid test coverage and/or screenshots from doing manual
testing
- [x] Done a self-review taking into account security and performance
aspects
- [x] Aligned any UI changes with the [UI
checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist)

Release Notes:

- N/A

---------

Co-authored-by: Anthony Eid <hello@anthonyeid.me>
Co-authored-by: Max Brunsfeld <maxbrunsfeld@gmail.com>
2026-03-18 12:05:57 -07:00

150 lines
4.3 KiB
Rust

use db::kvp::KeyValueStore;
use gpui::{App, AppContext as _, Context, Subscription, Task, WindowId};
use util::ResultExt;
pub struct Session {
session_id: String,
old_session_id: Option<String>,
old_window_ids: Option<Vec<WindowId>>,
}
const SESSION_ID_KEY: &str = "session_id";
const SESSION_WINDOW_STACK_KEY: &str = "session_window_stack";
impl Session {
pub async fn new(session_id: String, db: KeyValueStore) -> Self {
let old_session_id = db.read_kvp(SESSION_ID_KEY).ok().flatten();
db.write_kvp(SESSION_ID_KEY.to_string(), session_id.clone())
.await
.log_err();
let old_window_ids = db
.read_kvp(SESSION_WINDOW_STACK_KEY)
.ok()
.flatten()
.and_then(|json| serde_json::from_str::<Vec<u64>>(&json).ok())
.map(|vec: Vec<u64>| {
vec.into_iter()
.map(WindowId::from)
.collect::<Vec<WindowId>>()
});
Self {
session_id,
old_session_id,
old_window_ids,
}
}
#[cfg(any(test, feature = "test-support"))]
pub fn test() -> Self {
Self {
session_id: uuid::Uuid::new_v4().to_string(),
old_session_id: None,
old_window_ids: None,
}
}
#[cfg(any(test, feature = "test-support"))]
pub fn test_with_old_session(old_session_id: String) -> Self {
Self {
session_id: uuid::Uuid::new_v4().to_string(),
old_session_id: Some(old_session_id),
old_window_ids: None,
}
}
pub fn id(&self) -> &str {
&self.session_id
}
}
pub struct AppSession {
session: Session,
_serialization_task: Task<()>,
_subscriptions: Vec<Subscription>,
}
impl AppSession {
pub fn new(session: Session, cx: &Context<Self>) -> Self {
let _subscriptions = vec![cx.on_app_quit(Self::app_will_quit)];
#[cfg(not(any(test, feature = "test-support")))]
let _serialization_task = {
let db = KeyValueStore::global(cx);
cx.spawn(async move |_, cx| {
// Disabled in tests: the infinite loop bypasses "parking forbidden" checks,
// causing tests to hang instead of panicking.
{
let mut current_window_stack = Vec::new();
loop {
if let Some(windows) = cx.update(|cx| window_stack(cx))
&& windows != current_window_stack
{
store_window_stack(db.clone(), &windows).await;
current_window_stack = windows;
}
cx.background_executor()
.timer(std::time::Duration::from_millis(500))
.await;
}
}
})
};
#[cfg(any(test, feature = "test-support"))]
let _serialization_task = Task::ready(());
Self {
session,
_subscriptions,
_serialization_task,
}
}
fn app_will_quit(&mut self, cx: &mut Context<Self>) -> Task<()> {
if let Some(window_stack) = window_stack(cx) {
let db = KeyValueStore::global(cx);
cx.background_spawn(async move { store_window_stack(db, &window_stack).await })
} else {
Task::ready(())
}
}
pub fn id(&self) -> &str {
self.session.id()
}
pub fn last_session_id(&self) -> Option<&str> {
self.session.old_session_id.as_deref()
}
#[cfg(any(test, feature = "test-support"))]
pub fn replace_session_for_test(&mut self, session: Session) {
self.session = session;
}
pub fn last_session_window_stack(&self) -> Option<Vec<WindowId>> {
self.session.old_window_ids.clone()
}
}
fn window_stack(cx: &App) -> Option<Vec<u64>> {
Some(
cx.window_stack()?
.into_iter()
.map(|window| window.window_id().as_u64())
.collect(),
)
}
async fn store_window_stack(db: KeyValueStore, windows: &[u64]) {
if let Ok(window_ids_json) = serde_json::to_string(windows) {
db.write_kvp(SESSION_WINDOW_STACK_KEY.to_string(), window_ids_json)
.await
.log_err();
}
}