nodedb 0.4.0

Local-first, real-time, edge-to-cloud hybrid database for multi-modal workloads
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

// SPDX-License-Identifier: BUSL-1.1

//! Smoke tests for POST /v1/query and POST /v1/query/stream.
//!
//! Contracts asserted:
//! - 200 + JSON body with `rows` + correct content-type under Trust mode
//! - 401 when no bearer token under Password mode
//! - 400 for malformed request body (missing `sql` field)
//! - 400 for syntactically invalid SQL
//! - Content-Type is the v1 vendor type on success

mod common;
use common::pgwire_harness::TestServer;

use std::sync::Arc;
use std::time::Duration;

use nodedb::bridge::dispatch::Dispatcher;
use nodedb::config::auth::AuthMode;
use nodedb::control::state::SharedState;
use nodedb::wal::WalManager;

struct HttpOnlyServer {
    local_addr: std::net::SocketAddr,
    _server: tokio::task::JoinHandle<()>,
    _dir: tempfile::TempDir,
}

async fn start_http(auth_mode: AuthMode) -> HttpOnlyServer {
    let dir = tempfile::tempdir().expect("tempdir");
    let wal =
        Arc::new(WalManager::open_for_testing(&dir.path().join("query.wal")).expect("open wal"));
    let (dispatcher, _data_sides) = Dispatcher::new(1, 64);
    let shared = SharedState::new(dispatcher, wal).unwrap();
    if auth_mode == AuthMode::Trust {
        shared
            .credentials
            .bootstrap_trust_superuser("nodedb")
            .expect("bootstrap trust superuser");
    }

    let listener = tokio::net::TcpListener::bind("127.0.0.1:0")
        .await
        .expect("bind");
    let local_addr = listener.local_addr().expect("local addr");

    let (bus, _) = nodedb::control::shutdown::ShutdownBus::new(Arc::clone(&shared.shutdown));
    let shared_http = Arc::clone(&shared);
    let handle = tokio::spawn(async move {
        nodedb::control::server::http::server::run_with_listener(
            listener,
            shared_http,
            auth_mode,
            None,
            bus,
        )
        .await
        .ok();
    });

    tokio::time::sleep(Duration::from_millis(40)).await;

    HttpOnlyServer {
        local_addr,
        _server: handle,
        _dir: dir,
    }
}

// ─── /v1/query — auth ────────────────────────────────────────────────────────

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn query_requires_auth_under_password_mode() {
    let srv = start_http(AuthMode::Password).await;
    let url = format!("http://{}/v1/query", srv.local_addr);
    let resp = reqwest::Client::new()
        .post(&url)
        .json(&serde_json::json!({"sql": "SELECT 1"}))
        .send()
        .await
        .expect("POST /v1/query");
    assert_eq!(
        resp.status(),
        reqwest::StatusCode::UNAUTHORIZED,
        "/v1/query must require auth under Password mode"
    );
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn query_rejects_invalid_bearer() {
    let srv = start_http(AuthMode::Password).await;
    let url = format!("http://{}/v1/query", srv.local_addr);
    let resp = reqwest::Client::new()
        .post(&url)
        .header("Authorization", "Bearer ndb_bogus")
        .json(&serde_json::json!({"sql": "SELECT 1"}))
        .send()
        .await
        .expect("POST /v1/query");
    assert_eq!(
        resp.status(),
        reqwest::StatusCode::UNAUTHORIZED,
        "/v1/query must reject invalid bearer tokens"
    );
}

// ─── /v1/query — malformed request ───────────────────────────────────────────

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn query_returns_400_for_missing_sql_field() {
    let srv = start_http(AuthMode::Trust).await;
    let url = format!("http://{}/v1/query", srv.local_addr);
    // Body is valid JSON but lacks the required `sql` field.
    let resp = reqwest::Client::new()
        .post(&url)
        .header("Content-Type", "application/json")
        .body(r#"{"notSql": "SELECT 1"}"#)
        .send()
        .await
        .expect("POST /v1/query");
    assert_eq!(
        resp.status(),
        reqwest::StatusCode::UNPROCESSABLE_ENTITY,
        "/v1/query must return 422 for missing `sql` field (axum deserialization error)"
    );
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn query_returns_400_for_non_json_body() {
    let srv = start_http(AuthMode::Trust).await;
    let url = format!("http://{}/v1/query", srv.local_addr);
    let resp = reqwest::Client::new()
        .post(&url)
        .header("Content-Type", "application/json")
        .body("this is not JSON at all")
        .send()
        .await
        .expect("POST /v1/query");
    // axum returns 400 for JSON parse failures
    assert_eq!(
        resp.status(),
        reqwest::StatusCode::BAD_REQUEST,
        "/v1/query must return 400 for non-JSON body"
    );
}

// ─── /v1/query — content-type ────────────────────────────────────────────────

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn query_response_carries_vendor_content_type() {
    let srv = start_http(AuthMode::Trust).await;
    let url = format!("http://{}/v1/query", srv.local_addr);
    let resp = reqwest::Client::new()
        .post(&url)
        .json(&serde_json::json!({"sql": "SHOW USERS"}))
        .send()
        .await
        .expect("POST /v1/query");

    // SHOW USERS may succeed (200) or surface an error (4xx/5xx) in a minimal
    // test node — either way the response must carry the vendor content-type.
    let ct = resp
        .headers()
        .get("content-type")
        .and_then(|v| v.to_str().ok())
        .unwrap_or("");
    assert!(
        ct.contains("application/vnd.nodedb.v1+json"),
        "/v1/query responses must carry the v1 vendor content-type; got: {ct}"
    );
}

// ─── /v1/query — wrong HTTP method ───────────────────────────────────────────

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn query_get_returns_405() {
    let srv = start_http(AuthMode::Trust).await;
    let url = format!("http://{}/v1/query", srv.local_addr);
    let resp = reqwest::Client::new()
        .get(&url)
        .send()
        .await
        .expect("GET /v1/query");
    assert_eq!(
        resp.status(),
        reqwest::StatusCode::METHOD_NOT_ALLOWED,
        "/v1/query must reject GET with 405"
    );
}

// ─── /v1/query/stream — auth ─────────────────────────────────────────────────

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn query_stream_requires_auth_under_password_mode() {
    let srv = start_http(AuthMode::Password).await;
    let url = format!("http://{}/v1/query/stream", srv.local_addr);
    let resp = reqwest::Client::new()
        .post(&url)
        .json(&serde_json::json!({"sql": "SELECT 1"}))
        .send()
        .await
        .expect("POST /v1/query/stream");
    assert_eq!(
        resp.status(),
        reqwest::StatusCode::UNAUTHORIZED,
        "/v1/query/stream must require auth under Password mode"
    );
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn query_stream_returns_400_for_missing_sql_field() {
    let srv = start_http(AuthMode::Trust).await;
    let url = format!("http://{}/v1/query/stream", srv.local_addr);
    let resp = reqwest::Client::new()
        .post(&url)
        .header("Content-Type", "application/json")
        .body(r#"{"x": 1}"#)
        .send()
        .await
        .expect("POST /v1/query/stream");
    assert_eq!(
        resp.status(),
        reqwest::StatusCode::UNPROCESSABLE_ENTITY,
        "/v1/query/stream must return 422 for missing `sql` field"
    );
}

/// A `SELECT` whose row count exceeds the Data-Plane `stream_chunk_size`
/// (default 1000) is emitted as several frames on the lazy NDJSON path; the
/// route must surface EVERY row as its own NDJSON line, never truncating to the
/// first chunk. Mirrors the pgwire `streaming_select` regression guard for the
/// HTTP sink.
#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
async fn query_stream_returns_all_rows_across_chunks() {
    const ROW_COUNT: usize = 2_500;

    let srv = TestServer::start_multicores(4).await;
    let client = reqwest::Client::new();
    let stream_url = format!("http://127.0.0.1:{}/v1/query/stream", srv.http_port);

    // Seed over the persistent pgwire connection, not 2500 separate HTTP POSTs:
    // the HTTP sink under test is the streaming SELECT, and hammering the REST
    // endpoint with thousands of rapid single-row inserts trips the per-tenant
    // request rate limiter (429). The pgwire seeding path mirrors the
    // `streaming_select` regression test.
    srv.exec("CREATE COLLECTION http_stream WITH (engine='document_schemaless')")
        .await
        .expect("create collection");
    for i in 0..ROW_COUNT {
        srv.exec(&format!("INSERT INTO http_stream {{ id: 'r{i}', n: {i} }}"))
            .await
            .unwrap_or_else(|e| panic!("insert {i} failed: {e}"));
    }

    // No ORDER BY / DISTINCT / OFFSET / aggregate → streamable unordered scan.
    let resp = client
        .post(&stream_url)
        .json(&serde_json::json!({"sql": "SELECT n FROM http_stream"}))
        .send()
        .await
        .expect("POST /v1/query/stream");
    assert!(
        resp.status().is_success(),
        "streaming SELECT must succeed; got {}",
        resp.status()
    );

    let body = resp.text().await.expect("read ndjson body");
    let lines: Vec<&str> = body.lines().filter(|l| !l.trim().is_empty()).collect();
    assert_eq!(
        lines.len(),
        ROW_COUNT,
        "lazy NDJSON stream must emit all {ROW_COUNT} rows, not a truncated chunk"
    );
    // No in-band error line should appear on the happy path.
    for line in &lines {
        let v: serde_json::Value = sonic_rs::from_str(line).expect("each line is valid JSON");
        assert!(
            v.get("error").is_none(),
            "no NDJSON line should be an in-band error on the happy path: {line}"
        );
    }
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn query_stream_response_is_ndjson_content_type() {
    let srv = start_http(AuthMode::Trust).await;
    let url = format!("http://{}/v1/query/stream", srv.local_addr);
    let resp = reqwest::Client::new()
        .post(&url)
        .json(&serde_json::json!({"sql": "SHOW USERS"}))
        .send()
        .await
        .expect("POST /v1/query/stream");

    let ct = resp
        .headers()
        .get("content-type")
        .and_then(|v| v.to_str().ok())
        .unwrap_or("");
    // Either the streaming ndjson type or a 4xx error — if 2xx, must be ndjson.
    if resp.status().is_success() {
        assert!(
            ct.contains("ndjson") || ct.contains("x-ndjson"),
            "/v1/query/stream Content-Type must be application/x-ndjson on success; got: {ct}"
        );
    }
}