mirror of https://github.com/hanzoai/zip.git synced 2026-10-30 20:11:40 +00:00

Files

T

zeekay 795617c313 zip: the module is hanzo.ai/zip

The import path a reader types is the one the org owns, rather than the forge
that happens to host the bytes. hanzo.ai serves the go-import meta and points it
at the same repository, so where the code lives does not change.

The README's `go get` line moves with it — an install instruction naming the old
path is the one leftover a reader would actually follow.

2026-08-23 21:44:55 -07:00

3.7 KiB

Raw Permalink Blame History

HANZO_CHANGES.md — diff from upstream zeekay/zip

zeekay/zip was a tiny net/http wrapper (~250 LOC) experimenting with Sinatra-style routing in Go circa 2014. Hanzo adopted the name and rebuilt the framework from scratch on Fiber v3 / fasthttp for the canonical Hanzo Go web framework.

What's gone

Every file from upstream has been deleted. We kept the name.

handlers.go — old net/http handler registry. Replaced by zip.App.Get/Post/... plus internal routerAdapter over fiber.Router.
request.go, response.go — old Req / Res types. Replaced by *zip.Ctx wrapping fiber.Ctx.
websocket.go — old gorilla/websocket adapter. Replaced by package wsx over fasthttp/websocket.
examples/{hello,json,websocket} — old examples. Replaced by 9 new examples covering Sinatra-style, typed handlers, OpenAPI, module routes, websocket, SSE, and three migration paths.
Module path: zeekay.io/zip → hanzo.ai/zip.

What's new

Area	Implementation
Core	`*fiber.App` under the hood; `zip.App` is the public type.
Ctx	`fiber.Ctx` interface wrapped + `Org/User/UserEmail/IsAdmin/RequestID` accessors.
Typed handlers	Generic `zip.Get[In, Out](app, path, fn)` etc. with reflection-build OpenAPI 3.1.
Validation	~120 LOC reflection: `required`, `min/max`, `minlen/maxlen` struct tags.
OpenAPI	Auto-generated at `/.well-known/openapi.json`; Swagger UI at `/docs`.
Extension routes	`app.Module(method+path, runtime, dir)` — HIP-0105 surface. Loader is duck-typed (no hanzoai/base dep).
Middleware	`Recover`, `Logger`, `RequestID`, `Timeout`, `MaxBody`, `CORS`, `RateLimit`, `Telemetry`. Auth + StripIdentityHeaders moved to hanzoai/gateway/middleware (HIP-0106).
Adapters	`AdaptNetHTTP / AdaptNetHTTPFunc / AdaptNetHTTPMiddleware`; `app.Mount(prefix, http.Handler)`.
WebSocket	`wsx.Upgrade(fn)` over fasthttp/websocket.
Streaming	`c.SendStream(reader)` + `c.SendStreamWriter(fn)`.
ZAP RPC	`zaprpc.Service`/`Registry`/`Dispatch` + `app.ZAPRegistry()`. Wire dispatcher stubbed.

Dependencies

github.com/gofiber/fiber/v3 v3.2.0 — Fiber v3.
github.com/valyala/fasthttp v1.70.0 — transport.
github.com/fasthttp/websocket v1.5.12 — WebSocket.
github.com/luxfi/log v1.4.3 — canonical Hanzo logging. Forces Go 1.26.3 floor.

No uber-go/zap, no log/slog, no chi/gin/echo deps. Adapters use Fiber's own middleware/adaptor package which is part of the v3 core.

Policy adherence

luxfi/log everywhere — zero zap or slog imports.
No .capnp anywhere — ZAP only on the RPC plane.
No major version bumps — all deps pinned to specific patches on existing major lines.
luxfi canonical packages preferred — log was already on luxfi; no other Hanzo-canonical alternative existed for the Fiber surface.
Go 1.26.3 floor — bumped from the brief's 1.23.6 only because luxfi/log canonical (the mandatory dep) requires it. Every other dep is on its current patch.
HIP-0026 identity headers — c.Org/User/UserEmail/IsAdmin map directly to gateway-minted X-Org-Id / X-User-Id / X-User-Email / X-User-IsAdmin.
HIP-0105 extension contract — duck-typed via zip/runtime.Loader so the framework stays decoupled from hanzoai/base.
HIP-0106 Mount() contract — examples/subsystem-mount is the reference; the binary composes N subsystems via the same Mount(app, deps) error signature commerce/checkout uses today.

Backwards compatibility

None. zeekay/zip and hanzoai/zip share only the name. The module path changed (zeekay.io/zip → hanzo.ai/zip) so go-modules treats them as distinct packages — no transitive collision is possible.

3.7 KiB Raw Permalink Blame History