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.
73 lines
2.4 KiB
Go
73 lines
2.4 KiB
Go
// Package zaprpc is the ZAP RPC dispatch surface exposed by zip.App.
|
|
// ZAP is Hanzo's binary RPC transport (HIP-001x). zip.App.ZAPListen()
|
|
// serves all registered ZAP services on a dedicated TCP port; one zip
|
|
// binary speaks HTTP/JSON for human/REST clients AND ZAP RPC for
|
|
// machine clients.
|
|
//
|
|
// **STATUS**: dispatcher and registry stubbed; full integration with
|
|
// zapc-generated server code lands in a follow-up PR. The contract here
|
|
// is stable enough to plumb today.
|
|
package zaprpc
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
)
|
|
|
|
// Service is the minimal ZAP service interface zip can dispatch to.
|
|
// zapc-generated <svc>_server.go satisfies this naturally.
|
|
type Service interface {
|
|
// Name returns the service identifier (e.g. "validate.v1").
|
|
Name() string
|
|
// Handle dispatches one RPC call on the service. method is the
|
|
// fully-qualified method name; payload is the wire-encoded ZAP
|
|
// request body; the returned bytes are the wire-encoded response.
|
|
Handle(ctx context.Context, method string, payload []byte) ([]byte, error)
|
|
}
|
|
|
|
// Registry holds the set of services served by one zip.App.ZAPListen.
|
|
type Registry struct {
|
|
services map[string]Service
|
|
}
|
|
|
|
// NewRegistry constructs an empty registry.
|
|
func NewRegistry() *Registry {
|
|
return &Registry{services: map[string]Service{}}
|
|
}
|
|
|
|
// Register adds a service. Calling twice with the same name overwrites
|
|
// (caller bug).
|
|
func (r *Registry) Register(s Service) {
|
|
r.services[s.Name()] = s
|
|
}
|
|
|
|
// Get returns the service for name, or nil.
|
|
func (r *Registry) Get(name string) Service {
|
|
return r.services[name]
|
|
}
|
|
|
|
// Names returns the registered service names.
|
|
func (r *Registry) Names() []string {
|
|
out := make([]string, 0, len(r.services))
|
|
for n := range r.services {
|
|
out = append(out, n)
|
|
}
|
|
return out
|
|
}
|
|
|
|
// ErrNoService is returned by Dispatch when the service is unregistered.
|
|
var ErrNoService = errors.New("zaprpc: service not registered")
|
|
|
|
// Dispatch invokes the named service+method against the registry. The
|
|
// real ZAP wire-decode happens upstream of this function; Dispatch is
|
|
// the seam zip.App.ZAPListen uses to route a parsed envelope to the
|
|
// right handler. Surface is stable for service callers; the network
|
|
// integration lands in the follow-up PR.
|
|
func (r *Registry) Dispatch(ctx context.Context, service, method string, payload []byte) ([]byte, error) {
|
|
s, ok := r.services[service]
|
|
if !ok {
|
|
return nil, ErrNoService
|
|
}
|
|
return s.Handle(ctx, method, payload)
|
|
}
|