ajj 0.6.1

Simple, modern, ergonomic JSON-RPC 2.0 router built with tower and axum
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

pub mod ws_client;

use ajj::{HandlerCtx, Router};
use serde_json::{json, Value};
use std::time::Duration;
use tokio::time::{self, timeout};

/// Instantiate a router for testing.
pub fn test_router() -> ajj::Router<()> {
    Router::<()>::new()
        .route("ping", || async move { Ok::<_, ()>("pong") })
        .route(
            "double",
            |params: usize| async move { Ok::<_, ()>(params * 2) },
        )
        .route("call_me_later", |ctx: HandlerCtx| async move {
            ctx.spawn_with_ctx(|ctx| async move {
                time::sleep(time::Duration::from_millis(100)).await;

                let _ = ctx
                    .notify(&json!({
                        "method": "call_me_later",
                        "result": "notified"
                    }))
                    .await;
            });

            Ok::<_, ()>(())
        })
}

/// Test clients
pub trait TestClient {
    fn next_id(&mut self) -> usize;

    async fn send_raw<S: serde::Serialize>(&mut self, msg: &S);

    async fn recv<D: serde::de::DeserializeOwned>(&mut self) -> D;

    async fn send<S: serde::Serialize>(&mut self, method: &str, params: &S) -> usize {
        let id = self.next_id();
        self.send_raw(&json!({
            "jsonrpc": "2.0",
            "id": id,
            "method": method,
            "params": params,
        }))
        .await;
        id
    }
}

// SPEC: notifications receive no response.
async fn test_notification<T: TestClient>(client: &mut T) {
    client
        .send_raw(&json!(
            {"jsonrpc": "2.0", "method": "ping"}
        ))
        .await;

    let next: Result<Value, _> = timeout(Duration::from_millis(100), client.recv()).await;

    // The notification should not have a response
    assert!(next.is_err());
}

async fn test_call_me_later<T: TestClient>(client: &mut T) {
    let id = client.send("call_me_later", &()).await;

    let now = std::time::Instant::now();

    let next: Value = client.recv().await;
    assert_eq!(
        next,
        serde_json::json!({"id": id, "jsonrpc": "2.0", "result": null})
    );

    let next: Value = client.recv().await;
    assert!(now.elapsed().as_millis() >= 100);
    assert_eq!(
        next,
        serde_json::json!({"method": "call_me_later", "result": "notified"})
    );
}

async fn test_double<T: TestClient>(client: &mut T) {
    let id = client.send("double", &5).await;
    let next: Value = client.recv().await;
    assert_eq!(
        next,
        serde_json::json!({"id": id, "jsonrpc": "2.0", "result": 10})
    );
}

async fn test_ping<T: TestClient>(client: &mut T) {
    let id = client.send("ping", &()).await;

    let next: Value = client.recv().await;
    assert_eq!(
        next,
        serde_json::json!({"id": id, "jsonrpc": "2.0", "result": "pong"})
    );
}

/// basic tests of the test router
pub async fn basic_tests<T: TestClient>(client: &mut T) {
    timeout(Duration::from_secs(10), async move {
        test_ping(client).await;

        test_double(client).await;

        test_call_me_later(client).await;

        test_notification(client).await;
    })
    .await
    .unwrap();
}

/// Test when a full batch request fails to parse
async fn batch_parse_fail<T: TestClient>(client: &mut T) {
    client.send_raw(&json!(r#""invalid request""#)).await;

    let next: Value = client.recv().await;
    assert_eq!(
        next,
        serde_json::json!({
            "id": null,
            "jsonrpc": "2.0",
            "error": {
                "code": -32700,
                "message": "Parse error"
            }
        })
    );
}

// Test when a single request fails to parse
async fn batch_single_req_parse_fail<T: TestClient>(client: &mut T) {
    client
        .send_raw(&json!([
            {"jsonrpc": "2.0", "method": "ping", "id": 1},
            {"jsonrpc": "2.0", "method": "double", "params": 5, "id": 2},
            {"jsonrpc": "2.0", "method": "ping", "id": 4},
            "invalid request"

        ]))
        .await;

    let next: Value = client.recv().await;
    let arr = next.as_array().unwrap();

    assert_eq!(
        arr[0],
        serde_json::json!({
            "id": null,
            "jsonrpc": "2.0",
            "error": {
                "code": -32700,
                "message": "Parse error"
            }
        })
    );

    assert_eq!(arr.len(), 4);
    assert!(arr.contains(&serde_json::json!({"id": 1, "jsonrpc": "2.0", "result": "pong"})));
    assert!(arr.contains(&serde_json::json!({"id": 2, "jsonrpc": "2.0", "result": 10})));
    assert!(arr.contains(&serde_json::json!({"id": 4, "jsonrpc": "2.0", "result": "pong"})));
    assert!(arr.contains(&serde_json::json!({
        "id": null,
        "jsonrpc": "2.0",
        "error": {
            "code": -32700,
            "message": "Parse error"
        }
    })));
}

// SPEC: notifications receive no response.
async fn batch_contains_notification<T: TestClient>(client: &mut T) {
    let batch = json!([
        {"jsonrpc": "2.0", "method": "ping"},
        {"jsonrpc": "2.0", "method": "double", "params": 5, "id": 2},
        {"jsonrpc": "2.0", "method": "ping", "id": 4},
    ]);

    client.send_raw(&batch).await;
    let next: Value = client.recv().await;

    let arr = next.as_array().unwrap();
    assert_eq!(arr.len(), 2);
    assert!(arr.contains(&serde_json::json!({"id": 2, "jsonrpc": "2.0", "result": 10})));
    assert!(arr.contains(&serde_json::json!({"id": 4, "jsonrpc": "2.0", "result": "pong"})));
}

// SPEC: batches that contain only notifications receive no response.
async fn batch_contains_only_notifications<T: TestClient>(client: &mut T) {
    let batch = json!([
        {"jsonrpc": "2.0", "method": "ping"},
        {"jsonrpc": "2.0", "method": "ping"},
        {"jsonrpc": "2.0", "method": "ping"},
    ]);

    client.send_raw(&batch).await;
    let res = timeout(Duration::from_millis(200), client.recv::<Value>()).await;

    assert!(res.is_err());
}

/// Test of batch requests
pub async fn batch_tests<T: TestClient>(client: &mut T) {
    timeout(Duration::from_secs(10), async move {
        batch_parse_fail(client).await;

        batch_single_req_parse_fail(client).await;

        batch_contains_notification(client).await;

        batch_contains_only_notifications(client).await;
    })
    .await
    .unwrap();
}