pluginkit

type Failure struct {
	ID   string
	Step Step
	// Panicked is true only for a panic this step recovered, never for an error that merely holds one.
	Panicked bool
	Err      error
}

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

type MigrationStore interface {
	// Versions returns every recorded version, keyed by plugin id, in one read.
	Versions(ctx context.Context) (map[string]string, error)
	// Record stores version as the one plugin id has now applied.
	Record(ctx context.Context, id, version string) error
}

type MigrationVersioner interface {
	// MigrationVersion returns the version of the schema, which a host compares as an opaque string.
	MigrationVersion() (string, error)
}

type Migrator interface {
	// Migrate applies the plugin's schema, returning by the time ctx ends.
	Migrate(ctx context.Context) error
}

type MigratorOf func(Plugin) (Migrator, bool)

type Plugin interface {
	ID() string
	// Start readies the plugin, returning by the time ctx ends, and may run again after Stop.
	Start(ctx context.Context) error
	// Stop releases what the plugin holds by the time ctx ends, whether or not Start ran, and may run more than once.
	Stop(ctx context.Context) error
}

type PublicPathProvider interface {
	// PublicPaths returns those paths, whether or not Start ran or worked.
	PublicPaths() []string
}

type RouteProvider interface {
	// Routes returns the plugin's handler, whether or not Start ran or worked.
	Routes() http.Handler
}

type Seeder interface {
	Seed(ctx context.Context) error
}

type StartOutcome struct {
	Started []StartedPlugin
	Failed  []Failure
}

type StartedPlugin struct {
	ID   string
	Took time.Duration
}

type Step string