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]>
98 lines
2.3 KiB
Go
98 lines
2.3 KiB
Go
package cmd
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
|
|
"github.com/hanzoai/gateway/v2/internal/plugin/cobra/plugin"
|
|
"github.com/spf13/cobra"
|
|
"golang.org/x/mod/modfile"
|
|
)
|
|
|
|
// indirectRequires returns the indirect dependencies of the go.sum file.
|
|
func indirectRequires(goSum string) (map[string]struct{}, error) {
|
|
dir := filepath.Dir(goSum)
|
|
filename := filepath.Join(dir, "go.mod")
|
|
data, err := os.ReadFile(filename)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("reading go.mod: %w", err)
|
|
}
|
|
|
|
f, err := modfile.Parse(filename, data, nil)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("parsing go.mod: %w", err)
|
|
}
|
|
|
|
indirects := map[string]struct{}{}
|
|
for _, r := range f.Require {
|
|
if r.Indirect {
|
|
indirects[r.Mod.Path] = struct{}{}
|
|
}
|
|
}
|
|
|
|
return indirects, nil
|
|
}
|
|
|
|
// getBuildInfo returns the dependencies of the binary calling it.
|
|
// It is a var to allow the replacement of the function in the tests
|
|
// as the debug.ReadBuildInfo function is not available in the tests
|
|
// https://github.com/golang/go/issues/68045
|
|
var localDescriber = plugin.Local
|
|
|
|
func pluginFunc(cmd *cobra.Command, args []string) {
|
|
if err := pluginFuncErr(cmd, args); err != nil {
|
|
cmd.Println(err)
|
|
os.Exit(1) // skipcq: RVV-A0003
|
|
}
|
|
}
|
|
|
|
func pluginFuncErr(cmd *cobra.Command, _ []string) error {
|
|
f, err := os.Open(goSum)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
defer func() { _ = f.Close() }() // Workaround false positive for GO-S2307.
|
|
|
|
desc, err := plugin.Describe(f, goVersion, libcVersion)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
diffs := localDescriber().Compare(desc)
|
|
if len(diffs) == 0 {
|
|
cmd.Println("No incompatibilities found!")
|
|
return nil
|
|
}
|
|
|
|
if gogetEnabled {
|
|
indirects, err := indirectRequires(goSum)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
for _, diff := range diffs {
|
|
if diff.Name != "go" && diff.Name != "libc" {
|
|
if _, ok := indirects[diff.Name]; ok {
|
|
cmd.Printf("go mod edit --replace %s=%s@%s\n", diff.Name, diff.Name, diff.Expected)
|
|
} else {
|
|
cmd.Printf("go get %s@%s\n", diff.Name, diff.Expected)
|
|
}
|
|
continue
|
|
}
|
|
|
|
cmd.Println(diff.Name)
|
|
cmd.Println("\thave:", diff.Have)
|
|
cmd.Println("\twant:", diff.Expected)
|
|
}
|
|
} else {
|
|
for _, diff := range diffs {
|
|
cmd.Println(diff.Name)
|
|
cmd.Println("\thave:", diff.Have)
|
|
cmd.Println("\twant:", diff.Expected)
|
|
}
|
|
}
|
|
|
|
return fmt.Errorf("%d incompatibilities found", len(diffs))
|
|
}
|