♻️ Refacor providers

Move core implementation to the providers

Author: hirsch

app/http/middlewares/global.go

@@ -9,8 +9,8 @@ import (
 	"github.com/thinkerou/favicon"
 )
 
-func GlobalMiddlewares(engine *gin.Engine) {
-	engine.Use(
+func GlobalMiddlewares(server *gin.Engine) {
+	server.Use(
 		cors.Default(),
 		gzip.Gzip(gzip.DefaultCompression),
 		helmet.NoSniff(),

app/providers/database.provider.go

@@ -5,10 +5,13 @@ import (
 	"github.com/hirsch88/go-micro-framework/config"
 	"github.com/jinzhu/gorm"
 	_ "github.com/jinzhu/gorm/dialects/mysql"
+	"github.com/wantedly/gorm-zap"
+	"go.uber.org/zap"
 )
 
 type databaseProvider struct {
 	config *config.DatabaseConfig
+	log *zap.SugaredLogger
 }
 
 func (p *databaseProvider) Connect() *gorm.DB {
@@ -24,6 +27,7 @@ func (p *databaseProvider) Connect() *gorm.DB {
 	}
 
 	db.LogMode(p.config.LogMode)
+	db.SetLogger(gormzap.New(p.log.Desugar()))
 	db.DB().SetMaxIdleConns(p.config.IdleConnections)
 	db.DB().SetMaxOpenConns(p.config.OpenConnections)
 
@@ -43,6 +47,6 @@ type DatabaseProvider interface {
 	Migrate()
 }
 
-func NewDatabaseProvider(config *config.DatabaseConfig) DatabaseProvider {
-	return &databaseProvider{config}
+func NewDatabaseProvider(config *config.DatabaseConfig, log *zap.SugaredLogger) DatabaseProvider {
+	return &databaseProvider{config, log}
 }

core/logger.go renamed to app/providers/logger.provider.go

@@ -1,12 +1,12 @@
-package core
+package providers
 
 import (
 	"github.com/hirsch88/go-micro-framework/config"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
 )
 
-func NewLogger(config *config.AppConfig) *zap.SugaredLogger {
+func NewLoggerProvider(config *config.AppConfig) *zap.SugaredLogger {
 	var log *zap.Logger
 	if config.Env != "production" {
 		logConfig := zap.NewDevelopmentConfig()

app/providers/mail.provider.go

@@ -1,69 +1,49 @@
 package providers
 
 import (
-	"bytes"
 	"github.com/hirsch88/go-micro-framework/app/mail"
 	"github.com/hirsch88/go-micro-framework/config"
-	"github.com/hirsch88/go-micro-framework/core"
 	"go.uber.org/zap"
-	"html/template"
 	"log"
 )
 
 type mailProvider struct {
-	config *config.MailConfig
-	log    *zap.SugaredLogger
+	config   *config.MailConfig
+	log      *zap.SugaredLogger
+	template TemplateProvider
+	smtpMail SMTPMailProvider
 }
 
-func (p *mailProvider) Send(mail mail.Mailable, to string) {
+func (p *mailProvider) Send(mail mail.Mailable, to string) bool {
 	mailTemplate := mail.Build()
-	message, err := p.parseTemplate(mailTemplate)
+	message, err := p.template.Parse(mailTemplate.TemplatePath, mailTemplate.Context)
 	if err != nil {
 		log.Fatal(err)
 	}
-	if ok := p.sendMail(to, mailTemplate.Subject, message); ok {
-		p.log.Infof("Email has been sent to %s", to)
-	} else {
-		p.log.Infof("Failed to send the email to %s", to)
-	}
-}
-
-func (p *mailProvider) parseTemplate(mailTemplate *mail.Template) (string, error) {
-	t, err := template.ParseFiles(mailTemplate.TemplatePath)
-	if err != nil {
-		return "", err
-	}
-	buffer := new(bytes.Buffer)
-	if err = t.Execute(buffer, mailTemplate.Context); err != nil {
-		return "", err
-	}
-	return buffer.String(), nil
-}
-
-func (p *mailProvider) sendMail(to string, subject string, message string) bool {
-	smtpServer := core.SmtpServer{
-		Host: p.config.Host,
-		Port: p.config.Port,
-	}
-
-	mail := core.Mail{
-		From:    p.config.From,
-		To:      to,
-		Subject: subject,
-		Body:    message,
-	}
 
-	if err := core.SendMail(smtpServer, mail, p.config.Password); err != nil {
+	if err := p.smtpMail.Send(
+		SmtpServer{
+			Host: p.config.Host,
+			Port: p.config.Port,
+		},
+		Mail{
+			From:    p.config.From,
+			To:      to,
+			Subject: mailTemplate.Subject,
+			Body:    message,
+		},
+		p.config.Password,
+	); err != nil {
 		return false
 	}
 
 	return true
 }
 
 type MailProvider interface {
-	Send(mail mail.Mailable, to string)
+	Send(mail mail.Mailable, to string) bool
 }
 
-func NewMailProvider(config *config.MailConfig, log *zap.SugaredLogger) MailProvider {
-	return &mailProvider{config, log}
+func NewMailProvider(config *config.MailConfig, log *zap.SugaredLogger, template TemplateProvider, smtpMail SMTPMailProvider) MailProvider {
+	return &mailProvider{config, log, template, smtpMail}
 }

core/server.go renamed to app/providers/server.provider.go

@@ -1,4 +1,4 @@
-package core
+ package providers
 
 import (
 	"context"
@@ -11,12 +11,12 @@ import (
 	"time"
 )
 
-func NewGinEngine(lifecycle fx.Lifecycle, appConfig *config.AppConfig, log *zap.SugaredLogger) *gin.Engine {
+func NewServerProvider(lifecycle fx.Lifecycle, appConfig *config.AppConfig, log *zap.SugaredLogger) *gin.Engine {
 	gin.SetMode(gin.ReleaseMode)
 
-	engine := gin.New()
-	engine.Use(ginzap.Ginzap(log.Desugar(), time.RFC3339, true))
-	engine.Use(ginzap.RecoveryWithZap(log.Desugar(), true))
+	server := gin.New()
+	server.Use(ginzap.Ginzap(log.Desugar(), time.RFC3339, true))
+	server.Use(ginzap.RecoveryWithZap(log.Desugar(), true))
 
 	lifecycle.Append(fx.Hook{
 		OnStart: func(context.Context) error {
@@ -28,9 +28,9 @@ func NewGinEngine(lifecycle fx.Lifecycle, appConfig *config.AppConfig, log *zap.
 				fmt.Println("")
 			}
 
-			return engine.Run(":" + appConfig.Port)
+			return server.Run(":" + appConfig.Port)
 		},
 	})
 
-	return engine
+	return server
 }

core/mail.go renamed to app/providers/smtpMail.provider.go

@@ -1,25 +1,20 @@
-package core
+package providers
 
 import (
 	"crypto/tls"
 	"fmt"
+	"go.uber.org/zap"
 	"net/smtp"
 )
 
-/*
-|--------------------------------------------------------------------------
-| GMail lib
-|--------------------------------------------------------------------------
-|
-| This is solution to send emails with the gmail server.
-| https://hackernoon.com/golang-sendmail-sending-mail-through-net-smtp-package-5cadbe2670e0
-|
-*/
-
 const (
 	MIME = "MIME-version: 1.0;\nContent-Type: text/html; charset=\"UTF-8\";\n\n"
 )
 
+type smtpMailProvider struct {
+	log *zap.SugaredLogger
+}
+
 type Mail struct {
 	From    string
 	To      string
@@ -46,7 +41,7 @@ func (mail *Mail) BuildMessage() string {
 	return message
 }
 
-func SendMail(smtpServer SmtpServer, mail Mail, password string) error {
+func (p *smtpMailProvider) Send(smtpServer SmtpServer, mail Mail, password string) error {
 	messageBody := mail.BuildMessage()
 	auth := smtp.PlainAuth("", mail.From, password, smtpServer.Host)
 
@@ -98,5 +93,12 @@ func SendMail(smtpServer SmtpServer, mail Mail, password string) error {
 
 	client.Quit()
 	return nil
+}
+
+type SMTPMailProvider interface {
+	Send(smtpServer SmtpServer, mail Mail, password string) error
+}
 
+func NewSMTPMailProvider(log *zap.SugaredLogger) SMTPMailProvider {
+	return &smtpMailProvider{log}
 }

app/providers/template.provider.go

@@ -0,0 +1,32 @@
+package providers
+
+import (
+	"bytes"
+	"go.uber.org/zap"
+	"html/template"
+)
+
+type templateProvider struct {
+	log *zap.SugaredLogger
+}
+
+func (p *templateProvider) Parse(templatePath string, context interface{}) (string, error) {
+	p.log.Infof("Parsing template %s", templatePath)
+	t, err := template.ParseFiles(templatePath)
+	if err != nil {
+		return "", err
+	}
+	buffer := new(bytes.Buffer)
+	if err = t.Execute(buffer, context); err != nil {
+		return "", err
+	}
+	return buffer.String(), nil
+}
+
+type TemplateProvider interface {
+	Parse(templatePath string, context interface{}) (string, error)
+}
+
+func NewTemplateProvider(log *zap.SugaredLogger) TemplateProvider {
+	return &templateProvider{log}
+}

app/services/user.service_test.go

@@ -18,7 +18,7 @@ func testSetup(t *testing.T) (UserService, models.User) {
 	var userRepositoryMock = new(mocks.UserRepository)
 
 	userRepositoryMock.On("Create", mock.Anything).Return(user)
-	mailProviderMock.On("Send", mock.Anything, mock.Anything)
+	mailProviderMock.On("Send", mock.Anything, mock.Anything).Return(true)
 
 	var service = NewUserService(userRepositoryMock, mailProviderMock)
 	return service, user

bootstrap/app.go

@@ -7,7 +7,6 @@ import (
 	"github.com/hirsch88/go-micro-framework/app/repositories"
 	"github.com/hirsch88/go-micro-framework/app/services"
 	"github.com/hirsch88/go-micro-framework/config"
-	"github.com/hirsch88/go-micro-framework/core"
 	"github.com/hirsch88/go-micro-framework/routes"
 	"go.uber.org/fx"
 )
@@ -40,13 +39,13 @@ func App() *fx.App {
 		fx.Provide(config.NewDatabaseConfig),
 		fx.Provide(config.NewMailConfig),
 
-		// Core (./core)
-		fx.Provide(core.NewLogger),
-		fx.Provide(core.NewGinEngine),
-
 		// Providers (./app/providers)
+		fx.Provide(providers.NewLoggerProvider),
+		fx.Provide(providers.NewTemplateProvider),
 		fx.Provide(providers.NewDatabaseProvider),
+		fx.Provide(providers.NewSMTPMailProvider),
 		fx.Provide(providers.NewMailProvider),
+		fx.Provide(providers.NewServerProvider),
 
 		// Repositores (./app/repositores)
 		fx.Provide(repositories.NewUserRepository),

config/app.go

@@ -7,7 +7,9 @@ func NewAppConfig() *AppConfig {
 		| Environment Name
 		|--------------------------------------------------------------------------
 		|
-		| TODO
+		| With the help of the environment name we can implement different behaviour for
+		| our environments. For example for local development we like to have another
+		| logger encoding with colors, but in production we have the JSON encoding.
 		|
 		*/