aion-store 0.5.0

Persistence contracts and in-memory event stores for Aion durable workflows.
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
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

//! Deployed-package persistence scenarios of the conformance suite.

use std::sync::Arc;

use chrono::{DateTime, Utc};

use crate::package::{PackageRecord, PackageRouteRecord};
use crate::{EventStore, StoreError};

fn record(
    workflow_type: &str,
    content_hash: &str,
    archive: &[u8],
    deployed_at: DateTime<Utc>,
) -> PackageRecord {
    PackageRecord {
        workflow_type: workflow_type.to_owned(),
        content_hash: content_hash.to_owned(),
        archive: archive.to_vec(),
        deployed_at,
    }
}

fn deployed_at(offset_seconds: i64) -> Result<DateTime<Utc>, StoreError> {
    DateTime::from_timestamp(1_700_000_000 + offset_seconds, 0).ok_or_else(|| {
        StoreError::Backend(format!(
            "conformance fixture timestamp offset {offset_seconds} out of range"
        ))
    })
}

fn expect<T: PartialEq + std::fmt::Debug>(
    found: &T,
    wanted: &T,
    contract: &str,
) -> Result<(), StoreError> {
    if found == wanted {
        Ok(())
    } else {
        Err(StoreError::Backend(format!(
            "{contract}: expected {wanted:?}, found {found:?}"
        )))
    }
}

pub(super) async fn put_and_list_packages_round_trip_in_deploy_order(
    store: Arc<dyn EventStore>,
) -> Result<(), StoreError> {
    let later = record("checkout", &"b".repeat(64), b"archive-b", deployed_at(20)?);
    let earlier = record("billing", &"a".repeat(64), b"archive-a", deployed_at(10)?);

    store.put_package(later.clone()).await?;
    store.put_package(earlier.clone()).await?;

    expect(
        &store.list_packages().await?,
        &vec![earlier, later],
        "list_packages must return complete records in ascending deployed_at order",
    )
}

pub(super) async fn put_package_replaces_existing_row(
    store: Arc<dyn EventStore>,
) -> Result<(), StoreError> {
    let hash = "c".repeat(64);
    store
        .put_package(record("checkout", &hash, b"first", deployed_at(10)?))
        .await?;
    let replacement = record("checkout", &hash, b"second", deployed_at(30)?);
    store.put_package(replacement.clone()).await?;

    expect(
        &store.list_packages().await?,
        &vec![replacement],
        "re-persisting the same (type, hash) must replace the row, not duplicate it",
    )
}

pub(super) async fn put_package_points_route_at_persisted_version(
    store: Arc<dyn EventStore>,
) -> Result<(), StoreError> {
    let first = "a".repeat(64);
    let second = "b".repeat(64);
    store
        .put_package(record("checkout", &first, b"v1", deployed_at(10)?))
        .await?;
    store
        .put_package(record("checkout", &second, b"v2", deployed_at(20)?))
        .await?;

    expect(
        &store.list_package_routes().await?,
        &vec![PackageRouteRecord {
            workflow_type: "checkout".to_owned(),
            content_hash: second,
        }],
        "put_package must atomically re-point the type's route at the persisted version",
    )
}

pub(super) async fn put_package_route_repoints_without_touching_archives(
    store: Arc<dyn EventStore>,
) -> Result<(), StoreError> {
    let first = "a".repeat(64);
    let second = "b".repeat(64);
    let v1 = record("checkout", &first, b"v1", deployed_at(10)?);
    let v2 = record("checkout", &second, b"v2", deployed_at(20)?);
    store.put_package(v1.clone()).await?;
    store.put_package(v2.clone()).await?;

    store.put_package_route("checkout", &first).await?;

    expect(
        &store.list_package_routes().await?,
        &vec![PackageRouteRecord {
            workflow_type: "checkout".to_owned(),
            content_hash: first,
        }],
        "put_package_route must re-point the route (rollback)",
    )?;
    expect(
        &store.list_packages().await?,
        &vec![v1, v2],
        "a route re-point must leave persisted archives untouched",
    )
}

pub(super) async fn delete_package_removes_only_target_and_is_idempotent(
    store: Arc<dyn EventStore>,
) -> Result<(), StoreError> {
    let first = "a".repeat(64);
    let second = "b".repeat(64);
    let v1 = record("checkout", &first, b"v1", deployed_at(10)?);
    let v2 = record("checkout", &second, b"v2", deployed_at(20)?);
    store.put_package(v1).await?;
    store.put_package(v2.clone()).await?;

    store.delete_package("checkout", &first).await?;
    expect(
        &store.list_packages().await?,
        &vec![v2.clone()],
        "delete_package must remove exactly the target version",
    )?;

    // Deleting an absent row (already deleted, or a never-persisted
    // file-sourced version) is a no-op, never an error.
    store.delete_package("checkout", &first).await?;
    store.delete_package("never-persisted", &second).await?;
    expect(
        &store.list_packages().await?,
        &vec![v2],
        "idempotent deletes must leave surviving rows untouched",
    )
}

pub(super) async fn routes_list_in_workflow_type_order(
    store: Arc<dyn EventStore>,
) -> Result<(), StoreError> {
    let hash = "d".repeat(64);
    store.put_package_route("zeta", &hash).await?;
    store.put_package_route("alpha", &hash).await?;

    expect(
        &store.list_package_routes().await?,
        &vec![
            PackageRouteRecord {
                workflow_type: "alpha".to_owned(),
                content_hash: hash.clone(),
            },
            PackageRouteRecord {
                workflow_type: "zeta".to_owned(),
                content_hash: hash,
            },
        ],
        "list_package_routes must order by workflow type",
    )
}