Merge current v2.5 into v2.6

This commit is contained in:
romain 2022-01-19 16:16:18 +01:00
commit b42a7c89e7
7 changed files with 126 additions and 90 deletions

View file

@ -22,7 +22,7 @@ find "${PATH_TO_SITE}" -type f -not -path "/app/site/theme/*" \
--alt_ignore="/traefikproxy-vertical-logo-color.svg/" \ --alt_ignore="/traefikproxy-vertical-logo-color.svg/" \
--http_status_ignore="0,500,501,503" \ --http_status_ignore="0,500,501,503" \
--file_ignore="/404.html/" \ --file_ignore="/404.html/" \
--url_ignore="/https://groups.google.com/a/traefik.io/forum/#!forum/security/,/localhost:/,/127.0.0.1:/,/fonts.gstatic.com/,/.minikube/,/github.com\/traefik\/traefik\/*edit*/,/github.com\/traefik\/traefik/,/doc.traefik.io/,/github\.com\/golang\/oauth2\/blob\/36a7019397c4c86cf59eeab3bc0d188bac444277\/.+/,/www.akamai.com/,/pilot.traefik.io\/profile/,/traefik.io/,/doc.traefik.io\/traefik-mesh/,/www.mkdocs.org/,/squidfunk.github.io/,/ietf.org/,/www.namesilo.com/,/www.youtube.com/,/www.linode.com/,/www.alibabacloud.com/" \ --url_ignore="/https://groups.google.com/a/traefik.io/forum/#!forum/security/,/localhost:/,/127.0.0.1:/,/fonts.gstatic.com/,/.minikube/,/github.com\/traefik\/traefik\/*edit*/,/github.com\/traefik\/traefik/,/doc.traefik.io/,/github\.com\/golang\/oauth2\/blob\/36a7019397c4c86cf59eeab3bc0d188bac444277\/.+/,/www.akamai.com/,/pilot.traefik.io\/profile/,/traefik.io/,/doc.traefik.io\/traefik-mesh/,/www.mkdocs.org/,/squidfunk.github.io/,/ietf.org/,/www.namesilo.com/,/www.youtube.com/,/www.linode.com/,/www.alibabacloud.com/,/www.cloudxns.net/" \
'{}' 1>/dev/null '{}' 1>/dev/null
## HTML-proofer options at https://github.com/gjtorikian/html-proofer#configuration ## HTML-proofer options at https://github.com/gjtorikian/html-proofer#configuration

2
go.mod
View file

@ -93,7 +93,7 @@ require (
replace ( replace (
github.com/abbot/go-http-auth => github.com/containous/go-http-auth v0.4.1-0.20200324110947-a37a7636d23e github.com/abbot/go-http-auth => github.com/containous/go-http-auth v0.4.1-0.20200324110947-a37a7636d23e
github.com/go-check/check => github.com/containous/check v0.0.0-20170915194414-ca0bf163426a github.com/go-check/check => github.com/containous/check v0.0.0-20170915194414-ca0bf163426a
github.com/gorilla/mux => github.com/containous/mux v0.0.0-20181024131434-c33f32e26898 github.com/gorilla/mux => github.com/containous/mux v0.0.0-20220113180107-8ffa4f6d063c
github.com/mailgun/minheap => github.com/containous/minheap v0.0.0-20190809180810-6e71eb837595 github.com/mailgun/minheap => github.com/containous/minheap v0.0.0-20190809180810-6e71eb837595
github.com/mailgun/multibuf => github.com/containous/multibuf v0.0.0-20190809014333-8b6c9a7e6bba github.com/mailgun/multibuf => github.com/containous/multibuf v0.0.0-20190809014333-8b6c9a7e6bba
) )

4
go.sum
View file

@ -427,8 +427,8 @@ github.com/containous/minheap v0.0.0-20190809180810-6e71eb837595 h1:aPspFRO6b94T
github.com/containous/minheap v0.0.0-20190809180810-6e71eb837595/go.mod h1:+lHFbEasIiQVGzhVDVw/cn0ZaOzde2OwNncp1NhXV4c= github.com/containous/minheap v0.0.0-20190809180810-6e71eb837595/go.mod h1:+lHFbEasIiQVGzhVDVw/cn0ZaOzde2OwNncp1NhXV4c=
github.com/containous/multibuf v0.0.0-20190809014333-8b6c9a7e6bba h1:PhR03pep+5eO/9BSvCY9RyG8rjogB3uYS4X/WBYNTT8= github.com/containous/multibuf v0.0.0-20190809014333-8b6c9a7e6bba h1:PhR03pep+5eO/9BSvCY9RyG8rjogB3uYS4X/WBYNTT8=
github.com/containous/multibuf v0.0.0-20190809014333-8b6c9a7e6bba/go.mod h1:zkWcASFUJEst6QwCrxLdkuw1gvaKqmflEipm+iecV5M= github.com/containous/multibuf v0.0.0-20190809014333-8b6c9a7e6bba/go.mod h1:zkWcASFUJEst6QwCrxLdkuw1gvaKqmflEipm+iecV5M=
github.com/containous/mux v0.0.0-20181024131434-c33f32e26898 h1:1srn9voikJGofblBhWy3WuZWqo14Ou7NaswNG/I2yWc= github.com/containous/mux v0.0.0-20220113180107-8ffa4f6d063c h1:g6JvgTtfpS6AfhRjY87NZ0g39CrNDbdm8R+1CD85Cfo=
github.com/containous/mux v0.0.0-20181024131434-c33f32e26898/go.mod h1:z8WW7n06n8/1xF9Jl9WmuDeZuHAhfL+bwarNjsciwwg= github.com/containous/mux v0.0.0-20220113180107-8ffa4f6d063c/go.mod h1:z8WW7n06n8/1xF9Jl9WmuDeZuHAhfL+bwarNjsciwwg=
github.com/coredns/coredns v1.1.2/go.mod h1:zASH/MVDgR6XZTbxvOnsZfffS+31vg6Ackf/wo1+AM0= github.com/coredns/coredns v1.1.2/go.mod h1:zASH/MVDgR6XZTbxvOnsZfffS+31vg6Ackf/wo1+AM0=
github.com/coreos/bbolt v1.3.2/go.mod h1:iRUV2dpdMOn7Bo10OQBFzIJO9kkE559Wcmn+qkEiiKk= github.com/coreos/bbolt v1.3.2/go.mod h1:iRUV2dpdMOn7Bo10OQBFzIJO9kkE559Wcmn+qkEiiKk=
github.com/coreos/etcd v3.3.10+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc32PjwdhPthX9715RE= github.com/coreos/etcd v3.3.10+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc32PjwdhPthX9715RE=

View file

@ -15,31 +15,17 @@ import (
// Constructor creates a plugin handler. // Constructor creates a plugin handler.
type Constructor func(context.Context, http.Handler) (http.Handler, error) type Constructor func(context.Context, http.Handler) (http.Handler, error)
// pluginContext The static part of a plugin configuration.
type pluginContext struct {
// GoPath plugin's GOPATH
GoPath string `json:"goPath,omitempty" toml:"goPath,omitempty" yaml:"goPath,omitempty"`
// Import plugin's import/package
Import string `json:"import,omitempty" toml:"import,omitempty" yaml:"import,omitempty"`
// BasePkg plugin's base package name (optional)
BasePkg string `json:"basePkg,omitempty" toml:"basePkg,omitempty" yaml:"basePkg,omitempty"`
interpreter *interp.Interpreter
}
// Builder is a plugin builder. // Builder is a plugin builder.
type Builder struct { type Builder struct {
middlewareDescriptors map[string]pluginContext middlewareBuilders map[string]*middlewareBuilder
providerDescriptors map[string]pluginContext providerBuilders map[string]providerBuilder
} }
// NewBuilder creates a new Builder. // NewBuilder creates a new Builder.
func NewBuilder(client *Client, plugins map[string]Descriptor, localPlugins map[string]LocalDescriptor) (*Builder, error) { func NewBuilder(client *Client, plugins map[string]Descriptor, localPlugins map[string]LocalDescriptor) (*Builder, error) {
pb := &Builder{ pb := &Builder{
middlewareDescriptors: map[string]pluginContext{}, middlewareBuilders: map[string]*middlewareBuilder{},
providerDescriptors: map[string]pluginContext{}, providerBuilders: map[string]providerBuilder{},
} }
for pName, desc := range plugins { for pName, desc := range plugins {
@ -74,16 +60,15 @@ func NewBuilder(client *Client, plugins map[string]Descriptor, localPlugins map[
switch manifest.Type { switch manifest.Type {
case "middleware": case "middleware":
pb.middlewareDescriptors[pName] = pluginContext{ middleware, err := newMiddlewareBuilder(i, manifest.BasePkg, manifest.Import)
interpreter: i, if err != nil {
GoPath: client.GoPath(), return nil, err
Import: manifest.Import,
BasePkg: manifest.BasePkg,
} }
pb.middlewareBuilders[pName] = middleware
case "provider": case "provider":
pb.providerDescriptors[pName] = pluginContext{ pb.providerBuilders[pName] = providerBuilder{
interpreter: i, interpreter: i,
GoPath: client.GoPath(),
Import: manifest.Import, Import: manifest.Import,
BasePkg: manifest.BasePkg, BasePkg: manifest.BasePkg,
} }
@ -123,16 +108,15 @@ func NewBuilder(client *Client, plugins map[string]Descriptor, localPlugins map[
switch manifest.Type { switch manifest.Type {
case "middleware": case "middleware":
pb.middlewareDescriptors[pName] = pluginContext{ middleware, err := newMiddlewareBuilder(i, manifest.BasePkg, manifest.Import)
interpreter: i, if err != nil {
GoPath: localGoPath, return nil, err
Import: manifest.Import,
BasePkg: manifest.BasePkg,
} }
pb.middlewareBuilders[pName] = middleware
case "provider": case "provider":
pb.providerDescriptors[pName] = pluginContext{ pb.providerBuilders[pName] = providerBuilder{
interpreter: i, interpreter: i,
GoPath: localGoPath,
Import: manifest.Import, Import: manifest.Import,
BasePkg: manifest.BasePkg, BasePkg: manifest.BasePkg,
} }

View file

@ -9,15 +9,16 @@ import (
"strings" "strings"
"github.com/mitchellh/mapstructure" "github.com/mitchellh/mapstructure"
"github.com/traefik/yaegi/interp"
) )
// Build builds a middleware plugin. // Build builds a middleware plugin.
func (b Builder) Build(pName string, config map[string]interface{}, middlewareName string) (Constructor, error) { func (b Builder) Build(pName string, config map[string]interface{}, middlewareName string) (Constructor, error) {
if b.middlewareDescriptors == nil { if b.middlewareBuilders == nil {
return nil, fmt.Errorf("no plugin definition in the static configuration: %s", pName) return nil, fmt.Errorf("no plugin definition in the static configuration: %s", pName)
} }
descriptor, ok := b.middlewareDescriptors[pName] descriptor, ok := b.middlewareBuilders[pName]
if !ok { if !ok {
return nil, fmt.Errorf("unknown plugin type: %s", pName) return nil, fmt.Errorf("unknown plugin type: %s", pName)
} }
@ -30,59 +31,42 @@ func (b Builder) Build(pName string, config map[string]interface{}, middlewareNa
return m.NewHandler, err return m.NewHandler, err
} }
// Middleware is a HTTP handler plugin wrapper. type middlewareBuilder struct {
type Middleware struct {
middlewareName string
fnNew reflect.Value fnNew reflect.Value
config reflect.Value fnCreateConfig reflect.Value
} }
func newMiddleware(descriptor pluginContext, config map[string]interface{}, middlewareName string) (*Middleware, error) { func newMiddlewareBuilder(i *interp.Interpreter, basePkg, imp string) (*middlewareBuilder, error) {
basePkg := descriptor.BasePkg
if basePkg == "" { if basePkg == "" {
basePkg = strings.ReplaceAll(path.Base(descriptor.Import), "-", "_") basePkg = strings.ReplaceAll(path.Base(imp), "-", "_")
} }
vConfig, err := descriptor.interpreter.Eval(basePkg + `.CreateConfig()`) fnNew, err := i.Eval(basePkg + `.New`)
if err != nil {
return nil, fmt.Errorf("failed to eval CreateConfig: %w", err)
}
cfg := &mapstructure.DecoderConfig{
DecodeHook: mapstructure.StringToSliceHookFunc(","),
WeaklyTypedInput: true,
Result: vConfig.Interface(),
}
decoder, err := mapstructure.NewDecoder(cfg)
if err != nil {
return nil, fmt.Errorf("failed to create configuration decoder: %w", err)
}
err = decoder.Decode(config)
if err != nil {
return nil, fmt.Errorf("failed to decode configuration: %w", err)
}
fnNew, err := descriptor.interpreter.Eval(basePkg + `.New`)
if err != nil { if err != nil {
return nil, fmt.Errorf("failed to eval New: %w", err) return nil, fmt.Errorf("failed to eval New: %w", err)
} }
return &Middleware{ fnCreateConfig, err := i.Eval(basePkg + `.CreateConfig`)
middlewareName: middlewareName, if err != nil {
return nil, fmt.Errorf("failed to eval CreateConfig: %w", err)
}
return &middlewareBuilder{
fnNew: fnNew, fnNew: fnNew,
config: vConfig, fnCreateConfig: fnCreateConfig,
}, nil }, nil
} }
// NewHandler creates a new HTTP handler. func (p middlewareBuilder) newHandler(ctx context.Context, next http.Handler, cfg reflect.Value, middlewareName string) (http.Handler, error) {
func (m *Middleware) NewHandler(ctx context.Context, next http.Handler) (http.Handler, error) { args := []reflect.Value{reflect.ValueOf(ctx), reflect.ValueOf(next), cfg, reflect.ValueOf(middlewareName)}
args := []reflect.Value{reflect.ValueOf(ctx), reflect.ValueOf(next), m.config, reflect.ValueOf(m.middlewareName)} results := p.fnNew.Call(args)
results := m.fnNew.Call(args)
if len(results) > 1 && results[1].Interface() != nil { if len(results) > 1 && results[1].Interface() != nil {
return nil, results[1].Interface().(error) err, ok := results[1].Interface().(error)
if !ok {
return nil, fmt.Errorf("invalid error type: %T", results[0].Interface())
}
return nil, err
} }
handler, ok := results[0].Interface().(http.Handler) handler, ok := results[0].Interface().(http.Handler)
@ -92,3 +76,55 @@ func (m *Middleware) NewHandler(ctx context.Context, next http.Handler) (http.Ha
return handler, nil return handler, nil
} }
func (p middlewareBuilder) createConfig(config map[string]interface{}) (reflect.Value, error) {
results := p.fnCreateConfig.Call(nil)
if len(results) != 1 {
return reflect.Value{}, fmt.Errorf("invalid number of return for the CreateConfig function: %d", len(results))
}
vConfig := results[0]
cfg := &mapstructure.DecoderConfig{
DecodeHook: mapstructure.StringToSliceHookFunc(","),
WeaklyTypedInput: true,
Result: vConfig.Interface(),
}
decoder, err := mapstructure.NewDecoder(cfg)
if err != nil {
return reflect.Value{}, fmt.Errorf("failed to create configuration decoder: %w", err)
}
err = decoder.Decode(config)
if err != nil {
return reflect.Value{}, fmt.Errorf("failed to decode configuration: %w", err)
}
return vConfig, nil
}
// Middleware is an HTTP handler plugin wrapper.
type Middleware struct {
middlewareName string
config reflect.Value
builder *middlewareBuilder
}
func newMiddleware(builder *middlewareBuilder, config map[string]interface{}, middlewareName string) (*Middleware, error) {
vConfig, err := builder.createConfig(config)
if err != nil {
return nil, err
}
return &Middleware{
middlewareName: middlewareName,
config: vConfig,
builder: builder,
}, nil
}
// NewHandler creates a new HTTP handler.
func (m *Middleware) NewHandler(ctx context.Context, next http.Handler) (http.Handler, error) {
return m.builder.newHandler(ctx, next, m.config, m.middlewareName)
}

View file

@ -13,6 +13,7 @@ import (
"github.com/traefik/traefik/v2/pkg/log" "github.com/traefik/traefik/v2/pkg/log"
"github.com/traefik/traefik/v2/pkg/provider" "github.com/traefik/traefik/v2/pkg/provider"
"github.com/traefik/traefik/v2/pkg/safe" "github.com/traefik/traefik/v2/pkg/safe"
"github.com/traefik/yaegi/interp"
) )
// PP the interface of a plugin's provider. // PP the interface of a plugin's provider.
@ -52,16 +53,26 @@ func ppSymbols() map[string]map[string]reflect.Value {
// BuildProvider builds a plugin's provider. // BuildProvider builds a plugin's provider.
func (b Builder) BuildProvider(pName string, config map[string]interface{}) (provider.Provider, error) { func (b Builder) BuildProvider(pName string, config map[string]interface{}) (provider.Provider, error) {
if b.providerDescriptors == nil { if b.providerBuilders == nil {
return nil, fmt.Errorf("no plugin definition in the static configuration: %s", pName) return nil, fmt.Errorf("no plugin definition in the static configuration: %s", pName)
} }
descriptor, ok := b.providerDescriptors[pName] builder, ok := b.providerBuilders[pName]
if !ok { if !ok {
return nil, fmt.Errorf("unknown plugin type: %s", pName) return nil, fmt.Errorf("unknown plugin type: %s", pName)
} }
return newProvider(descriptor, config, "plugin-"+pName) return newProvider(builder, config, "plugin-"+pName)
}
type providerBuilder struct {
// Import plugin's import/package
Import string `json:"import,omitempty" toml:"import,omitempty" yaml:"import,omitempty"`
// BasePkg plugin's base package name (optional)
BasePkg string `json:"basePkg,omitempty" toml:"basePkg,omitempty" yaml:"basePkg,omitempty"`
interpreter *interp.Interpreter
} }
// Provider is a plugin's provider wrapper. // Provider is a plugin's provider wrapper.
@ -70,13 +81,13 @@ type Provider struct {
pp PP pp PP
} }
func newProvider(descriptor pluginContext, config map[string]interface{}, providerName string) (*Provider, error) { func newProvider(builder providerBuilder, config map[string]interface{}, providerName string) (*Provider, error) {
basePkg := descriptor.BasePkg basePkg := builder.BasePkg
if basePkg == "" { if basePkg == "" {
basePkg = strings.ReplaceAll(path.Base(descriptor.Import), "-", "_") basePkg = strings.ReplaceAll(path.Base(builder.Import), "-", "_")
} }
vConfig, err := descriptor.interpreter.Eval(basePkg + `.CreateConfig()`) vConfig, err := builder.interpreter.Eval(basePkg + `.CreateConfig()`)
if err != nil { if err != nil {
return nil, fmt.Errorf("failed to eval CreateConfig: %w", err) return nil, fmt.Errorf("failed to eval CreateConfig: %w", err)
} }
@ -97,12 +108,12 @@ func newProvider(descriptor pluginContext, config map[string]interface{}, provid
return nil, fmt.Errorf("failed to decode configuration: %w", err) return nil, fmt.Errorf("failed to decode configuration: %w", err)
} }
_, err = descriptor.interpreter.Eval(`package wrapper _, err = builder.interpreter.Eval(`package wrapper
import ( import (
"context" "context"
` + basePkg + ` "` + descriptor.Import + `" ` + basePkg + ` "` + builder.Import + `"
"github.com/traefik/traefik/v2/pkg/plugins" "github.com/traefik/traefik/v2/pkg/plugins"
) )
@ -116,7 +127,7 @@ func NewWrapper(ctx context.Context, config *` + basePkg + `.Config, name string
return nil, fmt.Errorf("failed to eval wrapper: %w", err) return nil, fmt.Errorf("failed to eval wrapper: %w", err)
} }
fnNew, err := descriptor.interpreter.Eval("wrapper.NewWrapper") fnNew, err := builder.interpreter.Eval("wrapper.NewWrapper")
if err != nil { if err != nil {
return nil, fmt.Errorf("failed to eval New: %w", err) return nil, fmt.Errorf("failed to eval New: %w", err)
} }

View file

@ -941,8 +941,9 @@
<div class="text-subtitle2">Regex</div> <div class="text-subtitle2">Regex</div>
<q-chip <q-chip
dense dense
class="app-chip app-chip-green"> class="app-chip app-chip-green app-chip-overflow">
{{ exData(middleware).regex }} {{ exData(middleware).regex }}
<q-tooltip>{{ exData(middleware).regex }}</q-tooltip>
</q-chip> </q-chip>
</div> </div>
</div> </div>
@ -954,8 +955,9 @@
<div class="text-subtitle2">Replacement</div> <div class="text-subtitle2">Replacement</div>
<q-chip <q-chip
dense dense
class="app-chip app-chip-green"> class="app-chip app-chip-green app-chip-overflow">
{{ exData(middleware).replacement }} {{ exData(middleware).replacement }}
<q-tooltip>{{ exData(middleware).replacement }}</q-tooltip>
</q-chip> </q-chip>
</div> </div>
</div> </div>
@ -1005,8 +1007,9 @@
<div class="text-subtitle2">Regex</div> <div class="text-subtitle2">Regex</div>
<q-chip <q-chip
dense dense
class="app-chip app-chip-green"> class="app-chip app-chip-green app-chip-overflow">
{{ exData(middleware).regex }} {{ exData(middleware).regex }}
<q-tooltip>{{ exData(middleware).regex }}</q-tooltip>
</q-chip> </q-chip>
</div> </div>
</div> </div>
@ -1018,8 +1021,9 @@
<div class="text-subtitle2">Replacement</div> <div class="text-subtitle2">Replacement</div>
<q-chip <q-chip
dense dense
class="app-chip app-chip-green"> class="app-chip app-chip-green app-chip-overflow">
{{ exData(middleware).replacement }} {{ exData(middleware).replacement }}
<q-tooltip>{{ exData(middleware).replacement }}</q-tooltip>
</q-chip> </q-chip>
</div> </div>
</div> </div>
@ -1062,8 +1066,9 @@
<q-chip <q-chip
v-for="(exp, key) in exData(middleware).regex" :key="key" v-for="(exp, key) in exData(middleware).regex" :key="key"
dense dense
class="app-chip app-chip-green"> class="app-chip app-chip-green app-chip-overflow">
{{ exp }} {{ exp }}
<q-tooltip>{{ exp }}</q-tooltip>
</q-chip> </q-chip>
</div> </div>
</div> </div>