router

Documentation

Index

• Constants
• Variables
• func GetGitRoutingHost(ctx context.Context, urlProvider url.Provider) string
• func NewAPIHandler(appCtx context.Context, config *types.Config, ...) http.Handler
• func NewGitHandler(urlProvider url.Provider, authenticator authn.Authenticator, ...) http.Handler
• func NewWebHandler(config *types.Config, openapi openapi.Service) http.Handler
• func SetupChecks(r chi.Router, checkCtrl *check.Controller)
• func SetupGitHooks(r chi.Router, githookCtrl *controllergithook.Controller, git git.Interface)
• func SetupMigrateRoutes(_ chi.Router, _ *migrate.Controller)
• func SetupPullReq(r chi.Router, pullreqCtrl *pullreq.Controller)
• func SetupRules(r chi.Router, repoCtrl *repo.Controller)
• func SetupUploads(r chi.Router, uploadCtrl *upload.Controller)
• func SetupWebhook(r chi.Router, webhookCtrl *webhook.Controller)
• func StripPrefix(prefix string, req *http.Request) error
• func WithLoggingRouter(handler string) logging.Option
• type APIRouter
  • func NewAPIRouter(handler http.Handler) *APIRouter
  • func (r *APIRouter) Handle(w http.ResponseWriter, req *http.Request)
  • func (r *APIRouter) IsEligibleTraffic(req *http.Request) bool
  • func (r *APIRouter) Name() string
• type GitRouter
  • func NewGitRouter(handler http.Handler, gitHost string) *GitRouter
  • func (r *GitRouter) Handle(w http.ResponseWriter, req *http.Request)
  • func (r *GitRouter) IsEligibleTraffic(req *http.Request) bool
  • func (r *GitRouter) Name() string
• type Interface
• type Router
  • func NewRouter(routers []Interface) *Router
  • func ProvideRouter(appCtx context.Context, config *types.Config, ...) *Router
  • func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type WebRouter
  • func NewWebRouter(handler http.Handler) *WebRouter
  • func (r *WebRouter) Handle(w http.ResponseWriter, req *http.Request)
  • func (r *WebRouter) IsEligibleTraffic(*http.Request) bool
  • func (r *WebRouter) Name() string

Constants

const APIMount = "/api"

const GitMount = "/git"

Variables

var WireSet = wire.NewSet(
	ProvideRouter,
)

WireSet provides a wire set for this package.

Functions

func GetGitRoutingHost

func GetGitRoutingHost(ctx context.Context, urlProvider url.Provider) string

func NewAPIHandler

func NewAPIHandler(
	appCtx context.Context,
	config *types.Config,
	authenticator authn.Authenticator,
	repoCtrl *repo.Controller,
	repoSettingsCtrl *reposettings.Controller,
	executionCtrl *execution.Controller,
	logCtrl *logs.Controller,
	spaceCtrl *space.Controller,
	pipelineCtrl *pipeline.Controller,
	secretCtrl *secret.Controller,
	triggerCtrl *trigger.Controller,
	connectorCtrl *connector.Controller,
	templateCtrl *template.Controller,
	pluginCtrl *plugin.Controller,
	pullreqCtrl *pullreq.Controller,
	webhookCtrl *webhook.Controller,
	githookCtrl *controllergithook.Controller,
	git git.Interface,
	saCtrl *serviceaccount.Controller,
	userCtrl *user.Controller,
	principalCtrl principal.Controller,
	checkCtrl *check.Controller,
	sysCtrl *system.Controller,
	uploadCtrl *upload.Controller,
	searchCtrl *keywordsearch.Controller,
	infraProviderCtrl *infraprovider.Controller,
	migrateCtrl *migrate.Controller,
	gitspaceCtrl *gitspace.Controller,
) http.Handler

NewAPIHandler returns a new APIHandler.

func NewGitHandler

func NewGitHandler(
	urlProvider url.Provider,
	authenticator authn.Authenticator,
	repoCtrl *repo.Controller,
) http.Handler

NewGitHandler returns a new GitHandler.

func NewWebHandler

func NewWebHandler(config *types.Config,
	openapi openapi.Service,
) http.Handler

NewWebHandler returns a new WebHandler.

func SetupChecks

func SetupChecks(r chi.Router, checkCtrl *check.Controller)

func SetupGitHooks

func SetupGitHooks(r chi.Router, githookCtrl *controllergithook.Controller, git git.Interface)

func SetupMigrateRoutes

func SetupMigrateRoutes(_ chi.Router, _ *migrate.Controller)

func SetupPullReq

func SetupPullReq(r chi.Router, pullreqCtrl *pullreq.Controller)

func SetupRules

func SetupRules(r chi.Router, repoCtrl *repo.Controller)

func SetupUploads

func SetupUploads(r chi.Router, uploadCtrl *upload.Controller)

func SetupWebhook

func SetupWebhook(r chi.Router, webhookCtrl *webhook.Controller)

func StripPrefix

func StripPrefix(prefix string, req *http.Request) error

StripPrefix removes the prefix from the request path (or noop if it's not there).

func WithLoggingRouter

func WithLoggingRouter(handler string) logging.Option

WithLoggingRouter can be used to annotate logs with the handler info.

Types

type APIRouter

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

func NewAPIRouter

func NewAPIRouter(handler http.Handler) *APIRouter

func (*APIRouter) Handle

func (r *APIRouter) Handle(w http.ResponseWriter, req *http.Request)

func (*APIRouter) IsEligibleTraffic

func (r *APIRouter) IsEligibleTraffic(req *http.Request) bool

func (*APIRouter) Name

func (r *APIRouter) Name() string

type GitRouter

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

func NewGitRouter

func NewGitRouter(handler http.Handler, gitHost string) *GitRouter

func (*GitRouter) Handle

func (r *GitRouter) Handle(w http.ResponseWriter, req *http.Request)

func (*GitRouter) IsEligibleTraffic

func (r *GitRouter) IsEligibleTraffic(req *http.Request) bool

func (*GitRouter) Name

func (r *GitRouter) Name() string

type Interface

type Interface interface {
	Handle(w http.ResponseWriter, req *http.Request)
	IsEligibleTraffic(req *http.Request) bool
	Name() string
}

type Router

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

func NewRouter

func NewRouter(
	routers []Interface,
) *Router

NewRouter returns a new http.Handler that routes traffic to the appropriate handlers.

func ProvideRouter

func ProvideRouter(
	appCtx context.Context,
	config *types.Config,
	authenticator authn.Authenticator,
	repoCtrl *repo.Controller,
	repoSettingsCtrl *reposettings.Controller,
	executionCtrl *execution.Controller,
	logCtrl *logs.Controller,
	spaceCtrl *space.Controller,
	pipelineCtrl *pipeline.Controller,
	secretCtrl *secret.Controller,
	triggerCtrl *trigger.Controller,
	connectorCtrl *connector.Controller,
	templateCtrl *template.Controller,
	pluginCtrl *plugin.Controller,
	pullreqCtrl *pullreq.Controller,
	webhookCtrl *webhook.Controller,
	githookCtrl *githook.Controller,
	git git.Interface,
	saCtrl *serviceaccount.Controller,
	userCtrl *user.Controller,
	principalCtrl principal.Controller,
	checkCtrl *check.Controller,
	sysCtrl *system.Controller,
	blobCtrl *upload.Controller,
	searchCtrl *keywordsearch.Controller,
	infraProviderCtrl *infraprovider.Controller,
	gitspaceCtrl *gitspace.Controller,
	migrateCtrl *migrate.Controller,
	urlProvider url.Provider,
	openapi openapi.Service,
) *Router

ProvideRouter provides ordered list of routers.

func (*Router) ServeHTTP

func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request)

type WebRouter

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

func NewWebRouter

func NewWebRouter(handler http.Handler) *WebRouter

func (*WebRouter) Handle

func (r *WebRouter) Handle(w http.ResponseWriter, req *http.Request)

func (*WebRouter) IsEligibleTraffic

func (r *WebRouter) IsEligibleTraffic(*http.Request) bool

func (*WebRouter) Name

func (r *WebRouter) Name() string