Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a warning about duplicate files in SEMANTICS.md #755

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

vladem
Copy link
Contributor

@vladem vladem commented Feb 15, 2024

Description of change

Update documentation to warn about a case when readdir does 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).

@vladem vladem temporarily deployed to PR integration tests February 15, 2024 17:40 — with GitHub Actions Inactive
@vladem vladem temporarily deployed to PR integration tests February 15, 2024 17:40 — with GitHub Actions Inactive
@vladem vladem temporarily deployed to PR integration tests February 15, 2024 17:40 — with GitHub Actions Inactive
@vladem vladem temporarily deployed to PR integration tests February 15, 2024 17:40 — with GitHub Actions Inactive
@vladem vladem temporarily deployed to PR integration tests February 15, 2024 17:40 — with GitHub Actions Inactive
@vladem vladem temporarily deployed to PR integration tests February 15, 2024 17:40 — with GitHub Actions Inactive
@@ -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.
Copy link
Contributor

@sauraank sauraank Feb 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and none of those may be a directory file.

Actually, for express bucket, only directory was accessible.

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants