mirror of
https://github.com/hanzoai/gateway.git
synced 2026-11-02 23:52:23 +00:00
zeekayandHanzo Dev
53350699b6
Every import in this module now resolves to github.com/hanzoai/gateway/v2.
The 34 github.com/krakend/* + github.com/luraproject/lura modules that
supplied the engine and its components are vendored under internal/ and
their 91 packages rewritten onto our own path.
Why fold rather than mirror into 34 hanzoai/* repos:
- It removes the exposure outright. 34 rows leave 34 rows of go.sum to
reason about; zero modules leave nothing. `go list -m all` and go.sum
now contain no krakend/lura entry at all.
- Cross-references cannot go wrong. 28 of the 34 import lura (97 files
inside lura self-reference it). Mirroring means rewriting every one of
those to our lura, and a single miss silently links a SECOND copy of
lura into the binary. With one module that is structurally impossible.
- It creates no duplicates. These are lura-coupled gateway glue with no
consumer outside this binary; publishing 34 repos would be 34 new
things to maintain for zero second caller. internal/ makes that
guarantee mechanical — Go forbids importing it from outside this
module, so none of it can become a competing public package. Verified
no repo outside gateway imports any hanzoai/gateway/v2 subpackage.
Layout mirrors provenance so an upstream re-sync stays a diff:
luraproject/lura/v2 -> internal/lura (the engine, 20 pkgs)
krakend/krakend-<x> -> internal/plugin/<x> (28 components)
krakend/<x> -> internal/pkg/<x> (6 standalone libs)
This commit is PURELY MECHANICAL: 196 of the 197 vendored files are
byte-identical to their upstream original once the import rewrite is
applied. The single exception is bloomfilter's subpackage, which upstream
names `krakend` — the one package name that could not survive as-is; it
becomes internal/pkg/bloomfilter/register. Hand edits land separately in
the next commit so they are readable on their own.
Per `go mod vendor` semantics, dependencies' _test.go files are not
vendored. They test upstream code at a pinned version that we do not
modify, several cannot run at all from a module distribution (they need
TLS certs and compiled .so plugins upstream generates but never ships),
and one is a 100k-request stress test that exhausts the ephemeral port
range and fails every package running beside it. Fold integrity is proven
by the byte-diff above instead, which is the stronger check.
Preserved deliberately — each of these is behaviour, not branding:
- the `github.com/devopsfaith/krakend*` extra_config namespace strings
(35 of them). These are config-surface keys, not import paths;
renaming one silently stops that component finding its config. The
jose validator namespace backs `auth/validator` on 212 endpoints.
- core.KrakendVersion / KrakendUserAgent / the X-KRAKEND consts, whose
VALUES rebrand.go overwrites — that seam is unchanged.
- the KRAKEND_ koanf env prefix (a hardcoded upstream const).
- every vendored module's LICENSE (34 files, Apache-2.0/MIT).
The Makefile/CI -X paths move with the engine. An -X naming a symbol that
does not exist is silently ignored by the linker, so a stale path here
would have shipped an "undefined" version in the backend User-Agent and
X-Api-Version with a perfectly green build. Verified live:
`gateway version` reports 2.13.0, not undefined.
Verification (GOWORK=off CGO_ENABLED=0, both tag modes):
go build ./... OK go build -tags legacy ./... OK
go vet ./... clean go vet -tags legacy ./... clean
go test ./... 6/6 ok go test -tags legacy 5/5 ok
tests/ integration harness 47 fixtures pass
gateway check -c configs/{hanzo,lux}/gateway.json -> Syntax OK!
go list -m all | grep -iE 'krakend|lura' -> empty
go mod verify -> all modules verified
Co-authored-by: Hanzo Dev <[email protected]>
144 lines
3.1 KiB
Go
144 lines
3.1 KiB
Go
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package plugin
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net/http"
|
|
"plugin"
|
|
"strings"
|
|
|
|
"github.com/hanzoai/gateway/v2/internal/lura/logging"
|
|
luraplugin "github.com/hanzoai/gateway/v2/internal/lura/plugin"
|
|
"github.com/hanzoai/gateway/v2/internal/lura/register"
|
|
)
|
|
|
|
var serverRegister = register.New()
|
|
|
|
func RegisterHandler(
|
|
name string,
|
|
handler func(context.Context, map[string]interface{}, http.Handler) (http.Handler, error),
|
|
) {
|
|
serverRegister.Register(Namespace, name, handler)
|
|
}
|
|
|
|
type Registerer interface {
|
|
RegisterHandlers(func(
|
|
name string,
|
|
handler func(context.Context, map[string]interface{}, http.Handler) (http.Handler, error),
|
|
))
|
|
}
|
|
|
|
type LoggerRegisterer interface {
|
|
RegisterLogger(interface{})
|
|
}
|
|
|
|
type RegisterHandlerFunc func(
|
|
name string,
|
|
handler func(context.Context, map[string]interface{}, http.Handler) (http.Handler, error),
|
|
)
|
|
|
|
func Load(path, pattern string, rcf RegisterHandlerFunc) (int, error) {
|
|
return LoadWithLogger(path, pattern, rcf, nil)
|
|
}
|
|
|
|
func LoadWithLogger(path, pattern string, rcf RegisterHandlerFunc, logger logging.Logger) (int, error) {
|
|
plugins, err := luraplugin.Scan(path, pattern)
|
|
if err != nil {
|
|
return 0, err
|
|
}
|
|
return load(plugins, rcf, logger)
|
|
}
|
|
|
|
func load(plugins []string, rcf RegisterHandlerFunc, logger logging.Logger) (int, error) {
|
|
var errors []error
|
|
|
|
loadedPlugins := 0
|
|
for k, pluginName := range plugins {
|
|
if err := open(pluginName, rcf, logger); err != nil {
|
|
errors = append(errors, fmt.Errorf("plugin #%d (%s): %s", k, pluginName, err.Error()))
|
|
continue
|
|
}
|
|
loadedPlugins++
|
|
}
|
|
|
|
if len(errors) > 0 {
|
|
return loadedPlugins, loaderError{errors: errors}
|
|
}
|
|
return loadedPlugins, nil
|
|
}
|
|
|
|
func open(pluginName string, rcf RegisterHandlerFunc, logger logging.Logger) (err error) {
|
|
defer func() {
|
|
if r := recover(); r != nil {
|
|
var ok bool
|
|
err, ok = r.(error)
|
|
if !ok {
|
|
err = fmt.Errorf("%v", r)
|
|
}
|
|
}
|
|
}()
|
|
|
|
var p Plugin
|
|
p, err = pluginOpener(pluginName)
|
|
if err != nil {
|
|
return
|
|
}
|
|
var r interface{}
|
|
r, err = p.Lookup("HandlerRegisterer")
|
|
if err != nil {
|
|
return
|
|
}
|
|
registerer, ok := r.(Registerer)
|
|
if !ok {
|
|
return fmt.Errorf("http-server-handler plugin loader: unknown type")
|
|
}
|
|
|
|
if logger != nil {
|
|
if lr, ok := r.(LoggerRegisterer); ok {
|
|
lr.RegisterLogger(logger)
|
|
}
|
|
}
|
|
|
|
RegisterExtraComponents(r)
|
|
|
|
registerer.RegisterHandlers(rcf)
|
|
return
|
|
}
|
|
|
|
var RegisterExtraComponents = func(interface{}) {}
|
|
|
|
// Plugin is the interface of the loaded plugins
|
|
type Plugin interface {
|
|
Lookup(name string) (plugin.Symbol, error)
|
|
}
|
|
|
|
// pluginOpener keeps the plugin open function in a var for easy testing
|
|
var pluginOpener = defaultPluginOpener
|
|
|
|
func defaultPluginOpener(name string) (Plugin, error) {
|
|
return plugin.Open(name)
|
|
}
|
|
|
|
type loaderError struct {
|
|
errors []error
|
|
}
|
|
|
|
// Error implements the error interface
|
|
func (l loaderError) Error() string {
|
|
msgs := make([]string, len(l.errors))
|
|
for i, err := range l.errors {
|
|
msgs[i] = err.Error()
|
|
}
|
|
return fmt.Sprintf("plugin loader found %d error(s): \n%s", len(msgs), strings.Join(msgs, "\n"))
|
|
}
|
|
|
|
func (l loaderError) Len() int {
|
|
return len(l.errors)
|
|
}
|
|
|
|
func (l loaderError) Errs() []error {
|
|
return l.errors
|
|
}
|