Skip to content

Fix bug in directory detection logic for GCS #457

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

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

Conversation

nnutter
Copy link

@nnutter nnutter commented Feb 12, 2025

If a file exists that is a superset of the filename, for example, "file1" and "file12", then this logic would erroneously report the subset path as a directory due to the lack of the trailing delimiter on the prefix.

I don't think the mocks used in unit tests can reproduce this behavior but an example of the behavior using the actual GCS client,

    client := ...
    bucketName := ...

    ctx := context.Background()

    it := client.Bucket(bucketName).Objects(ctx, &storage.Query{Delimiter: "/", Prefix: "testing/file1", Versions: false})
    _, err = it.Next()
    assert.ErrorIs(t, err, iterator.Done)

    object := client.Bucket(bucketName).Object("testing/file12")
    w := object.NewWriter(ctx)
    _, err = w.Write([]byte("test"))
    assert.NoError(t, err)
    err = w.Close()
    assert.NoError(t, err)
    t.Cleanup(func() {
        err := object.Delete(ctx)
        assert.NoError(t, err)
    })

    it = client.Bucket(bucketName).Objects(ctx, &storage.Query{Delimiter: "/", Prefix: "testing/file1/", Versions: false})
    _, err = it.Next()
    assert.ErrorIs(t, err, iterator.Done)

    it = client.Bucket(bucketName).Objects(ctx, &storage.Query{Delimiter: "/", Prefix: "testing/file1", Versions: false})
    _, err = it.Next()
    // This will fail because "file12" is found but that does not mean "file1" is a directory.
    assert.ErrorIs(t, err, iterator.Done)

If a file exists that is a superset of the filename, for example,
"file1" and "file12", then this logic would erroneously report the
subset path as a directory due to the lack of the trailing delimiter on
the prefix.

I don't think the mocks used in unit tests can reproduce this behavior
but an example of the behavior using the actual GCS client,

    it := client.Bucket(bucketName).Objects(ctx, &storage.Query{Delimiter: "/", Prefix: "testing/file1", Versions: false})
    _, err = it.Next()
    assert.ErrorIs(t, err, iterator.Done)

    object := client.Bucket(bucketName).Object("testing/file12")
    w := object.NewWriter(ctx)
    _, err = w.Write([]byte("test"))
    assert.NoError(t, err)
    err = w.Close()
    assert.NoError(t, err)
    t.Cleanup(func() {
        err := object.Delete(ctx)
        assert.NoError(t, err)
    })

    it = client.Bucket(bucketName).Objects(ctx, &storage.Query{Delimiter: "/", Prefix: "testing/file1/", Versions: false})
    _, err = it.Next()
    assert.ErrorIs(t, err, iterator.Done)

    it = client.Bucket(bucketName).Objects(ctx, &storage.Query{Delimiter: "/", Prefix: "testing/file1", Versions: false})
    _, err = it.Next()
    // This will fail because "file12" is found but that does not mean "file1" is a directory.
    assert.ErrorIs(t, err, iterator.Done)
@CLAassistant
Copy link

CLAassistant commented Feb 12, 2025

CLA assistant check
All committers have signed the CLA.

@nnutter nnutter changed the title Fix bug in directory detection logic Fix bug in directory detection logic for GCS Feb 14, 2025
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.

2 participants