migration_sql.go

// Package migration_sql
package migration_sql

import (
	"strings"

	kitModuleCfg "github.com/webnice/kit/v3/module/cfg"
	kitModuleCfgReg "github.com/webnice/kit/v3/module/cfg/reg"
	kitModuleDbSql "github.com/webnice/kit/v3/module/db/sql"
	kitTypes "github.com/webnice/kit/v3/types"
	kitTypesDb "github.com/webnice/kit/v3/types/db"
)

// Структура объекта компоненты.
type impl struct {
	cfg         kitModuleCfg.Interface
	databaseSql *kitTypesDb.DatabaseSqlConfiguration
}

// Регистрация компоненты в приложении.
func init() { kitModuleCfgReg.Registration(newComponent()) }

// Конструктор объекта компоненты.
func newComponent() kitTypes.Component {
	var m8s = &impl{
		cfg:         kitModuleCfg.Get(),
		databaseSql: new(kitTypesDb.DatabaseSqlConfiguration),
	}

	m8s.registrationConfigurationError(m8s.cfg.Gist().ConfigurationRegistration(m8s.databaseSql))

	return m8s
}

// Ссылка на менеджер логирования, для удобного использования внутри компоненты или модуля.
func (m8s *impl) log() kitTypes.Logger { return m8s.cfg.Log() }

// Обработка ошибки регистрации конфигурации.
func (m8s *impl) registrationConfigurationError(err error) {
	if err == nil {
		return
	}
	switch eto := err.(type) {
	case kitModuleCfg.Err:
		m8s.cfg.Gist().ErrorAppend(eto)
	default:
		m8s.cfg.Gist().ErrorAppend(m8s.cfg.Errors().ConfigurationApplicationObject(0, eto))
	}
}

// Preferences Функция возвращает настройки компоненты.
func (m8s *impl) Preferences() kitTypes.ComponentPreferences {
	const (
		cEnvironment   = `(?mi)application/component/environment$`
		cInterrupt     = `(?mi)application/component/interrupt$`
		cConfiguration = `(?mi)application/component/configuration$`
		cLogging       = `(?mi)application/component/logg.*`
		cLoggerConsole = `(?mi)application/component/logger_console$`
		cPidfile       = `(?mi)application/component/pidfile$`
		cBootstrap     = `(?mi)application/component/bootstrap$`
	)
	return kitTypes.ComponentPreferences{
		After:   []string{cConfiguration, cLoggerConsole, cLogging, cPidfile, cInterrupt, cEnvironment},
		Require: []string{cPidfile},
		Before:  []string{cBootstrap},
	}
}

// Initiate Функция инициализации компонента и подготовки компонента к запуску.
func (m8s *impl) Initiate() (err error) {
	var (
		elm interface{}
		ok  bool
		c   *kitTypesDb.DatabaseSqlConfiguration
	)

	if m8s.isSkip() {
		return
	}
	// Загрузка конфигурации базы данных, сохранённой в конфигурации приложения.
	if elm, err = m8s.cfg.ConfigurationByObject(m8s.databaseSql); err != nil {
		return
	}
	// Приведение пустого интерфейса к типу данных.
	if c, ok = elm.(*kitTypesDb.DatabaseSqlConfiguration); ok {
		// Исправление пути к миграции на абсолютный путь, исправление по адресу, поэтому все кто запросят
		// конфигурацию базы данных, получат исправленный вариант.
		m8s.cfg.Gist().AbsolutePathAndUpdate(&c.SqlDB.Migration)
		// Обновление локальной копии конфигурации, так как после работы yaml библиотеки может слетать адрес.
		m8s.databaseSql = c
	}

	return
}

// Do Выполнение компонента приложения.
func (m8s *impl) Do() (levelDone bool, levelExit bool, err error) {
	if m8s.isSkip() {
		return
	}
	if err = kitModuleDbSql.Get().MigrationUp(); err != nil {
		levelDone, levelExit = true, true
	}

	return
}

// Finalize Функция вызывается перед завершением компонента и приложения в целом.
func (m8s *impl) Finalize() (err error) { return }

func (m8s *impl) isSkip() (ret bool) {
	const cmdVersion, cmdConfig = `version`, `config`

	// Для стандартной команды версии приложения миграцию не запускаем.
	switch {
	case m8s.cfg.Command() == cmdVersion:
		ret = true
	case strings.HasPrefix(m8s.cfg.Command(), cmdConfig):
		ret = true
	}

	return
}