dumbgoy/soulseek-rs-modded
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

feat(daemon): make every window a view of one shared session

Browse Source 
Two TUIs on one daemon behaved as two separate windows that happened to share
a login: each showed only the transfers it had queued and the searches it had
run, and neither said it was attached to anything.

The status bar now names the daemon, and both lists are views of the session:
transfers and searches appear in every window, dismissing one dismisses it
everywhere, and a window opened later starts from what is already running
rather than blank. message read likewise starts from the conversation the
daemon collected instead of only what arrives while it runs.

Search state needed the daemon to say when a query went out. The window a
search collects for belongs to whichever client started it, so without that
every other window showed a running search as finished the moment it appeared
— which is what it did. The summary carries a file count too, so a window has
the right number before it has pulled the results across.

Adds Client::forget_search, which the library had no way to do: a resident
client otherwise holds every result set it has ever seen, and a window that
dismissed a search had no way to say so.

A review of the first cut found five defects, all fixed here and all covered:
syncing ran locally too, where it cost a full copy of every result set per
frame and deleted the completed-download history restored from disk; a
transfer could be listed twice by racing its own registration; clearing all
searches did not reach the session, so every row came back; a search dismissed
elsewhere never left; and a wishlist search reported as finished the instant
it went out.
This commit is contained in:
Michel de Graaf
2026-07-27 20:58:49 +02:00
parent 220beb4e41
commit 011eafaa7f
22 changed files with 900 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7
View File
@@ -158,6 +158,13 @@ soulseek-rs daemon status # who it is, what it shares, who is attached
soulseek-rs daemon stop
```
Every window is a view of the same session, not a session of its own. Open a
second TUI and it shows the searches and transfers already running, including
ones the first started; queue something in either and both see it. The status
bar names the daemon it is attached to, so it is obvious which you are looking
at. Closing a window leaves its downloads running, because they belong to the
daemon.
Everything that touches the network goes through it. `config`, `skills`,
`completions` and `portmap` stay local, because they are about this machine
rather than a session. `shares add`/`remove` do both: they write the config
docs/openrpc.json
+73
View File
@@ -787,6 +787,47 @@
],
"type": "object"
},
"SearchSummary": {
"description": "One search as the daemon sees it, for a client that did not run it.",
"properties": {
"files": {
"description": "Files found so far, across every peer that has answered.",
"format": "uint",
"minimum": 0,
"type": "integer"
},
"query": {
"type": "string"
},
"started_secs_ago": {
"description": "How long ago the query went out. A client compares this with its own\nsearch window to decide whether the search is still collecting.",
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"query",
"files",
"started_secs_ago"
],
"type": "object"
},
"Searches": {
"description": "Every search this session has run, newest last. Shared by all clients, so\na second one attaching sees what the first has been looking for.",
"properties": {
"searches": {
"items": {
"$ref": "#/components/schemas/SearchSummary"
},
"type": "array"
}
},
"required": [
"searches"
],
"type": "object"
},
"Seconds": {
"properties": {
"seconds": {
@@ -1285,6 +1326,38 @@
},
"summary": "Everything that has answered a search so far."
},
{
"name": "search.list",
"paramStructure": "by-name",
"params": [],
"result": {
"name": "result",
"schema": {
"$ref": "#/components/schemas/Searches"
}
},
"summary": "Every search this session has run, shared by all clients."
},
{
"name": "search.forget",
"paramStructure": "by-name",
"params": [
{
"name": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"result": {
"name": "result",
"schema": {
"$ref": "#/components/schemas/Ack"
}
},
"summary": "Drop a search and its results, for every client at once."
},
{
"name": "search.wishlist",
"paramStructure": "by-name",
soulseek-rs-lib/src/client/search.rs
+12
View File
@@ -137,6 +137,18 @@ impl Client {
})
}
/// Drop a search and everything it collected.
///
/// Returns whether there was one to drop. A client that stays up for days
/// would otherwise hold every result set it has ever seen, and a caller
/// that has dismissed a search has no other way to say so.
#[must_use]
pub fn forget_search(&self, search_key: &str) -> bool {
self.context
.write_safe()
.is_ok_and(|mut ctx| ctx.searches.remove(search_key).is_some())
}
#[must_use]
pub fn get_all_searches(&self) -> HashMap<String, Search> {
self.context
soulseek-rs/src/SKILL.md
+36 -10
View File
@@ -159,6 +159,11 @@ While it runs, every other command on this machine uses its session
automatically, with no flags, no credentials, and no second login.
`--bind ADDR` also accepts connections from other machines, which need the
token.
State lives in the daemon, so every client reads the same thing: `search` sees
searches any client ran, the transfer queue is shared, and `message read`
starts from the conversation the daemon already collected rather than only
what arrives while it runs.
**`daemon status`** — one object: `user`, `server`, `version`, `protocol`,
`listening`, `listen_port`, `shared_folders`, `shared_files`, `download_dir`,
`session_loss`, `clients`, `uptime_secs`. Exit 3 when nothing is running.
@@ -217,21 +222,42 @@ soulseek-rs user someuser --json
`download --stdin` reads whole records, so filtering with `jq` and piping back
is the normal way to be selective.
## Running several at once
## Several tracks at once
With a daemon running this needs no thought. They all share its one session:
Asked for a list of tracks (an album, a playlist, "these ten songs"), **give
each track its own subagent**, and run **at most ten at a time**. One subagent
searches for its track, judges the candidates, downloads the one it picked, and
reports back.
**Report as you go, not only at the end.** Each subagent tells the main agent
when its search has found candidates and again when its download completes, so
progress is visible while the rest are still working. A batch that reports only
once everything is finished looks indistinguishable from a batch that is stuck.
One short line each is enough: what it searched for, what it picked and why,
where the file landed, or which of the exit codes it hit and what that means
for that track.
Do this rather than writing a shell script that loops. Picking a file is a
judgement call every time: bitrate against file size, a peer with a free slot
against a faster one, the right pressing against a live bootleg with the same
name. A loop cannot make that call, so it either takes the first hit or needs
you to encode rules you would rather apply case by case. A subagent per track
also means one failure is one track, not a dead pipeline, and each comes back
with a sentence you can pass on.
Ten at once, not more. Every peer you queue behind is someone's home machine,
and the searches all share the daemon's one session.
```bash
for q in 'gary beck fold' 'marcal steady'; do
soulseek-rs search "$q" --json &
done
wait
# What each subagent runs for its own track:
soulseek-rs search 'gary beck fold' --json # look
soulseek-rs get 'gary beck fold' --json # or search, pick and fetch in one
```
Without one, the same loop is a bug: the runs share a username, so each login
displaces the last and they kill each other's session (exit 7). Giving each run
its own `--username` avoids the collision by registering a fresh account on the
server for every search, which is worse. Do not do it. Start the daemon.
This works because the daemon holds the session: ten subagents at once are ten
commands sharing one login. Without a daemon they would displace each
other (exit 7), and giving each its own `--username` would register a throwaway
account per track, which is worse. Start the daemon first.
The listener port needs no care either way: a run that finds the configured
port taken binds a free one and tells the server about that one instead.
soulseek-rs/src/api.rs
+47
View File
@@ -23,6 +23,23 @@ use std::sync::atomic::AtomicBool;
use std::sync::mpsc::Receiver;
use std::time::Duration;
/// What a session knows about one search it has run.
///
/// `started_secs_ago` is what lets a second window tell a search that is still
/// collecting from one that has finished: the collecting window is the
/// client's, so without the daemon saying when a search began, every window
/// but the one that started it would show the result as final immediately.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SessionSearch {
pub query: String,
/// Files found so far, across every peer that has answered.
pub files: usize,
/// How long ago the search went out, or `None` when the session cannot
/// say — which is the local case, where the window that ran it already
/// knows.
pub started_secs_ago: Option<u64>,
}
/// Everything the command layer and the TUI ask of a logged-in session.
///
/// Two rules keep the remote implementation honest:
@@ -36,6 +53,11 @@ use std::time::Duration;
/// local mirror.
pub trait SessionApi: Send + Sync {
fn username(&self) -> String;
/// The daemon this session is borrowed from, for the UI to name. `None`
/// when the session belongs to this process.
fn daemon_endpoint(&self) -> Option<String> {
None
}
fn listen_port(&self) -> Option<u16>;
fn session_loss(&self) -> Option<SessionLoss>;
@@ -56,6 +78,14 @@ pub trait SessionApi: Send + Sync {
cancel: Option<Arc<AtomicBool>>,
) -> Result<Vec<SearchResult>>;
fn get_search_results(&self, key: &str) -> Vec<SearchResult>;
/// Every search the session knows about.
///
/// Daemon-side this is shared, so a second client sees what the first has
/// been searching for rather than starting from a blank list.
fn all_searches(&self) -> Vec<SessionSearch>;
/// Drop a search from the session, so every window loses it rather than
/// only the one that dismissed it.
fn forget_search(&self, query: &str) -> bool;
fn get_search_results_count(&self, key: &str) -> usize;
fn try_get_search_results(&self, key: &str) -> Option<Vec<SearchResult>>;
fn start_wishlist_search(&self, query: &str) -> Result<()>;
@@ -152,6 +182,23 @@ impl SessionApi for Client {
Self::get_search_results(self, key)
}
fn forget_search(&self, query: &str) -> bool {
Self::forget_search(self, query)
}
fn all_searches(&self) -> Vec<SessionSearch> {
Self::get_all_searches(self)
.into_iter()
.map(|(query, search)| SessionSearch {
query,
files: search.results.iter().map(|r| r.files.len()).sum(),
// A local window started every search it can see, so it
// already knows which are still running.
started_secs_ago: None,
})
.collect()
}
fn get_search_results_count(&self, key: &str) -> usize {
Self::get_search_results_count(self, key)
}
soulseek-rs/src/commands/social.rs
+16
View File
@@ -261,6 +261,22 @@ pub fn message_send(ctx: &Ctx, user: &str, message: &str) -> CliResult {
pub fn message_read(ctx: &Ctx, span: Option<Duration>) -> CliResult {
let session = Session::open(ctx)?;
// What the session already holds comes first. A daemon has been collecting
// the whole time it has been up, including while nothing was reading, so
// starting from the next arrival would silently skip everything said so
// far. A session of our own knows nothing yet, so this is empty and the
// command behaves as it always did.
for message in session.client.message_history() {
if message.outgoing {
continue;
}
ctx.out.emit(&PrivateMessageRecord {
timestamp: u32::try_from(message.at).unwrap_or(0),
user: message.peer,
message: message.text,
});
}
stream(&ctx.out, "reading private messages", span, || {
for message in session.client.take_private_messages() {
ctx.out.emit(&PrivateMessageRecord {
soulseek-rs/src/daemon/mod.rs
+1
View File
@@ -228,6 +228,7 @@ pub fn run(
stop: Arc::clone(&stop),
open: Arc::new(std::sync::atomic::AtomicUsize::new(0)),
rooms: Mutex::new(rooms),
searches: Mutex::new(std::collections::HashMap::new()),
});
let drainer = {
soulseek-rs/src/daemon/openrpc.rs
+14 -4
View File
@@ -12,9 +12,9 @@ use super::proto::{
Ack, AuthParams, AuthResult, BrowseEvent, DaemonStatus, DirectoriesParams,
DownloadStartParams, DownloadStarted, DownloadStatusEvent, Downloads,
Event, IntervalSeconds, Members, MessageParams, Messages, Method,
QueryParams, RoomEventDto, RoomRef, SayParams, SearchResults, Seconds,
SessionLossEvent, SharesStatus, SlotsParams, TransferRef, UploadInfoDto,
Uploads, UserMessageDto, UserRef, UserResult,
QueryParams, RoomEventDto, RoomRef, SayParams, SearchResults, Searches,
Seconds, SessionLossEvent, SharesStatus, SlotsParams, TransferRef,
UploadInfoDto, Uploads, UserMessageDto, UserRef, UserResult,
};
use schemars::{JsonSchema, SchemaGenerator, generate::SchemaSettings};
use serde_json::{Value, json};
@@ -41,7 +41,8 @@ fn params_schema(method: Method, generator: &mut SchemaGenerator) -> Value {
Method::Auth => schema_of::<AuthParams>(generator),
Method::SearchStart
| Method::SearchResults
| Method::SearchWishlist => schema_of::<QueryParams>(generator),
| Method::SearchWishlist
| Method::SearchForget => schema_of::<QueryParams>(generator),
Method::DownloadStart => schema_of::<DownloadStartParams>(generator),
Method::DownloadPause
| Method::DownloadResume
@@ -68,6 +69,7 @@ fn params_schema(method: Method, generator: &mut SchemaGenerator) -> Value {
| Method::PrivilegesOwn
| Method::RoomListRequest
| Method::MessageHistory
| Method::SearchList
| Method::SharesStatusOf
| Method::SharesReindex => nothing(),
}
@@ -80,6 +82,7 @@ fn result_schema(method: Method, generator: &mut SchemaGenerator) -> Value {
Method::DaemonStatus => schema_of::<DaemonStatus>(generator),
Method::RpcDiscover => json!({ "type": "object" }),
Method::SearchResults => schema_of::<SearchResults>(generator),
Method::SearchList => schema_of::<Searches>(generator),
Method::SearchWishlistInterval => {
schema_of::<IntervalSeconds>(generator)
}
@@ -110,6 +113,7 @@ fn result_schema(method: Method, generator: &mut SchemaGenerator) -> Value {
| Method::RoomSay
| Method::MessageSend
| Method::BrowseUser
| Method::SearchForget
| Method::UserRequest => schema_of::<Ack>(generator),
}
}
@@ -131,6 +135,12 @@ fn summary(method: Method) -> &'static str {
Method::SearchResults => {
"Everything that has answered a search so far."
}
Method::SearchList => {
"Every search this session has run, shared by all clients."
}
Method::SearchForget => {
"Drop a search and its results, for every client at once."
}
Method::SearchWishlist => {
"Send a query as a wishlist search (server code 103)."
}
soulseek-rs/src/daemon/proto/method.rs
+20
View File
@@ -81,6 +81,26 @@ pub struct DirectoriesParams {
pub directories: Vec<String>,
}
/// Every search this session has run, newest last. Shared by all clients, so
/// a second one attaching sees what the first has been looking for.
#[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize)]
#[cfg_attr(test, derive(schemars::JsonSchema))]
pub struct Searches {
pub searches: Vec<SearchSummary>,
}
/// One search as the daemon sees it, for a client that did not run it.
#[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize)]
#[cfg_attr(test, derive(schemars::JsonSchema))]
pub struct SearchSummary {
pub query: String,
/// Files found so far, across every peer that has answered.
pub files: usize,
/// How long ago the query went out. A client compares this with its own
/// search window to decide whether the search is still collecting.
pub started_secs_ago: u64,
}
#[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize)]
#[cfg_attr(test, derive(schemars::JsonSchema))]
pub struct SearchResults {
soulseek-rs/src/daemon/proto/mod.rs
+2
View File
@@ -80,6 +80,8 @@ wire_vocabulary! {
RpcDiscover => "rpc.discover",
SearchStart => "search.start",
SearchResults => "search.results",
SearchList => "search.list",
SearchForget => "search.forget",
SearchWishlist => "search.wishlist",
SearchWishlistInterval => "search.wishlist_interval",
DownloadStart => "download.start",
soulseek-rs/src/daemon/server/mod.rs
+58 -3
View File
@@ -11,9 +11,9 @@ use super::proto::{
DaemonStatus, DirectoriesParams, DownloadDto, DownloadStartParams,
DownloadStarted, Downloads, IntervalSeconds, Members, MessageParams,
Messages, Method, OPENRPC, PROTOCOL_VERSION, QueryParams, RoomRef,
RpcError, SayParams, SearchResultDto, SearchResults, Seconds, SharesStatus,
SlotsParams, TransferRef, UploadInfoDto, Uploads, UserInfoDto, UserRef,
UserResult,
RpcError, SayParams, SearchResultDto, SearchResults, SearchSummary,
Searches, Seconds, SharesStatus, SlotsParams, TransferRef, UploadInfoDto,
Uploads, UserInfoDto, UserRef, UserResult,
};
use crate::api::SessionApi;
use crate::output::Exit;
@@ -41,6 +41,10 @@ pub struct Daemon {
pub open: Arc<std::sync::atomic::AtomicUsize>,
/// Rooms this session has joined, so a restart can rejoin them.
pub rooms: Mutex<Vec<String>>,
/// When each search went out. The window a search collects for belongs to
/// the client, so a second client can only tell a running search from a
/// finished one if the daemon remembers when it started.
pub searches: Mutex<std::collections::HashMap<String, Instant>>,
}
impl Daemon {
@@ -84,6 +88,7 @@ impl Daemon {
format!("search failed: {e}"),
)
})?;
self.record_search_start(&query.query);
ok(Ack::OK)
}
Method::SearchResults => {
@@ -97,6 +102,25 @@ impl Daemon {
.collect(),
})
}
Method::SearchList => ok(Searches {
searches: self
.session
.all_searches()
.into_iter()
.map(|search| SearchSummary {
files: search.files,
started_secs_ago: self.search_age(&search.query),
query: search.query,
})
.collect(),
}),
Method::SearchForget => {
let query: QueryParams = parse(params)?;
self.forget_search_start(&query.query);
ok(Ack {
ok: self.session.forget_search(&query.query),
})
}
Method::SearchWishlist => {
let query: QueryParams = parse(params)?;
self.session.start_wishlist_search(&query.query).map_err(
@@ -361,6 +385,30 @@ impl Daemon {
}
}
/// How long ago a search went out, or a long time when we never saw it
/// start — a search restored or begun before this daemon did.
fn search_age(&self, query: &str) -> u64 {
self.searches
.lock()
.ok()
.and_then(|searches| {
searches.get(query).map(|at| at.elapsed().as_secs())
})
.unwrap_or(u64::MAX)
}
fn record_search_start(&self, query: &str) {
if let Ok(mut searches) = self.searches.lock() {
searches.insert(query.to_string(), Instant::now());
}
}
fn forget_search_start(&self, query: &str) {
if let Ok(mut searches) = self.searches.lock() {
searches.remove(query);
}
}
fn identify(&self) -> AuthResult {
AuthResult {
protocol: PROTOCOL_VERSION,
@@ -536,6 +584,7 @@ mod tests {
stop: Arc::new(AtomicBool::new(false)),
open: Arc::new(std::sync::atomic::AtomicUsize::new(0)),
rooms: Mutex::new(Vec::new()),
searches: Mutex::new(std::collections::HashMap::new()),
}
}
@@ -570,6 +619,12 @@ mod tests {
) -> Vec<soulseek_rs::SearchResult> {
Vec::new()
}
fn all_searches(&self) -> Vec<crate::api::SessionSearch> {
Vec::new()
}
fn forget_search(&self, _query: &str) -> bool {
false
}
fn get_search_results_count(&self, _key: &str) -> usize {
0
}
soulseek-rs/src/models/app_state.rs
+7
View File
@@ -16,6 +16,13 @@ pub struct SearchEntry {
pub query: String,
pub status: SearchStatus,
pub results: Vec<FileDisplayData>,
/// What the session says this search has found, for a window that has not
/// fetched the results itself. Fetching every search every frame is what
/// a shared cache would otherwise cost.
pub known_files: usize,
/// Whether this window started the search. Its own worker knows when it
/// finishes; for the rest the session is the authority.
pub owned: bool,
pub start_time: Instant,
#[allow(dead_code)]
pub cancel_flag: Arc<AtomicBool>,
soulseek-rs/src/persist/snapshot.rs
+4
View File
@@ -107,6 +107,8 @@ pub fn restore_searches(state: &mut AppState, queries: &[String]) {
query: query.clone(),
status: SearchStatus::Completed,
results: Vec::new(),
known_files: 0,
owned: false,
start_time: std::time::Instant::now(),
cancel_flag: std::sync::Arc::new(
std::sync::atomic::AtomicBool::new(false),
@@ -147,6 +149,8 @@ mod tests {
query: query.into(),
status: SearchStatus::Active,
results: Vec::new(),
known_files: 0,
owned: false,
start_time: Instant::now(),
cancel_flag: Arc::new(AtomicBool::new(false)),
}
soulseek-rs/src/remote/mod.rs
+35 -3
View File
@@ -7,14 +7,14 @@
mod mirror;
use crate::api::SessionApi;
use crate::api::{SessionApi, SessionSearch};
use crate::daemon::proto::{
Ack, AuthParams, AuthResult, CODE_APPLICATION, ChatMessageDto,
DaemonStatus, DirectoriesParams, DownloadDto, DownloadStartParams,
DownloadStarted, Downloads, Event, IntervalSeconds, Members, MessageParams,
Messages, Method, PROTOCOL_VERSION, QueryParams, Request, Response,
RoomRef, RpcError, SayParams, SearchResults, Seconds, SharesStatus,
SlotsParams, TransferRef, Uploads, UserRef, UserResult,
RoomRef, RpcError, SayParams, SearchResults, Searches, Seconds,
SharesStatus, SlotsParams, TransferRef, Uploads, UserRef, UserResult,
};
use mirror::Mirror;
use serde::de::DeserializeOwned;
@@ -147,6 +147,8 @@ pub struct RemoteSession {
mirror: Arc<Mirror>,
next_id: AtomicU64,
username: String,
/// Where this session was reached, so the UI can say so.
endpoint: String,
/// Set when the reader thread stops, so a call fails immediately rather
/// than waiting out its timeout against a socket nobody is reading.
closed: Arc<AtomicBool>,
@@ -185,6 +187,7 @@ impl RemoteSession {
mirror,
next_id: AtomicU64::new(1),
username: String::new(),
endpoint: endpoint.to_string(),
closed: hung_up,
};
@@ -467,6 +470,10 @@ impl SessionApi for RemoteSession {
self.username.clone()
}
fn daemon_endpoint(&self) -> Option<String> {
Some(self.endpoint.clone())
}
fn listen_port(&self) -> Option<u16> {
self.status().and_then(|status| status.listen_port)
}
@@ -510,6 +517,31 @@ impl SessionApi for RemoteSession {
.unwrap_or_default()
}
fn all_searches(&self) -> Vec<SessionSearch> {
self.request::<_, Searches>(Method::SearchList, ())
.map(|listed| {
listed
.searches
.into_iter()
.map(|search| SessionSearch {
query: search.query,
files: search.files,
started_secs_ago: Some(search.started_secs_ago),
})
.collect()
})
.unwrap_or_default()
}
fn forget_search(&self, query: &str) -> bool {
self.ask(
Method::SearchForget,
QueryParams {
query: query.to_string(),
},
)
}
fn get_search_results_count(&self, key: &str) -> usize {
self.get_search_results(key).len()
}
soulseek-rs/src/ui/downloads.rs
+12 -1
View File
@@ -42,11 +42,18 @@ fn active_progress(downloads: &[DownloadEntry]) -> Option<(u64, u64, f64)> {
}
/// Renders download statistics in a reusable way
/// The status bar.
///
/// `daemon` names the session's owner when this window is attached to one. It
/// belongs in the title because a shared session behaves differently from a
/// private one: another window can add transfers, and closing this one leaves
/// them running.
pub fn render_download_stats(
frame: &mut Frame,
area: ratatui::layout::Rect,
downloads: &[DownloadEntry],
active_count: usize,
daemon: Option<&str>,
) {
let completed = downloads
.iter()
@@ -72,7 +79,11 @@ pub fn render_download_stats(
let active = active_progress(downloads);
let block = pane_block(false).title(plain_title("Status", false));
let title = match daemon {
Some(endpoint) => format!("Status · daemon {endpoint}"),
None => "Status".to_string(),
};
let block = pane_block(false).title(plain_title(&title, false));
let inner_area = block.inner(area);
frame.render_widget(block, area);
soulseek-rs/src/ui/main_tui/downloads.rs
+81 -3
View File
@@ -59,6 +59,22 @@ impl MainTui {
/// Remove all completed / failed / timed-out downloads from the list.
pub(super) fn clear_finished_downloads(&mut self) {
// Forget them in the session too. The list is a view of what the
// session holds, so dropping them only here would last until the next
// poll put them straight back.
for entry in &self.state.downloads {
if matches!(
entry.download.status,
DownloadStatus::Completed
| DownloadStatus::Failed(_)
| DownloadStatus::TimedOut
) {
self.client.remove_download(
&entry.download.username,
&entry.download.filename,
);
}
}
self.state.downloads.retain(|entry| {
!matches!(
entry.download.status,
@@ -218,13 +234,30 @@ impl MainTui {
pub(super) fn update_downloads(&mut self) {
if let Some(ref receiver) = self.state.downloads_receiver_channel {
while let Ok((download, download_receiver)) = receiver.try_recv() {
self.state.downloads.push(DownloadEntry {
download,
receiver: Some(download_receiver),
// A transfer of ours can already be listed: the session
// registers it the moment it is queued, so a frame between
// that and the worker handing it over here will have picked it
// up from the session. Take over that row rather than adding a
// second one for the same file.
let existing = self.state.downloads.iter_mut().find(|entry| {
entry.download.username == download.username
&& entry.download.filename == download.filename
});
match existing {
Some(entry) => {
entry.download = download;
entry.receiver = Some(download_receiver);
}
None => self.state.downloads.push(DownloadEntry {
download,
receiver: Some(download_receiver),
}),
}
}
}
self.sync_downloads_with_session();
self.state.active_downloads_count = 0;
for download_entry in &mut self.state.downloads {
if let Some(ref receiver) = download_entry.receiver {
@@ -241,4 +274,49 @@ impl MainTui {
}
}
}
/// Make the list show the session's transfers, not just this window's.
///
/// The queue belongs to the session, so against a daemon it includes what
/// another client queued and what was still running before this window
/// opened. Transfers this window started keep their own status channel,
/// which reports sooner than a poll; everything else is refreshed from the
/// session each tick.
fn sync_downloads_with_session(&mut self) {
// Only worth doing when the session is shared. A window with a
// session of its own started every transfer in it, so there is
// nothing to learn — and the list also holds completed transfers
// restored from disk that the session has never heard of, which this
// reconciliation would take to mean "cancelled elsewhere" and delete.
if self.client.daemon_endpoint().is_none() {
return;
}
let known = self.client.get_all_downloads();
for download in &known {
let existing = self.state.downloads.iter_mut().find(|entry| {
entry.download.username == download.username
&& entry.download.filename == download.filename
});
match existing {
// Ours: the channel is more current than this snapshot.
Some(entry) if entry.receiver.is_some() => {}
Some(entry) => entry.download.status = download.status.clone(),
None => self.state.downloads.push(DownloadEntry {
download: download.clone(),
receiver: None,
}),
}
}
// Anything the session has forgotten is gone for every window.
self.state.downloads.retain(|entry| {
entry.receiver.is_some()
|| known.iter().any(|download| {
download.username == entry.download.username
&& download.filename == entry.download.filename
})
});
}
}
soulseek-rs/src/ui/main_tui/mod.rs
+230 -7
View File
@@ -269,15 +269,40 @@ pub fn launch_main_tui(
mod tests {
use super::*;
use crate::daemon::proto::ChatMessageDto;
use crate::models::MessageDirection;
use crate::models::{MessageDirection, SearchStatus};
/// A session that knows a conversation and nothing else — what attaching
/// to a daemon looks like from the TUI's side.
struct TalkativeSession(Vec<ChatMessageDto>);
/// A stand-in for a daemon: it already holds a conversation, a transfer
/// queue, and a search cache, none of which this window created.
#[derive(Default)]
struct TalkativeSession {
history: Vec<ChatMessageDto>,
downloads: Vec<soulseek_rs::types::Download>,
searches: std::sync::Mutex<Vec<crate::api::SessionSearch>>,
/// Whether this session is a daemon's. Local sessions do not sync.
shared: bool,
}
fn queued(username: &str, filename: &str) -> soulseek_rs::types::Download {
let (sender, _) = std::sync::mpsc::channel();
soulseek_rs::types::Download {
username: username.to_string(),
filename: filename.to_string(),
token: 1,
size: 4096,
download_directory: "/tmp".to_string(),
status: soulseek_rs::DownloadStatus::Queued,
sender,
queue_position: None,
metadata: soulseek_rs::types::DownloadMetadata::default(),
}
}
impl SessionApi for TalkativeSession {
fn message_history(&self) -> Vec<ChatMessageDto> {
self.0.clone()
self.history.clone()
}
fn daemon_endpoint(&self) -> Option<String> {
self.shared.then(|| "test-daemon".to_string())
}
fn username(&self) -> String {
"tester".to_string()
@@ -302,6 +327,15 @@ mod tests {
) -> Vec<soulseek_rs::SearchResult> {
Vec::new()
}
fn all_searches(&self) -> Vec<crate::api::SessionSearch> {
self.searches.lock().expect("not poisoned").clone()
}
fn forget_search(&self, query: &str) -> bool {
let mut searches = self.searches.lock().expect("not poisoned");
let before = searches.len();
searches.retain(|search| search.query != query);
searches.len() != before
}
fn get_search_results_count(&self, _key: &str) -> usize {
0
}
@@ -346,7 +380,7 @@ mod tests {
Err(soulseek_rs::SoulseekRs::NotConnected)
}
fn get_all_downloads(&self) -> Vec<soulseek_rs::types::Download> {
Vec::new()
self.downloads.clone()
}
fn pause_download(&self, _u: &str, _f: &str) -> bool {
false
@@ -441,8 +475,36 @@ mod tests {
}
fn tui(history: Vec<ChatMessageDto>) -> MainTui {
with_session(TalkativeSession {
history,
shared: true,
..TalkativeSession::default()
})
}
fn shared(searches: Vec<crate::api::SessionSearch>) -> TalkativeSession {
TalkativeSession {
searches: std::sync::Mutex::new(searches),
shared: true,
..TalkativeSession::default()
}
}
fn search_of(
query: &str,
files: usize,
age: u64,
) -> crate::api::SessionSearch {
crate::api::SessionSearch {
query: query.to_string(),
files,
started_secs_ago: Some(age),
}
}
fn with_session(session: TalkativeSession) -> MainTui {
MainTui::new(
Arc::new(TalkativeSession(history)),
Arc::new(session),
"/tmp".to_string(),
1,
Duration::from_secs(1),
@@ -481,6 +543,167 @@ mod tests {
assert_eq!(tui.state.chat_peers(), ["bob"]);
}
#[test]
fn a_window_shows_transfers_it_did_not_start() {
// Two windows on one daemon are two views of one queue. A transfer
// queued in the other one has to appear here, or closing a window
// would look like losing its downloads.
let mut tui = with_session(TalkativeSession {
downloads: vec![queued("bob", "@@x\\theirs.mp3")],
shared: true,
..TalkativeSession::default()
});
assert!(
tui.state.downloads.is_empty(),
"nothing until the first poll"
);
tui.update_downloads();
assert_eq!(tui.state.downloads.len(), 1);
assert_eq!(tui.state.downloads[0].download.filename, "@@x\\theirs.mp3");
assert!(
tui.state.downloads[0].receiver.is_none(),
"someone else's transfer has no channel of ours"
);
// Polling again must not double it up.
tui.update_downloads();
assert_eq!(tui.state.downloads.len(), 1);
}
#[test]
fn a_transfer_the_session_forgets_leaves_every_window() {
let mut tui = with_session(TalkativeSession {
downloads: vec![queued("bob", "gone.mp3")],
shared: true,
..TalkativeSession::default()
});
tui.update_downloads();
assert_eq!(tui.state.downloads.len(), 1);
// The session no longer has it — cancelled from the other window.
tui.client = Arc::new(TalkativeSession {
shared: true,
..TalkativeSession::default()
});
tui.update_downloads();
assert!(
tui.state.downloads.is_empty(),
"a queue is shared in both directions"
);
}
#[test]
fn a_window_shows_searches_run_in_another() {
let mut tui =
with_session(shared(vec![search_of("their query", 7, 9_999)]));
tui.update_search_results();
assert_eq!(tui.state.searches.len(), 1);
assert_eq!(tui.state.searches[0].query, "their query");
// And it is not added a second time on the next frame.
tui.update_search_results();
assert_eq!(tui.state.searches.len(), 1);
}
#[test]
fn a_search_another_window_is_still_running_shows_as_active() {
// It had said "Done" the moment it appeared, because an imported
// search carried no notion of still collecting — so the other window
// looked finished while results were still arriving.
let mut tui =
with_session(shared(vec![search_of("still going", 3, 0)]));
tui.update_search_results();
assert_eq!(tui.state.searches[0].status, SearchStatus::Active);
assert_eq!(
tui.state.searches[0].known_files, 3,
"and its count comes across before the results do"
);
}
#[test]
fn a_search_that_has_run_its_window_shows_as_done() {
let mut tui =
with_session(shared(vec![search_of("finished", 12, 9_999)]));
tui.update_search_results();
assert_eq!(tui.state.searches[0].status, SearchStatus::Completed);
}
#[test]
fn removing_a_search_removes_it_from_the_session() {
// Removing it only from this window would last until the next sync,
// which would put it straight back — and in a shared session it would
// come back for every other window too.
let mut tui =
with_session(shared(vec![search_of("unwanted", 1, 9_999)]));
tui.update_search_results();
assert_eq!(tui.state.searches.len(), 1);
tui.remove_search_at_index(0);
tui.update_search_results();
assert!(tui.state.searches.is_empty(), "and it stays gone");
}
#[test]
fn clearing_every_search_clears_them_in_the_session_too() {
let mut tui = with_session(shared(vec![
search_of("one", 1, 9_999),
search_of("two", 2, 9_999),
]));
tui.update_search_results();
assert_eq!(tui.state.searches.len(), 2);
tui.clear_all_searches();
tui.update_search_results();
assert!(
tui.state.searches.is_empty(),
"clearing has to reach the session, or every row comes back"
);
}
#[test]
fn a_search_dismissed_in_another_window_leaves_this_one() {
let session = shared(vec![search_of("theirs", 4, 9_999)]);
let mut tui = with_session(session);
tui.update_search_results();
assert_eq!(tui.state.searches.len(), 1);
// The other window dismissed it.
tui.client.forget_search("theirs");
tui.update_search_results();
assert!(tui.state.searches.is_empty());
}
#[test]
fn a_window_with_its_own_session_is_left_alone() {
// Nothing to share, so nothing is synced — and in particular the
// completed transfers restored from disk, which the session has never
// heard of, are not mistaken for cancelled and deleted.
let mut tui = with_session(TalkativeSession {
downloads: Vec::new(),
shared: false,
..TalkativeSession::default()
});
tui.state.downloads.push(crate::models::DownloadEntry {
download: queued("bob", "from-disk.mp3"),
receiver: None,
});
tui.update_downloads();
assert_eq!(
tui.state.downloads.len(),
1,
"a local window's history must survive the tick"
);
}
#[test]
fn a_local_session_starts_from_its_own_snapshot_instead() {
// Locally the session knows no history and the state file is the whole
soulseek-rs/src/ui/main_tui/render.rs
+2
View File
@@ -41,11 +41,13 @@ impl MainTui {
constraints.push(Constraint::Length(3)); // Shortcuts
let main_chunks = Layout::vertical(constraints).split(frame.area());
let daemon = self.client.daemon_endpoint();
render_download_stats(
frame,
main_chunks[0],
&self.state.downloads,
self.state.active_downloads_count,
daemon.as_deref(),
);
self.render_content(frame, main_chunks[1]);
soulseek-rs/src/ui/main_tui/search.rs
+103 -1
View File
@@ -26,6 +26,13 @@ impl MainTui {
// Check if we're removing the currently active search
let was_active_search = self.state.selected_search_index == Some(index);
// Drop it from the session too. The list is a view of what the session
// holds, so removing it only here would last until the next sync put
// it straight back — and against a daemon it would come back for every
// other window as well.
if let Some(search) = self.state.searches.get(index) {
self.client.forget_search(&search.query);
}
self.state.searches.remove(index);
if let Some(current_idx) = self.state.selected_search_index {
@@ -64,7 +71,19 @@ impl MainTui {
.store(true, std::sync::atomic::Ordering::Relaxed);
}
// Clear searches
// And drop them from the session, or the next sync brings every one
// of them straight back — the same reason removing a single search
// has to say so.
let queries: Vec<String> = self
.state
.searches
.iter()
.map(|search| search.query.clone())
.collect();
for query in queries {
self.client.forget_search(&query);
}
self.state.searches.clear();
self.state.searches_table_state.select(None);
self.state.selected_search_index = None;
@@ -173,6 +192,8 @@ impl MainTui {
query: query.clone(),
status: SearchStatus::Active,
results: Vec::new(),
known_files: 0,
owned: true,
start_time: Instant::now(),
cancel_flag: cancel_flag.clone(),
};
@@ -213,17 +234,98 @@ impl MainTui {
});
}
/// Show the searches the session knows about, not just this window's.
///
/// Against a daemon the search cache is shared, so a window that opens
/// later sees what the others have looked for, and a query run in one
/// appears in the other. A search is still collecting if it went out less
/// than one search window ago — the window belongs to whichever client
/// started it, so the age is the only thing another window can judge by.
fn sync_searches_with_session(&mut self) {
// Only worth doing when the session is shared: a window with its own
// session ran every search in the list and already knows their state,
// so asking would cost a full copy of every result set per frame and
// tell us nothing.
if self.client.daemon_endpoint().is_none() {
return;
}
let timeout = self.search_timeout.as_secs();
for known in self.client.all_searches() {
let running = known
.started_secs_ago
.is_some_and(|elapsed| elapsed < timeout);
if let Some(existing) = self
.state
.searches
.iter_mut()
.find(|search| search.query == known.query)
{
// Ours keeps the status its own worker thread sets; the rest
// follow the session, so a search finishing in one window
// stops saying "Active" in the others.
if known.started_secs_ago.is_some() && !existing.owned {
existing.status = if running {
SearchStatus::Active
} else {
SearchStatus::Completed
};
existing.known_files = known.files;
}
continue;
}
self.state.searches.push(SearchEntry {
query: known.query,
status: if running {
SearchStatus::Active
} else {
SearchStatus::Completed
},
results: Vec::new(),
known_files: known.files,
owned: false,
start_time: std::time::Instant::now(),
cancel_flag: std::sync::Arc::new(
std::sync::atomic::AtomicBool::new(false),
),
});
}
// Dismissed elsewhere means dismissed here. Ours stay: this window is
// the authority on a search it started.
let live: Vec<String> = self
.client
.all_searches()
.into_iter()
.map(|search| search.query)
.collect();
self.state
.searches
.retain(|search| search.owned || live.contains(&search.query));
}
pub(super) fn update_search_results(&mut self) {
self.sync_searches_with_session();
let timeout = self.search_timeout;
let selected_search_index = self.state.selected_search_index;
// Fetch all results in one go (single lock acquisition per query)
// Use try_get_search_results to avoid blocking the UI thread
// Only what the user can see or what is still arriving. A shared
// cache can hold every search every window has ever run, and fetching
// all of them each frame is a round trip apiece against a daemon.
// The rest show the count the session reported.
let all_results: Vec<(usize, Vec<_>)> = self
.state
.searches
.iter()
.enumerate()
.filter(|(idx, search)| {
search.status == SearchStatus::Active
|| selected_search_index == Some(*idx)
})
.map(|(idx, s)| (idx, s.query.clone()))
.filter_map(|(idx, query)| {
self.client
soulseek-rs/src/ui/panes/searches_pane.rs
+8 -1
View File
@@ -35,7 +35,14 @@ pub fn render_searches_pane(
}
};
let results_count = search.results.len();
// What this window has fetched, or what the session says it will
// find when it does. A search another window ran has a count long
// before this one has pulled the results across.
let results_count = if search.results.is_empty() {
search.known_files
} else {
search.results.len()
};
let results_text = if results_count == 0
&& search.status == SearchStatus::Active
{
soulseek-rs/tests/daemon_protocol_e2e.rs
+126
View File
@@ -667,3 +667,129 @@ fn rapid_connect_and_drop_does_not_wear_the_daemon_out() {
"abandoned connections must not still be counted: {status}"
);
}
/// What one client does, the other sees.
///
/// Two TUIs on one daemon are two views of a single session, not two sessions
/// that happen to share a login. A search run in one appears in the other's
/// list, and a transfer queued in one appears in the other's queue — which is
/// what makes closing one window harmless.
#[test]
fn one_clients_work_shows_up_in_another() {
let daemon = daemon_or_skip!();
let mut first = daemon.connect_tcp().expect("connect");
first.authenticate(Some(&daemon.token())).expect("first in");
let mut second = daemon.connect_tcp().expect("connect");
second
.authenticate(Some(&daemon.token()))
.expect("second in");
// Nothing searched yet, so neither sees anything.
let queries = |connection: &mut Connection, id: u32| -> Vec<String> {
let reply = connection
.call(&format!(
r#"{{"jsonrpc":"2.0","id":{id},"method":"search.list"}}"#
))
.expect("an answer");
let parsed: serde_json::Value =
serde_json::from_str(&reply).expect("valid JSON");
parsed["result"]["searches"]
.as_array()
.expect("searches is an array")
.iter()
.filter_map(|search| search["query"].as_str().map(String::from))
.collect()
};
assert!(!queries(&mut second, 1).contains(&"shared_probe".to_string()));
// The first client searches.
first
.call(
r#"{"jsonrpc":"2.0","id":2,"method":"search.start","params":{"query":"shared_probe"}}"#,
)
.expect("an answer");
// The second client sees that search without having run it.
assert!(
queries(&mut second, 3).contains(&"shared_probe".to_string()),
"a search in one window must appear in the other"
);
// And its results are the same set, because there is one search cache.
let results = |connection: &mut Connection, id: u32| -> usize {
let reply = connection
.call(&format!(
r#"{{"jsonrpc":"2.0","id":{id},"method":"search.results","params":{{"query":"shared_probe"}}}}"#
))
.expect("an answer");
let parsed: serde_json::Value =
serde_json::from_str(&reply).expect("valid JSON");
parsed["result"]["results"]
.as_array()
.expect("results is an array")
.len()
};
assert_eq!(
results(&mut first, 4),
results(&mut second, 5),
"both windows read one search cache"
);
}
/// A client that attaches later starts from the session's state.
///
/// This is what makes a second window useful at all: it opens showing what is
/// already going on rather than a blank slate that fills only with what it
/// does itself.
#[test]
fn a_client_that_attaches_later_sees_what_is_already_there() {
let daemon = daemon_or_skip!();
// An early client does some work.
let mut early = daemon.connect_tcp().expect("connect");
early.authenticate(Some(&daemon.token())).expect("in");
early
.call(
r#"{"jsonrpc":"2.0","id":1,"method":"search.start","params":{"query":"earlier_probe"}}"#,
)
.expect("an answer");
early
.call(
r#"{"jsonrpc":"2.0","id":2,"method":"room.join","params":{"room":"cli_e2e_late_room"}}"#,
)
.expect("an answer");
// A window opened afterwards is told about it.
let mut late = daemon.connect_tcp().expect("connect");
late.authenticate(Some(&daemon.token())).expect("in");
let reply = late
.call(r#"{"jsonrpc":"2.0","id":3,"method":"search.list"}"#)
.expect("an answer");
let parsed: serde_json::Value =
serde_json::from_str(&reply).expect("valid JSON");
let mut queries = parsed["result"]["searches"]
.as_array()
.expect("searches is an array")
.iter()
.filter_map(|search| search["query"].as_str());
assert!(
queries.any(|query| query == "earlier_probe"),
"a window that opens later must see the searches already run: {reply}"
);
// The transfer queue is the session's, so both read the same one.
for (connection, id) in [(&mut early, 4), (&mut late, 5)] {
let reply = connection
.call(&format!(
r#"{{"jsonrpc":"2.0","id":{id},"method":"download.list"}}"#
))
.expect("an answer");
let parsed: serde_json::Value =
serde_json::from_str(&reply).expect("valid JSON");
assert!(
parsed["result"]["downloads"].is_array(),
"both windows read one queue: {reply}"
);
}
}
website/src/pages/docs.tsx
+6
View File
@@ -250,6 +250,12 @@ const Daemon = () => (
open, so there is no address to pass and no token to handle. Without one
running, everything behaves exactly as it did before.
</p>
<p>
Every window is a view of the same session. Open a second TUI and it shows the
searches and transfers already running; queue something in either and both see
it. The status bar names the daemon, and closing a window leaves its downloads
going, because they belong to the daemon rather than the window.
</p>
<p>
Why bother: the server permits a single session per account. Two one-off
commands at once either cut each other off, or push you into a throwaway