fix(lint): some issues (#5)

.github/linters/.golangci.yml

@@ -103,8 +103,8 @@ linters-settings:
   gci:
     custom-order: true
     sections:
-      - standard
       - default
+      - standard
       - prefix(github.com/WildEgor/e-shop-fiber-microservice-boilerplate)
   staticcheck:
     checks:

.github/workflows/lint.yml

@@ -29,7 +29,7 @@ jobs:
           VALIDATE_ALL_CODEBASE: ${{ github.event_name != 'pull_request' }}
           DEFAULT_BRANCH: develop
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          FILTER_REGEX_EXCLUDE: '.*(assets/.*|\.goreleaser\.yml)'
+          FILTER_REGEX_EXCLUDE: '.*(assets/.*|\.goreleaser\.yml|api/.*\.(yml|json)|README\.md|test/request/.*)'
           # go validator works pretty bad in super-linter, we'll use the original one
           VALIDATE_GO: false
           # do not validate SQL - linters are pretty useless in case of this library,

Dockerfile

@@ -7,33 +7,33 @@ LABEL maintainer="YOUR_NAME <YOUR_EMAIL>"
 #RUN git config --global url."https://${GITHUB_TOKEN}@github.com/".insteadOf "https://github.com/"
 WORKDIR /app
 COPY ./go.mod ./go.sum ./
-RUN mkdir -p dist
-RUN go mod download
+RUN mkdir -p dist && \
+    go mod download
 
 # Development Stage
 FROM base as dev
 WORKDIR /app/
 COPY . .
-RUN go install github.com/air-verse/air@latest
-RUN go build -o dist/app cmd/main.go
+RUN go install github.com/air-verse/air@latest && \
+    go build -o dist/app cmd/main.go
 CMD ["air", "-c", ".air-unix.toml", "-d"]
 
 # Debug stage
 FROM base as debug
 WORKDIR /
 COPY . .
-RUN go install github.com/go-delve/delve/cmd/dlv@latest
-RUN go build -gcflags="all=-N -l" -o /app/app cmd/main.go
-RUN mv /go/bin/dlv /
+RUN go install github.com/go-delve/delve/cmd/dlv@latest &&  \
+    go build -gcflags="all=-N -l" -o /app/app cmd/main.go &&  \
+    mv /go/bin/dlv /
 CMD ["/dlv", "--listen=:40000", "--headless=true", "--api-version=2", "--accept-multiclient", "exec", "/app/app"]
 
 # Build Production Stage
 FROM base as build
 WORKDIR /app
 COPY . .
-RUN go install github.com/swaggo/swag/cmd/swag@latest
-RUN $GOPATH/bin/swag init -g cmd/main.go --output docs
-RUN CGO_ENABLED=0 GOOS=linux go build -ldflags="-w -s" -o dist/app cmd/main.go
+RUN go install github.com/swaggo/swag/cmd/swag@latest &&  \
+    $GOPATH/bin/swag init -g cmd/main.go --output docs &&  \
+    CGO_ENABLED=0 GOOS=linux go build -ldflags="-w -s" -o dist/app cmd/main.go
 
 # Production Stage
 FROM cgr.dev/chainguard/busybox:latest-glibc as prod

cmd/main.go

@@ -31,7 +31,11 @@ func main() {
 	)
 	defer done()
 
-	srv, _ := server.NewServer()
+	srv, err := server.NewServer()
+	if err != nil {
+		panic(err)
+	}
+
 	srv.Run(ctx)
 
 	<-ctx.Done()

internal/adapters/wire.go

@@ -2,5 +2,5 @@ package adapters
 
 import "github.com/google/wire"
 
-// AdaptersSet contains "adapters" to 3th party systems
-var AdaptersSet = wire.NewSet()
+// Set contains "adapters" to 3th party systems
+var Set = wire.NewSet()

internal/app.go

@@ -20,8 +20,8 @@ import (
 // AppSet link main app deps
 var AppSet = wire.NewSet(
 	NewApp,
-	configs.ConfigsSet,
-	routers.RouterSet,
+	configs.Set,
+	routers.Set,
 )
 
 // Server represents the main server configuration.
@@ -53,7 +53,7 @@ func (srv *Server) Run(ctx context.Context) {
 
 		if ac.IsDebug() && srv.Pyro == nil {
 			slog.Info("pyro start")
-			srv.Pyro, _ = pyroscope.Start(pyroscope.Config{
+			pyro, err := pyroscope.Start(pyroscope.Config{
 				ApplicationName: srv.AppConfig.Name,
 				ServerAddress:   srv.ProfilerConfig.API,
 				Logger:          pyroscope.StandardLogger,
@@ -65,20 +65,30 @@ func (srv *Server) Run(ctx context.Context) {
 					pyroscope.ProfileInuseSpace,
 				},
 			})
+
+			if err != nil {
+				slog.Error("cannot start pyro client", slog.Any("err", err))
+			}
+
+			srv.Pyro = pyro
 		}
 
 		if !ac.IsDebug() {
 			slog.Info("pyro stop")
 			if srv.Pyro != nil {
-				srv.Pyro.Stop()
+				err := srv.Pyro.Stop()
+				if err != nil {
+					slog.Warn("cannot stop pyro client", slog.Any("err", err))
+					return
+				}
 			}
 		}
 
 	}
 
 	srv.AppConfig.OnChanged(pr)
 
-	if err := srv.App.Listen(fmt.Sprintf(":%s", srv.AppConfig.HttpPort), fiber.ListenConfig{
+	if err := srv.App.Listen(fmt.Sprintf(":%s", srv.AppConfig.HTTPPort), fiber.ListenConfig{
 		DisableStartupMessage: false,
 		EnablePrintRoutes:     false,
 		OnShutdownSuccess: func() {
@@ -102,9 +112,10 @@ func (srv *Server) Shutdown(ctx context.Context) {
 	}
 }
 
+// NewApp init app
 func NewApp(
 	ac *configs.AppConfig,
-	lc *configs.LoggerConfig,
+	lc *configs.LoggerConfig, // init logger
 	pc *configs.ProfilerConfig,
 	c *configs.Configurator,
 	eh *eh.ErrorsHandler,

internal/configs/app.go

@@ -9,10 +9,11 @@ import (
 type AppConfig struct {
 	Name     string `mapstructure:"name"`
 	Mode     string `mapstructure:"mode"`
-	HttpPort string `mapstructure:"http_port"`
+	HTTPPort string `mapstructure:"http_port"`
 	changer  func(ac *AppConfig)
 }
 
+// NewAppConfig creates app config
 func NewAppConfig(c *Configurator) *AppConfig {
 	cfg := &AppConfig{}
 
@@ -34,6 +35,7 @@ func NewAppConfig(c *Configurator) *AppConfig {
 	return cfg
 }
 
+// OnChanged register callback
 func (ac *AppConfig) OnChanged(fn func(ac *AppConfig)) {
 	ac.changer = fn
 }

internal/configs/configurator.go

@@ -12,6 +12,7 @@ type Configurator struct {
 	watchers []func()
 }
 
+// NewConfigurator create new Configurator
 func NewConfigurator() *Configurator {
 	c := &Configurator{
 		watchers: make([]func(), 0),
@@ -21,18 +22,19 @@ func NewConfigurator() *Configurator {
 	return c
 }
 
+// Watch config
 func (c *Configurator) Watch() {
-	viper.WatchConfig()
-
 	viper.OnConfigChange(func(e fsnotify.Event) {
 		slog.Info(fmt.Sprintf("watchers len: %d", len(c.watchers)))
 
 		for _, watcher := range c.watchers {
 			watcher()
 		}
 	})
+	viper.WatchConfig()
 }
 
+// Register watcher
 func (c *Configurator) Register(name string, fn func()) {
 	slog.Info("register watcher", slog.Any("value", name))
 	c.watchers = append(c.watchers, fn)

internal/configs/logger.go

@@ -7,6 +7,7 @@ import (
 )
 
 var (
+	// LogJsonFormat specify json format
 	LogJsonFormat string = "json"
 )
 
@@ -15,12 +16,13 @@ var logLevelToSlogLevel = map[string]slog.Leveler{
 	"info":  slog.LevelInfo,
 }
 
-// ProfilerConfig holds logger configurations
+// LoggerConfig holds logger configurations
 type LoggerConfig struct {
 	Level  string `mapstructure:"level"`
 	Format string `mapstructure:"format"`
 }
 
+// NewLoggerConfig create logger config
 func NewLoggerConfig(c *Configurator) *LoggerConfig {
 	cfg := &LoggerConfig{}
 

internal/configs/profiler.go

@@ -10,6 +10,7 @@ type ProfilerConfig struct {
 	API string `mapstructure:"api"`
 }
 
+// NewProfilerConfig create profiler config
 func NewProfilerConfig(c *Configurator) *ProfilerConfig {
 	cfg := &ProfilerConfig{}
 

internal/configs/wire.go

@@ -2,8 +2,8 @@ package configs
 
 import "github.com/google/wire"
 
-// ConfigsSet contains project configs
-var ConfigsSet = wire.NewSet(
+// Set contains project configs
+var Set = wire.NewSet(
 	NewConfigurator,
 	NewAppConfig,
 	NewLoggerConfig,

internal/handlers/errors/handler.go

@@ -9,10 +9,12 @@ import (
 type ErrorsHandler struct {
 }
 
+// NewErrorsHandler creates new handler
 func NewErrorsHandler() *ErrorsHandler {
 	return &ErrorsHandler{}
 }
 
+// Handle errors
 func (hch *ErrorsHandler) Handle(ctx fiber.Ctx, err error) error {
 	sc := fiber.StatusInternalServerError
 	var e *fiber.Error

internal/handlers/health_check/handler.go

@@ -4,13 +4,16 @@ import (
 	"github.com/gofiber/fiber/v3"
 )
 
+// HealthCheckHandler represent handler
 type HealthCheckHandler struct {
 }
 
+// NewHealthCheckHandler creates new handler
 func NewHealthCheckHandler() *HealthCheckHandler {
 	return &HealthCheckHandler{}
 }
 
+// Handle health
 // HealthCheck 		godoc
 // @Summary			Health check service
 // @Description		Health check service

internal/handlers/ping/handler.go

@@ -1,18 +1,21 @@
 package ping_handler
 
 import (
+	"crypto/rand"
 	"errors"
 	"github.com/gofiber/fiber/v3"
-	"math/rand"
 )
 
+// PingCheckHandler represent ping handler
 type PingCheckHandler struct {
 }
 
+// NewPingHandler creates new handler
 func NewPingHandler() *PingCheckHandler {
 	return &PingCheckHandler{}
 }
 
+// Handle ping
 // Ping 			godoc
 // @Summary			Dummy ping
 // @Description		Just random return 200 OK or error
@@ -22,8 +25,12 @@ func NewPingHandler() *PingCheckHandler {
 // @Success			200
 // @Router			/api/v1/ping [get]
 func (hch *PingCheckHandler) Handle(ctx fiber.Ctx) error {
-
-	n := rand.Int()
+	c := 10
+	b := make([]byte, c)
+	n, err := rand.Read(b)
+	if err != nil {
+		return errors.New("error")
+	}
 
 	if n%2 == 0 {
 		return errors.New("ooops")

internal/handlers/ready_check/handler.go

@@ -4,13 +4,16 @@ import (
 	"github.com/gofiber/fiber/v3"
 )
 
+// ReadyCheckHandler represent ready check
 type ReadyCheckHandler struct {
 }
 
+// NewReadyCheckHandler creates new handler
 func NewReadyCheckHandler() *ReadyCheckHandler {
 	return &ReadyCheckHandler{}
 }
 
+// Handle ready
 // HealthCheck 		godoc
 // @Summary			Ready check service
 // @Description		Ready check service

internal/handlers/wire.go

@@ -1,17 +1,17 @@
 package handlers
 
 import (
-	error_handler "github.com/WildEgor/e-shop-fiber-microservice-boilerplate/internal/handlers/errors"
-	health_check_handler "github.com/WildEgor/e-shop-fiber-microservice-boilerplate/internal/handlers/health_check"
-	ping_handler "github.com/WildEgor/e-shop-fiber-microservice-boilerplate/internal/handlers/ping"
-	ready_check_handler "github.com/WildEgor/e-shop-fiber-microservice-boilerplate/internal/handlers/ready_check"
+	eh "github.com/WildEgor/e-shop-fiber-microservice-boilerplate/internal/handlers/errors"
+	hch "github.com/WildEgor/e-shop-fiber-microservice-boilerplate/internal/handlers/health_check"
+	ph "github.com/WildEgor/e-shop-fiber-microservice-boilerplate/internal/handlers/ping"
+	rh "github.com/WildEgor/e-shop-fiber-microservice-boilerplate/internal/handlers/ready_check"
 	"github.com/google/wire"
 )
 
-// HandlersSet contains http/amqp/etc handlers (acts like facades)
-var HandlersSet = wire.NewSet(
-	error_handler.NewErrorsHandler,
-	health_check_handler.NewHealthCheckHandler,
-	ready_check_handler.NewReadyCheckHandler,
-	ping_handler.NewPingHandler,
+// Set contains http/amqp/etc handlers (acts like facades)
+var Set = wire.NewSet(
+	eh.NewErrorsHandler,
+	hch.NewHealthCheckHandler,
+	rh.NewReadyCheckHandler,
+	ph.NewPingHandler,
 )

internal/middlewares/not_found/handler.go

@@ -2,6 +2,7 @@ package not_found_middleware
 
 import "github.com/gofiber/fiber/v3"
 
+// NewNotFound create 404 handler
 func NewNotFound() fiber.Handler {
 	return func(ctx fiber.Ctx) error {
 		return ctx.Render("not_found", fiber.Map{

internal/routers/private_router.go

@@ -4,12 +4,17 @@ import (
 	"github.com/gofiber/fiber/v3"
 )
 
+var _ Router[*fiber.App] = (*PrivateRouter)(nil)
+
+// PrivateRouter router
 type PrivateRouter struct {
 }
 
+// NewPrivateRouter creates router
 func NewPrivateRouter() *PrivateRouter {
 	return &PrivateRouter{}
 }
 
+// Setup router
 func (r *PrivateRouter) Setup(app *fiber.App) {
 }