garage/script
Quentin b4592a00fe
All checks were successful
continuous-integration/drone/push Build is passing
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: #171
Co-authored-by: Quentin <quentin@dufour.io>
Co-committed-by: Quentin <quentin@dufour.io>
2022-01-12 19:04:55 +01:00
..
dev-bucket.sh Implement ListMultipartUploads (#171) 2022-01-12 19:04:55 +01:00
dev-clean.sh Implement ListMultipartUploads (#171) 2022-01-12 19:04:55 +01:00
dev-cluster.sh Implement ListMultipartUploads (#171) 2022-01-12 19:04:55 +01:00
dev-configure.sh Implement ListMultipartUploads (#171) 2022-01-12 19:04:55 +01:00
dev-env-aws.sh Implement ListMultipartUploads (#171) 2022-01-12 19:04:55 +01:00
dev-env-duck.sh Add preliminary support for Duck 2021-05-15 10:24:20 +02:00
dev-env-mc.sh Add minio & rclone to our functional tests 2021-05-02 14:59:58 +02:00
dev-env-rclone.sh Add minio & rclone to our functional tests 2021-05-02 14:59:58 +02:00
dev-env-s3cmd.sh Add minio & rclone to our functional tests 2021-05-02 14:59:58 +02:00
simulate_ring.py Not fully tested: new multi-dc MagLev 2021-03-05 16:22:29 +01:00
test-smoke.sh Implement ListMultipartUploads (#171) 2022-01-12 19:04:55 +01:00