neumann_server 0.4.0

gRPC server exposing Neumann database via QueryRouter
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
// SPDX-License-Identifier: MIT OR Apache-2.0
//! Health check service implementation.

use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;

use tonic::{Request, Response, Status};

use crate::proto::{health_server::Health, HealthCheckRequest, HealthCheckResponse, ServingStatus};

/// Service health state shared across threads.
#[derive(Debug)]
pub struct HealthState {
    query_service_healthy: AtomicBool,
    blob_service_healthy: AtomicBool,
    vector_service_healthy: AtomicBool,
    is_draining: AtomicBool,
}

impl Default for HealthState {
    fn default() -> Self {
        Self {
            query_service_healthy: AtomicBool::new(true),
            blob_service_healthy: AtomicBool::new(true),
            vector_service_healthy: AtomicBool::new(true),
            is_draining: AtomicBool::new(false),
        }
    }
}

impl HealthState {
    /// Create a new health state with all services healthy.
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    /// Set the query service health status.
    pub fn set_query_service_healthy(&self, healthy: bool) {
        self.query_service_healthy.store(healthy, Ordering::SeqCst);
    }

    /// Set the blob service health status.
    pub fn set_blob_service_healthy(&self, healthy: bool) {
        self.blob_service_healthy.store(healthy, Ordering::SeqCst);
    }

    /// Check if the query service is healthy.
    #[must_use]
    pub fn is_query_service_healthy(&self) -> bool {
        self.query_service_healthy.load(Ordering::SeqCst)
    }

    /// Check if the blob service is healthy.
    #[must_use]
    pub fn is_blob_service_healthy(&self) -> bool {
        self.blob_service_healthy.load(Ordering::SeqCst)
    }

    /// Set the vector service health status.
    pub fn set_vector_service_healthy(&self, healthy: bool) {
        self.vector_service_healthy.store(healthy, Ordering::SeqCst);
    }

    /// Check if the vector service is healthy.
    #[must_use]
    pub fn is_vector_service_healthy(&self) -> bool {
        self.vector_service_healthy.load(Ordering::SeqCst)
    }

    /// Check if all services are healthy.
    #[must_use]
    pub fn is_all_healthy(&self) -> bool {
        self.is_query_service_healthy()
            && self.is_blob_service_healthy()
            && self.is_vector_service_healthy()
            && !self.is_draining()
    }

    /// Set the draining state for graceful shutdown.
    pub fn set_draining(&self, draining: bool) {
        self.is_draining.store(draining, Ordering::SeqCst);
    }

    /// Check if the server is draining (shutting down gracefully).
    #[must_use]
    pub fn is_draining(&self) -> bool {
        self.is_draining.load(Ordering::SeqCst)
    }
}

/// Implementation of the Health gRPC service.
#[derive(Debug, Clone)]
pub struct HealthServiceImpl {
    state: Arc<HealthState>,
}

impl Default for HealthServiceImpl {
    fn default() -> Self {
        Self::new()
    }
}

impl HealthServiceImpl {
    /// Create a new health service.
    #[must_use]
    pub fn new() -> Self {
        Self {
            state: Arc::new(HealthState::new()),
        }
    }

    /// Create a new health service with shared state.
    #[must_use]
    pub const fn with_state(state: Arc<HealthState>) -> Self {
        Self { state }
    }

    /// Get a reference to the health state.
    #[must_use]
    pub const fn state(&self) -> &Arc<HealthState> {
        &self.state
    }
}

#[tonic::async_trait]
impl Health for HealthServiceImpl {
    async fn check(
        &self,
        request: Request<HealthCheckRequest>,
    ) -> Result<Response<HealthCheckResponse>, Status> {
        let service = request.into_inner().service;

        // If draining, report not serving for all services
        if self.state.is_draining() {
            return Ok(Response::new(HealthCheckResponse {
                status: ServingStatus::NotServing.into(),
            }));
        }

        let status = match service.as_deref() {
            Some("neumann.v1.QueryService") => {
                if self.state.is_query_service_healthy() {
                    ServingStatus::Serving
                } else {
                    ServingStatus::NotServing
                }
            },
            Some("neumann.v1.BlobService") => {
                if self.state.is_blob_service_healthy() {
                    ServingStatus::Serving
                } else {
                    ServingStatus::NotServing
                }
            },
            Some("neumann.vector.v1.PointsService" | "neumann.vector.v1.CollectionsService") => {
                if self.state.is_vector_service_healthy() {
                    ServingStatus::Serving
                } else {
                    ServingStatus::NotServing
                }
            },
            Some("") | None => {
                // Check overall health
                if self.state.is_all_healthy() {
                    ServingStatus::Serving
                } else {
                    ServingStatus::NotServing
                }
            },
            Some(unknown) => {
                tracing::warn!("Health check for unknown service: {}", unknown);
                ServingStatus::Unspecified
            },
        };

        Ok(Response::new(HealthCheckResponse {
            status: status.into(),
        }))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[tokio::test]
    async fn test_health_check_no_service() {
        let service = HealthServiceImpl::new();
        let request = Request::new(HealthCheckRequest { service: None });

        let response = service.check(request).await.unwrap();
        assert_eq!(
            response.into_inner().status,
            i32::from(ServingStatus::Serving)
        );
    }

    #[tokio::test]
    async fn test_health_check_empty_service() {
        let service = HealthServiceImpl::new();
        let request = Request::new(HealthCheckRequest {
            service: Some(String::new()),
        });

        let response = service.check(request).await.unwrap();
        assert_eq!(
            response.into_inner().status,
            i32::from(ServingStatus::Serving)
        );
    }

    #[tokio::test]
    async fn test_health_check_query_service() {
        let service = HealthServiceImpl::new();
        let request = Request::new(HealthCheckRequest {
            service: Some("neumann.v1.QueryService".to_string()),
        });

        let response = service.check(request).await.unwrap();
        assert_eq!(
            response.into_inner().status,
            i32::from(ServingStatus::Serving)
        );
    }

    #[tokio::test]
    async fn test_health_check_blob_service() {
        let service = HealthServiceImpl::new();
        let request = Request::new(HealthCheckRequest {
            service: Some("neumann.v1.BlobService".to_string()),
        });

        let response = service.check(request).await.unwrap();
        assert_eq!(
            response.into_inner().status,
            i32::from(ServingStatus::Serving)
        );
    }

    #[tokio::test]
    async fn test_health_check_unknown_service() {
        let service = HealthServiceImpl::new();
        let request = Request::new(HealthCheckRequest {
            service: Some("unknown.Service".to_string()),
        });

        let response = service.check(request).await.unwrap();
        assert_eq!(
            response.into_inner().status,
            i32::from(ServingStatus::Unspecified)
        );
    }

    #[tokio::test]
    async fn test_health_state_set_unhealthy() {
        let state = Arc::new(HealthState::new());
        let service = HealthServiceImpl::with_state(Arc::clone(&state));

        // Initially healthy
        assert!(state.is_query_service_healthy());
        assert!(state.is_blob_service_healthy());

        // Set query service unhealthy
        state.set_query_service_healthy(false);

        let request = Request::new(HealthCheckRequest {
            service: Some("neumann.v1.QueryService".to_string()),
        });
        let response = service
            .check(request)
            .await
            .expect("should return response");
        assert_eq!(
            response.into_inner().status,
            i32::from(ServingStatus::NotServing)
        );

        // Overall health should be not serving
        let request = Request::new(HealthCheckRequest { service: None });
        let response = service
            .check(request)
            .await
            .expect("should return response");
        assert_eq!(
            response.into_inner().status,
            i32::from(ServingStatus::NotServing)
        );

        // Blob service should still be serving
        let request = Request::new(HealthCheckRequest {
            service: Some("neumann.v1.BlobService".to_string()),
        });
        let response = service
            .check(request)
            .await
            .expect("should return response");
        assert_eq!(
            response.into_inner().status,
            i32::from(ServingStatus::Serving)
        );
    }

    #[test]
    fn test_health_state_operations() {
        let state = HealthState::new();

        assert!(state.is_query_service_healthy());
        assert!(state.is_blob_service_healthy());
        assert!(state.is_vector_service_healthy());
        assert!(state.is_all_healthy());

        state.set_query_service_healthy(false);
        assert!(!state.is_query_service_healthy());
        assert!(state.is_blob_service_healthy());
        assert!(state.is_vector_service_healthy());
        assert!(!state.is_all_healthy());

        state.set_query_service_healthy(true);
        state.set_blob_service_healthy(false);
        assert!(state.is_query_service_healthy());
        assert!(!state.is_blob_service_healthy());
        assert!(state.is_vector_service_healthy());
        assert!(!state.is_all_healthy());

        state.set_blob_service_healthy(true);
        state.set_vector_service_healthy(false);
        assert!(state.is_query_service_healthy());
        assert!(state.is_blob_service_healthy());
        assert!(!state.is_vector_service_healthy());
        assert!(!state.is_all_healthy());

        state.set_vector_service_healthy(true);
        assert!(state.is_all_healthy());
    }

    #[test]
    fn test_health_state_draining() {
        let state = HealthState::new();

        assert!(!state.is_draining());
        assert!(state.is_all_healthy());

        state.set_draining(true);
        assert!(state.is_draining());
        // When draining, all_healthy should return false
        assert!(!state.is_all_healthy());

        state.set_draining(false);
        assert!(!state.is_draining());
        assert!(state.is_all_healthy());
    }

    #[tokio::test]
    async fn test_health_check_vector_service() {
        let service = HealthServiceImpl::new();
        let request = Request::new(HealthCheckRequest {
            service: Some("neumann.vector.v1.PointsService".to_string()),
        });

        let response = service.check(request).await.unwrap();
        assert_eq!(
            response.into_inner().status,
            i32::from(ServingStatus::Serving)
        );

        let request = Request::new(HealthCheckRequest {
            service: Some("neumann.vector.v1.CollectionsService".to_string()),
        });

        let response = service.check(request).await.unwrap();
        assert_eq!(
            response.into_inner().status,
            i32::from(ServingStatus::Serving)
        );
    }

    #[tokio::test]
    async fn test_health_check_vector_service_unhealthy() {
        let state = Arc::new(HealthState::new());
        let service = HealthServiceImpl::with_state(Arc::clone(&state));

        state.set_vector_service_healthy(false);

        let request = Request::new(HealthCheckRequest {
            service: Some("neumann.vector.v1.PointsService".to_string()),
        });
        let response = service.check(request).await.unwrap();
        assert_eq!(
            response.into_inner().status,
            i32::from(ServingStatus::NotServing)
        );

        // Overall health should also be not serving
        let request = Request::new(HealthCheckRequest { service: None });
        let response = service.check(request).await.unwrap();
        assert_eq!(
            response.into_inner().status,
            i32::from(ServingStatus::NotServing)
        );
    }

    #[tokio::test]
    async fn test_health_check_when_draining() {
        let state = Arc::new(HealthState::new());
        let service = HealthServiceImpl::with_state(Arc::clone(&state));

        // Initially serving
        let request = Request::new(HealthCheckRequest { service: None });
        let response = service.check(request).await.unwrap();
        assert_eq!(
            response.into_inner().status,
            i32::from(ServingStatus::Serving)
        );

        // Set draining
        state.set_draining(true);

        // Should report not serving for overall health
        let request = Request::new(HealthCheckRequest { service: None });
        let response = service.check(request).await.unwrap();
        assert_eq!(
            response.into_inner().status,
            i32::from(ServingStatus::NotServing)
        );

        // Should report not serving for query service too
        let request = Request::new(HealthCheckRequest {
            service: Some("neumann.v1.QueryService".to_string()),
        });
        let response = service.check(request).await.unwrap();
        assert_eq!(
            response.into_inner().status,
            i32::from(ServingStatus::NotServing)
        );
    }

    #[test]
    fn test_health_service_default() {
        let service = HealthServiceImpl::default();
        let state = service.state();
        assert!(state.is_all_healthy());
    }

    #[test]
    fn test_health_service_state_accessor() {
        let state = Arc::new(HealthState::new());
        let service = HealthServiceImpl::with_state(Arc::clone(&state));
        assert!(Arc::ptr_eq(service.state(), &state));
    }
}