diff options
| author | Quentin <quentin@dufour.io> | 2022-01-12 19:04:55 +0100 |
|---|---|---|
| committer | Alex <alex@adnab.me> | 2022-01-12 19:04:55 +0100 |
| commit | b4592a00fee3504b80aab9a8ee46bbacf7612e4a (patch) | |
| tree | f4130c9e5553a475598f6101db3ca6059f042f95 /src/api/api_server.rs | |
| parent | 9cb2e9e57ce1aab23d8c3b2aaa7581c8e8b78253 (diff) | |
| download | garage-b4592a00fee3504b80aab9a8ee46bbacf7612e4a.tar.gz garage-b4592a00fee3504b80aab9a8ee46bbacf7612e4a.zip | |
Implement ListMultipartUploads (#171)
Implement ListMultipartUploads, also refactor ListObjects and ListObjectsV2.
It took me some times as I wanted to propose the following things:
- Using an iterator instead of the loop+goto pattern. I find it easier to read and it should enable some optimizations. For example, when consuming keys of a common prefix, we do many [redundant checks](https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/main/src/api/s3_list.rs#L125-L156) while the only thing to do is to [check if the following key is still part of the common prefix](https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/feature/s3-multipart-compat/src/api/s3_list.rs#L476).
- Try to name things (see ExtractionResult and RangeBegin enums) and to separate concerns (see ListQuery and Accumulator)
- An IO closure to make unit tests possibles.
- Unit tests, to track regressions and document how to interact with the code
- Integration tests with `s3api`. In the future, I would like to move them in Rust with the aws rust SDK.
Merging of the logic of ListMultipartUploads and ListObjects was not a goal but a consequence of the previous modifications.
Some points that we might want to discuss:
- ListObjectsV1, when using pagination and delimiters, has a weird behavior (it lists multiple times the same prefix) with `aws s3api` due to the fact that it can not use our optimization to skip the whole prefix. It is independant from my refactor and can be tested with the commented `s3api` tests in `test-smoke.sh`. It probably has the same weird behavior on the official AWS S3 implementation.
- Considering ListMultipartUploads, I had to "abuse" upload id marker to support prefix skipping. I send an `upload-id-marker` with the hardcoded value `include` to emulate your "including" token.
- Some ways to test ListMultipartUploads with existing software (my tests are limited to s3api for now).
Co-authored-by: Quentin Dufour <quentin@deuxfleurs.fr>
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/171
Co-authored-by: Quentin <quentin@dufour.io>
Co-committed-by: Quentin <quentin@dufour.io>
Diffstat (limited to 'src/api/api_server.rs')
| -rw-r--r-- | src/api/api_server.rs | 55 |
1 files changed, 43 insertions, 12 deletions
diff --git a/src/api/api_server.rs b/src/api/api_server.rs index 41aa0046..16156e74 100644 --- a/src/api/api_server.rs +++ b/src/api/api_server.rs @@ -1,3 +1,4 @@ +use std::cmp::{max, min}; use std::net::SocketAddr; use std::sync::Arc; @@ -217,16 +218,18 @@ async fn handler_inner(garage: Arc<Garage>, req: Request<Body>) -> Result<Respon handle_list( garage, &ListObjectsQuery { + common: ListQueryCommon { + bucket_name: bucket, + bucket_id, + delimiter: delimiter.map(|d| d.to_string()), + page_size: max_keys.map(|p| min(1000, max(1, p))).unwrap_or(1000), + prefix: prefix.unwrap_or_default(), + urlencode_resp: encoding_type.map(|e| e == "url").unwrap_or(false), + }, is_v2: false, - bucket_name: bucket, - bucket_id, - delimiter: delimiter.map(|d| d.to_string()), - max_keys: max_keys.unwrap_or(1000), - prefix: prefix.unwrap_or_default(), marker, continuation_token: None, start_after: None, - urlencode_resp: encoding_type.map(|e| e == "url").unwrap_or(false), }, ) .await @@ -246,16 +249,18 @@ async fn handler_inner(garage: Arc<Garage>, req: Request<Body>) -> Result<Respon handle_list( garage, &ListObjectsQuery { + common: ListQueryCommon { + bucket_name: bucket, + bucket_id, + delimiter: delimiter.map(|d| d.to_string()), + page_size: max_keys.map(|p| min(1000, max(1, p))).unwrap_or(1000), + urlencode_resp: encoding_type.map(|e| e == "url").unwrap_or(false), + prefix: prefix.unwrap_or_default(), + }, is_v2: true, - bucket_name: bucket, - bucket_id, - delimiter: delimiter.map(|d| d.to_string()), - max_keys: max_keys.unwrap_or(1000), - prefix: prefix.unwrap_or_default(), marker: None, continuation_token, start_after, - urlencode_resp: encoding_type.map(|e| e == "url").unwrap_or(false), }, ) .await @@ -266,6 +271,32 @@ async fn handler_inner(garage: Arc<Garage>, req: Request<Body>) -> Result<Respon ))) } } + Endpoint::ListMultipartUploads { + bucket, + delimiter, + encoding_type, + key_marker, + max_uploads, + prefix, + upload_id_marker, + } => { + handle_list_multipart_upload( + garage, + &ListMultipartUploadsQuery { + common: ListQueryCommon { + bucket_name: bucket, + bucket_id, + delimiter: delimiter.map(|d| d.to_string()), + page_size: max_uploads.map(|p| min(1000, max(1, p))).unwrap_or(1000), + prefix: prefix.unwrap_or_default(), + urlencode_resp: encoding_type.map(|e| e == "url").unwrap_or(false), + }, + key_marker, + upload_id_marker, + }, + ) + .await + } Endpoint::DeleteObjects { .. } => { handle_delete_objects(garage, bucket_id, req, content_sha256).await } |