durable-streams-server 0.3.0

Durable Streams protocol server in Rust, built with axum and tokio
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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
mod common;

use common::{spawn_test_server, test_client, unique_stream_name};

/// Helper: create a stream and return its name
async fn setup_stream(base_url: &str, client: &reqwest::Client) -> String {
    let name = unique_stream_name();
    client
        .put(format!("{base_url}/v1/stream/{name}"))
        .header("Content-Type", "text/plain")
        .send()
        .await
        .unwrap();
    name
}

/// Validates spec: 08-stream-closure.md#close-without-data
///
/// POST close-only (empty body + Stream-Closed: true) returns 204
/// with Stream-Closed: true header.
#[tokio::test]
async fn test_close_response_includes_stream_closed_header() {
    let (base_url, _port) = spawn_test_server().await;
    let client = test_client();
    let name = setup_stream(&base_url, &client).await;

    let response = client
        .post(format!("{base_url}/v1/stream/{name}"))
        .header("Content-Type", "text/plain")
        .header("Stream-Closed", "true")
        .send()
        .await
        .unwrap();

    assert_eq!(response.status(), 204);

    let closed = response
        .headers()
        .get("Stream-Closed")
        .expect("Missing Stream-Closed header on close response")
        .to_str()
        .unwrap();
    assert_eq!(closed, "true");

    assert!(
        response.headers().get("Stream-Next-Offset").is_some(),
        "Missing Stream-Next-Offset on close response"
    );
}

/// Validates spec: 08-stream-closure.md#close-with-data
///
/// POST close-with-data returns 204 with Stream-Closed: true header.
#[tokio::test]
async fn test_close_with_data_response_includes_stream_closed_header() {
    let (base_url, _port) = spawn_test_server().await;
    let client = test_client();
    let name = setup_stream(&base_url, &client).await;

    let response = client
        .post(format!("{base_url}/v1/stream/{name}"))
        .header("Content-Type", "text/plain")
        .header("Stream-Closed", "true")
        .body("final message")
        .send()
        .await
        .unwrap();

    assert_eq!(response.status(), 204);

    let closed = response
        .headers()
        .get("Stream-Closed")
        .expect("Missing Stream-Closed header on close-with-data response")
        .to_str()
        .unwrap();
    assert_eq!(closed, "true");

    // Next offset should reflect the appended message (13 bytes)
    let next_offset = response
        .headers()
        .get("Stream-Next-Offset")
        .expect("Missing Stream-Next-Offset")
        .to_str()
        .unwrap();
    assert_eq!(next_offset, "0000000000000001_000000000000000d");
}

/// Validates spec: 08-stream-closure.md#idempotent-close
///
/// Closing an already-closed stream returns 204 with Stream-Closed: true.
#[tokio::test]
async fn test_idempotent_close_returns_204_with_headers() {
    let (base_url, _port) = spawn_test_server().await;
    let client = test_client();
    let name = setup_stream(&base_url, &client).await;

    // First close
    client
        .post(format!("{base_url}/v1/stream/{name}"))
        .header("Content-Type", "text/plain")
        .header("Stream-Closed", "true")
        .send()
        .await
        .unwrap();

    // Second close (idempotent)
    let response = client
        .post(format!("{base_url}/v1/stream/{name}"))
        .header("Content-Type", "text/plain")
        .header("Stream-Closed", "true")
        .send()
        .await
        .unwrap();

    assert_eq!(response.status(), 204);

    let closed = response
        .headers()
        .get("Stream-Closed")
        .expect("Missing Stream-Closed on idempotent close")
        .to_str()
        .unwrap();
    assert_eq!(closed, "true");

    assert!(response.headers().get("Stream-Next-Offset").is_some());
}

/// Validates spec: 08-stream-closure.md#create-closed
///
/// PUT with Stream-Closed: true returns Stream-Closed: true in the
/// 201 response.
#[tokio::test]
async fn test_put_created_closed_response_includes_stream_closed() {
    let (base_url, _port) = spawn_test_server().await;
    let client = test_client();
    let name = unique_stream_name();

    let response = client
        .put(format!("{base_url}/v1/stream/{name}"))
        .header("Content-Type", "text/plain")
        .header("Stream-Closed", "true")
        .send()
        .await
        .unwrap();

    assert_eq!(response.status(), 201);

    let closed = response
        .headers()
        .get("Stream-Closed")
        .expect("Missing Stream-Closed on PUT create-closed response")
        .to_str()
        .unwrap();
    assert_eq!(closed, "true");
}

/// Validates spec: 08-stream-closure.md#create-closed
///
/// Idempotent PUT on a closed stream returns 200 with Stream-Closed: true.
#[tokio::test]
async fn test_put_idempotent_recreate_closed_includes_header() {
    let (base_url, _port) = spawn_test_server().await;
    let client = test_client();
    let name = unique_stream_name();

    // Create closed
    client
        .put(format!("{base_url}/v1/stream/{name}"))
        .header("Content-Type", "text/plain")
        .header("Stream-Closed", "true")
        .send()
        .await
        .unwrap();

    // Idempotent recreate
    let response = client
        .put(format!("{base_url}/v1/stream/{name}"))
        .header("Content-Type", "text/plain")
        .header("Stream-Closed", "true")
        .send()
        .await
        .unwrap();

    assert_eq!(response.status(), 200);

    let closed = response
        .headers()
        .get("Stream-Closed")
        .expect("Missing Stream-Closed on idempotent PUT of closed stream")
        .to_str()
        .unwrap();
    assert_eq!(closed, "true");
}

/// Validates spec: 08-stream-closure.md#error-precedence
///
/// Appending to a closed stream returns 409 with both Stream-Closed
/// and Stream-Next-Offset.
#[tokio::test]
async fn test_closed_stream_reject_includes_next_offset() {
    let (base_url, _port) = spawn_test_server().await;
    let client = test_client();
    let name = setup_stream(&base_url, &client).await;

    // Append some data
    client
        .post(format!("{base_url}/v1/stream/{name}"))
        .header("Content-Type", "text/plain")
        .body("data")
        .send()
        .await
        .unwrap();

    // Close
    client
        .post(format!("{base_url}/v1/stream/{name}"))
        .header("Content-Type", "text/plain")
        .header("Stream-Closed", "true")
        .send()
        .await
        .unwrap();

    // Attempt append to closed stream
    let response = client
        .post(format!("{base_url}/v1/stream/{name}"))
        .header("Content-Type", "text/plain")
        .body("rejected")
        .send()
        .await
        .unwrap();

    assert_eq!(response.status(), 409);

    let closed = response
        .headers()
        .get("Stream-Closed")
        .expect("Missing Stream-Closed on 409 response")
        .to_str()
        .unwrap();
    assert_eq!(closed, "true");

    let next_offset = response
        .headers()
        .get("Stream-Next-Offset")
        .expect("Missing Stream-Next-Offset on 409 response")
        .to_str()
        .unwrap();
    // After appending "data" (4 bytes), next_offset should be at seq 1
    assert_eq!(next_offset, "0000000000000001_0000000000000004");
}

/// Validates spec: 08-stream-closure.md#requirements
///
/// Stream-Closed: false (non-"true" value) does not close the stream.
#[tokio::test]
async fn test_close_with_non_true_value_ignored() {
    let (base_url, _port) = spawn_test_server().await;
    let client = test_client();
    let name = setup_stream(&base_url, &client).await;

    // Append with Stream-Closed: false
    let response = client
        .post(format!("{base_url}/v1/stream/{name}"))
        .header("Content-Type", "text/plain")
        .header("Stream-Closed", "false")
        .body("still open")
        .send()
        .await
        .unwrap();

    assert_eq!(response.status(), 204);

    // Stream should NOT have Stream-Closed header in response
    assert!(
        response.headers().get("Stream-Closed").is_none(),
        "Stream-Closed should not be present when value is 'false'"
    );

    // Verify stream is still open by appending more data
    let response2 = client
        .post(format!("{base_url}/v1/stream/{name}"))
        .header("Content-Type", "text/plain")
        .body("more data")
        .send()
        .await
        .unwrap();

    assert_eq!(
        response2.status(),
        204,
        "Stream should still accept appends"
    );
}

/// Validates spec: 08-stream-closure.md#read-mode-behavior
///
/// Reading an open stream with data returns Stream-Up-To-Date: true
/// but does NOT include Stream-Closed, verifying the header is only
/// emitted when the stream is actually closed.
///
/// Note: The server returns all messages from the requested offset to
/// the end of the stream in a single response — pagination is the
/// client's responsibility (resume from Stream-Next-Offset). Because
/// of this, `at_tail` is always true for data reads, so a true
/// "mid-stream on closed" scenario (`at_tail=false`, `closed=true`) cannot
/// occur at the HTTP layer. This test covers the `closed` guard
/// dimension instead: `at_tail=true`, `closed=false` → no Stream-Closed.
#[tokio::test]
async fn test_read_open_stream_omits_closed_header() {
    let (base_url, _port) = spawn_test_server().await;
    let client = test_client();
    let name = setup_stream(&base_url, &client).await;

    // Append messages but do NOT close
    for msg in &["first", "second", "third"] {
        client
            .post(format!("{base_url}/v1/stream/{name}"))
            .header("Content-Type", "text/plain")
            .body(*msg)
            .send()
            .await
            .unwrap();
    }

    // Read all messages — at_tail=true, closed=false
    let response = client
        .get(format!("{base_url}/v1/stream/{name}?offset=-1"))
        .send()
        .await
        .unwrap();

    assert_eq!(response.status(), 200);

    let up_to_date = response
        .headers()
        .get("Stream-Up-To-Date")
        .unwrap()
        .to_str()
        .unwrap();
    assert_eq!(up_to_date, "true", "Should be at tail after reading all");

    assert!(
        response.headers().get("Stream-Closed").is_none(),
        "Stream-Closed must not be present on an open stream"
    );
}

/// Validates spec: 08-stream-closure.md#read-mode-behavior
///
/// Reading a closed stream at the tail includes Stream-Closed: true.
#[tokio::test]
async fn test_read_at_tail_includes_closed_header() {
    let (base_url, _port) = spawn_test_server().await;
    let client = test_client();
    let name = setup_stream(&base_url, &client).await;

    // Append a message
    client
        .post(format!("{base_url}/v1/stream/{name}"))
        .header("Content-Type", "text/plain")
        .body("hello")
        .send()
        .await
        .unwrap();

    // Close the stream
    let close_response = client
        .post(format!("{base_url}/v1/stream/{name}"))
        .header("Content-Type", "text/plain")
        .header("Stream-Closed", "true")
        .send()
        .await
        .unwrap();

    let final_offset = close_response
        .headers()
        .get("Stream-Next-Offset")
        .unwrap()
        .to_str()
        .unwrap()
        .to_string();

    // Read from the final offset (at tail, no messages ahead)
    let response = client
        .get(format!("{base_url}/v1/stream/{name}?offset={final_offset}"))
        .send()
        .await
        .unwrap();

    assert_eq!(response.status(), 200);

    let up_to_date = response
        .headers()
        .get("Stream-Up-To-Date")
        .unwrap()
        .to_str()
        .unwrap();
    assert_eq!(up_to_date, "true");

    let closed = response
        .headers()
        .get("Stream-Closed")
        .expect("Missing Stream-Closed at tail of closed stream")
        .to_str()
        .unwrap();
    assert_eq!(closed, "true");
}