Files
tasks/common/collection/paging_iterator.go
Alex ShtinandGitHub 8e8f1b0f7c Remove license header from every file (#7689)
## What changed?
<!-- Describe what has changed in this PR -->
Remove license header from every file. Because it is really hard to
follow in this PR here is the summary:
1. License header is removed from all `.go` and `.proto` files
:fireworks::fireworks:🎆.
2. `LICENSE` file in the root directory has only Temporal and Uber
copyrights.
3. 5 other `LICENSE` files added to the packages which have copyrights
different from Temporal and Uber: Datadog, Xargin, "Mat Ryer, Tyler
Bunnell and contributors".
4. `license_file` flag is removed from all code generation tools.
5. `copyright_file` flag is removed from `go:generate mockgen`
directive.
6. All copyright related targets are removed from `Makefile`.
7. Updated Temporal copyright year to 2025 everywhere.

## Why?
<!-- Tell your future self why have you made these changes -->
I double checked with legal department that it is not needed to have
license header in every file. One file per repo is enough. I put all
copyrights to the root `LICENSE` file and removed header from all other
files. Also updated tools and `Makefile`.
2025-05-01 18:50:21 -07:00

104 lines
2.4 KiB
Go

package collection
type (
// PaginationFn is the function which get a page of results
PaginationFn[V any] func(paginationToken []byte) ([]V, []byte, error)
// PagingIteratorImpl is the implementation of PagingIterator
PagingIteratorImpl[V any] struct {
paginationFn PaginationFn[V]
pageToken []byte
pageErr error
pageItems []V
nextPageItemIndex int
}
)
// NewPagingIterator create a new paging iterator
func NewPagingIterator[V any](
paginationFn PaginationFn[V],
) Iterator[V] {
iter := &PagingIteratorImpl[V]{
paginationFn: paginationFn,
pageToken: nil,
pageErr: nil,
pageItems: nil,
nextPageItemIndex: 0,
}
iter.getNextPage() // this will initialize the paging iterator
return iter
}
// NewPagingIteratorWithToken create a new paging iterator with initial token
func NewPagingIteratorWithToken[V any](
paginationFn PaginationFn[V],
pageToken []byte,
) Iterator[V] {
iter := &PagingIteratorImpl[V]{
paginationFn: paginationFn,
pageToken: pageToken,
pageErr: nil,
pageItems: nil,
nextPageItemIndex: 0,
}
iter.getNextPage() // this will initialize the paging iterator
return iter
}
// HasNext return whether has next item or err
func (iter *PagingIteratorImpl[V]) HasNext() bool {
// pagination encounters error
if iter.pageErr != nil {
return true
}
// still have local cached item to return
if iter.nextPageItemIndex < len(iter.pageItems) {
return true
}
if len(iter.pageToken) != 0 {
iter.getNextPage()
return iter.HasNext()
}
return false
}
// Next return next item or err
func (iter *PagingIteratorImpl[V]) Next() (V, error) {
if !iter.HasNext() {
panic("HistoryEventIterator Next() called without checking HasNext()")
}
if iter.pageErr != nil {
err := iter.pageErr
iter.pageErr = nil
var v V
return v, err
}
// we have cached events
if iter.nextPageItemIndex < len(iter.pageItems) {
index := iter.nextPageItemIndex
iter.nextPageItemIndex++
return iter.pageItems[index], nil
}
panic("HistoryEventIterator Next() should return either a history event or a err")
}
func (iter *PagingIteratorImpl[V]) getNextPage() {
items, token, err := iter.paginationFn(iter.pageToken)
if err == nil {
iter.pageItems = items
iter.pageToken = token
iter.pageErr = nil
} else {
iter.pageItems = nil
iter.pageToken = nil
iter.pageErr = err
}
iter.nextPageItemIndex = 0
}