Add http-wasm plugin support to Traefik

This commit is contained in:
Jesse Haka 2023-11-30 22:42:06 +02:00 committed by GitHub
parent b2bb96390a
commit 6858dbdd07
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 338 additions and 119 deletions

View file

@ -4,28 +4,34 @@ import (
"context"
"fmt"
"net/http"
"os"
"path/filepath"
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
"github.com/traefik/traefik/v3/pkg/logs"
"github.com/traefik/yaegi/interp"
"github.com/traefik/yaegi/stdlib"
)
// Constructor creates a plugin handler.
type Constructor func(context.Context, http.Handler) (http.Handler, error)
type pluginMiddleware interface {
NewHandler(ctx context.Context, next http.Handler) (http.Handler, error)
}
type middlewareBuilder interface {
newMiddleware(config map[string]interface{}, middlewareName string) (pluginMiddleware, error)
}
// Builder is a plugin builder.
type Builder struct {
middlewareBuilders map[string]*middlewareBuilder
providerBuilders map[string]providerBuilder
middlewareBuilders map[string]middlewareBuilder
}
// NewBuilder creates a new Builder.
func NewBuilder(client *Client, plugins map[string]Descriptor, localPlugins map[string]LocalDescriptor) (*Builder, error) {
ctx := context.Background()
pb := &Builder{
middlewareBuilders: map[string]*middlewareBuilder{},
middlewareBuilders: map[string]middlewareBuilder{},
providerBuilders: map[string]providerBuilder{},
}
@ -36,44 +42,30 @@ func NewBuilder(client *Client, plugins map[string]Descriptor, localPlugins map[
return nil, fmt.Errorf("%s: failed to read manifest: %w", desc.ModuleName, err)
}
logger := log.With().Str("plugin", "plugin-"+pName).Str("module", desc.ModuleName).Logger()
i := interp.New(interp.Options{
GoPath: client.GoPath(),
Env: os.Environ(),
Stdout: logs.NoLevel(logger, zerolog.DebugLevel),
Stderr: logs.NoLevel(logger, zerolog.ErrorLevel),
})
err = i.Use(stdlib.Symbols)
if err != nil {
return nil, fmt.Errorf("%s: failed to load symbols: %w", desc.ModuleName, err)
}
err = i.Use(ppSymbols())
if err != nil {
return nil, fmt.Errorf("%s: failed to load provider symbols: %w", desc.ModuleName, err)
}
_, err = i.Eval(fmt.Sprintf(`import "%s"`, manifest.Import))
if err != nil {
return nil, fmt.Errorf("%s: failed to import plugin code %q: %w", desc.ModuleName, manifest.Import, err)
}
logger := log.With().
Str("plugin", "plugin-"+pName).
Str("module", desc.ModuleName).
Str("runtime", manifest.Runtime).
Logger()
logCtx := logger.WithContext(ctx)
switch manifest.Type {
case "middleware":
middleware, err := newMiddlewareBuilder(i, manifest.BasePkg, manifest.Import)
case typeMiddleware:
middleware, err := newMiddlewareBuilder(logCtx, client.GoPath(), manifest, desc.ModuleName)
if err != nil {
return nil, err
}
pb.middlewareBuilders[pName] = middleware
case "provider":
pb.providerBuilders[pName] = providerBuilder{
interpreter: i,
Import: manifest.Import,
BasePkg: manifest.BasePkg,
case typeProvider:
pBuilder, err := newProviderBuilder(logCtx, manifest, client.GoPath())
if err != nil {
return nil, fmt.Errorf("%s: %w", desc.ModuleName, err)
}
pb.providerBuilders[pName] = pBuilder
default:
return nil, fmt.Errorf("unknow plugin type: %s", manifest.Type)
}
@ -85,48 +77,107 @@ func NewBuilder(client *Client, plugins map[string]Descriptor, localPlugins map[
return nil, fmt.Errorf("%s: failed to read manifest: %w", desc.ModuleName, err)
}
logger := log.With().Str("plugin", "plugin-"+pName).Str("module", desc.ModuleName).Logger()
i := interp.New(interp.Options{
GoPath: localGoPath,
Env: os.Environ(),
Stdout: logs.NoLevel(logger, zerolog.DebugLevel),
Stderr: logs.NoLevel(logger, zerolog.ErrorLevel),
})
err = i.Use(stdlib.Symbols)
if err != nil {
return nil, fmt.Errorf("%s: failed to load symbols: %w", desc.ModuleName, err)
}
err = i.Use(ppSymbols())
if err != nil {
return nil, fmt.Errorf("%s: failed to load provider symbols: %w", desc.ModuleName, err)
}
_, err = i.Eval(fmt.Sprintf(`import "%s"`, manifest.Import))
if err != nil {
return nil, fmt.Errorf("%s: failed to import plugin code %q: %w", desc.ModuleName, manifest.Import, err)
}
logger := log.With().
Str("plugin", "plugin-"+pName).
Str("module", desc.ModuleName).
Str("runtime", manifest.Runtime).
Logger()
logCtx := logger.WithContext(ctx)
switch manifest.Type {
case "middleware":
middleware, err := newMiddlewareBuilder(i, manifest.BasePkg, manifest.Import)
case typeMiddleware:
middleware, err := newMiddlewareBuilder(logCtx, localGoPath, manifest, desc.ModuleName)
if err != nil {
return nil, err
}
pb.middlewareBuilders[pName] = middleware
case "provider":
pb.providerBuilders[pName] = providerBuilder{
interpreter: i,
Import: manifest.Import,
BasePkg: manifest.BasePkg,
case typeProvider:
builder, err := newProviderBuilder(logCtx, manifest, localGoPath)
if err != nil {
return nil, fmt.Errorf("%s: %w", desc.ModuleName, err)
}
pb.providerBuilders[pName] = builder
default:
return nil, fmt.Errorf("unknow plugin type: %s", manifest.Type)
}
}
return pb, nil
}
// Build builds a middleware plugin.
func (b Builder) Build(pName string, config map[string]interface{}, middlewareName string) (Constructor, error) {
if b.middlewareBuilders == nil {
return nil, fmt.Errorf("no plugin definitions in the static configuration: %s", pName)
}
// plugin (pName) can be located in yaegi or wasm middleware builders.
if descriptor, ok := b.middlewareBuilders[pName]; ok {
m, err := descriptor.newMiddleware(config, middlewareName)
if err != nil {
return nil, err
}
return m.NewHandler, nil
}
return nil, fmt.Errorf("unknown plugin type: %s", pName)
}
func newMiddlewareBuilder(ctx context.Context, goPath string, manifest *Manifest, moduleName string) (middlewareBuilder, error) {
switch manifest.Runtime {
case runtimeWasm:
wasmPath, err := getWasmPath(manifest)
if err != nil {
return nil, fmt.Errorf("wasm path: %w", err)
}
return newWasmMiddlewareBuilder(goPath, moduleName, wasmPath), nil
case runtimeYaegi, "":
i, err := newInterpreter(ctx, goPath, manifest.Import)
if err != nil {
return nil, fmt.Errorf("failed to craete Yaegi intepreter: %w", err)
}
return newYaegiMiddlewareBuilder(i, manifest.BasePkg, manifest.Import)
default:
return nil, fmt.Errorf("unknown plugin runtime: %s", manifest.Runtime)
}
}
func newProviderBuilder(ctx context.Context, manifest *Manifest, goPath string) (providerBuilder, error) {
switch manifest.Runtime {
case runtimeYaegi, "":
i, err := newInterpreter(ctx, goPath, manifest.Import)
if err != nil {
return providerBuilder{}, err
}
return providerBuilder{
interpreter: i,
Import: manifest.Import,
BasePkg: manifest.BasePkg,
}, nil
default:
return providerBuilder{}, fmt.Errorf("unknown plugin runtime: %s", manifest.Runtime)
}
}
func getWasmPath(manifest *Manifest) (string, error) {
wasmPath := manifest.WasmPath
if wasmPath == "" {
wasmPath = "plugin.wasm"
}
if !filepath.IsLocal(wasmPath) {
return "", fmt.Errorf("wasmPath must be a local path")
}
return wasmPath, nil
}