plugin

Documentation

Index

• Constants
• func CastToPrimitiveTypes(args map[string]interface{}) map[string]interface{}
• func NewCommand(cmd string, args []string, env []string) *exec.Cmd
• func SHA256SUM(filename string) (string, *gerr.GatewayDError)
• func Verify(params, returnVal *structpb.Struct) bool
• type IHook
• type IPlugin
• type IRegistry
• type Identifier
• type Method
• type Plugin
  • func (p *Plugin) Dispense() (pluginV1.GatewayDPluginServiceClient, *gerr.GatewayDError)
  • func (p *Plugin) Start() (net.Addr, error)
  • func (p *Plugin) Stop()
• type Priority
• type Registry
  • func NewRegistry(compatibility config.CompatibilityPolicy, ...) *Registry
  • func (reg *Registry) Add(plugin *Plugin) bool
  • func (reg *Registry) AddHook(hookName string, priority Priority, hookMethod Method)
  • func (reg *Registry) Exists(name, version, remoteURL string) bool
  • func (reg *Registry) ForEach(f func(Identifier, *Plugin))
  • func (reg *Registry) Get(id Identifier) *Plugin
  • func (reg *Registry) Hooks() map[string]map[Priority]Method
  • func (reg *Registry) List() []Identifier
  • func (reg *Registry) LoadPlugins(plugins []config.Plugin)
  • func (reg *Registry) RegisterHooks(id Identifier)
  • func (reg *Registry) Remove(id Identifier)
  • func (reg *Registry) Run(ctx context.Context, args map[string]interface{}, hookName string, ...) (map[string]interface{}, *gerr.GatewayDError)
  • func (reg *Registry) Shutdown()

Constants

const (
	// Run command hooks (cmd/run.go).
	OnConfigLoaded string = "onConfigLoaded"
	OnNewLogger    string = "onNewLogger"
	OnNewPool      string = "onNewPool"
	OnNewClient    string = "onNewClient"
	OnNewProxy     string = "onNewProxy"
	OnNewServer    string = "onNewServer"
	OnSignal       string = "onSignal"
	// Server hooks (network/server.go).
	OnRun      string = "onRun"
	OnBooting  string = "onBooting"
	OnBooted   string = "onBooted"
	OnOpening  string = "onOpening"
	OnOpened   string = "onOpened"
	OnClosing  string = "onClosing"
	OnClosed   string = "onClosed"
	OnTraffic  string = "onTraffic"
	OnShutdown string = "onShutdown"
	OnTick     string = "onTick"
	// Proxy hooks (network/proxy.go).
	OnTrafficFromClient string = "onTrafficFromClient"
	OnTrafficToServer   string = "onTrafficToServer"
	OnTrafficFromServer string = "onTrafficFromServer"
	OnTrafficToClient   string = "onTrafficToClient"
)

Functions

func CastToPrimitiveTypes

func CastToPrimitiveTypes(args map[string]interface{}) map[string]interface{}

CastToPrimitiveTypes casts the values of a map to its primitive type (e.g. time.Duration to float64) to prevent structpb invalid type(s) errors.

func NewCommand

func NewCommand(cmd string, args []string, env []string) *exec.Cmd

NewCommand returns a command with the given arguments and environment variables.

func SHA256SUM

func SHA256SUM(filename string) (string, *gerr.GatewayDError)

SHA256SUM returns the sha256 checksum of a file. Ref: https://github.com/codingsince1985/checksum A little copying is better than a little dependency.

func Verify

func Verify(params, returnVal *structpb.Struct) bool

Verify compares two structs and returns true if they are equal.

Types

type IHook

type IHook interface {
	AddHook(hookName string, priority Priority, hookMethod Method)
	Hooks() map[string]map[Priority]Method
	Run(
		ctx context.Context,
		args map[string]interface{},
		hookName string,
		opts ...grpc.CallOption,
	) (map[string]interface{}, *gerr.GatewayDError)
}

type IPlugin

type IPlugin interface {
	Start() (net.Addr, error)
	Stop()
	Dispense() (pluginV1.GatewayDPluginServiceClient, *gerr.GatewayDError)
}

type IRegistry

type IRegistry interface {
	// Plugin management
	Add(plugin *Plugin) bool
	Get(id Identifier) *Plugin
	List() []Identifier
	Exists(name, version, remoteURL string) bool
	ForEach(f func(Identifier, *Plugin))
	Remove(id Identifier)
	Shutdown()
	LoadPlugins(plugins []config.Plugin)
	RegisterHooks(id Identifier)

	// Hook management
	IHook
}

type Identifier

type Identifier struct {
	Name      string
	Version   string
	RemoteURL string
	Checksum  string
}

type Method

type Method func(
	context.Context, *structpb.Struct, ...grpc.CallOption) (*structpb.Struct, error)

type Plugin

type Plugin struct {
	goplugin.NetRPCUnsupportedPlugin
	pluginV1.GatewayDPluginServiceServer

	ID          Identifier
	Description string
	Authors     []string
	License     string
	ProjectURL  string
	LocalPath   string
	Args        []string
	Env         []string
	Enabled     bool
	// internal and external config options
	Config map[string]string
	// hooks it attaches to
	Hooks    []string
	Priority Priority
	// required plugins to be loaded before this one
	// Built-in plugins are always loaded first
	Requires   []Identifier
	Tags       []string
	Categories []string
	// contains filtered or unexported fields
}

func (*Plugin) Dispense

func (p *Plugin) Dispense() (pluginV1.GatewayDPluginServiceClient, *gerr.GatewayDError)

Dispense returns the plugin client.

func (*Plugin) Start

func (p *Plugin) Start() (net.Addr, error)

Start starts the plugin.

func (*Plugin) Stop

func (p *Plugin) Stop()

Stop kills the plugin.

type Priority

type Priority uint

Priority is the priority of a hook. Smaller values are executed first (higher priority).

type Registry

type Registry struct {
	Logger        zerolog.Logger
	Compatibility config.CompatibilityPolicy
	Verification  config.VerificationPolicy
	Acceptance    config.AcceptancePolicy
	// contains filtered or unexported fields
}

func NewRegistry

func NewRegistry(
	compatibility config.CompatibilityPolicy,
	verification config.VerificationPolicy,
	acceptance config.AcceptancePolicy,
	logger zerolog.Logger,
) *Registry

NewRegistry creates a new plugin registry.

func (*Registry) Add

func (reg *Registry) Add(plugin *Plugin) bool

Add adds a plugin to the registry.

func (*Registry) AddHook

func (reg *Registry) AddHook(hookName string, priority Priority, hookMethod Method)

Add adds a hook with a priority to the hooks map.

func (*Registry) Exists

func (reg *Registry) Exists(name, version, remoteURL string) bool

Exists checks if a plugin exists in the registry.

func (*Registry) ForEach

func (reg *Registry) ForEach(f func(Identifier, *Plugin))

ForEach iterates over all plugins in the registry.

func (*Registry) Get

func (reg *Registry) Get(id Identifier) *Plugin

Get returns a plugin from the registry.

func (*Registry) Hooks

func (reg *Registry) Hooks() map[string]map[Priority]Method

Hooks returns the hooks map.

func (*Registry) List

func (reg *Registry) List() []Identifier

List returns a list of all plugins in the registry.

func (*Registry) LoadPlugins

func (reg *Registry) LoadPlugins(plugins []config.Plugin)

LoadPlugins loads plugins from the config file.

func (*Registry) RegisterHooks

func (reg *Registry) RegisterHooks(id Identifier)

RegisterHooks registers the hooks for the given plugin.

func (*Registry) Remove

func (reg *Registry) Remove(id Identifier)

Remove removes a plugin from the registry.

func (*Registry) Run

func (reg *Registry) Run(
	ctx context.Context,
	args map[string]interface{},
	hookName string,
	opts ...grpc.CallOption,
) (map[string]interface{}, *gerr.GatewayDError)

Run runs the hooks of a specific type. The result of the previous hook is passed to the next hook as the argument, aka. chained. The context is passed to the hooks as well to allow them to cancel the execution. The args are passed to the first hook as the argument. The result of the first hook is passed to the second hook, and so on. The result of the last hook is eventually returned. The verification mode is used to determine how to handle errors. If the verification mode is set to Abort, the execution is aborted on the first error. If the verification mode is set to Remove, the hook is removed from the list of hooks on the first error. If the verification mode is set to Ignore, the error is ignored and the execution continues. If the verification mode is set to PassDown, the extra keys/values in the result are passed down to the next The verification mode is set to PassDown by default. The opts are passed to the hooks as well to allow them to use the grpc.CallOption.

func (*Registry) Shutdown

func (reg *Registry) Shutdown()

Shutdown shuts down all plugins in the registry.