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
//! Listener Discovery Service (LDS) implementation.
//!
//! LDS provides listener configuration to Envoy proxies.
use std::sync::Arc;
use async_trait::async_trait;
use tokio::sync::mpsc;
use tokio_stream::wrappers::ReceiverStream;
use tonic::{Request, Response, Status, Streaming};
use tracing::{debug, error, info, instrument};
use xds_cache::ShardedCache;
use xds_core::{NodeHash, ResourceRegistry, TypeUrl};
use crate::delta::{delta_response_to_proto, ClientResourceState, DeltaHandler};
use crate::sotw::SotwHandler;
use crate::stream::StreamContext;
// Re-export the data-plane-api types
pub use xds_types::envoy::service::discovery::v3::{DiscoveryRequest, DiscoveryResponse};
pub use xds_types::envoy::service::listener::v3::listener_discovery_service_server::{
ListenerDiscoveryService, ListenerDiscoveryServiceServer,
};
pub use xds_types::envoy::service::discovery::v3::{
DeltaDiscoveryRequest, DeltaDiscoveryResponse,
};
/// Listener Discovery Service.
#[derive(Debug, Clone)]
pub struct LdsService {
/// Shared cache.
cache: Arc<ShardedCache>,
/// Resource registry.
registry: Arc<ResourceRegistry>,
/// SotW handler.
sotw_handler: Arc<SotwHandler>,
/// Delta handler.
delta_handler: Arc<DeltaHandler>,
}
impl LdsService {
/// Create a new LDS service.
pub fn new(cache: Arc<ShardedCache>, registry: Arc<ResourceRegistry>) -> Self {
let sotw_handler = Arc::new(SotwHandler::new(Arc::clone(&cache), Arc::clone(®istry)));
let delta_handler = Arc::new(DeltaHandler::new(Arc::clone(&cache), Arc::clone(®istry)));
Self {
cache,
registry,
sotw_handler,
delta_handler,
}
}
/// Create a new LDS service with shared protocol handlers.
///
/// This allows sharing handlers across multiple services for better
/// resource efficiency.
pub fn new_with_handlers(
cache: Arc<ShardedCache>,
registry: Arc<ResourceRegistry>,
sotw_handler: Arc<SotwHandler>,
delta_handler: Arc<DeltaHandler>,
) -> Self {
Self {
cache,
registry,
sotw_handler,
delta_handler,
}
}
/// Get the type URL for listeners.
#[inline]
pub fn type_url() -> &'static str {
TypeUrl::LISTENER
}
/// Get a reference to the cache.
#[allow(dead_code)]
pub fn cache(&self) -> &ShardedCache {
&self.cache
}
/// Get a reference to the registry.
#[allow(dead_code)]
pub fn registry(&self) -> &ResourceRegistry {
&self.registry
}
/// Convert this service into a tonic service for use with Server::add_service.
pub fn into_service(self) -> ListenerDiscoveryServiceServer<Self> {
ListenerDiscoveryServiceServer::new(self)
}
/// Convert a SotW response to a proto DiscoveryResponse.
///
/// Returns an error if any resource fails to encode, rather than
/// silently dropping it.
fn convert_response(
&self,
response: crate::sotw::SotwResponse,
) -> Result<DiscoveryResponse, Status> {
use xds_types::google::protobuf::Any;
let resources: Vec<Any> = response
.resources
.iter()
.map(|r| {
r.encode().map(|encoded| Any {
type_url: encoded.type_url.clone(),
value: encoded.value.clone(),
})
})
.collect::<Result<Vec<_>, _>>()
.map_err(|e| Status::internal(format!("failed to encode resource: {}", e)))?;
Ok(DiscoveryResponse {
version_info: response.version_info,
resources,
type_url: TypeUrl::LISTENER.to_string(),
nonce: response.nonce,
canary: false,
control_plane: None,
resource_errors: vec![],
})
}
}
/// Response stream type for LDS.
pub type LdsResponseStream = ReceiverStream<Result<DiscoveryResponse, Status>>;
/// Delta response stream type for LDS.
pub type LdsDeltaResponseStream = ReceiverStream<Result<DeltaDiscoveryResponse, Status>>;
#[async_trait]
impl ListenerDiscoveryService for LdsService {
type StreamListenersStream = LdsResponseStream;
#[instrument(skip(self, request), name = "lds_stream")]
async fn stream_listeners(
&self,
request: Request<Streaming<DiscoveryRequest>>,
) -> Result<Response<Self::StreamListenersStream>, Status> {
let mut stream = request.into_inner();
let (tx, rx) = mpsc::channel(16);
let service = self.clone();
let mut ctx = StreamContext::new();
info!(stream = %ctx.id(), "LDS stream started");
tokio::spawn(async move {
let mut node_hash: Option<NodeHash> = None;
while let Some(result) = tokio_stream::StreamExt::next(&mut stream).await {
match result {
Ok(request) => {
// Validate type URL
if !request.type_url.is_empty() && request.type_url != TypeUrl::LISTENER {
error!(
stream = %ctx.id(),
expected = TypeUrl::LISTENER,
got = %request.type_url,
"invalid type URL for LDS"
);
continue;
}
// Extract node info
if node_hash.is_none() {
if let Some(ref node) = request.node {
let hash = NodeHash::from_id(&node.id);
ctx.set_node(node.id.clone(), hash);
node_hash = Some(hash);
}
}
let hash = match node_hash {
Some(h) => h,
None => {
// First request must include node information
error!(
stream = %ctx.id(),
"first request missing required node information"
);
let _ = tx.send(Err(Status::invalid_argument(
"first request must include node information"
))).await;
break;
}
};
// Process request
match service.sotw_handler.process_request(
&ctx,
TypeUrl::LISTENER.into(),
&request.version_info,
&request.resource_names,
hash,
) {
Ok(Some(response)) => {
match service.convert_response(response) {
Ok(discovery_response) => {
if tx.send(Ok(discovery_response)).await.is_err() {
break;
}
}
Err(e) => {
error!(stream = %ctx.id(), error = %e, "failed to convert response");
let _ = tx.send(Err(e)).await;
break;
}
}
}
Ok(None) => {}
Err(e) => {
error!(stream = %ctx.id(), error = %e, "LDS request failed");
break;
}
}
}
Err(e) => {
error!(stream = %ctx.id(), error = %e, "stream error");
break;
}
}
}
info!(stream = %ctx.id(), "LDS stream ended");
});
Ok(Response::new(ReceiverStream::new(rx)))
}
type DeltaListenersStream = LdsDeltaResponseStream;
#[instrument(skip(self, request), name = "lds_delta_stream")]
async fn delta_listeners(
&self,
request: Request<Streaming<DeltaDiscoveryRequest>>,
) -> Result<Response<Self::DeltaListenersStream>, Status> {
let mut stream = request.into_inner();
let (tx, rx) = mpsc::channel(16);
let service = self.clone();
let mut ctx = StreamContext::new();
info!(stream = %ctx.id(), "Delta LDS stream started");
tokio::spawn(async move {
let mut node_hash: Option<NodeHash> = None;
let mut client_state = ClientResourceState::new();
while let Some(result) = tokio_stream::StreamExt::next(&mut stream).await {
match result {
Ok(request) => {
if !request.type_url.is_empty() && request.type_url != TypeUrl::LISTENER {
error!(
stream = %ctx.id(),
expected = TypeUrl::LISTENER,
got = %request.type_url,
"invalid type URL for delta LDS"
);
continue;
}
if node_hash.is_none() {
if let Some(ref node) = request.node {
let hash = NodeHash::from_id(&node.id);
ctx.set_node(node.id.clone(), hash);
node_hash = Some(hash);
}
}
let hash = match node_hash {
Some(h) => h,
None => {
error!(
stream = %ctx.id(),
"first delta request missing required node information"
);
let _ = tx
.send(Err(Status::invalid_argument(
"first request must include node information",
)))
.await;
break;
}
};
if !request.response_nonce.is_empty() {
if let Some(ref err) = request.error_detail {
service.delta_handler.handle_nack(
&ctx,
TypeUrl::LISTENER.into(),
&request.response_nonce,
&err.message,
);
} else {
service.delta_handler.handle_ack(
&ctx,
TypeUrl::LISTENER.into(),
&request.response_nonce,
);
}
}
match service.delta_handler.process_request(
&ctx,
TypeUrl::LISTENER.into(),
&mut client_state,
request.resource_names_subscribe,
request.resource_names_unsubscribe,
hash,
) {
Ok(Some(response)) => match delta_response_to_proto(response) {
Ok(proto_response) => {
if tx.send(Ok(proto_response)).await.is_err() {
break;
}
}
Err(e) => {
error!(stream = %ctx.id(), error = %e, "failed to encode delta response");
let _ = tx.send(Err(e)).await;
break;
}
},
Ok(None) => {}
Err(e) => {
error!(stream = %ctx.id(), error = %e, "delta LDS request failed");
break;
}
}
}
Err(e) => {
error!(stream = %ctx.id(), error = %e, "delta stream error");
break;
}
}
}
info!(stream = %ctx.id(), "Delta LDS stream ended");
drop(tx);
});
Ok(Response::new(ReceiverStream::new(rx)))
}
#[instrument(skip(self, request), name = "lds_fetch")]
async fn fetch_listeners(
&self,
request: Request<DiscoveryRequest>,
) -> Result<Response<DiscoveryResponse>, Status> {
let request = request.into_inner();
let ctx = StreamContext::new();
let node_hash = request
.node
.as_ref()
.map(|n| NodeHash::from_id(&n.id))
.ok_or_else(|| Status::invalid_argument("node is required"))?;
debug!(node = ?node_hash, "LDS fetch request");
let response = self
.sotw_handler
.process_request(
&ctx,
TypeUrl::LISTENER.into(),
&request.version_info,
&request.resource_names,
node_hash,
)
.map_err(|e| Status::internal(e.to_string()))?
.ok_or_else(|| Status::not_found("no listeners available"))?;
Ok(Response::new(self.convert_response(response)?))
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn lds_service_creation() {
let cache = Arc::new(ShardedCache::new());
let registry = Arc::new(ResourceRegistry::new());
let _service = LdsService::new(cache, registry);
}
#[test]
fn lds_type_url() {
assert_eq!(LdsService::type_url(), TypeUrl::LISTENER);
}
}