bootstrap

type Bootstrap ¶

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

Bootstrap implements the Bootstrapper interface.

The Bootstrap stage is made up of the following steps (in order): - Construct: Create the initial plugin structs based on the plugin(s) found in the Discovery stage. - Decorate: Decorate the plugins with additional metadata.

The Construct step is implemented by the ConstructFunc type.

The Decorate step is implemented by the DecorateFunc type.

func New(cfg *config.Cfg, opts Opts) *Bootstrap

func (b *Bootstrap) Bootstrap(ctx context.Context, src plugins.PluginSource, found []*plugins.FoundBundle) ([]*plugins.Plugin, error)

type Bootstrapper ¶

type Bootstrapper interface {
	Bootstrap(ctx context.Context, src plugins.PluginSource, bundles []*plugins.FoundBundle) ([]*plugins.Plugin, error)
}

Bootstrapper is responsible for the Bootstrap stage of the plugin loader pipeline.

type ConstructFunc ¶

type ConstructFunc func(ctx context.Context, src plugins.PluginSource, bundles []*plugins.FoundBundle) ([]*plugins.Plugin, error)

ConstructFunc is the function used for the Construct step of the Bootstrap stage.

func DefaultConstructFunc(signatureCalculator plugins.SignatureCalculator, assetPath *assetpath.Service) ConstructFunc

type DecorateFunc ¶

type DecorateFunc func(ctx context.Context, p *plugins.Plugin) (*plugins.Plugin, error)

DecorateFunc is the function used for the Decorate step of the Bootstrap stage.

func AppChildDecorateFunc(cfg *config.Cfg) DecorateFunc

func DefaultDecorateFuncs(cfg *config.Cfg) []DecorateFunc

func SkipHostEnvVarsDecorateFunc(cfg *config.Cfg) DecorateFunc

type DefaultConstructor ¶

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

DefaultConstructor implements the default ConstructFunc used for the Construct step of the Bootstrap stage.

It uses a pluginFactoryFunc to create plugins and the signatureCalculator to calculate the plugin's signature state.

func NewDefaultConstructor(signatureCalculator plugins.SignatureCalculator, assetPath *assetpath.Service) *DefaultConstructor

func (c *DefaultConstructor) Construct(ctx context.Context, src plugins.PluginSource, bundles []*plugins.FoundBundle) ([]*plugins.Plugin, error)

type DefaultPluginFactory ¶

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

DefaultPluginFactory is the default plugin factory used by the Construct step of the Bootstrap stage.

It creates the plugin using plugin information found during the Discovery stage and makes use of the assetPath service to set the plugin's BaseURL, Module, Logos and Screenshots fields.

func NewDefaultPluginFactory(assetPath *assetpath.Service) *DefaultPluginFactory

type Opts ¶

type Opts struct {
	ConstructFunc ConstructFunc
	DecorateFuncs []DecorateFunc
}