bmux_clients_plugin_api 0.0.1-alpha.1

Typed public API of the bmux clients plugin (BPDL-generated bindings)
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

//! Smoke test: the BPDL-generated clients-plugin-api bindings compile
//! and their types can be constructed, serialized, and the declared
//! constants match the schema.

use bmux_clients_plugin_api::{
    clients_commands::{ClientAck, SetCurrentSessionError, SetFollowingError},
    clients_events::{self, ClientEvent},
    clients_state::{self, ClientQueryError, ClientSummary},
};

#[test]
fn client_summary_round_trips() {
    let summary = ClientSummary {
        id: uuid::Uuid::nil(),
        selected_session_id: Some(uuid::Uuid::nil()),
        selected_context_id: None,
        following_client_id: None,
        following_global: true,
    };
    let json = serde_json::to_string(&summary).expect("serialize");
    let round: ClientSummary = serde_json::from_str(&json).expect("deserialize");
    assert_eq!(summary, round);
}

#[test]
fn client_query_error_variants_serialize() {
    let err = ClientQueryError::NoCurrentClient;
    let json = serde_json::to_string(&err).expect("serialize");
    assert!(json.contains("no_current_client"));
}

#[test]
fn command_ack_and_error_variants_serialize() {
    let ack = ClientAck {
        client_id: uuid::Uuid::nil(),
    };
    assert!(
        serde_json::to_string(&ack)
            .expect("ack")
            .contains("client_id")
    );

    let err = SetCurrentSessionError::NotFound;
    assert!(
        serde_json::to_string(&err)
            .expect("err")
            .contains("not_found")
    );

    let follow_err = SetFollowingError::Denied {
        reason: "no".to_string(),
    };
    assert!(
        serde_json::to_string(&follow_err)
            .expect("follow err")
            .contains("denied")
    );
}

#[test]
fn client_event_variants_are_tagged() {
    let ev = ClientEvent::Attached {
        client_id: uuid::Uuid::nil(),
    };
    let json = serde_json::to_string(&ev).expect("serialize");
    assert!(json.contains("\"attached\""));
}

#[test]
fn interface_ids_match_bpdl_source() {
    assert_eq!(clients_state::INTERFACE_ID, "clients-state");
    assert_eq!(clients_events::INTERFACE_ID, "clients-events");
}

#[test]
fn event_kind_is_namespaced_by_plugin_id() {
    assert_eq!(clients_events::EVENT_KIND, "bmux.clients/clients-events");
}

#[test]
fn event_payload_alias_matches_declared_type() {
    let via_alias: clients_events::EventPayload = clients_events::EventPayload::Detached {
        client_id: uuid::Uuid::nil(),
    };
    let via_type: ClientEvent = ClientEvent::Detached {
        client_id: uuid::Uuid::nil(),
    };
    assert_eq!(
        serde_json::to_string(&via_alias).unwrap(),
        serde_json::to_string(&via_type).unwrap()
    );
}