Refacto load all functions
Unbounded LoadAll* loaders materialised an entire result set in one query with no ceiling. A table that is small in development can grow without bound in production, so these loaders were a latent memory and query-time hazard. Remove the LoadAll* methods from pkg/coredata and walk the cursor- paginated LoadBy* siblings instead through a shared page.LoadAll helper. The helper advances a MaxCursorSize forward cursor until the result set is exhausted and concatenates the pages. It caps a single call at MaxLoadAllPages (20) batches of 500 rows and errors past that rather than materialising an unbounded set, so a runaway caller fails loudly instead of exhausting memory. Callers that genuinely need every row now express that explicitly, and the coredata load-naming rule and docs are updated to discourage new unbounded loaders. Signed-off-by: Sacha Al Himdani <sacha@probo.com>
This commit is contained in:
committed by
Sacha Al Himdani
parent
853f2404a6
commit
9ab8ea2085
179
pkg/page/load_all_test.go
Normal file
179
pkg/page/load_all_test.go
Normal file
@@ -0,0 +1,179 @@
|
||||
// Copyright (c) 2026 Probo Inc <hello@probo.com>.
|
||||
//
|
||||
// Permission to use, copy, modify, and/or distribute this software for any
|
||||
// purpose with or without fee is hereby granted, provided that the above
|
||||
// copyright notice and this permission notice appear in all copies.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
||||
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
||||
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
||||
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
||||
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
||||
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||
// PERFORMANCE OF THIS SOFTWARE.
|
||||
|
||||
package page
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"go.probo.inc/probo/pkg/gid"
|
||||
)
|
||||
|
||||
// loadAllItem is a minimal Paginable used to exercise LoadAll without a
|
||||
// database. Values are unique so ordering is fully determined by value and
|
||||
// the id tiebreak is never decisive.
|
||||
type loadAllItem struct {
|
||||
id gid.GID
|
||||
value int
|
||||
}
|
||||
|
||||
func (i *loadAllItem) CursorKey(_ testOrderField) CursorKey {
|
||||
return CursorKey{ID: i.id, Value: i.value}
|
||||
}
|
||||
|
||||
// newLoadAllStore builds n items pre-sorted ascending by value (value == i).
|
||||
func newLoadAllStore(n int) []*loadAllItem {
|
||||
tenantID := gid.NewTenantID()
|
||||
|
||||
store := make([]*loadAllItem, n)
|
||||
for i := range store {
|
||||
store[i] = &loadAllItem{id: gid.New(tenantID, 1), value: i}
|
||||
}
|
||||
|
||||
return store
|
||||
}
|
||||
|
||||
// keysetPage mimics the SQL a coredata LoadBy* method runs for a forward
|
||||
// (ascending, Head) cursor: it returns the over-fetched window the cursor
|
||||
// asks for (Size+1 rows with no key, Size+2 once a key is set, including the
|
||||
// boundary row) so NewPage can trim it exactly as it would in production.
|
||||
func keysetPage(store []*loadAllItem, cursor *Cursor[testOrderField]) []*loadAllItem {
|
||||
limit := cursor.Size + 1
|
||||
if cursor.Key != nil {
|
||||
limit = cursor.Size + 2
|
||||
}
|
||||
|
||||
var out []*loadAllItem
|
||||
|
||||
for _, it := range store {
|
||||
if cursor.Key != nil {
|
||||
keyValue := cursor.Key.Value.(int)
|
||||
if it.value < keyValue {
|
||||
continue
|
||||
}
|
||||
|
||||
if it.value == keyValue && it.id.String() < cursor.Key.ID.String() {
|
||||
continue
|
||||
}
|
||||
}
|
||||
|
||||
out = append(out, it)
|
||||
if len(out) == limit {
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
return out
|
||||
}
|
||||
|
||||
func loadAllValues(items []*loadAllItem) []int {
|
||||
values := make([]int, len(items))
|
||||
for i, it := range items {
|
||||
values[i] = it.value
|
||||
}
|
||||
|
||||
return values
|
||||
}
|
||||
|
||||
func ascOrderBy() OrderBy[testOrderField] {
|
||||
return OrderBy[testOrderField]{
|
||||
Field: testOrderField("value"),
|
||||
Direction: OrderDirectionAsc,
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoadAll(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
count int
|
||||
expectedFetchs int
|
||||
}{
|
||||
{name: "empty result set", count: 0, expectedFetchs: 1},
|
||||
{name: "single short page", count: 10, expectedFetchs: 1},
|
||||
{name: "exactly one full page", count: MaxCursorSize, expectedFetchs: 1},
|
||||
{name: "two pages", count: MaxCursorSize + 1, expectedFetchs: 2},
|
||||
{name: "several pages", count: 2*MaxCursorSize + 7, expectedFetchs: 3},
|
||||
{name: "at the page-count limit", count: MaxLoadAllPages * MaxCursorSize, expectedFetchs: MaxLoadAllPages},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
store := newLoadAllStore(tt.count)
|
||||
|
||||
fetchs := 0
|
||||
got, err := LoadAll(
|
||||
context.Background(),
|
||||
ascOrderBy(),
|
||||
func(_ context.Context, cursor *Cursor[testOrderField]) ([]*loadAllItem, error) {
|
||||
fetchs++
|
||||
return keysetPage(store, cursor), nil
|
||||
},
|
||||
)
|
||||
|
||||
require.NoError(t, err)
|
||||
require.Len(t, got, tt.count)
|
||||
assert.Equal(t, loadAllValues(store), loadAllValues(got), "every row returned exactly once, in order")
|
||||
assert.Equal(t, tt.expectedFetchs, fetchs, "page count")
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoadAllPropagatesFetchError(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
sentinel := errors.New("boom")
|
||||
|
||||
got, err := LoadAll(
|
||||
context.Background(),
|
||||
ascOrderBy(),
|
||||
func(_ context.Context, _ *Cursor[testOrderField]) ([]*loadAllItem, error) {
|
||||
return nil, sentinel
|
||||
},
|
||||
)
|
||||
|
||||
require.ErrorIs(t, err, sentinel)
|
||||
assert.Nil(t, got)
|
||||
}
|
||||
|
||||
func TestLoadAllRefusesUnboundedResultSet(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
// One row past MaxLoadAllPages full pages keeps HasNext true after the
|
||||
// last allowed page, so LoadAll must bail instead of looping forever.
|
||||
store := newLoadAllStore(MaxLoadAllPages*MaxCursorSize + 1)
|
||||
|
||||
fetchs := 0
|
||||
got, err := LoadAll(
|
||||
context.Background(),
|
||||
ascOrderBy(),
|
||||
func(_ context.Context, cursor *Cursor[testOrderField]) ([]*loadAllItem, error) {
|
||||
fetchs++
|
||||
return keysetPage(store, cursor), nil
|
||||
},
|
||||
)
|
||||
|
||||
require.Error(t, err)
|
||||
assert.Nil(t, got)
|
||||
assert.Contains(t, err.Error(), "result set exceeds")
|
||||
assert.Equal(t, MaxLoadAllPages, fetchs, "stops after walking the max number of pages")
|
||||
}
|
||||
Reference in New Issue
Block a user