feat(core): add migrate (#310)

feat(core): add migrate

Author: jaronnie

core/stores/migrate/migrate.go

@@ -0,0 +1,136 @@
+package migrate
+
+import (
+	"context"
+	"io"
+	"os"
+	"strings"
+
+	"github.com/eddieowens/opts"
+	"github.com/golang-migrate/migrate/v4"
+	_ "github.com/golang-migrate/migrate/v4/database/mysql"
+	_ "github.com/golang-migrate/migrate/v4/database/pgx/v5"
+	"github.com/golang-migrate/migrate/v4/source/file"
+	"github.com/pkg/errors"
+	"github.com/zeromicro/go-zero/core/stores/sqlx"
+)
+
+type MigrateOpts struct {
+	PreProcessSqlFunc func(content string) string
+	Source            string
+}
+
+func (opts MigrateOpts) DefaultOptions() MigrateOpts {
+	return MigrateOpts{
+		PreProcessSqlFunc: func(content string) string {
+			return content
+		},
+		Source: "file://desc/sql_migration",
+	}
+}
+
+func WithPreProcessSqlFunc(f func(string) string) opts.Opt[MigrateOpts] {
+	return func(opts *MigrateOpts) {
+		opts.PreProcessSqlFunc = f
+	}
+}
+
+func WithSource(source string) opts.Opt[MigrateOpts] {
+	return func(opts *MigrateOpts) {
+		opts.Source = source
+	}
+}
+
+func Migrate(ctx context.Context, c sqlx.SqlConf, op ...opts.Opt[MigrateOpts]) error {
+	ops := opts.DefaultApply(op...)
+	var databaseUrl string
+	switch c.DriverName {
+	case "mysql":
+		databaseUrl = "mysql://" + c.DataSource
+	case "pgx":
+		databaseUrl = "pgx5://" + strings.TrimPrefix(c.DataSource, "postgres://")
+	}
+	if err := sqlMigrate(ops.Source, databaseUrl, c, ops); err != nil {
+		return err
+	}
+	return nil
+}
+
+type customFileSource struct {
+	*file.File
+	driverName        string
+	preProcessSqlFunc func(content string) string
+}
+
+func (c *customFileSource) ReadUp(version uint) (r io.ReadCloser, identifier string, err error) {
+	rc, id, err := c.File.ReadUp(version)
+	if err != nil {
+		return nil, "", err
+	}
+
+	content, err := io.ReadAll(rc)
+	if err != nil {
+		return nil, "", err
+	}
+
+	if err = rc.Close(); err != nil {
+		return nil, "", err
+	}
+	return io.NopCloser(strings.NewReader(c.preProcessSqlFunc(string(content)))), id, nil
+}
+
+func (c *customFileSource) ReadDown(version uint) (r io.ReadCloser, identifier string, err error) {
+	rc, id, err := c.File.ReadDown(version)
+	if err != nil {
+		return nil, "", err
+	}
+
+	content, err := io.ReadAll(rc)
+	if err != nil {
+		return nil, "", err
+	}
+
+	if err = rc.Close(); err != nil {
+		return nil, "", err
+	}
+
+	modifiedContent := c.preProcessSqlFunc(string(content))
+	return io.NopCloser(strings.NewReader(modifiedContent)), id, nil
+}
+
+func sqlMigrate(sourceUrl, databaseUrl string, c sqlx.SqlConf, ops MigrateOpts) error {
+	fileDriver := &file.File{}
+	fileSource, err := fileDriver.Open(sourceUrl)
+	if err != nil {
+		if errors.Is(err, os.ErrNotExist) {
+			return nil
+		}
+		return err
+	}
+
+	customSource := &customFileSource{
+		File:              fileSource.(*file.File),
+		driverName:        c.DriverName,
+		preProcessSqlFunc: ops.PreProcessSqlFunc,
+	}
+
+	m, err := migrate.NewWithSourceInstance("file", customSource, databaseUrl)
+	if err != nil {
+		return err
+	}
+
+	if err = m.Up(); err != nil {
+		if errors.Is(err, migrate.ErrNoChange) {
+			return nil
+		}
+	}
+
+	sourceErr, databaseErr := m.Close()
+	if sourceErr != nil {
+		return sourceErr
+	}
+	if databaseErr != nil {
+		return databaseErr
+	}
+	return nil
+}

go.mod

@@ -9,6 +9,7 @@ require (
 	github.com/bitly/go-simplejson v0.5.1
 	github.com/eddieowens/opts v0.1.0
 	github.com/fsnotify/fsnotify v1.9.0
+	github.com/golang-migrate/migrate/v4 v4.19.0
 	github.com/gorilla/websocket v1.5.3
 	github.com/huandu/go-sqlbuilder v1.37.0
 	github.com/jackc/pgx/v5 v5.7.6
@@ -23,8 +24,8 @@ require (
 	github.com/spf13/cast v1.10.0
 	github.com/stretchr/testify v1.11.1
 	github.com/zeromicro/go-zero v1.9.0
-	go.opentelemetry.io/otel v1.24.0
-	go.opentelemetry.io/otel/trace v1.24.0
+	go.opentelemetry.io/otel v1.37.0
+	go.opentelemetry.io/otel/trace v1.37.0
 	golang.org/x/time v0.13.0
 	google.golang.org/protobuf v1.36.9
 )
@@ -43,7 +44,7 @@ require (
 	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
 	github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
 	github.com/fatih/color v1.18.0 // indirect
-	github.com/go-logr/logr v1.4.2 // indirect
+	github.com/go-logr/logr v1.4.3 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/go-sql-driver/mysql v1.9.0 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
@@ -54,8 +55,11 @@ require (
 	github.com/grafana/pyroscope-go v1.2.4 // indirect
 	github.com/grafana/pyroscope-go/godeltaprof v0.1.8 // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.20.0 // indirect
+	github.com/hashicorp/errwrap v1.1.0 // indirect
+	github.com/hashicorp/go-multierror v1.1.1 // indirect
 	github.com/huandu/go-clone v1.7.3 // indirect
 	github.com/huandu/xstrings v1.5.0 // indirect
+	github.com/jackc/pgerrcode v0.0.0-20220416144525-469b46aa5efa // indirect
 	github.com/jackc/pgpassfile v1.0.0 // indirect
 	github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
 	github.com/jackc/puddle/v2 v2.2.2 // indirect
@@ -81,14 +85,15 @@ require (
 	go.etcd.io/etcd/api/v3 v3.5.15 // indirect
 	go.etcd.io/etcd/client/pkg/v3 v3.5.15 // indirect
 	go.etcd.io/etcd/client/v3 v3.5.15 // indirect
+	go.opentelemetry.io/auto/sdk v1.1.0 // indirect
 	go.opentelemetry.io/otel/exporters/jaeger v1.17.0 // indirect
-	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.24.0 // indirect
+	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.29.0 // indirect
 	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.24.0 // indirect
 	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.24.0 // indirect
 	go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.24.0 // indirect
 	go.opentelemetry.io/otel/exporters/zipkin v1.24.0 // indirect
-	go.opentelemetry.io/otel/metric v1.24.0 // indirect
-	go.opentelemetry.io/otel/sdk v1.24.0 // indirect
+	go.opentelemetry.io/otel/metric v1.37.0 // indirect
+	go.opentelemetry.io/otel/sdk v1.29.0 // indirect
 	go.opentelemetry.io/proto/otlp v1.3.1 // indirect
 	go.uber.org/atomic v1.10.0 // indirect
 	go.uber.org/automaxprocs v1.6.0 // indirect
@@ -100,9 +105,9 @@ require (
 	golang.org/x/sync v0.14.0 // indirect
 	golang.org/x/sys v0.33.0 // indirect
 	golang.org/x/text v0.25.0 // indirect
-	google.golang.org/genproto/googleapis/api v0.0.0-20240711142825-46eb208f015d // indirect
-	google.golang.org/genproto/googleapis/rpc v0.0.0-20240701130421-f6361c86f094 // indirect
-	google.golang.org/grpc v1.65.0 // indirect
+	google.golang.org/genproto/googleapis/api v0.0.0-20240814211410-ddb44dafa142 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20240903143218-8af14fe29dc1 // indirect
+	google.golang.org/grpc v1.67.0 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )