rskit-discovery 0.2.0-alpha.2

Service discovery with load balancing strategies
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
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
//! Discovery-integrated server component.
//!
//! Wraps any server implementing the [`rskit_bootstrap::Component`] trait to automatically register with service discovery on start
//! and deregister on stop.

use std::sync::Arc;

use async_trait::async_trait;
use rskit_bootstrap::{Component, Health};
use rskit_errors::{AppError, AppResult, ErrorCode};

use crate::{instance::ServiceInstance, traits::Registry};

/// Wraps a server component with service discovery auto-registration.
///
/// On `start()`, the inner server starts first, then the instance is registered. On `stop()`,
/// the instance is deregistered first, then the inner server stops.
pub struct DiscoveryServer<S: Component + ?Sized> {
    inner: Arc<S>,
    registry: Arc<dyn Registry>,
    instance: ServiceInstance,
    name: String,
}

impl<S: Component + ?Sized> DiscoveryServer<S> {
    /// Create a new discovery-integrated server.
    ///
    /// # Arguments
    ///
    /// * `name` - Component identifier (e.g., "discovery-grpc-server")
    /// * `inner` - The server component to wrap
    /// * `registry` - The service registry for registration/deregistration
    /// * `instance` - The service instance configuration
    pub fn new(
        name: String,
        inner: Arc<S>,
        registry: Arc<dyn Registry>,
        instance: ServiceInstance,
    ) -> Self {
        Self {
            inner,
            registry,
            instance,
            name,
        }
    }

    /// Returns a reference to the wrapped server component.
    pub fn inner(&self) -> &S {
        &self.inner
    }

    /// Returns the service instance being registered.
    pub fn instance(&self) -> &ServiceInstance {
        &self.instance
    }
}

#[async_trait]
impl<S: Component + ?Sized + 'static> Component for DiscoveryServer<S> {
    fn name(&self) -> &str {
        &self.name
    }

    async fn start(&self) -> AppResult<()> {
        // Start the inner server first
        tracing::debug!(
            component = %self.name,
            "Starting inner server component"
        );
        self.inner.start().await.map_err(|e| {
            AppError::new(
                ErrorCode::Internal,
                format!("failed to start inner server: {}", e),
            )
        })?;

        // Then register with discovery
        tracing::debug!(
            component = %self.name,
            service_id = %self.instance.id,
            service_name = %self.instance.name,
            address = %self.instance.address,
            port = %self.instance.port,
            "Registering with service discovery"
        );

        if let Err(err) = self.registry.register(&self.instance).await {
            // Log and attempt to stop the server if registration fails
            tracing::error!(
                component = %self.name,
                error = %err,
                "Registration failed, stopping inner server"
            );
            let inner_clone = self.inner.clone();
            tokio::spawn(async move {
                if let Err(e) = inner_clone.stop().await {
                    tracing::warn!(
                        "Failed to stop inner server after registration failure: {}",
                        e
                    );
                }
            });
            return Err(AppError::new(
                ErrorCode::Internal,
                format!("failed to register with discovery: {}", err),
            ));
        }

        tracing::debug!(
            component = %self.name,
            service_id = %self.instance.id,
            "Service registered successfully"
        );
        Ok(())
    }

    async fn stop(&self) -> AppResult<()> {
        tracing::debug!(
            component = %self.name,
            service_id = %self.instance.id,
            "Stopping discovery-server component"
        );

        // Deregister from discovery first
        if let Err(e) = self.registry.deregister(&self.instance.id).await {
            tracing::warn!(
                component = %self.name,
                service_id = %self.instance.id,
                error = %e,
                "Failed to deregister from discovery"
            );
            // Continue to stop the server even if deregistration fails
        }

        // Then stop the inner server
        self.inner.stop().await.map_err(|e| {
            AppError::new(
                ErrorCode::Internal,
                format!("failed to stop inner server: {}", e),
            )
        })?;

        tracing::debug!(
            component = %self.name,
            "Discovery-server component stopped"
        );
        Ok(())
    }

    fn health(&self) -> Health {
        // Report the inner component's health, tagged with the registration status.
        let inner_health = self.inner.health();
        if inner_health.is_healthy() {
            Health::healthy(format!("{} (registered)", self.name))
        } else {
            Health::unhealthy(
                format!("{} (inner unhealthy)", self.name),
                "inner component is unhealthy",
            )
        }
    }
}

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

    use rskit_errors::AppResult;

    /// Mock server for testing
    struct MockServer {
        started: parking_lot::Mutex<bool>,
        stopped: parking_lot::Mutex<bool>,
    }

    impl MockServer {
        fn new() -> Self {
            Self {
                started: parking_lot::Mutex::new(false),
                stopped: parking_lot::Mutex::new(false),
            }
        }
    }

    #[async_trait]
    impl Component for MockServer {
        fn name(&self) -> &str {
            "mock-server"
        }

        async fn start(&self) -> AppResult<()> {
            *self.started.lock() = true;
            Ok(())
        }

        async fn stop(&self) -> AppResult<()> {
            *self.stopped.lock() = true;
            Ok(())
        }

        fn health(&self) -> Health {
            Health::healthy("mock-server")
        }
    }

    struct ErrorServer {
        fail_start: bool,
        fail_stop: bool,
        healthy: bool,
    }

    #[async_trait]
    impl Component for ErrorServer {
        fn name(&self) -> &str {
            "error-server"
        }

        async fn start(&self) -> AppResult<()> {
            if self.fail_start {
                Err(AppError::new(ErrorCode::Internal, "start failed"))
            } else {
                Ok(())
            }
        }

        async fn stop(&self) -> AppResult<()> {
            if self.fail_stop {
                Err(AppError::new(ErrorCode::Internal, "stop failed"))
            } else {
                Ok(())
            }
        }

        fn health(&self) -> Health {
            if self.healthy {
                Health::healthy("error-server")
            } else {
                Health::unhealthy("error-server", "down")
            }
        }
    }

    /// Mock registry for testing
    struct MockRegistry {
        registered: parking_lot::Mutex<Vec<ServiceInstance>>,
        deregistered: parking_lot::Mutex<Vec<String>>,
        register_error: parking_lot::Mutex<Option<String>>,
        deregister_error: parking_lot::Mutex<Option<String>>,
    }

    impl MockRegistry {
        fn new() -> Arc<Self> {
            Arc::new(Self {
                registered: parking_lot::Mutex::new(Vec::new()),
                deregistered: parking_lot::Mutex::new(Vec::new()),
                register_error: parking_lot::Mutex::new(None),
                deregister_error: parking_lot::Mutex::new(None),
            })
        }

        fn set_register_error(&self, error: Option<String>) {
            *self.register_error.lock() = error;
        }

        fn set_deregister_error(&self, error: Option<String>) {
            *self.deregister_error.lock() = error;
        }

        fn registered_instances(&self) -> Vec<ServiceInstance> {
            self.registered.lock().clone()
        }

        fn deregistered_ids(&self) -> Vec<String> {
            self.deregistered.lock().clone()
        }
    }

    #[async_trait]
    impl Registry for MockRegistry {
        async fn register(&self, instance: &ServiceInstance) -> AppResult<()> {
            if let Some(err) = &*self.register_error.lock() {
                return Err(AppError::new(ErrorCode::Internal, err.clone()));
            }
            self.registered.lock().push(instance.clone());
            Ok(())
        }

        async fn deregister(&self, id: &str) -> AppResult<()> {
            if let Some(err) = &*self.deregister_error.lock() {
                return Err(AppError::new(ErrorCode::Internal, err.clone()));
            }
            self.deregistered.lock().push(id.to_string());
            Ok(())
        }
    }

    #[tokio::test]
    async fn test_lifecycle_success() {
        let server = Arc::new(MockServer::new());
        let registry = MockRegistry::new();
        let instance = ServiceInstance {
            id: "test-1".to_string(),
            name: "test-service".to_string(),
            address: "127.0.0.1".to_string(),
            port: 8080,
            healthy: true,
            weight: 1,
            tags: vec!["test".to_string()],
            metadata: Default::default(),
        };

        let discovery_server = DiscoveryServer::new(
            "discovery-test".to_string(),
            server.clone(),
            registry.clone(),
            instance.clone(),
        );

        // Start should start inner server and register
        discovery_server.start().await.unwrap();
        assert!(*server.started.lock());
        assert_eq!(registry.registered_instances().len(), 1);
        assert_eq!(registry.registered_instances()[0].id, "test-1");

        // Stop should deregister and stop inner server
        discovery_server.stop().await.unwrap();
        assert!(*server.stopped.lock());
        assert_eq!(registry.deregistered_ids().len(), 1);
        assert_eq!(registry.deregistered_ids()[0], "test-1");
    }

    #[tokio::test]
    async fn test_registration_failure_stops_server() {
        let server = Arc::new(MockServer::new());
        let registry = MockRegistry::new();
        registry.set_register_error(Some("service unavailable".to_string()));

        let instance = ServiceInstance {
            id: "test-2".to_string(),
            name: "test-service".to_string(),
            address: "127.0.0.1".to_string(),
            port: 8081,
            healthy: true,
            weight: 1,
            tags: vec![],
            metadata: Default::default(),
        };

        let discovery_server = DiscoveryServer::new(
            "discovery-test".to_string(),
            server.clone(),
            registry.clone(),
            instance,
        );

        // Start should fail
        let result = discovery_server.start().await;
        assert!(result.is_err());

        // Server should have started (even though registration failed)
        assert!(*server.started.lock());

        // After a short delay, we should see the stop called
        tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;
        assert!(*server.stopped.lock());
    }

    #[tokio::test]
    async fn test_deregistration_failure_doesnt_prevent_stop() {
        let server = Arc::new(MockServer::new());
        let registry = MockRegistry::new();
        let instance = ServiceInstance {
            id: "test-3".to_string(),
            name: "test-service".to_string(),
            address: "127.0.0.1".to_string(),
            port: 8082,
            healthy: true,
            weight: 1,
            tags: vec![],
            metadata: Default::default(),
        };

        let discovery_server = DiscoveryServer::new(
            "discovery-test".to_string(),
            server.clone(),
            registry.clone(),
            instance,
        );

        // Start successfully
        discovery_server.start().await.unwrap();
        assert_eq!(registry.registered_instances().len(), 1);

        // Set deregistration error
        registry.set_deregister_error(Some("registry error".to_string()));

        // Stop should still succeed
        let result = discovery_server.stop().await;
        assert!(result.is_ok());

        // Server should be stopped
        assert!(*server.stopped.lock());
    }

    #[test]
    fn test_component_name_and_accessors() {
        let server = Arc::new(MockServer::new());
        let registry = MockRegistry::new();
        let instance = ServiceInstance {
            id: "test-4".to_string(),
            name: "my-service".to_string(),
            address: "192.168.1.1".to_string(),
            port: 9000,
            healthy: true,
            weight: 1,
            tags: vec!["prod".to_string()],
            metadata: Default::default(),
        };

        let discovery_server = DiscoveryServer::new(
            "my-discovery-server".to_string(),
            server,
            registry,
            instance.clone(),
        );

        assert_eq!(discovery_server.name(), "my-discovery-server");
        assert_eq!(discovery_server.inner().name(), "mock-server");
        assert_eq!(discovery_server.instance().id, "test-4");
        assert_eq!(discovery_server.instance().name, "my-service");
        assert_eq!(discovery_server.instance().port, 9000);
    }

    #[tokio::test]
    async fn inner_start_failure_prevents_registration() {
        let server = Arc::new(ErrorServer {
            fail_start: true,
            fail_stop: false,
            healthy: true,
        });
        let registry = MockRegistry::new();
        let discovery_server = DiscoveryServer::new(
            "discovery-test".to_string(),
            server,
            registry.clone(),
            test_instance("test-5"),
        );

        let err = discovery_server.start().await.unwrap_err();

        assert!(err.to_string().contains("failed to start inner server"));
        assert!(registry.registered_instances().is_empty());
    }

    #[tokio::test]
    async fn inner_stop_failure_is_returned_after_deregistering() {
        let server = Arc::new(ErrorServer {
            fail_start: false,
            fail_stop: true,
            healthy: true,
        });
        let registry = MockRegistry::new();
        let discovery_server = DiscoveryServer::new(
            "discovery-test".to_string(),
            server,
            registry.clone(),
            test_instance("test-6"),
        );
        discovery_server.start().await.unwrap();

        let err = discovery_server.stop().await.unwrap_err();

        assert!(err.to_string().contains("failed to stop inner server"));
        assert_eq!(registry.deregistered_ids(), vec!["test-6".to_string()]);
    }

    #[test]
    fn health_reflects_inner_component_state() {
        let registry = MockRegistry::new();
        let healthy = DiscoveryServer::new(
            "discovery-test".to_string(),
            Arc::new(ErrorServer {
                fail_start: false,
                fail_stop: false,
                healthy: true,
            }),
            registry.clone(),
            test_instance("test-7"),
        );
        let unhealthy = DiscoveryServer::new(
            "discovery-test".to_string(),
            Arc::new(ErrorServer {
                fail_start: false,
                fail_stop: false,
                healthy: false,
            }),
            registry,
            test_instance("test-8"),
        );

        assert!(healthy.health().is_healthy());
        assert!(!unhealthy.health().is_healthy());
    }

    fn test_instance(id: &str) -> ServiceInstance {
        ServiceInstance {
            id: id.to_string(),
            name: "test-service".to_string(),
            address: "127.0.0.1".to_string(),
            port: 8080,
            healthy: true,
            weight: 1,
            tags: Vec::new(),
            metadata: Default::default(),
        }
    }
}