lilo-rm-client 0.7.1

Runtime Matters client shell for the public rtmd Unix socket contract
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
use std::path::PathBuf;

use lilo_rm_client::{ClientError, RuntimeClient, request};
use lilo_rm_core::{
    CaptureError, CapturePayload, CaptureRequest, CaptureResponse, CursorExpiredPayload,
    DockerIsolationStatus, DockerReadiness, DockerStatus, DoctorPayload, DoctorResponse, ErrorCode,
    EventBatch, EventsPayload, EventsRequest, HeadlessSpawnTarget, KillByPidPayload,
    KillByPidRequest, KillByPidResponse, KillOutcome, KillRequest, KilledPayload, Lifecycle,
    LifecycleCounts, MigrationState, NudgeFailureReason, NudgeOutcome, NudgePayload, NudgeRequest,
    NudgeResponse, RuntimeEvent, RuntimeKind, RuntimeResponse, RuntimeRpc, RuntimeSignal,
    SpawnConflictKind, SpawnConflictPayload, SpawnRequest, SpawnTarget, SpawnedPayload,
    StatusFilter, StatusPayload, ValidateTargetPayload, ValidateTargetRequest,
    ValidateTargetResponse, VersionInfo, VersionPayload, WatcherCounts, read_json_line,
    write_json_line,
};
use tokio::io::BufReader;
use tokio::net::UnixListener;
use tokio::task::JoinHandle;
use uuid::Uuid;

fn temp_socket_path() -> (tempfile::TempDir, PathBuf) {
    let tempdir = tempfile::tempdir().expect("tempdir");
    let socket_path = tempdir.path().join("rtmd.sock");
    (tempdir, socket_path)
}

async fn mock_response(
    expected_rpc: RuntimeRpc,
    response: RuntimeResponse,
) -> (RuntimeClient, JoinHandle<()>) {
    let (tempdir, socket_path) = temp_socket_path();
    let listener = UnixListener::bind(&socket_path).expect("bind test socket");
    let client = RuntimeClient::new(socket_path);
    let server = tokio::spawn(async move {
        let _tempdir = tempdir;
        let (stream, _) = listener.accept().await.expect("accept client");
        let (read_half, mut write_half) = stream.into_split();
        let mut reader = BufReader::new(read_half);
        let rpc: RuntimeRpc = read_json_line(&mut reader).await.expect("read rpc");
        assert_eq!(rpc, expected_rpc);
        write_json_line(&mut write_half, &response)
            .await
            .expect("write response");
    });
    (client, server)
}

#[tokio::test]
async fn missing_socket_reports_daemon_unavailable() {
    let (_tempdir, socket_path) = temp_socket_path();

    let error = request(&socket_path, RuntimeRpc::Version)
        .await
        .expect_err("missing socket should fail");

    match error {
        ClientError::DaemonUnavailable {
            socket_path: actual,
            ..
        } => assert_eq!(actual, socket_path),
        other => panic!("unexpected client error: {other:?}"),
    }
}

#[tokio::test]
async fn daemon_error_response_preserves_code() {
    let (client, server) = mock_response(
        RuntimeRpc::Version,
        RuntimeResponse::error(ErrorCode::SessionNotFound, "missing session"),
    )
    .await;

    let error = client
        .request(RuntimeRpc::Version)
        .await
        .expect_err("daemon error response should fail");

    assert_error_response(error);
    server.await.expect("server task");
}

#[tokio::test]
async fn spawn_conflict_maps_to_typed_client_error() {
    let payload = SpawnConflictPayload {
        kind: SpawnConflictKind::SessionId,
        lifecycle: Lifecycle::forking(session_id(), RuntimeKind::Claude),
    };
    let (client, server) = mock_response(
        RuntimeRpc::Spawn {
            request: spawn_request(),
        },
        RuntimeResponse::SpawnConflict(payload.clone()),
    )
    .await;

    let error = client
        .spawn(spawn_request())
        .await
        .expect_err("spawn conflict should fail");

    match error {
        ClientError::SpawnConflict(actual) => assert_eq!(*actual, payload),
        other => panic!("unexpected client error: {other:?}"),
    }
    server.await.expect("server task");
}

macro_rules! typed_helper_tests {
    ($module:ident, $method:ident($($arg:expr),*), $rpc:expr, $ok:expr, $value:expr, $expected:literal) => {
        mod $module {
            use super::*;

            #[tokio::test]
            async fn happy_path_returns_typed_value() {
                let (client, server) = mock_response($rpc, $ok).await;
                let actual = client.$method($($arg),*)
                    .await
                    .expect("typed helper should succeed");
                assert_eq!(actual, $value);
                server.await.expect("server task");
            }

            #[tokio::test]
            async fn daemon_error_maps_to_client_error_response() {
                let (client, server) = mock_response(
                    $rpc,
                    RuntimeResponse::error(ErrorCode::SessionNotFound, "missing session"),
                )
                .await;
                let error = client.$method($($arg),*)
                    .await
                    .expect_err("daemon error should fail");
                assert_error_response(error);
                server.await.expect("server task");
            }

            #[tokio::test]
            async fn unexpected_variant_reports_expected_and_got() {
                let (client, server) = mock_response($rpc, unexpected_for($expected)).await;
                let error = client.$method($($arg),*)
                    .await
                    .expect_err("unexpected response should fail");
                assert_unexpected(error, $expected, unexpected_name_for($expected));
                server.await.expect("server task");
            }
        }
    };
}

fn assert_error_response(error: ClientError) {
    match error {
        ClientError::ErrorResponse { code, message } => {
            assert_eq!(code, ErrorCode::SessionNotFound);
            assert_eq!(message, "missing session");
        }
        other => panic!("unexpected client error: {other:?}"),
    }
}

fn assert_unexpected(error: ClientError, expected: &'static str, got: &'static str) {
    match error {
        ClientError::UnexpectedResponse {
            expected: actual_expected,
            got: actual_got,
        } => {
            assert_eq!(actual_expected, expected);
            assert_eq!(actual_got, got);
        }
        other => panic!("unexpected client error: {other:?}"),
    }
}

fn unexpected_for(expected: &str) -> RuntimeResponse {
    if expected == "Version" {
        RuntimeResponse::Ack
    } else {
        RuntimeResponse::Version(version_payload())
    }
}

fn unexpected_name_for(expected: &str) -> &'static str {
    if expected == "Version" {
        "Ack"
    } else {
        "Version"
    }
}

fn session_id() -> Uuid {
    Uuid::parse_str("018f6e28-0000-7000-8000-000000000001").expect("uuid")
}

fn spawn_request() -> SpawnRequest {
    SpawnRequest {
        session_id: session_id(),
        runtime: RuntimeKind::Claude,
        isolation: Default::default(),
        image: None,
        env: Vec::new(),
        mounts: Vec::new(),
        cwd: "/tmp/rtm".into(),
        target: SpawnTarget::Headless(HeadlessSpawnTarget {}),
        force: false,
        shell_resume: None,
    }
}

fn spawn_payload() -> SpawnedPayload {
    SpawnedPayload {
        lifecycle: Lifecycle::forking(session_id(), RuntimeKind::Claude),
        event: RuntimeEvent::Lost {
            session_id: session_id(),
            evidence: lilo_rm_core::LostEvidence::PidNotAlive,
        },
        log_dir: None,
        stdout_path: None,
        stderr_path: None,
    }
}

fn kill_request() -> KillRequest {
    KillRequest {
        session_id: session_id(),
        signal: RuntimeSignal::Term,
        grace_secs: 1,
    }
}

fn kill_by_pid_request() -> KillByPidRequest {
    KillByPidRequest {
        pid: 4242,
        signal: 15,
        grace_secs: 1,
    }
}

fn kill_by_pid_response() -> KillByPidResponse {
    KillByPidResponse {
        pid: 4242,
        signal: 15,
        killed_after_grace: false,
        outcome: KillOutcome::Signalled,
    }
}

fn nudge_request() -> NudgeRequest {
    NudgeRequest {
        session_id: session_id(),
        content: "wake up".to_owned(),
    }
}

fn nudge_payload() -> NudgePayload {
    NudgePayload {
        response: nudge_response(NudgeOutcome::Delivered),
    }
}

fn nudge_response(outcome: NudgeOutcome) -> NudgeResponse {
    NudgeResponse {
        delivered: matches!(outcome, NudgeOutcome::Delivered),
        outcome,
    }
}

fn unsupported_nudge_payload() -> NudgePayload {
    NudgePayload {
        response: NudgeResponse {
            delivered: false,
            outcome: NudgeOutcome::Unsupported(NudgeFailureReason::HeadlessLifecycle),
        },
    }
}

fn capture_request() -> CaptureRequest {
    CaptureRequest {
        session_id: session_id(),
        scrollback_lines: None,
    }
}

fn version_payload() -> VersionPayload {
    VersionPayload {
        version: VersionInfo::new("0.6.0", "test-sha"),
    }
}

fn doctor_payload() -> DoctorPayload {
    DoctorPayload {
        doctor: DoctorResponse {
            version: version_payload().version,
            socket_path: "/tmp/rtmd.sock".to_owned(),
            uptime_secs: 0,
            sqlite: MigrationState {
                applied: 0,
                total: 0,
                applied_descriptions: Vec::new(),
                pending_descriptions: Vec::new(),
            },
            lifecycles: LifecycleCounts::default(),
            watchers: WatcherCounts {
                process_exit_watchers: 0,
                shim_sockets: 0,
                event_waiters: 0,
            },
            launchers: Vec::new(),
            tmux: lilo_rm_core::TmuxStatus {
                available: false,
                version: None,
                error: None,
            },
            docker: Box::new(DockerStatus {
                cli: DockerReadiness::unavailable("docker unavailable"),
                daemon: DockerReadiness::unavailable("docker daemon unavailable"),
                manifest_validation: DockerReadiness::unavailable("docker manifest unavailable"),
                isolation: DockerIsolationStatus {
                    supported: true,
                    default_workspace: "/workspace".to_owned(),
                    experimental: true,
                },
            }),
            log_availability: Vec::new(),
            last_probe_sweep: None,
            recent_lost: Vec::new(),
        },
    }
}

typed_helper_tests!(
    spawn_helper,
    spawn(spawn_request()),
    RuntimeRpc::Spawn {
        request: spawn_request()
    },
    RuntimeResponse::Spawned(spawn_payload()),
    spawn_payload(),
    "Spawned"
);

typed_helper_tests!(
    kill_helper,
    kill(kill_request()),
    RuntimeRpc::Kill {
        request: kill_request()
    },
    RuntimeResponse::Killed(KilledPayload {
        outcome: KillOutcome::Signalled
    }),
    KillOutcome::Signalled,
    "Killed"
);

typed_helper_tests!(
    kill_by_pid_helper,
    kill_by_pid(kill_by_pid_request()),
    RuntimeRpc::KillByPid {
        request: kill_by_pid_request()
    },
    RuntimeResponse::KillByPid(KillByPidPayload {
        response: kill_by_pid_response()
    }),
    KillOutcome::Signalled,
    "KillByPid"
);

typed_helper_tests!(
    status_helper,
    status(StatusFilter::default()),
    RuntimeRpc::Status {
        request: StatusFilter::default().into()
    },
    RuntimeResponse::Status(StatusPayload {
        lifecycles: Vec::new()
    }),
    StatusPayload {
        lifecycles: Vec::new()
    },
    "Status"
);

typed_helper_tests!(
    nudge_helper,
    nudge(nudge_request()),
    RuntimeRpc::Nudge {
        request: nudge_request()
    },
    RuntimeResponse::Nudge(nudge_payload()),
    nudge_response(NudgeOutcome::Delivered),
    "Nudge"
);

#[tokio::test]
async fn nudge_helper_preserves_unsupported_headless_outcome() {
    let (client, server) = mock_response(
        RuntimeRpc::Nudge {
            request: nudge_request(),
        },
        RuntimeResponse::Nudge(unsupported_nudge_payload()),
    )
    .await;

    let actual = client
        .nudge(nudge_request())
        .await
        .expect("unsupported nudge response is caller visible");

    assert_eq!(
        actual,
        nudge_response(NudgeOutcome::Unsupported(
            NudgeFailureReason::HeadlessLifecycle
        ))
    );
    server.await.expect("server task");
}

#[tokio::test]
async fn nudge_helper_preserves_tmux_pane_dead_outcome() {
    let (client, server) = mock_response(
        RuntimeRpc::Nudge {
            request: nudge_request(),
        },
        RuntimeResponse::Nudge(NudgePayload {
            response: nudge_response(NudgeOutcome::Failed(NudgeFailureReason::TmuxPaneDead)),
        }),
    )
    .await;

    let actual = client
        .nudge(nudge_request())
        .await
        .expect("failed nudge response is caller visible");

    assert_eq!(
        actual,
        nudge_response(NudgeOutcome::Failed(NudgeFailureReason::TmuxPaneDead))
    );
    server.await.expect("server task");
}

#[tokio::test]
async fn nudge_helper_preserves_terminal_session_outcome() {
    let (client, server) = mock_response(
        RuntimeRpc::Nudge {
            request: nudge_request(),
        },
        RuntimeResponse::Nudge(NudgePayload {
            response: nudge_response(NudgeOutcome::Failed(NudgeFailureReason::SessionEnded)),
        }),
    )
    .await;

    let actual = client
        .nudge(nudge_request())
        .await
        .expect("terminal nudge response is caller visible");

    assert_eq!(
        actual,
        nudge_response(NudgeOutcome::Failed(NudgeFailureReason::SessionEnded))
    );
    server.await.expect("server task");
}

typed_helper_tests!(
    capture_helper,
    capture(capture_request()),
    RuntimeRpc::Capture {
        request: capture_request()
    },
    RuntimeResponse::Capture(CapturePayload {
        response: CaptureResponse::Failed(CaptureError::PaneUnavailable)
    }),
    CaptureResponse::Failed(CaptureError::PaneUnavailable),
    "Capture"
);

typed_helper_tests!(
    validate_target_helper,
    validate_target("headless"),
    RuntimeRpc::ValidateTarget {
        request: ValidateTargetRequest {
            target: "headless".to_owned()
        }
    },
    RuntimeResponse::ValidateTarget(ValidateTargetPayload {
        response: ValidateTargetResponse::valid()
    }),
    ValidateTargetResponse::valid(),
    "ValidateTarget"
);

typed_helper_tests!(
    doctor_helper,
    doctor(),
    RuntimeRpc::Doctor,
    RuntimeResponse::Doctor(doctor_payload()),
    doctor_payload(),
    "Doctor"
);

typed_helper_tests!(
    version_helper,
    version(),
    RuntimeRpc::Version,
    RuntimeResponse::Version(version_payload()),
    version_payload(),
    "Version"
);

typed_helper_tests!(
    events_helper,
    events(EventsRequest::default()),
    RuntimeRpc::Events {
        request: EventsRequest::default()
    },
    RuntimeResponse::Events(EventsPayload {
        events: Vec::new(),
        cursor: 0
    }),
    EventBatch::Events {
        events: Vec::new(),
        cursor: 0
    },
    "Events or CursorExpired"
);

#[tokio::test]
async fn events_helper_returns_cursor_expired_batch() {
    let (client, server) = mock_response(
        RuntimeRpc::Events {
            request: EventsRequest {
                since: Some(5),
                wait_ms: Some(0),
            },
        },
        RuntimeResponse::CursorExpired(CursorExpiredPayload { oldest: 9 }),
    )
    .await;

    let actual = client
        .events(EventsRequest {
            since: Some(5),
            wait_ms: Some(0),
        })
        .await
        .expect("cursor expired is a typed event batch");

    assert_eq!(actual, EventBatch::CursorExpired { oldest: 9 });
    server.await.expect("server task");
}