reddb-io-wire 1.2.5

RedDB wire protocol vocabulary: connection-string parser and (later) RedWire frame types. Shared by reddb-server, reddb-client, and the official drivers.
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

//! Pinned `ParseError` message snapshots for the connection-string
//! parser (issue #90). Mirrors `reddb-server/tests/parser_snapshots.rs`
//! shipped in #87 so future grammar tweaks that change error wording
//! produce a snapshot diff in CI instead of a silent regression.
//!
//! Workflow:
//!   - First run: `cargo insta accept` records the new outputs.
//!   - Reviewing changes: `cargo insta review` shows pending diffs.
//!   - CI: snapshots must match exactly.

use reddb_wire::{parse, parse_with_limits, ConnStringLimits};

/// Parse `input` and format the resulting error for snapshotting.
/// Successful parses are formatted as `UNEXPECTED OK` so a missing
/// error path is visible in the diff.
fn fmt_parse_error(input: &str) -> String {
    match parse(input) {
        Ok(t) => format!("UNEXPECTED OK\ninput: {:?}\nparsed: {:?}\n", input, t),
        Err(e) => format!("input: {:?}\nkind:  {:?}\nerror: {}\n", input, e.kind, e),
    }
}

/// Snapshot helper that names the snapshot after the test fn.
macro_rules! snap {
    ($name:ident, $input:expr) => {
        #[test]
        fn $name() {
            insta::assert_snapshot!(stringify!($name), fmt_parse_error($input));
        }
    };
}

// ----- Empty / missing scheme ------------------------------------

snap!(empty_input, "");
snap!(only_whitespace, "    \n\t  ");
snap!(missing_scheme, "primary.svc:5050");
snap!(only_question_mark, "?route=primary");

// ----- UnsupportedScheme -----------------------------------------

snap!(unknown_scheme_mongodb, "mongodb://localhost");
snap!(unknown_scheme_uppercase, "MONGODB://localhost");
snap!(scheme_with_plus, "red+tls://host");

// ----- InvalidUri: structural ------------------------------------

snap!(file_no_path, "file://");
snap!(red_no_host, "red://");
snap!(reds_no_host, "reds://");
snap!(grpc_no_host, "grpc://");
snap!(http_no_host, "http://");

// ----- InvalidUri: ports -----------------------------------------

snap!(port_non_numeric, "red://host:nope");
snap!(port_overflow, "red://host:99999");
snap!(port_negative, "red://host:-1");
snap!(port_empty, "red://host:");

// ----- InvalidUri: cluster ---------------------------------------

snap!(cluster_empty_middle, "grpc://primary,,replica");
snap!(cluster_empty_first, "grpc://,b");
snap!(cluster_only_commas, "grpc://,,,");
snap!(cluster_trailing_comma, "grpc://a,");
snap!(cluster_non_numeric_port, "grpc://a:nope,b:5055");
snap!(cluster_ipv6_unterminated, "grpc://[::1:5050,b:5055");

// ----- InvalidUri: BIDI / control / weird codepoints -------------

snap!(bom_prefix, "\u{feff}red://host:5050");
snap!(rtl_override_in_host, "red://h\u{202e}ost:5050");
snap!(nul_byte_in_host, "red://host\0:5050");
snap!(control_char_in_host, "red://h\u{0001}:5050");

// ----- LimitExceeded variants ------------------------------------

#[test]
fn dos_uri_too_long() {
    let limits = ConnStringLimits {
        max_uri_bytes: 16,
        ..ConnStringLimits::default()
    };
    let r = parse_with_limits("red://very-long-host-name:5050", limits);
    let formatted = match r {
        Ok(_) => "UNEXPECTED OK".to_string(),
        Err(e) => format!("kind:  {:?}\nerror: {}\n", e.kind, e),
    };
    insta::assert_snapshot!("dos_uri_too_long", formatted);
}

#[test]
fn dos_too_many_query_params() {
    let limits = ConnStringLimits {
        max_query_params: 2,
        ..ConnStringLimits::default()
    };
    let r = parse_with_limits("red://h?a=1&b=2&c=3&d=4", limits);
    let formatted = match r {
        Ok(_) => "UNEXPECTED OK".to_string(),
        Err(e) => format!("kind:  {:?}\nerror: {}\n", e.kind, e),
    };
    insta::assert_snapshot!("dos_too_many_query_params", formatted);
}

#[test]
fn dos_too_many_cluster_hosts() {
    let limits = ConnStringLimits {
        max_cluster_hosts: 2,
        ..ConnStringLimits::default()
    };
    let r = parse_with_limits("grpc://a,b,c,d", limits);
    let formatted = match r {
        Ok(_) => "UNEXPECTED OK".to_string(),
        Err(e) => format!("kind:  {:?}\nerror: {}\n", e.kind, e),
    };
    insta::assert_snapshot!("dos_too_many_cluster_hosts", formatted);
}