tx3 0.0.1

tx3 p2p communications
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

use crate::*;
use tokio::io::AsyncReadExt;
use tokio::io::AsyncWriteExt;

fn init_tracing() {
    let subscriber = tracing_subscriber::FmtSubscriber::builder()
        .with_env_filter(
            tracing_subscriber::filter::EnvFilter::from_default_env(),
        )
        .with_file(true)
        .with_line_number(true)
        .finish();
    let _ = tracing::subscriber::set_global_default(subscriber);
}

#[tokio::test(flavor = "multi_thread")]
async fn relay_test_max_inbound_connections() {
    init_tracing();

    tracing::info!("setup relay");

    let mut relay_config =
        Tx3RelayConfig::new().with_bind("tx3-rst://127.0.0.1:0");
    relay_config.max_inbound_connections = 1;

    let relay = Tx3Relay::new(relay_config).await.unwrap();
    let r_addr = relay.local_addrs()[0].to_owned();

    tracing::info!("first connection");

    // make the first connection
    let node1 = Tx3Node::new(Tx3Config::new().with_bind(&r_addr))
        .await
        .unwrap();

    tracing::info!("second (expect to fail) connection");

    // the second connection should error
    assert!(Tx3Node::new(Tx3Config::new().with_bind(&r_addr))
        .await
        .is_err());

    tracing::info!("drop first connection");

    // if we drop the first connection
    drop(node1);

    // give the system time to notify the socket is closed
    tokio::time::sleep(std::time::Duration::from_secs(1)).await;

    tracing::info!("third connection");

    // the third connection should be a success again
    assert!(Tx3Node::new(Tx3Config::new().with_bind(&r_addr))
        .await
        .is_ok());
}

/// this test should be identical to max_inbound_connections above,
/// it just is not as efficient from the relay server's perspective.
#[tokio::test(flavor = "multi_thread")]
async fn relay_test_max_control_streams() {
    init_tracing();

    tracing::info!("setup relay");

    let mut relay_config =
        Tx3RelayConfig::new().with_bind("tx3-rst://127.0.0.1:0");
    relay_config.max_control_streams = 1;

    let relay = Tx3Relay::new(relay_config).await.unwrap();
    let r_addr = relay.local_addrs()[0].to_owned();

    tracing::info!("first connection");

    // make the first connection
    let node1 = Tx3Node::new(Tx3Config::new().with_bind(&r_addr))
        .await
        .unwrap();

    tracing::info!("second (expect to fail) connection");

    // the second connection should error
    assert!(Tx3Node::new(Tx3Config::new().with_bind(&r_addr))
        .await
        .is_err());

    tracing::info!("drop first connection");

    // if we drop the first connection
    drop(node1);

    // give the system time to notify the socket is closed
    tokio::time::sleep(std::time::Duration::from_secs(1)).await;

    tracing::info!("third connection");

    // the third connection should be a success again
    assert!(Tx3Node::new(Tx3Config::new().with_bind(&r_addr))
        .await
        .is_ok());
}

/// this test should be identical to the above two tests,
/// since we're establishing our test connections from the same loopback dev
#[tokio::test(flavor = "multi_thread")]
async fn relay_test_max_control_streams_per_ip() {
    init_tracing();

    tracing::info!("setup relay");

    let mut relay_config =
        Tx3RelayConfig::new().with_bind("tx3-rst://127.0.0.1:0");
    relay_config.max_control_streams_per_ip = 1;

    let relay = Tx3Relay::new(relay_config).await.unwrap();
    let r_addr = relay.local_addrs()[0].to_owned();

    tracing::info!("first connection");

    // make the first connection
    let node1 = Tx3Node::new(Tx3Config::new().with_bind(&r_addr))
        .await
        .unwrap();

    tracing::info!("second (expect to fail) connection");

    // the second connection should error
    assert!(Tx3Node::new(Tx3Config::new().with_bind(&r_addr))
        .await
        .is_err());

    tracing::info!("drop first connection");

    // if we drop the first connection
    drop(node1);

    // give the system time to notify the socket is closed
    tokio::time::sleep(std::time::Duration::from_secs(1)).await;

    tracing::info!("third connection");

    // the third connection should be a success again
    assert!(Tx3Node::new(Tx3Config::new().with_bind(&r_addr))
        .await
        .is_ok());
}

/// this test is a little unique because we actually need to setup relay streams
#[tokio::test(flavor = "multi_thread")]
async fn relay_test_max_relays_per_control() {
    init_tracing();

    tracing::info!("setup relay");

    let mut relay_config =
        Tx3RelayConfig::new().with_bind("tx3-rst://127.0.0.1:0");
    relay_config.max_relays_per_control = 1;

    let relay = Tx3Relay::new(relay_config).await.unwrap();
    let r_addr = relay.local_addrs()[0].to_owned();

    tracing::info!("setup main receiver node");

    // setup the main addressee
    let (main_ep, mut main_recv) =
        Tx3Node::new(Tx3Config::new().with_bind(&r_addr))
            .await
            .unwrap();
    let main_addr = main_ep.local_addrs()[0].to_owned();

    // handle incoming connections
    let r_task = tokio::task::spawn(async move {
        let mut all = Vec::new();

        for _ in 0..2 {
            tracing::info!("got one connection");

            let a = main_recv.recv().await.unwrap();
            all.push(tokio::task::spawn(async move {
                let mut socket = a.accept().await.unwrap();
                let mut got = [0; 5];
                socket.read_exact(&mut got).await.unwrap();
                assert_eq!(b"hello", &got[..]);
            }));
        }

        for t in all {
            t.await.unwrap();
        }
    });

    tracing::info!("make first connection");

    let (n1, _) = Tx3Node::new(Tx3Config::new()).await.unwrap();
    let mut c1 = n1.connect(&main_addr).await.unwrap();

    let (n2, _) = Tx3Node::new(Tx3Config::new()).await.unwrap();

    tracing::info!("should fail to make second connection");

    // c1 is still open, so n2 cannot create a second relay stream
    assert!(n2.connect(&main_addr).await.is_err());

    // but c1 still works
    c1.write_all(b"hello").await.unwrap();
    c1.flush().await.unwrap();

    tracing::info!("drop first connection");

    // and after we drop it
    drop(c1);
    drop(n1);

    // give the system time to notify the socket is closed
    tokio::time::sleep(std::time::Duration::from_secs(1)).await;

    tracing::info!("make third connection");

    let (n3, _) = Tx3Node::new(Tx3Config::new()).await.unwrap();
    // we are able to successfully establish c3
    let mut c3 = n3.connect(&main_addr).await.unwrap();

    // and use it
    c3.write_all(b"hello").await.unwrap();
    c3.flush().await.unwrap();

    // make sure we receive just c1 and c3 on the recv side
    r_task.await.unwrap();
}