Merge pull request #30 from evrone/develop

Readme update

integration-test/Dockerfile

@@ -4,8 +4,8 @@ COPY go.mod go.sum /modules/
 WORKDIR /modules
 RUN go mod download
 
-# Step 2: Builder
-FROM golang:1.16.2-alpine3.13 as builder
+# Step 2: Tests
+FROM golang:1.16.2-alpine3.13
 COPY --from=modules /go/pkg /go/pkg
 COPY . /app
 WORKDIR /app

internal/app/app.go

@@ -43,7 +43,7 @@ func Run(cfg *config.Config) {
 		logger.Fatal(err, "app - Run - rmqServer - server.NewServer")
 	}
 
-	// HTTP
+	// HTTP Server
 	handler := gin.New()
 	v1.NewRouter(handler, translationService)
 	httpServer := httpserver.NewServer(handler, httpserver.Port(cfg.HTTP.Port))

internal/delivery/amqp_rpc/router.go

@@ -5,18 +5,11 @@ import (
 	"github.com/evrone/go-service-template/pkg/rabbitmq/rmq_rpc/server"
 )
 
-type router struct {
-	translationService service.Translation
-	routerMap          map[string]server.CallHandler
-}
-
 func NewRouter(translationService service.Translation) map[string]server.CallHandler {
-	r := &router{
-		translationService: translationService,
-		routerMap:          make(map[string]server.CallHandler),
+	routes := make(map[string]server.CallHandler)
+	{
+		newTranslationRoutes(routes, translationService)
 	}
 
-	r.translationRoutes()
-
-	return r.routerMap
+	return routes
 }

internal/delivery/amqp_rpc/translation.go

@@ -5,22 +5,30 @@ import (
 	"github.com/streadway/amqp"
 
 	"github.com/evrone/go-service-template/internal/domain"
+	"github.com/evrone/go-service-template/internal/service"
 	"github.com/evrone/go-service-template/pkg/rabbitmq/rmq_rpc/server"
 )
 
-func (r *router) translationRoutes() {
-	r.routerMap["getHistory"] = r.getHistory()
+type translationRoutes struct {
+	translationService service.Translation
+}
+
+func newTranslationRoutes(routes map[string]server.CallHandler, ts service.Translation) {
+	r := &translationRoutes{ts}
+	{
+		routes["getHistory"] = r.getHistory()
+	}
 }
 
 type historyResponse struct {
 	History []domain.Translation `json:"history"`
 }
 
-func (r *router) getHistory() server.CallHandler {
+func (r *translationRoutes) getHistory() server.CallHandler {
 	return func(d *amqp.Delivery) (interface{}, error) {
 		translations, err := r.translationService.History()
 		if err != nil {
-			return nil, errors.Wrap(err, "amqp_rpc - router - getHistory - r.translationService.History")
+			return nil, errors.Wrap(err, "amqp_rpc - translationRoutes - getHistory - r.translationService.History")
 		}
 
 		response := historyResponse{translations}

internal/delivery/http/v1/router.go

@@ -20,13 +20,8 @@ import (
 // @host        localhost:8080
 // @BasePath    /api/v1
 
-type router struct {
-	translationService service.Translation
-}
-
 func NewRouter(handler *gin.Engine, translationService service.Translation) {
-	r := &router{translationService}
-
+	// Options
 	handler.Use(gin.Logger())
 	handler.Use(gin.Recovery())
 
@@ -37,8 +32,9 @@ func NewRouter(handler *gin.Engine, translationService service.Translation) {
 	// K8s probe
 	handler.GET("/healthz", func(c *gin.Context) { c.Status(http.StatusOK) })
 
-	api := handler.Group("/api/v1")
+	// Routers
+	h := handler.Group("/api/v1")
 	{
-		r.translationRouts(api)
+		newTranslationRoutes(h, translationService)
 	}
 }

internal/delivery/http/v1/translation.go

@@ -6,13 +6,20 @@ import (
 	"github.com/gin-gonic/gin"
 
 	"github.com/evrone/go-service-template/internal/domain"
+	"github.com/evrone/go-service-template/internal/service"
 )
 
-func (r *router) translationRouts(api *gin.RouterGroup) {
-	translation := api.Group("/translation")
+type translationRoutes struct {
+	translationService service.Translation
+}
+
+func newTranslationRoutes(handler *gin.RouterGroup, ts service.Translation) {
+	r := &translationRoutes{ts}
+
+	h := handler.Group("/translation")
 	{
-		translation.GET("/history", r.history)
-		translation.POST("/do-translate", r.doTranslate)
+		h.GET("/history", r.history)
+		h.POST("/do-translate", r.doTranslate)
 	}
 }
 
@@ -29,7 +36,7 @@ type historyResponse struct {
 // @Success     200 {object} historyResponse
 // @Failure     400 {object} response
 // @Router      /translation/history [get].
-func (r *router) history(c *gin.Context) {
+func (r *translationRoutes) history(c *gin.Context) {
 	translations, err := r.translationService.History()
 	if err != nil {
 		errorResponse(c, http.StatusBadRequest, err, "database problems")
@@ -56,7 +63,7 @@ type doTranslateRequest struct {
 // @Success     200 {object} domain.Translation
 // @Failure     400 {object} response
 // @Router      /translation/do-translate [post].
-func (r *router) doTranslate(c *gin.Context) {
+func (r *translationRoutes) doTranslate(c *gin.Context) {
 	var request doTranslateRequest
 	if err := c.ShouldBindJSON(&request); err != nil {
 		errorResponse(c, http.StatusBadRequest, err, "invalid request body")

internal/service/repo/translation_postgres.go

@@ -2,7 +2,8 @@ package repo
 
 import (
 	"context"
-	"fmt"
+
+	"github.com/pkg/errors"
 
 	"github.com/evrone/go-service-template/internal/domain"
 	"github.com/evrone/go-service-template/pkg/postgres"
@@ -22,12 +23,12 @@ func (r *TranslationRepo) GetHistory(ctx context.Context) ([]domain.Translation,
 		From("history").
 		ToSql()
 	if err != nil {
-		return nil, fmt.Errorf("TranslationRepo - GetHistory - r.Builder: %w", err)
+		return nil, errors.Wrap(err, "TranslationRepo - GetHistory - r.Builder")
 	}
 
 	rows, err := r.Pool.Query(ctx, sql)
 	if err != nil {
-		return nil, fmt.Errorf("TranslationRepo - GetHistory - r.Pool.Query: %w", err)
+		return nil, errors.Wrap(err, "TranslationRepo - GetHistory - r.Pool.Query")
 	}
 	defer rows.Close()
 
@@ -38,7 +39,7 @@ func (r *TranslationRepo) GetHistory(ctx context.Context) ([]domain.Translation,
 
 		err = rows.Scan(&e.Source, &e.Destination, &e.Original, &e.Translation)
 		if err != nil {
-			return nil, fmt.Errorf("TranslationRepo - GetHistory - rows.Scan: %w", err)
+			return nil, errors.Wrap(err, "TranslationRepo - GetHistory - rows.Scan")
 		}
 
 		entities = append(entities, e)
@@ -54,12 +55,12 @@ func (r *TranslationRepo) Store(ctx context.Context, entity domain.Translation)
 		Values(entity.Source, entity.Destination, entity.Original, entity.Translation).
 		ToSql()
 	if err != nil {
-		return fmt.Errorf("TranslationRepo - Store - r.Builder: %w", err)
+		return errors.Wrap(err, "TranslationRepo - Store - r.Builder")
 	}
 
 	_, err = r.Pool.Exec(ctx, sql, args...)
 	if err != nil {
-		return fmt.Errorf("TranslationRepo - Store - r.Pool.Exec: %w", err)
+		return errors.Wrap(err, "TranslationRepo - Store - r.Pool.Exec")
 	}
 
 	return nil

internal/service/translation.go

@@ -2,7 +2,8 @@ package service
 
 import (
 	"context"
-	"fmt"
+
+	"github.com/pkg/errors"
 
 	"github.com/evrone/go-service-template/internal/domain"
 )
@@ -22,7 +23,7 @@ func NewTranslationService(r TranslationRepo, w TranslationWebAPI) *TranslationS
 func (s *TranslationService) History() ([]domain.Translation, error) {
 	translations, err := s.repo.GetHistory(context.Background())
 	if err != nil {
-		return nil, fmt.Errorf("TranslationService - History - s.repo.GetHistory: %w", err)
+		return nil, errors.Wrap(err, "TranslationService - History - s.repo.GetHistory")
 	}
 
 	return translations, nil
@@ -31,12 +32,12 @@ func (s *TranslationService) History() ([]domain.Translation, error) {
 func (s *TranslationService) Translate(translation domain.Translation) (domain.Translation, error) {
 	translation, err := s.webAPI.Translate(translation)
 	if err != nil {
-		return domain.Translation{}, fmt.Errorf("TranslationService - Translate - s.webAPI.Translate: %w", err)
+		return domain.Translation{}, errors.Wrap(err, "TranslationService - Translate - s.webAPI.Translate")
 	}
 
 	err = s.repo.Store(context.Background(), translation)
 	if err != nil {
-		return domain.Translation{}, fmt.Errorf("TranslationService - Translate - s.repo.Store: %w", err)
+		return domain.Translation{}, errors.Wrap(err, "TranslationService - Translate - s.repo.Store")
 	}
 
 	return translation, nil

internal/service/webapi/translation_google.go

@@ -1,9 +1,8 @@
 package webapi
 
 import (
-	"fmt"
-
 	translator "github.com/Conight/go-googletrans"
+	"github.com/pkg/errors"
 
 	"github.com/evrone/go-service-template/internal/domain"
 )
@@ -26,7 +25,7 @@ func (t *TranslationWebAPI) Translate(translation domain.Translation) (domain.Tr
 
 	result, err := trans.Translate(translation.Original, translation.Source, translation.Destination)
 	if err != nil {
-		return domain.Translation{}, fmt.Errorf("TranslationWebAPI - Translate - trans.Translate: %w", err)
+		return domain.Translation{}, errors.Wrap(err, "TranslationWebAPI - Translate - trans.Translate")
 	}
 
 	translation.Translation = result.Text

pkg/logger/logger.go

@@ -1,12 +1,11 @@
 package logger
 
 import (
-	"fmt"
-
+	"github.com/pkg/errors"
 	"go.uber.org/zap"
 )
 
-var appLogger Logger //nolint:gochecknoglobals // it's necessary
+var appLogger Logger //nolint:gochecknoglobals // it's ok
 
 func NewAppLogger(zapLogger *ZapLogger, appName, appVersion string) {
 	fields := []Field{
@@ -57,14 +56,14 @@ func (l *logger) warn(msg string, fields ...Field) {
 }
 
 func (l *logger) error(err error, msg string, fields ...Field) {
-	err = fmt.Errorf("%s: %w", msg, err)
+	err = errors.Wrap(err, msg)
 
 	fields = append(l.defaultFields, fields...)
 	l.zap.Error(err.Error(), zapFields(fields)...)
 }
 
 func (l *logger) fatal(err error, msg string, fields ...Field) {
-	err = fmt.Errorf("%s: %w", msg, err)
+	err = errors.Wrap(err, msg)
 
 	fields = append(l.defaultFields, fields...)
 	l.zap.Fatal(err.Error(), zapFields(fields)...) // os.Exit()

pkg/rabbitmq/rmq_rpc/client/client.go

@@ -2,7 +2,6 @@ package client
 
 import (
 	"encoding/json"
-	"fmt"
 	"sync"
 	"time"
 
@@ -232,7 +231,7 @@ func (c *Client) Shutdown() error {
 
 	err := c.conn.Connection.Close()
 	if err != nil {
-		return fmt.Errorf("rmq_rpc client - Client - Shutdown - c.Connection.Close: %w", err)
+		return errors.Wrap(err, "rmq_rpc client - Client - Shutdown - c.Connection.Close")
 	}
 
 	return nil

pkg/rabbitmq/rmq_rpc/server/server.go

@@ -2,7 +2,6 @@ package server
 
 import (
 	"encoding/json"
-	"fmt"
 	"time"
 
 	"github.com/pkg/errors"
@@ -148,7 +147,7 @@ func (s *Server) Shutdown() error {
 
 	err := s.conn.Connection.Close()
 	if err != nil {
-		return fmt.Errorf("rmq_rpc server - Server - Shutdown - s.Connection.Close: %w", err)
+		return errors.Wrap(err, "rmq_rpc server - Server - Shutdown - s.Connection.Close")
 	}
 
 	return nil