arete-server 0.54.1

WebSocket server and projection handlers for Arete streaming pipelines
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
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
use std::collections::{HashMap, HashSet};
use std::net::{IpAddr, Ipv4Addr, SocketAddr};
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::mpsc as sync_mpsc;
use std::sync::{Arc, Mutex, Weak};

use arete_auth::SessionClaims;
use futures_util::StreamExt;
use tokio::net::TcpListener;
use tokio_tungstenite::tungstenite::protocol::Role;

use super::*;

#[derive(Debug)]
struct Reservation {
    context: AuthContext,
    subscriptions: HashSet<String>,
}

#[derive(Debug, Default)]
struct FakeAdmission {
    reservations: Mutex<HashMap<Uuid, Reservation>>,
    deny_refresh: AtomicBool,
    deny_reserve: AtomicBool,
    deny_inbound: AtomicBool,
    deny_egress: AtomicBool,
    refresh_entered: Mutex<Option<sync_mpsc::Sender<()>>>,
    refresh_release: Mutex<Option<sync_mpsc::Receiver<()>>>,
}

impl FakeAdmission {
    fn permit(self: &Arc<Self>, context: &AuthContext) -> Arc<dyn WebSocketConnectionPermit> {
        let id = Uuid::new_v4();
        self.reservations.lock().unwrap().insert(
            id,
            Reservation {
                context: context.clone(),
                subscriptions: HashSet::new(),
            },
        );
        Arc::new(FakePermit {
            state: Arc::downgrade(self),
            id,
        })
    }

    fn reservation_count(&self) -> usize {
        self.reservations.lock().unwrap().len()
    }

    fn block_next_refresh(&self, entered: sync_mpsc::Sender<()>, release: sync_mpsc::Receiver<()>) {
        *self.refresh_entered.lock().unwrap() = Some(entered);
        *self.refresh_release.lock().unwrap() = Some(release);
    }
}

#[derive(Debug)]
struct FakePermit {
    state: Weak<FakeAdmission>,
    id: Uuid,
}

impl WebSocketConnectionPermit for FakePermit {
    fn id(&self) -> Uuid {
        self.id
    }
}

impl Drop for FakePermit {
    fn drop(&mut self) {
        if let Some(state) = self.state.upgrade() {
            state.reservations.lock().unwrap().remove(&self.id);
        }
    }
}

impl WebSocketAdmissionProvider for Arc<FakeAdmission> {
    fn reserve_connection(
        &self,
        context: &AuthContext,
    ) -> Result<Option<Arc<dyn WebSocketConnectionPermit>>, AuthDeny> {
        if self.deny_reserve.load(Ordering::Relaxed) {
            return Err(AuthDeny::new(
                AuthErrorCode::InternalError,
                "connection rejected by provider",
            ));
        }
        Ok(Some(self.permit(context)))
    }

    fn refresh_connection(
        &self,
        current_permit: Option<Arc<dyn WebSocketConnectionPermit>>,
        context: &AuthContext,
        active_subscriptions: &[String],
    ) -> Result<Option<Arc<dyn WebSocketConnectionPermit>>, AuthDeny> {
        if let Some(entered) = self.refresh_entered.lock().unwrap().take() {
            let _ = entered.send(());
        }
        if let Some(release) = self.refresh_release.lock().unwrap().take() {
            let _ = release.recv();
        }
        if self.deny_refresh.load(Ordering::Relaxed) {
            return Err(AuthDeny::new(
                AuthErrorCode::TokenExpired,
                "refresh rejected",
            ));
        }
        let permit = current_permit.unwrap_or_else(|| self.permit(context));
        let mut reservations = self.reservations.lock().unwrap();
        let reservation = reservations.get_mut(&permit.id()).unwrap();
        reservation.context = context.clone();
        reservation.subscriptions = active_subscriptions.iter().cloned().collect();
        drop(reservations);
        Ok(Some(permit))
    }

    fn add_subscription(&self, permit: Uuid, subscription_id: &str) -> Result<bool, AuthDeny> {
        let mut reservations = self.reservations.lock().unwrap();
        let reservation = reservations.get_mut(&permit).unwrap();
        Ok(reservation
            .subscriptions
            .insert(subscription_id.to_string()))
    }

    fn remove_subscription(&self, permit: Uuid, subscription_id: &str) {
        if let Some(reservation) = self.reservations.lock().unwrap().get_mut(&permit) {
            reservation.subscriptions.remove(subscription_id);
        }
    }

    fn check_inbound_message(&self, _permit: Uuid) -> Result<(), AuthDeny> {
        if self.deny_inbound.load(Ordering::Relaxed) {
            Err(AuthDeny::rate_limited(
                Duration::from_secs(60),
                "provider inbound",
            ))
        } else {
            Ok(())
        }
    }

    fn check_egress(&self, _permit: Uuid, _bytes: usize) -> Result<(), AuthDeny> {
        if self.deny_egress.load(Ordering::Relaxed) {
            Err(AuthDeny::rate_limited(
                Duration::from_secs(60),
                "provider egress",
            ))
        } else {
            Ok(())
        }
    }
}

fn context(subject: &str) -> AuthContext {
    AuthContext::from_claims(
        SessionClaims::builder("issuer", subject, "audience")
            .with_metering_key(subject)
            .build(),
    )
}

fn insert_client(
    manager: &ClientManager,
    provider: &Arc<FakeAdmission>,
    context: AuthContext,
) -> Uuid {
    let client_id = Uuid::new_v4();
    let (sender, _receiver) = mpsc::channel(4);
    let mut client = ClientInfo::new(
        client_id,
        sender,
        Some(context.clone()),
        SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), 1234),
    );
    client.admission_permit = provider.reserve_connection(&context).unwrap();
    manager.clients.insert(client_id, client);
    client_id
}

async fn test_websocket_sender() -> WebSocketSender {
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let addr = listener.local_addr().unwrap();
    let (accepted, connected) = tokio::join!(listener.accept(), TcpStream::connect(addr));
    let (server_stream, _) = accepted.unwrap();
    let _client_stream = connected.unwrap();
    let socket = WebSocketStream::from_raw_socket(server_stream, Role::Server, None).await;
    socket.split().0
}

#[tokio::test]
async fn provider_reservations_follow_connection_and_subscription_lifecycle() {
    let provider = Arc::new(FakeAdmission::default());
    let manager = ClientManager::new().with_admission_provider(Arc::new(provider.clone()));
    let client_id = insert_client(&manager, &provider, context("actor:1"));
    assert_eq!(provider.reservation_count(), 1);

    let token = CancellationToken::new();
    assert!(manager
        .try_add_client_subscription(client_id, "sub-1".into(), token)
        .await
        .unwrap());
    assert_eq!(
        provider
            .reservations
            .lock()
            .unwrap()
            .values()
            .next()
            .unwrap()
            .subscriptions
            .len(),
        1
    );
    assert!(manager.remove_client_subscription(client_id, "sub-1").await);
    manager.remove_client(client_id);
    assert_eq!(provider.reservation_count(), 0);
}

#[tokio::test]
async fn public_add_client_returns_connection_denial() {
    let provider = Arc::new(FakeAdmission::default());
    provider.deny_reserve.store(true, Ordering::Relaxed);
    let manager = ClientManager::new().with_admission_provider(Arc::new(provider));
    let client_id = Uuid::new_v4();

    let deny = manager
        .add_client(
            client_id,
            test_websocket_sender().await,
            Some(context("actor:denied")),
            SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), 1234),
        )
        .unwrap_err();

    assert_eq!(deny.reason, "connection rejected by provider");
    assert!(!manager.has_client(client_id));
}

#[tokio::test]
async fn rejected_refresh_preserves_the_existing_context_and_permit() {
    let provider = Arc::new(FakeAdmission::default());
    let manager = ClientManager::new().with_admission_provider(Arc::new(provider.clone()));
    let client_id = insert_client(&manager, &provider, context("actor:old"));
    provider.deny_refresh.store(true, Ordering::Relaxed);

    assert!(manager
        .try_update_client_auth_async(client_id, context("actor:new"))
        .await
        .is_err());
    assert_eq!(
        manager
            .clients
            .get(&client_id)
            .unwrap()
            .auth_context
            .as_ref()
            .unwrap()
            .subject,
        "actor:old"
    );
    assert_eq!(provider.reservation_count(), 1);
}

#[tokio::test]
async fn public_sync_refresh_keeps_its_bool_contract() {
    let provider = Arc::new(FakeAdmission::default());
    let manager = ClientManager::new().with_admission_provider(Arc::new(provider.clone()));
    let client_id = insert_client(&manager, &provider, context("actor:old"));

    let refreshed: bool = manager.update_client_auth(client_id, context("actor:new"));

    assert!(refreshed);
    assert_eq!(
        manager
            .clients
            .get(&client_id)
            .unwrap()
            .auth_context
            .as_ref()
            .unwrap()
            .subject,
        "actor:new"
    );
}

#[tokio::test]
async fn public_try_refresh_reports_busy_so_a_host_can_retry() {
    let provider = Arc::new(FakeAdmission::default());
    let manager = ClientManager::new().with_admission_provider(Arc::new(provider.clone()));
    let client_id = insert_client(&manager, &provider, context("actor:old"));
    let lifecycle = manager
        .clients
        .get(&client_id)
        .unwrap()
        .admission_lifecycle
        .clone();
    let _busy = lifecycle.lock().await;

    let error = manager
        .try_update_client_auth(client_id, context("actor:new"))
        .unwrap_err();

    assert_eq!(error.code, AuthErrorCode::InternalError);
    assert_eq!(error.reason, "Subscription admission is busy");
    assert_eq!(
        manager
            .clients
            .get(&client_id)
            .unwrap()
            .auth_context
            .as_ref()
            .unwrap()
            .subject,
        "actor:old"
    );
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn refresh_serializes_subscription_changes_without_holding_the_registry() {
    let provider = Arc::new(FakeAdmission::default());
    let manager =
        Arc::new(ClientManager::new().with_admission_provider(Arc::new(provider.clone())));
    let client_id = insert_client(&manager, &provider, context("actor:old"));
    let (entered_tx, entered_rx) = sync_mpsc::channel();
    let (release_tx, release_rx) = sync_mpsc::channel();
    provider.block_next_refresh(entered_tx, release_rx);

    let refresh_manager = manager.clone();
    let refresh = tokio::spawn(async move {
        refresh_manager
            .try_update_client_auth_async(client_id, context("actor:new"))
            .await
    });
    tokio::task::spawn_blocking(move || entered_rx.recv_timeout(Duration::from_secs(1)))
        .await
        .unwrap()
        .unwrap();

    let probe_manager = manager.clone();
    let registry_available =
        tokio::task::spawn_blocking(move || probe_manager.has_client(client_id));
    assert!(
        tokio::time::timeout(Duration::from_millis(250), registry_available)
            .await
            .unwrap()
            .unwrap()
    );

    let add_manager = manager.clone();
    let mut add = tokio::spawn(async move {
        add_manager
            .try_add_client_subscription(
                client_id,
                "sub-during-refresh".into(),
                CancellationToken::new(),
            )
            .await
    });
    assert!(tokio::time::timeout(Duration::from_millis(50), &mut add)
        .await
        .is_err());

    release_tx.send(()).unwrap();
    assert!(refresh.await.unwrap().unwrap());
    assert!(add.await.unwrap().unwrap());
    let reservations = provider.reservations.lock().unwrap();
    let reservation = reservations.values().next().unwrap();
    assert_eq!(reservation.context.subject, "actor:new");
    assert_eq!(
        reservation.subscriptions,
        HashSet::from(["sub-during-refresh".to_string()])
    );
}

#[tokio::test]
async fn refresh_waits_for_an_in_progress_subscription_change() {
    let provider = Arc::new(FakeAdmission::default());
    let manager =
        Arc::new(ClientManager::new().with_admission_provider(Arc::new(provider.clone())));
    let client_id = insert_client(&manager, &provider, context("actor:old"));
    let lifecycle = manager
        .clients
        .get(&client_id)
        .unwrap()
        .admission_lifecycle
        .clone();
    let lifecycle_guard = lifecycle.lock().await;

    let refresh_manager = manager.clone();
    let mut refresh = tokio::spawn(async move {
        refresh_manager
            .try_update_client_auth_async(client_id, context("actor:new"))
            .await
    });
    assert!(
        tokio::time::timeout(Duration::from_millis(50), &mut refresh)
            .await
            .is_err()
    );

    drop(lifecycle_guard);
    assert!(refresh.await.unwrap().unwrap());
    assert_eq!(
        manager
            .clients
            .get(&client_id)
            .unwrap()
            .auth_context
            .as_ref()
            .unwrap()
            .subject,
        "actor:new"
    );
}

#[tokio::test]
async fn inbound_denial_remains_deliverable_while_egress_denial_disconnects() {
    let provider = Arc::new(FakeAdmission::default());
    let manager = ClientManager::new().with_admission_provider(Arc::new(provider.clone()));
    let inbound = Uuid::new_v4();
    let (sender, mut receiver) = mpsc::channel(4);
    let inbound_context = context("actor:inbound");
    let mut client = ClientInfo::new(
        inbound,
        sender,
        Some(inbound_context.clone()),
        SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), 1234),
    );
    client.admission_permit = provider.reserve_connection(&inbound_context).unwrap();
    manager.clients.insert(inbound, client);
    provider.deny_inbound.store(true, Ordering::Relaxed);
    let deny = manager.check_inbound_message_allowed(inbound).unwrap_err();
    assert!(manager.has_client(inbound));
    manager
        .send_text_to_client(inbound, deny.reason.clone())
        .await
        .unwrap();
    assert_eq!(
        receiver.recv().await,
        Some(Message::Text(deny.reason.into()))
    );
    manager.remove_client(inbound);

    provider.deny_inbound.store(false, Ordering::Relaxed);
    let egress = insert_client(&manager, &provider, context("actor:egress"));
    provider.deny_egress.store(true, Ordering::Relaxed);
    assert!(manager.enforce_egress_budgets(egress, 32).is_err());
    assert!(!manager.has_client(egress));
}

/// A client that stops reading is evicted when its queue fills. Its writer
/// may then be blocked on the socket; after a bounded grace the server drops
/// the socket instead of holding it, uncounted, until the peer reads again.
#[tokio::test]
async fn an_evicted_client_that_stops_reading_loses_its_socket() {
    use tokio::io::AsyncReadExt;

    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let addr = listener.local_addr().unwrap();
    let (accepted, connected) = tokio::join!(listener.accept(), TcpStream::connect(addr));
    let (server_stream, _) = accepted.unwrap();
    let mut peer = connected.unwrap();
    let socket = WebSocketStream::from_raw_socket(server_stream, Role::Server, None).await;
    let manager = ClientManager::new().with_message_queue_size(8);
    let client_id = Uuid::new_v4();
    manager
        .add_client(client_id, socket.split().0, None, addr)
        .unwrap();

    let frame = 1 << 20;
    let payload = Arc::new(Bytes::from(vec![0u8; frame]));
    let mut queued = 0usize;
    while manager.send_to_client(client_id, payload.clone()).is_ok() {
        queued += 1;
        tokio::task::yield_now().await;
    }
    assert!(
        !manager.has_client(client_id),
        "a full queue evicts the client"
    );

    tokio::time::sleep(REMOVED_CLIENT_WRITE_GRACE * 3).await;
    let mut received = 0usize;
    let mut buffer = vec![0; 1 << 16];
    tokio::time::timeout(Duration::from_secs(10), async {
        loop {
            match peer.read(&mut buffer).await {
                Ok(0) | Err(_) => return,
                Ok(read) => received += read,
            }
        }
    })
    .await
    .expect("the server closes the socket");
    assert!(
        received < queued * frame,
        "the dropped socket must not deliver everything queued: {received} of {} bytes",
        queued * frame
    );
}

fn account_context(consumer: &str, account: &str, max_account_connections: u32) -> AuthContext {
    let mut context = context(consumer);
    context.actor_key = Some(consumer.to_string());
    context.consumer_key = Some(consumer.to_string());
    context.account_key = Some(account.to_string());
    context.policy_version = Some(1);
    context.account_limits.max_connections = Some(max_account_connections);
    context
}

/// Two sockets refreshing into an account with one free place: the second
/// refresh waits for the first to install its identity, then sees the
/// account full. Without that, both counted the same free place and both won.
///
/// The parked first refresh blocks a worker inside the fake provider, and a
/// second refresh that does not wait would block another on the provider's
/// hook lock; a third worker keeps the timer running so that case fails
/// rather than hangs.
#[tokio::test(flavor = "multi_thread", worker_threads = 3)]
async fn concurrent_refreshes_cannot_share_an_accounts_last_place() {
    let provider = Arc::new(FakeAdmission::default());
    let manager =
        Arc::new(ClientManager::new().with_admission_provider(Arc::new(provider.clone())));
    insert_client(
        &manager,
        &provider,
        account_context("consumer:b", "account:b", 2),
    );
    let first = insert_client(
        &manager,
        &provider,
        account_context("consumer:c", "account:c", 9),
    );
    let second = insert_client(
        &manager,
        &provider,
        account_context("consumer:d", "account:d", 9),
    );
    let (entered_tx, entered_rx) = sync_mpsc::channel();
    let (release_tx, release_rx) = sync_mpsc::channel();
    provider.block_next_refresh(entered_tx, release_rx);

    let first_manager = manager.clone();
    let first_refresh = tokio::spawn(async move {
        first_manager
            .try_update_client_auth_async(first, account_context("consumer:b", "account:b", 2))
            .await
    });
    tokio::task::spawn_blocking(move || entered_rx.recv_timeout(Duration::from_secs(1)))
        .await
        .unwrap()
        .unwrap();

    let second_manager = manager.clone();
    let mut second_refresh = tokio::spawn(async move {
        second_manager
            .try_update_client_auth_async(second, account_context("consumer:b", "account:b", 2))
            .await
    });
    // Give the second refresh time to race the first. Release the first
    // before asserting anything, so a failure cannot leave it parked.
    let early = tokio::time::timeout(Duration::from_millis(100), &mut second_refresh).await;
    release_tx.send(()).unwrap();
    assert!(first_refresh.await.unwrap().unwrap());
    let second = match early {
        Ok(finished) => finished,
        Err(_) => second_refresh.await,
    };
    let deny = second
        .unwrap()
        .expect_err("the second refresh must not take the place the first took");
    assert_eq!(deny.code, AuthErrorCode::ConnectionLimitExceeded);
}