mirror of
https://github.com/hanzoai/gateway.git
synced 2026-10-30 15:04:44 +00:00
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]>
105 lines
3.8 KiB
Go
105 lines
3.8 KiB
Go
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package proxy
|
|
|
|
import (
|
|
"github.com/hanzoai/gateway/v2/internal/lura/config"
|
|
"github.com/hanzoai/gateway/v2/internal/lura/logging"
|
|
"github.com/hanzoai/gateway/v2/internal/lura/sd"
|
|
)
|
|
|
|
// Factory creates proxies based on the received endpoint configuration.
|
|
//
|
|
// Both, factories and backend factories, create proxies but factories are designed as a stack makers
|
|
// because they are intended to generate the complete proxy stack for a given frontend endpoint
|
|
// the app would expose and they could wrap several proxies provided by a backend factory
|
|
type Factory interface {
|
|
New(cfg *config.EndpointConfig) (Proxy, error)
|
|
}
|
|
|
|
// FactoryFunc type is an adapter to allow the use of ordinary functions as proxy factories.
|
|
// If f is a function with the appropriate signature, FactoryFunc(f) is a Factory that calls f.
|
|
type FactoryFunc func(*config.EndpointConfig) (Proxy, error)
|
|
|
|
// New implements the Factory interface
|
|
func (f FactoryFunc) New(cfg *config.EndpointConfig) (Proxy, error) { return f(cfg) }
|
|
|
|
// DefaultFactory returns a default http proxy factory with the injected logger
|
|
func DefaultFactory(logger logging.Logger) Factory {
|
|
return NewDefaultFactory(httpProxy, logger)
|
|
}
|
|
|
|
// DefaultFactoryWithSubscriber returns a default proxy factory with the injected logger and subscriber factory
|
|
func DefaultFactoryWithSubscriber(logger logging.Logger, sF sd.SubscriberFactory) Factory {
|
|
return NewDefaultFactoryWithSubscriber(httpProxy, logger, sF)
|
|
}
|
|
|
|
// NewDefaultFactory returns a default proxy factory with the injected proxy builder and logger
|
|
func NewDefaultFactory(backendFactory BackendFactory, logger logging.Logger) Factory {
|
|
sf := func(remote *config.Backend) sd.Subscriber {
|
|
return sd.GetRegister().Get(remote.SD)(remote)
|
|
}
|
|
return NewDefaultFactoryWithSubscriber(backendFactory, logger, sf)
|
|
}
|
|
|
|
// NewDefaultFactoryWithSubscriber returns a default proxy factory with the injected proxy builder,
|
|
// logger and subscriber factory
|
|
func NewDefaultFactoryWithSubscriber(backendFactory BackendFactory, logger logging.Logger, sF sd.SubscriberFactory) Factory {
|
|
return defaultFactory{backendFactory, logger, sF}
|
|
}
|
|
|
|
type defaultFactory struct {
|
|
backendFactory BackendFactory
|
|
logger logging.Logger
|
|
subscriberFactory sd.SubscriberFactory
|
|
}
|
|
|
|
// New implements the Factory interface
|
|
func (pf defaultFactory) New(cfg *config.EndpointConfig) (p Proxy, err error) {
|
|
switch len(cfg.Backend) {
|
|
case 0:
|
|
err = ErrNoBackends
|
|
case 1:
|
|
p, err = pf.newSingle(cfg)
|
|
default:
|
|
p, err = pf.newMulti(cfg)
|
|
}
|
|
if err != nil {
|
|
return
|
|
}
|
|
|
|
p = NewPluginMiddleware(pf.logger, cfg)(p)
|
|
p = NewStaticMiddleware(pf.logger, cfg)(p)
|
|
return
|
|
}
|
|
|
|
func (pf defaultFactory) newMulti(cfg *config.EndpointConfig) (p Proxy, err error) {
|
|
backendProxy := make([]Proxy, len(cfg.Backend))
|
|
for i, backend := range cfg.Backend {
|
|
backendProxy[i] = pf.newStack(backend)
|
|
}
|
|
p = NewMergeDataMiddleware(pf.logger, cfg)(backendProxy...)
|
|
p = NewFlatmapMiddleware(pf.logger, cfg)(p)
|
|
return
|
|
}
|
|
|
|
func (pf defaultFactory) newSingle(cfg *config.EndpointConfig) (Proxy, error) {
|
|
return pf.newStack(cfg.Backend[0]), nil
|
|
}
|
|
|
|
func (pf defaultFactory) newStack(backend *config.Backend) (p Proxy) {
|
|
p = pf.backendFactory(backend)
|
|
p = NewBackendPluginMiddleware(pf.logger, backend)(p)
|
|
p = NewGraphQLMiddleware(pf.logger, backend)(p)
|
|
p = NewFilterHeadersMiddleware(pf.logger, backend)(p)
|
|
p = NewLoadBalancedMiddlewareWithSubscriberAndLogger(pf.logger, pf.subscriberFactory(backend))(p)
|
|
if backend.ConcurrentCalls > 1 {
|
|
p = NewConcurrentMiddlewareWithLogger(pf.logger, backend)(p)
|
|
}
|
|
p = NewRequestBuilderMiddlewareWithLogger(pf.logger, backend)(p)
|
|
// we need to filter the input query strings before the request is constructed
|
|
// so the query strings are properly added to the URL:
|
|
p = NewFilterQueryStringsMiddleware(pf.logger, backend)(p)
|
|
return
|
|
}
|