coder/scaletest/dashboard/config.go

package dashboard

import (
	"context"
	"net/url"
	"time"

	"cdr.dev/slog"

	"golang.org/x/xerrors"
)

type Config struct {
	// Interval is the minimum interval between fetches.
	Interval time.Duration `json:"interval"`
	// Jitter is the maximum interval between fetches.
	Jitter time.Duration `json:"jitter"`
	// Trace is whether to trace the requests.
	Trace bool `json:"trace"`
	// Logger is the logger to use.
	Logger slog.Logger `json:"-"`
	// Headless controls headless mode for chromedp.
	Headless bool `json:"headless"`
	// ActionFunc is a function that returns an action to run.
	ActionFunc func(ctx context.Context, log slog.Logger, randIntn func(int) int, deadline time.Time) (Label, Action, error) `json:"-"`
	// WaitLoaded is a function that waits for the page to be loaded.
	WaitLoaded func(ctx context.Context, deadline time.Time) error
	// Screenshot is a function that takes a screenshot.
	Screenshot func(ctx context.Context, filename string) (string, error)
	// RandIntn is a function that returns a random number between 0 and n-1.
	RandIntn func(int) int `json:"-"`
	// InitChromeDPCtx is a function that initializes ChromeDP into the given context.Context.
	InitChromeDPCtx func(ctx context.Context, log slog.Logger, u *url.URL, sessionToken string, headless bool) (context.Context, context.CancelFunc, error) `json:"-"`
}

func (c Config) Validate() error {
	if !(c.Interval > 0) {
		return xerrors.Errorf("validate interval: must be greater than zero")
	}

	if !(c.Jitter < c.Interval) {
		return xerrors.Errorf("validate jitter: must be less than interval")
	}

	return nil
}