zc2 0.0.27

P2P compute broker with credit-based billing, WAL, and broker mesh support
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
//! `zc up | share | down | price` while the agent runs (spec §6.1): one owner.

use crate::agent::client::AgentClient;
use crate::agent::hub::{self, HubClient, HubError};
use std::path::PathBuf;
use std::time::Duration;

const T: Duration = Duration::from_secs(5);

/// `--workers N` / `-w N` / `-n N` / `--workers=N`, only when given explicitly.
pub fn explicit_workers(args: &[String]) -> Option<u32> {
    let mut it = args.iter();
    while let Some(a) = it.next() {
        match a.as_str() {
            "--workers" | "-w" | "-n" => return it.next().and_then(|v| v.parse().ok()),
            s if s.starts_with("--workers=") => return s["--workers=".len()..].parse().ok(),
            _ => {}
        }
    }
    None
}

pub fn port_flags_given(args: &[String]) -> bool {
    args.iter()
        .any(|a| matches!(a.as_str(), "--port" | "-p" | "--broker-port" | "-b"))
}

fn num(v: f64) -> String {
    // 18.0 → "18", 3.6 → "3.6"
    format!("{v}")
}

pub fn format_price(state: &str, per_hour: Option<f64>, effective: Option<f64>) -> String {
    match (state, per_hour, effective) {
        ("set", Some(p), _) => format!("this Mac: {} credits/hour", num(p)),
        ("inherited", _, Some(e)) => format!("this Mac: account default ({} credits/hour)", num(e)),
        ("inherited", _, None) => "this Mac: account default".to_string(),
        ("mixed", _, Some(e)) => format!("this Mac: mixed (from {} credits/hour)", num(e)),
        ("disabled", _, _) => "this Mac: disabled on the hub".to_string(),
        _ => "this Mac: no price yet".to_string(),
    }
}

fn print_error(e: String) -> i32 {
    eprintln!("zc: {e}");
    1
}

pub fn up(c: &AgentClient, args: &[String]) -> i32 {
    if port_flags_given(args) {
        eprintln!("  note: the zc agent owns the ports; --port/--broker-port are ignored");
    }
    if let Some(n) = explicit_workers(args) {
        if let Err(e) = c.put("/v1/workers", serde_json::json!({ "count": n }), T) {
            return print_error(e);
        }
    }
    match c.put("/v1/sharing", serde_json::json!({ "on": true }), T) {
        Ok(s) => {
            println!(
                "✓ Sharing handed to zc agent: {} worker(s). Follow it with `zc agent status`.",
                s["this_mac"]["workers"]["desired"]
            );
            0
        }
        Err(e) => print_error(e),
    }
}

/// `zc down` while the agent runs: turn sharing off through the agent. A
/// broker the agent didn't start (a manual `zc up -d`) is one it can't stop,
/// so then this returns `None` once sharing is off: the caller falls through
/// to the port-based teardown that stops that broker, which is what the
/// `unmanaged_broker` hint and the 409 tell the owner to run `zc down` for.
pub fn down(c: &AgentClient) -> Option<i32> {
    match c.put("/v1/sharing", serde_json::json!({ "on": false }), T) {
        Ok(s) if s["this_mac"]["broker"] == "unmanaged" => {
            println!("✓ zc agent paused sharing; stopping the broker it didn't start.");
            None
        }
        Ok(_) => {
            println!("✓ zc agent is draining the workers and will stop sharing.");
            Some(0)
        }
        Err(e) => Some(print_error(e)),
    }
}

/// `nan` and `inf` parse as numbers, but JSON has no such values: serialized
/// they become `null`, which the hub reads as "use the account default".
fn finite_price(v: f64) -> Result<f64, String> {
    if v.is_finite() {
        Ok(v)
    } else {
        Err(format!(
            "price must be a finite number of credits/hour, got {v}"
        ))
    }
}

pub fn price_set(c: &AgentClient, value: f64) -> i32 {
    if let Err(e) = finite_price(value) {
        return print_error(e);
    }
    let body = serde_json::json!({ "scope": "device", "price_per_hour": value });
    match c.put("/v1/price", body, Duration::from_secs(30)) {
        Ok(_) => {
            println!("price set: {} credits/hour on this Mac (hub)", num(value));
            0
        }
        Err(e) => print_error(e),
    }
}

pub fn price_show(c: &AgentClient) -> i32 {
    match c.summary(T) {
        Ok(s) => {
            let p = &s["prices"]["this_mac"];
            println!(
                "{}",
                format_price(
                    p["state"].as_str().unwrap_or(""),
                    p["per_hour"].as_f64(),
                    p["effective_per_hour"].as_f64()
                )
            );
            0
        }
        Err(e) => print_error(e),
    }
}

pub fn try_up(args: &[String]) -> Option<i32> {
    AgentClient::running().map(|c| up(&c, args))
}

pub fn try_down() -> Option<i32> {
    AgentClient::running().and_then(|c| down(&c))
}

pub fn try_price(value: Option<f64>) -> Option<i32> {
    let c = AgentClient::running()?;
    Some(match value {
        Some(v) => price_set(&c, v),
        None => price_show(&c),
    })
}

/// `GET /api/provide/summary`, retried once in UTC when the hub rejects the
/// starting time zone with 422 (mirrors the agent's own `refresh_hub` retry).
async fn summary_with_retry(
    client: &HubClient,
    tz: &str,
) -> Result<crate::agent::hubwire::HubSummary, HubError> {
    let result = client.summary(tz).await;
    if tz != "UTC" && matches!(result, Err(HubError::Status(422, _))) {
        return client.summary("UTC").await;
    }
    result
}

/// `zc price [<v>]` without an agent: the same hub writes it would make.
pub fn price_direct(value: Option<f64>) -> i32 {
    price_direct_in(crate::credentials::dir(), value)
}

/// `price_direct`, with its state dir (`~/.zakuro`: the credentials and the
/// node key) passed in.
fn price_direct_in(state_dir: Option<PathBuf>, value: Option<f64>) -> i32 {
    // Before anything is read or sent.
    if let Some(Err(e)) = value.map(finite_price) {
        return print_error(e);
    }
    let Some(state_dir) = state_dir else {
        return print_error("no HOME or ZAKURO_HOME".into());
    };
    let Some(creds) = hub::read_credentials(&state_dir.join("credentials")) else {
        return print_error("this Mac is not signed in: run `zc login`".into());
    };
    let base = creds
        .api_url
        .clone()
        .unwrap_or_else(crate::credentials::default_api_url);
    let pk = crate::broker::node_identity::NodeKey::load_or_create_in(Some(state_dir)).public_b64();
    let rt = match tokio::runtime::Builder::new_current_thread()
        .enable_all()
        .build()
    {
        Ok(rt) => rt,
        Err(e) => return print_error(e.to_string()),
    };
    rt.block_on(async move {
        let client = HubClient::new(&base, &creds.api_key, Duration::from_secs(10));
        let summary = match summary_with_retry(&client, &hub::system_tz()).await {
            Ok(s) => s,
            Err(e) => return print_error(e.message()),
        };
        let mine = summary.this_mac_workers(&pk);
        let Some(v) = value else {
            let p = crate::agent::merge::this_mac_price(&mine);
            println!(
                "{}",
                format_price(&p.state, p.per_hour, p.effective_per_hour)
            );
            return 0;
        };
        let b = summary.bounds();
        if v < b.min as f64 || v > b.max as f64 {
            return print_error(format!(
                "price must be between {} and {} credits/hour",
                b.min, b.max
            ));
        }
        let ids: Vec<i64> = mine.iter().map(|w| w.id).collect();
        if ids.is_empty() {
            return print_error(
                "this Mac has no workers on the hub yet: start sharing first (`zc share`)".into(),
            );
        }
        match hub::set_device_price(&client, &ids, Some(v)).await {
            Ok(()) => {
                println!(
                    "price set: {} credits/hour on this Mac ({} worker(s))",
                    num(v),
                    ids.len()
                );
                0
            }
            Err(failed) => print_error(format!("could not price {} worker(s)", failed.len())),
        }
    })
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::agent::client::tests::{idle_agent, sleeper_cfg, start_agent};
    use crate::agent::core::tests::{hub_json, row};
    use crate::agent::hub::tests::{mock_hub, Seen};

    fn args(s: &[&str]) -> Vec<String> {
        s.iter().map(|a| a.to_string()).collect()
    }

    #[test]
    fn worker_and_port_flags_are_detected() {
        assert_eq!(explicit_workers(&args(&["--workers", "3"])), Some(3));
        assert_eq!(explicit_workers(&args(&["-w", "2", "-d"])), Some(2));
        assert_eq!(explicit_workers(&args(&["-n", "4"])), Some(4));
        assert_eq!(explicit_workers(&args(&["--workers=5"])), Some(5));
        assert_eq!(explicit_workers(&args(&["-d"])), None);
        assert!(port_flags_given(&args(&["--port", "4000"])));
        assert!(port_flags_given(&args(&["-b", "9100"])));
        assert!(!port_flags_given(&args(&["--workers", "2"])));
    }

    #[test]
    fn price_lines() {
        assert_eq!(
            format_price("set", Some(18.0), Some(18.0)),
            "this Mac: 18 credits/hour"
        );
        assert_eq!(
            format_price("inherited", None, Some(12.0)),
            "this Mac: account default (12 credits/hour)"
        );
        assert_eq!(
            format_price("inherited", None, None),
            "this Mac: account default"
        );
        assert_eq!(
            format_price("mixed", None, Some(12.0)),
            "this Mac: mixed (from 12 credits/hour)"
        );
    }

    #[test]
    fn a_disabled_price_state_is_shown_as_disabled_on_the_hub() {
        assert_eq!(
            format_price("disabled", None, None),
            "this Mac: disabled on the hub"
        );
    }

    #[test]
    fn a_422_on_the_starting_zone_is_retried_once_in_utc() {
        use crate::agent::hubwire::tests::HUB_JSON;

        let (base, seen) = mock_hub(|_, url, _| match url {
            "/api/provide/summary?tz=Asia%2FTokyo" => (422, "{}".into()),
            "/api/provide/summary?tz=UTC" => (200, HUB_JSON.to_string()),
            _ => (404, "{}".into()),
        });
        let client = hub::HubClient::new(&base, "zk_1_x", std::time::Duration::from_secs(5));
        let rt = tokio::runtime::Builder::new_current_thread()
            .enable_all()
            .build()
            .unwrap();
        let summary = rt
            .block_on(summary_with_retry(&client, "Asia/Tokyo"))
            .expect("retried in UTC and succeeded");
        assert_eq!(summary.account.username, "jean");
        let urls: Vec<String> = seen
            .lock()
            .unwrap()
            .iter()
            .map(|(_, u, _, _)| u.clone())
            .collect();
        assert_eq!(
            urls,
            vec![
                "/api/provide/summary?tz=Asia%2FTokyo".to_string(),
                "/api/provide/summary?tz=UTC".to_string()
            ]
        );
    }

    #[test]
    fn up_and_down_are_handed_to_the_agent() {
        let (c, _stop) = idle_agent();
        assert_eq!(up(&c, &args(&["--workers", "2", "--port", "4000"])), 0);
        let s = c.summary(std::time::Duration::from_secs(2)).unwrap();
        assert_eq!(
            (
                s["this_mac"]["sharing"].as_bool(),
                s["this_mac"]["workers"]["desired"].as_u64()
            ),
            (Some(true), Some(2))
        );
        assert_eq!(down(&c), Some(0));
        assert_eq!(
            c.summary(std::time::Duration::from_secs(2)).unwrap()["this_mac"]["sharing"],
            false
        );
        assert_eq!(
            price_set(&c, 10.0),
            1,
            "not signed in: the agent answers 503"
        );
    }

    fn wait_until(what: &str, mut done: impl FnMut() -> bool) {
        let end = std::time::Instant::now() + Duration::from_secs(10);
        while std::time::Instant::now() < end {
            if done() {
                return;
            }
            std::thread::sleep(Duration::from_millis(100));
        }
        panic!("timed out waiting for: {what}");
    }

    /// A broker the agent didn't start (a manual `zc up -d`) holds the broker
    /// port. `zc down` pauses the agent, then hands back to the port-based
    /// teardown that stops that broker, so following the `unmanaged_broker`
    /// hint (and the 409) actually frees this Mac for the agent.
    #[test]
    fn down_with_an_unmanaged_broker_pauses_the_agent_then_falls_through() {
        // Answers `/health` like a zakuro broker, but the agent never started it.
        let (fake_broker, _) = mock_hub(|_, url, _| match url {
            "/health" => (
                200,
                r#"{"status":"healthy","service":"zakuro-broker"}"#.into(),
            ),
            _ => (404, "{}".into()),
        });
        let mut cfg = sleeper_cfg("down-unmanaged");
        cfg.broker_port = fake_broker.rsplit(':').next().unwrap().parse().unwrap();
        crate::agent::files::ensure_dir(&cfg.dir).unwrap();
        crate::agent::files::save_json(
            &cfg.dir.join(crate::agent::files::STATE_FILE),
            &crate::agent::files::DesiredState {
                sharing: true,
                ..Default::default()
            },
        )
        .unwrap();
        let (c, _guard) = start_agent(cfg);
        let summary = || c.summary(Duration::from_secs(2)).unwrap();
        wait_until("the agent sees the unmanaged broker", || {
            summary()["this_mac"]["broker"] == "unmanaged"
        });
        assert_eq!(summary()["this_mac"]["sharing"], true);

        assert_eq!(down(&c), None, "the port-based `zc down` must still run");
        assert_eq!(
            summary()["this_mac"]["sharing"],
            false,
            "the agent paused sharing first"
        );
    }

    /// A hub whose summary lists this node's one worker row (11); every PUT
    /// succeeds.
    fn pricing_hub(pk: String) -> (String, Seen) {
        mock_hub(move |method, url, _| match method {
            "GET" if url.starts_with("/api/provide/summary") => {
                (200, hub_json(&pk, &row(11, None)))
            }
            "PUT" => (200, "{}".into()),
            _ => (404, "{}".into()),
        })
    }

    fn put_bodies(seen: &Seen) -> Vec<String> {
        seen.lock()
            .unwrap()
            .iter()
            .filter(|e| e.0 == "PUT")
            .map(|e| e.2.clone())
            .collect()
    }

    /// `nan` and `inf` serialize as JSON `null`, which the hub reads as "use
    /// the account default": `zc price nan` would silently clear this Mac's
    /// price. Without an agent it is refused before anything is sent.
    #[test]
    fn a_non_finite_price_is_refused_before_it_reaches_the_hub() {
        let state = crate::agent::files::tests::tmp("price-direct");
        std::fs::create_dir_all(&state).unwrap();
        let pk = crate::broker::node_identity::NodeKey::load_or_create_in(Some(state.clone()))
            .public_b64();
        let (hub, seen) = pricing_hub(pk);
        std::fs::write(
            state.join("credentials"),
            format!("api_key=zk_1_test\napi_url={hub}\n"),
        )
        .unwrap();

        for v in [f64::NAN, f64::INFINITY, f64::NEG_INFINITY] {
            assert_eq!(price_direct_in(Some(state.clone()), Some(v)), 1, "{v}");
        }
        assert_eq!(put_bodies(&seen), Vec::<String>::new(), "nothing sent");

        assert_eq!(
            price_direct_in(Some(state), Some(18.0)),
            0,
            "a real price still goes through"
        );
        assert_eq!(
            put_bodies(&seen),
            vec![r#"{"price_per_hour":18.0}"#.to_string()]
        );
    }

    /// The same through a running agent: refused before the request is sent.
    #[test]
    fn a_non_finite_price_is_refused_before_it_reaches_the_agent() {
        let cfg = sleeper_cfg("price-set");
        std::fs::create_dir_all(&cfg.state_dir).unwrap();
        let (hub, seen) = pricing_hub(cfg.node_pubkey());
        std::fs::write(
            cfg.state_dir.join("credentials"),
            format!("api_key=zk_1_test\napi_url={hub}\n"),
        )
        .unwrap();
        let (c, _guard) = start_agent(cfg);

        for v in [f64::NAN, f64::INFINITY, f64::NEG_INFINITY] {
            assert_eq!(price_set(&c, v), 1, "{v}");
        }
        assert_eq!(put_bodies(&seen), Vec::<String>::new(), "nothing sent");

        assert_eq!(price_set(&c, 18.0), 0, "a real price still goes through");
        assert_eq!(
            put_bodies(&seen),
            vec![r#"{"price_per_hour":18.0}"#.to_string()]
        );
    }
}