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 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
// Copyright 2020-2022 The NATS Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
pub mod bucket;
use std::{
io::{self, ErrorKind},
task::Poll,
};
use crate::{HeaderValue, StatusCode};
use bytes::Bytes;
use futures::StreamExt;
use once_cell::sync::Lazy;
use regex::Regex;
use time::{format_description::well_known::Rfc3339, OffsetDateTime};
use crate::{header, jetstream::response, Error, Message};
use self::bucket::Status;
use super::{
consumer::DeliverPolicy,
stream::{RawMessage, Republish, Source, StorageType, Stream},
};
// Helper to extract key value operation from message headers
fn kv_operation_from_maybe_headers(maybe_headers: Option<&String>) -> Operation {
if let Some(headers) = maybe_headers {
return match headers.as_str() {
KV_OPERATION_DELETE => Operation::Delete,
KV_OPERATION_PURGE => Operation::Purge,
_ => Operation::Put,
};
}
Operation::Put
}
fn kv_operation_from_stream_message(message: &RawMessage) -> Operation {
kv_operation_from_maybe_headers(message.headers.as_ref())
}
static VALID_BUCKET_RE: Lazy<Regex> = Lazy::new(|| Regex::new(r#"\A[a-zA-Z0-9_-]+\z"#).unwrap());
static VALID_KEY_RE: Lazy<Regex> = Lazy::new(|| Regex::new(r#"\A[-/_=\.a-zA-Z0-9]+\z"#).unwrap());
pub(crate) const MAX_HISTORY: i64 = 64;
const ALL_KEYS: &str = ">";
const KV_OPERATION: &str = "KV-Operation";
const KV_OPERATION_DELETE: &str = "DEL";
const KV_OPERATION_PURGE: &str = "PURGE";
const KV_OPERATION_PUT: &str = "PUT";
const NATS_ROLLUP: &str = "Nats-Rollup";
const ROLLUP_SUBJECT: &str = "sub";
pub(crate) fn is_valid_bucket_name(bucket_name: &str) -> bool {
VALID_BUCKET_RE.is_match(bucket_name)
}
pub(crate) fn is_valid_key(key: &str) -> bool {
if key.is_empty() || key.starts_with('.') || key.ends_with('.') {
return false;
}
VALID_KEY_RE.is_match(key)
}
/// Configuration values for key value stores.
#[derive(Debug, Default)]
pub struct Config {
/// Name of the bucket
pub bucket: String,
/// Human readable description.
pub description: String,
/// Maximum size of a single value.
pub max_value_size: i32,
/// Maximum historical entries.
pub history: i64,
/// Maximum age of any entry in the bucket, expressed in nanoseconds
pub max_age: std::time::Duration,
/// How large the bucket may become in total bytes before the configured discard policy kicks in
pub max_bytes: i64,
/// The type of storage backend, `File` (default) and `Memory`
pub storage: StorageType,
/// How many replicas to keep for each entry in a cluster.
pub num_replicas: usize,
/// Republish is for republishing messages once persistent in the Key Value Bucket.
pub republish: Option<Republish>,
/// Bucket mirror configuration.
pub mirror: Option<Source>,
/// Bucket sources configuration.
pub sources: Option<Vec<Source>>,
/// Allow mirrors using direct API.
pub mirror_direct: bool,
}
/// Describes what kind of operation and entry represents
#[derive(Debug, Clone, Copy, Eq, PartialEq)]
pub enum Operation {
/// A value was put into the bucket
Put,
/// A value was deleted from a bucket
Delete,
/// A value was purged from a bucket
Purge,
}
/// A struct used as a handle for the bucket.
#[derive(Debug, Clone)]
pub struct Store {
pub name: String,
pub stream_name: String,
pub prefix: String,
pub put_prefix: Option<String>,
pub use_jetstream_prefix: bool,
pub stream: Stream,
}
impl Store {
/// Queries the server and returns status from the server.
///
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// let client = async_nats::connect("demo.nats.io:4222").await?;
/// let jetstream = async_nats::jetstream::new(client);
/// let kv = jetstream.create_key_value(async_nats::jetstream::kv::Config {
/// bucket: "kv".to_string(),
/// history: 10,
/// ..Default::default()
/// }).await?;
/// let status = kv.status().await?;
/// println!("status: {:?}", status);
/// # Ok(())
/// # }
/// ```
pub async fn status(&self) -> Result<Status, Error> {
// TODO: should we poll for fresh info here? probably yes.
let info = self.stream.info.clone();
Ok(Status {
info,
bucket: self.name.to_string(),
})
}
/// Puts new key value pair into the bucket.
/// If key didn't exist, it is created. If it did exist, a new value with a new version is
/// added.
///
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// let client = async_nats::connect("demo.nats.io:4222").await?;
/// let jetstream = async_nats::jetstream::new(client);
/// let kv = jetstream.create_key_value(async_nats::jetstream::kv::Config {
/// bucket: "kv".to_string(),
/// history: 10,
/// ..Default::default()
/// }).await?;
/// let status = kv.put("key", "value".into()).await?;
/// # Ok(())
/// # }
/// ```
pub async fn put<T: AsRef<str>>(&self, key: T, value: bytes::Bytes) -> Result<u64, Error> {
if !is_valid_key(key.as_ref()) {
return Err(Box::new(io::Error::new(
io::ErrorKind::InvalidInput,
"invalid key",
)));
}
let mut subject = String::new();
if self.use_jetstream_prefix {
subject.push_str(&self.stream.context.prefix);
subject.push('.');
}
subject.push_str(self.put_prefix.as_ref().unwrap_or(&self.prefix));
subject.push_str(key.as_ref());
let publish_ack = self.stream.context.publish(subject, value).await?;
let ack = publish_ack.await?;
Ok(ack.sequence)
}
/// Retrieves the last [Entry] for a given key from a bucket.
///
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// let client = async_nats::connect("demo.nats.io:4222").await?;
/// let jetstream = async_nats::jetstream::new(client);
/// let kv = jetstream.create_key_value(async_nats::jetstream::kv::Config {
/// bucket: "kv".to_string(),
/// history: 10,
/// ..Default::default()
/// }).await?;
/// let status = kv.put("key", "value".into()).await?;
/// let entry = kv.entry("key").await?;
/// println!("entry: {:?}", entry);
/// # Ok(())
/// # }
/// ```
pub async fn entry<T: Into<String>>(&self, key: T) -> Result<Option<Entry>, Error> {
let key: String = key.into();
if !is_valid_key(key.as_ref()) {
return Err(Box::new(io::Error::new(
io::ErrorKind::InvalidInput,
"invalid key",
)));
}
let subject = format!("{}{}", self.prefix.as_str(), &key);
let result: Option<(Message, Operation, u64, OffsetDateTime)> = {
if self.stream.info.config.allow_direct {
let message = self
.stream
.direct_get_last_for_subject(subject.as_str())
.await;
match message {
Ok(message) => {
let headers = message.headers.as_ref().ok_or_else(|| {
std::io::Error::new(io::ErrorKind::Other, "did not found headers")
})?;
let operation = headers.get(KV_OPERATION).map_or_else(
|| Operation::Put,
|operation| match operation
.iter()
.next()
.cloned()
.unwrap_or_else(|| KV_OPERATION_PUT.to_string())
.as_ref()
{
KV_OPERATION_PURGE => Operation::Purge,
KV_OPERATION_DELETE => Operation::Delete,
_ => Operation::Put,
},
);
let sequence = headers
.get(header::NATS_SEQUENCE)
.ok_or_else(|| {
io::Error::new(
io::ErrorKind::NotFound,
"did not found sequence header",
)
})?
.iter()
.next()
.ok_or_else(|| {
io::Error::new(
io::ErrorKind::NotFound,
"did not found sequence header value",
)
})?
.parse()?;
let created = headers
.get(header::NATS_TIME_STAMP)
.ok_or_else(|| {
io::Error::new(
io::ErrorKind::NotFound,
"did not found timestamp header",
)
})?
.iter()
.next()
.ok_or_else(|| {
io::Error::new(
io::ErrorKind::NotFound,
"did not found timestamp header value",
)
})
.and_then(|created| {
OffsetDateTime::parse(created, &Rfc3339).map_err(|err| {
std::io::Error::new(
io::ErrorKind::Other,
format!("failed to parse Nats-Time-Stamp: {err}"),
)
})
})?;
Some((message.message, operation, sequence, created))
}
Err(err) => {
let e: std::io::Error = *err.downcast().unwrap();
if e.kind() == ErrorKind::NotFound {
None
} else {
return Err(Box::new(e));
}
}
}
} else {
let raw_message = self
.stream
.get_last_raw_message_by_subject(subject.as_str())
.await;
match raw_message {
Ok(raw_message) => {
let operation = kv_operation_from_stream_message(&raw_message);
// TODO: unnecessary expensive, cloning whole Message.
let nats_message = Message::try_from(raw_message.clone())?;
Some((
nats_message,
operation,
raw_message.sequence,
raw_message.time,
))
}
Err(err) => {
let e: std::io::Error = *err.downcast().unwrap();
let d = e.get_ref().unwrap();
let de = d.downcast_ref::<response::Error>().unwrap();
// 10037 is returned when there are no messages found.
if de.code == 10037 {
None
} else {
return Err(Box::new(e));
}
}
}
}
};
match result {
Some((message, operation, revision, created)) => {
if message.status == Some(StatusCode::NO_RESPONDERS) {
return Ok(None);
}
let entry = Entry {
bucket: self.name.clone(),
key,
value: message.payload.to_vec(),
revision,
created,
operation,
delta: 0,
};
Ok(Some(entry))
}
// TODO: remember to touch this when Errors are in place.
None => Ok(None),
}
}
/// Creates a [futures::Stream] over [Entries][Entry] a given key in the bucket, which yields
/// values whenever there are changes for that key.
///
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// use futures::StreamExt;
/// let client = async_nats::connect("demo.nats.io:4222").await?;
/// let jetstream = async_nats::jetstream::new(client);
/// let kv = jetstream.create_key_value(async_nats::jetstream::kv::Config {
/// bucket: "kv".to_string(),
/// history: 10,
/// ..Default::default()
/// }).await?;
/// let mut entries = kv.watch("kv").await?;
/// while let Some(entry) = entries.next().await {
/// println!("entry: {:?}", entry);
/// }
/// # Ok(())
/// # }
/// ```
pub async fn watch<T: AsRef<str>>(&self, key: T) -> Result<Watch<'_>, Error> {
let subject = format!("{}{}", self.prefix.as_str(), key.as_ref());
let consumer = self
.stream
.create_consumer(super::consumer::push::OrderedConfig {
deliver_subject: self.stream.context.client.new_inbox(),
description: Some("kv watch consumer".to_string()),
filter_subject: subject,
replay_policy: super::consumer::ReplayPolicy::Instant,
deliver_policy: DeliverPolicy::New,
..Default::default()
})
.await?;
Ok(Watch {
subscription: consumer.messages().await?,
prefix: self.prefix.clone(),
bucket: self.name.clone(),
})
}
/// Creates a [futures::Stream] over [Entries][Entry] for all keys, which yields
/// values whenever there are changes in the bucket.
///
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// use futures::StreamExt;
/// let client = async_nats::connect("demo.nats.io:4222").await?;
/// let jetstream = async_nats::jetstream::new(client);
/// let kv = jetstream.create_key_value(async_nats::jetstream::kv::Config {
/// bucket: "kv".to_string(),
/// history: 10,
/// ..Default::default()
/// }).await?;
/// let mut entries = kv.watch_all().await?;
/// while let Some(entry) = entries.next().await {
/// println!("entry: {:?}", entry);
/// }
/// # Ok(())
/// # }
/// ```
pub async fn watch_all(&self) -> Result<Watch<'_>, Error> {
self.watch(ALL_KEYS).await
}
pub async fn get<T: Into<String>>(&self, key: T) -> Result<Option<Vec<u8>>, Error> {
match self.entry(key).await {
Ok(Some(entry)) => match entry.operation {
Operation::Put => Ok(Some(entry.value)),
_ => Ok(None),
},
Ok(None) => Ok(None),
Err(err) => Err(err),
}
}
/// Updates a value for a given key, but only if passed `revision` is the last `revision` in
/// the bucket.
///
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// use futures::StreamExt;
/// let client = async_nats::connect("demo.nats.io:4222").await?;
/// let jetstream = async_nats::jetstream::new(client);
/// let kv = jetstream.create_key_value(async_nats::jetstream::kv::Config {
/// bucket: "kv".to_string(),
/// history: 10,
/// ..Default::default()
/// }).await?;
/// let revision = kv.put("key", "value".into()).await?;
/// kv.update("key", "updated".into(), revision).await?;
/// # Ok(())
/// # }
/// ```
pub async fn update<T: AsRef<str>>(
&self,
key: T,
value: Bytes,
revision: u64,
) -> Result<u64, Error> {
if !is_valid_key(key.as_ref()) {
return Err(Box::new(io::Error::new(
io::ErrorKind::InvalidInput,
"invalid key",
)));
}
let subject = format!("{}{}", self.prefix.as_str(), key.as_ref());
let mut headers = crate::HeaderMap::default();
headers.insert(
header::NATS_EXPECTED_LAST_SUBJECT_SEQUENCE,
HeaderValue::from(revision),
);
self.stream
.context
.publish_with_headers(subject, headers, value)
.await?
.await
.map(|publish_ack| publish_ack.sequence)
}
/// Deletes a given key. This is a non-destructive operation, which sets a `DELETE` marker.
///
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// use futures::StreamExt;
/// let client = async_nats::connect("demo.nats.io:4222").await?;
/// let jetstream = async_nats::jetstream::new(client);
/// let kv = jetstream.create_key_value(async_nats::jetstream::kv::Config {
/// bucket: "kv".to_string(),
/// history: 10,
/// ..Default::default()
/// }).await?;
/// kv.put("key", "value".into()).await?;
/// kv.delete("key").await?;
/// # Ok(())
/// # }
/// ```
pub async fn delete<T: AsRef<str>>(&self, key: T) -> Result<(), Error> {
if !is_valid_key(key.as_ref()) {
return Err(Box::new(io::Error::new(
io::ErrorKind::InvalidInput,
"invalid key",
)));
}
let mut subject = String::new();
if self.use_jetstream_prefix {
subject.push_str(&self.stream.context.prefix);
subject.push('.');
}
subject.push_str(self.put_prefix.as_ref().unwrap_or(&self.prefix));
subject.push_str(key.as_ref());
let mut headers = crate::HeaderMap::default();
// TODO: figure out which headers k/v should be where.
headers.insert(KV_OPERATION, KV_OPERATION_DELETE.parse::<HeaderValue>()?);
self.stream
.context
.publish_with_headers(subject, headers, "".into())
.await?
.await?;
Ok(())
}
/// Purges all the revisions of a entry destructively, leaving behind a single purge entry in-place.
///
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// use futures::StreamExt;
/// let client = async_nats::connect("demo.nats.io:4222").await?;
/// let jetstream = async_nats::jetstream::new(client);
/// let kv = jetstream.create_key_value(async_nats::jetstream::kv::Config {
/// bucket: "kv".to_string(),
/// history: 10,
/// ..Default::default()
/// }).await?;
/// kv.put("key", "value".into()).await?;
/// kv.put("key", "another".into()).await?;
/// kv.purge("key").await?;
/// # Ok(())
/// # }
/// ```
pub async fn purge<T: AsRef<str>>(&self, key: T) -> Result<(), Error> {
if !is_valid_key(key.as_ref()) {
return Err(Box::new(io::Error::new(
io::ErrorKind::InvalidInput,
"invalid key",
)));
}
let subject = format!("{}{}", self.prefix.as_str(), key.as_ref());
let mut headers = crate::HeaderMap::default();
headers.insert(KV_OPERATION, HeaderValue::from(KV_OPERATION_PURGE));
headers.insert(NATS_ROLLUP, HeaderValue::from(ROLLUP_SUBJECT));
self.stream
.context
.publish_with_headers(subject, headers, "".into())
.await?
.await?;
Ok(())
}
/// Returns a [futures::Stream] that allows iterating over all [Operations][Operation] that
/// happen for given key.
///
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// use futures::StreamExt;
/// let client = async_nats::connect("demo.nats.io:4222").await?;
/// let jetstream = async_nats::jetstream::new(client);
/// let kv = jetstream.create_key_value(async_nats::jetstream::kv::Config {
/// bucket: "kv".to_string(),
/// history: 10,
/// ..Default::default()
/// }).await?;
/// let mut entries = kv.history("kv").await?;
/// while let Some(entry) = entries.next().await {
/// println!("entry: {:?}", entry);
/// }
/// # Ok(())
/// # }
/// ```
pub async fn history<T: AsRef<str>>(&self, key: T) -> Result<History<'_>, Error> {
if !is_valid_key(key.as_ref()) {
return Err(Box::new(io::Error::new(
io::ErrorKind::InvalidInput,
"invalid key",
)));
}
let subject = format!("{}{}", self.prefix.as_str(), key.as_ref());
let consumer = self
.stream
.create_consumer(super::consumer::push::OrderedConfig {
deliver_subject: self.stream.context.client.new_inbox(),
description: Some("kv history consumer".to_string()),
filter_subject: subject,
replay_policy: super::consumer::ReplayPolicy::Instant,
..Default::default()
})
.await?;
Ok(History {
subscription: consumer.messages().await?,
done: false,
prefix: self.prefix.clone(),
bucket: self.name.clone(),
})
}
/// Returns a [futures::Stream] that allows iterating over all keys in the bucket.
///
/// # Examples
///
/// Iterating over each each key individually
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// use futures::{StreamExt, TryStreamExt};
/// let client = async_nats::connect("demo.nats.io:4222").await?;
/// let jetstream = async_nats::jetstream::new(client);
/// let kv = jetstream.create_key_value(async_nats::jetstream::kv::Config {
/// bucket: "kv".to_string(),
/// history: 10,
/// ..Default::default()
/// }).await?;
/// let mut keys = kv.keys().await?.boxed();
/// while let Some(key) = keys.try_next().await? {
/// println!("key: {:?}", key);
/// }
/// # Ok(())
/// # }
/// ```
///
/// Collecting it into a vector of keys
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// use futures::TryStreamExt;
/// let client = async_nats::connect("demo.nats.io:4222").await?;
/// let jetstream = async_nats::jetstream::new(client);
/// let kv = jetstream.create_key_value(async_nats::jetstream::kv::Config {
/// bucket: "kv".to_string(),
/// history: 10,
/// ..Default::default()
/// }).await?;
/// let keys = kv.keys().await?.try_collect::<Vec<String>>().await?;
/// println!("Keys: {:?}", keys);
/// # Ok(())
/// # }
/// ```
pub async fn keys(&self) -> Result<Keys, Error> {
let subject = format!("{}>", self.prefix.as_str());
let consumer = self
.stream
.create_consumer(super::consumer::push::OrderedConfig {
deliver_subject: self.stream.context.client.new_inbox(),
description: Some("kv history consumer".to_string()),
filter_subject: subject,
headers_only: true,
replay_policy: super::consumer::ReplayPolicy::Instant,
// We only need to know the latest state for each key, not the whole history
deliver_policy: DeliverPolicy::LastPerSubject,
..Default::default()
})
.await?;
let entries = History {
done: consumer.info.num_pending == 0,
subscription: consumer.messages().await?,
prefix: self.prefix.clone(),
bucket: self.name.clone(),
};
Ok(Keys { inner: entries })
}
}
pub struct Watch<'a> {
subscription: super::consumer::push::Ordered<'a>,
prefix: String,
bucket: String,
}
impl<'a> futures::Stream for Watch<'a> {
type Item = Result<Entry, Error>;
fn poll_next(
mut self: std::pin::Pin<&mut Self>,
cx: &mut std::task::Context<'_>,
) -> std::task::Poll<Option<Self::Item>> {
match self.subscription.poll_next_unpin(cx) {
Poll::Ready(message) => match message {
None => Poll::Ready(None),
Some(message) => {
let message = message?;
let info = message.info()?;
let operation = match message
.headers
.as_ref()
.and_then(|headers| headers.get(KV_OPERATION))
.unwrap_or(&HeaderValue::from(KV_OPERATION_PUT))
.iter()
.next()
.unwrap()
.as_str()
{
KV_OPERATION_DELETE => Operation::Delete,
KV_OPERATION_PURGE => Operation::Purge,
_ => Operation::Put,
};
let key = message
.subject
.strip_prefix(&self.prefix)
.map(|s| s.to_string())
.unwrap();
Poll::Ready(Some(Ok(Entry {
bucket: self.bucket.clone(),
key,
value: message.payload.to_vec(),
revision: info.stream_sequence,
created: info.published,
delta: info.pending,
operation,
})))
}
},
std::task::Poll::Pending => Poll::Pending,
}
}
fn size_hint(&self) -> (usize, Option<usize>) {
(0, None)
}
}
pub struct History<'a> {
subscription: super::consumer::push::Ordered<'a>,
done: bool,
prefix: String,
bucket: String,
}
impl<'a> futures::Stream for History<'a> {
type Item = Result<Entry, Error>;
fn poll_next(
mut self: std::pin::Pin<&mut Self>,
cx: &mut std::task::Context<'_>,
) -> std::task::Poll<Option<Self::Item>> {
if self.done {
return Poll::Ready(None);
}
match self.subscription.poll_next_unpin(cx) {
Poll::Ready(message) => match message {
None => Poll::Ready(None),
Some(message) => {
let message = message?;
let info = message.info()?;
if info.pending == 0 {
self.done = true;
}
let operation = match message
.headers
.as_ref()
.and_then(|headers| headers.get(KV_OPERATION))
.unwrap_or(&HeaderValue::from(KV_OPERATION_PUT))
.iter()
.next()
.unwrap()
.as_str()
{
KV_OPERATION_DELETE => Operation::Delete,
KV_OPERATION_PURGE => Operation::Purge,
_ => Operation::Put,
};
let key = message
.subject
.strip_prefix(&self.prefix)
.map(|s| s.to_string())
.unwrap();
Poll::Ready(Some(Ok(Entry {
bucket: self.bucket.clone(),
key,
value: message.payload.to_vec(),
revision: info.stream_sequence,
created: info.published,
delta: info.pending,
operation,
})))
}
},
std::task::Poll::Pending => Poll::Pending,
}
}
fn size_hint(&self) -> (usize, Option<usize>) {
(0, None)
}
}
pub struct Keys<'a> {
inner: History<'a>,
}
impl<'a> futures::Stream for Keys<'a> {
type Item = Result<String, Error>;
fn poll_next(
mut self: std::pin::Pin<&mut Self>,
cx: &mut std::task::Context<'_>,
) -> std::task::Poll<Option<Self::Item>> {
loop {
match self.inner.poll_next_unpin(cx) {
Poll::Ready(None) => return Poll::Ready(None),
Poll::Ready(Some(res)) => match res {
Ok(entry) => {
// Skip purged and deleted keys
if matches!(entry.operation, Operation::Purge | Operation::Delete) {
// Try to poll again if we skip this one
continue;
} else {
return Poll::Ready(Some(Ok(entry.key)));
}
}
Err(e) => return Poll::Ready(Some(Err(e))),
},
Poll::Pending => return Poll::Pending,
}
}
}
}
/// An entry in a key-value bucket.
#[derive(Debug, Clone)]
pub struct Entry {
/// Name of the bucket the entry is in.
pub bucket: String,
/// The key that was retrieved.
pub key: String,
/// The value that was retrieved.
// TODO: should we use Bytes?
pub value: Vec<u8>,
/// A unique sequence for this value.
pub revision: u64,
/// Distance from the latest value.
pub delta: u64,
/// The time the data was put in the bucket.
pub created: OffsetDateTime,
/// The kind of operation that caused this entry.
pub operation: Operation,
}