Michael Milton
9c3eb16046
* Session list pagination refactor * address pr comments, add explanatory comments, clean up sql queries, move tests into proper files * fix build error * fix test error
57 lines
1.7 KiB
Go
57 lines
1.7 KiB
Go
// Copyright (c) HashiCorp, Inc.
|
|
// SPDX-License-Identifier: BUSL-1.1
|
|
|
|
package session
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"github.com/hashicorp/boundary/internal/errors"
|
|
"github.com/hashicorp/boundary/internal/pagination"
|
|
)
|
|
|
|
// List lists up to page size sessions, filtering out entries that
|
|
// do not pass the filter item function. It will automatically request
|
|
// more sessions from the database, at page size chunks, to fill the page.
|
|
// It returns a new list token used to continue pagination or refresh items.
|
|
// Sessions are ordered by create time descending (most recently created first).
|
|
func List(
|
|
ctx context.Context,
|
|
grantsHash []byte,
|
|
pageSize int,
|
|
filterItemFn pagination.ListFilterFunc[*Session],
|
|
repo *Repository,
|
|
includeTerminated bool,
|
|
) (*pagination.ListResponse[*Session], error) {
|
|
const op = "session.List"
|
|
|
|
switch {
|
|
case len(grantsHash) == 0:
|
|
return nil, errors.New(ctx, errors.InvalidParameter, op, "missing grants hash")
|
|
case pageSize < 1:
|
|
return nil, errors.New(ctx, errors.InvalidParameter, op, "page size must be at least 1")
|
|
case filterItemFn == nil:
|
|
return nil, errors.New(ctx, errors.InvalidParameter, op, "missing filter item callback")
|
|
case repo == nil:
|
|
return nil, errors.New(ctx, errors.InvalidParameter, op, "missing repo")
|
|
}
|
|
|
|
listItemsFn := func(ctx context.Context, lastPageItem *Session, limit int) ([]*Session, time.Time, error) {
|
|
opts := []Option{
|
|
WithLimit(limit),
|
|
}
|
|
if lastPageItem != nil {
|
|
opts = append(opts, WithStartPageAfterItem(lastPageItem))
|
|
}
|
|
if includeTerminated {
|
|
opts = append(opts,
|
|
WithTerminated(includeTerminated),
|
|
)
|
|
}
|
|
return repo.listSessions(ctx, opts...)
|
|
}
|
|
|
|
return pagination.List(ctx, grantsHash, pageSize, filterItemFn, listItemsFn, repo.estimatedCount)
|
|
}
|