bevy-agent-feedback-plugin 0.5.0

Let AI coding agents see and control your Bevy app: input injection, labeled screenshots, and frame-synced feedback over a JSON-lines TCP protocol.
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
use crate::{
    config::AgentFeedbackConfig,
    protocol::{
        AgentCommand, AgentResponse, ParseLimits, parse_request_with_limits, write_protocol_file,
    },
    session::AgentFeedbackSession,
};
use bevy::{app::AppExit, prelude::*};
use serde_json::Value;
use std::{
    io::{self, Read, Write},
    net::{SocketAddr, TcpListener, TcpStream},
    path::PathBuf,
    sync::{
        Arc, Mutex,
        atomic::{AtomicBool, Ordering},
        mpsc::{Receiver, SyncSender, TryRecvError, TrySendError, sync_channel},
    },
    thread::{self, JoinHandle},
    time::{Duration, Instant},
};

pub(crate) struct AgentFeedbackRuntimePlugin;

impl Plugin for AgentFeedbackRuntimePlugin {
    fn build(&self, app: &mut App) {
        let config = app.world().resource::<AgentFeedbackConfig>().clone();
        let session = AgentFeedbackSession::new(&config);
        match start_runtime(&config, session.clone()) {
            Ok((runtime, socket_addr)) => {
                if let Err(error) = write_protocol_file(&config, &session, socket_addr) {
                    log::error!("failed to write agent protocol file: {error}");
                }
                app.insert_resource(session).insert_resource(runtime);
            }
            Err(error) => log::error!("failed to start agent feedback socket: {error}"),
        }
    }
}

#[derive(Resource)]
pub(crate) struct AgentFeedbackRuntime {
    pub(crate) requests: Mutex<Receiver<AgentRequest>>,
    pub(crate) release_on_disconnect: Arc<AtomicBool>,
    last_accepted_command: Instant,
    running: Arc<AtomicBool>,
    thread: Mutex<Option<JoinHandle<()>>>,
    session: AgentFeedbackSession,
    protocol_file: PathBuf,
}

impl AgentFeedbackRuntime {
    pub(crate) fn record_accepted_command(&mut self) {
        self.last_accepted_command = Instant::now();
    }
}

impl Drop for AgentFeedbackRuntime {
    fn drop(&mut self) {
        self.running.store(false, Ordering::Relaxed);
        let Ok(mut thread) = self.thread.lock() else {
            self.session.cleanup(&self.protocol_file);
            return;
        };
        if let Some(thread) = thread.take() {
            let _ = thread.join();
        }
        self.session.cleanup(&self.protocol_file);
    }
}

pub(crate) struct AgentRequest {
    pub(crate) id: Value,
    pub(crate) command: AgentCommand,
    pub(crate) responder: SyncSender<AgentResponse>,
    pub(crate) canceled: Arc<AtomicBool>,
}

struct ServerSettings {
    command_timeout: Duration,
    max_wait_frames: u16,
    max_action_steps: u16,
    max_time_advance_steps: u16,
    max_time_advance: Duration,
    release_on_disconnect: Arc<AtomicBool>,
}

pub(crate) fn idle_shutdown(
    config: Res<AgentFeedbackConfig>,
    runtime: Option<ResMut<AgentFeedbackRuntime>>,
    mut app_exit: MessageWriter<AppExit>,
) {
    let Some(idle_after) = config.idle_shutdown_after else {
        return;
    };
    let Some(mut runtime) = runtime else {
        return;
    };
    let idle_after = idle_after.max(Duration::from_secs(5));
    if runtime.last_accepted_command.elapsed() < idle_after {
        return;
    }

    runtime.last_accepted_command = Instant::now();
    log::warn!(
        "agent feedback idle shutdown after {} ms without an accepted command",
        idle_after.as_millis()
    );
    app_exit.write(AppExit::Success);
}

fn start_runtime(
    config: &AgentFeedbackConfig,
    session: AgentFeedbackSession,
) -> io::Result<(AgentFeedbackRuntime, SocketAddr)> {
    let listener = TcpListener::bind(config.bind_addr)?;
    listener.set_nonblocking(true)?;
    let socket_addr = listener.local_addr()?;
    let (sender, receiver) = sync_channel(config.max_pending_commands.max(1));
    let running = Arc::new(AtomicBool::new(true));
    let release_on_disconnect = Arc::new(AtomicBool::new(false));
    let last_accepted_command = Instant::now();
    let server_running = running.clone();
    let settings = ServerSettings {
        command_timeout: config.command_timeout,
        max_wait_frames: config.max_wait_frames,
        max_action_steps: config.max_action_steps,
        max_time_advance_steps: config.max_time_advance_steps,
        max_time_advance: config.max_time_advance,
        release_on_disconnect: release_on_disconnect.clone(),
    };
    let thread = thread::Builder::new()
        .name("bevy-agent-feedback".to_string())
        .spawn(move || server_loop(listener, sender, server_running, settings))?;

    Ok((
        AgentFeedbackRuntime {
            requests: Mutex::new(receiver),
            release_on_disconnect,
            last_accepted_command,
            running,
            thread: Mutex::new(Some(thread)),
            protocol_file: config.protocol_file.clone(),
            session,
        },
        socket_addr,
    ))
}

fn server_loop(
    listener: TcpListener,
    sender: SyncSender<AgentRequest>,
    running: Arc<AtomicBool>,
    settings: ServerSettings,
) {
    while running.load(Ordering::Relaxed) {
        match listener.accept() {
            Ok((stream, _)) => handle_client(stream, &sender, &running, &settings),
            Err(error) if error.kind() == io::ErrorKind::WouldBlock => {
                thread::sleep(Duration::from_millis(50));
            }
            Err(error) => {
                log::warn!("agent feedback socket accept failed: {error}");
                thread::sleep(Duration::from_millis(250));
            }
        }
    }
}

fn handle_client(
    mut stream: TcpStream,
    sender: &SyncSender<AgentRequest>,
    running: &AtomicBool,
    settings: &ServerSettings,
) {
    let _release_guard = DisconnectReleaseGuard {
        release_on_disconnect: settings.release_on_disconnect.clone(),
    };
    if stream
        .set_read_timeout(Some(Duration::from_millis(100)))
        .is_err()
    {
        return;
    }
    if stream
        .set_write_timeout(Some(settings.command_timeout))
        .is_err()
    {
        return;
    }

    let mut pending = Vec::with_capacity(1024);
    let mut buf = [0_u8; 1024];
    while running.load(Ordering::Relaxed) {
        match stream.read(&mut buf) {
            Ok(0) => return,
            Ok(read) => {
                if pending.len() + read > 8192 {
                    let _ = write_response(
                        &mut stream,
                        &AgentResponse::error(
                            Value::Null,
                            "line_too_long",
                            "request exceeds 8192 bytes",
                        ),
                    );
                    return;
                }
                pending.extend_from_slice(&buf[..read]);
                while let Some(newline) = pending.iter().position(|byte| *byte == b'\n') {
                    let line: Vec<u8> = pending.drain(..=newline).collect();
                    let line = String::from_utf8_lossy(&line);
                    let line = line.trim();
                    if !line.is_empty() && handle_line(line, &mut stream, sender, settings).is_err()
                    {
                        return;
                    }
                }
            }
            Err(error)
                if error.kind() == io::ErrorKind::WouldBlock
                    || error.kind() == io::ErrorKind::TimedOut => {}
            Err(error) => {
                let _ = write_response(
                    &mut stream,
                    &AgentResponse::error(Value::Null, "socket_error", error.to_string()),
                );
                return;
            }
        }
    }
}

const QUEUE_CLOSED: &str = "game command queue is closed; game likely exited - check game.log";

fn handle_line(
    line: &str,
    stream: &mut TcpStream,
    sender: &SyncSender<AgentRequest>,
    settings: &ServerSettings,
) -> io::Result<()> {
    let request = match parse_request_with_limits(
        line,
        ParseLimits {
            max_wait_frames: settings.max_wait_frames,
            max_action_steps: settings.max_action_steps,
            max_time_advance_steps: settings.max_time_advance_steps,
            max_time_advance: settings.max_time_advance,
        },
    ) {
        Ok(request) => request,
        Err(error) => {
            return write_response(
                stream,
                &AgentResponse::error(error.id, error.code, error.message),
            );
        }
    };

    let id = request.id.clone();
    let (response_sender, response_receiver) = sync_channel(1);
    let canceled = Arc::new(AtomicBool::new(false));
    let agent_request = AgentRequest {
        id: request.id,
        command: request.command,
        responder: response_sender,
        canceled: canceled.clone(),
    };

    match sender.try_send(agent_request) {
        Ok(()) => wait_for_response(
            stream,
            response_receiver,
            id,
            settings.command_timeout,
            &canceled,
        ),
        Err(TrySendError::Full(request)) => write_response(
            stream,
            &AgentResponse::error(request.id, "queue_full", "game command queue is full"),
        ),
        Err(TrySendError::Disconnected(request)) => write_response(
            stream,
            &AgentResponse::error(request.id, "closed", QUEUE_CLOSED),
        ),
    }
}

fn wait_for_response(
    stream: &mut TcpStream,
    response_receiver: Receiver<AgentResponse>,
    id: Value,
    command_timeout: Duration,
    canceled: &AtomicBool,
) -> io::Result<()> {
    let start = Instant::now();
    loop {
        let remaining = command_timeout.saturating_sub(start.elapsed());
        if remaining.is_zero() {
            break;
        }
        match response_receiver.recv_timeout(remaining.min(Duration::from_millis(20))) {
            Ok(response) => return write_response(stream, &response),
            Err(std::sync::mpsc::RecvTimeoutError::Timeout) => {
                if socket_closed(stream) {
                    canceled.store(true, Ordering::Release);
                    return Err(io::Error::new(
                        io::ErrorKind::BrokenPipe,
                        "client disconnected while command was pending",
                    ));
                }
            }
            Err(std::sync::mpsc::RecvTimeoutError::Disconnected) => {
                return write_response(stream, &AgentResponse::error(id, "closed", QUEUE_CLOSED));
            }
        }
    }
    match response_receiver.try_recv() {
        Ok(response) => write_response(stream, &response),
        Err(TryRecvError::Disconnected) => {
            write_response(stream, &AgentResponse::error(id, "closed", QUEUE_CLOSED))
        }
        Err(TryRecvError::Empty) => {
            canceled.store(true, Ordering::Release);
            write_response(
                stream,
                &AgentResponse::error(
                    id,
                    "timeout",
                    format!(
                        "game did not answer within {} ms",
                        command_timeout.as_millis()
                    ),
                ),
            )
        }
    }
}

fn socket_closed(stream: &TcpStream) -> bool {
    let mut byte = [0_u8; 1];
    match stream.peek(&mut byte) {
        Ok(0) => true,
        Ok(_) => false,
        Err(error)
            if error.kind() == io::ErrorKind::WouldBlock
                || error.kind() == io::ErrorKind::TimedOut =>
        {
            false
        }
        Err(_) => true,
    }
}

fn write_response(stream: &mut TcpStream, response: &AgentResponse) -> io::Result<()> {
    serde_json::to_writer(&mut *stream, response).map_err(io::Error::other)?;
    stream.write_all(b"\n")?;
    stream.flush()
}

struct DisconnectReleaseGuard {
    release_on_disconnect: Arc<AtomicBool>,
}

impl Drop for DisconnectReleaseGuard {
    fn drop(&mut self) {
        self.release_on_disconnect.store(true, Ordering::Relaxed);
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;
    use std::io::{BufRead, BufReader};

    #[test]
    fn queued_response_wins_at_zero_deadline() {
        let listener = TcpListener::bind(("127.0.0.1", 0)).expect("bind local response socket");
        listener
            .set_nonblocking(true)
            .expect("bound local response accept");
        let address = listener.local_addr().expect("local response address");
        let client = TcpStream::connect_timeout(&address, Duration::from_secs(1))
            .expect("connect local response socket");
        let (mut server, _) = listener.accept().expect("accept local response socket");
        client
            .set_read_timeout(Some(Duration::from_secs(1)))
            .expect("bound response read");
        server
            .set_write_timeout(Some(Duration::from_secs(1)))
            .expect("bound response write");

        let (response_sender, response_receiver) = sync_channel(1);
        response_sender
            .try_send(AgentResponse::ok(json!(17), "queued", None, None))
            .expect("prequeue response");
        let canceled = AtomicBool::new(false);

        wait_for_response(
            &mut server,
            response_receiver,
            json!(17),
            Duration::ZERO,
            &canceled,
        )
        .expect("write prequeued response");

        assert!(!canceled.load(Ordering::Acquire));
        let mut line = String::new();
        BufReader::new(client)
            .read_line(&mut line)
            .expect("read prequeued response");
        assert_eq!(
            serde_json::from_str::<Value>(&line).expect("response JSON"),
            json!({"id": 17, "ok": true, "result": {"status": "queued"}})
        );
    }
}