mirror of
https://github.com/hanzoai/zip.git
synced 2026-10-30 20:11:40 +00:00
zeekayandGitHub
879ef2d2bb
* 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.
84 lines
2.8 KiB
Go
84 lines
2.8 KiB
Go
// module-routes example — mount HIP-0105 extension modules as routes.
|
|
//
|
|
// The loader is constructed by the embedding binary (typically
|
|
// *extruntime.Loader from hanzoai/base/plugins/extruntime, with
|
|
// gojavm + wasmvm + pyvm + starlarkvm registered). zip is a CONSUMER
|
|
// of the loader — it accepts anything that satisfies zip/runtime.Loader.
|
|
//
|
|
// This example stubs a tiny in-memory loader so the example compiles
|
|
// without pulling hanzoai/base. Replace with real *extruntime.Loader
|
|
// in production.
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"log"
|
|
|
|
"github.com/hanzoai/zip"
|
|
"github.com/hanzoai/zip/middleware"
|
|
"github.com/hanzoai/zip/runtime"
|
|
)
|
|
|
|
// stubLoader is a zero-dependency runtime.Loader that echoes the
|
|
// envelope back. Replace with *extruntime.Loader in a real service.
|
|
type stubLoader struct{}
|
|
|
|
func (stubLoader) Runtimes() []string {
|
|
return []string{"goja", "wazero", "pyvm", "starlark", "native"}
|
|
}
|
|
|
|
func (stubLoader) LoadDir(_ context.Context, _ string) (map[string]runtime.Module, error) {
|
|
return map[string]runtime.Module{}, nil
|
|
}
|
|
|
|
func (stubLoader) LoadOne(_ context.Context, dir string) (runtime.Module, error) {
|
|
return &stubModule{dir: dir, rt: "goja"}, nil
|
|
}
|
|
|
|
type stubModule struct {
|
|
dir string
|
|
rt string
|
|
}
|
|
|
|
func (m *stubModule) Name() string { return m.dir }
|
|
func (m *stubModule) Runtime() string { return m.rt }
|
|
func (m *stubModule) Exports() []string { return []string{"handler"} }
|
|
func (m *stubModule) Close() error { return nil }
|
|
func (m *stubModule) Invoke(_ context.Context, fn string, payload []byte) ([]byte, error) {
|
|
return json.Marshal(map[string]any{
|
|
"status": 200,
|
|
"headers": map[string]string{"X-Module-Stub": "1"},
|
|
"body": map[string]any{"fn": fn, "echo": json.RawMessage(payload)},
|
|
})
|
|
}
|
|
|
|
func main() {
|
|
app := zip.New(zip.Config{
|
|
AppName: "module-routes",
|
|
Loader: stubLoader{},
|
|
AllowedRuntimes: []string{"goja", "wazero", "pyvm", "starlark"},
|
|
})
|
|
app.Use(middleware.Recover(), middleware.RequestID())
|
|
|
|
// Mount one module per runtime. In a real deployment each `./ext/*`
|
|
// directory contains an extension.json manifest + compiled artifact.
|
|
mustMount(app, "POST /v1/policy/eval", "wazero", "./ext/policy")
|
|
mustMount(app, "POST /v1/transform", "pyvm", "./ext/transform")
|
|
mustMount(app, "POST /v1/webhook", "goja", "./ext/webhook")
|
|
mustMount(app, "POST /v1/route", "starlark", "./ext/route")
|
|
|
|
log.Fatal(app.Listen(":8080"))
|
|
}
|
|
|
|
func mustMount(app *zip.App, methodPath, rt, modulePath string) {
|
|
// The stub loader claims rt="goja" for every directory; in this
|
|
// demo we re-register stubModule with the right rt so Module
|
|
// passes the runtime-match check. In production the real
|
|
// extruntime loader reads extension.json and the manifest decides.
|
|
if err := app.Module(methodPath, "goja", modulePath); err != nil {
|
|
log.Fatalf("mount %s: %v", methodPath, err)
|
|
}
|
|
_ = rt
|
|
}
|