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
//! Synchronization types that are used internally.
use crate::sdk::{
commit::{CommitState, Comparison},
events::{AccountDiff, CheckedPatch, EventLogExt, FolderDiff},
storage::StorageEventLogs,
vault::VaultId,
Error, Result,
};
use crate::{
CreateSet, MaybeDiff, MergeOutcome, Origin, SyncCompare, SyncDiff,
SyncStatus,
};
use async_trait::async_trait;
use indexmap::IndexMap;
use std::{
collections::{HashMap, HashSet},
fmt,
};
use crate::sdk::events::DeviceDiff;
#[cfg(feature = "files")]
use crate::sdk::events::FileDiff;
/// How to resolve hard conflicts.
#[derive(Default, Debug)]
pub enum HardConflictResolver {
/// Automatically fetch and overwrite account data.
#[default]
AutomaticFetch,
}
/// Options for sync operation.
#[derive(Default, Debug)]
pub struct SyncOptions {
/// Only sync these origins.
pub origins: Vec<Origin>,
/// Resolver for hard conflicts.
pub hard_conflict_resolver: HardConflictResolver,
}
/// Error type that can be returned from a sync operation.
#[derive(Debug)]
pub struct SyncError<T: std::error::Error> {
/// Errors generated during a sync operation.
pub errors: Vec<(Origin, T)>,
}
impl<T: std::error::Error> std::error::Error for SyncError<T> {}
impl<T: std::error::Error> fmt::Display for SyncError<T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
for (_, e) in self.errors.iter() {
write!(f, "{}", e)?;
}
Ok(())
}
}
impl<T: std::error::Error> SyncError<T> {
/// Convert to an option.
pub fn into_option(self) -> Option<Self> {
if self.errors.is_empty() {
None
} else {
Some(self)
}
}
}
impl<T: std::error::Error> Default for SyncError<T> {
fn default() -> Self {
Self { errors: Vec::new() }
}
}
/// Options for folder merge.
pub(crate) enum FolderMergeOptions<'a> {
/// Update a URN lookup when merging.
Urn(VaultId, &'a mut crate::sdk::identity::UrnLookup),
/// Update a search index when merging.
#[cfg(feature = "search")]
Search(VaultId, &'a mut crate::sdk::storage::search::SearchIndex),
}
/// Information about possible conflicts.
#[derive(Debug, Default, Eq, PartialEq)]
pub struct MaybeConflict {
/// Whether the identity folder might be conflicted.
pub identity: bool,
/// Whether the account log might be conflicted.
pub account: bool,
/// Whether the device log might be conflicted.
pub device: bool,
/// Whether the files log might be conflicted.
#[cfg(feature = "files")]
pub files: bool,
/// Account folders that might be conflicted.
pub folders: IndexMap<VaultId, bool>,
}
impl MaybeConflict {
/// Check for any conflicts.
pub fn has_conflicts(&self) -> bool {
let mut has_conflicts = self.identity || self.account || self.device;
#[cfg(feature = "files")]
{
has_conflicts = has_conflicts || self.files;
}
for (_, value) in &self.folders {
has_conflicts = has_conflicts || *value;
if has_conflicts {
break;
}
}
has_conflicts
}
}
/// Comparison between local and remote status.
#[derive(Debug)]
pub struct SyncComparison {
/// Local sync status.
pub local_status: SyncStatus,
/// Remote sync status.
pub remote_status: SyncStatus,
/// Comparison of the identity event log.
pub identity: Comparison,
/// Comparison of the account event log.
pub account: Comparison,
/// Comparison of the device event log.
pub device: Comparison,
/// Comparison of the files event log.
#[cfg(feature = "files")]
pub files: Option<Comparison>,
/// Comparison for each folder in the account.
pub folders: IndexMap<VaultId, Comparison>,
}
impl SyncComparison {
/// Create a new sync comparison.
pub async fn new(
storage: &impl SyncStorage,
remote_status: SyncStatus,
) -> Result<SyncComparison> {
let local_status = storage.sync_status().await?;
let identity = {
let identity = storage.identity_log().await?;
let reader = identity.read().await;
reader.tree().compare(&remote_status.identity.1)?
};
let account = {
let account = storage.account_log().await?;
let reader = account.read().await;
reader.tree().compare(&remote_status.account.1)?
};
let device = {
let device = storage.device_log().await?;
let reader = device.read().await;
reader.tree().compare(&remote_status.device.1)?
};
#[cfg(feature = "files")]
let files = {
let files = storage.file_log().await?;
let reader = files.read().await;
if let Some(files) = &remote_status.files {
if reader.tree().is_empty() {
None
} else {
Some(reader.tree().compare(&files.1)?)
}
} else if reader.tree().is_empty() {
None
} else {
Some(Comparison::Unknown)
}
};
let folders = {
let mut folders = IndexMap::new();
for (id, folder) in &remote_status.folders {
// Folder may exist on remote but not locally
// if we have just deleted a folder
if let Ok(event_log) = storage.folder_log(id).await {
let event_log = event_log.read().await;
folders.insert(*id, event_log.tree().compare(&folder.1)?);
}
}
folders
};
Ok(SyncComparison {
local_status,
remote_status,
identity,
account,
device,
#[cfg(feature = "files")]
files,
folders,
})
}
/// Determine if synchronization is required.
pub fn needs_sync(&self) -> bool {
self.local_status != self.remote_status
}
/// Build a diff from this comparison.
///
/// The diff includes changes on local that are not yet
/// present on the remote or information that will allow
/// a comparison on the remote.
pub async fn diff(&self, storage: &impl SyncStorage) -> Result<SyncDiff> {
let mut diff: SyncDiff = Default::default();
match self.identity {
Comparison::Equal => {}
Comparison::Contains(_) => {
// Need to push changes to remote
let log = storage.identity_log().await?;
let reader = log.read().await;
let is_last_commit = Some(&self.remote_status.identity.0)
== reader.tree().last_commit().as_ref();
// Avoid empty patches when commit is already the last
if !is_last_commit {
/*
let identity = FolderDiff {
last_commit: Some(self.remote_status.identity.0),
patch: reader
.diff(Some(&self.remote_status.identity.0))
.await?,
checkpoint: self.remote_status.identity.1.clone(),
};
*/
let identity = reader
.diff_checked(
Some(self.remote_status.identity.0),
self.remote_status.identity.1.clone(),
)
.await?;
diff.identity = Some(MaybeDiff::Diff(identity));
}
}
Comparison::Unknown => {
tracing::info!(
local = ?self.local_status.identity,
remote = ?self.remote_status.identity,
"identity folder divergence"
);
diff.identity = Some(MaybeDiff::Compare(Some(
self.local_status.identity.clone(),
)));
}
}
match self.account {
Comparison::Equal => {}
Comparison::Contains(_) => {
// Need to push changes to remote
let log = storage.account_log().await?;
let reader = log.read().await;
let is_last_commit = Some(&self.remote_status.account.0)
== reader.tree().last_commit().as_ref();
// Avoid empty patches when commit is already the last
if !is_last_commit {
/*
let account = AccountDiff {
last_commit: Some(self.remote_status.account.0),
patch: reader
.diff(Some(&self.remote_status.account.0))
.await?,
checkpoint: self.remote_status.account.1.clone(),
};
*/
let account = reader
.diff_checked(
Some(self.remote_status.account.0),
self.remote_status.account.1.clone(),
)
.await?;
diff.account = Some(MaybeDiff::Diff(account));
}
}
Comparison::Unknown => {
tracing::info!(
local = ?self.local_status.account,
remote = ?self.remote_status.account,
"account events divergence"
);
diff.account = Some(MaybeDiff::Compare(Some(
self.local_status.account.clone(),
)));
}
}
match self.device {
Comparison::Equal => {}
Comparison::Contains(_) => {
// Need to push changes to remote
let log = storage.device_log().await?;
let reader = log.read().await;
let is_last_commit = Some(&self.remote_status.device.0)
== reader.tree().last_commit().as_ref();
// Avoid empty patches when commit is already the last
if !is_last_commit {
/*
let device = DeviceDiff {
last_commit: Some(self.remote_status.device.0),
patch: reader
.diff(Some(&self.remote_status.device.0))
.await?,
checkpoint: self.remote_status.device.1.clone(),
};
*/
let device = reader
.diff_checked(
Some(self.remote_status.device.0),
self.remote_status.device.1.clone(),
)
.await?;
diff.device = Some(MaybeDiff::Diff(device));
}
}
Comparison::Unknown => {
tracing::info!(
local = ?self.local_status.device,
remote = ?self.remote_status.device,
"device events divergence"
);
// NOTE: this will break the device revoke test spec!
/*
diff.device = Some(MaybeDiff::Compare(Some(
self.local_status.device.clone(),
)));
*/
}
}
#[cfg(feature = "files")]
match (&self.files, &self.remote_status.files) {
(Some(files), Some(remote_files)) => {
match files {
Comparison::Equal => {}
Comparison::Contains(_) => {
// Need to push changes to remote
let log = storage.file_log().await?;
let reader = log.read().await;
let is_last_commit = Some(&remote_files.0)
== reader.tree().last_commit().as_ref();
// Avoid empty patches when commit is already the last
if !is_last_commit {
/*
let files = FileDiff {
last_commit: Some(remote_files.0),
patch: reader
.diff(Some(&remote_files.0))
.await?,
checkpoint: remote_files.1.clone(),
};
*/
let files = reader
.diff_checked(
Some(remote_files.0),
remote_files.1.clone(),
)
.await?;
diff.files = Some(MaybeDiff::Diff(files));
}
}
Comparison::Unknown => {
tracing::info!(
local = ?files,
remote = ?remote_files,
"file events divergence"
);
diff.files = Some(MaybeDiff::Compare(
self.local_status.files.clone(),
));
}
}
}
// Remote does not have any files yet so we need
// to send the entire file event log
(Some(Comparison::Unknown), None) => {
// Need to push changes to remote
let log = storage.file_log().await?;
let reader = log.read().await;
if !reader.tree().is_empty() {
let files = FileDiff {
last_commit: None,
patch: reader.diff_events(None).await?,
checkpoint: Default::default(),
};
diff.files = Some(MaybeDiff::Diff(files));
}
}
_ => {}
}
for (id, folder) in &self.folders {
let commit_state = self
.remote_status
.folders
.get(id)
.ok_or(Error::CacheNotAvailable(*id))?;
match folder {
Comparison::Equal => {}
Comparison::Contains(_) => {
// Need to push changes to remote
let log = storage.folder_log(id).await?;
let log = log.read().await;
/*
let folder = FolderDiff {
last_commit: Some(commit_state.0),
patch: log.diff(Some(&commit_state.0)).await?,
checkpoint: commit_state.1.clone(),
};
*/
let folder = log
.diff_checked(
Some(commit_state.0),
commit_state.1.clone(),
)
.await?;
if !folder.patch.is_empty() {
diff.folders.insert(*id, MaybeDiff::Diff(folder));
}
}
Comparison::Unknown => {
tracing::info!(
id = %id,
local = ?self.local_status.folders.get(id),
remote = ?commit_state,
"folder events divergence"
);
diff.folders.insert(
*id,
MaybeDiff::Compare(
self.local_status.folders.get(id).cloned(),
),
);
}
}
}
// Handle events for new folders on local that
// don't exist on remote yet
for (id, _) in &self.local_status.folders {
if self.remote_status.folders.get(id).is_none() {
let log = storage.folder_log(id).await?;
let log = log.read().await;
let first_commit = log.tree().first_commit()?;
let folder = FolderDiff {
last_commit: Some(first_commit.0),
patch: log.diff_events(Some(&first_commit.0)).await?,
checkpoint: first_commit.1,
};
if !folder.patch.is_empty() {
diff.folders.insert(*id, MaybeDiff::Diff(folder));
}
}
}
Ok(diff)
}
}
/// Storage implementations that can synchronize.
#[async_trait]
pub trait SyncStorage: StorageEventLogs {
/// Get the sync status.
async fn sync_status(&self) -> Result<SyncStatus>;
/// Change set of all event logs.
///
/// Used by network aware implementations to transfer
/// entire accounts.
async fn change_set(&self) -> Result<CreateSet> {
let identity = {
let log = self.identity_log().await?;
let reader = log.read().await;
reader.diff_events(None).await?
};
let account = {
let log = self.account_log().await?;
let reader = log.read().await;
reader.diff_events(None).await?
};
let device = {
let log = self.device_log().await?;
let reader = log.read().await;
reader.diff_events(None).await?
};
#[cfg(feature = "files")]
let files = {
let log = self.file_log().await?;
let reader = log.read().await;
reader.diff_events(None).await?
};
let mut folders = HashMap::new();
let identifiers = self.folder_identifiers().await?;
for id in &identifiers {
let event_log = self.folder_log(id).await?;
let log_file = event_log.read().await;
folders.insert(*id, log_file.diff_events(None).await?);
}
Ok(CreateSet {
identity,
account,
folders,
device,
#[cfg(feature = "files")]
files,
})
}
}
/// Types that can force merge a diff.
///
/// Force merge deletes all events from the log and
/// applies the diff patch as a new set of events.
///
/// Use this when event logs have completely diverged
/// and need to be rewritten.
#[async_trait]
pub trait ForceMerge {
/// Force merge changes to the identity folder.
async fn force_merge_identity(
&mut self,
source: FolderDiff,
outcome: &mut MergeOutcome,
) -> Result<()>;
/// Force merge changes to the account event log.
async fn force_merge_account(
&mut self,
diff: AccountDiff,
outcome: &mut MergeOutcome,
) -> Result<()>;
/// Force merge changes to the devices event log.
async fn force_merge_device(
&mut self,
diff: DeviceDiff,
outcome: &mut MergeOutcome,
) -> Result<()>;
/// Force merge changes to the files event log.
#[cfg(feature = "files")]
async fn force_merge_files(
&mut self,
diff: FileDiff,
outcome: &mut MergeOutcome,
) -> Result<()>;
/// Force merge changes to a folder.
async fn force_merge_folder(
&mut self,
folder_id: &VaultId,
source: FolderDiff,
outcome: &mut MergeOutcome,
) -> Result<()>;
}
/// Types that can merge diffs.
#[async_trait]
pub trait Merge {
/// Merge changes to the identity folder.
async fn merge_identity(
&mut self,
diff: FolderDiff,
outcome: &mut MergeOutcome,
) -> Result<CheckedPatch>;
/// Compare the identity folder.
async fn compare_identity(
&self,
state: &CommitState,
) -> Result<Comparison>;
/// Merge changes to the account event log.
async fn merge_account(
&mut self,
diff: AccountDiff,
outcome: &mut MergeOutcome,
) -> Result<(CheckedPatch, HashSet<VaultId>)>;
/// Compare the account events.
async fn compare_account(
&self,
state: &CommitState,
) -> Result<Comparison>;
/// Merge changes to the devices event log.
async fn merge_device(
&mut self,
diff: DeviceDiff,
outcome: &mut MergeOutcome,
) -> Result<CheckedPatch>;
/// Compare the device events.
async fn compare_device(&self, state: &CommitState)
-> Result<Comparison>;
/// Merge changes to the files event log.
#[cfg(feature = "files")]
async fn merge_files(
&mut self,
diff: FileDiff,
outcome: &mut MergeOutcome,
) -> Result<CheckedPatch>;
/// Compare the file events.
#[cfg(feature = "files")]
async fn compare_files(&self, state: &CommitState) -> Result<Comparison>;
/// Merge changes to a folder.
async fn merge_folder(
&mut self,
folder_id: &VaultId,
diff: FolderDiff,
outcome: &mut MergeOutcome,
) -> Result<CheckedPatch>;
/// Compare folder events.
async fn compare_folder(
&self,
folder_id: &VaultId,
state: &CommitState,
) -> Result<Comparison>;
/// Compare the local state to a remote status.
async fn compare(
&mut self,
remote_status: &SyncStatus,
) -> Result<SyncCompare> {
let mut compare = SyncCompare::default();
compare.identity =
Some(self.compare_identity(&remote_status.identity).await?);
compare.account =
Some(self.compare_account(&remote_status.account).await?);
compare.device =
Some(self.compare_device(&remote_status.device).await?);
#[cfg(feature = "files")]
if let Some(files) = &remote_status.files {
compare.files = Some(self.compare_files(files).await?);
}
for (id, folder_status) in &remote_status.folders {
compare
.folders
.insert(*id, self.compare_folder(id, folder_status).await?);
}
Ok(compare)
}
/// Merge a diff into this storage.
async fn merge(
&mut self,
diff: SyncDiff,
outcome: &mut MergeOutcome,
) -> Result<SyncCompare> {
let mut compare = SyncCompare::default();
match diff.identity {
Some(MaybeDiff::Diff(diff)) => {
self.merge_identity(diff, outcome).await?;
}
Some(MaybeDiff::Compare(state)) => {
if let Some(state) = state {
compare.identity =
Some(self.compare_identity(&state).await?);
}
}
None => {}
}
let mut deleted_folders = HashSet::new();
match diff.account {
Some(MaybeDiff::Diff(diff)) => {
let (_, deletions) =
self.merge_account(diff, outcome).await?;
deleted_folders = deletions;
}
Some(MaybeDiff::Compare(state)) => {
if let Some(state) = state {
compare.account =
Some(self.compare_account(&state).await?);
}
}
None => {}
}
match diff.device {
Some(MaybeDiff::Diff(diff)) => {
self.merge_device(diff, outcome).await?;
}
Some(MaybeDiff::Compare(state)) => {
if let Some(state) = state {
compare.device = Some(self.compare_device(&state).await?);
}
}
None => {}
}
#[cfg(feature = "files")]
match diff.files {
Some(MaybeDiff::Diff(diff)) => {
self.merge_files(diff, outcome).await?;
}
Some(MaybeDiff::Compare(state)) => {
if let Some(state) = state {
compare.files = Some(self.compare_files(&state).await?);
}
}
None => {}
}
for (id, maybe_diff) in diff.folders {
// Don't bother trying to merge folders that
// have been deleted
if deleted_folders.contains(&id) {
tracing::debug!(
folder_id = %id,
"merge::ignore_deleted_folder");
continue;
}
match maybe_diff {
MaybeDiff::Diff(diff) => {
self.merge_folder(&id, diff, outcome).await?;
}
MaybeDiff::Compare(state) => {
if let Some(state) = state {
compare.folders.insert(
id,
self.compare_folder(&id, &state).await?,
);
}
}
}
}
tracing::debug!(num_changes = %outcome.changes, "merge complete");
Ok(compare)
}
}
/// Difference between a local sync status and a remote
/// sync status.
pub async fn diff(
storage: &(impl SyncStorage + Send + Sync),
remote_status: SyncStatus,
) -> Result<(bool, SyncStatus, SyncDiff)> {
let comparison = {
// Compare local status to the remote
SyncComparison::new(storage, remote_status).await?
};
let needs_sync = comparison.needs_sync();
let diff = comparison.diff(storage).await?;
Ok((needs_sync, comparison.local_status, diff))
}