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]>
109 lines
2.9 KiB
Go
109 lines
2.9 KiB
Go
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package config
|
|
|
|
import (
|
|
"fmt"
|
|
"regexp"
|
|
"strings"
|
|
)
|
|
|
|
var (
|
|
endpointURLKeysPattern = regexp.MustCompile(`/\{([a-zA-Z\-_0-9]+)\}`)
|
|
hostPattern = regexp.MustCompile(`(https?://)?([a-zA-Z0-9\._\-]+)(:[0-9]{2,6})?/?`)
|
|
)
|
|
|
|
// URIParser defines the interface for all the URI manipulation required by KrakenD
|
|
type URIParser interface {
|
|
CleanHosts([]string) []string
|
|
CleanHost(string) string
|
|
CleanPath(string) string
|
|
GetEndpointPath(string, []string) string
|
|
}
|
|
|
|
// Like URIParser but with safe versions of the clean host functionality that
|
|
// does not panic but returns an error.
|
|
type SafeURIParser interface {
|
|
SafeCleanHosts([]string) ([]string, error)
|
|
SafeCleanHost(string) (string, error)
|
|
CleanPath(string) string
|
|
GetEndpointPath(string, []string) string
|
|
}
|
|
|
|
// NewURIParser creates a new URIParser using the package variable RoutingPattern
|
|
func NewURIParser() URIParser {
|
|
return URI(RoutingPattern)
|
|
}
|
|
|
|
// NewSafeURIParser creates a safe URI parser that does not panic when cleaning hosts
|
|
func NewSafeURIParser() URI {
|
|
return URI(RoutingPattern)
|
|
}
|
|
|
|
// URI implements the URIParser interface
|
|
type URI int
|
|
|
|
// SafeCleanHosts applies the SafeCleanHost method to every member of the received array of hosts
|
|
func (u URI) SafeCleanHosts(hosts []string) ([]string, error) {
|
|
cleaned := make([]string, 0, len(hosts))
|
|
for i := range hosts {
|
|
h, err := u.SafeCleanHost(hosts[i])
|
|
if err != nil {
|
|
return nil, fmt.Errorf("host %s not valid: %w", hosts[i], errInvalidHost)
|
|
}
|
|
cleaned = append(cleaned, h)
|
|
}
|
|
return cleaned, nil
|
|
}
|
|
|
|
// CleanHosts applies the CleanHost method to every member of the received array of hosts
|
|
// Panics in case of error.
|
|
func (u URI) CleanHosts(hosts []string) []string {
|
|
ss, e := u.SafeCleanHosts(hosts)
|
|
if e != nil {
|
|
panic(e)
|
|
}
|
|
return ss
|
|
}
|
|
|
|
// SafeCleanHost sanitizes the received host
|
|
func (URI) SafeCleanHost(host string) (string, error) {
|
|
matches := hostPattern.FindAllStringSubmatch(host, -1)
|
|
if len(matches) != 1 {
|
|
return "", errInvalidHost
|
|
}
|
|
keys := matches[0][1:]
|
|
if keys[0] == "" {
|
|
keys[0] = "http://"
|
|
}
|
|
return strings.Join(keys, ""), nil
|
|
}
|
|
|
|
// CleanHost sanitizes the received host.
|
|
// Panics on error.
|
|
func (u URI) CleanHost(host string) string {
|
|
h, err := u.SafeCleanHost(host)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
return h
|
|
}
|
|
|
|
// CleanPath trims all the extra slashes from the received URI path
|
|
func (URI) CleanPath(path string) string {
|
|
return "/" + strings.TrimPrefix(path, "/")
|
|
}
|
|
|
|
// GetEndpointPath applies the proper replacement in the received path to generate valid route patterns
|
|
func (u URI) GetEndpointPath(path string, params []string) string {
|
|
result := path
|
|
if u == ColonRouterPatternBuilder {
|
|
for p := range params {
|
|
parts := strings.Split(result, "?")
|
|
parts[0] = strings.ReplaceAll(parts[0], "{"+params[p]+"}", ":"+params[p])
|
|
result = strings.Join(parts, "?")
|
|
}
|
|
}
|
|
return result
|
|
}
|