service

type ExternalServiceList ¶

type ExternalServiceList struct {
	HealthCheck bool
	Init        Initialiser
}

ExternalServiceList holds the initialiser and initialisation state of external services.

func NewServiceList(initialiser Initialiser) *ExternalServiceList

func (e *ExternalServiceList) GetHTTPServer(cfg *config.Config, bindAddr string, router http.Handler) HTTPServer

func (e *ExternalServiceList) GetHealthCheck(cfg *config.Config, buildTime, gitCommit, version string) (HealthChecker, error)

func (e *ExternalServiceList) GetRequestMiddleware() RequestMiddleware

type HTTPServer ¶

type HTTPServer interface {
	ListenAndServe() error
	Shutdown(ctx context.Context) error
}

HTTPServer defines the required methods from the HTTP server

type HealthChecker ¶

type HealthChecker interface {
	Handler(w http.ResponseWriter, req *http.Request)
	Start(ctx context.Context)
	Stop()
	AddCheck(name string, checker healthcheck.Checker) (err error)
}

HealthChecker defines the required methods from Healthcheck

type Init ¶

type Init struct{}

Init implements the Initialiser interface to initialise dependencies

func (e *Init) DoGetHTTPServer(cfg *config.Config, bindAddr string, router http.Handler) HTTPServer

func (e *Init) DoGetHealthCheck(cfg *config.Config, buildTime, gitCommit, version string) (HealthChecker, error)

func (e *Init) DoGetRequestMiddleware() RequestMiddleware

type Initialiser ¶

type Initialiser interface {
	DoGetHTTPServer(cfg *config.Config, bindAddr string, router http.Handler) HTTPServer
	DoGetHealthCheck(cfg *config.Config, buildTime, gitCommit, version string) (HealthChecker, error)
	DoGetRequestMiddleware() RequestMiddleware
}

Initialiser defines the methods to initialise external services

type NoOpRequestMiddleware ¶

type NoOpRequestMiddleware struct{}

func (rm NoOpRequestMiddleware) GetMiddlewareFunction() func(http.Handler) http.Handler

type RequestMiddleware ¶

type RequestMiddleware interface {
	GetMiddlewareFunction() func(http.Handler) http.Handler
}

RequestMiddleware defines a method to get a middleware function that can modify the request. It is only needed to facilitate testing: the APIFeature in dp-component-test modifies the request to add a fake host and scheme. We need to remove this when running component tests, but don't need to do anything while in production mode. This can be achieved by injecting a middleware function (which will be different in production and test mode).

type Service ¶

type Service struct {
	Config      *config.Config
	Server      HTTPServer
	Router      *mux.Router
	Proxy       *proxy.Proxy
	ServiceList *ExternalServiceList
	HealthCheck HealthChecker
}

Service contains all the configs, server and clients to run the proxy

func Run(ctx context.Context, cfg *config.Config, serviceList *ExternalServiceList, buildTime, gitCommit, version string, svcErrors chan error) (*Service, error)

func (svc *Service) Close(ctx context.Context) error