mirror of
https://github.com/zap-proto/zip.git
synced 2026-10-19 15:38:57 +00:00
App, Group, Operation. A group is a prefix and what holds under it, an operation
is one typed route declared there, and the verb methods are generic methods —
which Go 1.27 allows on a concrete type and still refuses on an interface. So In
and Out come from the handler and the caller writes no type arguments:
users := app.Group("/v1/users")
users.Post("/", api.Create)
mint := users.Group("/mint").With(middleware.Mint(gate))
mint.Post("/deposit", api.Deposit)
A Group is a CLOSED HANDLE: two unexported fields, and no method that hands back
the app, the parent or the fiber underneath. A subsystem given the group at its
own prefix cannot reach above it, so confinement is a property of the type
instead of a rule something has to police — which is what a host needs in order
to hand out a bounded surface and know what comes back.
That is bought by giving up the router interface, deliberately. Router and
OpTarget are gone, and with them the ability to implement a route table outside
this package: a decorator is no longer a router, a gate is middleware on a group,
and a bound is a path. The five package-level verb functions go the same way —
a registration is a method on the thing it registers into.
Raw carries what is not a typed operation: a stream, an upgrade, a probe, a
foreign subtree. It names its method, and it is the longer spelling because
opting out of the typed model is the exception and should read like one.
Co-authored-by: Hanzo Dev <[email protected]>
82 lines
2.8 KiB
Go
82 lines
2.8 KiB
Go
package zip_test
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"testing"
|
|
|
|
"github.com/zap-proto/zip"
|
|
)
|
|
|
|
type askIn struct {
|
|
Ref string `json:"ref"`
|
|
}
|
|
type askOut struct {
|
|
Org string `json:"org"`
|
|
}
|
|
|
|
// Ask is the whole of what a caller needs to reach a peer: a name, an op token
|
|
// and a value. No address, no registry, no discovery — and the tenant rides the
|
|
// CALLER, so the callee reads an org the caller could not choose.
|
|
func TestAskReachesAPeerByNameAndCarriesTheCaller(t *testing.T) {
|
|
dir := sockDir(t)
|
|
t.Setenv(zip.RuntimeDirEnv, dir)
|
|
|
|
peer := zip.New(zip.Config{AppName: "ledger", DisableStartupMessage: true})
|
|
peer.Post("/v1/ledger/whoami", func(ctx context.Context, in *askIn) (*askOut, error) {
|
|
org, ok := zip.Tenant(ctx)
|
|
if !ok {
|
|
return nil, zip.Errorf(403, "no tenant")
|
|
}
|
|
return &askOut{Org: org}, nil
|
|
}, zip.WithOperationID("ledger_whoami"))
|
|
|
|
go func() { _ = peer.Listen(zip.SocketPath("ledger")) }()
|
|
t.Cleanup(func() { _ = peer.Shutdown() })
|
|
waitSock(t, zip.SocketPath("ledger"))
|
|
|
|
// A background job STATES its caller once, explicitly. It cannot launder one:
|
|
// an inbound request always wins over a stated caller.
|
|
ctx := zip.WithCaller(context.Background(), zip.Caller{User: "u_job", Org: "acme"})
|
|
out, err := zip.Ask[askIn, askOut](ctx, "ledger", "ledger_whoami", &askIn{Ref: "r1"})
|
|
if err != nil {
|
|
t.Fatalf("Ask: %v", err)
|
|
}
|
|
if out.Org != "acme" {
|
|
t.Fatalf("org = %q, want acme", out.Org)
|
|
}
|
|
|
|
// A caller with no validated principal is refused by the CALLEE, not by
|
|
// anything the caller could skip.
|
|
_, err = zip.Ask[askIn, askOut](context.Background(), "ledger", "ledger_whoami", &askIn{})
|
|
var he *zip.HTTPError
|
|
if !errors.As(err, &he) || he.Status != 403 {
|
|
t.Fatalf("unauthenticated Ask = %v, want a 403 from the callee", err)
|
|
}
|
|
}
|
|
|
|
// The Conn is kept for the life of the process: a plane hop must not pay for a
|
|
// fresh connect, which is what "dial, call, close" per call costs.
|
|
func TestAskReusesOneConnPerPeer(t *testing.T) {
|
|
dir := sockDir(t)
|
|
t.Setenv(zip.RuntimeDirEnv, dir)
|
|
|
|
peer := zip.New(zip.Config{AppName: "reuse", DisableStartupMessage: true})
|
|
peer.Post("/v1/reuse/ping", func(ctx context.Context, in *askIn) (*askOut, error) {
|
|
return &askOut{Org: "ok"}, nil
|
|
}, zip.WithOperationID("reuse_ping"))
|
|
go func() { _ = peer.Listen(zip.SocketPath("reuse")) }()
|
|
t.Cleanup(func() { _ = peer.Shutdown() })
|
|
waitSock(t, zip.SocketPath("reuse"))
|
|
|
|
ctx := zip.WithCaller(context.Background(), zip.Caller{User: "u", Org: "o"})
|
|
for i := 0; i < 20; i++ {
|
|
if _, err := zip.Ask[askIn, askOut](ctx, "reuse", "reuse_ping", &askIn{}); err != nil {
|
|
t.Fatalf("call %d: %v", i, err)
|
|
}
|
|
}
|
|
// One socket, N calls: nothing to assert about the pool from outside, so the
|
|
// property under test is that 20 sequential calls succeed on one handle
|
|
// without the caller ever holding a Conn.
|
|
}
|