epbinding

type Binding struct {
	ID       string `json:"id"`
	ScriptID string `json:"script_id"`
	// Name is the endpoint's segment of /endpoints/{name}, unique across the
	// deployment.
	Name string `json:"name" example:"order-lookup"`
	// Methods are the HTTP methods it answers.
	Methods []string `json:"methods" example:"GET"`
	// Path is the template under /endpoints/{name}: "" for the name alone,
	// "/{id}" for one parameter a request reads as req.params["id"].
	Path string `json:"path" example:"/{id}"`
	// AuthMode is authenticated, public or bot_check.
	AuthMode string `json:"auth_mode" example:"authenticated"`
	// Callers is who an authenticated endpoint admits besides the
	// administrator: "*" for every authenticated caller, "persona:<name>" and
	// "api_key:<name>". Empty admits no one but the administrator.
	Callers []string `json:"callers" example:"persona:analyst"`
	// BotCheck is the named bot check a bot_check endpoint requires.
	BotCheck string `json:"bot_check,omitempty" example:"default"`
	// CheckedMethods are the methods a bot_check endpoint checks, empty for
	// every method it answers; HEAD is checked where GET is.
	CheckedMethods []string `json:"checked_methods"`
	// TimeoutSeconds, MaxMemoryBytes and MaxBodyBytes bound one request.
	TimeoutSeconds int   `json:"timeout_seconds"`
	MaxMemoryBytes int64 `json:"max_memory_bytes"`
	MaxBodyBytes   int   `json:"max_body_bytes"`
	// AllowedOrigins are the browser origins a cross-origin request may come
	// from; empty answers no preflight.
	AllowedOrigins []string `json:"allowed_origins"`
	// RateLimit is the endpoint's requests per minute on each replica, and
	// CallerRateLimit one signed-in caller's.
	RateLimit       int       `json:"rate_limit"`
	CallerRateLimit int       `json:"caller_rate_limit"`
	Enabled         bool      `json:"enabled"`
	CreatedBy       string    `json:"created_by,omitempty"`
	UpdatedBy       string    `json:"updated_by,omitempty"`
	CreatedAt       time.Time `json:"created_at"`
	UpdatedAt       time.Time `json:"updated_at"`
}

type Caller struct {
	// Admin is whether the caller is the platform's administrator, whom every
	// authenticated endpoint admits whatever its callers say: an
	// administrator is unrestricted on every surface.
	Admin bool
	// Persona is the persona the caller's roles resolve to, empty when none.
	Persona string
	// APIKey is the name of the API key the request carried, empty for a
	// browser session.
	APIKey string
}

type Failure struct {
	ID         string    `json:"id"`
	EndpointID string    `json:"endpoint_id"`
	Version    int       `json:"version"`
	Method     string    `json:"method"`
	Status     int       `json:"status"`
	Error      string    `json:"error"`
	DurationMS int64     `json:"duration_ms"`
	CreatedAt  time.Time `json:"created_at"`
}

type Filter struct {
	ScriptIDs []string
	AuthMode  string
	Enabled   *bool
	Limit     int
	Offset    int
}

type Request struct {
	Name     string
	Methods  []string
	Path     *string
	AuthMode string
	// Callers, BotCheck and CheckedMethods are nil or empty to keep what the
	// binding had; a change of mode clears what the old mode named.
	Callers         []string
	BotCheck        string
	CheckedMethods  []string
	TimeoutSeconds  int
	MaxMemoryBytes  int64
	MaxBodyBytes    int
	AllowedOrigins  []string
	RateLimit       int
	CallerRateLimit int
	Enabled         *bool
	Actor           string
}

type Stamp struct {
	Binding time.Time
	Script  time.Time
}

type Store interface {
	// Set creates or replaces sc's binding, keyed by its script; a name
	// another script's binding has is ErrNameTaken.
	Set(ctx context.Context, b *Binding) error
	// Get is a script's binding, ErrNotFound when it has none.
	Get(ctx context.Context, scriptID string) (*Binding, error)
	// GetByName is the binding a name serves, ErrNotFound when none does.
	GetByName(ctx context.Context, name string) (*Binding, error)
	// List is one page of the bindings filter matches, by name, and how
	// many it matches in all.
	List(ctx context.Context, filter Filter) (page []Binding, total int, err error)
	// SetEnabled turns a script's binding on or off.
	SetEnabled(ctx context.Context, scriptID string, enabled bool, actor string) error
	// RecordFailure keeps one failed request.
	RecordFailure(ctx context.Context, f Failure) error
	// Failures is an endpoint's most recent failed requests, newest first.
	Failures(ctx context.Context, endpointID string, limit int) ([]Failure, error)
	// SweepFailures deletes the failures recorded before cutoff.
	SweepFailures(ctx context.Context, cutoff time.Time) (int64, error)
	// Stamp is when the binding a name serves, and the script it binds, were
	// last written: one read that tells a replica whether what it compiled
	// for the name is still current. ErrNotFound when no binding has it.
	Stamp(ctx context.Context, name string) (Stamp, error)
}