concinnity-dev 0.19.119

The Concinnity dev tooling library: world authoring, the in-engine editor, the debug server, docs and packaging
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

//! Calls answered the way a running engine answers them, for verb tests.

use concinnity_core::ecs::World;
use concinnity_core::render::backend::NullBackend;
use serde_json::{Map, Value};
use std::sync::{Arc, Mutex};

use super::camera::CameraMotion;
use crate::debug::catalog;
use crate::debug::state::DebugState;
use crate::debug::verb::Reply;

/// The arguments a test writes as a JSON object, or none for `null`.
pub(in crate::debug) fn arguments(value: Value) -> Map<String, Value> {
    match value {
        Value::Object(fields) => fields,
        _ => Map::new(),
    }
}

/// Answer a call from `state` alone, for verbs that never wait on the engine.
pub(in crate::debug) fn ask(state: DebugState, name: &str) -> Reply {
    catalog::run(name, Map::new(), &Mutex::new(state))
}

/// A world and the debug server's camera-motion slot, standing in for the
/// engine thread: a call runs on a worker thread while this one applies each
/// queued job, world jobs to `world` and backend jobs to a `NullBackend`.
pub(in crate::debug) struct Engine {
    pub(in crate::debug) world: World,
    pub(in crate::debug) motion: Option<CameraMotion>,
}

impl Engine {
    pub(in crate::debug) fn new(world: World) -> Self {
        Self {
            world,
            motion: None,
        }
    }

    // A loaded test host can stall either thread past the call's wait; a call
    // that timed out is retried, so a test asserts what the verb answers
    // rather than the scheduler.
    pub(in crate::debug) fn call(&mut self, name: &str, args: Value) -> Reply {
        for _ in 0..5 {
            let reply = self.call_once(name, args.clone());
            if !reply
                .as_ref()
                .is_err_and(|e| e.ends_with("timed out waiting for engine"))
            {
                return reply;
            }
        }
        panic!("{name} kept timing out under load");
    }

    fn call_once(&mut self, name: &str, args: Value) -> Reply {
        let shared = Arc::new(Mutex::new(DebugState::default()));
        let queue = shared.lock().unwrap().queue.clone();
        let name = name.to_string();
        let worker = std::thread::spawn(move || catalog::run(&name, arguments(args), &shared));
        let deadline = std::time::Instant::now() + std::time::Duration::from_secs(10);
        while !worker.is_finished() {
            assert!(
                std::time::Instant::now() < deadline,
                "the call never returned"
            );
            let jobs = queue.take();
            for job in jobs.world {
                job(&mut self.world, &mut self.motion);
            }
            for job in jobs.backend {
                job(&mut NullBackend, None);
            }
            std::thread::yield_now();
        }
        worker.join().expect("call thread panicked")
    }
}