blitz-control-protocol 0.6.0

The Blitz agent-control and diagnostics surface: one vocabulary, one core, two transports
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
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
//! The socket transport, connecting half: finding a running host, and talking
//! to it.
//!
//! # Why this is a sibling of the server and not a layer above it
//!
//! A peer can be both. AgencyZero is driven by agents over this protocol while
//! it drives a browser it embeds, and a QA harness that launches a headless
//! host is a client of one socket in a process that could serve another. The
//! two halves share the vocabulary, the framing and the error taxonomy, and
//! neither is built on the other, so a build takes whichever halves it needs.
//!
//! Neither half needs blitz. The framing is the protocol; the document is not.
//! `ps-qa` takes this feature and nothing else, and `cargo tree -p ps-qa`
//! showing no renderer, window runtime or GPU stack is the check that keeps it
//! that way.
//!
//! The transport is deliberately not hand-rolled. Frames are length-prefixed
//! rather than newline-delimited, which is why a naive socket read hangs, and
//! `endpoint_libs`' `framed_json_neutral` is the same codec the server writes with.
//!
//! This was `ps-qa`'s `inspector` module. It moved here so there is one client
//! rather than one per consumer: the browser's own `chuzz-inspect` had grown a
//! second one that built its requests as untyped JSON by hand, with a comment
//! explaining which fields the runtime would and would not accept.

use std::collections::VecDeque;
use std::path::{Path, PathBuf};
use std::time::Duration;
use std::time::Instant;

use crate::{
    AgentControlRequest, AgentSnapshot, DEBUG_PROTOCOL_VERSION, DebugDescriptor, DebugEvent,
    DebugProtocolError, DebugResponse, DebugStream, DiagnosticsRequest, JsonRpcId, JsonRpcMessage,
    JsonRpcRequest, MCP_PROTOCOL_VERSION, MessageStream, TransportStream, WireMessage,
    decode_diagnostics_event_value, decode_response_value, decode_wire_value, encode_agent_request,
    encode_diagnostics_request, encode_rpc, peek_value_request_id,
};
use eyre::{Context, Result, bail, eyre};
use std::os::unix::ffi::OsStrExt;

use endpoint_libs::libs::ws::transport::framed::framed_json_neutral;
use endpoint_libs::libs::ws::transport::nagoya::NagoyaStream;
use nagoya::reactor::{Addr, Reactor, TcpStream};
use nagoya::timeout;

/// Matches the Python client's bench timeout. Long because a driven
/// interaction can leave the app resolving for a while before it answers.
const REQUEST_TIMEOUT: Duration = Duration::from_secs(60);
const MAX_QUEUED_EVENTS: usize = 256;

/// Where an inspector announced itself, and what it said.
#[derive(Debug)]
pub struct Descriptor {
    pub path: PathBuf,
    pub descriptor: DebugDescriptor,
    /// The descriptor verbatim, for the dump modes. Reprinting a re-serialized
    /// struct would hide any field this build of the tool does not know about.
    pub raw: serde_json::Value,
    verified_reachable: bool,
}

/// The reactor every inspector connection lives on.
///
/// A nagoya socket makes progress only while the reactor it was created on is
/// polled, and this client is a library: it does not own the caller's thread and
/// cannot assume one is polling anything. `Reactor::start` owns a thread, so a
/// connection keeps being driven between the caller's awaits.
///
/// One for the process rather than one per connection: a thread per inspector
/// connection would be a thread per command in a QA sweep.
fn client_reactor() -> &'static nagoya::reactor::Handle {
    static REACTOR: std::sync::OnceLock<(Reactor, nagoya::reactor::Handle)> =
        std::sync::OnceLock::new();
    let (_, handle) = REACTOR.get_or_init(|| {
        let reactor = Reactor::start().expect("inspector reactor could not start");
        let handle = reactor.handle();
        (reactor, handle)
    });
    handle
}

impl Descriptor {
    pub fn socket_path(&self) -> PathBuf {
        match self.descriptor.address.strip_prefix("unix://") {
            Some(path) => PathBuf::from(path),
            // The Python fell back to the descriptor path with the extension
            // swapped, and the server does name the socket that way.
            None => self.path.with_extension("sock"),
        }
    }

    /// Trap 8 in docs/performance.md: an unpinned descriptor directory keeps
    /// dead instances around. Pid existence is not enough: macOS reuses pids,
    /// so an unrelated process can make a stale descriptor look current. The
    /// control socket is the service, and a successful connection is the only
    /// liveness check that proves the descriptor can actually be used.
    fn is_reachable(&self) -> bool {
        std::os::unix::net::UnixStream::connect(self.socket_path()).is_ok()
    }

    pub fn warn_if_stale(&self) {
        if !self.verified_reachable && !self.is_reachable() {
            eprintln!(
                "warning: descriptor {} names pid {}, but its control socket is unreachable",
                self.path.display(),
                self.descriptor.pid
            );
        }
    }
}

/// Locate a running inspector, preferring an explicitly pinned descriptor.
///
/// `--descriptor <path>` wins. Otherwise the build's own pinned path is tried,
/// then the temporary directory is scanned, which is the fallback for a
/// hand-launched build and the one that can find a stale instance.
///
/// A named descriptor that is not there is an error, not an invitation to
/// scan. Falling through to discovery attached to the newest *other* host on
/// the machine, which on a machine running several suites at once is another
/// site's document: the tree came back, it was plausible, and it described a
/// page nobody had asked about. A typo in a path is not consent to inspect
/// somebody else's application.
pub fn discover(explicit: Option<&str>) -> Result<Descriptor> {
    if let Some(path) = explicit {
        let path = PathBuf::from(path);
        if !path.exists() {
            bail!(
                "descriptor {} does not exist. ps-qa attaches to the descriptor you \
                 name and to no other; omit --descriptor to discover a running host.",
                path.display()
            );
        }
        return read_descriptor(&path);
    }

    // The delivery script pins this path into the bundle's `Info.plist`, so a
    // locally built app announces itself here and nowhere else. Scanning only
    // $TMPDIR meant the one instance that was definitely running was the one
    // instance discovery could not see, and it picked a dead descriptor from a
    // previous run instead, which is how preferring a live pid still failed.
    let pinned = PathBuf::from("target/blitz-control.json");
    if pinned.exists()
        && let Ok(mut descriptor) = read_descriptor(&pinned)
        && descriptor.is_reachable()
    {
        descriptor.verified_reachable = true;
        return Ok(descriptor);
    }

    let root = PathBuf::from(std::env::var("TMPDIR").unwrap_or_else(|_| "/tmp".into()))
        .join("tauri-blitz-agent");
    let mut found: Vec<(std::time::SystemTime, PathBuf)> = std::fs::read_dir(&root)
        .into_iter()
        .flatten()
        .flatten()
        .map(|entry| entry.path())
        .filter(|path| path.extension().is_some_and(|ext| ext == "json"))
        .filter_map(|path| Some((path.metadata().ok()?.modified().ok()?, path)))
        .collect();
    found.sort();

    // Newest *reachable* instance, not simply newest.
    //
    // Descriptors outlive the process that wrote them, and a machine that has
    // run the app more than once has a directory full of them. Taking the most
    // recent file connected to whichever instance happened to exit last: at
    // best a refused connection, at worst a successful attach to a stale socket
    // and a set of numbers describing a process nobody is looking at. The
    // warning for that case already existed and was printed immediately before
    // connecting anyway.
    for (_, path) in found.iter().rev() {
        let Ok(mut descriptor) = read_descriptor(path) else {
            continue;
        };
        if descriptor.is_reachable() {
            descriptor.verified_reachable = true;
            return Ok(descriptor);
        }
    }

    bail!(
        "no reachable inspector descriptor found; is a diagnostics build running?\n\
         looked at target/blitz-control.json and {}. Pass --descriptor \
         <path> to inspect a specific descriptor.",
        root.display()
    )
}

fn read_descriptor(path: &Path) -> Result<Descriptor> {
    let text = std::fs::read_to_string(path)
        .with_context(|| format!("reading descriptor {}", path.display()))?;
    let raw: serde_json::Value = serde_json::from_str(&text)
        .with_context(|| format!("parsing descriptor {}", path.display()))?;
    let descriptor: DebugDescriptor = serde_json::from_value(raw.clone())
        .with_context(|| format!("descriptor {} is not a DebugDescriptor", path.display()))?;
    if descriptor.protocol_version != DEBUG_PROTOCOL_VERSION {
        bail!(
            "descriptor {} uses debug protocol {}, but this client speaks {}",
            path.display(),
            descriptor.protocol_version,
            DEBUG_PROTOCOL_VERSION
        );
    }
    Ok(Descriptor {
        path: path.to_path_buf(),
        descriptor,
        raw,
        verified_reachable: false,
    })
}

/// A connected inspector client.
///
/// `MessageStream` is the object-safe half of the endpoint-libs transport seam,
/// so the concrete framing type, which is opaque, never has to be named.
pub struct Client {
    stream: Box<dyn MessageStream>,
    next_id: i64,
    request_timeout: Duration,
    events: VecDeque<DebugEvent>,
}

#[derive(Debug)]
struct InspectorResponseError {
    code: String,
    message: String,
}

impl std::fmt::Display for InspectorResponseError {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            formatter,
            "inspector returned {}: {}",
            self.code, self.message
        )
    }
}

impl std::error::Error for InspectorResponseError {}

/// Whether a host refused a request because it does not have the thing asked
/// for, rather than because something went wrong.
///
/// The distinction matters for a headless host. It owns a document and no
/// compositor, so there are no frame metrics to report and saying "unsupported"
/// is the true answer. A caller that only wanted the numbers as context can
/// carry on without them; one that exists to judge frame timing cannot, and
/// should still fail.
pub fn is_unsupported(error: &eyre::Report) -> bool {
    error
        .downcast_ref::<InspectorResponseError>()
        .is_some_and(|refusal| refusal.code == "unsupported")
}

/// Return a bounded response category without exposing the inspector message.
pub fn safe_response_code(error: &eyre::Report) -> Option<&'static str> {
    let code = error
        .downcast_ref::<InspectorResponseError>()?
        .code
        .as_str();
    Some(match code {
        "notEditable" => "notEditable",
        "unknownNode" => "unknownNode",
        "documentUnavailable" => "documentUnavailable",
        "unsupportedRequest" => "unsupportedRequest",
        _ => "other",
    })
}

impl Client {
    fn queue_event(&mut self, event: DebugEvent) {
        if self.events.len() == MAX_QUEUED_EVENTS {
            self.events.pop_front();
        }
        self.events.push_back(event);
    }

    pub async fn connect(socket: &Path) -> Result<Self> {
        const CONNECT_DEADLINE: Duration = Duration::from_millis(500);
        const RETRY_DELAY: Duration = Duration::from_millis(20);

        let started = Instant::now();
        let stream = loop {
            let addr = Addr::path(socket.as_os_str().as_bytes())
                .map_err(|_| std::io::Error::other("socket path is not a valid unix address"))?;
            match TcpStream::connect(addr, client_reactor()).await {
                Ok(stream) => break stream,
                Err(_) if started.elapsed() < CONNECT_DEADLINE => {
                    nagoya::sleep(RETRY_DELAY).await;
                }
                Err(error) => {
                    return Err(error)
                        .with_context(|| format!("connecting to {}", socket.display()));
                }
            }
        };
        Ok(Self {
            stream: Box::new(TransportStream::new(framed_json_neutral(
                NagoyaStream::new(stream),
            ))),
            next_id: 0,
            request_timeout: REQUEST_TIMEOUT,
            events: VecDeque::new(),
        })
    }

    /// Bound every inspector exchange for a latency-sensitive command.
    ///
    /// Interactive dump/diagnostic modes retain the generous default. QA and
    /// coverage explicitly lower it so a dead action cannot multiply a
    /// minute-long transport wait across a suite.
    pub fn set_request_timeout(&mut self, request_timeout: Duration) {
        self.request_timeout = request_timeout;
    }

    pub fn request_timeout(&self) -> Duration {
        self.request_timeout
    }

    fn next_id(&mut self) -> JsonRpcId {
        self.next_id += 1;
        JsonRpcId::Number(self.next_id)
    }

    /// Send one request and return the frame that answers *it*.
    ///
    /// Matching on the id is not pedantry. The server pushes notifications on
    /// the same socket, so a client that returns the next frame it sees will
    /// eventually hand a console message back as though it were metrics.
    async fn exchange(
        &mut self,
        request: WireMessage,
        id: &JsonRpcId,
    ) -> Result<serde_json::Value> {
        self.stream
            .send(request)
            .await
            .map_err(|error| eyre!("sending to the inspector failed: {error}"))?;
        loop {
            let message = timeout(self.request_timeout, self.stream.recv())
                .await
                .map_err(|_| {
                    eyre!(
                        "the inspector did not answer within {:?}",
                        self.request_timeout
                    )
                })?
                .ok_or_else(|| eyre!("the inspector closed the connection"))?
                .map_err(|error| eyre!("reading from the inspector failed: {error}"))?;
            let value = decode_wire_value(message).map_err(protocol_error)?;
            if peek_value_request_id(&value).as_ref() == Some(id) {
                return Ok(value);
            }
            if let Ok(event) = decode_diagnostics_event_value(value) {
                self.queue_event(event);
            }
        }
    }

    /// A raw JSON-RPC call, for `initialize` and `tools/list`, which are not
    /// tool calls and so have no typed request in the protocol crate.
    pub async fn raw_request(
        &mut self,
        method: &str,
        params: serde_json::Value,
    ) -> Result<serde_json::Value> {
        let id = self.next_id();
        let request = encode_rpc(JsonRpcMessage::Request(JsonRpcRequest::call(
            id.clone(),
            method,
            params,
        )))
        .map_err(protocol_error)?;
        self.exchange(request, &id).await
    }

    pub async fn initialize(&mut self) -> Result<serde_json::Value> {
        self.raw_request(
            "initialize",
            serde_json::json!({"protocolVersion": MCP_PROTOCOL_VERSION}),
        )
        .await
    }

    pub async fn tools_list(&mut self) -> Result<serde_json::Value> {
        self.raw_request("tools/list", serde_json::json!({})).await
    }

    /// An agent-control call, encoded from the server's own type.
    ///
    /// This is the whole reason the protocol crate exists. `AgentAction` is
    /// adjacently tagged, so the `{"action":"click","node_id":9}` that reads
    /// correctly is not what the server accepts, and getting it wrong used to
    /// present as a hung application rather than as an encoding mistake.
    pub async fn agent(&mut self, request: &AgentControlRequest) -> Result<Answer> {
        let id = self.next_id();
        let frame = encode_agent_request(id.clone(), request).map_err(protocol_error)?;
        let value = self.exchange(frame, &id).await?;
        Answer::new(value)
    }

    pub async fn diagnostics(&mut self, request: &DiagnosticsRequest) -> Result<Answer> {
        let id = self.next_id();
        let frame = encode_diagnostics_request(id.clone(), request).map_err(protocol_error)?;
        let value = self.exchange(frame, &id).await?;
        Answer::new(value)
    }

    /// Establish a paint-event baseline immediately before driving input.
    ///
    /// New runtimes answer with `Ack` and suppress any revision that predates
    /// this call. Older runtimes answer `streamingUnavailable`; callers retain
    /// their bounded compatibility fallback in that case.
    pub async fn arm_paint_events(&mut self) -> Result<bool> {
        self.events
            .retain(|event| !matches!(event, DebugEvent::PaintCommitted { .. }));
        match self
            .diagnostics(&DiagnosticsRequest::Observe {
                streams: vec![DebugStream::Paint],
            })
            .await
        {
            Ok(_) => Ok(true),
            Err(error)
                if error
                    .downcast_ref::<InspectorResponseError>()
                    .is_some_and(|error| error.code == "streamingUnavailable") =>
            {
                Ok(false)
            }
            Err(error) => Err(error),
        }
    }

    /// Wait for the first real frame committed after an armed interaction.
    pub async fn wait_for_paint(&mut self, within: Duration) -> Result<bool> {
        if let Some(index) = self
            .events
            .iter()
            .position(|event| matches!(event, DebugEvent::PaintCommitted { .. }))
        {
            self.events.remove(index);
            return Ok(true);
        }

        let deadline = Instant::now() + within;
        loop {
            let remaining = deadline.saturating_duration_since(Instant::now());
            if remaining.is_zero() {
                return Ok(false);
            }
            let message = match timeout(remaining, self.stream.recv()).await {
                Ok(Some(message)) => message,
                Ok(None) | Err(_) => return Ok(false),
            };
            let message = message
                .map_err(|error| eyre!("reading paint event from inspector failed: {error}"))?;
            let value = decode_wire_value(message).map_err(protocol_error)?;
            match decode_diagnostics_event_value(value) {
                Ok(DebugEvent::PaintCommitted { .. }) => return Ok(true),
                Ok(event) => self.queue_event(event),
                Err(_) => {}
            }
        }
    }

    /// The same call, but returning a protocol-level error rather than failing
    /// on it.
    ///
    /// `watch` needs this because `observe` is not implemented server-side: it
    /// answers `streamingUnavailable`. Printing that answer and then draining
    /// is what the previous client did, and it is the more useful behaviour:
    /// the mode reports what the server said instead of dying on it.
    pub async fn diagnostics_envelope(
        &mut self,
        request: &DiagnosticsRequest,
    ) -> Result<serde_json::Value> {
        let id = self.next_id();
        let frame = encode_diagnostics_request(id.clone(), request).map_err(protocol_error)?;
        self.exchange(frame, &id).await
    }

    pub async fn agent_envelope(
        &mut self,
        request: &AgentControlRequest,
    ) -> Result<serde_json::Value> {
        let id = self.next_id();
        let frame = encode_agent_request(id.clone(), request).map_err(protocol_error)?;
        self.exchange(frame, &id).await
    }

    /// Collect pushed notifications for a while, as `watch` does.
    pub async fn drain(&mut self, seconds: f64) -> Result<Vec<serde_json::Value>> {
        let deadline = Instant::now() + Duration::from_secs_f64(seconds);
        let mut out = Vec::new();
        loop {
            let remaining = deadline.saturating_duration_since(Instant::now());
            if remaining.is_zero() {
                return Ok(out);
            }
            match timeout(remaining, self.stream.recv()).await {
                Err(_) => return Ok(out),
                Ok(None) => return Ok(out),
                Ok(Some(Ok(message))) => {
                    out.push(decode_wire_value(message).map_err(protocol_error)?)
                }
                Ok(Some(Err(error))) => bail!("reading from the inspector failed: {error}"),
            }
        }
    }
}

/// Read the application's semantic tree and report the inspector round-trip.
///
/// Most commands need this exact request. Keeping it beside the transport
/// prevents every command module from rebuilding the protocol exchange.
pub async fn inspect(client: &mut Client) -> Result<(AgentSnapshot, f64)> {
    inspect_from(client, None).await
}

/// Read only one semantic subtree.
///
/// Polling a known destination from the document root makes interaction
/// latency proportional to every unrelated node in the application. The
/// protocol already accepts a semantic root, so stabilization can acquire the
/// target once and observe only the component that must remain mounted.
pub async fn inspect_subtree(client: &mut Client, root: u64) -> Result<(AgentSnapshot, f64)> {
    inspect_from(client, Some(root)).await
}

async fn inspect_from(client: &mut Client, root: Option<u64>) -> Result<(AgentSnapshot, f64)> {
    let started = Instant::now();
    let answer = client
        .agent(&AgentControlRequest::Inspect {
            root,
            max_depth: 40,
        })
        .await?;
    let elapsed = started.elapsed().as_secs_f64() * 1000.0;
    match answer.response {
        DebugResponse::AgentSnapshot(snapshot) => Ok((snapshot, elapsed)),
        other => bail!("asked for a semantic snapshot, got {other:?}"),
    }
}

pub struct Answer {
    pub response: DebugResponse,
}

impl Answer {
    fn new(value: serde_json::Value) -> Result<Self> {
        let (_, response) = decode_response_value(value).map_err(protocol_error)?;
        if let DebugResponse::Error(error) = &response {
            return Err(eyre::Report::new(InspectorResponseError {
                code: error.code.clone(),
                message: error.message.clone(),
            }));
        }
        Ok(Self { response })
    }
}

fn protocol_error(error: DebugProtocolError) -> eyre::Report {
    eyre!("{error}")
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{JsonRpcResponse, encode_diagnostics_event};
    use nagoya::reactor::TcpListener;

    #[test]
    fn connect_retries_startup_and_exchange_preserves_events() {
        nagoya::block_on(async {
            let socket = std::env::temp_dir().join(format!(
                "ps-qa-transport-{}-{}.sock",
                std::process::id(),
                std::time::SystemTime::now()
                    .duration_since(std::time::UNIX_EPOCH)
                    .expect("system clock is after the epoch")
                    .as_nanos()
            ));
            let server_socket = socket.clone();
            let server = async move {
                // The descriptor can be visible before its socket is bound. Make
                // that production race deterministic and require the client retry.
                nagoya::sleep(Duration::from_millis(40)).await;
                let addr = Addr::path(server_socket.as_os_str().as_bytes()).expect("socket path");
                let listener = TcpListener::bind(addr, client_reactor()).expect("bind test socket");
                let (stream, _) = listener.accept().await.expect("accept test client");
                let mut stream =
                    TransportStream::new(framed_json_neutral(NagoyaStream::new(stream)));
                let _request = stream
                    .recv()
                    .await
                    .expect("client keeps connection open")
                    .expect("read initialize request");
                stream
                    .send(
                        encode_diagnostics_event(&DebugEvent::PaintCommitted { revision: 7 })
                            .expect("encode paint event"),
                    )
                    .await
                    .expect("send paint event");
                stream
                    .send(
                        encode_rpc(JsonRpcMessage::Response(JsonRpcResponse::result(
                            Some(JsonRpcId::Number(1)),
                            serde_json::json!({"protocolVersion": MCP_PROTOCOL_VERSION}),
                        )))
                        .expect("encode initialize response"),
                    )
                    .await
                    .expect("send initialize response");
            };

            let client_socket = socket.clone();
            let client = async move {
                let mut client = Client::connect(&client_socket)
                    .await
                    .expect("client retries until socket is bound");
                client.initialize().await.expect("initialize completes");
                assert!(
                    client
                        .wait_for_paint(Duration::ZERO)
                        .await
                        .expect("queued paint remains readable"),
                    "an event arriving before the response must not steal the response or be discarded"
                );
            };

            futures::future::join(server, client).await;
            let _ = std::fs::remove_file(socket);
        });
    }

    #[test]
    fn descriptor_protocol_mismatch_is_rejected_before_connecting() {
        let path = std::env::temp_dir().join(format!(
            "ps-qa-descriptor-version-{}-{}.json",
            std::process::id(),
            std::time::SystemTime::now()
                .duration_since(std::time::UNIX_EPOCH)
                .expect("system clock is after the epoch")
                .as_nanos()
        ));
        std::fs::write(
            &path,
            serde_json::json!({
                "protocolVersion": DEBUG_PROTOCOL_VERSION + 1,
                "pid": 1,
                "instanceId": "fixture",
                "address": "unix:///tmp/fixture.sock",
                "renderer": "fixture",
                "rendererRevision": "test"
            })
            .to_string(),
        )
        .expect("write descriptor fixture");
        let error = read_descriptor(&path).expect_err("newer protocol must not be guessed");
        assert!(
            error.to_string().contains("this client speaks"),
            "unexpected error: {error}"
        );
        let _ = std::fs::remove_file(path);
    }
}