zenrpc

Zenrpc

• Upstream: https://github.com/vmkteam/zenrpc (v2)
• Middleware: https://github.com/vmkteam/zenrpc-middleware (импорт zm)
• Clients: https://github.com/vmkteam/rpcgen (v2, см. /rpcgen)
• JSON-RPC 2.0, codegen через go generate (не reflection), SMD + OpenRPC
• Транспорты: HTTP (echo.WrapHandler(rpc)), WebSocket, NATS (brokersrv)
• Экосистема: SMDBox (браузер API), rpcdiff (diff OpenRPC)

Codegen

//go:generate go tool zenrpc

go.mod содержит tool github.com/vmkteam/zenrpc/v2/zenrpc. make generate — обязательно после любых изменений в API/моделях/аннотациях. Файлы *_zenrpc.go не редактировать.

Сервис

Встраивание zenrpc.Service; VT-сервисы дополнительно встраивают embedlog.Logger:

type ReviewService struct {
    rm *reviewer.ReviewManager
    zenrpc.Service
}

type ProjectService struct {
    zenrpc.Service
    embedlog.Logger
    projectRepo db.ProjectRepo
}

Сигнатура метода: func (Service) Method([ctx,] [args]) (<value>, <error>) — любой return опционален, value может быть pointer, error = error | *zenrpc.Error.

Аннотации (magic comments)

// GetByID returns review details.
//
//zenrpc:reviewId Review ID
//zenrpc:return Review
//zenrpc:500 Internal Error
//zenrpc:404 Not Found
func (s ReviewService) GetByID(ctx context.Context, reviewId int) (*Review, error) {

• //zenrpc:<param> Description — описание параметра
• //zenrpc:<param>=<default> Description — default value
• //zenrpc:<httpCode> Description — код ошибки
• //zenrpc:return Description — описание возврата

Ошибки

RPC-слой использует zenrpc.NewStringError, для wrap — zenrpc.NewError:

var (
    ErrInternal   = zenrpc.NewStringError(http.StatusInternalServerError, "internal error")
    ErrNotFound   = zenrpc.NewStringError(http.StatusNotFound, "not found")
    ErrBadRequest = zenrpc.NewStringError(http.StatusBadRequest, "bad request")
)
func newInternalError(err error) *zenrpc.Error {
    return zenrpc.NewError(http.StatusInternalServerError, err)
}