http

Documentation

Index

• func FaviconHandler() http.Handler
• func LogTraceID(next http.Handler) http.Handler
• func PrometheusMiddleware(next http.Handler) http.Handler
• func SvelteKitHandler(path string) http.Handler
• type CatalogClient
  • func NewCatalogClient(url string) CatalogClient
  • func (c CatalogClient) Authenticate() (*model.User, error)
  • func (c CatalogClient) Doughs() ([]model.Dough, error)
  • func (c CatalogClient) GetRecommendation(id int) (*model.Pizza, error)
  • func (c CatalogClient) Ingredients(ingredientType string) ([]model.Ingredient, error)
  • func (c CatalogClient) RecordRecommendation(p model.Pizza) (*model.Pizza, error)
  • func (c CatalogClient) Tools() ([]string, error)
  • func (c CatalogClient) WithClient(client *http.Client) CatalogClient
  • func (c CatalogClient) WithRequestContext(ctx context.Context) CatalogClient
• type CopyClient
  • func NewCopyClient(url string) CopyClient
  • func (c CopyClient) Adjectives() ([]string, error)
  • func (c CopyClient) Names() ([]string, error)
  • func (c CopyClient) WithClient(client *http.Client) CopyClient
  • func (c CopyClient) WithRequestContext(ctx context.Context) CopyClient
• type PizzaRecommendation
• type Restrictions
  • func (r Restrictions) WithDefaults() Restrictions
• type Server
  • func NewServer(profiling bool, traceInstaller *TraceInstaller) *Server
  • func (s *Server) AddCatalogHandler(db *database.Catalog)
  • func (s *Server) AddConfigHandler(config map[string]string)
  • func (s *Server) AddCopyHandler(db *database.Copy)
  • func (s *Server) AddFrontend()
  • func (s *Server) AddGateway(catalogUrl, copyUrl, wsUrl, recommendationsUrl, configUrl string)
  • func (s *Server) AddHTTPTesting()
  • func (s *Server) AddLivenessProbes()
  • func (s *Server) AddPrometheusHandler()
  • func (s *Server) AddRecommendations(catalogClient CatalogClient, copyClient CopyClient)
  • func (s *Server) AddTestK6IO()
  • func (s *Server) AddWebSocket()
  • func (s *Server) AuthMiddleware(db *database.Catalog) func(http.Handler) http.Handler
  • func (s *Server) AuthViaCatalogClientMiddleware(catalogClient CatalogClient) func(http.Handler) http.Handler
  • func (s *Server) ServeHTTP(rw http.ResponseWriter, r *http.Request)
• type TraceInstaller
  • func NewTraceInstaller(ctx context.Context, endpointUrl string) (*TraceInstaller, error)
  • func (t *TraceInstaller) Insecure()
  • func (t *TraceInstaller) Install(r chi.Router, serviceName string, extraOpts ...otelhttp.Option)

Functions

func FaviconHandler

func FaviconHandler() http.Handler

func LogTraceID

func LogTraceID(next http.Handler) http.Handler

func PrometheusMiddleware

func PrometheusMiddleware(next http.Handler) http.Handler

func SvelteKitHandler

func SvelteKitHandler(path string) http.Handler

From: https://www.liip.ch/en/blog/embed-sveltekit-into-a-go-binary

Types

type CatalogClient

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

CatalogClient is a client that queries the Catalog service.

func NewCatalogClient

func NewCatalogClient(url string) CatalogClient

NewCatalogClient returns a ready-to-use client for the QuickPizza catalog, service given its URL.

func (CatalogClient) Authenticate

func (c CatalogClient) Authenticate() (*model.User, error)

Authenticate authenticates the token against the /api/users/token/authenticate endpoint. The token will be taken from the authentication information in c.ctx, under the authKey key. Its value should be "token <TOKEN>".

func (CatalogClient) Doughs

func (c CatalogClient) Doughs() ([]model.Dough, error)

func (CatalogClient) GetRecommendation

func (c CatalogClient) GetRecommendation(id int) (*model.Pizza, error)

func (CatalogClient) Ingredients

func (c CatalogClient) Ingredients(ingredientType string) ([]model.Ingredient, error)

func (CatalogClient) RecordRecommendation

func (c CatalogClient) RecordRecommendation(p model.Pizza) (*model.Pizza, error)

func (CatalogClient) Tools

func (c CatalogClient) Tools() ([]string, error)

func (CatalogClient) WithClient

func (c CatalogClient) WithClient(client *http.Client) CatalogClient

WithClient returns a CatalogClient that uses the specified http.Client, instead of http.DefaultClient.

func (CatalogClient) WithRequestContext

func (c CatalogClient) WithRequestContext(ctx context.Context) CatalogClient

WithRequestContext returns a copy of the CatalogClient that will use the supplied context. This context should come from a http.Request, and if provided, CatalogClient will: - Extract parent tracer and trace IDs from it and propagate it to the requests it makes. - Extract the QuickPizza user ID from it and propagate it as well.

type CopyClient

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

CopyClient is a client that queries the Copy service.

func NewCopyClient

func NewCopyClient(url string) CopyClient

NewCopyClient is the Copy service equivalent of NewCatalogClient.

func (CopyClient) Adjectives

func (c CopyClient) Adjectives() ([]string, error)

func (CopyClient) Names

func (c CopyClient) Names() ([]string, error)

func (CopyClient) WithClient

func (c CopyClient) WithClient(client *http.Client) CopyClient

WithClient is the Copy service equivalent of CatalogClient.

func (CopyClient) WithRequestContext

func (c CopyClient) WithRequestContext(ctx context.Context) CopyClient

WithRequestContext is the Copy service equivalent of CatalogClient.

type PizzaRecommendation

type PizzaRecommendation struct {
	Pizza      model.Pizza `json:"pizza"`
	Calories   int         `json:"calories"`
	Vegetarian bool        `json:"vegetarian"`
}

PizzaRecommendation is the object returned by the /api/pizza endpoint.

type Restrictions

type Restrictions struct {
	MaxCaloriesPerSlice int      `json:"maxCaloriesPerSlice"`
	MustBeVegetarian    bool     `json:"mustBeVegetarian"`
	ExcludedIngredients []string `json:"excludedIngredients"`
	ExcludedTools       []string `json:"excludedTools"`
	MaxNumberOfToppings int      `json:"maxNumberOfToppings"`
	MinNumberOfToppings int      `json:"minNumberOfToppings"`
}

Restrictions are sent by the client to further specify how the target pizza should look like

func (Restrictions) WithDefaults

func (r Restrictions) WithDefaults() Restrictions

type Server

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

Server is the object that handles HTTP requests and computes pizza recommendations. Routes are divided into serveral groups that can be instantiated independently as microservices, or all together as one single big service.

func NewServer

func NewServer(profiling bool, traceInstaller *TraceInstaller) *Server

func (*Server) AddCatalogHandler

func (s *Server) AddCatalogHandler(db *database.Catalog)

AddCatalogHandler enables routes related to the ingredients, doughs, tools, ratings and users. A database.InMemoryDatabase is required to enable this endpoint group. This database is safe to be used concurrently and thus may be shared with other endpoint groups.

func (*Server) AddConfigHandler

func (s *Server) AddConfigHandler(config map[string]string)

AddConfigHandler enables serving the config server.

func (*Server) AddCopyHandler

func (s *Server) AddCopyHandler(db *database.Copy)

AddCopyHandler enables copy (i.e. prose) related endpoints.

func (*Server) AddFrontend

func (s *Server) AddFrontend()

AddFrontend enables serving the embedded Svelte frontend.

func (*Server) AddGateway

func (s *Server) AddGateway(catalogUrl, copyUrl, wsUrl, recommendationsUrl, configUrl string)

AddGateway enables a gateway that routes external requests to the respective services. This endpoint should be typically enabled toget with WithFrontend on a microservices-based deployment. TODO: So far the gateway only handles a few endpoints.

func (*Server) AddHTTPTesting

func (s *Server) AddHTTPTesting()

AddHTTPTesting enables routes for simple HTTP endpoint testing, like in httpbin.org. These are meant to replace https://github.com/grafana/httpbin (roughly).

func (*Server) AddLivenessProbes

func (s *Server) AddLivenessProbes()

func (*Server) AddPrometheusHandler

func (s *Server) AddPrometheusHandler()

AddPrometheusHandler adds a /metrics endpoint and instrument subsequently enabled groups with general http-level metrics.

func (*Server) AddRecommendations

func (s *Server) AddRecommendations(catalogClient CatalogClient, copyClient CopyClient)

AddRecommendations enables the recommendations endpoint in this Server. This endpoint is stateless and thus needs the URLs for the Catalog and Copy services.

func (*Server) AddTestK6IO

func (s *Server) AddTestK6IO()

AddTestK6IO enables routes for replacing the legacy test.k6.io service. It tries to follow https://github.com/grafana/test.k6.io as closely as possible, even though the original service was implemented in PHP. For this reason, the paths defined here will sometimes end in '.php'.

func (*Server) AddWebSocket

func (s *Server) AddWebSocket()

AddWebSocket enables serving and handle websockets.

func (*Server) AuthMiddleware

func (s *Server) AuthMiddleware(db *database.Catalog) func(http.Handler) http.Handler

func (*Server) AuthViaCatalogClientMiddleware

func (s *Server) AuthViaCatalogClientMiddleware(catalogClient CatalogClient) func(http.Handler) http.Handler

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type TraceInstaller

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

TraceInstaller installs tracing middleware into a chi router. An uninitialized TraceInstaller behaves like a noop, where calls to Install have no effect.

func NewTraceInstaller

func NewTraceInstaller(ctx context.Context, endpointUrl string) (*TraceInstaller, error)

NewTraceInstaller creates a new initialized TraceInstaller that will set up traces and push them.

func (*TraceInstaller) Insecure

func (t *TraceInstaller) Insecure()

Insecure instructs the TraceInstaller to trust incoming trace IDs.

func (*TraceInstaller) Install

func (t *TraceInstaller) Install(r chi.Router, serviceName string, extraOpts ...otelhttp.Option)

Install adds tracing middleware to the supplied chi.Router. extraOpts take precedence over the default opts.