echo

echo v5

Factory for Echo v5 (github.com/labstack/echo/v5). It lives beside echo/v4: same options, same config keys (boost.factory.echo.*) and the same plugin set, written against the v5 API. An app picks one of the two; a service moves from v4 to v5 by changing the import paths and the handler signature.

Usage

import (
	"context"
	"net/http"

	e "github.com/labstack/echo/v5"
	"github.com/xgodev/boost"
	"github.com/xgodev/boost/factory/contrib/labstack/echo/v5"
	"github.com/xgodev/boost/factory/contrib/labstack/echo/v5/plugins/local/extra/health"
	"github.com/xgodev/boost/factory/contrib/labstack/echo/v5/plugins/native/recover"
)

func main() {
	boost.Start()
	ctx := context.Background()

	srv, err := echo.NewServer(ctx, recover.Register, health.Register)
	if err != nil {
		panic(err)
	}

	srv.GET("/hello", func(c *e.Context) error {
		return c.String(http.StatusOK, "Hello, World!")
	})

	srv.Serve(ctx) // blocks until srv.Shutdown(ctx)
}

Constructors:

Each returns (*Server, error): a plugin that fails stops the build and its error is returned. Serve blocks and logs any error but the http.ErrServerClosed that Shutdown causes; Shutdown drains the server within the context deadline. *Server is a multiserver.Server.

With fx, fx/modules/factory/contrib/labstack/echo/v5.Module() provides *echo.Server and *e.Echo and joins the multiserver group, so the multiserver module serves it on the app start and shuts it down on the stop. Plugins come from the optional []echo.Plugin in the graph.

Configuration

Plugins

Every plugin has a package Register(ctx, srv) error that reads its keys under boost.factory.echo.plugins.<name>, and the constructor trio NewX(), NewXWithConfigPath(path), NewXWithOptions(opts).

The Prometheus collectors register once per process in the default registry, so every echo server of the app reports into the same echo_* metrics. The OpenTelemetry plugin uses the providers of factory/contrib/go.opentelemetry.io/otel/v1.

Differences from v4

• Handlers take *echo.Context (v5) instead of echo.Context; route methods return echo.RouteInfo; ErrorHandlerJSON/ErrorHandlerString take (c, err).
• Echo logs through log/slog; WrapLogger bridges it to the boost logger.
• Constructors and plugins return their errors instead of panicking or calling log.Fatal.
• cors.allowed.credentials defaults to false: echo v5 refuses credentials with the * origin. Set explicit origins to turn it on.
• bodyLimit.* and bodydump.* keys are registered under their plugin path (v4 missed them) and H2C reads hc2.* under the server path.
• Prometheus, pprof and OpenTelemetry use the v5 echo-contrib/echo-otel packages; Swagger UI uses swaggo/echo-swagger/v2 (v4 has its v1 plugin).
• The builder REST door still generates echo v4 code.