recomp 0.4.0

Reusable components
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
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

#[cfg(feature = "storage-aws")]
use object_store::aws::AmazonS3;
#[cfg(feature = "storage-azure")]
use object_store::azure::MicrosoftAzure;
#[cfg(feature = "storage-gcp")]
use object_store::gcp::GoogleCloudStorage;
#[cfg(feature = "storage-http")]
use object_store::http::HttpStore;
#[cfg(all(feature = "storage", not(target_arch = "wasm32")))]
use object_store::local::LocalFileSystem;
use object_store::memory::InMemory;

mod builder;

#[cfg(feature = "storage-azure")]
pub use builder::AzureObjectStorageBuilder;
#[cfg(feature = "storage-gcp")]
pub use builder::GcpObjectStorageBuilder;
#[cfg(feature = "storage-http")]
pub use builder::HttpObjectStorageBuilder;
#[cfg(all(feature = "storage", not(target_arch = "wasm32")))]
pub use builder::LocalObjectStorageBuilder;
pub use builder::MemoryObjectStorageBuilder;
#[cfg(feature = "storage-aws")]
pub use builder::S3ObjectStorageBuilder;

/// Object storage component backed by an [`object_store::ObjectStore`].
///
/// Object storage clients do not own a separate runtime lifecycle, so this type
/// is a ready handle around a built object store.
#[derive(Debug)]
pub struct ObjectStorage<S> {
    name: String,
    store: S,
}

impl ObjectStorage<InMemory> {
    /// Creates a builder for in-memory object storage.
    ///
    /// `name` is the logical storage name returned by [`ObjectStorage::name`];
    /// it is not part of the object store configuration.
    #[must_use]
    pub fn memory(name: impl Into<String>) -> MemoryObjectStorageBuilder {
        MemoryObjectStorageBuilder::new(name)
    }
}

#[cfg(all(feature = "storage", not(target_arch = "wasm32")))]
impl ObjectStorage<LocalFileSystem> {
    /// Creates a builder for local filesystem object storage.
    ///
    /// `name` is the logical storage name returned by [`ObjectStorage::name`];
    /// it is not part of the object store configuration.
    #[must_use]
    pub fn local(
        name: impl Into<String>,
        root: impl AsRef<std::path::Path>,
    ) -> LocalObjectStorageBuilder {
        LocalObjectStorageBuilder::new(name, root)
    }
}

#[cfg(feature = "storage-aws")]
impl ObjectStorage<AmazonS3> {
    /// Creates a builder for Amazon S3 compatible object storage.
    ///
    /// `name` is the logical storage name returned by [`ObjectStorage::name`];
    /// it is not part of the object store configuration.
    ///
    /// The builder starts from [`object_store::aws::AmazonS3Builder::from_env`]
    /// so standard AWS environment variables are honored before falling back to
    /// provider defaults such as instance metadata credentials. Callers can
    /// override any provider setting before building.
    #[must_use]
    pub fn s3(name: impl Into<String>) -> S3ObjectStorageBuilder {
        S3ObjectStorageBuilder::new(name)
    }
}

#[cfg(feature = "storage-gcp")]
impl ObjectStorage<GoogleCloudStorage> {
    /// Creates a builder for Google Cloud Storage.
    ///
    /// `name` is the logical storage name returned by [`ObjectStorage::name`];
    /// it is not part of the object store configuration.
    ///
    /// The builder starts from
    /// [`object_store::gcp::GoogleCloudStorageBuilder::from_env`] so standard
    /// Google Cloud environment variables are honored before falling back to
    /// provider defaults such as application default credentials and metadata
    /// server credentials. Callers can override any provider setting before
    /// building.
    #[must_use]
    pub fn gcs(name: impl Into<String>) -> GcpObjectStorageBuilder {
        GcpObjectStorageBuilder::new(name)
    }
}

#[cfg(feature = "storage-azure")]
impl ObjectStorage<MicrosoftAzure> {
    /// Creates a builder for Microsoft Azure Blob Storage.
    ///
    /// `name` is the logical storage name returned by [`ObjectStorage::name`];
    /// it is not part of the object store configuration.
    ///
    /// The builder starts from
    /// [`object_store::azure::MicrosoftAzureBuilder::from_env`] so standard
    /// Azure environment variables are honored before falling back to provider
    /// defaults such as managed identity credentials. Callers can override any
    /// provider setting before building.
    #[must_use]
    pub fn azure(name: impl Into<String>) -> AzureObjectStorageBuilder {
        AzureObjectStorageBuilder::new(name)
    }
}

#[cfg(feature = "storage-http")]
impl ObjectStorage<HttpStore> {
    /// Creates a builder for HTTP/WebDAV object storage.
    ///
    /// `name` is the logical storage name returned by [`ObjectStorage::name`];
    /// it is not part of the object store configuration.
    #[must_use]
    pub fn http(name: impl Into<String>, url: impl Into<String>) -> HttpObjectStorageBuilder {
        HttpObjectStorageBuilder::new(name, url)
    }
}

impl<S> ObjectStorage<S> {
    pub(crate) fn from_store(name: impl Into<String>, store: S) -> Self {
        Self {
            name: name.into(),
            store,
        }
    }

    /// Returns the logical storage name.
    #[must_use]
    pub const fn name(&self) -> &str {
        self.name.as_str()
    }

    /// Returns the underlying object store.
    ///
    /// This is the escape hatch for provider-specific functionality.
    #[must_use]
    pub const fn store(&self) -> &S {
        &self.store
    }
}

#[cfg(test)]
mod tests {
    use std::{env, fs, io::ErrorKind, process};

    use object_store::{ObjectStoreExt as _, PutPayload, path::Path};

    use super::ObjectStorage;

    #[test]
    fn memory_builder_builds_usable_object_storage() {
        let runtime = runtime();
        let storage = ObjectStorage::memory("objects").build();
        let path = Path::from("documents/report.txt");

        assert_eq!(storage.name(), "objects", "storage name must be preserved");

        runtime.block_on(async {
            match storage
                .store()
                .put(&path, PutPayload::from_static(b"hello storage"))
                .await
            {
                Ok(_) => {}
                Err(error) => panic!("memory object must be written: {error}"),
            }

            let bytes = match storage.store().get(&path).await {
                Ok(result) => match result.bytes().await {
                    Ok(bytes) => bytes,
                    Err(error) => panic!("memory object bytes must be read: {error}"),
                },
                Err(error) => panic!("memory object must be read: {error}"),
            };

            assert_eq!(
                bytes.as_ref(),
                b"hello storage",
                "read bytes must match written bytes"
            );
        });
    }

    #[cfg(not(target_arch = "wasm32"))]
    #[test]
    fn local_builder_builds_usable_object_storage() {
        let runtime = runtime();
        let root = test_directory("local_builder_builds_usable_object_storage");
        create_test_directory(&root);
        let storage = match ObjectStorage::local("objects", &root).build() {
            Ok(storage) => storage,
            Err(error) => panic!("local object storage must build: {error}"),
        };
        let path = Path::from("documents/report.txt");

        runtime.block_on(async {
            match storage
                .store()
                .put(&path, PutPayload::from_static(b"hello local storage"))
                .await
            {
                Ok(_) => {}
                Err(error) => panic!("local object must be written: {error}"),
            }

            let bytes = match storage.store().get(&path).await {
                Ok(result) => match result.bytes().await {
                    Ok(bytes) => bytes,
                    Err(error) => panic!("local object bytes must be read: {error}"),
                },
                Err(error) => panic!("local object must be read: {error}"),
            };

            assert_eq!(
                bytes.as_ref(),
                b"hello local storage",
                "read bytes must match written local bytes"
            );
        });

        remove_test_directory(&root);
    }

    fn runtime() -> tokio::runtime::Runtime {
        match tokio::runtime::Builder::new_current_thread()
            .enable_time()
            .build()
        {
            Ok(runtime) => runtime,
            Err(error) => panic!("test runtime must build: {error}"),
        }
    }

    #[cfg(not(target_arch = "wasm32"))]
    fn test_directory(name: &str) -> std::path::PathBuf {
        let directory = env::temp_dir().join(format!("recomp-storage-{name}-{}", process::id()));
        remove_test_directory(&directory);

        directory
    }

    #[cfg(not(target_arch = "wasm32"))]
    fn create_test_directory(directory: &std::path::Path) {
        match fs::create_dir_all(directory) {
            Ok(()) => {}
            Err(error) => panic!("test storage directory must be created: {error}"),
        }
    }

    #[cfg(not(target_arch = "wasm32"))]
    fn remove_test_directory(directory: &std::path::Path) {
        match fs::remove_dir_all(directory) {
            Ok(()) => {}
            Err(error) if error.kind() == ErrorKind::NotFound => {}
            Err(error) => panic!("test storage directory cleanup failed: {error}"),
        }
    }
}