service

Documentation

Index

• type ExternalServiceList
  • func NewServiceList(initialiser Initialiser) *ExternalServiceList
  • func (e *ExternalServiceList) GetCognitoClient(region string) cognitoclient.Client
  • func (e *ExternalServiceList) GetHTTPServer(bindAddr string, router http.Handler) HTTPServer
  • func (e *ExternalServiceList) GetHealthCheck(cfg *config.Config, buildTime, gitCommit, version string) (HealthChecker, error)
• type HTTPServer
• type HealthChecker
• type Init
  • func (e *Init) DoGetCognitoClient(AWSRegion string) cognitoclient.Client
  • func (e *Init) DoGetHTTPServer(bindAddr string, router http.Handler) HTTPServer
  • func (e *Init) DoGetHealthCheck(cfg *config.Config, buildTime, gitCommit, version string) (HealthChecker, error)
• type Initialiser
• type Service
  • func Run(ctx context.Context, cfg *config.Config, serviceList *ExternalServiceList, ...) (*Service, error)
  • func (svc *Service) Close(ctx context.Context) error

Types

type ExternalServiceList

type ExternalServiceList struct {
	HealthCheck bool
	Init        Initialiser
}

ExternalServiceList holds the initialiser and initialisation state of external services.

func NewServiceList

func NewServiceList(initialiser Initialiser) *ExternalServiceList

NewServiceList creates a new service list with the provided initialiser

func (*ExternalServiceList) GetCognitoClient

func (e *ExternalServiceList) GetCognitoClient(region string) cognitoclient.Client

GetCognitoClient creates a cognito client

func (*ExternalServiceList) GetHTTPServer

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

GetHTTPServer creates an http server

func (*ExternalServiceList) GetHealthCheck

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

GetHealthCheck creates a healthcheck with versionInfo and sets the HealthCheck flag to true

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 (*Init) DoGetCognitoClient

func (e *Init) DoGetCognitoClient(AWSRegion string) cognitoclient.Client

DoGetCognitoClient creates a CognitoClient with the provided region

func (*Init) DoGetHTTPServer

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

DoGetHTTPServer creates an HTTP Server with the provided bind address and router

func (*Init) DoGetHealthCheck

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

DoGetHealthCheck creates a healthcheck with versionInfo

type Initialiser

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

Initialiser defines the methods to initialise external services

type Service

type Service struct {
	Config      *config.Config
	Server      HTTPServer
	Router      *mux.Router
	Api         *api.API
	ServiceList *ExternalServiceList
	HealthCheck HealthChecker
}

Service contains all the configs, server and clients to run the dp-identity-api API

func Run

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

Run the service

func (*Service) Close

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

Close gracefully shuts the service down in the required order, with timeout