beet_net 0.0.8

Cross-platform networking utilities
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
use crate::prelude::*;
use beet_core::prelude::*;
use bytes::Bytes;

/// Cross-service storage bucket for S3, filesystem, memory, or other providers
#[derive(Component)]
pub struct Bucket {
	/// Bucket name
	name: String,
	/// Provider that handles bucket operations (S3, filesystem, memory, etc.)
	provider: Box<dyn BucketProvider>,
}
impl Clone for Bucket {
	fn clone(&self) -> Self {
		Self {
			name: self.name.clone(),
			provider: self.provider.box_clone(),
		}
	}
}

impl Bucket {
	pub fn new(provider: impl BucketProvider, name: impl Into<String>) -> Self {
		Self {
			name: name.into(),
			provider: Box::new(provider),
		}
	}

	/// Create a [`BucketItem`] for working with a specific path
	///
	/// # Example
	/// ```no_run
	/// # use beet_core::prelude::*;
	/// # use beet_net::prelude::*;
	/// let bucket = temp_bucket();
	/// let item = bucket.item(RoutePath::from("/my-file.txt"));
	/// ```
	pub fn item(&self, path: RoutePath) -> BucketItem {
		BucketItem::new(self.clone(), path)
	}

	/// Get bucket name
	pub fn name(&self) -> &str { &self.name }


	/// Create bucket (may take 10+ seconds for some services like dynamodb)
	///
	/// # Example
	/// ```
	/// # use beet_core::prelude::*;
	/// # use beet_net::prelude::*;
	/// # async fn run() -> Result<()> {
	/// let bucket = temp_bucket();
	/// bucket.bucket_create().await?;
	/// # Ok(())
	/// # }
	/// ```
	///
	/// # Errors
	/// Fails if bucket already exists
	pub async fn bucket_create(&self) -> Result {
		self.provider.bucket_create(&self.name).await
	}

	/// Ensure bucket exists, creating if needed
	///
	/// # Example
	/// ```
	/// # use beet_core::prelude::*;
	/// # use beet_net::prelude::*;
	/// # async fn run() -> Result<()> {
	/// let bucket = temp_bucket();
	/// bucket.bucket_try_create().await?;
	/// # Ok(())
	/// # }
	/// ```
	pub async fn bucket_try_create(&self) -> Result {
		self.provider.bucket_try_create(&self.name).await
	}

	/// Check if bucket exists
	///
	/// # Example
	/// ```
	/// # use beet_core::prelude::*;
	/// # use beet_net::prelude::*;
	/// # async fn run() -> Result<()> {
	/// let bucket = temp_bucket();
	/// let exists = bucket.bucket_exists().await?;
	/// # Ok(())
	/// # }
	/// ```
	pub async fn bucket_exists(&self) -> Result<bool> {
		self.provider.bucket_exists(&self.name).await
	}
	/// Remove bucket
	///
	/// # Example
	/// ```
	/// # use beet_core::prelude::*;
	/// # use beet_net::prelude::*;
	/// # async fn run() -> Result<()> {
	/// let bucket = temp_bucket();
	/// bucket.bucket_remove().await?;
	/// # Ok(())
	/// # }
	/// ```
	///
	/// # Errors
	/// Fails if bucket doesn't exist
	pub async fn bucket_remove(&self) -> Result {
		self.provider.bucket_remove(&self.name).await
	}
	/// Insert object into bucket
	///
	/// # Example
	/// ```
	/// # use beet_core::prelude::*;
	/// # use beet_net::prelude::*;
	/// # async fn run() -> Result<()> {
	/// let bucket = temp_bucket();
	/// bucket.insert(&RoutePath::from("/file.txt"), "content").await?;
	/// # Ok(())
	/// # }
	/// ```
	pub async fn insert(
		&self,
		path: &RoutePath,
		body: impl Into<Bytes>,
	) -> Result {
		self.provider.insert(&self.name, path, body.into()).await
	}

	/// Insert object, failing if it already exists
	///
	/// # Example
	/// ```
	/// # use beet_core::prelude::*;
	/// # use beet_net::prelude::*;
	/// # async fn run() -> Result<()> {
	/// let bucket = temp_bucket();
	/// bucket.try_insert(&RoutePath::from("/file.txt"), "content").await?;
	/// # Ok(())
	/// # }
	/// ```
	pub async fn try_insert(
		&self,
		path: &RoutePath,
		body: impl Into<Bytes>,
	) -> Result {
		if self.exists(path).await? {
			bevybail!("Object already exists: {}", path)
		} else {
			self.insert(path, body).await
		}
	}

	/// Check if object exists
	///
	/// # Example
	/// ```
	/// # use beet_core::prelude::*;
	/// # use beet_net::prelude::*;
	/// # async fn run() -> Result<()> {
	/// let bucket = temp_bucket();
	/// let exists = bucket.exists(&RoutePath::from("/file.txt")).await?;
	/// # Ok(())
	/// # }
	/// ```
	pub async fn exists(&self, path: &RoutePath) -> Result<bool> {
		self.provider.exists(&self.name, path).await
	}
	/// List all objects in bucket
	///
	/// # Example
	/// ```
	/// # use beet_core::prelude::*;
	/// # use beet_net::prelude::*;
	/// # async fn run() -> Result<()> {
	/// let bucket = temp_bucket();
	/// let paths = bucket.list().await?;
	/// # Ok(())
	/// # }
	/// ```
	pub async fn list(&self) -> Result<Vec<RoutePath>> {
		self.provider.list(&self.name).await
	}
	/// Get object data
	///
	/// # Example
	/// ```
	/// # use beet_core::prelude::*;
	/// # use beet_net::prelude::*;
	/// # async fn run() -> Result<()> {
	/// let bucket = temp_bucket();
	/// let data = bucket.get(&RoutePath::from("/file.txt")).await?;
	/// # Ok(())
	/// # }
	/// ```
	pub async fn get(&self, path: &RoutePath) -> Result<Bytes> {
		self.provider.get(&self.name, path).await
	}

	/// Get all objects and their data
	///
	/// # Example
	/// ```
	/// # use beet_core::prelude::*;
	/// # use beet_net::prelude::*;
	/// # async fn run() -> Result<()> {
	/// let bucket = temp_bucket();
	/// let all_data = bucket.get_all().await?;
	/// # Ok(())
	/// # }
	/// ```
	///
	/// # Caution
	/// Expensive operation - prefer [`Self::list`] + [`Self::get`]
	pub async fn get_all(&self) -> Result<Vec<(RoutePath, Bytes)>> {
		self.list()
			.await?
			.into_iter()
			.map(async |path| {
				let data = self.get(&path).await?;
				Ok::<_, BevyError>((path, data))
			})
			.xmap(async_ext::try_join_all)
			.await
	}

	/// Remove object from bucket
	///
	/// # Example
	/// ```
	/// # use beet_core::prelude::*;
	/// # use beet_net::prelude::*;
	/// # async fn run() -> Result<()> {
	/// let bucket = temp_bucket();
	/// bucket.remove(&RoutePath::from("/file.txt")).await?;
	/// # Ok(())
	/// # }
	/// ```
	pub async fn remove(&self, path: &RoutePath) -> Result {
		self.provider.remove(&self.name, path).await
	}

	/// Get public URL for object (if supported by provider)
	///
	/// # Example
	/// ```
	/// # use beet_core::prelude::*;
	/// # use beet_net::prelude::*;
	/// # async fn run() -> Result<()> {
	/// let bucket = temp_bucket();
	/// let url = bucket.public_url(&RoutePath::from("/file.txt")).await?;
	/// # Ok(())
	/// # }
	/// ```
	pub async fn public_url(&self, path: &RoutePath) -> Result<Option<String>> {
		self.provider.public_url(&self.name, path).await
	}
	/// Get provider region
	pub async fn region(&self) -> Option<String> { self.provider.region() }
}

pub trait BucketProvider: 'static + Send + Sync {
	fn box_clone(&self) -> Box<dyn BucketProvider>;

	/// Get provider region
	fn region(&self) -> Option<String>;
	/// Check if bucket exists
	fn bucket_exists(&self, bucket_name: &str)
	-> SendBoxedFuture<Result<bool>>;
	/// Create bucket
	fn bucket_create(&self, bucket_name: &str) -> SendBoxedFuture<Result>;
	/// Remove bucket (destructive operation!)
	fn bucket_remove(&self, bucket_name: &str) -> SendBoxedFuture<Result>;

	/// Ensure bucket exists, creating if needed
	fn bucket_try_create(&self, bucket_name: &str) -> SendBoxedFuture<Result> {
		let exists_fut = self.bucket_exists(bucket_name);
		let create_fut = self.bucket_create(bucket_name);
		Box::pin(async move {
			if exists_fut.await? {
				Ok(())
			} else {
				create_fut.await
			}
		})
	}
	/// Insert object into bucket
	fn insert(
		&self,
		bucket_name: &str,
		path: &RoutePath,
		body: Bytes,
	) -> SendBoxedFuture<Result>;
	/// List all objects in bucket
	fn list(
		&self,
		bucket_name: &str,
	) -> SendBoxedFuture<Result<Vec<RoutePath>>>;
	/// Get object from bucket
	fn get(
		&self,
		bucket_name: &str,
		path: &RoutePath,
	) -> SendBoxedFuture<Result<Bytes>>;
	/// Check if object exists in bucket
	fn exists(
		&self,
		bucket_name: &str,
		path: &RoutePath,
	) -> SendBoxedFuture<Result<bool>>;
	/// Remove object from bucket
	fn remove(
		&self,
		bucket_name: &str,
		path: &RoutePath,
	) -> SendBoxedFuture<Result>;
	/// Get public URL of object
	/// - fs: `file:///data/buckets/my-bucket/key`
	/// - s3: `https://my-bucket.s3.us-west-2.amazonaws.com/key`
	fn public_url(
		&self,
		bucket_name: &str,
		path: &RoutePath,
	) -> SendBoxedFuture<Result<Option<String>>>;
}

/// Create temporary in-memory bucket for testing
pub fn temp_bucket() -> Bucket { Bucket::new(InMemoryProvider::new(), "temp") }
/// Create local bucket with platform-specific provider
/// - wasm: [`LocalStorageProvider`]
/// - native: [`FsBucketProvider`] at `.cache/buckets`
pub fn local_bucket(name: impl Into<String>) -> Bucket {
	#[cfg(target_arch = "wasm32")]
	return Bucket::new(LocalStorageProvider::new(), name);
	#[cfg(not(target_arch = "wasm32"))]
	return Bucket::new(
		FsBucketProvider::new(
			AbsPathBuf::new_workspace_rel(".cache/buckets").unwrap(),
		),
		name,
	);
}
/// Select filesystem or S3 bucket based on [`ServiceAccess`] and feature flags
#[allow(unused_variables)]
pub async fn s3_fs_selector(
	fs_path: AbsPathBuf,
	bucket_name: impl AsRef<str>,
	access: ServiceAccess,
) -> Bucket {
	let bucket_name = bucket_name.as_ref();
	match access {
		ServiceAccess::Local => {
			debug!("Bucket Selector - FS: {fs_path}");
			Bucket::new(FsBucketProvider::new(fs_path.clone()), "")
		}
		#[cfg(not(all(feature = "aws", not(target_arch = "wasm32"))))]
		ServiceAccess::Remote => {
			debug!("Bucket Selector - FS (no aws or wasm): {fs_path}");
			Bucket::new(FsBucketProvider::new(fs_path.clone()), "")
		}
		#[cfg(all(feature = "aws", not(target_arch = "wasm32")))]
		ServiceAccess::Remote => {
			debug!("Bucket Selector - S3: {bucket_name}");
			let provider = S3Provider::create().await;
			Bucket::new(provider, bucket_name)
		}
	}
}



#[cfg(test)]
pub mod bucket_test {
	use crate::prelude::*;
	use beet_core::prelude::*;

	pub async fn run(provider: impl BucketProvider) {
		let bucket = Bucket::new(provider, "beet-test-bucket");
		let path = RoutePath::from("/test_path");
		let body = bytes::Bytes::from("test_body");
		bucket.bucket_remove().await.ok();
		bucket.bucket_exists().await.unwrap().xpect_false();
		bucket.bucket_try_create().await.unwrap();
		bucket.exists(&path).await.unwrap().xpect_false();
		bucket.remove(&path).await.xpect_err();
		bucket.insert(&path, body.clone()).await.unwrap();
		bucket.bucket_exists().await.unwrap().xpect_true();
		bucket.exists(&path).await.unwrap().xpect_true();
		bucket.list().await.unwrap().xpect_eq(vec![path.clone()]);
		bucket.get(&path).await.unwrap().xpect_eq(body.clone());
		bucket.get(&path).await.unwrap().xpect_eq(body);

		bucket.remove(&path).await.unwrap();
		bucket.get(&path).await.xpect_err();

		bucket.bucket_remove().await.unwrap();
		bucket.bucket_exists().await.unwrap().xpect_false();
	}
}