mirror of
https://github.com/ModernRelay/omnigraph.git
synced 2026-06-30 02:49:39 +02:00
7779b72446
* docs(dev): write-latency roadmap (validated cost model + layered fix)
Records the validated 6-LIST warm-write cost model, the two root causes
(un-GC'd _versions/; re-resolving latest by listing), and the layered fix
(GC + capture-once reuse), plus how commit-graph-table retirement feeds in.
Linked from docs/dev/index.md next to the RFC-013 docs.
* feat(engine)!: strand storage versioning — one internal-schema version, no in-place migration
Set MIN_SUPPORTED == CURRENT == 4: this binary reads exactly one `__manifest`
internal-schema version and refuses any older graph on open with a
rebuild-via-export/import message, instead of migrating it in place. Storage
format changes become a deliberate cutover, not a permanently-carried in-place
migration — the pre-release "complexity must be earned" contract.
Delete the entire in-place migration apparatus and everything that existed only
to support it: the `migrate_vN` arms + dispatcher + stamp-bump helpers + the
schema-version-floor tripwire; `migrate_on_open` (both open modes now refuse);
the legacy `_graph_commits.lance` readers + the v3 test fixtures + migration
tests + `migration.v3_to_v4.*` failpoints + the two surface guards that pinned
Lance variants only the migration matched on; and `state::merge_lineage_rows`.
Keep `read_stamp` / `stamp_current_version` / `set_stamp` /
`refuse_if_stamp_unsupported` — the seam a future one-shot converter plugs into.
`load_commit_cache_for_branch` now reads the `__manifest` projection
unconditionally (sub-v4 graphs are refused at open). Adds
`sub_current_graph_is_refused_on_open_with_rebuild_hint`.
The commit-graph TABLES are still created/used as branch-ref ledgers — their
retirement (CommitGraph -> pure `__manifest` projection) is the next commit.
BREAKING CHANGE: a graph created by omnigraph <= 0.7.2 (internal schema v3) is
refused on open. Rebuild it: `omnigraph export` with the old release, then
`omnigraph init` + `omnigraph load` with this one. Data, vectors, and blobs are
preserved; commit history and branches are not.
* feat(engine)!: retire `_graph_commits.lance` / `_graph_commit_actors.lance` — CommitGraph is a pure `__manifest` projection
Since RFC-013 Phase 7, graph lineage lives in `__manifest` (`graph_commit` /
`graph_head` rows) and branch authority is `__manifest` (branch create forks it
first). The two commit-graph datasets were vestigial: `_graph_commit_actors.lance`
was never written or read; `_graph_commits.lance` carried zero commit rows and
only mirrored the manifest's branch refs (a deny-list "parallel copy"). Retire
both.
- `CommitGraph` collapses to a pure projection: drops its Lance dataset handles
(`dataset`/`actor_dataset`) and all branch methods; `open`/`open_at_branch`/
`refresh`/`init` open NO dataset, building the cache from
`ManifestCoordinator::read_graph_lineage_at`. Removes ~1.4s of cold-open
dataset opens.
- `graph_coordinator`: `commit_graph` is now non-`Option` (always a valid
projection). `branch_create`/`branch_delete` go through `ManifestCoordinator`
only — a single atomic op, replacing the two-step manifest-fork +
commit-graph-fork + rollback. Deleted `create_commit_graph_branch`,
`reclaim_commit_graph_branch`, `ensure_commit_graph_initialized`, and every
`storage.exists(_graph_commits.lance)` gate.
- `optimize`: dropped `reconcile_commit_graph_orphans` and the two tables from
the internal-table compaction set (now `__manifest` only).
- `instrumentation`: `INTERNAL_TABLE_DIRS` no longer lists the two tables.
- Fresh graphs create neither table; `lineage_projection.rs` now asserts both
`.lance` dirs are absent. Deleted the obsolete commit-graph-branch-race
failpoint tests + their failpoint names, and updated the `maintenance`
optimize tests (one internal table, not three).
Review-pass fixes folded in:
- Removed two stale `omnigraph.rs` in-source tests the prior run missed (a
disk-full link failure masked them): one asserting `open` probes
`_graph_commits.lance` (the exists-gate this commit removes) — it was masked
earlier by a disk-full link failure.
- Corrected src comments referencing deleted code (`migrate_v3_to_v4`,
`append_commit`/`append_merge_commit`, the three-internal-table list,
the `_graph_commits` reconcile owner) in publisher/recovery/optimize/recovery_audit.
- Narrowed `set_stamp_for_test` to `cfg(test)` (its only caller is the refusal
test) — removes a dead-code warning in the failpoints build.
Branch create/delete atomicity improves (single atomic `__manifest` op). No
behavior change for reads or branches.
Follow-up (separate commit): the now-always-0 `IoCounts::commit_graph_reads` test
counter + its `IOTracker`, threaded through ~11 cost-test files.
* feat: surface the internal-schema (storage-format) version to operators
After stranding storage versioning (a sub-v4 graph is refused on open), operators
could only discover the storage-format version by hitting a refusal. Surface it:
- `omnigraph version` prints an `internal-schema <N>` line (the binary's CURRENT
storage-format version).
- `omnigraph snapshot` includes `internal_schema_version` — the GRAPH's per-branch
on-disk stamp, read via the new `Omnigraph::internal_schema_version_of`.
- `GET /healthz` includes `internal_schema_version` (server-scoped: the binary's
CURRENT, alongside `version`/`source_version`).
Wire: re-expose `INTERNAL_MANIFEST_SCHEMA_VERSION` as `pub` on `db::manifest`;
add `internal_schema_version: u32` to `SnapshotOutput` + `HealthOutput`;
`snapshot_payload` takes the per-graph version (the `Snapshot` does not carry it),
threaded through the embedded CLI + server snapshot callers. `openapi.json`
regenerated (two added int32 properties). Extends the existing healthz / snapshot /
version tests.
* docs(engine): gate internal-schema version at the graph level; record the per-branch read gap
PR reviewers flagged that the open path validates only main's internal-schema stamp, so a branch read could decode a branch stamped outside this binary's range. The stamp is a graph-wide storage-format property (the upgrade path is a whole-graph export/import), so with one binary version every branch is always CURRENT; divergence needs concurrent multi-version writers, an unsupported topology already in one-winner-CAS territory. Gating per-branch would add a second __manifest open per non-main branch read to defend a state we do not support, unearned complexity that regresses the warm-read budget.
Keep the graph-level gate, document it at the code site (refuse_if_internal_schema_unsupported), and record the read-only residual hole as a known gap in invariants.md to close only when multi-version write topologies become supported. Also clarify the sub-floor rebuild message to say "export with the older omnigraph binary that created it."
No behavior change: HEAD already gated at the graph level.
* test(cost): remove the dead commit_graph_reads IO counter
Phase B retired _graph_commits.lance / _graph_commit_actors.lance, so no commit-graph dataset is opened and the commit_graph IOTracker term is structurally always 0. Remove IoCounts::commit_graph_reads, its total_reads() term, the commit_graph IOTracker in OpProbes, and the now-dead commit_graph_wrapper field on QueryIoProbes (it had no accessor — nothing ever attached it). Drop the 7 trivially-true assert_eq!(commit_graph_reads, 0) checks in warm_read_cost.rs and the debug-print refs in write_cost{,_s3}.rs.
Lineage and actor rows now live in __manifest (RFC-013 Phase 7), so the internal_table_scans_are_flat_in_history gate folds into the single manifest_reads flat-assertion — the manifest scan already covers them. Harness-only; no production runtime impact.
* docs: align with the commit-graph retirement + strand storage versioning
Update the always-loaded and user-facing docs to match the landed state: graph lineage lives in __manifest, the _graph_commits.lance / _graph_commit_actors.lance tables are retired, and storage is strict-single-version (no in-place migration — a sub-CURRENT graph is refused with an export/import rebuild).
Fixed stale claims in invariants.md (the migration/atomicity known-gap entry, the Truth Matrix branch-delete row, the read-path/optimize internal-table scope), lance.md (the migrate_v1_to_v2 PK bullet now reflects init-time set; removed the two deleted v3->v4 migration surface guards), testing.md (dropped the deleted migration failpoint tests; manifest-only internal-table term), writes.md (rewrote the Migration-code section to the strand model), storage.md / maintenance.md / constants.md (retired tables out of the layout, internal-table compaction scope, and the constants cheat-sheet), and AGENTS.md. Marked the retirement DONE in the RFC-013 handoff/roadmap and banner-noted the historical RFC analysis.
Added docs/user/operations/upgrade.md (the export/import rebuild recipe) and docs/dev/versioning.md (the four-axis compatibility policy: release lockstep / wire additive / storage strict-single-version / Lance pinned), cross-linked from the audience indexes and the AGENTS.md topic map, and rewrote the in-progress v0.8.0 release note for the strand model + version surfacing. check-agents-md.sh passes (65 links, 62 docs).
* test(manifest): cover the v3-refusal→export/import rebuild cycle and branch stamp inheritance
Two coverage additions from PR review (P1):
(a) sub_current_graph_is_refused_then_rebuilt_via_export_import — the full operator narrative in one flow: load → export → a sub-CURRENT graph (stamp rewound below CURRENT) is refused with the export nudge → fresh init + load(export) → data present and the rebuilt graph opens. The refusal is stamp-only (read before any data), so a stamp-rewound graph is a faithful stand-in for a real older-release graph without a second binary; vector/blob fidelity stays covered by tests/export.rs.
(b) branch_inherits_main_internal_schema_stamp — proves a branch cannot diverge from main's stamp under single-binary operation (create_branch forks main's __manifest, the publisher does not re-stamp), which is why the graph-level (main-only) stamp gate is sufficient for supported inputs. A divergent branch stamp needs concurrent multi-version writers, the unsupported topology recorded as a known gap.
1434 lines
48 KiB
Rust
1434 lines
48 KiB
Rust
use std::collections::HashSet;
|
|
use std::env;
|
|
use std::fs;
|
|
use std::path::{Path, PathBuf};
|
|
|
|
use axum::Router;
|
|
use axum::body::{Body, to_bytes};
|
|
use axum::http::{Method, Request, StatusCode};
|
|
use omnigraph::db::Omnigraph;
|
|
use omnigraph::loader::{LoadMode, load_jsonl};
|
|
use omnigraph_server::{AppState, build_app, served_openapi};
|
|
use serde_json::Value;
|
|
use tower::ServiceExt;
|
|
|
|
fn fixture(name: &str) -> PathBuf {
|
|
PathBuf::from(env!("CARGO_MANIFEST_DIR"))
|
|
.join("../omnigraph/tests/fixtures")
|
|
.join(name)
|
|
}
|
|
|
|
fn graph_path(root: &Path) -> PathBuf {
|
|
root.join("openapi_test.omni")
|
|
}
|
|
|
|
async fn init_loaded_graph() -> tempfile::TempDir {
|
|
let temp = tempfile::tempdir().unwrap();
|
|
let graph = graph_path(temp.path());
|
|
fs::create_dir_all(&graph).unwrap();
|
|
let schema = fs::read_to_string(fixture("test.pg")).unwrap();
|
|
let data = fs::read_to_string(fixture("test.jsonl")).unwrap();
|
|
Omnigraph::init(graph.to_str().unwrap(), &schema)
|
|
.await
|
|
.unwrap();
|
|
let mut db = Omnigraph::open(graph.to_str().unwrap()).await.unwrap();
|
|
load_jsonl(&mut db, &data, LoadMode::Overwrite)
|
|
.await
|
|
.unwrap();
|
|
temp
|
|
}
|
|
|
|
async fn app_for_loaded_graph() -> (tempfile::TempDir, Router) {
|
|
let temp = init_loaded_graph().await;
|
|
let graph = graph_path(temp.path());
|
|
let state = AppState::open(graph.to_string_lossy().to_string())
|
|
.await
|
|
.unwrap();
|
|
let app = build_app(state);
|
|
(temp, app)
|
|
}
|
|
|
|
async fn app_for_loaded_graph_with_auth(token: &str) -> (tempfile::TempDir, Router) {
|
|
let temp = init_loaded_graph().await;
|
|
let graph = graph_path(temp.path());
|
|
let db = Omnigraph::open(graph.to_str().unwrap()).await.unwrap();
|
|
let state = AppState::new_with_bearer_token(
|
|
graph.to_string_lossy().to_string(),
|
|
db,
|
|
Some(token.to_string()),
|
|
);
|
|
let app = build_app(state);
|
|
(temp, app)
|
|
}
|
|
|
|
async fn json_response(app: &Router, request: Request<Body>) -> (StatusCode, Value) {
|
|
let response = app.clone().oneshot(request).await.unwrap();
|
|
let status = response.status();
|
|
let body = to_bytes(response.into_body(), usize::MAX).await.unwrap();
|
|
let json: Value = serde_json::from_slice(&body).unwrap();
|
|
(status, json)
|
|
}
|
|
|
|
fn openapi_doc() -> utoipa::openapi::OpenApi {
|
|
// RFC-011 cluster-only: the canonical committed spec is the SERVED
|
|
// shape — protected routes nested under `/graphs/{graph_id}/…`,
|
|
// `/healthz` and `/graphs` flat. This matches what the server serves.
|
|
served_openapi()
|
|
}
|
|
|
|
fn openapi_json() -> Value {
|
|
serde_json::to_value(openapi_doc()).unwrap()
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Endpoint integration tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[tokio::test]
|
|
async fn openapi_endpoint_returns_200_with_valid_json() {
|
|
let (_temp, app) = app_for_loaded_graph().await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (status, json) = json_response(&app, request).await;
|
|
assert_eq!(status, StatusCode::OK);
|
|
assert!(json.is_object(), "response must be a JSON object");
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn openapi_endpoint_returns_openapi_31_version() {
|
|
let (_temp, app) = app_for_loaded_graph().await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let version = json["openapi"].as_str().unwrap();
|
|
assert!(
|
|
version.starts_with("3.1"),
|
|
"expected OpenAPI 3.1.x, got {version}"
|
|
);
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn openapi_endpoint_does_not_require_auth() {
|
|
let temp = init_loaded_graph().await;
|
|
let graph = graph_path(temp.path());
|
|
let db = Omnigraph::open(graph.to_str().unwrap()).await.unwrap();
|
|
let state = AppState::new_with_bearer_token(
|
|
graph.to_string_lossy().to_string(),
|
|
db,
|
|
Some("secret-token".to_string()),
|
|
);
|
|
let app = build_app(state);
|
|
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (status, _) = json_response(&app, request).await;
|
|
assert_eq!(
|
|
status,
|
|
StatusCode::OK,
|
|
"/openapi.json should not require auth"
|
|
);
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Info and metadata tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[test]
|
|
fn openapi_info_contains_title_and_description() {
|
|
let doc = openapi_json();
|
|
let info = &doc["info"];
|
|
assert_eq!(info["title"].as_str().unwrap(), "Omnigraph API");
|
|
assert!(info["description"].as_str().unwrap().contains("Omnigraph"));
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_info_contains_version() {
|
|
let doc = openapi_json();
|
|
let version = doc["info"]["version"].as_str().unwrap();
|
|
assert!(!version.is_empty(), "version must not be empty");
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Path coverage tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
// The canonical served spec keeps `/healthz` and `/graphs` flat; every
|
|
// protected route nests under `/graphs/{graph_id}/…`.
|
|
const EXPECTED_PATHS: &[&str] = &[
|
|
"/healthz",
|
|
"/graphs",
|
|
"/graphs/{graph_id}/snapshot",
|
|
"/graphs/{graph_id}/read",
|
|
"/graphs/{graph_id}/query",
|
|
"/graphs/{graph_id}/export",
|
|
"/graphs/{graph_id}/change",
|
|
"/graphs/{graph_id}/mutate",
|
|
"/graphs/{graph_id}/queries",
|
|
"/graphs/{graph_id}/queries/{name}",
|
|
"/graphs/{graph_id}/schema",
|
|
"/graphs/{graph_id}/schema/apply",
|
|
"/graphs/{graph_id}/load",
|
|
"/graphs/{graph_id}/ingest",
|
|
"/graphs/{graph_id}/branches",
|
|
"/graphs/{graph_id}/branches/{branch}",
|
|
"/graphs/{graph_id}/branches/merge",
|
|
"/graphs/{graph_id}/commits",
|
|
"/graphs/{graph_id}/commits/{commit_id}",
|
|
];
|
|
|
|
#[test]
|
|
fn openapi_contains_all_expected_paths() {
|
|
let doc = openapi_json();
|
|
let paths = doc["paths"].as_object().expect("paths must be an object");
|
|
let path_keys: HashSet<&str> = paths.keys().map(|k| k.as_str()).collect();
|
|
|
|
for expected in EXPECTED_PATHS {
|
|
assert!(
|
|
path_keys.contains(expected),
|
|
"missing path: {expected}. Found: {path_keys:?}"
|
|
);
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_has_no_unexpected_paths() {
|
|
let doc = openapi_json();
|
|
let paths = doc["paths"].as_object().expect("paths must be an object");
|
|
let expected: HashSet<&str> = EXPECTED_PATHS.iter().copied().collect();
|
|
|
|
for path in paths.keys() {
|
|
assert!(
|
|
expected.contains(path.as_str()),
|
|
"unexpected path in OpenAPI spec: {path}"
|
|
);
|
|
}
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// HTTP method tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[test]
|
|
fn openapi_healthz_is_get() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/healthz"]["get"].is_object());
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_read_is_post() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/graphs/{graph_id}/read"]["post"].is_object());
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_export_is_post() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/graphs/{graph_id}/export"]["post"].is_object());
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_change_is_post() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/graphs/{graph_id}/change"]["post"].is_object());
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_mutate_is_post() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/graphs/{graph_id}/mutate"]["post"].is_object());
|
|
}
|
|
|
|
// Deprecation flagging — `/read` and `/change` are kept indefinitely for
|
|
// back-compat but are flagged so OpenAPI codegens (typescript-fetch,
|
|
// openapi-generator, oapi-codegen, etc.) emit @deprecated on the generated
|
|
// SDK methods. The canonical successors `/query` and `/mutate` are not
|
|
// flagged. See `deprecation_headers` in `omnigraph-server/src/lib.rs` for
|
|
// the matching runtime signal (RFC 9745 + RFC 8288 headers).
|
|
#[test]
|
|
fn openapi_read_is_deprecated() {
|
|
let doc = openapi_json();
|
|
assert_eq!(
|
|
doc["paths"]["/graphs/{graph_id}/read"]["post"]["deprecated"],
|
|
serde_json::Value::Bool(true),
|
|
"/read must be flagged deprecated in OpenAPI; use /query instead"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_change_is_deprecated() {
|
|
let doc = openapi_json();
|
|
assert_eq!(
|
|
doc["paths"]["/graphs/{graph_id}/change"]["post"]["deprecated"],
|
|
serde_json::Value::Bool(true),
|
|
"/change must be flagged deprecated in OpenAPI; use /mutate instead"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_query_is_not_deprecated() {
|
|
let doc = openapi_json();
|
|
let deprecated = doc["paths"]["/graphs/{graph_id}/query"]["post"]
|
|
.get("deprecated")
|
|
.and_then(serde_json::Value::as_bool)
|
|
.unwrap_or(false);
|
|
assert!(
|
|
!deprecated,
|
|
"/query is the canonical read endpoint and must not be deprecated"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_mutate_is_not_deprecated() {
|
|
let doc = openapi_json();
|
|
let deprecated = doc["paths"]["/graphs/{graph_id}/mutate"]["post"]
|
|
.get("deprecated")
|
|
.and_then(serde_json::Value::as_bool)
|
|
.unwrap_or(false);
|
|
assert!(
|
|
!deprecated,
|
|
"/mutate is the canonical mutation endpoint and must not be deprecated"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_ingest_is_post() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/graphs/{graph_id}/ingest"]["post"].is_object());
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_load_is_not_deprecated() {
|
|
// RFC-009 Phase 5: /load is the canonical bulk-load endpoint.
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/graphs/{graph_id}/load"]["post"].is_object());
|
|
let deprecated = doc["paths"]["/graphs/{graph_id}/load"]["post"]
|
|
.get("deprecated")
|
|
.and_then(serde_json::Value::as_bool)
|
|
.unwrap_or(false);
|
|
assert!(
|
|
!deprecated,
|
|
"/load is the canonical load endpoint and must not be deprecated"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_ingest_is_deprecated() {
|
|
// RFC-009 Phase 5: /ingest is now the deprecated alias of /load.
|
|
let doc = openapi_json();
|
|
assert_eq!(
|
|
doc["paths"]["/graphs/{graph_id}/ingest"]["post"]["deprecated"],
|
|
serde_json::Value::Bool(true),
|
|
"/ingest must be flagged deprecated now that /load is canonical"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_branches_supports_get_and_post() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/graphs/{graph_id}/branches"]["get"].is_object());
|
|
assert!(doc["paths"]["/graphs/{graph_id}/branches"]["post"].is_object());
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_branch_delete_is_delete() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/graphs/{graph_id}/branches/{branch}"]["delete"].is_object());
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_branch_merge_is_post() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/graphs/{graph_id}/branches/merge"]["post"].is_object());
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_commits_is_get() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/graphs/{graph_id}/commits"]["get"].is_object());
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_commit_show_is_get() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/graphs/{graph_id}/commits/{commit_id}"]["get"].is_object());
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Schema coverage tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
const EXPECTED_SCHEMAS: &[&str] = &[
|
|
"BranchCreateOutput",
|
|
"BranchCreateRequest",
|
|
"BranchDeleteOutput",
|
|
"BranchListOutput",
|
|
"BranchMergeOutcome",
|
|
"BranchMergeOutput",
|
|
"BranchMergeRequest",
|
|
"ChangeOutput",
|
|
"ChangeRequest",
|
|
"QueryRequest",
|
|
"CommitListOutput",
|
|
"CommitOutput",
|
|
"ErrorCode",
|
|
"ErrorOutput",
|
|
"ExportRequest",
|
|
"HealthOutput",
|
|
"IngestOutput",
|
|
"IngestRequest",
|
|
"IngestTableOutput",
|
|
"LoadMode",
|
|
"MergeConflictKindOutput",
|
|
"MergeConflictOutput",
|
|
"ReadOutput",
|
|
"ReadRequest",
|
|
"ReadTargetOutput",
|
|
"ManifestConflictOutput",
|
|
"SchemaApplyOutput",
|
|
"SchemaApplyRequest",
|
|
"SnapshotOutput",
|
|
"SnapshotTableOutput",
|
|
];
|
|
|
|
#[test]
|
|
fn openapi_contains_all_expected_schemas() {
|
|
let doc = openapi_json();
|
|
let schemas = doc["components"]["schemas"]
|
|
.as_object()
|
|
.expect("schemas must be an object");
|
|
let schema_keys: HashSet<&str> = schemas.keys().map(|k| k.as_str()).collect();
|
|
|
|
for expected in EXPECTED_SCHEMAS {
|
|
assert!(
|
|
schema_keys.contains(expected),
|
|
"missing schema: {expected}. Found: {schema_keys:?}"
|
|
);
|
|
}
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Schema field validation tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[test]
|
|
fn health_output_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["HealthOutput"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("status"));
|
|
assert!(props.contains_key("version"));
|
|
assert!(props.contains_key("internal_schema_version"));
|
|
assert!(props.contains_key("source_version"));
|
|
}
|
|
|
|
#[test]
|
|
fn read_request_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["ReadRequest"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("query_source"));
|
|
assert!(props.contains_key("query_name"));
|
|
assert!(props.contains_key("params"));
|
|
assert!(props.contains_key("branch"));
|
|
assert!(props.contains_key("snapshot"));
|
|
}
|
|
|
|
#[test]
|
|
fn read_request_query_source_is_required() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["ReadRequest"];
|
|
let required: Vec<&str> = schema["required"]
|
|
.as_array()
|
|
.unwrap()
|
|
.iter()
|
|
.map(|v| v.as_str().unwrap())
|
|
.collect();
|
|
assert!(required.contains(&"query_source"));
|
|
}
|
|
|
|
#[test]
|
|
fn read_output_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["ReadOutput"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("query_name"));
|
|
assert!(props.contains_key("target"));
|
|
assert!(props.contains_key("row_count"));
|
|
assert!(props.contains_key("rows"));
|
|
}
|
|
|
|
#[test]
|
|
fn change_request_schema_has_expected_fields() {
|
|
// Canonical field names on the wire are now `query` and `name`. The
|
|
// schema descriptions document `query_source` and `query_name` as
|
|
// legacy deserialization aliases for backward compatibility.
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["ChangeRequest"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("query"));
|
|
assert!(props.contains_key("name"));
|
|
assert!(props.contains_key("params"));
|
|
assert!(props.contains_key("branch"));
|
|
let query_desc = schema["properties"]["query"]["description"]
|
|
.as_str()
|
|
.unwrap_or_default();
|
|
assert!(
|
|
query_desc.contains("query_source"),
|
|
"expected `query` description to mention the legacy `query_source` alias, got: {query_desc}"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn query_request_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["QueryRequest"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("query"));
|
|
assert!(props.contains_key("name"));
|
|
assert!(props.contains_key("params"));
|
|
assert!(props.contains_key("branch"));
|
|
assert!(props.contains_key("snapshot"));
|
|
}
|
|
|
|
#[test]
|
|
fn query_request_query_is_required() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["QueryRequest"];
|
|
let required: Vec<&str> = schema["required"]
|
|
.as_array()
|
|
.unwrap()
|
|
.iter()
|
|
.map(|v| v.as_str().unwrap())
|
|
.collect();
|
|
assert!(required.contains(&"query"));
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_query_is_post() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/graphs/{graph_id}/query"]["post"].is_object());
|
|
}
|
|
|
|
#[test]
|
|
fn query_endpoint_documents_mutation_400() {
|
|
let doc = openapi_json();
|
|
let four_hundred = &doc["paths"]["/graphs/{graph_id}/query"]["post"]["responses"]["400"];
|
|
let description = four_hundred["description"].as_str().unwrap_or_default();
|
|
assert!(
|
|
description.contains("mutations") || description.contains("POST /mutate"),
|
|
"expected /query 400 response to mention mutation rejection, got: {description}"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn change_output_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["ChangeOutput"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("branch"));
|
|
assert!(props.contains_key("query_name"));
|
|
assert!(props.contains_key("affected_nodes"));
|
|
assert!(props.contains_key("affected_edges"));
|
|
}
|
|
|
|
#[test]
|
|
fn ingest_request_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["IngestRequest"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("branch"));
|
|
assert!(props.contains_key("from"));
|
|
assert!(props.contains_key("mode"));
|
|
assert!(props.contains_key("data"));
|
|
}
|
|
|
|
#[test]
|
|
fn ingest_output_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["IngestOutput"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("uri"));
|
|
assert!(props.contains_key("branch"));
|
|
assert!(props.contains_key("base_branch"));
|
|
assert!(props.contains_key("branch_created"));
|
|
assert!(props.contains_key("mode"));
|
|
assert!(props.contains_key("tables"));
|
|
}
|
|
|
|
#[test]
|
|
fn export_request_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["ExportRequest"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("branch"));
|
|
assert!(props.contains_key("type_names"));
|
|
assert!(props.contains_key("table_keys"));
|
|
}
|
|
|
|
#[test]
|
|
fn branch_create_request_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["BranchCreateRequest"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("from"));
|
|
assert!(props.contains_key("name"));
|
|
}
|
|
|
|
#[test]
|
|
fn branch_create_request_name_is_required() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["BranchCreateRequest"];
|
|
let required: Vec<&str> = schema["required"]
|
|
.as_array()
|
|
.unwrap()
|
|
.iter()
|
|
.map(|v| v.as_str().unwrap())
|
|
.collect();
|
|
assert!(required.contains(&"name"));
|
|
}
|
|
|
|
#[test]
|
|
fn branch_merge_request_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["BranchMergeRequest"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("source"));
|
|
assert!(props.contains_key("target"));
|
|
}
|
|
|
|
#[test]
|
|
fn error_output_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["ErrorOutput"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("error"));
|
|
assert!(props.contains_key("code"));
|
|
assert!(props.contains_key("merge_conflicts"));
|
|
assert!(props.contains_key("manifest_conflict"));
|
|
}
|
|
|
|
#[test]
|
|
fn manifest_conflict_output_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["ManifestConflictOutput"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("table_key"));
|
|
assert!(props.contains_key("expected"));
|
|
assert!(props.contains_key("actual"));
|
|
}
|
|
|
|
#[test]
|
|
fn commit_output_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["CommitOutput"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("graph_commit_id"));
|
|
assert!(props.contains_key("manifest_version"));
|
|
assert!(props.contains_key("parent_commit_id"));
|
|
assert!(props.contains_key("actor_id"));
|
|
assert!(props.contains_key("created_at"));
|
|
}
|
|
|
|
#[test]
|
|
fn snapshot_output_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["SnapshotOutput"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("branch"));
|
|
assert!(props.contains_key("manifest_version"));
|
|
assert!(props.contains_key("internal_schema_version"));
|
|
assert!(props.contains_key("tables"));
|
|
}
|
|
|
|
#[test]
|
|
fn snapshot_table_output_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["SnapshotTableOutput"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("table_key"));
|
|
assert!(props.contains_key("table_path"));
|
|
assert!(props.contains_key("table_version"));
|
|
assert!(props.contains_key("row_count"));
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Enum schema tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[test]
|
|
fn load_mode_schema_has_three_variants() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["LoadMode"];
|
|
let variants = schema["enum"].as_array().unwrap();
|
|
assert_eq!(variants.len(), 3);
|
|
let values: HashSet<&str> = variants.iter().map(|v| v.as_str().unwrap()).collect();
|
|
assert!(values.contains("overwrite"));
|
|
assert!(values.contains("append"));
|
|
assert!(values.contains("merge"));
|
|
}
|
|
|
|
#[test]
|
|
fn branch_merge_outcome_schema_has_three_variants() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["BranchMergeOutcome"];
|
|
let variants = schema["enum"].as_array().unwrap();
|
|
assert_eq!(variants.len(), 3);
|
|
let values: HashSet<&str> = variants.iter().map(|v| v.as_str().unwrap()).collect();
|
|
assert!(values.contains("already_up_to_date"));
|
|
assert!(values.contains("fast_forward"));
|
|
assert!(values.contains("merged"));
|
|
}
|
|
|
|
#[test]
|
|
fn error_code_schema_has_expected_variants() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["ErrorCode"];
|
|
let variants = schema["enum"].as_array().unwrap();
|
|
let values: HashSet<&str> = variants.iter().map(|v| v.as_str().unwrap()).collect();
|
|
assert!(values.contains("unauthorized"));
|
|
assert!(values.contains("forbidden"));
|
|
assert!(values.contains("bad_request"));
|
|
assert!(values.contains("not_found"));
|
|
assert!(values.contains("conflict"));
|
|
assert!(values.contains("internal"));
|
|
}
|
|
|
|
#[test]
|
|
fn merge_conflict_kind_output_schema_has_expected_variants() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["MergeConflictKindOutput"];
|
|
let variants = schema["enum"].as_array().unwrap();
|
|
let values: HashSet<&str> = variants.iter().map(|v| v.as_str().unwrap()).collect();
|
|
assert!(values.contains("divergent_insert"));
|
|
assert!(values.contains("divergent_update"));
|
|
assert!(values.contains("delete_vs_update"));
|
|
assert!(values.contains("orphan_edge"));
|
|
assert!(values.contains("unique_violation"));
|
|
assert!(values.contains("cardinality_violation"));
|
|
assert!(values.contains("value_constraint_violation"));
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Security scheme tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[test]
|
|
fn openapi_defines_bearer_token_security_scheme() {
|
|
let doc = openapi_json();
|
|
let scheme = &doc["components"]["securitySchemes"]["bearer_token"];
|
|
assert_eq!(scheme["type"].as_str().unwrap(), "http");
|
|
assert_eq!(scheme["scheme"].as_str().unwrap(), "bearer");
|
|
}
|
|
|
|
#[test]
|
|
fn protected_endpoints_reference_bearer_token_security() {
|
|
let doc = openapi_json();
|
|
let protected_paths = [
|
|
("/graphs/{graph_id}/read", "post"),
|
|
("/graphs/{graph_id}/change", "post"),
|
|
("/graphs/{graph_id}/schema/apply", "post"),
|
|
("/graphs/{graph_id}/queries", "get"),
|
|
("/graphs/{graph_id}/queries/{name}", "post"),
|
|
("/graphs/{graph_id}/load", "post"),
|
|
("/graphs/{graph_id}/ingest", "post"),
|
|
("/graphs/{graph_id}/export", "post"),
|
|
("/graphs/{graph_id}/snapshot", "get"),
|
|
("/graphs/{graph_id}/branches", "get"),
|
|
("/graphs/{graph_id}/branches", "post"),
|
|
("/graphs/{graph_id}/branches/{branch}", "delete"),
|
|
("/graphs/{graph_id}/branches/merge", "post"),
|
|
("/graphs/{graph_id}/commits", "get"),
|
|
("/graphs/{graph_id}/commits/{commit_id}", "get"),
|
|
];
|
|
|
|
for (path, method) in protected_paths {
|
|
let operation = &doc["paths"][path][method];
|
|
let security = operation["security"]
|
|
.as_array()
|
|
.unwrap_or_else(|| panic!("no security on {method} {path}"));
|
|
let has_bearer = security
|
|
.iter()
|
|
.any(|s| s.as_object().unwrap().contains_key("bearer_token"));
|
|
assert!(has_bearer, "{method} {path} missing bearer_token security");
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn healthz_does_not_require_security() {
|
|
let doc = openapi_json();
|
|
let healthz = &doc["paths"]["/healthz"]["get"];
|
|
assert!(
|
|
healthz.get("security").is_none() || healthz["security"].is_null(),
|
|
"/healthz should not have security requirements"
|
|
);
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Path parameter tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[test]
|
|
fn branch_delete_has_branch_path_parameter() {
|
|
let doc = openapi_json();
|
|
let params = doc["paths"]["/graphs/{graph_id}/branches/{branch}"]["delete"]["parameters"]
|
|
.as_array()
|
|
.unwrap();
|
|
let has_branch = params
|
|
.iter()
|
|
.any(|p| p["name"].as_str() == Some("branch") && p["in"].as_str() == Some("path"));
|
|
assert!(
|
|
has_branch,
|
|
"DELETE /branches/{{branch}} must have 'branch' path parameter"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn commit_show_has_commit_id_path_parameter() {
|
|
let doc = openapi_json();
|
|
let params = doc["paths"]["/graphs/{graph_id}/commits/{commit_id}"]["get"]["parameters"]
|
|
.as_array()
|
|
.unwrap();
|
|
let has_commit_id = params
|
|
.iter()
|
|
.any(|p| p["name"].as_str() == Some("commit_id") && p["in"].as_str() == Some("path"));
|
|
assert!(
|
|
has_commit_id,
|
|
"GET /commits/{{commit_id}} must have 'commit_id' path parameter"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn snapshot_has_branch_query_parameter() {
|
|
let doc = openapi_json();
|
|
let params = doc["paths"]["/graphs/{graph_id}/snapshot"]["get"]["parameters"]
|
|
.as_array()
|
|
.unwrap();
|
|
let has_branch = params
|
|
.iter()
|
|
.any(|p| p["name"].as_str() == Some("branch") && p["in"].as_str() == Some("query"));
|
|
assert!(
|
|
has_branch,
|
|
"GET /snapshot must have 'branch' query parameter"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn commits_has_branch_query_parameter() {
|
|
let doc = openapi_json();
|
|
let params = doc["paths"]["/graphs/{graph_id}/commits"]["get"]["parameters"]
|
|
.as_array()
|
|
.unwrap();
|
|
let has_branch = params
|
|
.iter()
|
|
.any(|p| p["name"].as_str() == Some("branch") && p["in"].as_str() == Some("query"));
|
|
assert!(
|
|
has_branch,
|
|
"GET /commits must have 'branch' query parameter"
|
|
);
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Tag tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[test]
|
|
fn openapi_operations_have_tags() {
|
|
let doc = openapi_json();
|
|
let paths = doc["paths"].as_object().unwrap();
|
|
|
|
for (path, methods) in paths {
|
|
let methods = methods.as_object().unwrap();
|
|
for (method, operation) in methods {
|
|
let tags = operation["tags"].as_array();
|
|
assert!(
|
|
tags.is_some_and(|t| !t.is_empty()),
|
|
"{method} {path} should have at least one tag"
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Response schema reference tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[test]
|
|
fn read_endpoint_200_references_read_output_schema() {
|
|
let doc = openapi_json();
|
|
let content = &doc["paths"]["/graphs/{graph_id}/read"]["post"]["responses"]["200"]["content"];
|
|
let schema = &content["application/json"]["schema"];
|
|
let ref_path = schema["$ref"].as_str().unwrap();
|
|
assert!(
|
|
ref_path.contains("ReadOutput"),
|
|
"POST /read 200 should reference ReadOutput, got {ref_path}"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn change_endpoint_200_references_change_output_schema() {
|
|
let doc = openapi_json();
|
|
let content = &doc["paths"]["/graphs/{graph_id}/change"]["post"]["responses"]["200"]["content"];
|
|
let schema = &content["application/json"]["schema"];
|
|
let ref_path = schema["$ref"].as_str().unwrap();
|
|
assert!(
|
|
ref_path.contains("ChangeOutput"),
|
|
"POST /change 200 should reference ChangeOutput, got {ref_path}"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn healthz_200_references_health_output_schema() {
|
|
let doc = openapi_json();
|
|
let content = &doc["paths"]["/healthz"]["get"]["responses"]["200"]["content"];
|
|
let schema = &content["application/json"]["schema"];
|
|
let ref_path = schema["$ref"].as_str().unwrap();
|
|
assert!(
|
|
ref_path.contains("HealthOutput"),
|
|
"GET /healthz 200 should reference HealthOutput, got {ref_path}"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn error_responses_reference_error_output_schema() {
|
|
let doc = openapi_json();
|
|
let paths_with_errors = [
|
|
("/graphs/{graph_id}/read", "post", "400"),
|
|
("/graphs/{graph_id}/read", "post", "401"),
|
|
("/graphs/{graph_id}/change", "post", "400"),
|
|
("/graphs/{graph_id}/change", "post", "409"),
|
|
("/graphs/{graph_id}/branches", "post", "409"),
|
|
];
|
|
|
|
for (path, method, status) in paths_with_errors {
|
|
let content = &doc["paths"][path][method]["responses"][status]["content"];
|
|
let schema = &content["application/json"]["schema"];
|
|
let ref_path = schema["$ref"].as_str().unwrap();
|
|
assert!(
|
|
ref_path.contains("ErrorOutput"),
|
|
"{method} {path} {status} should reference ErrorOutput, got {ref_path}"
|
|
);
|
|
}
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Request body reference tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[test]
|
|
fn post_endpoints_have_request_body() {
|
|
let doc = openapi_json();
|
|
let post_paths = [
|
|
("/graphs/{graph_id}/read", "ReadRequest"),
|
|
("/graphs/{graph_id}/change", "ChangeRequest"),
|
|
("/graphs/{graph_id}/schema/apply", "SchemaApplyRequest"),
|
|
("/graphs/{graph_id}/ingest", "IngestRequest"),
|
|
("/graphs/{graph_id}/export", "ExportRequest"),
|
|
("/graphs/{graph_id}/branches", "BranchCreateRequest"),
|
|
("/graphs/{graph_id}/branches/merge", "BranchMergeRequest"),
|
|
];
|
|
|
|
for (path, expected_schema) in post_paths {
|
|
let request_body = &doc["paths"][path]["post"]["requestBody"];
|
|
assert!(
|
|
request_body.is_object(),
|
|
"POST {path} should have a requestBody"
|
|
);
|
|
let schema = &request_body["content"]["application/json"]["schema"];
|
|
let ref_path = schema["$ref"].as_str().unwrap();
|
|
assert!(
|
|
ref_path.contains(expected_schema),
|
|
"POST {path} requestBody should reference {expected_schema}, got {ref_path}"
|
|
);
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn invoke_stored_query_request_body_is_optional() {
|
|
let doc = openapi_json();
|
|
let request_body = &doc["paths"]["/graphs/{graph_id}/queries/{name}"]["post"]["requestBody"];
|
|
assert!(
|
|
request_body.is_object(),
|
|
"POST /queries/{{name}} should document its optional request body"
|
|
);
|
|
assert_eq!(
|
|
request_body["required"].as_bool().unwrap_or(false),
|
|
false,
|
|
"stored-query invocation body should be optional"
|
|
);
|
|
let schema = &request_body["content"]["application/json"]["schema"];
|
|
let ref_path = schema["$ref"]
|
|
.as_str()
|
|
.or_else(|| {
|
|
schema["oneOf"]
|
|
.as_array()
|
|
.and_then(|schemas| schemas.iter().find_map(|schema| schema["$ref"].as_str()))
|
|
})
|
|
.unwrap();
|
|
assert!(
|
|
ref_path.contains("InvokeStoredQueryRequest"),
|
|
"POST /queries/{{name}} requestBody should reference InvokeStoredQueryRequest, got {ref_path}"
|
|
);
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Serialization round-trip test
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[test]
|
|
fn openapi_spec_round_trips_through_json() {
|
|
let doc = openapi_doc();
|
|
let json_string = serde_json::to_string_pretty(&doc).unwrap();
|
|
let parsed: Value = serde_json::from_str(&json_string).unwrap();
|
|
assert!(parsed["openapi"].is_string());
|
|
assert!(parsed["paths"].is_object());
|
|
assert!(parsed["components"]["schemas"].is_object());
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Open-mode vs auth-mode: served spec reflects runtime config
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[tokio::test]
|
|
async fn open_mode_spec_has_no_security_schemes() {
|
|
let (_temp, app) = app_for_loaded_graph().await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let schemes = &json["components"]["securitySchemes"];
|
|
assert!(
|
|
schemes.is_null() || schemes.as_object().is_some_and(|m| m.is_empty()),
|
|
"open-mode spec should have no security schemes"
|
|
);
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn open_mode_spec_has_no_operation_security() {
|
|
let (_temp, app) = app_for_loaded_graph().await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let paths = json["paths"].as_object().unwrap();
|
|
for (path, methods) in paths {
|
|
for (method, operation) in methods.as_object().unwrap() {
|
|
let security = &operation["security"];
|
|
assert!(
|
|
security.is_null(),
|
|
"open-mode: {method} {path} should have no security requirement"
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn auth_mode_spec_includes_bearer_token_security_scheme() {
|
|
let (_temp, app) = app_for_loaded_graph_with_auth("secret").await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let scheme = &json["components"]["securitySchemes"]["bearer_token"];
|
|
assert_eq!(scheme["type"].as_str().unwrap(), "http");
|
|
assert_eq!(scheme["scheme"].as_str().unwrap(), "bearer");
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn auth_mode_spec_has_security_on_protected_operations() {
|
|
let (_temp, app) = app_for_loaded_graph_with_auth("secret").await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
// RFC-011 cluster-only: the served spec always nests protected
|
|
// routes under `/graphs/{graph_id}/...`.
|
|
let protected_paths = [
|
|
("/graphs/{graph_id}/read", "post"),
|
|
("/graphs/{graph_id}/change", "post"),
|
|
("/graphs/{graph_id}/snapshot", "get"),
|
|
("/graphs/{graph_id}/branches", "get"),
|
|
("/graphs/{graph_id}/commits", "get"),
|
|
];
|
|
for (path, method) in protected_paths {
|
|
let security = &json["paths"][path][method]["security"];
|
|
let arr = security
|
|
.as_array()
|
|
.unwrap_or_else(|| panic!("auth-mode: {method} {path} missing security"));
|
|
let has_bearer = arr
|
|
.iter()
|
|
.any(|s| s.as_object().unwrap().contains_key("bearer_token"));
|
|
assert!(
|
|
has_bearer,
|
|
"auth-mode: {method} {path} should require bearer_token"
|
|
);
|
|
}
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn auth_mode_healthz_still_has_no_security() {
|
|
let (_temp, app) = app_for_loaded_graph_with_auth("secret").await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let healthz = &json["paths"]["/healthz"]["get"];
|
|
assert!(
|
|
healthz.get("security").is_none() || healthz["security"].is_null(),
|
|
"auth-mode: /healthz should still have no security"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_spec_is_up_to_date() {
|
|
let spec_path = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("../../openapi.json");
|
|
|
|
let generated = serde_json::to_string_pretty(&openapi_doc()).unwrap() + "\n";
|
|
|
|
if !env::var("OMNIGRAPH_UPDATE_OPENAPI")
|
|
.unwrap_or_default()
|
|
.is_empty()
|
|
{
|
|
fs::write(&spec_path, &generated).unwrap();
|
|
return;
|
|
}
|
|
|
|
let committed = fs::read_to_string(&spec_path).unwrap_or_else(|_| {
|
|
panic!(
|
|
"openapi.json not found at {}. Run: OMNIGRAPH_UPDATE_OPENAPI=1 cargo test -p omnigraph-server --test openapi openapi_spec_is_up_to_date",
|
|
spec_path.display()
|
|
)
|
|
});
|
|
|
|
assert_eq!(
|
|
committed, generated,
|
|
"openapi.json is out of date. Run: OMNIGRAPH_UPDATE_OPENAPI=1 cargo test -p omnigraph-server --test openapi openapi_spec_is_up_to_date"
|
|
);
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// MR-668 — multi-mode OpenAPI cluster filter
|
|
// ---------------------------------------------------------------------------
|
|
//
|
|
// In multi-graph mode, `/openapi.json` reports cluster routes
|
|
// (`/graphs/{graph_id}/...`) instead of the legacy flat routes. The
|
|
// only flat path that survives is `/healthz`. Operation IDs gain a
|
|
// `cluster_` prefix so SDK generators have stable, unique ids.
|
|
//
|
|
// These tests exercise the request-time `server_openapi` handler via
|
|
// `oneshot`, not the static `ApiDoc::openapi()` — the rewrite happens
|
|
// only on the served document.
|
|
|
|
const EXPECTED_CLUSTER_PATHS: &[&str] = &[
|
|
"/graphs/{graph_id}/snapshot",
|
|
"/graphs/{graph_id}/read",
|
|
"/graphs/{graph_id}/export",
|
|
"/graphs/{graph_id}/change",
|
|
"/graphs/{graph_id}/schema",
|
|
"/graphs/{graph_id}/schema/apply",
|
|
"/graphs/{graph_id}/ingest",
|
|
"/graphs/{graph_id}/branches",
|
|
"/graphs/{graph_id}/branches/{branch}",
|
|
"/graphs/{graph_id}/branches/merge",
|
|
"/graphs/{graph_id}/commits",
|
|
"/graphs/{graph_id}/commits/{commit_id}",
|
|
];
|
|
|
|
async fn app_for_multi_mode(graph_ids: &[&str]) -> (Vec<tempfile::TempDir>, Router) {
|
|
use std::sync::Arc;
|
|
|
|
use omnigraph_server::{GraphHandle, GraphId, GraphKey};
|
|
|
|
let mut dirs = Vec::with_capacity(graph_ids.len());
|
|
let mut handles = Vec::with_capacity(graph_ids.len());
|
|
for id in graph_ids {
|
|
let dir = tempfile::tempdir().unwrap();
|
|
let graph_uri = dir.path().join(id).to_str().unwrap().to_string();
|
|
let schema = fs::read_to_string(fixture("test.pg")).unwrap();
|
|
let engine = Omnigraph::init(&graph_uri, &schema).await.unwrap();
|
|
handles.push(Arc::new(GraphHandle {
|
|
key: GraphKey::cluster(GraphId::try_from(*id).unwrap()),
|
|
uri: graph_uri,
|
|
engine: Arc::new(engine),
|
|
policy: None,
|
|
queries: None,
|
|
}));
|
|
dirs.push(dir);
|
|
}
|
|
let workload = omnigraph_server::workload::WorkloadController::from_env();
|
|
let state = AppState::new_multi(handles, Vec::new(), None, workload, None).unwrap();
|
|
let app = build_app(state);
|
|
(dirs, app)
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn multi_mode_openapi_lists_cluster_paths() {
|
|
let (_dirs, app) = app_for_multi_mode(&["alpha"]).await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (status, json) = json_response(&app, request).await;
|
|
assert_eq!(status, StatusCode::OK);
|
|
let paths = json["paths"].as_object().expect("paths must be an object");
|
|
let path_keys: HashSet<&str> = paths.keys().map(|k| k.as_str()).collect();
|
|
for expected in EXPECTED_CLUSTER_PATHS {
|
|
assert!(
|
|
path_keys.contains(expected),
|
|
"missing cluster path in multi-mode spec: {expected}. \
|
|
Found: {path_keys:?}"
|
|
);
|
|
}
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn multi_mode_openapi_drops_flat_protected_paths() {
|
|
let (_dirs, app) = app_for_multi_mode(&["alpha"]).await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let paths = json["paths"].as_object().unwrap();
|
|
// None of the legacy flat protected paths should appear in multi mode.
|
|
let flat_protected = [
|
|
"/snapshot",
|
|
"/read",
|
|
"/export",
|
|
"/change",
|
|
"/schema",
|
|
"/schema/apply",
|
|
"/ingest",
|
|
"/branches",
|
|
"/branches/{branch}",
|
|
"/branches/merge",
|
|
"/commits",
|
|
"/commits/{commit_id}",
|
|
];
|
|
for flat in flat_protected {
|
|
assert!(
|
|
!paths.contains_key(flat),
|
|
"flat path {flat} must not appear in multi-mode spec; \
|
|
cluster routes are the only protected surface"
|
|
);
|
|
}
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn multi_mode_openapi_keeps_management_paths_flat() {
|
|
let (_dirs, app) = app_for_multi_mode(&["alpha"]).await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let paths = json["paths"].as_object().unwrap();
|
|
for flat in ["/healthz", "/graphs"] {
|
|
assert!(
|
|
paths.contains_key(flat),
|
|
"{flat} must remain flat in multi mode"
|
|
);
|
|
let nested = format!("/graphs/{{graph_id}}{flat}");
|
|
assert!(
|
|
!paths.contains_key(&nested),
|
|
"{flat} must NOT be cluster-prefixed to {nested}"
|
|
);
|
|
}
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn multi_mode_openapi_prefixes_operation_ids_with_cluster() {
|
|
let (_dirs, app) = app_for_multi_mode(&["alpha"]).await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
// Every cluster path operation must have a `cluster_` operation_id.
|
|
// Flat-mounted paths (healthz, management /graphs) keep their
|
|
// original operation_ids — they're not per-graph.
|
|
let paths = json["paths"].as_object().unwrap();
|
|
let mut checked = 0;
|
|
for (path, item) in paths {
|
|
if path == "/healthz" || path == "/graphs" {
|
|
continue;
|
|
}
|
|
for method in ["get", "post", "put", "delete", "patch"] {
|
|
if let Some(op) = item.get(method).filter(|v| v.is_object()) {
|
|
if let Some(id) = op["operationId"].as_str() {
|
|
assert!(
|
|
id.starts_with("cluster_"),
|
|
"operation_id at {path}.{method} must start with `cluster_`, got `{id}`"
|
|
);
|
|
checked += 1;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
assert!(
|
|
checked >= EXPECTED_CLUSTER_PATHS.len(),
|
|
"expected at least {} cluster operation_ids; checked {checked}",
|
|
EXPECTED_CLUSTER_PATHS.len()
|
|
);
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn multi_mode_openapi_declares_graph_id_path_parameter() {
|
|
let (_dirs, app) = app_for_multi_mode(&["alpha"]).await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let paths = json["paths"].as_object().unwrap();
|
|
|
|
for expected_path in EXPECTED_CLUSTER_PATHS {
|
|
let item = paths
|
|
.get(*expected_path)
|
|
.unwrap_or_else(|| panic!("missing cluster path {expected_path}"));
|
|
for method in ["get", "post", "put", "delete", "patch"] {
|
|
let Some(operation) = item.get(method).filter(|value| value.is_object()) else {
|
|
continue;
|
|
};
|
|
let parameters = operation["parameters"]
|
|
.as_array()
|
|
.unwrap_or_else(|| panic!("{expected_path}.{method} missing parameters"));
|
|
let graph_id = parameters
|
|
.iter()
|
|
.find(|param| param["name"] == "graph_id" && param["in"] == "path")
|
|
.unwrap_or_else(|| {
|
|
panic!("{expected_path}.{method} missing graph_id path parameter")
|
|
});
|
|
assert_eq!(
|
|
graph_id["required"].as_bool(),
|
|
Some(true),
|
|
"{expected_path}.{method} graph_id parameter must be required"
|
|
);
|
|
assert_eq!(
|
|
graph_id["schema"]["type"].as_str(),
|
|
Some("string"),
|
|
"{expected_path}.{method} graph_id parameter must be string typed"
|
|
);
|
|
}
|
|
}
|
|
|
|
for flat in ["/healthz", "/graphs"] {
|
|
let item = paths.get(flat).unwrap();
|
|
for method in ["get", "post", "put", "delete", "patch"] {
|
|
if let Some(operation) = item.get(method).filter(|value| value.is_object()) {
|
|
let has_graph_id = operation["parameters"]
|
|
.as_array()
|
|
.map(|params| {
|
|
params
|
|
.iter()
|
|
.any(|param| param["name"] == "graph_id" && param["in"] == "path")
|
|
})
|
|
.unwrap_or(false);
|
|
assert!(
|
|
!has_graph_id,
|
|
"{flat}.{method} must not declare graph_id; it remains flat"
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn multi_mode_operation_ids_are_unique() {
|
|
// Sanity check: the cluster_ prefix prevents collision with flat ids
|
|
// (which don't appear in multi mode, but the contract is "unique
|
|
// across the spec"). Verify every operation_id in the multi-mode
|
|
// spec is unique.
|
|
let (_dirs, app) = app_for_multi_mode(&["alpha"]).await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let paths = json["paths"].as_object().unwrap();
|
|
let mut seen_ids: HashSet<String> = HashSet::new();
|
|
for (_, item) in paths {
|
|
for method in ["get", "post", "put", "delete", "patch"] {
|
|
if let Some(op) = item.get(method).filter(|v| v.is_object()) {
|
|
if let Some(id) = op["operationId"].as_str() {
|
|
assert!(
|
|
seen_ids.insert(id.to_string()),
|
|
"duplicate operation_id `{id}` in multi-mode spec"
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn served_spec_always_nests_under_cluster_prefix() {
|
|
// RFC-011 cluster-only: even a one-graph convenience app serves the
|
|
// nested cluster surface and never the flat protected routes.
|
|
let (_temp, app) = app_for_loaded_graph().await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let paths = json["paths"].as_object().unwrap();
|
|
let path_keys: HashSet<&str> = paths.keys().map(|k| k.as_str()).collect();
|
|
for cluster in EXPECTED_CLUSTER_PATHS {
|
|
assert!(
|
|
path_keys.contains(cluster),
|
|
"served spec must emit cluster path: {cluster}. Found: {path_keys:?}"
|
|
);
|
|
}
|
|
// The flat protected routes must NOT appear — only the nested
|
|
// cluster surface plus the always-flat `/healthz` and `/graphs`.
|
|
let flat_protected = [
|
|
"/snapshot",
|
|
"/read",
|
|
"/query",
|
|
"/export",
|
|
"/change",
|
|
"/mutate",
|
|
"/queries",
|
|
"/queries/{name}",
|
|
"/schema",
|
|
"/schema/apply",
|
|
"/load",
|
|
"/ingest",
|
|
"/branches",
|
|
"/branches/{branch}",
|
|
"/branches/merge",
|
|
"/commits",
|
|
"/commits/{commit_id}",
|
|
];
|
|
for flat in flat_protected {
|
|
assert!(
|
|
!path_keys.contains(flat),
|
|
"served spec must NOT emit flat protected path: {flat}"
|
|
);
|
|
}
|
|
}
|