handler

Documentation

Overview

Package handler provides functionality for executing Gitaly commands

Index

• type GitalyCommand
  • func NewGitalyCommand(cfg *config.Config, serviceName string, response *accessverifier.Response) *GitalyCommand
  • func (gc *GitalyCommand) LogExecution(ctx context.Context, repository *pb.Repository, env sshenv.Env)
  • func (gc *GitalyCommand) PrepareContext(ctx context.Context, repository *pb.Repository, env sshenv.Env) (context.Context, context.CancelFunc)
  • func (gc *GitalyCommand) RunGitalyCommand(ctx context.Context, handler GitalyHandlerFunc) error
• type GitalyHandlerFunc

Types

type GitalyCommand

type GitalyCommand struct {
	Config   *config.Config
	Response *accessverifier.Response
	Command  gitaly.Command
}

GitalyCommand provides functionality for executing Gitaly commands

func NewGitalyCommand

func NewGitalyCommand(cfg *config.Config, serviceName string, response *accessverifier.Response) *GitalyCommand

NewGitalyCommand creates a new GitalyCommand instance

func (*GitalyCommand) LogExecution

func (gc *GitalyCommand) LogExecution(ctx context.Context, repository *pb.Repository, env sshenv.Env)

LogExecution logs the execution of a Git command

func (*GitalyCommand) PrepareContext

func (gc *GitalyCommand) PrepareContext(ctx context.Context, repository *pb.Repository, env sshenv.Env) (context.Context, context.CancelFunc)

PrepareContext wraps a given context with a correlation ID and logs the command to be run.

func (*GitalyCommand) RunGitalyCommand

func (gc *GitalyCommand) RunGitalyCommand(ctx context.Context, handler GitalyHandlerFunc) error

RunGitalyCommand provides a bootstrap for Gitaly commands executed through GitLab-Shell. It ensures that logging, tracing and other common concerns are configured before executing the `handler`.

type GitalyHandlerFunc

type GitalyHandlerFunc func(ctx context.Context, client *grpc.ClientConn) (int32, error)

GitalyHandlerFunc implementations are responsible for making an appropriate Gitaly call using the provided client and context and returning an error from the Gitaly call.