velesdb-server 6.0.0

REST API server for VelesDB vector database
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
use super::*;

#[test]
fn test_openapi_spec_generation() {
    let openapi = ApiDoc::openapi();
    let json = openapi.to_json().expect("Failed to serialize OpenAPI spec");
    assert!(!json.is_empty(), "OpenAPI spec should not be empty");
    assert!(json.contains("VelesDB API"), "Should contain API title");
    assert!(
        json.contains(env!("CARGO_PKG_VERSION")),
        "Should contain version"
    );
}

#[test]
fn test_openapi_has_all_endpoints() {
    let openapi = ApiDoc::openapi();
    let json = openapi.to_json().expect("Failed to serialize OpenAPI spec");
    assert!(json.contains("/health"), "Should document /health");
    assert!(
        json.contains("/collections"),
        "Should document /collections"
    );
    assert!(
        json.contains(r"/collections/{name}"),
        "Should document collections by name"
    );
    assert!(json.contains("/points"), "Should document points endpoint");
    assert!(
        json.contains(r"/collections/{name}/points/stream"),
        "Should document points stream endpoint"
    );
    assert!(json.contains("/search"), "Should document search endpoint");
    assert!(json.contains("/query"), "Should document /query");
    assert!(json.contains("/aggregate"), "Should document /aggregate");
    assert!(
        json.contains("/query/explain"),
        "Should document /query/explain"
    );
}

#[test]
fn test_openapi_has_all_tags() {
    let openapi = ApiDoc::openapi();
    let json = openapi.to_json().expect("Failed to serialize OpenAPI spec");
    assert!(json.contains("\"health\""), "Should have health tag");
    assert!(
        json.contains("\"collections\""),
        "Should have collections tag"
    );
    assert!(json.contains("\"points\""), "Should have points tag");
    assert!(json.contains("\"search\""), "Should have search tag");
    assert!(json.contains("\"query\""), "Should have query tag");
}

#[test]
fn test_openapi_has_schemas() {
    let openapi = ApiDoc::openapi();
    let json = openapi.to_json().expect("Failed to serialize OpenAPI spec");
    assert!(
        json.contains("CreateCollectionRequest"),
        "Should have CreateCollectionRequest schema"
    );
    assert!(
        json.contains("CollectionResponse"),
        "Should have CollectionResponse schema"
    );
    assert!(
        json.contains("SearchRequest"),
        "Should have SearchRequest schema"
    );
    assert!(
        json.contains("SearchResponse"),
        "Should have SearchResponse schema"
    );
    assert!(
        json.contains("ErrorResponse"),
        "Should have ErrorResponse schema"
    );
}

/// Regenerates `docs/openapi.{json,yaml}` in place instead of only
/// comparing against them. Opt-in via `UPDATE_OPENAPI_SNAPSHOT=1` so that
/// a plain `cargo test` — including the default parallel test threads —
/// never mutates the working tree; see `generate_openapi_spec_files`.
fn update_openapi_snapshot_requested() -> bool {
    std::env::var_os("UPDATE_OPENAPI_SNAPSHOT").is_some()
}

// #[ignore]: excludes this from the general `cargo test --workspace`
// sweep (the "Tests" CI job), which runs with a DIFFERENT feature set
// (persistence,gpu,update-check, no `openapi`/`prometheus`) than the one
// the committed docs/openapi.{json,yaml} were generated under. Run under
// that other feature set, the assert-equal below fails on a real (but
// benign) schema difference -- not staleness, a feature-combination
// mismatch. Only the dedicated `openapi-drift` CI step, which targets
// this test by exact name with `--ignored` under the canonical feature
// set, should ever run it.
#[test]
#[ignore = "run explicitly via the openapi-drift CI job; see comment above"]
fn generate_openapi_spec_files() {
    let openapi = ApiDoc::openapi();
    let json = openapi
        .to_pretty_json()
        .expect("Failed to serialize OpenAPI JSON");
    let yaml = serde_yaml::to_string(&openapi).expect("Failed to serialize OpenAPI YAML");

    // docs/ relative to workspace root
    let docs_dir = std::path::Path::new(env!("CARGO_MANIFEST_DIR"))
        .parent()
        .expect("test: CARGO_MANIFEST_DIR has a parent (crates/)")
        .parent()
        .expect("test: crates/ has a parent (workspace root)")
        .join("docs");
    let json_path = docs_dir.join("openapi.json");
    let yaml_path = docs_dir.join("openapi.yaml");

    if update_openapi_snapshot_requested() {
        std::fs::create_dir_all(&docs_dir).expect("Failed to create docs dir");
        std::fs::write(&json_path, &json).expect("Failed to write openapi.json");
        std::fs::write(&yaml_path, &yaml).expect("Failed to write openapi.yaml");
    } else {
        let committed_json = std::fs::read_to_string(&json_path).expect(
            "Failed to read docs/openapi.json (run with UPDATE_OPENAPI_SNAPSHOT=1 to create it)",
        );
        let committed_yaml = std::fs::read_to_string(&yaml_path).expect(
            "Failed to read docs/openapi.yaml (run with UPDATE_OPENAPI_SNAPSHOT=1 to create it)",
        );
        assert_eq!(
            json, committed_json,
            "docs/openapi.json is stale — rerun with UPDATE_OPENAPI_SNAPSHOT=1 to regenerate"
        );
        assert_eq!(
            yaml, committed_yaml,
            "docs/openapi.yaml is stale — rerun with UPDATE_OPENAPI_SNAPSHOT=1 to regenerate"
        );
    }

    // Verify key endpoints are present
    assert!(
        json.contains("sparse"),
        "OpenAPI spec should contain sparse endpoints"
    );
    assert!(
        json.contains("/graph/edges"),
        "Should contain graph edge endpoints"
    );
    assert!(
        json.contains("/graph/traverse"),
        "Should contain graph traverse endpoint"
    );
    assert!(
        json.contains("/stream/insert"),
        "Should contain stream insert endpoint"
    );
    assert!(
        json.contains("/match"),
        "Should contain match query endpoint"
    );
    assert!(
        json.contains("/search/multi"),
        "Should contain multi-query search endpoint"
    );
}

#[test]
fn test_openapi_has_license() {
    let openapi = ApiDoc::openapi();
    let json = openapi.to_json().expect("Failed to serialize OpenAPI spec");
    assert!(
        json.contains("VelesDB Core License 1.0"),
        "Should have VelesDB Core License 1.0"
    );
}

#[test]
fn test_openapi_pretty_json() {
    let openapi = ApiDoc::openapi();
    let pretty_json = openapi
        .to_pretty_json()
        .expect("Failed to serialize pretty JSON");
    assert!(
        pretty_json.contains('\n'),
        "Pretty JSON should have newlines"
    );
    assert!(
        pretty_json.len() > 1000,
        "OpenAPI spec should be substantial"
    );
}

#[test]
fn test_openapi_has_all_metrics_documented() {
    let openapi = ApiDoc::openapi();
    let json = openapi.to_json().expect("Failed to serialize OpenAPI spec");
    assert!(json.contains("cosine"), "Should document cosine metric");
    assert!(
        json.contains("euclidean"),
        "Should document euclidean metric"
    );
    assert!(json.contains("dot"), "Should document dot product metric");
    assert!(json.contains("hamming"), "Should document hamming metric");
    assert!(json.contains("jaccard"), "Should document jaccard metric");
}

#[test]
fn test_openapi_has_storage_mode_documented() {
    let openapi = ApiDoc::openapi();
    let json = openapi.to_json().expect("Failed to serialize OpenAPI spec");
    assert!(
        json.contains("storage_mode"),
        "Should document storage_mode parameter"
    );
}

#[test]
fn test_openapi_has_search_types_documented() {
    let openapi = ApiDoc::openapi();
    let json = openapi.to_json().expect("Failed to serialize OpenAPI spec");
    assert!(json.contains("text_search"), "Should document text search");
    assert!(
        json.contains("hybrid_search"),
        "Should document hybrid search"
    );
    assert!(json.contains("batch"), "Should document batch search");
}

#[test]
fn test_create_collection_request_default_metric() {
    let json = r#"{"name": "test", "dimension": 128}"#;
    let req: CreateCollectionRequest =
        serde_json::from_str(json).expect("test: valid CreateCollectionRequest JSON");
    assert_eq!(req.metric, "cosine");
}

#[test]
fn test_create_collection_request_with_hamming() {
    let json = r#"{"name": "test", "dimension": 128, "metric": "hamming"}"#;
    let req: CreateCollectionRequest =
        serde_json::from_str(json).expect("test: valid CreateCollectionRequest JSON");
    assert_eq!(req.metric, "hamming");
}

#[test]
fn test_create_collection_request_with_jaccard() {
    let json = r#"{"name": "test", "dimension": 128, "metric": "jaccard"}"#;
    let req: CreateCollectionRequest =
        serde_json::from_str(json).expect("test: valid CreateCollectionRequest JSON");
    assert_eq!(req.metric, "jaccard");
}

#[test]
fn test_create_collection_request_with_storage_mode() {
    let json = r#"{"name": "test", "dimension": 128, "storage_mode": "sq8"}"#;
    let req: CreateCollectionRequest =
        serde_json::from_str(json).expect("test: valid CreateCollectionRequest JSON");
    assert_eq!(req.storage_mode, "sq8");
}

#[test]
fn test_search_request_deserialize() {
    let json = r#"{"vector": [0.1, 0.2, 0.3], "top_k": 5}"#;
    let req: SearchRequest = serde_json::from_str(json).expect("test: valid SearchRequest JSON");
    assert_eq!(req.vector, vec![0.1, 0.2, 0.3]);
    assert_eq!(req.top_k, 5);
}

#[test]
fn test_batch_search_request_deserialize() {
    let json = r#"{"searches": [{"vector": [0.1, 0.2], "top_k": 3}]}"#;
    let req: BatchSearchRequest =
        serde_json::from_str(json).expect("test: valid BatchSearchRequest JSON");
    assert_eq!(req.searches.len(), 1);
    assert_eq!(req.searches[0].top_k, 3);
}

#[test]
fn test_text_search_request_deserialize() {
    let json = r#"{"query": "machine learning", "top_k": 10}"#;
    let req: TextSearchRequest =
        serde_json::from_str(json).expect("test: valid TextSearchRequest JSON");
    assert_eq!(req.query, "machine learning");
    assert_eq!(req.top_k, 10);
}

#[test]
fn test_hybrid_search_request_deserialize() {
    let json = r#"{"vector": [0.1, 0.2], "query": "test", "top_k": 5}"#;
    let req: HybridSearchRequest =
        serde_json::from_str(json).expect("test: valid HybridSearchRequest JSON");
    assert_eq!(req.vector, vec![0.1, 0.2]);
    assert_eq!(req.query, "test");
    assert_eq!(req.top_k, 5);
}

#[test]
fn test_upsert_points_request_deserialize() {
    let json = r#"{"points": [{"id": 1, "vector": [0.1, 0.2]}]}"#;
    let req: UpsertPointsRequest =
        serde_json::from_str(json).expect("test: valid UpsertPointsRequest JSON");
    assert_eq!(req.points.len(), 1);
    assert_eq!(req.points[0].id, 1);
}

#[test]
fn test_collection_response_serialize() {
    let resp = CollectionResponse {
        name: "test".to_string(),
        dimension: 128,
        metric: "cosine".to_string(),
        storage_mode: "full".to_string(),
        point_count: 100,
    };
    let json = serde_json::to_string(&resp).expect("test: serialize CollectionResponse");
    assert!(json.contains("\"name\":\"test\""));
    assert!(json.contains("\"dimension\":128"));
    assert!(json.contains("\"metric\":\"cosine\""));
    assert!(json.contains("\"storage_mode\":\"full\""));
    assert!(json.contains("\"point_count\":100"));
}

#[test]
fn test_search_response_serialize() {
    let resp = SearchResponse {
        results: vec![SearchResultResponse {
            id: 1,
            score: 0.95,
            payload: None,
        }],
    };
    let json = serde_json::to_string(&resp).expect("test: serialize SearchResponse");
    assert!(json.contains("\"results\""));
    // IDs are serialized as strings to prevent JavaScript precision loss (WP-0D).
    assert!(json.contains("\"id\":\"1\""));
}

#[test]
fn test_error_response_serialize() {
    let resp = ErrorResponse {
        error: "Test error".to_string(),
        code: None,
    };
    let json = serde_json::to_string(&resp).expect("test: serialize ErrorResponse");
    assert!(json.contains("\"error\":\"Test error\""));
    // code: None is omitted from JSON output
    assert!(!json.contains("\"code\""));
}

// ========================================================================
// OpenAPI <-> Router structural conformance
// ========================================================================

/// Extracts every `(path_template, HTTP method)` pair declared in the
/// OpenAPI spec. Returns a sorted `Vec` for deterministic assertions.
fn extract_openapi_operations() -> Vec<(String, axum::http::Method)> {
    let openapi = ApiDoc::openapi();
    let mut ops = Vec::new();
    for (path, item) in &openapi.paths.paths {
        if item.get.is_some() {
            ops.push((path.clone(), axum::http::Method::GET));
        }
        if item.post.is_some() {
            ops.push((path.clone(), axum::http::Method::POST));
        }
        if item.put.is_some() {
            ops.push((path.clone(), axum::http::Method::PUT));
        }
        if item.delete.is_some() {
            ops.push((path.clone(), axum::http::Method::DELETE));
        }
        if item.patch.is_some() {
            ops.push((path.clone(), axum::http::Method::PATCH));
        }
    }
    ops.sort_by(|a, b| a.0.cmp(&b.0).then_with(|| a.1.as_str().cmp(b.1.as_str())));
    ops
}

/// Converts an OpenAPI path template into a concrete URI by replacing
/// each `{param}` placeholder with a safe dummy value.
fn template_to_uri(template: &str) -> String {
    template
        .replace("{name}", "test_col")
        .replace("{id}", "1")
        .replace("{node_id}", "1")
        .replace("{edge_id}", "1")
        .replace("{label}", "test_label")
        .replace("{property}", "test_prop")
}

/// Creates a minimal [`AppState`] backed by an ephemeral directory.
/// Returns both the state and the `TempDir` guard (must stay alive).
fn create_conformance_state() -> (std::sync::Arc<AppState>, tempfile::TempDir) {
    let dir = tempfile::TempDir::new().expect("test: create temp dir");
    let db = Database::open(dir.path()).expect("test: open database");
    let state = std::sync::Arc::new(AppState {
        db,
        onboarding_metrics: OnboardingMetrics::default(),
        query_limits: parking_lot::RwLock::new(QueryLimits::default()),
        ready: AtomicBool::new(true),
        operational_metrics: velesdb_core::metrics::OperationalMetrics::new_arc(),
        traversal_metrics: Arc::new(velesdb_core::metrics::TraversalMetrics::new()),
        query_duration_histogram: Arc::new(velesdb_core::metrics::DurationHistogram::new()),
    });
    (state, dir)
}

/// Returns `true` when the response is Axum's built-in fallback (route
/// not found), which is a `404` with an empty body. Handler-generated
/// 404s always carry a non-empty JSON body.
async fn is_axum_fallback(resp: axum::http::Response<axum::body::Body>) -> bool {
    if resp.status() != axum::http::StatusCode::NOT_FOUND {
        return false;
    }
    let body = axum::body::to_bytes(resp.into_body(), 1024 * 1024)
        .await
        .expect("test: read response body");
    body.is_empty()
}

/// Structural conformance: every `(path, method)` declared in the OpenAPI
/// spec must be reachable through the Axum router (must NOT hit Axum's
/// built-in fallback 404).
#[tokio::test]
async fn test_openapi_routes_match_router() {
    let operations = extract_openapi_operations();
    assert!(
        !operations.is_empty(),
        "OpenAPI spec should declare at least one operation"
    );

    let (state, _dir) = create_conformance_state();
    let router = crate::routes::api_routes().with_state(state);

    let mut failures: Vec<String> = Vec::new();
    for (template, method) in &operations {
        let uri = template_to_uri(template);
        let req = axum::http::Request::builder()
            .method(method)
            .uri(&uri)
            .header("content-type", "application/json")
            .body(axum::body::Body::from("{}"))
            .expect("test: build request");

        let resp = tower::ServiceExt::oneshot(router.clone(), req)
            .await
            .expect("test: send request");

        if is_axum_fallback(resp).await {
            failures.push(format!("{method} {template}"));
        }
    }

    assert!(
        failures.is_empty(),
        "OpenAPI operations with no matching router route:\n  {}",
        failures.join("\n  ")
    );
}