Merge pull request #13 from create-go-app/dev

Update ENV; Add conn URL builder

Author: Vic Shóstak

.env.example

@@ -1,18 +1,19 @@
 # Server settings:
-SERVER_URL="0.0.0.0:5000"
-SERVER_EMAIL="no-reply@example.com"
-SERVER_EMAIL_PASSWORD="secret"
+SERVER_HOST="0.0.0.0"
+SERVER_PORT=5000
+SERVER_READ_TIMEOUT=60
 
 # JWT settings:
 JWT_SECRET_KEY="secret"
 JWT_REFRESH_KEY="refresh"
 
 # Database settings:
-DB_SERVER_URL="host=localhost port=5432 user=postgres password=password dbname=postgres sslmode=disable"
+DB_HOST="localhost"
+DB_PORT=5432
+DB_USER="postgres"
+DB_PASSWORD="password"
+DB_NAME="postgres"
+DB_SSL_MODE="disable"
 DB_MAX_CONNECTIONS=100
 DB_MAX_IDLE_CONNECTIONS=10
-DB_MAX_LIFETIME_CONNECTIONS=2
-
-# SMTP severs settings:
-SMTP_SERVER="smtp.example.com"
-SMTP_PORT=25
+DB_MAX_LIFETIME_CONNECTIONS=2

pkg/configs/server_config.go

@@ -3,17 +3,23 @@ package configs
 import (
 	"net/http"
 	"os"
+	"strconv"
 	"time"
 
+	"github.com/create-go-app/net_http-go-template/pkg/utils"
 	"github.com/gorilla/mux"
 )
 
 // ServerConfig func for configuration net/http app.
 func ServerConfig(router *mux.Router) *http.Server {
+	// Define server settings:
+	serverConnURL, _ := utils.ConnectionURLBuilder("server")
+	readTimeoutSecondsCount, _ := strconv.Atoi(os.Getenv("SERVER_READ_TIMEOUT"))
+
+	// Return server configuration.
 	return &http.Server{
-		Handler:      router,
-		Addr:         os.Getenv("SERVER_URL"),
-		WriteTimeout: 60 * time.Second,
-		ReadTimeout:  60 * time.Second,
+		Handler:     router,
+		Addr:        serverConnURL,
+		ReadTimeout: time.Second * time.Duration(readTimeoutSecondsCount),
 	}
 }

pkg/routes/swagger_routes.go

@@ -2,18 +2,21 @@ package routes
 
 import (
 	"net/http"
-	"os"
 
+	"github.com/create-go-app/net_http-go-template/pkg/utils"
 	"github.com/gorilla/mux"
 
 	httpSwagger "github.com/swaggo/http-swagger"
 )
 
 // SwaggerRoutes func for describe group of Swagger routes.
 func SwaggerRoutes(router *mux.Router) {
+	// Define server settings:
+	serverConnURL, _ := utils.ConnectionURLBuilder("server")
+
 	// Build Swagger route.
 	getSwagger := httpSwagger.Handler(
-		httpSwagger.URL("http://"+os.Getenv("SERVER_URL")+"/swagger/doc.json"),
+		httpSwagger.URL("http://"+serverConnURL+"/swagger/doc.json"),
 		httpSwagger.DeepLinking(true),
 		httpSwagger.DocExpansion("none"),
 		httpSwagger.DomID("#swagger-ui"),

pkg/utils/connection_url_builder.go

@@ -0,0 +1,40 @@
+package utils
+
+import (
+	"fmt"
+	"os"
+)
+
+// ConnectionURLBuilder func for building URL connection.
+func ConnectionURLBuilder(n string) (string, error) {
+	// Define URL to connection.
+	var url string
+
+	// Switch given names.
+	switch n {
+	case "postgres":
+		// URL for PostgreSQL connection.
+		url = fmt.Sprintf(
+			"host=%s port=%s user=%s password=%s dbname=%s sslmode=%s",
+			os.Getenv("DB_HOST"),
+			os.Getenv("DB_PORT"),
+			os.Getenv("DB_USER"),
+			os.Getenv("DB_PASSWORD"),
+			os.Getenv("DB_NAME"),
+			os.Getenv("DB_SSL_MODE"),
+		)
+	case "server":
+		// URL for server connection.
+		url = fmt.Sprintf(
+			"%s:%s",
+			os.Getenv("SERVER_HOST"),
+			os.Getenv("SERVER_PORT"),
+		)
+	default:
+		// Return error message.
+		return "", fmt.Errorf("connection name '%v' is not supported", n)
+	}
+
+	// Return connection URL.
+	return url, nil
+}

pkg/utils/start_server.go

@@ -16,6 +16,7 @@ func StartServerWithGracefulShutdown(server *http.Server) {
 
 	// Run our server in a goroutine so that it doesn't block.
 	go func() {
+		log.Println("Server is starting...")
 		if err := server.ListenAndServe(); err != nil {
 			log.Println(err)
 		}
@@ -43,6 +44,6 @@ func StartServerWithGracefulShutdown(server *http.Server) {
 	// Optionally, you could run srv.Shutdown in a goroutine and block on
 	// <-ctx.Done() if your application should wait for other services
 	// to finalize based on context cancellation.
-	log.Println("shutting down")
+	log.Println("Server is shutting down...")
 	os.Exit(0)
 }

platform/database/postgres.go

@@ -6,6 +6,7 @@ import (
 	"strconv"
 	"time"
 
+	"github.com/create-go-app/net_http-go-template/pkg/utils"
 	"github.com/jmoiron/sqlx"
 
 	_ "github.com/jackc/pgx/v4/stdlib" // load pgx driver for PostgreSQL
@@ -18,21 +19,27 @@ func PostgreSQLConnection() (*sqlx.DB, error) {
 	maxIdleConn, _ := strconv.Atoi(os.Getenv("DB_MAX_IDLE_CONNECTIONS"))
 	maxLifetimeConn, _ := strconv.Atoi(os.Getenv("DB_MAX_LIFETIME_CONNECTIONS"))
 
+	// Build PostgreSQL connection URL.
+	postgresConnURL, err := utils.ConnectionURLBuilder("postgres")
+	if err != nil {
+		return nil, err
+	}
+
 	// Define database connection for PostgreSQL.
-	db, err := sqlx.Connect("pgx", os.Getenv("DB_SERVER_URL"))
+	db, err := sqlx.Connect("pgx", postgresConnURL)
 	if err != nil {
-		return nil, fmt.Errorf("error, not connected to PostgreSQL database, %w", err)
+		return nil, fmt.Errorf("error, not connected to database, %w", err)
 	}
 
-	// Set database connection settings.
+	// Set database connection settings:
 	db.SetMaxOpenConns(maxConn)                           // the default is 0 (unlimited)
 	db.SetMaxIdleConns(maxIdleConn)                       // defaultMaxIdleConns = 2
 	db.SetConnMaxLifetime(time.Duration(maxLifetimeConn)) // 0, connections are reused forever
 
 	// Try to ping database.
 	if err := db.Ping(); err != nil {
 		defer db.Close() // close database connection
-		return nil, fmt.Errorf("error, not sent ping to PostgreSQL database, %w", err)
+		return nil, fmt.Errorf("error, not sent ping to database, %w", err)
 	}
 
 	return db, nil