plugin

Documentation

Index

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

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 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 v1.HookName, priority sdkPlugin.Priority, hookMethod sdkPlugin.Method)
	Hooks() map[v1.HookName]map[sdkPlugin.Priority]sdkPlugin.Method
	Run(
		ctx context.Context,
		args map[string]interface{},
		hookName v1.HookName,
		opts ...grpc.CallOption,
	) (map[string]interface{}, *gerr.GatewayDError)
}

type IPlugin

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

type IRegistry

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

	// Hook management
	IHook
}

type Plugin

type Plugin sdkPlugin.Plugin

func (*Plugin) Dispense

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

Dispense returns the plugin client.

func (*Plugin) Ping

func (p *Plugin) Ping() *gerr.GatewayDError

Ping pings the plugin.

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 Registry

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

func NewRegistry

func NewRegistry(
	ctx context.Context,
	compatibility config.CompatibilityPolicy,
	verification config.VerificationPolicy,
	acceptance config.AcceptancePolicy,
	termination config.TerminationPolicy,
	logger zerolog.Logger,
	devMode bool,
) *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 v1.HookName, priority sdkPlugin.Priority, hookMethod sdkPlugin.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(function func(sdkPlugin.Identifier, *Plugin))

ForEach iterates over all plugins in the registry.

func (*Registry) Get

func (reg *Registry) Get(pluginID sdkPlugin.Identifier) *Plugin

Get returns a plugin from the registry.

func (*Registry) Hooks

func (reg *Registry) Hooks() map[v1.HookName]map[sdkPlugin.Priority]sdkPlugin.Method

Hooks returns the hooks map.

func (*Registry) List

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

List returns a list of all plugins in the registry.

func (*Registry) LoadPlugins

func (reg *Registry) LoadPlugins(ctx context.Context, plugins []config.Plugin)

LoadPlugins loads plugins from the config file.

func (*Registry) RegisterHooks

func (reg *Registry) RegisterHooks(ctx context.Context, pluginID sdkPlugin.Identifier)

RegisterHooks registers the hooks for the given plugin.

func (*Registry) Remove

func (reg *Registry) Remove(pluginID sdkPlugin.Identifier)

Remove removes plugin hooks and then removes the plugin from the registry.

func (*Registry) Run

func (reg *Registry) Run(
	ctx context.Context,
	args map[string]interface{},
	hookName v1.HookName,
	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.

func (*Registry) Size

func (reg *Registry) Size() int

Size returns the number of plugins in the registry.