nexus

package
v1.26.2-rc.0 Latest Latest
Warning

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

Go to latest
Published: Dec 17, 2024 License: MIT Imports: 40 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// Currently supported token version.
	TokenVersion = 1
	// Header key for the callback token in StartOperation requests.
	CallbackTokenHeader = "Temporal-Callback-Token"
)

Variables

View Source
var ErrNexusDisabled = serviceerror.NewFailedPrecondition("nexus is disabled")
View Source
var PayloadSerializer nexus.Serializer = payloadSerializer{}
View Source
var RouteCompletionCallback = routing.NewBuilder[string]().
	Constant("namespaces").
	StringVariable("namespace", func(namespace *string) *string { return namespace }).
	Constant("nexus", "callback").
	Build()

RouteCompletionCallback is an HTTP route for completing a Nexus operation via callback.

View Source
var RouteDispatchNexusTaskByEndpoint = routing.NewBuilder[string]().
	Constant("nexus", "endpoints").
	StringVariable("endpoint", func(endpoint *string) *string { return endpoint }).
	Constant("services").
	Build()
View Source
var RouteDispatchNexusTaskByNamespaceAndTaskQueue = routing.NewBuilder[NamespaceAndTaskQueue]().
	Constant("namespaces").
	StringVariable("namespace", func(params *NamespaceAndTaskQueue) *string { return &params.Namespace }).
	Constant("task-queues").
	StringVariable("task_queue", func(params *NamespaceAndTaskQueue) *string { return &params.TaskQueue }).
	Constant("nexus-services").
	Build()

Functions

func APIFailureToNexusFailure

func APIFailureToNexusFailure(failure *failurepb.Failure) (nexus.Failure, error)

APIFailureToNexusFailure converts an API proto Failure to a Nexus SDK Failure setting the metadata "type" field to the proto fullname of the temporal API Failure message. Mutates the failure temporarily, unsetting the Message field to avoid duplicating the information in the serialized failure. Mutating was chosen over cloning for performance reasons since this function may be called frequently.

func AdaptAuthorizeError

func AdaptAuthorizeError(err error) error

func ConvertGRPCError

func ConvertGRPCError(err error, exposeDetails bool) error

ConvertGRPCError converts either a serviceerror or a gRPC status error into a Nexus HandlerError if possible. If exposeDetails is true, the error message from the given error is exposed in the converted HandlerError, otherwise, a default message with minimal information is attached to the returned error. Roughly taken from https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto and https://github.com/grpc-ecosystem/grpc-gateway/blob/a7cf811e6ffabeaddcfb4ff65602c12671ff326e/runtime/errors.go#L56.

func FormatDuration added in v1.26.2

func FormatDuration(d time.Duration) string

FormatDuration converts a duration into a string representation in millisecond resolution. TODO: replace this with the version exported from the Nexus SDK

func HandlerErrorTypeFromHTTPStatus added in v1.25.0

func HandlerErrorTypeFromHTTPStatus(statusCode int) nexus.HandlerErrorType

func NexusFailureToAPIFailure added in v1.26.2

func NexusFailureToAPIFailure(failure nexus.Failure, retryable bool) (*failurepb.Failure, error)

NexusFailureToAPIFailure converts a Nexus Failure to an API proto Failure. If the failure metadata "type" field is set to the fullname of the temporal API Failure message, the failure is reconstructed using protojson.Unmarshal on the failure details field.

func NexusFailureToProtoFailure

func NexusFailureToProtoFailure(failure nexus.Failure) *nexuspb.Failure

NexusFailureToProtoFailure converts a Nexus SDK Failure to a proto Nexus Failure. Always returns a non-nil value.

func ProtoFailureToNexusFailure

func ProtoFailureToNexusFailure(failure *nexuspb.Failure) nexus.Failure

ProtoFailureToNexusFailure converts a proto Nexus Failure to a Nexus SDK Failure.

func UnsuccessfulOperationErrorToTemporalFailure

func UnsuccessfulOperationErrorToTemporalFailure(opErr *nexus.UnsuccessfulOperationError) (*failurepb.Failure, error)

Types

type CallbackToken

type CallbackToken struct {
	// Token version - currently only [TokenVersion] is supported.
	Version int `json:"v"`
	// Encoded [tokenspb.NexusOperationCompletion].
	Data string `json:"d"`
}

CallbackToken contains an encoded NexusOperationCompletion message.

func DecodeCallbackToken

func DecodeCallbackToken(encoded string) (token *CallbackToken, err error)

DecodeCallbackToken unmarshals the given token applying minimal data verification.

type CallbackTokenGenerator

type CallbackTokenGenerator struct {
}

func NewCallbackTokenGenerator

func NewCallbackTokenGenerator() *CallbackTokenGenerator

func (*CallbackTokenGenerator) DecodeCompletion

DecodeCompletion decodes a callback token unwrapping the contained NexusOperationCompletion proto struct.

func (*CallbackTokenGenerator) Tokenize

type EndpointRegistry added in v1.25.0

type EndpointRegistry interface {
	// GetByName returns an endpoint entry for the endpoint name for a caller from the given namespace ID.
	// Note that the default implementation is global to the cluster and can ignore the namespace ID param.
	GetByName(ctx context.Context, namespaceID namespace.ID, endpointName string) (*persistencespb.NexusEndpointEntry, error)
	GetByID(ctx context.Context, endpointID string) (*persistencespb.NexusEndpointEntry, error)
	StartLifecycle()
	StopLifecycle()
}

type EndpointRegistryConfig added in v1.25.0

type EndpointRegistryConfig struct {
	// contains filtered or unexported fields
}

func NewEndpointRegistryConfig added in v1.25.0

func NewEndpointRegistryConfig(dc *dynamicconfig.Collection) *EndpointRegistryConfig

type EndpointRegistryImpl added in v1.25.0

type EndpointRegistryImpl struct {
	// contains filtered or unexported fields
}

EndpointRegistryImpl manages a cached view of Nexus endpoints. Endpoints are lazily-loaded into memory on the first read. Thereafter, endpoint data is kept up to date by background long polling on matching service ListNexusEndpoints.

func NewEndpointRegistry added in v1.25.0

func NewEndpointRegistry(
	config *EndpointRegistryConfig,
	matchingClient matchingservice.MatchingServiceClient,
	persistence p.NexusEndpointManager,
	logger log.Logger,
	metricsHandler metrics.Handler,
) *EndpointRegistryImpl

func (*EndpointRegistryImpl) GetByID added in v1.25.0

func (*EndpointRegistryImpl) GetByName added in v1.25.0

func (*EndpointRegistryImpl) StartLifecycle added in v1.25.0

func (r *EndpointRegistryImpl) StartLifecycle()

StartLifecycle starts this component. It should only be invoked by an fx lifecycle hook. Should not be called multiple times or concurrently with StopLifecycle()

func (*EndpointRegistryImpl) StopLifecycle added in v1.25.0

func (r *EndpointRegistryImpl) StopLifecycle()

StopLifecycle stops this component. It should only be invoked by an fx lifecycle hook. Should not be called multiple times or concurrently with StartLifecycle()

type NamespaceAndTaskQueue

type NamespaceAndTaskQueue struct {
	Namespace string
	TaskQueue string
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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