feat(migrator): added migrator

.github/workflows/ci.yaml

@@ -10,6 +10,7 @@ env:
   REGISTRY: "defany"
   IMAGE_NAME: "user-service"
   CONTAINER_NAME: "user-service"
+  IMAGE_NAME_MIGRATOR: "migrator"
 
 jobs:
   build-test:
@@ -66,6 +67,9 @@ jobs:
           TAG_NAME=$(echo $GITHUB_SHA | head -c7)
           docker buildx create --use
           docker buildx build --no-cache --push --tag $REGISTRY/$IMAGE_NAME:$TAG_NAME .
+          
+          docker buildx create --use -f migrator.Dockerfile
+          docker buildx build --no-cache --push --tag $REGISTRY/$IMAGE_NAME-$IMAGE_NAME_MIGRATOR:$TAG_NAME .
 
   deploy:
     runs-on: ubuntu-latest
@@ -83,7 +87,7 @@ jobs:
             # Set up variables
             TAG_NAME=$(echo $GITHUB_SHA | head -c7)
             
-            # Login into Selectel Registry
+            # Login into docker
             docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }} $REGISTRY
             
             # Stop running container
@@ -92,5 +96,8 @@ jobs:
             # Remove old container
             docker rm $CONTAINER_NAME
             
+            # Run migrations before next container
+            docker run --name $CONTAINER_NAME -t $REGISTRY/$IMAGE_NAME-$IMAGE_NAME_MIGRATOR:$TAG_NAME
+            
             # Run a new container from a new image
             docker run -d -p 50100:50001 --restart=always --name $CONTAINER_NAME -t $REGISTRY/$IMAGE_NAME:$TAG_NAME

Dockerfile

@@ -5,7 +5,7 @@ WORKDIR  /github.com/defany/auth-service/source
 
 RUN go mod download
 RUN go mod tidy -e
-RUN go build -o ./bin/server app/cmd/main.go
+RUN go build -o ./bin/server app/cmd/app/main.go
 
 FROM alpine:latest
 

app/cmd/migrator/migrator.go

@@ -0,0 +1,46 @@
+package main
+
+import (
+	"context"
+	"github.com/defany/auth-service/app/internal/app"
+	"github.com/defany/auth-service/app/pkg/logger/sl"
+	"github.com/defany/auth-service/app/pkg/postgres"
+	"log/slog"
+)
+
+func main() {
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
+
+	a := app.NewApp()
+
+	db := a.DI().Database(ctx)
+
+	log := a.DI().Log(ctx)
+
+	migrator, err := postgres.NewMigrator(db.Pool(), a.DI().Config(ctx).Database.MigrationsDir)
+	if err != nil {
+		log.Error("failed to setup migrator", sl.ErrAttr(err))
+
+		return
+	}
+
+	log.Info("upping the migrations")
+
+	upped, err := migrator.Up(ctx)
+	if err != nil {
+		log.Error("failed to up migrations", sl.ErrAttr(err))
+
+		return
+	}
+
+	if len(upped) == 0 {
+		log.Info("there is no migrations to up")
+
+		return
+	}
+
+	for _, migration := range upped {
+		log.Info("migration upped!", slog.String("name", migration.Source.Path))
+	}
+}

app/internal/app/app.go

@@ -11,12 +11,16 @@ import (
 )
 
 type App struct {
-	di         *di
+	di         *DI
 	grpcServer *grpc.Server
 }
 
-func NewApp() App {
-	return App{}
+func NewApp() *App {
+	a := &App{}
+
+	a.setupDI()
+
+	return a
 }
 
 func (a *App) Run(ctx context.Context) error {
@@ -35,6 +39,10 @@ func (a *App) Run(ctx context.Context) error {
 	return a.runGRPCServer(ctx)
 }
 
+func (a *App) DI() *DI {
+	return a.di
+}
+
 func (a *App) setupDI() {
 	a.di = newDI()
 }

app/internal/app/di.go

@@ -15,7 +15,7 @@ import (
 	"os"
 )
 
-type di struct {
+type DI struct {
 	log *slog.Logger
 
 	cfg *config.Config
@@ -33,14 +33,14 @@ type di struct {
 	}
 
 	txManager postgres.TxManager
-	db        postgres.Querier
+	db        postgres.Postgres
 }
 
-func newDI() *di {
-	return &di{}
+func newDI() *DI {
+	return &DI{}
 }
 
-func (d *di) Log(ctx context.Context) *slog.Logger {
+func (d *DI) Log(ctx context.Context) *slog.Logger {
 	if d.log != nil {
 		return d.log
 	}
@@ -50,7 +50,7 @@ func (d *di) Log(ctx context.Context) *slog.Logger {
 	return d.log
 }
 
-func (d *di) Config(_ context.Context) *config.Config {
+func (d *DI) Config(_ context.Context) *config.Config {
 	if d.cfg != nil {
 		return d.cfg
 	}
@@ -60,7 +60,7 @@ func (d *di) Config(_ context.Context) *config.Config {
 	return d.cfg
 }
 
-func (d *di) Database(ctx context.Context) postgres.Querier {
+func (d *DI) Database(ctx context.Context) postgres.Postgres {
 	if d.db != nil {
 		return d.db
 	}
@@ -90,7 +90,7 @@ func (d *di) Database(ctx context.Context) postgres.Querier {
 	return d.db
 }
 
-func (d *di) TxManager(ctx context.Context) postgres.TxManager {
+func (d *DI) TxManager(ctx context.Context) postgres.TxManager {
 	if d.txManager != nil {
 		return d.txManager
 	}
@@ -100,7 +100,7 @@ func (d *di) TxManager(ctx context.Context) postgres.TxManager {
 	return d.txManager
 }
 
-func (d *di) UserRepo(ctx context.Context) repository.UserRepository {
+func (d *DI) UserRepo(ctx context.Context) repository.UserRepository {
 	if d.repositories.user != nil {
 		return d.repositories.user
 	}
@@ -110,7 +110,7 @@ func (d *di) UserRepo(ctx context.Context) repository.UserRepository {
 	return d.repositories.user
 }
 
-func (d *di) UserService(ctx context.Context) defserv.UserService {
+func (d *DI) UserService(ctx context.Context) defserv.UserService {
 	if d.services.user != nil {
 		return d.services.user
 	}
@@ -120,7 +120,7 @@ func (d *di) UserService(ctx context.Context) defserv.UserService {
 	return d.services.user
 }
 
-func (d *di) UserImpl(ctx context.Context) *user.Implementation {
+func (d *DI) UserImpl(ctx context.Context) *user.Implementation {
 	if d.implementations.user != nil {
 		return d.implementations.user
 	}

app/internal/repository/user/storage.go

@@ -22,11 +22,11 @@ const (
 )
 
 type repository struct {
-	db postgres.Querier
+	db postgres.Postgres
 	qb squirrel.StatementBuilderType
 }
 
-func NewRepository(db postgres.Querier) repo.UserRepository {
+func NewRepository(db postgres.Postgres) repo.UserRepository {
 	return &repository{
 		db: db,
 		qb: squirrel.StatementBuilder.PlaceholderFormat(squirrel.Dollar),

app/pkg/postgres/migrations.go

@@ -0,0 +1,33 @@
+package postgres
+
+import (
+	"context"
+	"github.com/jackc/pgx/v5/pgxpool"
+	"github.com/jackc/pgx/v5/stdlib"
+	"github.com/pressly/goose/v3"
+	"os"
+)
+
+type Migrator struct {
+	provider *goose.Provider
+}
+
+func NewMigrator(db *pgxpool.Pool, migrationsDir string) (*Migrator, error) {
+	provider, err := goose.NewProvider(goose.DialectPostgres, stdlib.OpenDBFromPool(db), os.DirFS(migrationsDir))
+	if err != nil {
+		return nil, err
+	}
+
+	return &Migrator{
+		provider: provider,
+	}, nil
+}
+
+func (u *Migrator) Up(ctx context.Context) ([]*goose.MigrationResult, error) {
+	res, err := u.provider.Up(ctx)
+	if err != nil {
+		return nil, err
+	}
+
+	return res, nil
+}

app/pkg/postgres/postgres.go

@@ -8,13 +8,15 @@ import (
 	"log/slog"
 )
 
-type Querier interface {
+type Postgres interface {
 	Query(ctx context.Context, query string, args ...interface{}) (pgx.Rows, error)
 	QueryRow(ctx context.Context, query string, args ...interface{}) pgx.Row
 	Exec(ctx context.Context, query string, args ...interface{}) (commandTag pgconn.CommandTag, err error)
 
 	BeginTx(ctx context.Context, txOptions pgx.TxOptions) (pgx.Tx, error)
 
+	Pool() *pgxpool.Pool
+
 	Close()
 }
 
@@ -24,7 +26,7 @@ type postgres struct {
 	db *pgxpool.Pool
 }
 
-func NewPostgres(ctx context.Context, log *slog.Logger, cfg *Config) (Querier, error) {
+func NewPostgres(ctx context.Context, log *slog.Logger, cfg *Config) (Postgres, error) {
 	p := &postgres{
 		log: log,
 	}
@@ -70,6 +72,10 @@ func (p *postgres) BeginTx(ctx context.Context, txOptions pgx.TxOptions) (pgx.Tx
 	return p.db.BeginTx(ctx, txOptions)
 }
 
+func (p *postgres) Pool() *pgxpool.Pool {
+	return p.db
+}
+
 func (p *postgres) Close() {
 	p.db.Close()
 }

app/pkg/postgres/tx.go

@@ -17,10 +17,10 @@ type TxManager interface {
 type Handler func(ctx context.Context) error
 
 type txManager struct {
-	db Querier
+	db Postgres
 }
 
-func NewTxManager(db Querier) TxManager {
+func NewTxManager(db Postgres) TxManager {
 	return &txManager{
 		db: db,
 	}

docker-compose.yaml

@@ -28,6 +28,7 @@ services:
       postgres:
         condition: service_healthy
     environment:
+      CONFIG_PATH: ./local.json
       DB_HOST: postgres
 
   server:

go.mod

@@ -8,6 +8,7 @@ require (
 	github.com/ilyakaznacheev/cleanenv v1.5.0
 	github.com/jackc/pgx/v5 v5.5.3
 	github.com/pkg/errors v0.9.1
+	github.com/pressly/goose/v3 v3.18.0
 	google.golang.org/grpc v1.61.0
 	google.golang.org/protobuf v1.32.0
 	gopkg.in/yaml.v3 v3.0.1
@@ -25,10 +26,13 @@ require (
 	github.com/lann/ps v0.0.0-20150810152359-62de8c46ede0 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/mfridman/interpolate v0.0.2 // indirect
 	github.com/rogpeppe/go-internal v1.12.0 // indirect
+	github.com/sethvargo/go-retry v0.2.4 // indirect
+	go.uber.org/multierr v1.11.0 // indirect
 	golang.org/x/crypto v0.17.0 // indirect
-	golang.org/x/net v0.18.0 // indirect
-	golang.org/x/sync v0.5.0 // indirect
+	golang.org/x/net v0.19.0 // indirect
+	golang.org/x/sync v0.6.0 // indirect
 	golang.org/x/sys v0.15.0 // indirect
 	golang.org/x/text v0.14.0 // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20240205150955-31a09d347014 // indirect