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
//! Etcd Watch RPC.
pub use crate::rpc::pb::mvccpb::event::EventType;
use crate::auth::AuthService;
use crate::channel::Channel;
use crate::error::{Error, Result};
use crate::rpc::pb::etcdserverpb::watch_client::WatchClient as PbWatchClient;
use crate::rpc::pb::etcdserverpb::watch_request::RequestUnion as WatchRequestUnion;
use crate::rpc::pb::etcdserverpb::{
WatchCancelRequest, WatchCreateRequest, WatchProgressRequest, WatchRequest,
WatchResponse as PbWatchResponse,
};
use crate::rpc::pb::mvccpb::Event as PbEvent;
use crate::rpc::{KeyRange, KeyValue, ResponseHeader};
use http::HeaderValue;
use std::pin::Pin;
use std::sync::{Arc, RwLock};
use std::task::{Context, Poll};
use tokio::sync::mpsc::{channel, Sender};
use tokio_stream::{wrappers::ReceiverStream, Stream};
use tonic::Streaming;
/// Client for watch operations.
#[repr(transparent)]
#[derive(Clone)]
pub struct WatchClient {
inner: PbWatchClient<AuthService<Channel>>,
}
impl WatchClient {
/// Creates a watch client.
#[inline]
pub(crate) fn new(channel: Channel, auth_token: Arc<RwLock<Option<HeaderValue>>>) -> Self {
let inner = PbWatchClient::new(AuthService::new(channel, auth_token));
Self { inner }
}
/// Limits the maximum size of a decoded message.
///
/// Default: `4MB`
pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_decoding_message_size(limit);
self
}
/// Watches for events happening or that have happened. Both input and output
/// are streams; the input stream is for creating and canceling watchers and the output
/// stream sends events. One watch RPC can watch on multiple key ranges, streaming events
/// for several watches at once. The entire event history can be watched starting from the
/// last compaction revision.
pub async fn watch(
&mut self,
key: impl Into<Vec<u8>>,
options: Option<WatchOptions>,
) -> Result<(Watcher, WatchStream)> {
let (request_sender, request_receiver) = channel::<WatchRequest>(100);
let request_stream = ReceiverStream::new(request_receiver);
request_sender
.send(options.unwrap_or_default().with_key(key).into())
.await
.map_err(|e| Error::WatchError(e.to_string()))?;
let response_stream = self.inner.watch(request_stream).await?.into_inner();
let mut watch_stream = WatchStream::new(response_stream);
let watch_id = match watch_stream.message().await? {
Some(resp) => {
assert!(resp.created(), "not a create watch response");
resp.watch_id()
}
None => {
return Err(Error::WatchError("failed to create watch".to_string()));
}
};
Ok((Watcher::new(watch_id, request_sender), watch_stream))
}
}
/// Options for `Watch` operation.
#[derive(Debug, Default, Clone)]
pub struct WatchOptions {
req: WatchCreateRequest,
key_range: KeyRange,
}
impl WatchOptions {
/// Sets key.
#[inline]
fn with_key(mut self, key: impl Into<Vec<u8>>) -> Self {
self.key_range.with_key(key);
self
}
/// Creates a new `WatchOptions`.
#[inline]
pub const fn new() -> Self {
Self {
req: WatchCreateRequest {
key: Vec::new(),
range_end: Vec::new(),
start_revision: 0,
progress_notify: false,
filters: Vec::new(),
prev_kv: false,
watch_id: 0,
fragment: false,
},
key_range: KeyRange::new(),
}
}
/// Sets the end of the range [key, end) to watch. If `end` is not given,
/// only the key argument is watched. If `end` is equal to '\0', all keys greater than
/// or equal to the key argument are watched.
#[inline]
pub fn with_range(mut self, end: impl Into<Vec<u8>>) -> Self {
self.key_range.with_range(end);
self
}
/// Watches all keys >= key.
#[inline]
pub fn with_from_key(mut self) -> Self {
self.key_range.with_from_key();
self
}
/// Watches all keys prefixed with key.
#[inline]
pub fn with_prefix(mut self) -> Self {
self.key_range.with_prefix();
self
}
/// Watches all keys.
#[inline]
pub fn with_all_keys(mut self) -> Self {
self.key_range.with_all_keys();
self
}
/// Sets the revision to watch from (inclusive). No `start_revision` is "now".
#[inline]
pub const fn with_start_revision(mut self, revision: i64) -> Self {
self.req.start_revision = revision;
self
}
/// `progress_notify` is set so that the etcd server will periodically send a `WatchResponse` with
/// no events to the new watcher if there are no recent events. It is useful when clients
/// wish to recover a disconnected watcher starting from a recent known revision.
/// The etcd server may decide how often it will send notifications based on current load.
#[inline]
pub const fn with_progress_notify(mut self) -> Self {
self.req.progress_notify = true;
self
}
/// Filter the events at server side before it sends back to the watcher.
#[inline]
pub fn with_filters(mut self, filters: impl Into<Vec<WatchFilterType>>) -> Self {
self.req.filters = filters.into().into_iter().map(|f| f as i32).collect();
self
}
/// If `prev_kv` is set, created watcher gets the previous KV before the event happens.
/// If the previous KV is already compacted, nothing will be returned.
#[inline]
pub const fn with_prev_key(mut self) -> Self {
self.req.prev_kv = true;
self
}
/// If `watch_id` is provided and non-zero, it will be assigned to this watcher.
/// Since creating a watcher in etcd is not a synchronous operation,
/// this can be used ensure that ordering is correct when creating multiple
/// watchers on the same stream. Creating a watcher with an ID already in
/// use on the stream will cause an error to be returned.
#[inline]
pub const fn with_watch_id(mut self, watch_id: i64) -> Self {
self.req.watch_id = watch_id;
self
}
/// Enables splitting large revisions into multiple watch responses.
#[inline]
pub const fn with_fragment(mut self) -> Self {
self.req.fragment = true;
self
}
}
impl From<WatchOptions> for WatchCreateRequest {
#[inline]
fn from(mut options: WatchOptions) -> Self {
let (key, range_end) = options.key_range.build();
options.req.key = key;
options.req.range_end = range_end;
options.req
}
}
impl From<WatchOptions> for WatchRequest {
#[inline]
fn from(options: WatchOptions) -> Self {
Self {
request_union: Some(WatchRequestUnion::CreateRequest(options.into())),
}
}
}
impl From<WatchCancelRequest> for WatchRequest {
#[inline]
fn from(req: WatchCancelRequest) -> Self {
Self {
request_union: Some(WatchRequestUnion::CancelRequest(req)),
}
}
}
impl From<WatchProgressRequest> for WatchRequest {
#[inline]
fn from(req: WatchProgressRequest) -> Self {
Self {
request_union: Some(WatchRequestUnion::ProgressRequest(req)),
}
}
}
/// Watch filter type.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum WatchFilterType {
/// Filter out put event.
NoPut = 0,
/// Filter out delete event.
NoDelete = 1,
}
/// Response for `Watch` operation.
#[cfg_attr(feature = "pub-response-field", visible::StructFields(pub))]
#[derive(Debug, Clone)]
#[repr(transparent)]
pub struct WatchResponse(PbWatchResponse);
impl WatchResponse {
/// Creates a new `WatchResponse`.
#[inline]
const fn new(resp: PbWatchResponse) -> Self {
Self(resp)
}
/// Watch response header.
#[inline]
pub fn header(&self) -> Option<&ResponseHeader> {
self.0.header.as_ref().map(From::from)
}
/// Takes the header out of the response, leaving a [`None`] in its place.
#[inline]
pub fn take_header(&mut self) -> Option<ResponseHeader> {
self.0.header.take().map(ResponseHeader::new)
}
/// The ID of the watcher that corresponds to the response.
#[inline]
pub const fn watch_id(&self) -> i64 {
self.0.watch_id
}
/// created is set to true if the response is for a create watch request.
/// The client should record the watch_id and expect to receive events for
/// the created watcher from the same stream.
/// All events sent to the created watcher will attach with the same watch_id.
#[inline]
pub const fn created(&self) -> bool {
self.0.created
}
/// `canceled` is set to true if the response is for a cancel watch request.
/// No further events will be sent to the canceled watcher.
#[inline]
pub const fn canceled(&self) -> bool {
self.0.canceled
}
/// `compact_revision` is set to the minimum index if a watcher tries to watch
/// at a compacted index.
///
/// This happens when creating a watcher at a compacted revision or the watcher cannot
/// catch up with the progress of the key-value store.
///
/// The client should treat the watcher as canceled and should not try to create any
/// watcher with the same start_revision again.
#[inline]
pub const fn compact_revision(&self) -> i64 {
self.0.compact_revision
}
/// Indicates the reason for canceling the watcher.
#[inline]
pub fn cancel_reason(&self) -> &str {
&self.0.cancel_reason
}
/// Events happened on the watched keys.
#[inline]
pub fn events(&self) -> &[Event] {
unsafe { &*(self.0.events.as_slice() as *const _ as *const [Event]) }
}
}
/// Watching event.
#[cfg_attr(feature = "pub-response-field", visible::StructFields(pub))]
#[derive(Debug, Clone)]
#[repr(transparent)]
pub struct Event(PbEvent);
impl Event {
/// The kind of event. If type is a `Put`, it indicates
/// new data has been stored to the key. If type is a `Delete`,
/// it indicates the key was deleted.
#[inline]
pub fn event_type(&self) -> EventType {
match self.0.r#type {
0 => EventType::Put,
1 => EventType::Delete,
i => panic!("unknown event {}", i),
}
}
/// The KeyValue for the event.
/// A `Put` event contains current kv pair.
/// A `Put` event with `kv.version()==1` indicates the creation of a key.
/// A `Delete` event contains the deleted key with
/// its modification revision set to the revision of deletion.
#[inline]
pub fn kv(&self) -> Option<&KeyValue> {
self.0.kv.as_ref().map(From::from)
}
/// The key-value pair before the event happens.
#[inline]
pub fn prev_kv(&self) -> Option<&KeyValue> {
self.0.prev_kv.as_ref().map(From::from)
}
}
/// The watching handle.
#[cfg_attr(feature = "pub-response-field", visible::StructFields(pub))]
#[derive(Debug)]
pub struct Watcher {
watch_id: i64,
sender: Sender<WatchRequest>,
}
impl Watcher {
/// Creates a new `Watcher`.
#[inline]
const fn new(watch_id: i64, sender: Sender<WatchRequest>) -> Self {
Self { watch_id, sender }
}
/// The ID of the watcher.
#[inline]
pub const fn watch_id(&self) -> i64 {
self.watch_id
}
/// Watches for events happening or that have happened.
#[inline]
pub async fn watch(
&mut self,
key: impl Into<Vec<u8>>,
options: Option<WatchOptions>,
) -> Result<()> {
self.sender
.send(options.unwrap_or_default().with_key(key).into())
.await
.map_err(|e| Error::WatchError(e.to_string()))
}
/// Cancels this watcher.
#[inline]
pub async fn cancel(&mut self) -> Result<()> {
let req = WatchCancelRequest {
watch_id: self.watch_id,
};
self.sender
.send(req.into())
.await
.map_err(|e| Error::WatchError(e.to_string()))
}
/// Cancels watch by specified `watch_id`.
#[inline]
pub async fn cancel_by_id(&mut self, watch_id: i64) -> Result<()> {
let req = WatchCancelRequest { watch_id };
self.sender
.send(req.into())
.await
.map_err(|e| Error::WatchError(e.to_string()))
}
/// Requests a watch stream progress status be sent in the watch response stream as soon as
/// possible.
#[inline]
pub async fn request_progress(&mut self) -> Result<()> {
let req = WatchProgressRequest {};
self.sender
.send(req.into())
.await
.map_err(|e| Error::WatchError(e.to_string()))
}
}
/// The watch response stream.
#[cfg_attr(feature = "pub-response-field", visible::StructFields(pub))]
#[derive(Debug)]
pub struct WatchStream {
stream: Streaming<PbWatchResponse>,
}
impl WatchStream {
/// Creates a new `WatchStream`.
#[inline]
const fn new(stream: Streaming<PbWatchResponse>) -> Self {
Self { stream }
}
/// Fetch the next message from this stream.
#[inline]
pub async fn message(&mut self) -> Result<Option<WatchResponse>> {
match self.stream.message().await? {
Some(resp) => Ok(Some(WatchResponse::new(resp))),
None => Ok(None),
}
}
}
impl Stream for WatchStream {
type Item = Result<WatchResponse>;
#[inline]
fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
Pin::new(&mut self.get_mut().stream)
.poll_next(cx)
.map(|t| match t {
Some(Ok(resp)) => Some(Ok(WatchResponse::new(resp))),
Some(Err(e)) => Some(Err(From::from(e))),
None => None,
})
}
}