Add a warning about duplicate files in SEMANTICS.md #755
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Vladislav Volodkin <[email protected]>
vladem
had a problem deploying
to
PR integration tests
GitHub Actions
Failure
vladem
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
vladem
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
vladem
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
vladem
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
vladem
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
vladem
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
sauraank
reviewed
Feb 27, 2024
| @@ -45,6 +45,9 @@ Not all S3 object keys correspond to valid file names, and these objects will no | |||
|
|
|||
| then mounting your bucket with Mountpoint will show only the `blue` directory, containing the file `image.jpg`. The `blue` object will not be accessible. See the [detailed semantics](#mapping-s3-object-keys-to-files-and-directories) below for more information about invalid object keys. | |||
|
|
|||
| > [!IMPORTANT] | |||
| > Please note, that there is a known [issue](https://github.com/awslabs/mountpoint-s3/issues/725) with `readdir` operation (used to list files in a directory), which results in duplicate files in the response. Duplicate files may occur for any type of a bucket if it contains keys which should be hidden according to the semantics described above. E.g. for bucket with keys `blue` and `blue/image.jpg` two files with the name `blue` may be shown, and none of those may be a directory file. | |||
There was a problem hiding this comment.
and none of those may be a directory file.
Actually, for express bucket, only directory was accessible.
dannycjones
reviewed
Jul 2, 2024
Comment on lines
+48
to
+49
| > [!IMPORTANT] | ||
| > Please note, that there is a known [issue](https://github.com/awslabs/mountpoint-s3/issues/725) with `readdir` operation (used to list files in a directory), which results in duplicate files in the response. Duplicate files may occur for any type of a bucket if it contains keys which should be hidden according to the semantics described above. E.g. for bucket with keys `blue` and `blue/image.jpg` two files with the name `blue` may be shown, and none of those may be a directory file. |
There was a problem hiding this comment.
and none of those may be a directory file.
Are we sure this is the case? I understand where we may see a directory and a file returned, but not two entries both for directories.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of change
Update documentation to warn about a case when
readdirdoes not follow our semantics.Note that for Express buckets the problem is already in TROUBLESHOOTING.md, but for Standard buckets its not mentioned anywhere.
Does this change impact existing behavior?
This is not a breaking change.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and I agree to the terms of the Developer Certificate of Origin (DCO).