refactor

Author: moukoublen

README.md

@@ -25,15 +25,14 @@ The boilerplate consists of:
 ## Go package and file structure
 The project structure attempts to be on a par with [golang-standards/project-layout](https://github.com/golang-standards/project-layout).
 
-> Every local package that collides with a golang std package is named with `x` postfix. For example `.../internal/httpx` or `.../internal/logx`. By doing this cheat you can avoid putting aliases when you need both of those and you can take advantage of package autocomplete/autoimport features more easily than having colliding names.
+> Every local package that collides with a golang std package is named with `l` postfix. For example `.../internal/zhttp` or `.../internal/zlog`. By doing this cheat you can avoid putting aliases when you need both of those and you can take advantage of package autocomplete/autoimport features more easily than having colliding names.
 
 | Package            | Description    |
 |--------------------|-----------------------------------------|
-| `cmd/*/main.go`    | main function that is intended to glue together the most core level components like: configuration, http server and router, logs initialization, db connections (if any), the `App` and finally the `Main` struct (`/internal/exec.go`) that handles the long running / signal handling / graceful shutdown of the service. |
-| `internal/exec.go` | the `Main` struct that wraps the long running / signal handling / graceful shutdown of the service |
+| `cmd/*/main.go`    | main function that is intended to glue together the most core level components like: configuration, http server and router, logs initialization, db connections (if any), the `App` and finally the `Daemon` struct (`/internal/exec.go`) that handles the long running / signal handling / graceful shutdown of the service. |
 | `internal/config`  | this package contain the initialization of `koanf` config. |
-| `internal/httpx`   | this package contains: the setup of the `chi` router, some helpers functions for parsing/writing http request and http response. |
-| `internal/logx`   | this package contains the setup/init function for `slog` logger. |
+| `internal/zhttp`   | this package contains: the setup of the `chi` router, some helpers functions for parsing/writing http request and http response. |
+| `internal/zlog`   | this package contains the setup/init function for `slog` logger. |
 
 | Folder/File        | Description    |
 |--------------------|-----------------------------------------|

cmd/goboilerplate/main.go

@@ -4,12 +4,13 @@ import (
 	"context"
 	"fmt"
 	"log/slog"
+	"maps"
 	"os"
 
 	"github.com/ifnotnil/daemon"
 	"github.com/moukoublen/goboilerplate/internal/config"
-	"github.com/moukoublen/goboilerplate/internal/httpx"
-	"github.com/moukoublen/goboilerplate/internal/logx"
+	"github.com/moukoublen/goboilerplate/internal/zhttp"
+	"github.com/moukoublen/goboilerplate/internal/zlog"
 )
 
 func defaultConfigs() map[string]any {
@@ -18,43 +19,41 @@ func defaultConfigs() map[string]any {
 	}
 
 	gather := []map[string]any{
-		httpx.DefaultConfigValues(),
-		logx.DefaultConfigValues(),
+		zhttp.DefaultConfigValues(),
+		zlog.DefaultConfigValues(),
 	}
 
 	for _, g := range gather {
-		for k, v := range g {
-			defaults[k] = v
-		}
+		maps.Copy(defaults, g)
 	}
 
 	return defaults
 }
 
 func main() {
 	// pre-init slog with default config
-	logger := logx.InitSLog(logx.Config{LogType: logx.LogTypeText, Level: slog.LevelInfo})
+	logger := zlog.InitSLog(zlog.Config{LogType: zlog.LogTypeText, Level: slog.LevelInfo})
 	logger.Info("starting up...")
 
 	cnf, err := config.Load(context.Background(), "APP_", defaultConfigs())
 	if err != nil {
-		logger.Error("error during config init", logx.Error(err))
+		logger.Error("error during config init", zlog.Error(err))
 		os.Exit(1)
 	}
 
-	logger = logx.InitSLog(logx.ParseConfig(cnf))
+	logger = zlog.InitSLog(zlog.ParseConfig(cnf))
 
 	dmn := daemon.Start(
 		context.Background(),
 		daemon.WithLogger(logger),
 		daemon.WithShutdownGraceDuration(cnf.Duration("shutdown_timeout")),
 	)
 
-	httpConf := httpx.ParseConfig(cnf)
-	router := httpx.NewDefaultRouter(dmn.CTX(), httpConf, logger)
+	httpConf := zhttp.ParseConfig(cnf)
+	router := zhttp.NewDefaultRouter(dmn.CTX(), httpConf, logger)
 
 	// init services / application
-	server := httpx.StartListenAndServe(
+	server := zhttp.StartListenAndServe(
 		fmt.Sprintf("%s:%d", httpConf.IP, httpConf.Port),
 		router,
 		httpConf.ReadHeaderTimeout,
@@ -67,7 +66,7 @@ func main() {
 		func(ctx context.Context) {
 			logger.InfoContext(ctx, "shuting down http server")
 			if err := server.Shutdown(ctx); err != nil {
-				logger.Warn("error during http server shutdown", logx.Error(err))
+				logger.Warn("error during http server shutdown", zlog.Error(err))
 			}
 		},
 	)

internal/config/config.go

@@ -11,23 +11,23 @@ import (
 	"github.com/knadh/koanf/providers/env"
 	"github.com/knadh/koanf/providers/file"
 	"github.com/knadh/koanf/v2"
-	"github.com/moukoublen/goboilerplate/internal/logx"
+	"github.com/moukoublen/goboilerplate/internal/zlog"
 )
 
 func Load(ctx context.Context, envVarPrefix string, defaultConfigs map[string]any) (*koanf.Koanf, error) {
-	logger := logx.GetFromContext(ctx)
+	logger := zlog.GetFromContext(ctx)
 
 	const delim = "."
 	k := koanf.New(delim)
 
 	// Load default values.
 	if err := k.Load(confmap.Provider(defaultConfigs, delim), nil); err != nil {
-		logger.DebugContext(ctx, "error during config loading from defaults", logx.Error(err))
+		logger.DebugContext(ctx, "error during config loading from defaults", zlog.Error(err))
 	}
 
 	// Load YAML config.
 	if err := k.Load(file.Provider("config.yaml"), yaml.Parser()); err != nil {
-		logger.DebugContext(ctx, "error during config loading from yaml file", logx.Error(err))
+		logger.DebugContext(ctx, "error during config loading from yaml file", zlog.Error(err))
 		if !errors.Is(err, fs.ErrNotExist) {
 			return k, err
 		}
@@ -39,12 +39,12 @@ func Load(ctx context.Context, envVarPrefix string, defaultConfigs map[string]an
 		"log":  map[string]any{},
 	}
 	if err := k.Load(env.Provider(envVarPrefix, delim, buildEnvVarsNamesMapper(envVarsLevels, envVarPrefix)), nil); err != nil {
-		logger.WarnContext(ctx, "error during config loading from env vars", logx.Error(err))
+		logger.WarnContext(ctx, "error during config loading from env vars", zlog.Error(err))
 	}
 
 	// Load .env file
 	if err := k.Load(file.Provider(".env"), dotenv.ParserEnv(envVarPrefix, delim, buildEnvVarsNamesMapper(envVarsLevels, envVarPrefix))); err != nil {
-		logger.WarnContext(ctx, "error during config loading from dot env file", logx.Error(err))
+		logger.WarnContext(ctx, "error during config loading from dot env file", zlog.Error(err))
 		if !errors.Is(err, fs.ErrNotExist) {
 			return k, err
 		}

internal/httpx/handlers.go renamed to internal/zhttp/handlers.go

@@ -1,4 +1,4 @@
-package httpx
+package zhttp
 
 import (
 	"net/http"

internal/httpx/inbound.go renamed to internal/zhttp/inbound.go

@@ -1,11 +1,11 @@
-package httpx
+package zhttp
 
 import (
 	"context"
 	"encoding/json"
 	"net/http"
 
-	"github.com/moukoublen/goboilerplate/internal/logx"
+	"github.com/moukoublen/goboilerplate/internal/zlog"
 )
 
 // RespondJSON renders a json response using a json encoder directly over the ResponseWriter.
@@ -17,8 +17,8 @@ func RespondJSON(ctx context.Context, w http.ResponseWriter, statusCode int, bod
 
 	if body != nil {
 		if err := json.NewEncoder(w).Encode(body); err != nil {
-			logger := logx.GetFromContext(ctx)
-			logger.ErrorContext(ctx, "error during response encoding", logx.Error(err))
+			logger := zlog.GetFromContext(ctx)
+			logger.ErrorContext(ctx, "error during response encoding", zlog.Error(err))
 		}
 	}
 }

internal/httpx/mock_http_client_test.go renamed to internal/zhttp/mock_http_client_test.go

@@ -1,4 +1,4 @@
-package httpx
+package zhttp
 
 import (
 	"fmt"

internal/httpx/outbound.go renamed to internal/zhttp/outbound.go

@@ -1,4 +1,4 @@
-package httpx
+package zhttp
 
 import (
 	"context"
@@ -12,7 +12,7 @@ import (
 	"github.com/go-chi/chi/v5/middleware"
 	xhttp "github.com/ifnotnil/x/http"
 	"github.com/knadh/koanf/v2"
-	"github.com/moukoublen/goboilerplate/internal/logx"
+	"github.com/moukoublen/goboilerplate/internal/zlog"
 )
 
 func DefaultConfigValues() map[string]any {
@@ -70,7 +70,7 @@ func NewDefaultRouter(ctx context.Context, c Config, logger *slog.Logger) *chi.M
 }
 
 func LogRoutes(ctx context.Context, r *chi.Mux) {
-	logger := logx.GetFromContext(ctx)
+	logger := zlog.GetFromContext(ctx)
 	if !logger.Enabled(ctx, slog.LevelDebug) {
 		return
 	}
@@ -85,7 +85,7 @@ func LogRoutes(ctx context.Context, r *chi.Mux) {
 	}
 
 	if err := chi.Walk(r, walkFunc); err != nil {
-		logger.ErrorContext(ctx, "error during chi walk", logx.Error(err))
+		logger.ErrorContext(ctx, "error during chi walk", zlog.Error(err))
 	} else {
 		logger.DebugContext(ctx, "http routes", slog.Any("routes", routes))
 	}

internal/httpx/router.go renamed to internal/zhttp/router.go

@@ -1,4 +1,4 @@
-package httpx
+package zhttp
 
 import (
 	"encoding/json"

internal/httpx/router_test.go renamed to internal/zhttp/router_test.go

@@ -1,4 +1,4 @@
-package logx
+package zlog
 
 import (
 	"context"