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
use super::*;
use aws_sdk_s3::operation::list_objects_v2::ListObjectsV2Output;
use aws_sdk_s3::primitives::ByteStream;
use aws_sdk_s3::types::{Delete, Object, ObjectIdentifier};
use aws_smithy_types_convert::stream::PaginationStreamExt;
use futures::future::ok;
use futures::stream::Stream;
use std::future::Future;
use std::pin::Pin;
use std::task::{Context, Poll};
use tokio::io;
/// A stream that can list objects, and (using member functions) delete or copy listed files.
pub struct ListObjects<S> {
s3: Client,
config: Config,
bucket: String,
/// Common prefix (as requested) of the listed objects. Empty string if all objects were
/// requestd.
prefix: String,
stream: S,
}
impl<S> ListObjects<S>
where
S: Stream<Item = Result<ListObjectsV2Output, Error>> + Sized + Send + 'static,
{
pub fn boxed(
self,
) -> ListObjects<Pin<Box<dyn Stream<Item = Result<ListObjectsV2Output, Error>> + Send>>> {
ListObjects {
s3: self.s3,
config: self.config,
bucket: self.bucket,
stream: self.stream.boxed(),
prefix: self.prefix,
}
}
/// Calls an async closure on all the individual objects of the list operation
pub async fn process<P, F>(self, f: P) -> Result<(), Error>
where
P: Fn(Object) -> F + Clone,
F: Future<Output = ()>,
{
let ListObjects {
stream, prefix: _, ..
} = self;
stream
.try_filter_map(|response| ok(response.contents))
.map_ok(|x| stream::iter(x).map(Ok))
.try_flatten()
.try_for_each_concurrent(None, move |object| {
let f = f.clone();
async move {
f(object).await;
Ok(())
}
})
.await
}
/// Download all listed objects - returns a stream of the contents.
/// Used as a basis for other `download_all_*` functions.
pub fn download_all_stream(
self,
) -> impl Stream<Item = Result<(String, ByteStream, Option<i64>), Error>> {
let ListObjects {
s3,
config: _,
bucket,
stream,
prefix: _,
} = self;
stream
.try_filter_map(|response| ok(response.contents))
.map_ok(|x| stream::iter(x).map(Ok))
.try_flatten()
.map(|result| {
result.and_then(|obj| {
let Object { key, size, .. } = obj;
if let Some(key) = key {
Ok((key, size))
} else {
Err(Error::MissingKeyOrSize)
}
})
})
.and_then(move |(key, _)| {
let (s3, bucket) = (s3.clone(), bucket.clone());
async move {
let output = s3
.get_object()
.bucket(bucket.clone())
.key(key.clone())
.send()
.await
.context(err::GetObject {
key: key.clone(),
bucket,
})?;
Ok((key, output.body, output.content_length))
}
})
}
pub fn download_all_to_vec(self) -> impl Stream<Item = Result<(String, Vec<u8>), Error>> {
self.download_all_stream()
.and_then(|(key, body, _)| async move {
let mut contents = vec![];
io::copy(&mut body.into_async_read(), &mut contents)
.await
.context(err::TokioIo)?;
Ok((key, contents))
})
}
/*
/// Download all listed objects to file system.
/// UNIMPLEMENTED.
pub fn download_all(self) -> impl Future<Output = Result<(), Error>> {
// TODO use download_all_stream
ok(unimplemented!())
}
*/
/// Delete all listed objects.
///
/// With the two arguments, you can implement a detailed real-time progress report of both how
/// many files have been listed, and how many files have been deleted.
///
/// `list_progress`: Closure that is given number of files listed as argument. Is called
/// several times, one for each batch of files listed.
/// `delete_progress`: Closure that is given RequestReport of a delete request. The `size`
/// field refers to the number of fields deleted.
///
pub fn delete_all<P1, P2, F1, F2>(
self,
list_progress: P1,
delete_progress: P2,
) -> impl Future<Output = Result<(), Error>>
where
P1: Fn(usize) -> F1 + Clone + Send + Sync + 'static,
P2: Fn(RequestReport) -> F2 + Clone + Send + Sync + 'static,
F1: Future<Output = ()> + Send + 'static,
F2: Future<Output = ()> + Send + 'static,
{
// For each ListObjectsV2Output, send a request to delete all the listed objects
let ListObjects {
s3,
config,
bucket,
stream,
prefix: _,
} = self;
let timeout = Arc::new(Mutex::new(TimeoutState::new(
config.algorithm.clone(),
config.delete_requests.clone(),
)));
let n_retries = config.algorithm.n_retries;
stream.try_for_each_concurrent(None, move |object| {
let (s3, bucket, timeout, delete_progress2, list_progress2) = (
s3.clone(),
bucket.clone(),
timeout.clone(),
delete_progress.clone(),
list_progress.clone(),
);
let objects = object
.contents
.unwrap_or_default() // unwrap or empty Vec
.iter()
.filter_map(|obj| {
obj.key.as_ref().map(|key| {
ObjectIdentifier::builder()
.set_key(Some(key.clone()))
.set_version_id(None)
.build()
.unwrap() // unwrap: shouldn't fail building as the key comes directly
// from S3
})
})
.collect::<Vec<_>>();
let n_objects = objects.len();
async move {
list_progress2(n_objects).await;
let (report, _) = s3_request(
move || {
let (s3, bucket, objects) = (s3.clone(), bucket.clone(), objects.clone());
async move {
let (s3, bucket, objects) =
(s3.clone(), bucket.clone(), objects.clone());
Ok((
async move {
s3.delete_objects()
.set_bucket(Some(bucket))
.set_delete(Some(
Delete::builder()
.set_objects(Some(objects))
.build()
.unwrap(), // unwrap: shouldn't fail building
// because all the input comes directly from S3
))
.send()
.await
.map_err(|e| e.into())
},
n_objects,
))
}
},
|_, size| size,
n_retries,
timeout.clone(),
)
.await?;
timeout.lock().await.update(&report);
delete_progress2(report).await;
Ok(())
}
})
}
/// Flatten into a stream of Objects.
pub fn flatten(self) -> impl Stream<Item = Result<Object, Error>> {
self.stream
.try_filter_map(|response| ok(response.contents))
.map_ok(|x| stream::iter(x).map(Ok))
.try_flatten()
}
/*
/// This function exists to provide a stream to copy all objects, for both `copy_all` and
/// `move_all`. The `String` that is the stream's `Item` is the _source key_. An `Ok` value
/// thus signals (relevant when used in `move_all`) that a certain key is ready for deletion.
fn copy_all_stream<F, R>(
self,
dest_bucket: Option<String>,
mapping: F,
default_request: R,
) -> impl Stream<Item = Result<String, Error>>
where
F: Fn(&str) -> String + Clone + Send + Sync + Unpin + 'static,
R: Fn() -> CopyObjectRequest + Clone + Unpin + Sync + Send + 'static,
{
let ListObjects {
s3,
config,
bucket,
stream,
prefix: _,
} = self;
let timeout = Arc::new(Mutex::new(TimeoutState::new(
config.algorithm.clone(),
config.put_requests.clone(),
)));
let n_retries = config.algorithm.n_retries;
let dest_bucket = dest_bucket.unwrap_or_else(|| bucket.clone());
stream
.try_filter_map(|response| ok(response.1.contents))
.map_ok(|x| stream::iter(x).map(Ok))
.try_flatten()
.try_filter_map(|obj| {
// Just filter out any object that does not have both of `key` and `size`
let Object { key, size, .. } = obj;
ok(key.and_then(|key| size.map(|size| (key, size))))
})
.and_then(move |(key, size)| {
let (s3, timeout) = (s3.clone(), timeout.clone());
let request = CopyObjectRequest {
copy_source: format!("{}/{}", bucket, key),
bucket: dest_bucket.clone(),
key: mapping(&key),
..default_request()
};
// println!("COPY REQUEST\n{:#?}", request);
s3_request(
move || {
let (s3, request) = (s3.clone(), request.clone());
async move {
let (s3, request) = (s3.clone(), request.clone());
Ok((async move{s3.copy_object(request).context(err::CopyObject).await}, size as usize))
}
},
|_, size| size,
n_retries,
timeout,
)
.map_ok(|_| key)
})
}
/// Copy all listed objects, to a different S3 location as defined in `mapping` and
/// `dest_bucket`.
/// If `other_bucket` is not provided, copy to same bucket
pub fn copy_all<F, R>(
self,
dest_bucket: Option<String>,
mapping: F,
default_request: R,
) -> impl Future<Output = Result<(), Error>>
where
F: Fn(&str) -> String + Clone + Send + Sync + Unpin + 'static,
R: Fn() -> CopyObjectRequest + Clone + Unpin + Sync + Send + 'static,
{
self.copy_all_stream(dest_bucket, mapping, default_request)
.try_for_each(|_| async { Ok(()) })
}
// TODO: Is it possible to change copy_all so that we can move_all by just chaining copy_all
// and delete_all? Then copy_all would need to return a stream of old keys, but does that make
// sense in general?
// For now, this is code duplication.
pub fn move_all<F, R>(
self,
dest_bucket: Option<String>,
mapping: F,
default_request: R,
) -> impl Future<Output = Result<(), Error>>
where
F: Fn(&str) -> String + Clone + Send + Sync + Unpin + 'static,
R: Fn() -> CopyObjectRequest + Clone + Unpin + Sync + Send + 'static,
{
let src_bucket = self.bucket.clone();
let timeout = Arc::new(Mutex::new(TimeoutState::new(
self.config.algorithm.clone(),
self.config.delete_requests.clone(),
)));
let n_retries = self.config.algorithm.n_retries;
let s3 = self.s3.clone();
self.copy_all_stream(dest_bucket, mapping, default_request)
.and_then(move |src_key| {
let delete_request = DeleteObjectRequest {
bucket: src_bucket.clone(),
key: src_key,
..Default::default()
};
let (s3, timeout) = (s3.clone(), timeout.clone());
s3_request(
move || {
let (s3, delete_request) = (s3.clone(), delete_request.clone());
async move {
let (s3, delete_request) = (s3.clone(), delete_request.clone());
Ok((
async move {
s3.delete_object(delete_request)
.context(err::DeleteObject)
.await
},
1,
))
}
},
|_, _| 1,
n_retries,
timeout,
)
.map_ok(drop)
.boxed()
})
.try_for_each(|_| async { Ok(()) })
.boxed()
}
/// Move all listed objects by substituting their common prefix with `new_prefix`.
pub fn move_to_prefix<R>(
self,
dest_bucket: Option<String>,
new_prefix: String,
default_request: R,
) -> impl Future<Output = Result<(), Error>>
where
R: Fn() -> CopyObjectRequest + Clone + Unpin + Sync + Send + 'static,
{
let old_prefix = self.prefix.clone();
let substitute_prefix =
move |source: &str| format!("{}{}", new_prefix, source.trim_start_matches(&old_prefix));
self.move_all(dest_bucket, substitute_prefix, default_request)
.boxed()
}
*/
}
impl<S> Stream for ListObjects<S>
where
S: Stream<Item = Result<ListObjectsV2Output, Error>> + Sized + Send + Unpin,
{
type Item = Result<ListObjectsV2Output, Error>;
fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>> {
Pin::new(&mut self.stream).poll_next(cx)
}
}
impl S3Algo {
/// List objects of a bucket.
pub fn list_prefix(
&self,
bucket: String,
prefix: Option<String>,
) -> ListObjects<impl Stream<Item = Result<ListObjectsV2Output, Error>> + Sized + Send> {
// TODO: Reintroduce retry and timeout
let stream = self
.s3
.list_objects_v2()
.bucket(bucket.clone())
.set_prefix(prefix)
.into_paginator()
.send();
let stream = PaginationStreamExt::into_stream_03x(stream)
// Turn into a stream of Objects
.map_err(|source| Error::ListObjectsV2 { source });
ListObjects {
s3: self.s3.clone(),
config: self.config.clone(),
stream,
bucket,
prefix: String::new(),
}
}
}
#[cfg(test)]
mod test {
use super::*;
use crate::test::rand_string;
use std::sync::atomic::{AtomicUsize, Ordering};
#[tokio::test]
async fn test_s3_delete_files_progress() {
// Minio does paging at 10'000 fles, so we need more than that.
// It means this test will take a minutes or two.
let algo = S3Algo::new(testing_sdk_client().await);
let dir = rand_string(14);
let dir2 = dir.clone();
const N_FILES: usize = 11_000;
let files = (0..N_FILES).map(move |i| ObjectSource::Data {
data: vec![1, 2, 3],
key: format!("{}/{}.file", dir2, i),
});
algo.upload_files(
"test-bucket".into(),
files,
|result| async move {
if result.seq % 100 == 0 {
println!("{} files uploaded", result.seq);
}
},
|client| client.put_object(),
)
.await
.unwrap();
let listed_files = Arc::new(AtomicUsize::new(0));
let deleted_files = Arc::new(AtomicUsize::new(0));
let listed_files2 = listed_files.clone();
let deleted_files2 = deleted_files.clone();
// Do one listing only to check the exact file names
let present = Arc::new(Mutex::new(std::collections::HashSet::new()));
algo.list_prefix("test-bucket".into(), Some(dir.clone()))
.process(|object| async {
let name = object.key.unwrap_or_else(|| "NONE".to_string());
println!("OBJ {}", name);
present.lock().await.insert(name);
})
.await
.unwrap();
let mut present = present.lock().await;
// All files are present
for i in 0..N_FILES {
let file_name = &format!("{}/{}.file", dir, i);
assert!(present.remove(file_name));
}
// No unexpected filesnames.
// Because once, it listed 11_200 files instead of 11_000
if !present.is_empty() {
println!("Left-over object names: {:?}", present);
panic!("Not empty ({} files)", present.len());
}
// Assert that number of files is N_FILES
let count = algo
.list_prefix("test-bucket".into(), Some(dir.clone()))
.flatten()
.try_fold(0usize, |acc, _| ok(acc + 1))
.await
.unwrap();
assert_eq!(count, N_FILES);
// Delete all
algo.list_prefix("test-bucket".into(), Some(dir.clone()))
.delete_all(
move |n| {
println!("Listed {} items", n);
let listed_files = listed_files2.clone();
async move {
listed_files.fetch_add(n, Ordering::Relaxed);
}
},
move |del_rep| {
let n = del_rep.size as usize;
println!("Deleted {} items", n);
let deleted_files = deleted_files2.clone();
async move {
deleted_files.fetch_add(n, Ordering::Relaxed);
}
},
)
.await
.unwrap();
// Assert number of objects listed and deleted
assert_eq!(listed_files.load(Ordering::Relaxed), N_FILES);
assert_eq!(deleted_files.load(Ordering::Relaxed), N_FILES);
// Assert that number of files is 0
let count = algo
.list_prefix("test-bucket".into(), Some(dir))
.flatten()
.try_fold(0usize, |acc, _| ok(acc + 1))
.await
.unwrap();
assert_eq!(count, 0);
}
}