icechunk 2.0.2

Transactional storage engine for Zarr designed for use on cloud object storage
Documentation 
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

//! Detection and resolution for concurrent writes.
//!
//! When rebasing a session onto a newer snapshot, conflicts may occur if both
//! modified the same data. This module detects conflicts and provides resolution
//! strategies.

use std::collections::HashSet;

use async_trait::async_trait;

use crate::{
    change_set::ChangeSet,
    format::{ChunkIndices, NodeId, Path, transaction_log::TransactionLog},
    session::{Session, SessionResult},
};

pub mod basic_solver;
pub mod detector;

/// A conflict detected when rebasing changes onto a newer snapshot.
#[derive(Debug, PartialEq, Eq)]
pub enum Conflict {
    NewNodeConflictsWithExistingNode(Path),
    NewNodeInInvalidGroup(Path),
    ZarrMetadataDoubleUpdate(Path),
    ZarrMetadataUpdateOfDeletedArray(Path),
    ZarrMetadataUpdateOfDeletedGroup(Path),
    ChunkDoubleUpdate {
        path: Path,
        node_id: NodeId,
        chunk_coordinates: HashSet<ChunkIndices>,
    },
    ChunksUpdatedInDeletedArray {
        path: Path,
        node_id: NodeId,
    },
    ChunksUpdatedInUpdatedArray {
        path: Path,
        node_id: NodeId,
    },
    DeleteOfUpdatedArray {
        path: Path,
        node_id: NodeId,
    },
    DeleteOfUpdatedGroup {
        path: Path,
        node_id: NodeId,
    },
    MoveOperationCannotBeRebased,
    // FIXME: we are missing the case of current change deleting a group and previous change
    // creating something new under it
}

/// Result of attempting to resolve conflicts.
#[derive(Debug)]
pub enum ConflictResolution {
    /// Conflicts were resolved; use this patched changeset.
    Patched(ChangeSet),
    /// Conflicts could not be resolved automatically.
    Unsolvable { reason: Vec<Conflict>, unmodified: ChangeSet },
}

/// Strategy for resolving conflicts during rebase.
#[async_trait]
pub trait ConflictSolver {
    async fn solve(
        &self,
        previous_change: &TransactionLog,
        previous_repo: &Session,
        current_changes: ChangeSet,
        current_repo: &Session,
    ) -> SessionResult<ConflictResolution>;
}