relay-knowledge 1.1.10

Graph-database-based knowledge graph project.
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
use axum::{
    Router,
    body::{Body, to_bytes},
    http::{Request, StatusCode, header},
};
use serde_json::{Value, json};
use std::{
    fs,
    path::{Path, PathBuf},
    process::Command,
    time::{SystemTime, UNIX_EPOCH},
};
use tower::ServiceExt;

use super::router;
use crate::{
    api::{CodeRepositoryRegisterRequest, InterfaceKind, RequestContext},
    application::RelayKnowledgeService,
    domain::{
        CodeFeatureFlagRequest, CodeIndexMode, CodeIndexRequest, CodeQueryKind,
        CodeRepositorySelector, CodeRetrievalRequest, FreshnessPolicy, SoftwareGlobalKind,
        SoftwareGlobalRequest,
    },
    env::{EnvironmentConfig, PlatformKind},
};

#[tokio::test]
async fn serves_versioned_code_repository_index_status_and_query_apis() {
    let repo = FixtureRepo::create("web-code-api");
    repo.write(
        "src/lib.rs",
        "pub fn retry_policy() -> &'static str { \"bounded\" }\n",
    );
    repo.git(["add", "."]);
    repo.git(["commit", "-m", "initial"]);
    let service = test_service("web-code-api").await;
    service
        .register_code_repository(
            CodeRepositoryRegisterRequest {
                root_path: repo.path.to_string_lossy().into_owned(),
                alias: "fixture".to_owned(),
                path_filters: Vec::new(),
                language_filters: Vec::new(),
            },
            RequestContext::for_interface(InterfaceKind::Api),
        )
        .await
        .expect("repository should register");
    let router = router(service.clone(), crate::net::http::DEFAULT_MAX_BODY_BYTES);
    let selector = CodeRepositorySelector::new("fixture", "HEAD", Vec::new(), Vec::new())
        .expect("selector should validate");
    let index_request = CodeIndexRequest {
        repository: selector.clone(),
        mode: CodeIndexMode::Full,
        workspace_detection: Default::default(),
        freshness_policy: FreshnessPolicy::AllowStale,
    };

    let preview = request_json(
        router.clone(),
        "POST",
        "/api/v1/code/repositories/fixture/scope/preview",
        Some(json!(index_request)),
        StatusCode::OK,
    )
    .await;
    assert_eq!(preview["preview"]["selected_file_count"], 1);

    let incremental = CodeIndexRequest {
        repository: selector.clone(),
        mode: CodeIndexMode::incremental("HEAD~1", "HEAD").expect("refs should validate"),
        workspace_detection: Default::default(),
        freshness_policy: FreshnessPolicy::AllowStale,
    };
    let rejected_incremental = request_json(
        router.clone(),
        "POST",
        "/api/v1/code/repositories/fixture/index",
        Some(json!(incremental)),
        StatusCode::BAD_REQUEST,
    )
    .await;
    assert_eq!(rejected_incremental["error_kind"], "invalid_argument");
    assert!(
        rejected_incremental["message"]
            .as_str()
            .expect("message should render")
            .contains("full index mode")
    );

    let index = request_json(
        router.clone(),
        "POST",
        "/api/v1/code/repositories/fixture/index",
        Some(json!(index_request)),
        StatusCode::OK,
    )
    .await;
    if let Some(task_id) = index["task"]["task_id"].as_str() {
        service
            .run_code_index_task_once(
                Some(task_id.to_owned()),
                RequestContext::for_interface(InterfaceKind::Api),
            )
            .await
            .expect("index worker should run");
    }

    let status = request_json(
        router.clone(),
        "GET",
        "/api/v1/code/repositories/fixture/status?ref=HEAD",
        None,
        StatusCode::OK,
    )
    .await;
    assert_eq!(status["status"]["alias"], "fixture");
    assert_eq!(status["status"]["indexed_file_count"], 1);

    let blank_query = request_json(
        router.clone(),
        "POST",
        "/api/v1/code/repositories/fixture/query",
        Some(json!({
            "query": " ",
            "repository": selector.clone(),
            "code_query_kind": "definition",
            "limit": 5,
            "freshness_policy": "allow_stale"
        })),
        StatusCode::BAD_REQUEST,
    )
    .await;
    assert_eq!(blank_query["error_kind"], "invalid_argument");
    assert!(
        blank_query["message"]
            .as_str()
            .expect("message should render")
            .contains("query: must not be empty")
    );

    let zero_limit = request_json(
        router.clone(),
        "POST",
        "/api/v1/code/repositories/fixture/query",
        Some(json!({
            "query": "retry_policy",
            "repository": selector.clone(),
            "code_query_kind": "definition",
            "limit": 0,
            "freshness_policy": "allow_stale"
        })),
        StatusCode::BAD_REQUEST,
    )
    .await;
    assert_eq!(zero_limit["error_kind"], "invalid_argument");
    assert!(
        zero_limit["message"]
            .as_str()
            .expect("message should render")
            .contains("limit: must be greater than zero")
    );

    let query_request = CodeRetrievalRequest::new(
        "retry_policy",
        selector.clone(),
        CodeQueryKind::Definition,
        5,
        FreshnessPolicy::WaitUntilFresh,
    )
    .expect("query should validate");
    let query = request_json(
        router.clone(),
        "POST",
        "/api/v1/code/repositories/fixture/query",
        Some(json!(query_request)),
        StatusCode::OK,
    )
    .await;
    assert_eq!(query["results"][0]["path"], "src/lib.rs");

    let blank_feature_flags = request_json(
        router.clone(),
        "POST",
        "/api/v1/code/repositories/fixture/feature-flags",
        Some(json!({
            "query": " ",
            "repository": selector.clone(),
            "limit": 10,
            "freshness_policy": "allow_stale"
        })),
        StatusCode::BAD_REQUEST,
    )
    .await;
    assert_eq!(blank_feature_flags["error_kind"], "invalid_argument");
    assert!(
        blank_feature_flags["message"]
            .as_str()
            .expect("message should render")
            .contains("query: must not be empty")
    );

    let feature_flags_request =
        CodeFeatureFlagRequest::new(None, selector.clone(), 10, FreshnessPolicy::AllowStale)
            .expect("feature flags request should validate");
    let feature_flags = request_json(
        router.clone(),
        "POST",
        "/api/v1/code/repositories/fixture/feature-flags",
        Some(json!(feature_flags_request)),
        StatusCode::OK,
    )
    .await;
    assert_eq!(
        feature_flags["flags"]
            .as_array()
            .expect("flags array")
            .len(),
        0
    );
    assert_eq!(feature_flags["freshness"]["state"], "fresh");

    let zero_impact_limit = request_json(
        router.clone(),
        "POST",
        "/api/v1/code/repositories/fixture/impact",
        Some(json!({
            "repository": selector.clone(),
            "base_ref": "HEAD~1",
            "head_ref": "HEAD",
            "limit": 0
        })),
        StatusCode::BAD_REQUEST,
    )
    .await;
    assert_eq!(zero_impact_limit["error_kind"], "invalid_argument");
    assert!(
        zero_impact_limit["message"]
            .as_str()
            .expect("message should render")
            .contains("limit: must be greater than zero")
    );

    let report = request_json(
        router.clone(),
        "GET",
        "/api/v1/code/repositories/fixture/report",
        None,
        StatusCode::OK,
    )
    .await;
    assert_eq!(report["report"]["alias"], "fixture");

    let zero_software_limit = request_json(
        router.clone(),
        "POST",
        "/api/v1/code/repositories/fixture/software",
        Some(json!({
            "repository": selector.clone(),
            "kind": "relationships",
            "freshness_policy": "allow_stale",
            "limit": 0
        })),
        StatusCode::BAD_REQUEST,
    )
    .await;
    assert_eq!(zero_software_limit["error_kind"], "invalid_argument");
    assert!(
        zero_software_limit["message"]
            .as_str()
            .expect("message should render")
            .contains("limit: must be greater than zero")
    );

    let software_request = SoftwareGlobalRequest::new(
        selector.clone(),
        SoftwareGlobalKind::Relationships,
        FreshnessPolicy::GraphOnly,
        10,
    )
    .expect("software request should validate");
    let software = request_json(
        router.clone(),
        "POST",
        "/api/v1/code/repositories/fixture/software",
        Some(json!(software_request)),
        StatusCode::OK,
    )
    .await;
    assert_eq!(software["request"]["kind"], "relationships");

    let mismatch = request_json(
        router,
        "POST",
        "/api/v1/code/repositories/other/query",
        Some(json!(query_request)),
        StatusCode::BAD_REQUEST,
    )
    .await;
    assert_eq!(mismatch["error_kind"], "invalid_argument");
}

async fn test_service(label: &str) -> RelayKnowledgeService {
    let home = unique_temp_dir(label);
    let environment = EnvironmentConfig::from_pairs(
        PlatformKind::Unix,
        [
            ("HOME", "/tmp"),
            (
                "RELAY_KNOWLEDGE_HOME",
                home.as_path().to_str().expect("utf8 path"),
            ),
        ],
    )
    .expect("environment should parse");

    RelayKnowledgeService::from_environment(&environment)
        .await
        .expect("service should initialize")
}

async fn request_json(
    router: Router,
    method: &str,
    uri: &str,
    body: Option<Value>,
    expected_status: StatusCode,
) -> Value {
    let mut builder = Request::builder().method(method).uri(uri);
    let body = match body {
        Some(value) => {
            builder = builder.header(header::CONTENT_TYPE, "application/json");
            Body::from(value.to_string())
        }
        None => Body::empty(),
    };
    let response = router
        .oneshot(builder.body(body).expect("request should build"))
        .await
        .expect("router should respond");
    assert_eq!(response.status(), expected_status);

    serde_json::from_str(&response_text(response).await).expect("response should be json")
}

async fn response_text(response: axum::response::Response) -> String {
    let bytes = to_bytes(response.into_body(), usize::MAX)
        .await
        .expect("body should be readable");

    String::from_utf8(bytes.to_vec()).expect("body should be utf8")
}

struct FixtureRepo {
    path: PathBuf,
}

impl FixtureRepo {
    fn create(name: &str) -> Self {
        let nanos = SystemTime::now()
            .duration_since(UNIX_EPOCH)
            .expect("clock should be after epoch")
            .as_nanos();
        let path = std::env::temp_dir().join(format!("relay-knowledge-{name}-{nanos}"));
        fs::create_dir_all(&path).expect("repo directory should be created");
        let repo = Self { path };
        repo.git(["init"]);
        repo.git(["config", "user.email", "relay@example.invalid"]);
        repo.git(["config", "user.name", "Relay Test"]);
        repo
    }

    fn write(&self, relative: &str, content: &str) {
        let path = self.path.join(relative);
        if let Some(parent) = path.parent() {
            fs::create_dir_all(parent).expect("parent directory should exist");
        }
        fs::write(path, content).expect("fixture file should be written");
    }

    fn git<const N: usize>(&self, args: [&str; N]) {
        let output = git_command(&self.path, args)
            .output()
            .expect("git should run");
        assert!(
            output.status.success(),
            "git failed: {}",
            String::from_utf8_lossy(&output.stderr)
        );
    }
}

impl Drop for FixtureRepo {
    fn drop(&mut self) {
        let _ = fs::remove_dir_all(&self.path);
    }
}

fn git_command<const N: usize>(path: &Path, args: [&str; N]) -> Command {
    let mut command = Command::new("git");
    command.current_dir(path).args(args);
    command
}

fn unique_temp_dir(label: &str) -> PathBuf {
    let now = SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .expect("clock should be after epoch")
        .as_nanos();

    std::env::temp_dir().join(format!("relay-knowledge-web-{label}-{now}"))
}