feat(storage): allow specifying includeTrailingDelimiter #5617
Conversation
gaul
force-pushed
the
gcs/include-trailing-delimiter
branch
from
21a4344
to
733f824
Compare
gaul
changed the title
product-auto-label
bot
added
the
api: storage
storage/storage.go
Outdated
| @@ -1588,6 +1588,11 @@ type Query struct { | |||
| // which returns all properties. Passing ProjectionNoACL will omit Owner and ACL, | |||
| // which may improve performance when listing many objects. | |||
| Projection Projection | |||
|
|
|||
| // If true, objects that end in exactly one instance of delimiter have | |||
There was a problem hiding this comment.
I see this is copied from the API docs, but it should be rephrased based on how this is exposed via ObjectIterator in this library and based on godoc standards. I would say something like:
IncludeTrailingDelimiter controls how objects which end in a single instance of Delimiter (for example, if Query.Delimiter = "/" and the object name is "foo/bar/") are included in the results. By default, these objects only show up as prefixes. If IncludeTrailingDelimiter is set to true, they will also be included as objects and their metadata will be populated in the returned ObjectAttrs.
| // If true, objects that end in exactly one instance of delimiter have | ||
| // their metadata included in items[] in addition to the relevant part of | ||
| // the object name appearing in prefixes[]. | ||
| IncludeTrailingDelimiter bool | ||
| } |
There was a problem hiding this comment.
Can you also write an integration test to verify that this behaves as expected with real objects? Example for Query.Projection is here:
google-cloud-go/storage/integration_test.go
Line 1902 in 9f79ac4
There was a problem hiding this comment.
I read through the integration test scrolls but the evil wizard frightened me. I tried again with some magical potions 🍷 but this quest seems to require some serious XP. Is there a cheat code to avoid grinding?
There was a problem hiding this comment.
For this use case we can sidestep most of the suggested configuration:
(cd storage/ && GCLOUD_TESTS_GOLANG_KEY=/path/to/creds.json GCLOUD_TESTS_GOLANG_PROJECT_ID=proj go test -v -run TestIntegration_Objects)
733f824
to
a3978ec
Compare
gaul
force-pushed
the
gcs/include-trailing-delimiter
branch
from
a3978ec
to
b0a25e2
Compare
tritone
added
the
kokoro:force-run
kokoro-team
removed
the
kokoro:force-run
tritone
added
the
kokoro:force-run
kokoro-team
removed
the
kokoro:force-run
References fsouza/fake-gcs-server#676.