dartboard-local 0.1.3

In-process server and local client transport for dartboard
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
//! In-process dartboard server + LocalClient.
//!
//! The server owns the canonical [`Canvas`], assigns globally monotonic
//! sequence numbers, and fans out [`ServerMsg`]s to connected clients. Each
//! [`LocalClient`] is a handle scoped to one session. Other transports can
//! integrate by implementing [`ServerSink`] and using
//! [`ServerHandle::register_transport`].

use std::sync::mpsc;
use std::sync::{Arc, Mutex};

use dartboard_core::{
    Canvas, CanvasOp, Client, ClientMsg, ClientOpId, Peer, RgbColor, Seq, ServerMsg, UserId,
};
use rand::seq::SliceRandom;

pub mod store;

pub use store::{CanvasStore, InMemStore};

/// Candidate player colors. Kept in sync with the client-side palette in
/// `dartboard/src/theme.rs`.
const PLAYER_PALETTE: [RgbColor; 9] = [
    RgbColor::new(255, 110, 64),
    RgbColor::new(255, 236, 96),
    RgbColor::new(145, 226, 88),
    RgbColor::new(72, 220, 170),
    RgbColor::new(84, 196, 255),
    RgbColor::new(128, 163, 255),
    RgbColor::new(192, 132, 255),
    RgbColor::new(255, 124, 196),
    RgbColor::new(176, 48, 56),
];

/// Max concurrent players on a single shared canvas. Equal to the palette
/// length so the seat cap preserves unique per-user colors.
pub const MAX_PLAYERS: usize = PLAYER_PALETTE.len();

/// Policy for assigning per-user colors on connect.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
pub enum ColorSelectionMode {
    /// Workspace default color-selection policy.
    #[default]
    Default,
    /// Assign a color uniformly from the palette entries not currently in use.
    RandomUnique,
}

fn select_user_color(mode: ColorSelectionMode, used: &[RgbColor]) -> RgbColor {
    let available: Vec<_> = PLAYER_PALETTE
        .iter()
        .copied()
        .filter(|color| !used.contains(color))
        .collect();
    debug_assert!(
        !available.is_empty(),
        "color selection requires an unused palette slot"
    );

    match mode {
        ColorSelectionMode::Default | ColorSelectionMode::RandomUnique => *available
            .choose(&mut rand::thread_rng())
            .expect("unused color should exist before reaching MAX_PLAYERS"),
    }
}

/// Minimal transport-facing sink used by the server to fan out [`ServerMsg`]s.
pub trait ServerSink: Send {
    fn send(&self, msg: ServerMsg) -> bool;
}

/// A handle to the running server. Cloneable; every clone references the same
/// canonical canvas and client registry.
#[derive(Clone)]
pub struct ServerHandle {
    inner: Arc<ServerInner>,
}

struct ServerInner {
    state: Mutex<State>,
}

struct State {
    canvas: Canvas,
    seq: Seq,
    next_user_id: UserId,
    color_selection_mode: ColorSelectionMode,
    clients: Vec<ClientEntry>,
    store: Box<dyn CanvasStore>,
}

struct ClientEntry {
    peer: Peer,
    sender: Box<dyn ServerSink>,
}

struct LocalSink(mpsc::Sender<ServerMsg>);

impl ServerSink for LocalSink {
    fn send(&self, msg: ServerMsg) -> bool {
        self.0.send(msg).is_ok()
    }
}

/// Introductory payload a client sends before any ops. Name is echoed back to
/// peers; color is a transport-level hint and may be replaced by the server's
/// configured [`ColorSelectionMode`].
#[derive(Debug, Clone)]
pub struct Hello {
    pub name: String,
    pub color: RgbColor,
}

/// Outcome of a connect attempt. Rejected connections leave no registered
/// state on the server.
pub enum ConnectOutcome {
    Accepted(LocalClient),
    Rejected(String),
}

impl ServerHandle {
    pub fn spawn_local<S: CanvasStore + 'static>(store: S) -> Self {
        Self::spawn_local_with_color_selection_mode(store, ColorSelectionMode::default())
    }

    pub fn spawn_local_with_color_selection_mode<S: CanvasStore + 'static>(
        store: S,
        color_selection_mode: ColorSelectionMode,
    ) -> Self {
        let canvas = store.load().unwrap_or_default();
        let inner = Arc::new(ServerInner {
            state: Mutex::new(State {
                canvas,
                seq: 0,
                next_user_id: 1,
                color_selection_mode,
                clients: Vec::new(),
                store: Box::new(store),
            }),
        });
        Self { inner }
    }

    pub fn try_connect_local(&self, hello: Hello) -> ConnectOutcome {
        let (tx, rx) = mpsc::channel();
        match self.register_transport(hello, Box::new(LocalSink(tx))) {
            Ok(user_id) => ConnectOutcome::Accepted(LocalClient {
                server: self.clone(),
                user_id,
                rx,
                next_client_op_id: 1,
            }),
            Err(reason) => ConnectOutcome::Rejected(reason),
        }
    }

    pub fn connect_local(&self, hello: Hello) -> LocalClient {
        match self.try_connect_local(hello) {
            ConnectOutcome::Accepted(client) => client,
            ConnectOutcome::Rejected(reason) => {
                panic!("connect_local rejected: {reason}")
            }
        }
    }

    /// Register a new client against an existing transport sink.
    pub fn register_transport(
        &self,
        hello: Hello,
        sender: Box<dyn ServerSink>,
    ) -> Result<UserId, String> {
        let mut state = self.inner.state.lock().unwrap();
        if state.clients.len() >= MAX_PLAYERS {
            let reason = format!(
                "dartboard is full ({} / {} players)",
                state.clients.len(),
                MAX_PLAYERS
            );
            let _ = sender.send(ServerMsg::ConnectRejected {
                reason: reason.clone(),
            });
            return Err(reason);
        }
        let user_id = state.next_user_id;
        state.next_user_id += 1;

        let used_colors: Vec<RgbColor> = state.clients.iter().map(|c| c.peer.color).collect();
        let color = select_user_color(state.color_selection_mode, &used_colors);

        let peer = Peer {
            user_id,
            name: hello.name,
            color,
        };

        sender.send(ServerMsg::Welcome {
            your_user_id: user_id,
            your_color: color,
            peers: state.clients.iter().map(|c| c.peer.clone()).collect(),
            snapshot: state.canvas.clone(),
        });

        for entry in &state.clients {
            entry
                .sender
                .send(ServerMsg::PeerJoined { peer: peer.clone() });
        }

        state.clients.push(ClientEntry { peer, sender });
        Ok(user_id)
    }

    pub fn peer_count(&self) -> usize {
        self.inner.state.lock().unwrap().clients.len()
    }

    pub fn canvas_snapshot(&self) -> Canvas {
        self.inner.state.lock().unwrap().canvas.clone()
    }

    /// Apply an op on behalf of an already-registered user.
    pub fn submit_op_for(&self, user_id: UserId, client_op_id: ClientOpId, op: CanvasOp) {
        let mut state = self.inner.state.lock().unwrap();

        let State {
            canvas,
            seq,
            clients,
            store,
            ..
        } = &mut *state;

        canvas.apply(&op);
        *seq += 1;
        let seq = *seq;
        store.save(canvas);

        for entry in clients.iter() {
            if entry.peer.user_id == user_id {
                entry.sender.send(ServerMsg::Ack { client_op_id, seq });
            }
            entry.sender.send(ServerMsg::OpBroadcast {
                from: user_id,
                op: op.clone(),
                seq,
            });
        }
    }

    /// Disconnect a previously-registered user and broadcast `PeerLeft`.
    pub fn disconnect_user(&self, user_id: UserId) {
        let mut state = self.inner.state.lock().unwrap();
        state.clients.retain(|c| c.peer.user_id != user_id);
        for entry in &state.clients {
            entry.sender.send(ServerMsg::PeerLeft { user_id });
        }
    }
}

/// In-process client handle. Sends ops directly into the server under the
/// shared state lock; receives events over a std mpsc channel.
pub struct LocalClient {
    server: ServerHandle,
    user_id: UserId,
    rx: mpsc::Receiver<ServerMsg>,
    next_client_op_id: ClientOpId,
}

impl LocalClient {
    pub fn user_id(&self) -> UserId {
        self.user_id
    }

    pub fn send(&mut self, msg: ClientMsg) -> Option<ClientOpId> {
        match msg {
            ClientMsg::Hello { .. } => None,
            ClientMsg::Op { op, .. } => Some(self.submit_op(op)),
        }
    }
}

impl Client for LocalClient {
    fn submit_op(&mut self, op: CanvasOp) -> ClientOpId {
        let id = self.next_client_op_id;
        self.next_client_op_id += 1;
        self.server.submit_op_for(self.user_id, id, op);
        id
    }

    fn try_recv(&mut self) -> Option<ServerMsg> {
        self.rx.try_recv().ok()
    }
}

impl Drop for LocalClient {
    fn drop(&mut self) {
        self.server.disconnect_user(self.user_id);
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use dartboard_core::{ops::RowShift, Pos};

    fn red() -> RgbColor {
        RgbColor::new(255, 0, 0)
    }

    fn blue() -> RgbColor {
        RgbColor::new(0, 0, 255)
    }

    fn drain_events(client: &mut LocalClient) -> Vec<ServerMsg> {
        let mut events = Vec::new();
        while let Some(msg) = client.try_recv() {
            events.push(msg);
        }
        events
    }

    #[test]
    fn welcome_contains_snapshot_and_existing_peers() {
        let server = ServerHandle::spawn_local(InMemStore);
        let mut alice = server.connect_local(Hello {
            name: "alice".into(),
            color: red(),
        });
        let mut bob = server.connect_local(Hello {
            name: "bob".into(),
            color: blue(),
        });

        let alice_events = drain_events(&mut alice);
        let bob_events = drain_events(&mut bob);

        match &alice_events[0] {
            ServerMsg::Welcome { peers, .. } => assert!(peers.is_empty()),
            other => panic!("expected Welcome, got {:?}", other),
        }
        match &bob_events[0] {
            ServerMsg::Welcome { peers, .. } => {
                assert_eq!(peers.len(), 1);
                assert_eq!(peers[0].name, "alice");
            }
            other => panic!("expected Welcome, got {:?}", other),
        }
        assert!(alice_events
            .iter()
            .any(|m| matches!(m, ServerMsg::PeerJoined { .. })));
    }

    #[test]
    fn submit_op_broadcasts_and_acks() {
        let server = ServerHandle::spawn_local(InMemStore);
        let mut alice = server.connect_local(Hello {
            name: "alice".into(),
            color: red(),
        });
        let mut bob = server.connect_local(Hello {
            name: "bob".into(),
            color: blue(),
        });
        let _ = drain_events(&mut alice);
        let _ = drain_events(&mut bob);

        alice.submit_op(CanvasOp::PaintCell {
            pos: Pos { x: 2, y: 1 },
            ch: 'A',
            fg: red(),
        });

        let alice_events = drain_events(&mut alice);
        let bob_events = drain_events(&mut bob);

        assert!(alice_events
            .iter()
            .any(|m| matches!(m, ServerMsg::Ack { .. })));
        assert!(alice_events
            .iter()
            .any(|m| matches!(m, ServerMsg::OpBroadcast { .. })));
        assert!(bob_events
            .iter()
            .any(|m| matches!(m, ServerMsg::OpBroadcast { .. })));

        let snap = server.canvas_snapshot();
        assert_eq!(snap.get(Pos { x: 2, y: 1 }), 'A');
    }

    #[test]
    fn sequence_numbers_are_monotonic() {
        let server = ServerHandle::spawn_local(InMemStore);
        let mut client = server.connect_local(Hello {
            name: "solo".into(),
            color: red(),
        });
        let _ = drain_events(&mut client);

        client.submit_op(CanvasOp::PaintCell {
            pos: Pos { x: 0, y: 0 },
            ch: 'A',
            fg: red(),
        });
        client.submit_op(CanvasOp::PaintCell {
            pos: Pos { x: 1, y: 0 },
            ch: 'B',
            fg: red(),
        });

        let mut seqs = Vec::new();
        for msg in drain_events(&mut client) {
            if let ServerMsg::OpBroadcast { seq, .. } = msg {
                seqs.push(seq);
            }
        }
        assert_eq!(seqs, vec![1, 2]);
    }

    #[test]
    fn shift_row_op_is_applied_server_side() {
        let server = ServerHandle::spawn_local(InMemStore);
        let mut client = server.connect_local(Hello {
            name: "solo".into(),
            color: red(),
        });
        let _ = drain_events(&mut client);

        client.submit_op(CanvasOp::PaintCell {
            pos: Pos { x: 0, y: 0 },
            ch: 'A',
            fg: red(),
        });
        client.submit_op(CanvasOp::PaintCell {
            pos: Pos { x: 1, y: 0 },
            ch: 'B',
            fg: red(),
        });
        client.submit_op(CanvasOp::ShiftRow {
            y: 0,
            kind: RowShift::PushLeft { to_x: 1 },
        });

        let snap = server.canvas_snapshot();
        assert_eq!(snap.get(Pos { x: 0, y: 0 }), 'B');
        assert_eq!(snap.get(Pos { x: 1, y: 0 }), ' ');
    }

    #[test]
    fn joining_players_get_unique_colors_from_palette() {
        let server = ServerHandle::spawn_local(InMemStore);
        let mut alice = server.connect_local(Hello {
            name: "alice".into(),
            color: red(),
        });
        let mut bob = server.connect_local(Hello {
            name: "bob".into(),
            color: red(),
        });

        let alice_color = match drain_events(&mut alice).into_iter().next() {
            Some(ServerMsg::Welcome { your_color, .. }) => your_color,
            other => panic!("expected Welcome, got {:?}", other),
        };
        assert!(PLAYER_PALETTE.contains(&alice_color));

        let bob_color = match drain_events(&mut bob).into_iter().next() {
            Some(ServerMsg::Welcome { your_color, .. }) => your_color,
            other => panic!("expected Welcome, got {:?}", other),
        };
        assert_ne!(
            bob_color, alice_color,
            "players should never collide while free palette slots remain"
        );
        assert!(
            PLAYER_PALETTE.contains(&bob_color),
            "assigned color {:?} should come from the palette",
            bob_color
        );
    }

    #[test]
    fn dropping_client_broadcasts_peer_left() {
        let server = ServerHandle::spawn_local(InMemStore);
        let mut alice = server.connect_local(Hello {
            name: "alice".into(),
            color: red(),
        });
        let alice_id;
        {
            let bob = server.connect_local(Hello {
                name: "bob".into(),
                color: blue(),
            });
            alice_id = alice.user_id();
            drop(bob);
        }
        let events = drain_events(&mut alice);
        assert!(
            events
                .iter()
                .any(|m| matches!(m, ServerMsg::PeerLeft { .. })),
            "expected PeerLeft in {:?}",
            events
        );
        assert_eq!(server.peer_count(), 1);
        let _ = alice_id;
    }

    #[test]
    fn next_connect_is_rejected_when_server_is_full() {
        let server = ServerHandle::spawn_local(InMemStore);
        let mut clients = Vec::new();
        for (i, color) in PLAYER_PALETTE.iter().copied().enumerate().take(MAX_PLAYERS) {
            clients.push(server.connect_local(Hello {
                name: format!("peer{i}"),
                color,
            }));
        }

        match server.try_connect_local(Hello {
            name: "overflow".into(),
            color: red(),
        }) {
            ConnectOutcome::Rejected(reason) => {
                assert!(reason.to_lowercase().contains("full"), "reason: {reason}");
            }
            ConnectOutcome::Accepted(_) => panic!("server should be full"),
        }
        assert_eq!(server.peer_count(), MAX_PLAYERS);
    }
}