plugins

type ChainFunc func(PipelineFunc) PipelineFunc

type ClientConnection struct {
	// Address of client connection
	Addr net.Addr
	// According to the docs (https://docs.mongodb.com/manual/core/authentication/#authentication-methods) multiple logins should
	// have the credentials for all until a logout happens; for now we aren't doing that.
	Identities []ClientIdentity

	// Map is storage that resets on cursor change
	Map map[interface{}]interface{}
}

type ClientIdentity interface {
	Type() string // Where the identity came from
	User() string
	Roles() []string
}

type CursorCache interface {
	GetCursor(cursorID int64) *CursorCacheEntry
	CloseCursor(cursorID int64)
}

type CursorCacheEntry struct {
	ID             int64
	CursorConsumed int

	// Map is storage that resets on cursor change
	Map map[interface{}]interface{}
}

type PipelineFunc func(context.Context, *Request) (bson.D, error)

type Plugin interface {
	// Name returns the name for the given plugin
	Name() string

	// Configure configures this plugin with the given configuration object. Returns
	// an error if the configuration is invalid for the plugin.
	Configure(bson.D) error

	// Process is the function executed when a message is called in the pipeline.
	Process(context.Context, *Request, PipelineFunc) (bson.D, error)
}

type PluginFunc func() Plugin

type Request struct {
	CC *ClientConnection
	CursorCache

	CommandName string
	Command     command.Command

	// Map of arbitrary data for plugins to store stuff in
	Map map[string]interface{}
}

type StaticIdentity struct {
	T  string   `bson"type"`
	U  string   `bson:"user"`
	RS []string `bson:"roles"`
}