barbed 0.0.4

Twitch Helix, EventSub, OAuth, IRC, and provider helpers
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

//! Triangulates the checked-in catalog JSON, the generated registries, and the
//! generated summary counts against each other.

use barbed::{eventsub, helix, twitch_catalog};
use serde::Deserialize;

#[derive(Deserialize)]
struct Summary {
    counts: SummaryCounts,
}

#[derive(Deserialize)]
struct SummaryCounts {
    helix_total: usize,
    helix_ga_or_new: usize,
    helix_beta: usize,
    eventsub_total: usize,
    eventsub_ga_or_new: usize,
    eventsub_beta: usize,
    eventsub_typed_events: usize,
    eventsub_untyped_events: usize,
    auth_flows: usize,
    auth_endpoints: usize,
}

#[derive(Deserialize)]
struct HelixCatalog {
    endpoints: Vec<Stability>,
}

#[derive(Deserialize)]
struct EventSubCatalog {
    subscriptions: Vec<EventSubCatalogEntry>,
}

#[derive(Deserialize)]
struct EventSubCatalogEntry {
    stability: String,
    event: Option<serde_json::Value>,
}

#[derive(Deserialize)]
struct Stability {
    stability: String,
}

#[derive(Deserialize)]
struct AuthCatalog {
    flows: Vec<serde_json::Value>,
    endpoints: Vec<serde_json::Value>,
}

fn summary() -> Summary {
    serde_json::from_str(include_str!("../twitch_catalog/summary.json"))
        .expect("summary.json should decode")
}

fn helix_catalog() -> HelixCatalog {
    serde_json::from_str(include_str!("../twitch_catalog/helix.json"))
        .expect("helix.json should decode")
}

fn eventsub_catalog() -> EventSubCatalog {
    serde_json::from_str(include_str!("../twitch_catalog/eventsub.json"))
        .expect("eventsub.json should decode")
}

fn auth_catalog() -> AuthCatalog {
    serde_json::from_str(include_str!("../twitch_catalog/auth.json"))
        .expect("auth.json should decode")
}

fn beta_count(entries: &[Stability]) -> usize {
    entries
        .iter()
        .filter(|entry| entry.stability == "beta")
        .count()
}

#[test]
fn generated_helix_surface_matches_checked_in_catalog() {
    let summary = summary();
    let catalog = helix_catalog();

    assert_eq!(summary.counts.helix_total, helix::ALL_ENDPOINTS.len());
    assert_eq!(summary.counts.helix_total, catalog.endpoints.len());
    assert_eq!(
        summary.counts.helix_ga_or_new,
        twitch_catalog::ga_or_new_helix_endpoint_count()
    );
    assert_eq!(
        summary.counts.helix_beta,
        twitch_catalog::beta_helix_endpoint_count()
    );
    assert_eq!(summary.counts.helix_beta, beta_count(&catalog.endpoints));
}

#[test]
fn generated_eventsub_surface_matches_checked_in_catalog() {
    let summary = summary();
    let catalog = eventsub_catalog();

    assert_eq!(
        summary.counts.eventsub_total,
        eventsub::ALL_EVENTSUB_SUBSCRIPTIONS.len()
    );
    assert_eq!(summary.counts.eventsub_total, catalog.subscriptions.len());
    assert_eq!(
        summary.counts.eventsub_ga_or_new,
        twitch_catalog::ga_or_new_eventsub_count()
    );
    assert_eq!(
        summary.counts.eventsub_beta,
        twitch_catalog::beta_eventsub_count()
    );
    assert_eq!(
        summary.counts.eventsub_beta,
        catalog
            .subscriptions
            .iter()
            .filter(|entry| entry.stability == "beta")
            .count()
    );

    let typed = catalog
        .subscriptions
        .iter()
        .filter(|entry| entry.event.is_some())
        .count();
    assert_eq!(summary.counts.eventsub_typed_events, typed);
    assert_eq!(
        summary.counts.eventsub_untyped_events,
        catalog.subscriptions.len() - typed
    );
    assert_eq!(
        summary.counts.eventsub_typed_events + summary.counts.eventsub_untyped_events,
        summary.counts.eventsub_total
    );
}

#[test]
fn summary_matches_auth_catalog() {
    let summary = summary();
    let catalog = auth_catalog();

    assert_eq!(summary.counts.auth_flows, catalog.flows.len());
    assert_eq!(summary.counts.auth_endpoints, catalog.endpoints.len());
}

#[test]
fn beta_surfaces_remain_explicitly_counted() {
    assert_eq!(twitch_catalog::beta_helix_endpoint_count(), 12);
    assert_eq!(twitch_catalog::beta_eventsub_count(), 4);
}