server

type Calls interface {
	// Call checks req, a call made by the app of caller, and forwards it with traceparent.
	Call(ctx context.Context, caller manifest.Manifest, req *runnerv1.CallRequest, traceparent string) (*runnerv1.CallResponse, error)
}

type FileInfo struct {
	// Name is the last element of the file's name.
	Name    string
	Size    int64
	Dir     bool
	ModTime time.Time
}

type Files interface {
	// Stat describes the file or folder name.
	Stat(ctx context.Context, store, name string) (FileInfo, error)
	// ReadDir lists the folder name, in any order.
	ReadDir(ctx context.Context, store, name string) ([]FileInfo, error)
	// Read opens the file name, which Stat found to be a file.
	Read(ctx context.Context, store, name string) (io.ReadCloser, error)
	// Write replaces the file name with what data yields, at most MaxFileSize bytes, whole or not
	// at all: when data or ctx fails, the store stays as it was.
	Write(ctx context.Context, store, name string, data io.Reader) (FileInfo, error)
	// Mkdir makes the folder name and its missing parents. A folder that exists is no error.
	Mkdir(ctx context.Context, store, name string) error
	// Remove removes the file or the empty folder name.
	Remove(ctx context.Context, store, name string) error
	// Rename renames oldName to newName and replaces a file at newName. The server never asks it
	// to replace a folder.
	Rename(ctx context.Context, store, oldName, newName string) error
}

type Mail interface {
	// Send sends msg from the address from, the app's email.from, once for each idempotency key
	// it remembers, and returns the message's id; a repeated key it remembers returns the first
	// message's id.
	Send(ctx context.Context, from string, msg *runnerv1.SendRequest) (string, error)
	// List returns a page of the messages in folder, newest first, and how many it holds.
	List(ctx context.Context, folder string, offset, limit int) ([]*runnerv1.MessageSummary, int, error)
	// Get returns the message id.
	Get(ctx context.Context, id string) (*runnerv1.GetResponse, error)
	// Delete deletes the message id.
	Delete(ctx context.Context, id string) error
	// Move moves the message id to folder.
	Move(ctx context.Context, id, folder string) error
}

type Minter interface {
	// Public returns the key that verifies the tokens it signs.
	Public() ed25519.PublicKey
	// MintCall returns the token of a call from the app caller to the app callee: on behalf of
	// the viewer v, or of the calling app itself when v is nil.
	MintCall(v *viewer.Claims, caller, callee string, now time.Time) (string, error)
}

type Options struct {
	// Dir is the folder where the server makes runner.sock, and mysql.sock when the app declares
	// sqldb. The app makes app.sock there.
	Dir string
	// Manifest is the app's permission list.
	Manifest manifest.Manifest
	// Egress, when not nil, replaces the manifest's egress for the app's requests to outside
	// services: a preview reaches only the entries it shares with the app's live release. It may
	// hold only entries of the manifest's egress.
	Egress []manifest.Egress
	// Env is the environment the app runs in: EnvDev, EnvPreview or EnvProduction.
	Env string
	// Version is the version of the release that Hello reports.
	Version string
	// ViewerKeys verify the viewer tokens the app accepts. There must be at least one.
	ViewerKeys []ed25519.PublicKey
	// CSRFKey signs the app's form tokens: an app accepts the tokens of another instance of it
	// with the same key. It must be at least MinCSRFKey bytes.
	CSRFKey []byte
	// ShareAppSocket makes runner.sock and mysql.sock usable by every user, and has Hello tell
	// the app to do the same with app.sock: for an app that runs as another user. Dir then
	// decides who reaches them.
	ShareAppSocket bool
	// Adopted marks an app that is already running and said Hello to an earlier server. Ready is
	// closed at New; nothing else changes.
	Adopted bool
	// Database is where the proxy on mysql.sock logs in, until SetDatabase changes it. It is set
	// exactly when the app declares sqldb.
	Database *mysqlproxy.Upstream
	// OnDatabaseError, if set, gets each reason the proxy could not open the app's database.
	// It may be called from several goroutines at once.
	OnDatabaseError func(error)
	// OnReady, if set, is called at each Ready the app sends.
	OnReady func()
	// Providers do the work of the building blocks.
	Providers Providers
}

type Outbound interface {
	Do(ctx context.Context, req *http.Request) (*http.Response, error)
}

type Providers struct {
	// Files keeps the file stores. It must be set when the app declares one.
	Files Files
	// Mail sends the app's mail and serves its mailbox. It must be set when the app declares email.
	Mail Mail
	// Secrets holds the values of the app's secrets and settings. It must be set when the app
	// declares either.
	Secrets Secrets
	// Telemetry takes the app's spans. With nil, they are dropped.
	Telemetry Telemetry
	// Calls carries the app's calls to other apps, as Router does. With nil, every call fails
	// with E-RPC-011.
	Calls Calls
	// Outbound sends the app's requests to outside services. It must be set when the app
	// declares egress.
	Outbound Outbound
}

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

type Secrets interface {
	// Secret returns the value of the secret name, which the app declares.
	Secret(ctx context.Context, name string) (string, error)
	// Settings returns the values of the settings. Hello hands the app those it declares. It may
	// be called from several goroutines at once, and the server never changes the map.
	Settings() map[string]string
}

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

type Telemetry interface {
	// Export takes spans, and dropped, the number of spans the app or the server dropped since
	// the previous export.
	Export(ctx context.Context, spans []*runnerv1.Span, dropped uint64)
}