rpcfiber

package
v0.65.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 11, 2026 License: MIT Imports: 13 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ExtractMetaFromContext

func ExtractMetaFromContext(ctx router.Context, meta *cmdrpc.RequestMeta)

ExtractMetaFromContext reads known values from request context.

func ExtractMetaFromHeaders

func ExtractMetaFromHeaders(ctx router.Context, meta *cmdrpc.RequestMeta)

ExtractMetaFromHeaders copies request headers and known identity fields from headers.

func ExtractMetaFromParams

func ExtractMetaFromParams(ctx router.Context, meta *cmdrpc.RequestMeta)

ExtractMetaFromParams copies route params and known identity fields from params.

func ExtractMetaFromQuery

func ExtractMetaFromQuery(ctx router.Context, meta *cmdrpc.RequestMeta)

ExtractMetaFromQuery copies query string and known identity fields from query values.

func Mount added in v0.63.0

func Mount[T any](r router.Router[T], srv MethodServer, opts ...Option) error

Mount registers RPC endpoints on any go-router backend.

func MountFiber

func MountFiber(r router.Router[*fiber.App], srv MethodServer, opts ...Option) error

MountFiber mounts RPC invoke/discovery endpoints on a Fiber-backed go-router Router.

Types

type AfterInvokeHook

type AfterInvokeHook func(router.Context, string, any, error)

AfterInvokeHook runs after RPC invoke (success or failure).

type BeforeInvokeHook

type BeforeInvokeHook func(router.Context, string, any) error

BeforeInvokeHook runs after payload decode/meta merge and before RPC invoke.

type Config

type Config struct {
	InvokePath           string
	EndpointsPath        string
	DiscoveryEnabled     bool
	MetaMergePolicy      MetaMergePolicy
	InvokeMiddlewares    []router.MiddlewareFunc
	DiscoveryMiddlewares []router.MiddlewareFunc

	MetaExtractors []MetaExtractor
	BeforeInvoke   BeforeInvokeHook
	AfterInvoke    AfterInvokeHook
	ErrorMapper    cmdrpc.ErrorMapper
	ErrorObserver  ErrorObserver
}

Config controls route mounting and metadata extraction behavior.

type ErrorObserver added in v0.64.0

type ErrorObserver func(router.Context, FailureEvent)

ErrorObserver observes each failed stage once, including failures before invocation. A failing invocation and a failing diagnostic/mapping callback may produce separate events. Observer panics are contained and are not re-reported.

type FailureEvent added in v0.64.0

type FailureEvent struct {
	Stage  FailureStage
	Method string
	Err    error
	Panic  any
}

FailureEvent is diagnostic-only. Err and Panic may contain private data and must never be copied into public responses. Method is client supplied.

type FailureStage added in v0.64.0

type FailureStage string

FailureStage identifies the RPC boundary that failed. It is diagnostic metadata, not a public error code or an indication that command effects were rolled back.

const (
	FailureStageParse        FailureStage = "parse"
	FailureStageResolve      FailureStage = "resolve"
	FailureStageDecode       FailureStage = "decode"
	FailureStageMetadata     FailureStage = "metadata"
	FailureStageBeforeInvoke FailureStage = "before_invoke"
	FailureStageInvoke       FailureStage = "invoke"
	FailureStageAfterInvoke  FailureStage = "after_invoke"
	FailureStageMapping      FailureStage = "mapping"
)

type MetaExtractor

type MetaExtractor func(router.Context, *cmdrpc.RequestMeta)

MetaExtractor maps request state into rpc.RequestMeta.

type MetaMergePolicy added in v0.52.0

type MetaMergePolicy string

MetaMergePolicy controls precedence when combining transport metadata with payload metadata.

const (
	// MetaMergePolicyEnvelopeOverrides preserves payload/envelope metadata precedence.
	MetaMergePolicyEnvelopeOverrides MetaMergePolicy = "envelope_overrides"
	// MetaMergePolicyTransportOverrides gives trusted transport metadata precedence.
	MetaMergePolicyTransportOverrides MetaMergePolicy = "transport_overrides"
)

type MethodServer

type MethodServer interface {
	Invoke(context.Context, string, any) (any, error)
	NewRequestForMethod(string) (any, error)
	EndpointsMeta() []cmdrpc.Endpoint
}

MethodServer is the minimum go-command/rpc server surface required by the Fiber mount.

type Option

type Option func(*Config)

Option mutates MountFiber configuration.

func WithAfterInvokeHook

func WithAfterInvokeHook(hook AfterInvokeHook) Option

WithAfterInvokeHook sets a post-invoke hook.

func WithBeforeInvokeHook

func WithBeforeInvokeHook(hook BeforeInvokeHook) Option

WithBeforeInvokeHook sets a pre-invoke hook.

func WithDiscoveryEnabled added in v0.52.0

func WithDiscoveryEnabled(enabled bool) Option

WithDiscoveryEnabled toggles registration of the discovery endpoints route.

func WithDiscoveryMiddlewares added in v0.52.0

func WithDiscoveryMiddlewares(mw ...router.MiddlewareFunc) Option

WithDiscoveryMiddlewares appends middleware only for the discovery route.

func WithEndpointsPath

func WithEndpointsPath(path string) Option

WithEndpointsPath overrides the default discovery route path.

func WithErrorMapper added in v0.64.0

func WithErrorMapper(mapper cmdrpc.ErrorMapper) Option

WithErrorMapper opts into structured application errors for returned invocation and pre-invoke errors. Use cmdrpc.DefaultErrorMapper for the default safe classifier. A mapper returning nil declines to that classifier; a nil option restores legacy mode. Transport-stage codes and HTTP statuses are unchanged.

func WithErrorObserver added in v0.64.0

func WithErrorObserver(observer ErrorObserver) Option

WithErrorObserver installs a diagnostic observer without changing AfterInvoke's invocation-only semantics. The observer must not write a response.

func WithInvokeMiddlewares added in v0.52.0

func WithInvokeMiddlewares(mw ...router.MiddlewareFunc) Option

WithInvokeMiddlewares appends middleware only for the invoke route.

func WithInvokePath

func WithInvokePath(path string) Option

WithInvokePath overrides the default invoke route path.

func WithMetaExtractor

func WithMetaExtractor(extractor MetaExtractor) Option

WithMetaExtractor appends a metadata extractor hook.

func WithMetaExtractors

func WithMetaExtractors(extractors ...MetaExtractor) Option

WithMetaExtractors replaces metadata extractor hooks.

func WithMetaMergePolicy added in v0.52.0

func WithMetaMergePolicy(policy MetaMergePolicy) Option

WithMetaMergePolicy sets transport-vs-envelope metadata precedence.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址