Quentin
b4592a00fe
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: Deuxfleurs/garage#171 Co-authored-by: Quentin <quentin@dufour.io> Co-committed-by: Quentin <quentin@dufour.io>
86 lines
2.8 KiB
Nix
86 lines
2.8 KiB
Nix
{
|
|
system ? builtins.currentSystem,
|
|
release ? false,
|
|
target ? "x86_64-unknown-linux-musl",
|
|
compileMode ? null,
|
|
git_version ? null,
|
|
}:
|
|
|
|
with import ./nix/common.nix;
|
|
|
|
let
|
|
crossSystem = { config = target; };
|
|
in let
|
|
pkgs = import pkgsSrc {
|
|
inherit system crossSystem;
|
|
overlays = [ cargo2nixOverlay ];
|
|
};
|
|
|
|
/*
|
|
The following complexity should be abstracted by makePackageSet' (note the final quote).
|
|
However its code uses deprecated features of rust-overlay that can lead to bug.
|
|
Instead, we build our own rustChannel object with the recommended API of rust-overlay.
|
|
*/
|
|
rustChannel = pkgs.rustPlatform.rust;
|
|
|
|
overrides = pkgs.buildPackages.rustBuilder.overrides.all ++ [
|
|
/*
|
|
We want to inject the git version while keeping the build deterministic.
|
|
As we do not want to consider the .git folder as part of the input source,
|
|
we ask the user (the CI often) to pass the value to Nix.
|
|
*/
|
|
(pkgs.rustBuilder.rustLib.makeOverride {
|
|
name = "garage";
|
|
overrideAttrs = drv: if git_version != null then {
|
|
preConfigure = ''
|
|
${drv.preConfigure or ""}
|
|
export GIT_VERSION="${git_version}"
|
|
'';
|
|
} else {};
|
|
})
|
|
|
|
/*
|
|
On a sandbox pure NixOS environment, /usr/bin/file is not available.
|
|
This is a known problem: https://github.com/NixOS/nixpkgs/issues/98440
|
|
We simply patch the file as suggested
|
|
*/
|
|
/*(pkgs.rustBuilder.rustLib.makeOverride {
|
|
name = "libsodium-sys";
|
|
overrideAttrs = drv: {
|
|
preConfigure = ''
|
|
${drv.preConfigure or ""}
|
|
sed -i 's,/usr/bin/file,${file}/bin/file,g' ./configure
|
|
'';
|
|
}
|
|
})*/
|
|
];
|
|
|
|
packageFun = import ./Cargo.nix;
|
|
|
|
rustPkgs = pkgs.rustBuilder.makePackageSet {
|
|
inherit packageFun rustChannel release;
|
|
packageOverrides = overrides;
|
|
|
|
buildRustPackages = pkgs.buildPackages.rustBuilder.makePackageSet {
|
|
inherit rustChannel packageFun;
|
|
packageOverrides = overrides;
|
|
};
|
|
|
|
localPatterns = [
|
|
/*
|
|
The way the default rules are written make think we match recursively, on full path, but the rules are misleading.
|
|
In fact, the regex is only called on root elements of the crate (and not recursively).
|
|
This behavior does not work well with our nested modules.
|
|
We tried to build a "deny list" but negative lookup ahead are not supported on Nix.
|
|
As a workaround, we have to register all our submodules in this allow list...
|
|
*/
|
|
''^(src|tests)'' # fixed default
|
|
''.*\.(rs|toml)$'' # fixed default
|
|
''^(crdt|replication|cli|helper)'' # our crate submodules
|
|
];
|
|
};
|
|
|
|
in
|
|
if compileMode == "test"
|
|
then builtins.mapAttrs (name: value: rustPkgs.workspace.${name} { inherit compileMode; }) rustPkgs.workspace
|
|
else rustPkgs.workspace.garage { inherit compileMode; }
|