Skip to content

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions queue/queue.go
Original file line number Diff line number Diff line change
Expand Up @@ -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) {

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

returnItems = append(returnItems, item)
}
}

return returnItems
}

type sema struct {
ready chan bool
response *sync.WaitGroup
Expand Down Expand Up @@ -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()

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.

Choose a reason for hiding this comment

The 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 {
Expand Down
51 changes: 51 additions & 0 deletions queue/queue_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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)
}

func TestMultipleGetEmpty(t *testing.T) {
q := New(10)
var wg sync.WaitGroup
Expand Down