helper

Documentation

Index

• Variables
• func ByteSliceHasAnyPrefix(s []byte, prefixes ...string) bool
• func ClientConnection(ctx context.Context, storageName string) (*grpc.ClientConn, error)
• func ContainsPathTraversal(path string) bool
• func DecorateError(code codes.Code, err error) error
• func ErrInternal(err error) error
• func ErrInternalf(format string, a ...interface{}) error
• func ErrInvalidArgument(err error) error
• func ErrInvalidArgumentf(format string, a ...interface{}) error
• func ErrNotFound(err error) error
• func ErrPreconditionFailed(err error) error
• func ErrPreconditionFailedf(format string, a ...interface{}) error
• func ExtractGitalyServers(ctx context.Context) (gitalyServersInfo storage.GitalyServers, err error)
• func GetObjectDirectoryPath(repo repository.GitRepo) (string, error)
• func GetPath(repo repository.GitRepo) (string, error)
• func GetRepoPath(repo repository.GitRepo) (string, error)
• func GetStorageByName(storageName string) (string, error)
• func GrpcCode(err error) codes.Code
• func IncomingToOutgoing(ctx context.Context) context.Context
• func InjectGitalyServers(ctx context.Context, name, address, token string) (context.Context, error)
• func IsGitDirectory(dir string) bool
• func IsNumber(s []byte) bool
• func SanitizeError(err error) error
• func SanitizeString(str string) string
• func UnquoteBytes(s []byte) []byte

Variables

var MaxCommitOrTagMessageSize = 10 * 1024

MaxCommitOrTagMessageSize is the threshold for a commit/tag message, if exceeded then message is truncated and it's up to the client to request it in full separately.

var Unimplemented = status.Errorf(codes.Unimplemented, "this rpc is not implemented")

Unimplemented is a Go error with gRPC error code 'Unimplemented'

Functions

func ByteSliceHasAnyPrefix

func ByteSliceHasAnyPrefix(s []byte, prefixes ...string) bool

ByteSliceHasAnyPrefix tests whether the byte slice s begins with any of the prefixes.

func ClientConnection

func ClientConnection(ctx context.Context, storageName string) (*grpc.ClientConn, error)

ClientConnection creates a grpc.ClientConn from the injected gitaly-servers metadata

func ContainsPathTraversal

func ContainsPathTraversal(path string) bool

ContainsPathTraversal checks if the path contains any traversal

func DecorateError

func DecorateError(code codes.Code, err error) error

DecorateError unless it's already a grpc error.

If given nil it will return nil.

func ErrInternal

func ErrInternal(err error) error

ErrInternal wraps err with codes.Internal, unless err is already a grpc error

func ErrInternalf

func ErrInternalf(format string, a ...interface{}) error

ErrInternalf wrapps a formatted error with codes.Internal, unless err is already a grpc error

func ErrInvalidArgument

func ErrInvalidArgument(err error) error

ErrInvalidArgument wraps err with codes.InvalidArgument, unless err is already a grpc error

func ErrInvalidArgumentf

func ErrInvalidArgumentf(format string, a ...interface{}) error

ErrInvalidArgumentf wraps a formatted error with codes.InvalidArgument, unless err is already a grpc error

func ErrNotFound

func ErrNotFound(err error) error

ErrNotFound wraps error with codes.NotFound, unless err is already a grpc error

func ErrPreconditionFailed

func ErrPreconditionFailed(err error) error

ErrPreconditionFailed wraps err with codes.FailedPrecondition, unless err is already a grpc error

func ErrPreconditionFailedf

func ErrPreconditionFailedf(format string, a ...interface{}) error

ErrPreconditionFailedf wraps a formatted error with codes.FailedPrecondition, unless err is already a grpc error

func ExtractGitalyServers

func ExtractGitalyServers(ctx context.Context) (gitalyServersInfo storage.GitalyServers, err error)

ExtractGitalyServers extracts `storage.GitalyServers` from an incoming context.

func GetObjectDirectoryPath

func GetObjectDirectoryPath(repo repository.GitRepo) (string, error)

GetObjectDirectoryPath returns the full path of the object directory in a repository referenced by an RPC Repository message. The errors returned are gRPC errors with relevant error codes and should be passed back to gRPC without further decoration.

func GetPath

func GetPath(repo repository.GitRepo) (string, error)

GetPath returns the path of the repo passed as first argument. An error is returned when either the storage can't be found or the path includes constructs trying to perform directory traversal.

func GetRepoPath

func GetRepoPath(repo repository.GitRepo) (string, error)

GetRepoPath returns the full path of the repository referenced by an RPC Repository message. The errors returned are gRPC errors with relevant error codes and should be passed back to gRPC without further decoration.

func GetStorageByName

func GetStorageByName(storageName string) (string, error)

GetStorageByName will return the path for the storage, which is fetched by its key. An error is return if it cannot be found.

func GrpcCode

func GrpcCode(err error) codes.Code

GrpcCode emulates the old grpc.Code function: it translates errors into codes.Code values.

func IncomingToOutgoing

func IncomingToOutgoing(ctx context.Context) context.Context

IncomingToOutgoing creates an outgoing context out of an incoming context with the same storage metadata

func InjectGitalyServers

func InjectGitalyServers(ctx context.Context, name, address, token string) (context.Context, error)

InjectGitalyServers injects gitaly-servers metadata into an outgoing context

func IsGitDirectory

func IsGitDirectory(dir string) bool

IsGitDirectory checks if the directory passed as first argument looks like a valid git directory.

func IsNumber

func IsNumber(s []byte) bool

IsNumber tests whether the byte slice s contains only digits or not

func SanitizeError

func SanitizeError(err error) error

SanitizeError does the same thing as SanitizeString but for error types

func SanitizeString

func SanitizeString(str string) string

SanitizeString will clean password and tokens from URLs, and replace them with [FILTERED].

func UnquoteBytes

func UnquoteBytes(s []byte) []byte

UnquoteBytes removes surrounding double-quotes from a byte slice returning a new slice if they exist, otherwise it returns the same byte slice passed.