catalog

type Diagnostics struct {
	Status Status `json:"status"`
	// FailureCode is a providers.CatalogError code without the gateway's
	// catalog_ prefix, or one of the Failure codes.
	FailureCode    string `json:"failure_code,omitempty"`
	Detail         string `json:"detail,omitempty"`
	UpstreamStatus int    `json:"upstream_status,omitempty"`
	// Stale reports a catalog served past its TTL.
	Stale bool `json:"stale"`
	// FromCache reports a catalog served as stored, not just discovered.
	FromCache bool `json:"from_cache"`
}

type Invalidation int

type Options struct {
	// Store keeps the catalogs. Nil keeps them in this Service's memory.
	// A core.ConditionalCatalogStore fences discoveries in every process
	// that shares it; any other store fences them within this Service.
	Store core.CatalogStore
	// TTL is how long a catalog is served before a read discovers it
	// again. Zero or less uses DefaultTTL.
	TTL time.Duration
	// InstanceTTL gives an instance its own TTL. A result of zero or less
	// uses TTL.
	InstanceTTL func(instance string) time.Duration
	// SchemaVersion stamps every catalog the Service stores. A stored
	// catalog stamped otherwise is neither served nor kept as stale: the
	// rules that wrote it are not the rules that would read it.
	SchemaVersion int
	// KeepStale serves the stored catalog, marked stale, beside the error
	// of a discovery that fails, as the gateway does. Without it a failed
	// discovery returns only its error.
	KeepStale bool
	// Now returns the current time. Nil uses time.Now.
	Now func() time.Time
}

type Read struct {
	// Record is the catalog served, or the zero record when there is none.
	Record core.CatalogRecord
	// Diagnostics describe the read without its rows.
	Diagnostics Diagnostics
	// Err is why the read could not discover or serve a catalog. With
	// Options.KeepStale, Record may hold the stale catalog beside it.
	Err error
}

type Request struct {
	Key core.CatalogKey
	// Discover lists the catalog upstream. A read calls it when the stored
	// catalog is missing or no longer fresh.
	Discover func(ctx context.Context) ([]core.ModelInfo, error)
	// NotBefore makes a catalog observed before it no longer fresh, as a
	// Runtime does with catalogs observed before its settings changed.
	NotBefore time.Time
	// Rebase is asked whether a discovery that exactly one hard
	// invalidation fenced may store anyway, as the gateway lets an
	// operation whose own credential write caused the invalidation keep
	// its result. Nil never rebases. It must not call the Service.
	Rebase func() bool
}

type Service struct {
	// contains filtered or unexported fields
}

type Status string