mirror of
https://github.com/hanzoai/zip.git
synced 2026-10-30 20:11:40 +00:00
* wipe upstream zeekay/zip — rebuilding on Fiber v3
* core: zip on Fiber v3 — App, Ctx, Router, typed handlers, OpenAPI
zip wraps *fiber.App. Sinatra/Express idiom (app.Get/Post/...).
Generic zip.Get[I,O], zip.Post[I,O] etc. reflection-build OpenAPI 3.1
spec served at /.well-known/openapi.json + Swagger UI at /docs.
Ctx exposes Hanzo identity (Org/User/UserEmail/IsAdmin) from gateway
X-* headers per HIP-0026. luxfi/log per-request logger via c.Log().
Module(method+path, runtime, modulePath) mounts a HIP-0105 extension
as a Fiber route. Loader is duck-typed via zip/runtime.Loader so zip
does not pull hanzoai/base as a transitive dep — service binary
constructs *extruntime.Loader and injects via zip.Config.Loader.
go.mod: go 1.26.3 (forced by luxfi/log v1.4.3 floor; brief said
1.23.6 but luxfi canonical requires 1.26.x). Fiber v3.2.0, no major
bumps planned.
* middleware: Recover, RequestID, Logger, Timeout, MaxBody, CORS, Auth, RateLimit, Telemetry
Recover catches handler panics → luxfi/log + 500 JSON.
RequestID forwards X-Request-Id (or mints 16-byte hex).
Logger wraps each request with method/path/status/dur, enriches the
per-request luxfi/log Logger via c.SetLog().
Auth trusts gateway-minted X-* headers first; falls back to bearer
verification via injected AuthVerifier.
StripIdentityHeaders for non-gateway deployments.
RateLimit is per-org (or per-IP fallback) in-memory token bucket.
Telemetry plumbs to any O11ySink.
* adapters + wsx + zaprpc
AdaptNetHTTP/AdaptNetHTTPFunc/AdaptNetHTTPMiddleware via Fiber's
adaptor pkg. app.Mount(prefix, http.Handler) for legacy chi/gin/beego
migration. Each adapter doc'd as MIGRATION TOOL — costs ~5% vs native
Fiber dispatch.
wsx is fasthttp/websocket wrapped — wsx.Upgrade(fn) returns a
zip.Handler. Conn is *websocket.Conn from fasthttp/websocket; text/
binary/close/ping/pong message constants re-exported.
zaprpc ships Service + Registry + Dispatch. app.ZAPRegistry() returns
the per-App registry. app.ZAPListen(addr) reserves the port and logs
but the on-the-wire dispatcher is stubbed — full integration in a
follow-up PR pending zapc server type stabilization.
* examples + core tests
examples/
hello/ — minimal Sinatra-style API
zap-typed/ — generic typed handler + auto-OpenAPI + Swagger
subsystem-mount/ — HIP-0106 Mount(*App, deps) idiom
module-routes/ — app.Module() over a stub zip/runtime.Loader
websocket/ — wsx.Upgrade echo server
sse-streaming/ — c.SendStreamWriter Server-Sent Events
migrate-from-gin/ — gin→zip mechanical port
migrate-from-chi/ — chi→zip via AdaptNetHTTP
migrate-from-beego/— beego→zip via AdaptNetHTTP
Verified live: hello binary serves /hello + /health 200s; zap-typed
serves /v1/validate + /.well-known/openapi.json with reflection-
derived schemas. Tests pass: 5 cases (basic routing, HTTPError, typed
validation, groups, identity headers).
* docs: README, HANZO_CHANGES, MIGRATION, MIDDLEWARE, MODULE_HANDLERS
README pitches zip as canonical Hanzo Go framework on Fiber v3.
HANZO_CHANGES documents the diff from upstream zeekay/zip — every
file replaced; only the name kept.
MIGRATION covers gin/chi/beego/net-http with per-route recipes.
MIDDLEWARE covers Recover/RequestID/Logger/Auth/etc.
MODULE_HANDLERS covers app.Module() over HIP-0105 with the wire
envelope and per-runtime guidance.
* ctx.Bind validates via reflection tags; tighten AuthVerifier interface
c.Bind/BindQuery/BindURI now run validate() after parse and return
*HTTPError(400) directly — handler code is one line:
if err := c.Bind(&v); err != nil { return err }
AuthVerifier.Verify now takes context.Context (was an empty
interface{}). middleware import adjusted.
* module-routes: default Content-Type to application/json; add tests
Modules that don't set a Content-Type in their response envelope get
application/json; charset=utf-8 by default — the wire format is JSON
both directions.
Tests cover: happy path (POST /v1/eval echoed back), runtime mismatch
between caller and manifest, AllowedRuntimes refusal, nil Loader.
110 lines
2.8 KiB
Go
110 lines
2.8 KiB
Go
package zip
|
|
|
|
import (
|
|
"github.com/gofiber/fiber/v3"
|
|
)
|
|
|
|
// Router is the path-mounting surface shared by *App and Group.
|
|
// All concrete routes flow through toFiberHandler — fiber.Ctx is
|
|
// the underlying type the framework's users never see directly.
|
|
type Router interface {
|
|
Use(handlers ...Handler) Router
|
|
|
|
Get(path string, h Handler) Router
|
|
Post(path string, h Handler) Router
|
|
Put(path string, h Handler) Router
|
|
Patch(path string, h Handler) Router
|
|
Delete(path string, h Handler) Router
|
|
Head(path string, h Handler) Router
|
|
Options(path string, h Handler) Router
|
|
All(path string, h Handler) Router
|
|
|
|
Group(prefix string, handlers ...Handler) Router
|
|
Route(prefix string, fn func(r Router)) Router
|
|
|
|
// Fiber returns the underlying fiber.Router for one-off escape.
|
|
Fiber() fiber.Router
|
|
}
|
|
|
|
// routerAdapter wraps a fiber.Router (App or Group) and exposes the
|
|
// zip-style Handler signature.
|
|
type routerAdapter struct {
|
|
r fiber.Router
|
|
app *App
|
|
}
|
|
|
|
func (a *routerAdapter) Use(handlers ...Handler) Router {
|
|
for _, h := range handlers {
|
|
a.r.Use(toFiberHandler(a.app, h))
|
|
}
|
|
return a
|
|
}
|
|
|
|
func (a *routerAdapter) Get(path string, h Handler) Router {
|
|
a.r.Get(path, toFiberHandler(a.app, h))
|
|
return a
|
|
}
|
|
|
|
func (a *routerAdapter) Post(path string, h Handler) Router {
|
|
a.r.Post(path, toFiberHandler(a.app, h))
|
|
return a
|
|
}
|
|
|
|
func (a *routerAdapter) Put(path string, h Handler) Router {
|
|
a.r.Put(path, toFiberHandler(a.app, h))
|
|
return a
|
|
}
|
|
|
|
func (a *routerAdapter) Patch(path string, h Handler) Router {
|
|
a.r.Patch(path, toFiberHandler(a.app, h))
|
|
return a
|
|
}
|
|
|
|
func (a *routerAdapter) Delete(path string, h Handler) Router {
|
|
a.r.Delete(path, toFiberHandler(a.app, h))
|
|
return a
|
|
}
|
|
|
|
func (a *routerAdapter) Head(path string, h Handler) Router {
|
|
a.r.Head(path, toFiberHandler(a.app, h))
|
|
return a
|
|
}
|
|
|
|
func (a *routerAdapter) Options(path string, h Handler) Router {
|
|
a.r.Options(path, toFiberHandler(a.app, h))
|
|
return a
|
|
}
|
|
|
|
func (a *routerAdapter) All(path string, h Handler) Router {
|
|
a.r.All(path, toFiberHandler(a.app, h))
|
|
return a
|
|
}
|
|
|
|
func (a *routerAdapter) Group(prefix string, handlers ...Handler) Router {
|
|
args := make([]any, 0, len(handlers))
|
|
for _, h := range handlers {
|
|
args = append(args, toFiberHandler(a.app, h))
|
|
}
|
|
g := a.r.Group(prefix, args...)
|
|
return &routerAdapter{r: g, app: a.app}
|
|
}
|
|
|
|
func (a *routerAdapter) Route(prefix string, fn func(r Router)) Router {
|
|
g := a.r.Group(prefix)
|
|
r := &routerAdapter{r: g, app: a.app}
|
|
fn(r)
|
|
return r
|
|
}
|
|
|
|
func (a *routerAdapter) Fiber() fiber.Router { return a.r }
|
|
|
|
// toFiberHandler turns a zip.Handler into a fiber.Handler, materialising
|
|
// the per-request *Ctx and forwarding errors to fiber's error chain (which
|
|
// runs through zip's default errorHandler).
|
|
func toFiberHandler(app *App, h Handler) fiber.Handler {
|
|
return func(fc fiber.Ctx) error {
|
|
c := &Ctx{fc: fc, app: app, log: app.logger}
|
|
return h(c)
|
|
}
|
|
}
|