Separate matchers as a bucket filter #3229
There are no files selected for viewing
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
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
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
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| // Copyright 2020-2024 Buf Technologies, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package storage | ||
|
|
||
| import ( | ||
| "context" | ||
| "io/fs" | ||
|
|
||
| "github.com/bufbuild/buf/private/pkg/normalpath" | ||
| ) | ||
|
|
||
| // FilterReadBucket filters the ReadBucket. | ||
| // | ||
| // If the Matchers are empty, the original ReadBucket is returned. | ||
| // If there is more than one Matcher, the Matchers are anded together. | ||
| func FilterReadBucket(readBucket ReadBucket, matchers ...Matcher) ReadBucket { | ||
| if len(matchers) == 0 { | ||
| return readBucket | ||
| } | ||
| return newFilterReadBucketCloser(readBucket, nil, MatchAnd(matchers...)) | ||
| } | ||
|
|
||
| // FilterReadBucketCloser filters the ReadBucketCloser. | ||
| // | ||
| // If the Matchers are empty, the original ReadBucketCloser is returned. | ||
| // If there is more than one Matcher, the Matchers are anded together. | ||
| func FilterReadBucketCloser(readBucketCloser ReadBucketCloser, matchers ...Matcher) ReadBucket { | ||
| if len(matchers) == 0 { | ||
| return readBucketCloser | ||
| } | ||
| return newFilterReadBucketCloser(readBucketCloser, readBucketCloser.Close, MatchAnd(matchers...)) | ||
| } | ||
|
|
||
| type filterReadBucketCloser struct { | ||
| delegate ReadBucket | ||
| closeFunc func() error | ||
| matcher Matcher | ||
| } | ||
|
|
||
| func newFilterReadBucketCloser( | ||
| delegate ReadBucket, | ||
| closeFunc func() error, | ||
| matcher Matcher, | ||
| ) *filterReadBucketCloser { | ||
| return &filterReadBucketCloser{ | ||
| delegate: delegate, | ||
| closeFunc: closeFunc, | ||
| matcher: matcher, | ||
| } | ||
| } | ||
|
|
||
| func (r *filterReadBucketCloser) Get(ctx context.Context, path string) (ReadObjectCloser, error) { | ||
| path, err := normalpath.NormalizeAndValidate(path) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if !r.matcher.MatchPath(path) { | ||
| return nil, &fs.PathError{Op: "read", Path: path, Err: fs.ErrNotExist} | ||
| } | ||
| return r.delegate.Get(ctx, path) | ||
| } | ||
|
|
||
| func (r *filterReadBucketCloser) Stat(ctx context.Context, path string) (ObjectInfo, error) { | ||
| path, err := normalpath.NormalizeAndValidate(path) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if !r.matcher.MatchPath(path) { | ||
| return nil, &fs.PathError{Op: "read", Path: path, Err: fs.ErrNotExist} | ||
| } | ||
| return r.delegate.Stat(ctx, path) | ||
| } | ||
|
|
||
| func (r *filterReadBucketCloser) Walk(ctx context.Context, prefix string, f func(ObjectInfo) error) error { | ||
| prefix, err := normalpath.NormalizeAndValidate(prefix) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| return r.delegate.Walk( | ||
| ctx, | ||
| prefix, | ||
| func(objectInfo ObjectInfo) error { | ||
| if !r.matcher.MatchPath(objectInfo.Path()) { | ||
| return nil | ||
| } | ||
| return f(objectInfo) | ||
| }, | ||
| ) | ||
| } | ||
|
|
||
| func (r *filterReadBucketCloser) Close() error { | ||
| if r.closeFunc != nil { | ||
| return r.closeFunc() | ||
| } | ||
| return nil | ||
| } | ||
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Chose
FilterReadBucketoverMatchReadBucket, the naming of filter with the filter funcs being called matchers I think is still clear. We could also rename Matchers to FIlters?