droboticflow/internal/store/query_build_lifecycle.go
2026-11-15 08:11:09 -08:00

70 lines
2.1 KiB
Go

package store
import (
"context"
"errors"
"fmt"
"time"
)
// Yield is successful bounded progress, not loss of the source safety permit.
// Callers retain pending work and do not stop projector/builder replicas.
var ErrQueryBuildYielded = errors.New("query build round yielded with durable progress retained")
var ErrQueryBuildStopped = errors.New("query build stopped; durable checkpoint retained")
var ErrQueryBuildNoProgress = errors.New("query build made no durable progress")
const (
queryColdRoundBudget = time.Minute
queryRefreshRoundBudget = 30 * time.Second
queryBuildOperationBudget = 15 * time.Second
queryBuildNoProgressLimit = 5 * time.Minute
)
type queryBuildRound struct {
until time.Time
now func() time.Time
}
func newQueryBuildRound(cold bool) *queryBuildRound {
budget := queryRefreshRoundBudget
if cold {
budget = queryColdRoundBudget
}
return &queryBuildRound{until: time.Now().Add(budget), now: time.Now}
}
func (r *queryBuildRound) check(ctx context.Context) error {
if err := ctx.Err(); err != nil {
return err
}
if r != nil && !r.now().Before(r.until) {
return ErrQueryBuildYielded
}
return nil
}
// Operation deadlines bound a single read/commit. They do not shorten the
// lifetime of the initial job or discard any previously confirmed checkpoint.
func queryBuildOperation(ctx context.Context) (context.Context, context.CancelFunc) {
return context.WithTimeout(ctx, queryBuildOperationBudget)
}
func queryBuildPhaseFailure(phase string, err error) error {
if err == nil || errors.Is(err, ErrQueryBuildYielded) {
return err
}
return fmt.Errorf("query build %s: %w", phase, err)
}
// Admission/checkpoint backpressure before a write is a resumable yield. A
// failed durable transaction is never converted into success or budget yield.
func (s *MongoStore) queryBuildPace(ctx context.Context, bytes int) error {
op, stop := queryBuildOperation(ctx)
defer stop()
err := s.paceQueryBuild(op, bytes)
if err != nil && ctx.Err() == nil && errors.Is(op.Err(), context.DeadlineExceeded) {
return ErrQueryBuildYielded
}
return err
}