mirror of
https://github.com/mattermost/focalboard.git
synced 2024-12-24 13:43:12 +02:00
Refactor schema table migration mechanism (#3709)
* Refactor schema table migration mechanism The old schema table migration code was initializing the migration engine before changing the migrations table and was mixing queries on two different database connections (the `s.db` connection and the migrations `db` connection). The changes on this commit take care of changing the migrations table before the morph migration engine is initialized and they use the same connection for all operations, better isolating the schema table migration process. * Update migrate function to take the cluster mutex first thing * Split migration code and orchestration on different functions * Wrap custom errors on data migrations * Rename private migration method * Update server/services/store/sqlstore/migrate.go Co-authored-by: Doug Lauder <wiggin77@warpmail.net>
This commit is contained in:
Miguel de la Cruz
GitHub
parent
270a110dc1
commit
3acd505618
@ -10,8 +10,6 @@ import (
|
||||
|
||||
"text/template"
|
||||
|
||||
"github.com/mattermost/morph/models"
|
||||
|
||||
"github.com/mattermost/mattermost-server/v6/shared/mlog"
|
||||
"github.com/mattermost/mattermost-server/v6/store/sqlstore"
|
||||
|
||||
@ -24,10 +22,7 @@ import (
|
||||
|
||||
_ "github.com/lib/pq" // postgres driver
|
||||
|
||||
sq "github.com/Masterminds/squirrel"
|
||||
|
||||
"github.com/mattermost/focalboard/server/model"
|
||||
"github.com/mattermost/mattermost-plugin-api/cluster"
|
||||
)
|
||||
|
||||
//go:embed migrations
|
||||
@ -74,6 +69,32 @@ func (s *SQLStore) getMigrationConnection() (*sql.DB, error) {
|
||||
}
|
||||
|
||||
func (s *SQLStore) Migrate() error {
|
||||
if s.isPlugin {
|
||||
mutex, mutexErr := s.NewMutexFn("Boards_dbMutex")
|
||||
if mutexErr != nil {
|
||||
return fmt.Errorf("error creating database mutex: %w", mutexErr)
|
||||
}
|
||||
|
||||
s.logger.Debug("Acquiring cluster lock for Focalboard migrations")
|
||||
mutex.Lock()
|
||||
defer func() {
|
||||
s.logger.Debug("Releasing cluster lock for Focalboard migrations")
|
||||
mutex.Unlock()
|
||||
}()
|
||||
}
|
||||
|
||||
if err := s.EnsureSchemaMigrationFormat(); err != nil {
|
||||
return err
|
||||
}
|
||||
defer func() {
|
||||
// the old schema migration table deletion happens after the
|
||||
// migrations have run, to be able to recover its information
|
||||
// in case there would be errors during the process.
|
||||
if err := s.deleteOldSchemaMigrationTable(); err != nil {
|
||||
s.logger.Error("cannot delete the old schema migration table", mlog.Err(err))
|
||||
}
|
||||
}()
|
||||
|
||||
var driver drivers.Driver
|
||||
var err error
|
||||
|
||||
@ -181,26 +202,12 @@ func (s *SQLStore) Migrate() error {
|
||||
engine.Close()
|
||||
}()
|
||||
|
||||
var mutex *cluster.Mutex
|
||||
if s.isPlugin {
|
||||
var mutexErr error
|
||||
mutex, mutexErr = s.NewMutexFn("Boards_dbMutex")
|
||||
if mutexErr != nil {
|
||||
return fmt.Errorf("error creating database mutex: %w", mutexErr)
|
||||
}
|
||||
|
||||
s.logger.Debug("Acquiring cluster lock for Focalboard migrations")
|
||||
mutex.Lock()
|
||||
defer func() {
|
||||
s.logger.Debug("Releasing cluster lock for Focalboard migrations")
|
||||
mutex.Unlock()
|
||||
}()
|
||||
}
|
||||
|
||||
if mErr := s.migrateSchemaVersionTable(src.Migrations()); mErr != nil {
|
||||
return mErr
|
||||
}
|
||||
return s.runMigrationSequence(engine, driver)
|
||||
}
|
||||
|
||||
// runMigrationSequence executes all the migrations in order, both
|
||||
// plain SQL and data migrations.
|
||||
func (s *SQLStore) runMigrationSequence(engine *morph.Morph, driver drivers.Driver) error {
|
||||
if mErr := s.ensureMigrationsAppliedUpToVersion(engine, driver, uniqueIDsMigrationRequiredVersion); mErr != nil {
|
||||
return mErr
|
||||
}
|
||||
@ -214,11 +221,11 @@ func (s *SQLStore) Migrate() error {
|
||||
}
|
||||
|
||||
if mErr := s.RunTeamLessBoardsMigration(); mErr != nil {
|
||||
return mErr
|
||||
return fmt.Errorf("error running teamless boards migration: %w", mErr)
|
||||
}
|
||||
|
||||
if mErr := s.RunDeletedMembershipBoardsMigration(); mErr != nil {
|
||||
return mErr
|
||||
return fmt.Errorf("error running deleted membership boards migration: %w", mErr)
|
||||
}
|
||||
|
||||
if mErr := s.ensureMigrationsAppliedUpToVersion(engine, driver, categoriesUUIDIDMigrationRequiredVersion); mErr != nil {
|
||||
@ -229,10 +236,6 @@ func (s *SQLStore) Migrate() error {
|
||||
return fmt.Errorf("error running categoryID migration: %w", mErr)
|
||||
}
|
||||
|
||||
if mErr := s.deleteOldSchemaMigrationTable(); mErr != nil {
|
||||
return mErr
|
||||
}
|
||||
|
||||
appliedMigrations, err := driver.AppliedMigrations()
|
||||
if err != nil {
|
||||
return err
|
||||
@ -244,218 +247,6 @@ func (s *SQLStore) Migrate() error {
|
||||
return engine.ApplyAll()
|
||||
}
|
||||
|
||||
// migrateSchemaVersionTable converts the schema version table from
|
||||
// the old format used by go-migrate to the new format used by
|
||||
// gomorph.
|
||||
// When running the Focalboard with go-migrate's schema version table
|
||||
// existing in the database, gomorph is unable to make sense of it as it's
|
||||
// not in the format required by gomorph.
|
||||
func (s *SQLStore) migrateSchemaVersionTable(migrations []*models.Migration) error {
|
||||
migrationNeeded, err := s.isSchemaMigrationNeeded()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if !migrationNeeded {
|
||||
return nil
|
||||
}
|
||||
|
||||
s.logger.Info("Migrating schema migration to new format")
|
||||
|
||||
legacySchemaVersion, err := s.getLegacySchemaVersion()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if err := s.createTempSchemaTable(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if err := s.populateTempSchemaTable(migrations, legacySchemaVersion); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if err := s.useNewSchemaTable(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *SQLStore) isSchemaMigrationNeeded() (bool, error) {
|
||||
// Check if `dirty` column exists on schema version table.
|
||||
// This column exists only for the old schema version table.
|
||||
|
||||
// SQLite needs a bit of a special handling
|
||||
if s.dbType == model.SqliteDBType {
|
||||
return s.isSchemaMigrationNeededSQLite()
|
||||
}
|
||||
|
||||
query := s.getQueryBuilder(s.db).
|
||||
Select("count(*)").
|
||||
From("information_schema.COLUMNS").
|
||||
Where(sq.Eq{
|
||||
"TABLE_NAME": s.tablePrefix + "schema_migrations",
|
||||
"COLUMN_NAME": "dirty",
|
||||
})
|
||||
|
||||
row := query.QueryRow()
|
||||
|
||||
var count int
|
||||
if err := row.Scan(&count); err != nil {
|
||||
s.logger.Error("failed to check for columns of schema_migrations table", mlog.Err(err))
|
||||
return false, err
|
||||
}
|
||||
|
||||
return count == 1, nil
|
||||
}
|
||||
|
||||
func (s *SQLStore) isSchemaMigrationNeededSQLite() (bool, error) {
|
||||
// the way to check presence of a column is different
|
||||
// for SQLite. Hence, the separate function
|
||||
|
||||
query := fmt.Sprintf("PRAGMA table_info(\"%sschema_migrations\");", s.tablePrefix)
|
||||
rows, err := s.db.Query(query)
|
||||
if err != nil {
|
||||
s.logger.Error("SQLite - failed to check for columns in schema_migrations table", mlog.Err(err))
|
||||
return false, err
|
||||
}
|
||||
|
||||
defer s.CloseRows(rows)
|
||||
|
||||
data := [][]*string{}
|
||||
for rows.Next() {
|
||||
// PRAGMA returns 6 columns
|
||||
row := make([]*string, 6)
|
||||
|
||||
err := rows.Scan(
|
||||
&row[0],
|
||||
&row[1],
|
||||
&row[2],
|
||||
&row[3],
|
||||
&row[4],
|
||||
&row[5],
|
||||
)
|
||||
if err != nil {
|
||||
s.logger.Error("error scanning rows from SQLite schema_migrations table definition", mlog.Err(err))
|
||||
return false, err
|
||||
}
|
||||
|
||||
data = append(data, row)
|
||||
}
|
||||
|
||||
nameColumnFound := false
|
||||
for _, row := range data {
|
||||
if len(row) >= 2 && *row[1] == "dirty" {
|
||||
nameColumnFound = true
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
return nameColumnFound, nil
|
||||
}
|
||||
|
||||
func (s *SQLStore) getLegacySchemaVersion() (uint32, error) {
|
||||
query := s.getQueryBuilder(s.db).
|
||||
Select("version").
|
||||
From(s.tablePrefix + "schema_migrations")
|
||||
|
||||
row := query.QueryRow()
|
||||
|
||||
var version uint32
|
||||
if err := row.Scan(&version); err != nil {
|
||||
s.logger.Error("error fetching legacy schema version", mlog.Err(err))
|
||||
s.logger.Error("getLegacySchemaVersion err " + err.Error())
|
||||
return version, err
|
||||
}
|
||||
|
||||
return version, nil
|
||||
}
|
||||
|
||||
func (s *SQLStore) createTempSchemaTable() error {
|
||||
// squirrel doesn't support DDL query in query builder
|
||||
// so, we need to use a plain old string
|
||||
query := fmt.Sprintf("CREATE TABLE IF NOT EXISTS %s (Version bigint NOT NULL, Name varchar(64) NOT NULL, PRIMARY KEY (Version))", s.tablePrefix+tempSchemaMigrationTableName)
|
||||
if _, err := s.db.Exec(query); err != nil {
|
||||
s.logger.Error("failed to create temporary schema migration table", mlog.Err(err))
|
||||
s.logger.Error("createTempSchemaTable error " + err.Error())
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *SQLStore) populateTempSchemaTable(migrations []*models.Migration, legacySchemaVersion uint32) error {
|
||||
query := s.getQueryBuilder(s.db).
|
||||
Insert(s.tablePrefix+tempSchemaMigrationTableName).
|
||||
Columns("Version", "Name")
|
||||
|
||||
for _, migration := range migrations {
|
||||
// migrations param contains both up and down variant for
|
||||
// each migration. Skipping for either one (down in this case)
|
||||
// to process a migration only a single time.
|
||||
if migration.Direction == models.Down {
|
||||
continue
|
||||
}
|
||||
|
||||
if migration.Version > legacySchemaVersion {
|
||||
break
|
||||
}
|
||||
|
||||
query = query.Values(migration.Version, migration.Name)
|
||||
}
|
||||
|
||||
if _, err := query.Exec(); err != nil {
|
||||
s.logger.Error("failed to insert migration records into temporary schema table", mlog.Err(err))
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *SQLStore) useNewSchemaTable() error {
|
||||
// first delete the old table, then
|
||||
// rename the new table to old table's name
|
||||
|
||||
// renaming old schema migration table. Will delete later once the migration is
|
||||
// complete, just in case.
|
||||
var query string
|
||||
if s.dbType == model.MysqlDBType {
|
||||
query = fmt.Sprintf("RENAME TABLE `%sschema_migrations` TO `%sschema_migrations_old_temp`", s.tablePrefix, s.tablePrefix)
|
||||
} else {
|
||||
query = fmt.Sprintf("ALTER TABLE %sschema_migrations RENAME TO %sschema_migrations_old_temp", s.tablePrefix, s.tablePrefix)
|
||||
}
|
||||
|
||||
if _, err := s.db.Exec(query); err != nil {
|
||||
s.logger.Error("failed to rename old schema migration table", mlog.Err(err))
|
||||
return err
|
||||
}
|
||||
|
||||
// renaming new temp table to old table's name
|
||||
if s.dbType == model.MysqlDBType {
|
||||
query = fmt.Sprintf("RENAME TABLE `%s%s` TO `%sschema_migrations`", s.tablePrefix, tempSchemaMigrationTableName, s.tablePrefix)
|
||||
} else {
|
||||
query = fmt.Sprintf("ALTER TABLE %s%s RENAME TO %sschema_migrations", s.tablePrefix, tempSchemaMigrationTableName, s.tablePrefix)
|
||||
}
|
||||
|
||||
if _, err := s.db.Exec(query); err != nil {
|
||||
s.logger.Error("failed to rename temp schema table", mlog.Err(err))
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *SQLStore) deleteOldSchemaMigrationTable() error {
|
||||
query := "DROP TABLE IF EXISTS " + s.tablePrefix + "schema_migrations_old_temp"
|
||||
if _, err := s.db.Exec(query); err != nil {
|
||||
s.logger.Error("failed to delete old temp schema migrations table", mlog.Err(err))
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *SQLStore) ensureMigrationsAppliedUpToVersion(engine *morph.Morph, driver drivers.Driver, version int) error {
|
||||
applied, err := driver.AppliedMigrations()
|
||||
if err != nil {
|
||||
|
||||
268
server/services/store/sqlstore/schema_table_migration.go
Normal file
268
server/services/store/sqlstore/schema_table_migration.go
Normal file
@ -0,0 +1,268 @@
|
||||
package sqlstore
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"io"
|
||||
|
||||
sq "github.com/Masterminds/squirrel"
|
||||
"github.com/mattermost/focalboard/server/model"
|
||||
"github.com/mattermost/mattermost-server/v6/shared/mlog"
|
||||
"github.com/mattermost/morph/models"
|
||||
)
|
||||
|
||||
// EnsureSchemaMigrationFormat checks the schema migrations table
|
||||
// format and, if it's not using the new shape, it migrates the old
|
||||
// one's status before initializing the migrations engine.
|
||||
func (s *SQLStore) EnsureSchemaMigrationFormat() error {
|
||||
migrationNeeded, err := s.isSchemaMigrationNeeded()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if !migrationNeeded {
|
||||
return nil
|
||||
}
|
||||
|
||||
s.logger.Info("Migrating schema migration to new format")
|
||||
|
||||
legacySchemaVersion, err := s.getLegacySchemaVersion()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
migrations, err := getEmbeddedMigrations()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
filteredMigrations := filterMigrations(migrations, legacySchemaVersion)
|
||||
|
||||
if err := s.createTempSchemaTable(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
s.logger.Info("Populating the temporal schema table", mlog.Uint32("legacySchemaVersion", legacySchemaVersion), mlog.Int("migrations", len(filteredMigrations)))
|
||||
|
||||
if err := s.populateTempSchemaTable(filteredMigrations); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if err := s.useNewSchemaTable(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// getEmbeddedMigrations returns a list of the embedded migrations
|
||||
// using the morph migration format. The migrations do not have the
|
||||
// contents set, as the goal is to obtain a list of them.
|
||||
func getEmbeddedMigrations() ([]*models.Migration, error) {
|
||||
assetsList, err := Assets.ReadDir("migrations")
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
migrations := []*models.Migration{}
|
||||
for _, f := range assetsList {
|
||||
m, err := models.NewMigration(io.NopCloser(&bytes.Buffer{}), f.Name())
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if m.Direction != models.Up {
|
||||
continue
|
||||
}
|
||||
|
||||
migrations = append(migrations, m)
|
||||
}
|
||||
|
||||
return migrations, nil
|
||||
}
|
||||
|
||||
// filterMigrations takes the whole list of migrations parsed from the
|
||||
// embedded directory and returns a filtered list that only contains
|
||||
// one migration per version and those migrations that have already
|
||||
// run based on the legacySchemaVersion.
|
||||
func filterMigrations(migrations []*models.Migration, legacySchemaVersion uint32) []*models.Migration {
|
||||
filteredMigrations := []*models.Migration{}
|
||||
for _, migration := range migrations {
|
||||
// we only take into account up migrations to avoid duplicates
|
||||
if migration.Direction != models.Up {
|
||||
continue
|
||||
}
|
||||
|
||||
// we're only interested on registering migrations that
|
||||
// already run, so we skip those above the legacy version
|
||||
if migration.Version > legacySchemaVersion {
|
||||
continue
|
||||
}
|
||||
|
||||
filteredMigrations = append(filteredMigrations, migration)
|
||||
}
|
||||
|
||||
return filteredMigrations
|
||||
}
|
||||
|
||||
func (s *SQLStore) isSchemaMigrationNeeded() (bool, error) {
|
||||
// Check if `dirty` column exists on schema version table.
|
||||
// This column exists only for the old schema version table.
|
||||
|
||||
// SQLite needs a bit of a special handling
|
||||
if s.dbType == model.SqliteDBType {
|
||||
return s.isSchemaMigrationNeededSQLite()
|
||||
}
|
||||
|
||||
query := s.getQueryBuilder(s.db).
|
||||
Select("count(*)").
|
||||
From("information_schema.COLUMNS").
|
||||
Where(sq.Eq{
|
||||
"TABLE_NAME": s.tablePrefix + "schema_migrations",
|
||||
"COLUMN_NAME": "dirty",
|
||||
})
|
||||
|
||||
row := query.QueryRow()
|
||||
|
||||
var count int
|
||||
if err := row.Scan(&count); err != nil {
|
||||
s.logger.Error("failed to check for columns of schema_migrations table", mlog.Err(err))
|
||||
return false, err
|
||||
}
|
||||
|
||||
return count == 1, nil
|
||||
}
|
||||
|
||||
func (s *SQLStore) isSchemaMigrationNeededSQLite() (bool, error) {
|
||||
// the way to check presence of a column is different
|
||||
// for SQLite. Hence, the separate function
|
||||
|
||||
query := fmt.Sprintf("PRAGMA table_info(\"%sschema_migrations\");", s.tablePrefix)
|
||||
rows, err := s.db.Query(query)
|
||||
if err != nil {
|
||||
s.logger.Error("SQLite - failed to check for columns in schema_migrations table", mlog.Err(err))
|
||||
return false, err
|
||||
}
|
||||
|
||||
defer s.CloseRows(rows)
|
||||
|
||||
data := [][]*string{}
|
||||
for rows.Next() {
|
||||
// PRAGMA returns 6 columns
|
||||
row := make([]*string, 6)
|
||||
|
||||
err := rows.Scan(
|
||||
&row[0],
|
||||
&row[1],
|
||||
&row[2],
|
||||
&row[3],
|
||||
&row[4],
|
||||
&row[5],
|
||||
)
|
||||
if err != nil {
|
||||
s.logger.Error("error scanning rows from SQLite schema_migrations table definition", mlog.Err(err))
|
||||
return false, err
|
||||
}
|
||||
|
||||
data = append(data, row)
|
||||
}
|
||||
|
||||
nameColumnFound := false
|
||||
for _, row := range data {
|
||||
if len(row) >= 2 && *row[1] == "dirty" {
|
||||
nameColumnFound = true
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
return nameColumnFound, nil
|
||||
}
|
||||
|
||||
func (s *SQLStore) getLegacySchemaVersion() (uint32, error) {
|
||||
query := s.getQueryBuilder(s.db).
|
||||
Select("version").
|
||||
From(s.tablePrefix + "schema_migrations")
|
||||
|
||||
row := query.QueryRow()
|
||||
|
||||
var version uint32
|
||||
if err := row.Scan(&version); err != nil {
|
||||
s.logger.Error("error fetching legacy schema version", mlog.Err(err))
|
||||
return version, err
|
||||
}
|
||||
|
||||
return version, nil
|
||||
}
|
||||
|
||||
func (s *SQLStore) createTempSchemaTable() error {
|
||||
// squirrel doesn't support DDL query in query builder
|
||||
// so, we need to use a plain old string
|
||||
query := fmt.Sprintf("CREATE TABLE IF NOT EXISTS %s (Version bigint NOT NULL, Name varchar(64) NOT NULL, PRIMARY KEY (Version))", s.tablePrefix+tempSchemaMigrationTableName)
|
||||
if _, err := s.db.Exec(query); err != nil {
|
||||
s.logger.Error("failed to create temporary schema migration table", mlog.Err(err))
|
||||
s.logger.Error("createTempSchemaTable error " + err.Error())
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *SQLStore) populateTempSchemaTable(migrations []*models.Migration) error {
|
||||
query := s.getQueryBuilder(s.db).
|
||||
Insert(s.tablePrefix+tempSchemaMigrationTableName).
|
||||
Columns("Version", "Name")
|
||||
|
||||
for _, migration := range migrations {
|
||||
s.logger.Info("-- Registering migration", mlog.Uint32("version", migration.Version), mlog.String("name", migration.Name))
|
||||
query = query.Values(migration.Version, migration.Name)
|
||||
}
|
||||
|
||||
if _, err := query.Exec(); err != nil {
|
||||
s.logger.Error("failed to insert migration records into temporary schema table", mlog.Err(err))
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *SQLStore) useNewSchemaTable() error {
|
||||
// first delete the old table, then
|
||||
// rename the new table to old table's name
|
||||
|
||||
// renaming old schema migration table. Will delete later once the migration is
|
||||
// complete, just in case.
|
||||
var query string
|
||||
if s.dbType == model.MysqlDBType {
|
||||
query = fmt.Sprintf("RENAME TABLE `%sschema_migrations` TO `%sschema_migrations_old_temp`", s.tablePrefix, s.tablePrefix)
|
||||
} else {
|
||||
query = fmt.Sprintf("ALTER TABLE %sschema_migrations RENAME TO %sschema_migrations_old_temp", s.tablePrefix, s.tablePrefix)
|
||||
}
|
||||
|
||||
if _, err := s.db.Exec(query); err != nil {
|
||||
s.logger.Error("failed to rename old schema migration table", mlog.Err(err))
|
||||
return err
|
||||
}
|
||||
|
||||
// renaming new temp table to old table's name
|
||||
if s.dbType == model.MysqlDBType {
|
||||
query = fmt.Sprintf("RENAME TABLE `%s%s` TO `%sschema_migrations`", s.tablePrefix, tempSchemaMigrationTableName, s.tablePrefix)
|
||||
} else {
|
||||
query = fmt.Sprintf("ALTER TABLE %s%s RENAME TO %sschema_migrations", s.tablePrefix, tempSchemaMigrationTableName, s.tablePrefix)
|
||||
}
|
||||
|
||||
if _, err := s.db.Exec(query); err != nil {
|
||||
s.logger.Error("failed to rename temp schema table", mlog.Err(err))
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *SQLStore) deleteOldSchemaMigrationTable() error {
|
||||
query := "DROP TABLE IF EXISTS " + s.tablePrefix + "schema_migrations_old_temp"
|
||||
if _, err := s.db.Exec(query); err != nil {
|
||||
s.logger.Error("failed to delete old temp schema migrations table", mlog.Err(err))
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
100
server/services/store/sqlstore/schema_table_migration_test.go
Normal file
100
server/services/store/sqlstore/schema_table_migration_test.go
Normal file
@ -0,0 +1,100 @@
|
||||
package sqlstore
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/mattermost/morph/models"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestGetEmbeddedMigrations(t *testing.T) {
|
||||
t.Run("should find migrations on the embedded assets", func(t *testing.T) {
|
||||
migrations, err := getEmbeddedMigrations()
|
||||
require.NoError(t, err)
|
||||
require.NotEmpty(t, migrations)
|
||||
})
|
||||
}
|
||||
|
||||
func TestFilterMigrations(t *testing.T) {
|
||||
migrations := []*models.Migration{
|
||||
{Direction: models.Up, Version: 1},
|
||||
{Direction: models.Down, Version: 1},
|
||||
{Direction: models.Up, Version: 2},
|
||||
{Direction: models.Down, Version: 2},
|
||||
{Direction: models.Up, Version: 3},
|
||||
{Direction: models.Down, Version: 3},
|
||||
{Direction: models.Up, Version: 4},
|
||||
{Direction: models.Down, Version: 4},
|
||||
}
|
||||
|
||||
t.Run("only up migrations should be included", func(t *testing.T) {
|
||||
filteredMigrations := filterMigrations(migrations, 4)
|
||||
require.Len(t, filteredMigrations, 4)
|
||||
for _, migration := range filteredMigrations {
|
||||
require.Equal(t, models.Up, migration.Direction)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("only migrations below or equal to the legacy schema version should be included", func(t *testing.T) {
|
||||
testCases := []struct {
|
||||
Name string
|
||||
LegacyVersion uint32
|
||||
ExpectedVersions []uint32
|
||||
}{
|
||||
{"All should be included", 4, []uint32{1, 2, 3, 4}},
|
||||
{"Only half should be included", 2, []uint32{1, 2}},
|
||||
{"Three including the third should be included", 3, []uint32{1, 2, 3}},
|
||||
}
|
||||
|
||||
for _, tc := range testCases {
|
||||
t.Run(tc.Name, func(t *testing.T) {
|
||||
filteredMigrations := filterMigrations(migrations, tc.LegacyVersion)
|
||||
require.Len(t, filteredMigrations, int(tc.LegacyVersion))
|
||||
|
||||
versions := make([]uint32, len(filteredMigrations))
|
||||
for i, migration := range filteredMigrations {
|
||||
versions[i] = migration.Version
|
||||
}
|
||||
|
||||
require.ElementsMatch(t, versions, tc.ExpectedVersions)
|
||||
})
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("migrations should be included even if they're not sorted", func(t *testing.T) {
|
||||
unsortedMigrations := []*models.Migration{
|
||||
{Direction: models.Up, Version: 4},
|
||||
{Direction: models.Down, Version: 4},
|
||||
{Direction: models.Up, Version: 1},
|
||||
{Direction: models.Down, Version: 2},
|
||||
{Direction: models.Down, Version: 1},
|
||||
{Direction: models.Up, Version: 3},
|
||||
{Direction: models.Down, Version: 3},
|
||||
{Direction: models.Up, Version: 2},
|
||||
}
|
||||
|
||||
testCases := []struct {
|
||||
Name string
|
||||
LegacyVersion uint32
|
||||
ExpectedVersions []uint32
|
||||
}{
|
||||
{"All should be included", 4, []uint32{1, 2, 3, 4}},
|
||||
{"Only half should be included", 2, []uint32{1, 2}},
|
||||
{"Three including the third should be included", 3, []uint32{1, 2, 3}},
|
||||
}
|
||||
|
||||
for _, tc := range testCases {
|
||||
t.Run(tc.Name, func(t *testing.T) {
|
||||
filteredMigrations := filterMigrations(unsortedMigrations, tc.LegacyVersion)
|
||||
require.Len(t, filteredMigrations, int(tc.LegacyVersion))
|
||||
|
||||
versions := make([]uint32, len(filteredMigrations))
|
||||
for i, migration := range filteredMigrations {
|
||||
versions[i] = migration.Version
|
||||
}
|
||||
|
||||
require.ElementsMatch(t, versions, tc.ExpectedVersions)
|
||||
})
|
||||
}
|
||||
})
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user