mirror of
https://github.com/hanzoai/gateway.git
synced 2026-11-02 23:52:23 +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]>
80 lines
2.4 KiB
Go
80 lines
2.4 KiB
Go
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package mux
|
|
|
|
import (
|
|
"net/http"
|
|
"sync"
|
|
|
|
"github.com/hanzoai/gateway/v2/internal/lura/transport/http/server"
|
|
)
|
|
|
|
// Engine defines the minimun required interface for the mux compatible engine
|
|
type Engine interface {
|
|
http.Handler
|
|
Handle(pattern, method string, handler http.Handler)
|
|
}
|
|
|
|
// BasicEngine is a slightly customized http.ServeMux router
|
|
type BasicEngine struct {
|
|
handler *http.ServeMux
|
|
dict map[string]map[string]http.HandlerFunc
|
|
}
|
|
|
|
// NewHTTPErrorInterceptor returns a HTTPErrorInterceptor over the injected response writer
|
|
func NewHTTPErrorInterceptor(w http.ResponseWriter) *HTTPErrorInterceptor {
|
|
return &HTTPErrorInterceptor{w, new(sync.Once)}
|
|
}
|
|
|
|
// HTTPErrorInterceptor is a reposnse writer that adds a header signaling incomplete response in case of
|
|
// seeing a status code not equal to 200
|
|
type HTTPErrorInterceptor struct {
|
|
http.ResponseWriter
|
|
once *sync.Once
|
|
}
|
|
|
|
// WriteHeader records the status code and adds a header signaling incomplete responses
|
|
func (i *HTTPErrorInterceptor) WriteHeader(code int) {
|
|
i.once.Do(func() {
|
|
if code != http.StatusOK {
|
|
i.ResponseWriter.Header().Set(server.CompleteResponseHeaderName, server.HeaderIncompleteResponseValue)
|
|
}
|
|
})
|
|
i.ResponseWriter.WriteHeader(code)
|
|
}
|
|
|
|
// DefaultEngine returns a new engine using BasicEngine
|
|
func DefaultEngine() *BasicEngine {
|
|
return &BasicEngine{
|
|
handler: http.NewServeMux(),
|
|
dict: map[string]map[string]http.HandlerFunc{},
|
|
}
|
|
}
|
|
|
|
// Handle registers a handler at a given url pattern and http method
|
|
func (e *BasicEngine) Handle(pattern, method string, handler http.Handler) {
|
|
if _, ok := e.dict[pattern]; !ok {
|
|
e.dict[pattern] = map[string]http.HandlerFunc{}
|
|
e.handler.Handle(pattern, e.registrableHandler(pattern))
|
|
}
|
|
e.dict[pattern][method] = handler.ServeHTTP
|
|
}
|
|
|
|
// ServeHTTP adds a error interceptor and delegates the request dispatching to the
|
|
// internal request multiplexer.
|
|
func (e *BasicEngine) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
|
e.handler.ServeHTTP(NewHTTPErrorInterceptor(w), r)
|
|
}
|
|
|
|
func (e *BasicEngine) registrableHandler(pattern string) http.Handler {
|
|
return http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
|
|
if handler, ok := e.dict[pattern][req.Method]; ok {
|
|
handler(rw, req)
|
|
return
|
|
}
|
|
|
|
rw.Header().Set(server.CompleteResponseHeaderName, server.HeaderIncompleteResponseValue)
|
|
http.Error(rw, "", http.StatusMethodNotAllowed)
|
|
})
|
|
}
|