vifu-runtime 0.1.12

Embeddable Agent Runtime primitives for product-owned agents and endpoints.
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
use std::collections::VecDeque;
use std::fmt;

use bevy_app::{App, Plugin};
use bevy_ecs::prelude::*;
use bevy_ecs::schedule::ScheduleLabel;
use serde::{Deserialize, Serialize};
use serde_json::Value;

#[derive(Clone, Debug, Hash, PartialEq, Eq, ScheduleLabel)]
pub struct RuntimeSchedule;

#[derive(Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RuntimeCommand {
    pub id: String,
    pub name: String,
    #[serde(default)]
    pub payload: Value,
}

impl fmt::Debug for RuntimeCommand {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter
            .debug_struct("RuntimeCommand")
            .field("id", &self.id)
            .field("name", &self.name)
            .field("payload", &"[REDACTED]")
            .finish()
    }
}

impl RuntimeCommand {
    pub fn new(id: impl Into<String>, name: impl Into<String>, payload: Value) -> Self {
        Self {
            id: id.into(),
            name: name.into(),
            payload,
        }
    }
}

#[derive(Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RuntimeEvent {
    pub sequence: u64,
    pub name: String,
    #[serde(default)]
    pub payload: Value,
}

impl fmt::Debug for RuntimeEvent {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter
            .debug_struct("RuntimeEvent")
            .field("sequence", &self.sequence)
            .field("name", &self.name)
            .field("payload", &"[REDACTED]")
            .finish()
    }
}

#[derive(Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct EffectRequest {
    pub id: String,
    pub kind: String,
    #[serde(default)]
    pub payload: Value,
}

impl fmt::Debug for EffectRequest {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter
            .debug_struct("EffectRequest")
            .field("id", &self.id)
            .field("kind", &self.kind)
            .field("payload", &"[REDACTED]")
            .finish()
    }
}

#[derive(Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct EffectResult {
    pub effect_id: String,
    pub succeeded: bool,
    #[serde(default)]
    pub output: Value,
}

impl fmt::Debug for EffectResult {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter
            .debug_struct("EffectResult")
            .field("effect_id", &self.effect_id)
            .field("succeeded", &self.succeeded)
            .field("output", &"[REDACTED]")
            .finish()
    }
}

#[derive(Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RuntimeSnapshot {
    pub revision: u64,
    #[serde(default)]
    pub state: Value,
}

impl fmt::Debug for RuntimeSnapshot {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter
            .debug_struct("RuntimeSnapshot")
            .field("revision", &self.revision)
            .field("state", &"[REDACTED]")
            .finish()
    }
}

impl Default for RuntimeSnapshot {
    fn default() -> Self {
        Self {
            revision: 0,
            state: Value::Object(Default::default()),
        }
    }
}

#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RuntimeAdvance {
    pub snapshot: RuntimeSnapshot,
    pub events: Vec<RuntimeEvent>,
    pub effects: Vec<EffectRequest>,
}

#[derive(Resource, Default)]
pub struct RuntimeCommandQueue {
    commands: VecDeque<RuntimeCommand>,
}

impl RuntimeCommandQueue {
    pub fn push(&mut self, command: RuntimeCommand) {
        self.commands.push_back(command);
    }

    pub fn pop_front(&mut self) -> Option<RuntimeCommand> {
        self.commands.pop_front()
    }

    pub fn drain(&mut self) -> impl Iterator<Item = RuntimeCommand> + '_ {
        self.commands.drain(..)
    }

    pub fn is_empty(&self) -> bool {
        self.commands.is_empty()
    }
}

#[derive(Resource, Default)]
pub struct RuntimeEventQueue {
    next_sequence: u64,
    events: Vec<RuntimeEvent>,
}

impl RuntimeEventQueue {
    pub fn emit(&mut self, name: impl Into<String>, payload: Value) -> u64 {
        let sequence = self.next_sequence;
        self.next_sequence = self.next_sequence.saturating_add(1);
        self.events.push(RuntimeEvent {
            sequence,
            name: name.into(),
            payload,
        });
        sequence
    }

    pub fn drain(&mut self) -> impl Iterator<Item = RuntimeEvent> + '_ {
        self.events.drain(..)
    }
}

#[derive(Resource, Default)]
pub struct EffectRequestQueue {
    next_id: u64,
    effects: Vec<EffectRequest>,
}

impl EffectRequestQueue {
    pub fn request(&mut self, kind: impl Into<String>, payload: Value) -> String {
        let id = format!("effect-{}", self.next_id);
        self.next_id = self.next_id.saturating_add(1);
        self.effects.push(EffectRequest {
            id: id.clone(),
            kind: kind.into(),
            payload,
        });
        id
    }

    pub fn drain(&mut self) -> impl Iterator<Item = EffectRequest> + '_ {
        self.effects.drain(..)
    }
}

#[derive(Resource, Default)]
pub struct EffectResultQueue {
    results: VecDeque<EffectResult>,
}

impl EffectResultQueue {
    pub fn push(&mut self, result: EffectResult) {
        self.results.push_back(result);
    }

    pub fn pop_front(&mut self) -> Option<EffectResult> {
        self.results.pop_front()
    }

    pub fn drain(&mut self) -> impl Iterator<Item = EffectResult> + '_ {
        self.results.drain(..)
    }
}

#[derive(Resource, Clone)]
pub struct RuntimeState {
    pub revision: u64,
    pub value: Value,
}

impl fmt::Debug for RuntimeState {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter
            .debug_struct("RuntimeState")
            .field("revision", &self.revision)
            .field("value", &"[REDACTED]")
            .finish()
    }
}

impl Default for RuntimeState {
    fn default() -> Self {
        Self {
            revision: 0,
            value: Value::Object(Default::default()),
        }
    }
}

impl RuntimeState {
    pub fn snapshot(&self) -> RuntimeSnapshot {
        RuntimeSnapshot {
            revision: self.revision,
            state: self.value.clone(),
        }
    }
}

#[derive(Clone, Copy, Debug, Default)]
pub struct VifuRuntimePlugin;

impl Plugin for VifuRuntimePlugin {
    fn build(&self, app: &mut App) {
        app.init_schedule(RuntimeSchedule)
            .init_resource::<RuntimeCommandQueue>()
            .init_resource::<RuntimeEventQueue>()
            .init_resource::<EffectRequestQueue>()
            .init_resource::<EffectResultQueue>()
            .init_resource::<RuntimeState>();
    }
}

pub struct HeadlessRuntime {
    app: App,
}

impl Default for HeadlessRuntime {
    fn default() -> Self {
        Self::new()
    }
}

impl HeadlessRuntime {
    pub fn new() -> Self {
        let mut app = App::empty();
        app.add_plugins(VifuRuntimePlugin);
        Self { app }
    }

    pub fn restore(snapshot: RuntimeSnapshot) -> Self {
        let mut runtime = Self::new();
        runtime.app.insert_resource(RuntimeState {
            revision: snapshot.revision,
            value: snapshot.state,
        });
        runtime
    }

    pub fn app(&self) -> &App {
        &self.app
    }

    pub fn app_mut(&mut self) -> &mut App {
        &mut self.app
    }

    pub fn snapshot(&self) -> RuntimeSnapshot {
        self.app.world().resource::<RuntimeState>().snapshot()
    }

    pub fn complete_effect(&mut self, result: EffectResult) {
        self.app
            .world_mut()
            .resource_mut::<EffectResultQueue>()
            .push(result);
    }

    pub fn enqueue_command(&mut self, command: RuntimeCommand) {
        self.app
            .world_mut()
            .resource_mut::<RuntimeCommandQueue>()
            .push(command);
    }

    pub fn run_schedule(&mut self, schedule: impl ScheduleLabel) -> RuntimeAdvance {
        self.app.world_mut().run_schedule(schedule);
        self.take_advance()
    }

    pub fn dispatch(&mut self, command: RuntimeCommand) -> RuntimeAdvance {
        self.enqueue_command(command);
        self.app.world_mut().run_schedule(RuntimeSchedule);

        {
            let mut state = self.app.world_mut().resource_mut::<RuntimeState>();
            state.revision = state.revision.saturating_add(1);
        }

        self.take_advance()
    }

    fn take_advance(&mut self) -> RuntimeAdvance {
        let snapshot = self.snapshot();
        let events = self
            .app
            .world_mut()
            .resource_mut::<RuntimeEventQueue>()
            .drain()
            .collect();
        let effects = self
            .app
            .world_mut()
            .resource_mut::<EffectRequestQueue>()
            .drain()
            .collect();

        RuntimeAdvance {
            snapshot,
            events,
            effects,
        }
    }
}

#[cfg(test)]
mod tests {
    use bevy_ecs::prelude::{ResMut, Resource};
    use serde_json::json;

    use super::*;

    #[derive(Resource, Default)]
    struct ProcessedCommands(u64);

    fn echo_commands(
        mut commands: ResMut<RuntimeCommandQueue>,
        mut events: ResMut<RuntimeEventQueue>,
        mut effects: ResMut<EffectRequestQueue>,
        mut state: ResMut<RuntimeState>,
        mut processed: ResMut<ProcessedCommands>,
    ) {
        for command in commands.drain() {
            processed.0 += 1;
            state.value["lastCommand"] = Value::String(command.name.clone());
            events.emit("command.processed", json!({ "commandId": command.id }));
            effects.request("agent.invoke", command.payload);
        }
    }

    #[test]
    fn plugins_define_runtime_behavior() {
        let mut runtime = HeadlessRuntime::new();
        runtime
            .app_mut()
            .init_resource::<ProcessedCommands>()
            .add_systems(RuntimeSchedule, echo_commands);

        let advance = runtime.dispatch(RuntimeCommand::new(
            "command-1",
            "player.message",
            json!({ "text": "Hello" }),
        ));

        assert_eq!(advance.snapshot.revision, 1);
        assert_eq!(advance.snapshot.state["lastCommand"], "player.message");
        assert_eq!(advance.events[0].name, "command.processed");
        assert_eq!(advance.effects[0].kind, "agent.invoke");
    }

    #[test]
    fn snapshots_can_be_restored() {
        let runtime = HeadlessRuntime::restore(RuntimeSnapshot {
            revision: 7,
            state: json!({ "scene": "platform" }),
        });

        assert_eq!(runtime.snapshot().revision, 7);
        assert_eq!(runtime.snapshot().state["scene"], "platform");
    }

    #[derive(Clone, Debug, Hash, PartialEq, Eq, ScheduleLabel)]
    struct ExtensionSchedule;

    fn run_extension(
        mut commands: ResMut<RuntimeCommandQueue>,
        mut events: ResMut<RuntimeEventQueue>,
        mut state: ResMut<RuntimeState>,
    ) {
        let command = commands.pop_front().expect("extension command");
        state.revision = 9;
        state.value = command.payload;
        events.emit("extension.completed", json!({ "commandId": command.id }));
    }

    #[test]
    fn extensions_run_on_the_shared_runtime_host() {
        let mut runtime = HeadlessRuntime::new();
        runtime
            .app_mut()
            .init_schedule(ExtensionSchedule)
            .add_systems(ExtensionSchedule, run_extension);
        runtime.enqueue_command(RuntimeCommand::new(
            "command-9",
            "extension.run",
            json!({ "result": "ok" }),
        ));

        let advance = runtime.run_schedule(ExtensionSchedule);

        assert_eq!(advance.snapshot.revision, 9);
        assert_eq!(advance.snapshot.state["result"], "ok");
        assert_eq!(advance.events[0].name, "extension.completed");
    }
}