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
use anyhow::Result;
use noosphere_core::data::{Did, IdentityIpld, Jwt, Link, MapOperation, MemoIpld};
use std::{collections::BTreeSet, marker::PhantomData};
use async_stream::try_stream;
use noosphere_storage::Storage;
use tokio::io::AsyncRead;
use tokio_stream::{Stream, StreamExt};
use crate::{
content::{SphereContentRead, SphereFile},
internal::SphereContextInternal,
HasSphereContext, SphereAuthorityRead, SpherePetnameRead,
};
/// A [SphereWalker] makes it possible to convert anything that implements
/// [HasSphereContext] into an async [Stream] over sphere content, allowing
/// incremental iteration over both the breadth of content at any version, or
/// the depth of changes over a range of history.
pub struct SphereWalker<'a, C, S>
where
C: HasSphereContext<S>,
S: Storage + 'static,
{
has_sphere_context: &'a C,
storage: PhantomData<S>,
}
impl<'a, C, S> From<&'a C> for SphereWalker<'a, C, S>
where
C: HasSphereContext<S>,
S: Storage + 'static,
{
fn from(has_sphere_context: &'a C) -> Self {
SphereWalker {
has_sphere_context,
storage: Default::default(),
}
}
}
impl<'a, C, S> SphereWalker<'a, C, S>
where
C: SphereAuthorityRead<S> + HasSphereContext<S>,
S: Storage + 'static,
{
/// Get a stream that yields a link to every authorization to access the
/// sphere along with its corresponding [DelegationIpld]. Note that since a
/// revocation may be issued without necessarily removing its revoked
/// delegation, this will yield all authorizations regardless of revocation
/// status.
pub fn authorization_stream(
&self,
) -> impl Stream<Item = Result<(String, Did, Link<Jwt>)>> + '_ {
try_stream! {
let sphere = self.has_sphere_context.to_sphere().await?;
let delegations = sphere.get_authority().await?.get_delegations().await?;
let stream = delegations.into_stream().await?;
for await entry in stream {
let (link, delegation) = entry?;
let ucan = delegation.resolve_ucan(sphere.store()).await?;
yield (delegation.name, Did(ucan.audience().to_string()), link);
}
}
}
/// Get a [BTreeSet] whose members are all the [Link<Jwt>]s to
/// authorizations that enable sphere access as of this version of the
/// sphere. Note that the full space of authoriztions may be very large; for
/// a more space-efficient approach, use
/// [SphereWalker::authorization_stream] to incrementally access all
/// authorizations in the sphere.
///
/// This method is forgiving of missing or corrupted data, and will yield an
/// incomplete set of authorizations in the case that some or all names are
/// not able to be accessed.
pub async fn list_authorizations(&self) -> Result<BTreeSet<Link<Jwt>>> {
let sphere_identity = self.has_sphere_context.identity().await?;
let authorization_stream = self.authorization_stream();
tokio::pin!(authorization_stream);
Ok(authorization_stream
.fold(BTreeSet::new(), |mut delegations, another_delegation| {
match another_delegation {
Ok((_, _, delegation)) => {
delegations.insert(delegation);
}
Err(error) => {
warn!(
"Could not read a petname from {}: {}",
sphere_identity, error
)
}
};
delegations
})
.await)
}
}
impl<'a, C, S> SphereWalker<'a, C, S>
where
C: SpherePetnameRead<S> + HasSphereContext<S>,
S: Storage + 'static,
{
/// Same as [SphereWalker::petname_stream], but consumes the [SphereWalker].
/// This is useful in cases where it would otherwise be necessary to borrow
/// a reference to [SphereWalker] for a static lifetime.
pub fn into_petname_stream(self) -> impl Stream<Item = Result<(String, IdentityIpld)>> + 'a {
try_stream! {
let sphere = self.has_sphere_context.to_sphere().await?;
let petnames = sphere.get_address_book().await?.get_identities().await?;
let stream = petnames.into_stream().await?;
for await entry in stream {
let (petname, address) = entry?;
yield (petname, address);
}
}
}
/// Get a stream that yields every petname in the namespace along with its
/// corresponding [AddressIpld]. This is useful for iterating over sphere
/// petnames incrementally without having to load the entire index into
/// memory at once.
pub fn petname_stream(&self) -> impl Stream<Item = Result<(String, IdentityIpld)>> + '_ {
try_stream! {
let sphere = self.has_sphere_context.to_sphere().await?;
let petnames = sphere.get_address_book().await?.get_identities().await?;
let stream = petnames.into_stream().await?;
for await entry in stream {
let (petname, address) = entry?;
yield (petname, address);
}
}
}
/// Get a stream that yields the set of petnames that changed at each
/// revision of the backing sphere, up to but excluding an optional `since`
/// CID parameter. To stream the entire history, pass `None` as the
/// parameter.
pub fn petname_change_stream<'b>(
&'b self,
since: Option<&'a Link<MemoIpld>>,
) -> impl Stream<Item = Result<(Link<MemoIpld>, BTreeSet<String>)>> + 'b {
try_stream! {
let sphere = self.has_sphere_context.to_sphere().await?;
let since = since.cloned();
let stream = sphere.into_identities_changelog_stream(since.as_ref());
for await change in stream {
let (cid, changelog) = change?;
let mut changed_petnames = BTreeSet::new();
for operation in changelog.changes {
let petname = match operation {
MapOperation::Add { key, .. } => key,
MapOperation::Remove { key } => key,
};
changed_petnames.insert(petname);
}
yield (cid, changed_petnames);
}
}
}
/// Get a stream that yields the set of petnames that changed at each
/// revision of the backing sphere, up to but excluding an optional `since`
/// CID parameter. To stream the entire history, pass `None` as the
/// parameter.
pub fn into_petname_change_stream(
self,
since: Option<&'a Link<MemoIpld>>,
) -> impl Stream<Item = Result<(Link<MemoIpld>, BTreeSet<String>)>> + '_ {
try_stream! {
let sphere = self.has_sphere_context.to_sphere().await?;
let since = since.cloned();
let stream = sphere.into_identities_changelog_stream(since.as_ref());
for await change in stream {
let (cid, changelog) = change?;
let mut changed_petnames = BTreeSet::new();
for operation in changelog.changes {
let petname = match operation {
MapOperation::Add { key, .. } => key,
MapOperation::Remove { key } => key,
};
changed_petnames.insert(petname);
}
yield (cid, changed_petnames);
}
}
}
/// Get a [BTreeSet] whose members are all the petnames that have addresses
/// as of this version of the sphere. Note that the full space of names may
/// be very large; for a more space-efficient approach, use
/// [SphereWalker::petname_stream] to incrementally access all petnames in
/// the sphere.
///
/// This method is forgiving of missing or corrupted data, and will yield an
/// incomplete set of names in the case that some or all names are not able
/// to be accessed.
pub async fn list_petnames(&self) -> Result<BTreeSet<String>> {
let sphere_identity = self.has_sphere_context.identity().await?;
let petname_stream = self.petname_stream();
tokio::pin!(petname_stream);
Ok(petname_stream
.fold(BTreeSet::new(), |mut petnames, another_petname| {
match another_petname {
Ok((petname, _)) => {
petnames.insert(petname);
}
Err(error) => {
warn!(
"Could not read a petname from {}: {}",
sphere_identity, error
)
}
};
petnames
})
.await)
}
/// Get a [BTreeSet] whose members are all the petnames whose values have
/// changed at least once since the provided version of the sphere
/// (exclusive of the provided version; use `None` to get all petnames
/// changed since the beginning of the sphere's history).
///
/// This method is forgiving of missing or corrupted history, and will yield
/// an incomplete set of changes in the case that some or all changes are
/// not able to be accessed.
///
/// Note that this operation will scale in memory consumption and duration
/// proportionally to the size of the sphere and the length of its history.
/// For a more efficient method of accessing changes, consider using
/// [SphereWalker::petname_change_stream] instead.
pub async fn petname_changes(
&self,
since: Option<&Link<MemoIpld>>,
) -> Result<BTreeSet<String>> {
let sphere_identity = self.has_sphere_context.identity().await?;
let change_stream = self.petname_change_stream(since);
tokio::pin!(change_stream);
Ok(change_stream
.fold(BTreeSet::new(), |mut all, some| {
match some {
Ok((_, mut changes)) => all.append(&mut changes),
Err(error) => warn!(
"Could not read some changes from {}: {}",
sphere_identity, error
),
};
all
})
.await)
}
}
impl<'a, C, S> SphereWalker<'a, C, S>
where
C: SphereContentRead<S> + HasSphereContext<S>,
S: Storage + 'static,
{
/// Same as [SphereWalker::content_stream], but consumes the [SphereWalker].
/// This is useful in cases where it would otherwise be necessary to borrow
/// a reference to [SphereWalker] for a static lifetime.
pub fn into_content_stream(
self,
) -> impl Stream<Item = Result<(String, SphereFile<impl AsyncRead>)>> + 'a {
try_stream! {
let sphere = self.has_sphere_context.to_sphere().await?;
let content = sphere.get_content().await?;
let stream = content.into_stream().await?;
for await entry in stream {
let (key, memo_link) = entry?;
let file = self.has_sphere_context.get_file(sphere.cid(), memo_link).await?;
yield (key.clone(), file);
}
}
}
/// Get a stream that yields every slug in the namespace along with its
/// corresponding [SphereFile]. This is useful for iterating over sphere
/// content incrementally without having to load the entire index into
/// memory at once.
pub fn content_stream(
&self,
) -> impl Stream<Item = Result<(String, SphereFile<impl AsyncRead>)>> + '_ {
try_stream! {
let sphere = self.has_sphere_context.to_sphere().await?;
let links = sphere.get_content().await?;
let stream = links.into_stream().await?;
for await entry in stream {
let (key, memo) = entry?;
let file = self.has_sphere_context.get_file(sphere.cid(), memo).await?;
yield (key.clone(), file);
}
}
}
/// Get a stream that yields the set of slugs that changed at each revision
/// of the backing sphere, up to but excluding an optional CID. To stream
/// the entire history, pass `None` as the parameter.
pub fn into_content_change_stream(
self,
since: Option<&'a Link<MemoIpld>>,
) -> impl Stream<Item = Result<(Link<MemoIpld>, BTreeSet<String>)>> + '_ {
try_stream! {
let sphere = self.has_sphere_context.to_sphere().await?;
let since = since.cloned();
let stream = sphere.into_content_changelog_stream(since.as_ref());
for await change in stream {
let (cid, changelog) = change?;
let mut changed_slugs = BTreeSet::new();
for operation in changelog.changes {
let slug = match operation {
MapOperation::Add { key, .. } => key,
MapOperation::Remove { key } => key,
};
changed_slugs.insert(slug);
}
yield (cid, changed_slugs);
}
}
}
/// Get a stream that yields the set of slugs that changed at each revision
/// of the backing sphere, up to but excluding an optional CID. To stream
/// the entire history, pass `None` as the parameter.
pub fn content_change_stream<'b>(
&'b self,
since: Option<&'b Link<MemoIpld>>,
) -> impl Stream<Item = Result<(Link<MemoIpld>, BTreeSet<String>)>> + 'b {
try_stream! {
let sphere = self.has_sphere_context.to_sphere().await?;
let since = since.cloned();
let stream = sphere.into_content_changelog_stream(since.as_ref());
for await change in stream {
let (cid, changelog) = change?;
let mut changed_slugs = BTreeSet::new();
for operation in changelog.changes {
let slug = match operation {
MapOperation::Add { key, .. } => key,
MapOperation::Remove { key } => key,
};
changed_slugs.insert(slug);
}
yield (cid, changed_slugs);
}
}
}
/// Get a [BTreeSet] whose members are all the slugs that have values as of
/// this version of the sphere. Note that the full space of slugs may be
/// very large; for a more space-efficient approach, use
/// [SphereWalker::content_stream] or [SphereWalker::into_content_stream] to
/// incrementally access all slugs in the sphere.
///
/// This method is forgiving of missing or corrupted data, and will yield an
/// incomplete set of links in the case that some or all links are not able
/// to be accessed.
pub async fn list_slugs(&self) -> Result<BTreeSet<String>> {
let sphere_identity = self.has_sphere_context.identity().await?;
let link_stream = self.content_stream();
tokio::pin!(link_stream);
Ok(link_stream
.fold(BTreeSet::new(), |mut links, another_link| {
match another_link {
Ok((slug, _)) => {
links.insert(slug);
}
Err(error) => {
warn!("Could not read a link from {}: {}", sphere_identity, error)
}
};
links
})
.await)
}
/// Get a [BTreeSet] whose members are all the slugs whose values have
/// changed at least once since the provided version of the sphere
/// (exclusive of the provided version; use `None` to get all slugs changed
/// since the beginning of the sphere's history).
///
/// This method is forgiving of missing or corrupted history, and will yield
/// an incomplete set of changes in the case that some or all changes are
/// not able to be accessed.
///
/// Note that this operation will scale in memory consumption and duration
/// proportionally to the size of the sphere and the length of its history.
/// For a more efficient method of accessing changes, consider using
/// [SphereWalker::content_change_stream] instead.
pub async fn content_changes(
&self,
since: Option<&Link<MemoIpld>>,
) -> Result<BTreeSet<String>> {
let sphere_identity = self.has_sphere_context.identity().await?;
let change_stream = self.content_change_stream(since);
tokio::pin!(change_stream);
Ok(change_stream
.fold(BTreeSet::new(), |mut all, some| {
match some {
Ok((_, mut changes)) => all.append(&mut changes),
Err(error) => warn!(
"Could not read some changes from {}: {}",
sphere_identity, error
),
};
all
})
.await)
}
}
#[cfg(test)]
mod tests {
use anyhow::Result;
use std::collections::BTreeSet;
use noosphere_core::data::{ContentType, Did};
use tokio::io::AsyncReadExt;
use tokio_stream::StreamExt;
#[cfg(target_arch = "wasm32")]
use wasm_bindgen_test::wasm_bindgen_test;
#[cfg(target_arch = "wasm32")]
wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);
use super::SphereWalker;
use crate::helpers::{simulated_sphere_context, SimulationAccess};
use crate::{HasMutableSphereContext, SphereAuthorityWrite, SphereContentWrite, SphereCursor};
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
#[cfg_attr(not(target_arch = "wasm32"), tokio::test)]
async fn it_can_be_initialized_with_a_context_or_a_cursor() {
let (sphere_context, _) = simulated_sphere_context(SimulationAccess::ReadWrite, None)
.await
.unwrap();
let mut cursor = SphereCursor::latest(sphere_context.clone());
let changes = vec![
vec!["dogs", "birds"],
vec!["cats", "dogs"],
vec!["birds"],
vec!["cows", "beetles"],
];
for change in changes {
for slug in change {
cursor
.write(slug, &ContentType::Subtext, b"are cool".as_ref(), None)
.await
.unwrap();
}
cursor.save(None).await.unwrap();
}
let walker_cursor = SphereWalker::from(&cursor);
let walker_context = SphereWalker::from(&sphere_context);
let slugs_cursor = walker_cursor.list_slugs().await.unwrap();
let slugs_context = walker_context.list_slugs().await.unwrap();
assert_eq!(slugs_cursor.len(), 5);
assert_eq!(slugs_cursor, slugs_context);
}
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
#[cfg_attr(not(target_arch = "wasm32"), tokio::test)]
async fn it_can_list_all_slugs_currently_in_a_sphere() {
let (sphere_context, _) = simulated_sphere_context(SimulationAccess::ReadWrite, None)
.await
.unwrap();
let mut cursor = SphereCursor::latest(sphere_context);
let changes = vec![
vec!["dogs", "birds"],
vec!["cats", "dogs"],
vec!["birds"],
vec!["cows", "beetles"],
];
for change in changes {
for slug in change {
cursor
.write(slug, &ContentType::Subtext, b"are cool".as_ref(), None)
.await
.unwrap();
}
cursor.save(None).await.unwrap();
}
let walker_cursor = cursor.clone();
let walker = SphereWalker::from(&walker_cursor);
let slugs = walker.list_slugs().await.unwrap();
assert_eq!(slugs.len(), 5);
cursor.remove("dogs").await.unwrap();
cursor.save(None).await.unwrap();
let slugs = walker.list_slugs().await.unwrap();
assert_eq!(slugs.len(), 4);
}
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
#[cfg_attr(not(target_arch = "wasm32"), tokio::test)]
async fn it_can_list_all_authorizations_currently_in_a_sphere() -> Result<()> {
let (sphere_context, _) =
simulated_sphere_context(SimulationAccess::ReadWrite, None).await?;
let mut cursor = SphereCursor::latest(sphere_context);
let authorizations_to_add = 10;
for i in 0..authorizations_to_add {
cursor
.authorize(&format!("foo{}", i), &Did(format!("did:key:foo{}", i)))
.await?;
}
cursor.save(None).await?;
let authorizations = SphereWalker::from(&cursor).list_authorizations().await?;
assert_eq!(authorizations.len(), authorizations_to_add + 1);
Ok(())
}
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
#[cfg_attr(not(target_arch = "wasm32"), tokio::test)]
async fn it_can_stream_the_whole_index() {
let (sphere_context, _) = simulated_sphere_context(SimulationAccess::ReadWrite, None)
.await
.unwrap();
let mut cursor = SphereCursor::latest(sphere_context);
let expected = BTreeSet::<(String, String)>::from([
("cats".into(), "Cats are awesome".into()),
("dogs".into(), "Dogs are pretty cool".into()),
("birds".into(), "Birds rights".into()),
("mice".into(), "Mice like cookies".into()),
]);
for (slug, content) in &expected {
cursor
.write(slug.as_str(), &ContentType::Subtext, content.as_ref(), None)
.await
.unwrap();
cursor.save(None).await.unwrap();
}
let mut actual = BTreeSet::new();
let walker = SphereWalker::from(&cursor);
let stream = walker.content_stream();
tokio::pin!(stream);
while let Some(Ok((slug, mut file))) = stream.next().await {
let mut contents = String::new();
file.contents.read_to_string(&mut contents).await.unwrap();
actual.insert((slug, contents));
}
assert_eq!(expected, actual);
}
}