mesh-llm-client 0.68.0

Low-level Rust client implementation for Mesh LLM embedded integrations
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
// Integration tests for mesh-client::protocol wire types.
// These tests verify the portable protocol layer that is safe to use on mobile targets.

use mesh_client::proto::node::{
    GossipFrame, MeshSubprotocol, MeshSubprotocolOpen, NodeRole, OwnerControlEnvelope,
    OwnerControlErrorCode, OwnerControlGetConfigRequest, OwnerControlRequest, PeerAnnouncement,
    PeerDown, PeerLeaving, RouteTable, RouteTableRequest,
};
use mesh_client::protocol::{
    ALPN_CONTROL_V1, ALPN_V0, ALPN_V1, ControlFrameError, ControlProtocol, MAX_CONTROL_FRAME_BYTES,
    NODE_PROTOCOL_GENERATION, STREAM_CONFIG_PUSH, STREAM_CONFIG_SUBSCRIBE, STREAM_GOSSIP,
    STREAM_PEER_DOWN, STREAM_PEER_LEAVING, STREAM_ROUTE_REQUEST, STREAM_SUBPROTOCOL,
    STREAM_TUNNEL_MAP, decode_control_frame, decode_legacy_tunnel_map_frame,
    decode_owner_control_envelope, encode_control_frame, encode_owner_control_envelope,
    owner_control_rejection_envelope,
};
use mesh_client::{
    ConfigTransportSelection, ControlPlaneBootstrapOptions, ControlPlaneRetryPolicy,
};

// ── ALPN constants ──────────────────────────────────────────────────────────

#[test]
fn alpn_v0_is_correct() {
    assert_eq!(ALPN_V0, b"mesh-llm/0");
}

#[test]
fn alpn_v1_is_correct() {
    assert_eq!(ALPN_V1, b"mesh-llm/1");
}

#[test]
fn control_alpn_is_correct() {
    assert_eq!(ALPN_CONTROL_V1, b"mesh-llm-control/1");
}

// ── ControlProtocol ─────────────────────────────────────────────────────────

#[test]
fn protocol_from_alpn_v1() {
    use mesh_client::protocol::protocol_from_alpn;
    assert_eq!(protocol_from_alpn(ALPN_V1), ControlProtocol::ProtoV1);
}

#[test]
fn protocol_from_alpn_v0() {
    use mesh_client::protocol::protocol_from_alpn;
    assert_eq!(protocol_from_alpn(ALPN_V0), ControlProtocol::JsonV0);
}

#[test]
fn protocol_from_alpn_unknown_defaults_to_v1() {
    use mesh_client::protocol::protocol_from_alpn;
    assert_eq!(
        protocol_from_alpn(b"mesh-llm/999"),
        ControlProtocol::ProtoV1
    );
}

// ── Wire constants sanity ────────────────────────────────────────────────────

#[test]
fn stream_type_constants_are_distinct() {
    let types = [
        STREAM_GOSSIP,
        STREAM_TUNNEL_MAP,
        STREAM_ROUTE_REQUEST,
        STREAM_PEER_DOWN,
        STREAM_PEER_LEAVING,
        STREAM_CONFIG_SUBSCRIBE,
        STREAM_CONFIG_PUSH,
    ];
    let mut seen = std::collections::HashSet::new();
    for t in &types {
        assert!(seen.insert(t), "duplicate stream type constant: {:#04x}", t);
    }
}

#[test]
fn node_protocol_generation_is_one() {
    assert_eq!(NODE_PROTOCOL_GENERATION, 1u32);
}

#[test]
fn max_control_frame_bytes_is_eight_mib() {
    assert_eq!(MAX_CONTROL_FRAME_BYTES, 8 * 1024 * 1024);
}

#[test]
fn config_stream_constants_remain_stable() {
    assert_eq!(STREAM_CONFIG_SUBSCRIBE, 0x0b);
    assert_eq!(STREAM_CONFIG_PUSH, 0x0c);
    assert_eq!(STREAM_SUBPROTOCOL, 0x0d);
}

#[test]
fn control_plane_bootstrap_requires_explicit_endpoint_by_default() {
    let err = ControlPlaneBootstrapOptions::new()
        .select_transport()
        .expect_err("new config clients should require explicit owner-control endpoints");

    assert_eq!(err.code, OwnerControlErrorCode::ControlEndpointRequired);
    assert!(!err.legacy_retry_allowed);
}

#[test]
fn control_plane_bootstrap_uses_explicit_control_endpoint() {
    let selection = ControlPlaneBootstrapOptions::new()
        .with_control_endpoint("https://control.example.test")
        .select_transport()
        .expect("configured control endpoint should stay on owner-control lane");

    assert_eq!(
        selection,
        ConfigTransportSelection::OwnerControl {
            endpoint: "https://control.example.test".to_string(),
            retry_policy: ControlPlaneRetryPolicy::NoSilentLegacyDowngrade,
        }
    );
}

// ── Control frame encode / decode roundtrip ──────────────────────────────────

fn make_valid_gossip_frame() -> GossipFrame {
    GossipFrame {
        r#gen: NODE_PROTOCOL_GENERATION,
        sender_id: vec![0u8; 32],
        peers: vec![PeerAnnouncement {
            endpoint_id: vec![0u8; 32],
            role: NodeRole::Worker as i32,
            ..Default::default()
        }],
    }
}

#[test]
fn gossip_frame_roundtrip() {
    let frame = make_valid_gossip_frame();
    let encoded = encode_control_frame(STREAM_GOSSIP, &frame);
    let decoded: GossipFrame = decode_control_frame(STREAM_GOSSIP, &encoded)
        .expect("valid gossip frame must decode successfully");
    assert_eq!(decoded.r#gen, NODE_PROTOCOL_GENERATION);
    assert_eq!(decoded.sender_id, vec![0u8; 32]);
    assert_eq!(decoded.peers.len(), 1);
    assert_eq!(decoded.peers[0].endpoint_id, vec![0u8; 32]);
    assert_eq!(decoded.peers[0].role, NodeRole::Worker as i32);
}

#[test]
fn gossip_frame_bad_generation_rejected() {
    let mut frame = make_valid_gossip_frame();
    frame.r#gen = 0;
    let encoded = encode_control_frame(STREAM_GOSSIP, &frame);
    let err = decode_control_frame::<GossipFrame>(STREAM_GOSSIP, &encoded)
        .expect_err("gen=0 gossip frame must be rejected");
    assert!(
        matches!(err, ControlFrameError::BadGeneration { got: 0 }),
        "expected BadGeneration{{got:0}}, got {err:?}"
    );
}

#[test]
fn gossip_subprotocol_discovery_roundtrip_and_validation() {
    let frame = GossipFrame {
        r#gen: NODE_PROTOCOL_GENERATION,
        sender_id: vec![0u8; 32],
        peers: vec![PeerAnnouncement {
            endpoint_id: vec![0u8; 32],
            role: NodeRole::Worker as i32,
            subprotocols: vec![MeshSubprotocol {
                name: "skippy-stage".to_string(),
                major: 1,
                features: vec!["stage-control".to_string(), "artifact-transfer".to_string()],
            }],
            ..Default::default()
        }],
    };
    let encoded = encode_control_frame(STREAM_GOSSIP, &frame);
    let decoded: GossipFrame = decode_control_frame(STREAM_GOSSIP, &encoded)
        .expect("valid gossip subprotocol discovery must decode");
    assert_eq!(decoded.peers[0].subprotocols[0].name, "skippy-stage");
    assert_eq!(decoded.peers[0].subprotocols[0].major, 1);

    let mut invalid = decoded;
    invalid.peers[0].subprotocols[0].name.clear();
    let encoded = encode_control_frame(STREAM_GOSSIP, &invalid);
    let err = decode_control_frame::<GossipFrame>(STREAM_GOSSIP, &encoded)
        .expect_err("invalid subprotocol discovery must be rejected");
    assert!(matches!(err, ControlFrameError::InvalidSubprotocol));
}

#[test]
fn mesh_subprotocol_open_validates_generic_envelope() {
    let open = MeshSubprotocolOpen {
        r#gen: NODE_PROTOCOL_GENERATION,
        name: "skippy-stage".to_string(),
        major: 1,
    };
    let encoded = encode_control_frame(STREAM_SUBPROTOCOL, &open);
    let decoded: MeshSubprotocolOpen = decode_control_frame(STREAM_SUBPROTOCOL, &encoded).unwrap();
    assert_eq!(decoded.name, "skippy-stage");
    assert_eq!(decoded.major, 1);

    let bad = MeshSubprotocolOpen {
        r#gen: NODE_PROTOCOL_GENERATION,
        name: " ".to_string(),
        major: 1,
    };
    let encoded = encode_control_frame(STREAM_SUBPROTOCOL, &bad);
    let err = decode_control_frame::<MeshSubprotocolOpen>(STREAM_SUBPROTOCOL, &encoded)
        .expect_err("empty subprotocol names must be rejected");
    assert!(matches!(err, ControlFrameError::InvalidSubprotocol));
}

#[test]
fn gossip_frame_invalid_sender_id_rejected() {
    let mut frame = make_valid_gossip_frame();
    frame.sender_id = vec![0u8; 16]; // 16 bytes instead of 32
    let encoded = encode_control_frame(STREAM_GOSSIP, &frame);
    let err = decode_control_frame::<GossipFrame>(STREAM_GOSSIP, &encoded)
        .expect_err("short sender_id must be rejected");
    assert!(
        matches!(err, ControlFrameError::InvalidSenderId { got: 16 }),
        "expected InvalidSenderId{{got:16}}, got {err:?}"
    );
}

#[test]
fn wrong_stream_type_rejected() {
    let frame = make_valid_gossip_frame();
    let encoded = encode_control_frame(STREAM_GOSSIP, &frame);
    let err = decode_control_frame::<GossipFrame>(STREAM_TUNNEL_MAP, &encoded)
        .expect_err("wrong stream type must be rejected");
    assert!(
        matches!(
            err,
            ControlFrameError::WrongStreamType {
                expected: STREAM_TUNNEL_MAP,
                got: STREAM_GOSSIP,
            }
        ),
        "expected WrongStreamType, got {err:?}"
    );
}

// ── PeerDown / PeerLeaving roundtrip ─────────────────────────────────────────

#[test]
fn peer_down_roundtrip() {
    let msg = PeerDown {
        peer_id: vec![0xAB; 32],
        r#gen: NODE_PROTOCOL_GENERATION,
    };
    let encoded = encode_control_frame(STREAM_PEER_DOWN, &msg);
    let decoded: PeerDown =
        decode_control_frame(STREAM_PEER_DOWN, &encoded).expect("valid PeerDown must decode");
    assert_eq!(decoded.peer_id, vec![0xAB; 32]);
    assert_eq!(decoded.r#gen, NODE_PROTOCOL_GENERATION);
}

#[test]
fn peer_leaving_roundtrip() {
    let msg = PeerLeaving {
        peer_id: vec![0xCD; 32],
        r#gen: NODE_PROTOCOL_GENERATION,
    };
    let encoded = encode_control_frame(STREAM_PEER_LEAVING, &msg);
    let decoded: PeerLeaving =
        decode_control_frame(STREAM_PEER_LEAVING, &encoded).expect("valid PeerLeaving must decode");
    assert_eq!(decoded.peer_id, vec![0xCD; 32]);
    assert_eq!(decoded.r#gen, NODE_PROTOCOL_GENERATION);
}

#[test]
fn peer_down_bad_generation_rejected() {
    let msg = PeerDown {
        peer_id: vec![0x77; 32],
        r#gen: 0,
    };
    let encoded = encode_control_frame(STREAM_PEER_DOWN, &msg);
    let err = decode_control_frame::<PeerDown>(STREAM_PEER_DOWN, &encoded)
        .expect_err("PeerDown gen=0 must be rejected");
    assert!(
        matches!(err, ControlFrameError::BadGeneration { got: 0 }),
        "expected BadGeneration, got {err:?}"
    );
}

// ── RouteTable roundtrip ─────────────────────────────────────────────────────

#[test]
fn route_table_request_bad_generation_rejected() {
    let req = RouteTableRequest {
        requester_id: vec![0u8; 32],
        r#gen: 0,
    };
    let encoded = encode_control_frame(STREAM_ROUTE_REQUEST, &req);
    let err = decode_control_frame::<RouteTableRequest>(STREAM_ROUTE_REQUEST, &encoded)
        .expect_err("RouteTableRequest gen=0 must be rejected");
    assert!(
        matches!(err, ControlFrameError::BadGeneration { got: 0 }),
        "expected BadGeneration, got {err:?}"
    );
}

#[test]
fn route_table_bad_generation_rejected() {
    let table = RouteTable {
        entries: vec![],
        mesh_id: None,
        r#gen: 0,
    };
    let encoded = encode_control_frame(STREAM_ROUTE_REQUEST, &table);
    let err = decode_control_frame::<RouteTable>(STREAM_ROUTE_REQUEST, &encoded)
        .expect_err("RouteTable gen=0 must be rejected");
    assert!(
        matches!(err, ControlFrameError::BadGeneration { got: 0 }),
        "expected BadGeneration, got {err:?}"
    );
}

// ── v0 legacy compatibility ───────────────────────────────────────────────────

#[test]
fn decode_legacy_tunnel_map_from_json() {
    // JSON: { "<hex-peer-id>": <port> }
    let peer_bytes = [0x42u8; 32];
    let hex_id = hex::encode(peer_bytes);
    let json = format!("{{\"{hex_id}\": 9337}}");

    let frame = decode_legacy_tunnel_map_frame(json.as_bytes())
        .expect("valid legacy tunnel map JSON must decode");

    assert_eq!(frame.entries.len(), 1);
    assert_eq!(frame.entries[0].target_peer_id, peer_bytes.to_vec());
    assert_eq!(frame.entries[0].tunnel_port, 9337);
}

#[test]
fn decode_legacy_tunnel_map_invalid_hex_ignored() {
    let json = b"{\"notvalidhex\": 9337}";
    let frame = decode_legacy_tunnel_map_frame(json)
        .expect("invalid hex entries should be silently ignored");
    assert_eq!(frame.entries.len(), 0);
}

// ── ControlFrameError Display ────────────────────────────────────────────────

#[test]
fn control_frame_error_display_bad_generation() {
    let err = ControlFrameError::BadGeneration { got: 99 };
    let s = err.to_string();
    assert!(s.contains("99"), "Display must mention the bad gen value");
}

#[test]
fn control_frame_error_implements_std_error() {
    let err: Box<dyn std::error::Error> = Box::new(ControlFrameError::BadGeneration { got: 0 });
    assert!(err.to_string().contains("0"));
}

#[test]
fn owner_control_envelope_roundtrip() {
    let envelope = OwnerControlEnvelope {
        r#gen: NODE_PROTOCOL_GENERATION,
        handshake: None,
        request: Some(OwnerControlRequest {
            request_id: 5,
            get_config: Some(OwnerControlGetConfigRequest {
                requester_node_id: vec![0x10; 32],
                target_node_id: vec![0x20; 32],
            }),
            watch_config: None,
            apply_config: None,
            refresh_inventory: None,
        }),
        response: None,
        error: None,
    };
    let decoded = decode_owner_control_envelope(&encode_owner_control_envelope(&envelope))
        .expect("valid owner-control envelope must decode");
    assert_eq!(decoded.request.unwrap().request_id, 5);
}

#[test]
fn owner_control_unknown_command_rejects_with_structured_error() {
    let envelope = OwnerControlEnvelope {
        r#gen: NODE_PROTOCOL_GENERATION,
        handshake: None,
        request: Some(OwnerControlRequest {
            request_id: 6,
            get_config: None,
            watch_config: None,
            apply_config: None,
            refresh_inventory: None,
        }),
        response: None,
        error: None,
    };
    let bytes = encode_owner_control_envelope(&envelope);
    let err = decode_owner_control_envelope(&bytes)
        .expect_err("missing command variant must be rejected");
    let rejection = owner_control_rejection_envelope(&bytes, Some(6), &err);
    let error = rejection
        .error
        .expect("structured rejection must carry an error");
    assert_eq!(
        OwnerControlErrorCode::try_from(error.code).unwrap(),
        OwnerControlErrorCode::UnknownCommand
    );
}

#[test]
fn owner_control_legacy_json_rejects_with_structured_error() {
    let legacy_json = br#"{"request_id":6,"command":"GetConfig"}"#;
    let err = decode_owner_control_envelope(legacy_json)
        .expect_err("legacy json must be rejected on protobuf-only control plane");
    let rejection = owner_control_rejection_envelope(legacy_json, Some(6), &err);
    let error = rejection
        .error
        .expect("structured rejection must carry an error");
    assert_eq!(
        OwnerControlErrorCode::try_from(error.code).unwrap(),
        OwnerControlErrorCode::LegacyJsonUnsupported
    );
}