feat(migrate): add database migration functionality (#16)

Author: lmquang

Dockerfile

@@ -1,5 +1,3 @@
-FROM dwarvesf/sql-migrate as sql-migrate
-
 FROM golang:1.23-alpine as builder
 RUN mkdir /build
 WORKDIR /build
@@ -18,10 +16,8 @@ RUN apk --no-cache add ca-certificates
 RUN ln -fs /usr/share/zoneinfo/Asia/Ho_Chi_Minh /etc/localtime
 WORKDIR /
 
-COPY --from=sql-migrate /usr/local/bin/sql-migrate /usr/bin/
 COPY --from=builder /go/bin/* /usr/bin/
+COPY migrations /migrations
 COPY docs /docs
-# COPY migrations /migrations
-# COPY dbconfig.yml /
 
-ENTRYPOINT [ "server" ]
+CMD [ "server" ]

cmd/migrate/main.go

@@ -0,0 +1,60 @@
+package main
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/golang-migrate/migrate/v4"
+	"github.com/golang-migrate/migrate/v4/database/postgres"
+	_ "github.com/golang-migrate/migrate/v4/source/file"
+	"gorm.io/gorm"
+
+	pgstore "github.com/dwarvesf/icy-backend/internal/store/postgres"
+	"github.com/dwarvesf/icy-backend/internal/utils/config"
+	"github.com/dwarvesf/icy-backend/internal/utils/logger"
+)
+
+func runMigrations(db *gorm.DB, logger *logger.Logger) error {
+	// Open database connection
+	sqlDB, err := db.DB()
+	if err != nil {
+		return fmt.Errorf("failed to get database connection: %w", err)
+	}
+
+	// Create migrate instance
+	migrationPath := fmt.Sprintf("file://%s", filepath.Join("migrations", "schema"))
+	driver, err := postgres.WithInstance(sqlDB, &postgres.Config{})
+	if err != nil {
+		return fmt.Errorf("failed to create postgres driver: %w", err)
+	}
+
+	m, err := migrate.NewWithDatabaseInstance(
+		migrationPath,
+		"postgres", driver)
+	if err != nil {
+		return fmt.Errorf("failed to create migrate instance: %w", err)
+	}
+
+	// Run migrations
+	if err := m.Up(); err != nil && err != migrate.ErrNoChange {
+		return fmt.Errorf("migration failed: %w", err)
+	}
+
+	logger.Info("Migrations completed successfully")
+	return nil
+}
+
+func main() {
+	appConfig := config.New()
+	logger := logger.New(appConfig.Environment)
+
+	db := pgstore.New(appConfig, logger)
+
+	if err := runMigrations(db, logger); err != nil {
+		logger.Error("[main][runMigrations] failed to run migrations", map[string]string{
+			"error": err.Error(),
+		})
+		os.Exit(1)
+	}
+}

docs/deploy.md

@@ -18,20 +18,20 @@
 
 ## Deployment Steps
 
-### 1. Initialize Fly.io Configuration
+### 1. Configure Secrets
+Create a `.env.prod` file with your application's environment variables. Then import them:
+```bash
+flyctl secrets import < .env.prod
+```
+
+### 2. Initialize Fly.io Configuration
 ```bash
 flyctl launch --ha=false
 ```
 - This command will detect your Dockerfile and create a `fly.toml` configuration file
 - Choose a name for your application
 - Select the region closest to your primary users
 
-### 2. Configure Secrets
-Create a `.env.prod` file with your application's environment variables. Then import them:
-```bash
-flyctl secrets import < .env.prod
-```
-
 ### 3. Set Required Environment Variables
 Ensure all necessary environment variables are set:
 ```bash
@@ -53,19 +53,6 @@ flyctl status
 flyctl open  # Opens the deployed application in your browser
 ```
 
-### 6. Run Database Migrations
-To run database migrations, use the following command:
-```bash
-export $(grep -v '^#' .env.prod | xargs) \
-&& migrate -path ./migrations/schema \
-           -database "postgres://${DB_USER}:${DB_PASS}@${DB_HOST}:${DB_PORT}/${DB_NAME}?sslmode=${DB_SSL_MODE}" \
-           up
-```
-Notes:
-- Ensure `.env.prod` contains all necessary database connection variables
-- The `migrate` command applies all pending schema migrations
-- Run this command after initial deployment or when new migrations are added
-
 ## Additional Fly.io Commands
 
 - Scale your app: 

fly.toml

@@ -1,4 +1,4 @@
-# fly.toml app configuration file generated for icy-backend-dev on 2025-02-13T10:52:05+07:00
+# fly.toml app configuration file generated for icy-backend on 2025-02-13T19:55:30+07:00
 #
 # See https://fly.io/docs/reference/configuration/ for information about how to use this file.
 #
@@ -8,6 +8,9 @@ primary_region = 'sin'
 
 [build]
 
+[deploy]
+  release_command = 'migrate'
+
 [http_service]
   internal_port = 8080
   force_https = true

go.mod

@@ -8,6 +8,7 @@ require (
 	github.com/gin-contrib/cors v1.7.2
 	github.com/gin-gonic/gin v1.10.0
 	github.com/go-playground/validator/v10 v10.22.1
+	github.com/golang-migrate/migrate/v4 v4.18.2
 	github.com/joho/godotenv v1.5.1
 	github.com/onsi/ginkgo/v2 v2.21.0
 	github.com/onsi/gomega v1.35.1
@@ -37,11 +38,9 @@ require (
 	github.com/PuerkitoBio/purell v1.1.1 // indirect
 	github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578 // indirect
 	github.com/StackExchange/wmi v1.2.1 // indirect
-	github.com/VictoriaMetrics/fastcache v1.12.2 // indirect
 	github.com/bits-and-blooms/bitset v1.20.0 // indirect
 	github.com/bytedance/sonic v1.12.4 // indirect
 	github.com/bytedance/sonic/loader v0.2.1 // indirect
-	github.com/cespare/xxhash/v2 v2.3.0 // indirect
 	github.com/cloudwego/base64x v0.1.4 // indirect
 	github.com/cloudwego/iasm v0.2.0 // indirect
 	github.com/consensys/bavard v0.1.29 // indirect
@@ -54,7 +53,6 @@ require (
 	github.com/ethereum/go-verkle v0.2.2 // indirect
 	github.com/fsnotify/fsnotify v1.6.0 // indirect
 	github.com/gabriel-vasile/mimetype v1.4.6 // indirect
-	github.com/gballet/go-libpcsclite v0.0.0-20190607065134-2772fd86a8ff // indirect
 	github.com/gin-contrib/sse v0.1.0 // indirect
 	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-ole/go-ole v1.3.0 // indirect
@@ -66,51 +64,38 @@ require (
 	github.com/go-playground/universal-translator v0.18.1 // indirect
 	github.com/go-task/slim-sprig/v3 v3.0.0 // indirect
 	github.com/goccy/go-json v0.10.3 // indirect
-	github.com/gofrs/flock v0.8.1 // indirect
-	github.com/golang/snappy v0.0.5-0.20220116011046-fa5810519dcb // indirect
 	github.com/google/go-cmp v0.6.0 // indirect
 	github.com/google/pprof v0.0.0-20241029153458-d1b30febd7db // indirect
-	github.com/google/uuid v1.3.0 // indirect
+	github.com/google/uuid v1.6.0 // indirect
 	github.com/gorilla/websocket v1.5.0 // indirect
-	github.com/holiman/bloomfilter/v2 v2.0.3 // indirect
+	github.com/hashicorp/errwrap v1.1.0 // indirect
+	github.com/hashicorp/go-multierror v1.1.1 // indirect
 	github.com/holiman/uint256 v1.3.2 // indirect
-	github.com/huin/goupnp v1.3.0 // indirect
 	github.com/jackc/pgpassfile v1.0.0 // indirect
 	github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
 	github.com/jackc/pgx/v5 v5.5.5 // indirect
 	github.com/jackc/puddle/v2 v2.2.1 // indirect
-	github.com/jackpal/go-nat-pmp v1.0.2 // indirect
 	github.com/jinzhu/inflection v1.0.0 // indirect
 	github.com/jinzhu/now v1.1.5 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
-	github.com/karalabe/hid v1.0.1-0.20240306101548-573246063e52 // indirect
 	github.com/klauspost/cpuid/v2 v2.2.9 // indirect
 	github.com/leodido/go-urn v1.4.0 // indirect
+	github.com/lib/pq v1.10.9 // indirect
 	github.com/mailru/easyjson v0.7.6 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
-	github.com/mattn/go-runewidth v0.0.13 // indirect
 	github.com/mmcloughlin/addchain v0.4.0 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
-	github.com/olekukonko/tablewriter v0.0.5 // indirect
 	github.com/pelletier/go-toml/v2 v2.2.3 // indirect
-	github.com/peterh/liner v1.1.1-0.20190123174540-a2c9a5303de7 // indirect
-	github.com/pion/dtls/v2 v2.2.7 // indirect
-	github.com/pion/logging v0.2.2 // indirect
-	github.com/pion/stun/v2 v2.0.0 // indirect
-	github.com/pion/transport/v2 v2.2.1 // indirect
-	github.com/pion/transport/v3 v3.0.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
-	github.com/rivo/uniseg v0.2.0 // indirect
 	github.com/shirou/gopsutil v3.21.4-0.20210419000835-c7a38de76ee5+incompatible // indirect
-	github.com/status-im/keycard-go v0.2.0 // indirect
 	github.com/supranational/blst v0.3.13 // indirect
-	github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7 // indirect
 	github.com/tklauser/go-sysconf v0.3.12 // indirect
 	github.com/tklauser/numcpus v0.6.1 // indirect
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
 	github.com/ugorji/go/codec v1.2.12 // indirect
+	go.uber.org/atomic v1.11.0 // indirect
 	go.uber.org/multierr v1.10.0 // indirect
 	golang.org/x/arch v0.12.0 // indirect
 	golang.org/x/crypto v0.33.0 // indirect