feat: add HTTP/REST gateway via grpc-gateway#21
Merged
Conversation
Adds an optional HTTP/REST gateway that translates JSON-over-HTTP requests to gRPC calls, making all LedgerService methods accessible without a gRPC client. - Proto: annotate all 11 RPC methods with google.api.http options (POST/GET/PUT/PATCH/DELETE mapped to REST-idiomatic URLs under /v1/streams) - buf.yaml: add buf.build/googleapis/googleapis dependency - buf.gen.yaml: add buf.build/grpc-ecosystem/gateway plugin - api/ledger/v1/ledger.pb.gw.go: generated grpc-gateway handler registration - internal/server/gateway.go: newGatewayHandler, header matcher (x-ledger-store, x-api-key), and TLS-aware dial options for the loopback gRPC connection - internal/server/server.go: optional HTTP server wired alongside gRPC; Serve() starts HTTP in a goroutine, Stop() shuts it down gracefully - internal/config/config.go: HTTPListen field (empty = gateway disabled) - internal/cli/root.go: --http-addr flag - internal/cli/start.go: propagate --http-addr to background process; writeDefaultConfig includes http_listen comment - Tests: TestGatewayHealth, TestGatewayAppendRead, TestGatewayAPIKeyAuth
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
google.api.httpoptions; REST URLs followPOST /v1/streams/{stream}/entries,GET /v1/streams/{stream}/entries, etc.internal/server/gateway.godials the local gRPC server and mounts aruntime.ServeMux;x-ledger-storeandx-api-keyHTTP headers are forwarded as gRPC metadata so existing auth interceptors handle authentication unchangedhttp_listenconfig field (and--http-addrCLI flag) enables the gateway — empty means disabled, so existing deployments are unaffectedStop()callshttpServer.Shutdown(ctx)beforeGracefulStop(), preserving the existing shutdown orderTest plan
TestGatewayHealth—GET /v1/healthreturns{"status":"ok"}TestGatewayAppendRead— append viaPOST, read back viaGET, verify entry round-tripTestGatewayAPIKeyAuth— requests withoutx-api-keyreturn 401; valid key returns 200