-
Notifications
You must be signed in to change notification settings - Fork 844
RM-27055 added Queue methods: GetItems, GetItem, Search, Clear #163
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
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -145,6 +145,25 @@ func (items *items) getUntil(checker func(item interface{}) bool) []interface{} | |
return returnItems | ||
} | ||
|
||
func (items *items) getMatch(checker func(item interface{}) bool) []interface{} { | ||
length := len(*items) | ||
|
||
if len(*items) == 0 { | ||
// returning nil here actually wraps that nil in a list | ||
// of interfaces... thanks go | ||
return []interface{}{} | ||
} | ||
|
||
returnItems := make([]interface{}, 0, length) | ||
for _, item := range *items { | ||
if !checker(item) { | ||
returnItems = append(returnItems, item) | ||
} | ||
} | ||
|
||
return returnItems | ||
} | ||
|
||
type sema struct { | ||
ready chan bool | ||
response *sync.WaitGroup | ||
|
@@ -323,6 +342,51 @@ func (q *Queue) Len() int64 { | |
return int64(len(q.items)) | ||
} | ||
|
||
// GetItems returns items in this queue. | ||
func (q *Queue) GetItems() []interface{} { | ||
q.lock.Lock() | ||
defer q.lock.Unlock() | ||
|
||
return q.items | ||
} | ||
|
||
// Search takes a function and returns a list of items that | ||
// match the checker. This does not wait and remove items. | ||
func (q *Queue) Search(checker func(item interface{}) bool) ([]interface{}) { | ||
if checker == nil { | ||
return nil | ||
} | ||
|
||
q.lock.Lock() | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I realize that this is an ancient PR, but it might be better to do a single deferred unlock here as is done elsewhere in this file. |
||
|
||
if q.disposed { | ||
q.lock.Unlock() | ||
return nil | ||
} | ||
|
||
result := q.items.getMatch(checker) | ||
q.lock.Unlock() | ||
return result | ||
} | ||
|
||
|
||
// GetItem returns one item without deleting in this queue. | ||
func (q *Queue) GetItem(pos int) (interface{}, bool) { | ||
q.lock.Lock() | ||
defer q.lock.Unlock() | ||
if len(q.items) > pos { | ||
return q.items[pos], true | ||
} | ||
return nil, false | ||
} | ||
|
||
// GetItems returns items in this queue. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Comment doesn't seem to define the exact behavior. |
||
func (q *Queue) Clear(hint int64) { | ||
q.lock.Lock() | ||
defer q.lock.Unlock() | ||
q.items = make([]interface{}, 0, hint) | ||
} | ||
|
||
// Disposed returns a bool indicating if this queue | ||
// has had disposed called on it. | ||
func (q *Queue) Disposed() bool { | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -190,6 +190,57 @@ func TestGetEmpty(t *testing.T) { | |
assert.Equal(t, `a`, result[0]) | ||
} | ||
|
||
func TestGetItems(t *testing.T) { | ||
q := New(10) | ||
|
||
q.Put(`a`) | ||
|
||
result := q.GetItems() | ||
|
||
assert.Len(t, result, 1) | ||
assert.Equal(t, `a`, result[0]) | ||
} | ||
|
||
func TestSearch(t *testing.T) { | ||
q := New(10) | ||
|
||
q.Put(`a`) | ||
q.Put(`b`) | ||
q.Put(`c`) | ||
|
||
result := q.Search(func(item interface{}) bool { | ||
return item != `b` | ||
}) | ||
|
||
assert.Len(t, result, 1) | ||
assert.Equal(t, `b`, result[0]) | ||
} | ||
|
||
func TestGetItem(t *testing.T) { | ||
q := New(10) | ||
|
||
q.Put(`a`) | ||
|
||
result, ok := q.GetItem(0) | ||
if !assert.Equal(t, ok, true) { | ||
return | ||
} | ||
|
||
assert.Equal(t, `a`, result) | ||
} | ||
|
||
func TestClear(t *testing.T) { | ||
q := New(10) | ||
|
||
q.Put(`a`) | ||
|
||
result := q.GetItems() | ||
assert.Len(t, result, 1) | ||
q.Clear(10) | ||
result = q.GetItems() | ||
assert.Len(t, result, 0) | ||
} | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thank you for adding/expanding tests. |
||
func TestMultipleGetEmpty(t *testing.T) { | ||
q := New(10) | ||
var wg sync.WaitGroup | ||
|
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.
to me it seems unintuitive that this would return objects that do not pass checker, I'd expect the opposite behavior
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.
Agreed. This logic should probably be inverted and the name changed to something like
matcher
.