This is an automated email from the ASF dual-hosted git repository.

klesh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake.git


The following commit(s) were added to refs/heads/main by this push:
     new 817e0651 refactor: implement the interface core.MigrationScript (#3471)
817e0651 is described below

commit 817e0651f863da645c3b6db8d377ba6182034819
Author: mindlesscloud <[email protected]>
AuthorDate: Wed Oct 19 16:16:35 2022 +0800

    refactor: implement the interface core.MigrationScript (#3471)
    
    * refactor: implement the interface core.MigrationScript
    
    * fix: some adjustments according to the reveiw comments
    
    * fix: check error for TransformTable
    
    * fix: rename function parameters
---
 plugins/jira/impl/impl.go                          |   5 +-
 .../migrationscripts/20220407_add_source_table.go  |  20 +--
 .../20220505_rename_source_table.go                |  52 +-------
 .../migrationscripts/20220716_add_init_tables.go   | 144 +++++++--------------
 plugins/jira/models/migrationscripts/register.go   |  12 +-
 5 files changed, 67 insertions(+), 166 deletions(-)

diff --git a/plugins/jira/impl/impl.go b/plugins/jira/impl/impl.go
index d3e7ee39..f54e2d67 100644
--- a/plugins/jira/impl/impl.go
+++ b/plugins/jira/impl/impl.go
@@ -23,7 +23,6 @@ import (
        "net/http"
        "time"
 
-       "github.com/apache/incubator-devlake/migration"
        "github.com/apache/incubator-devlake/plugins/core"
        "github.com/apache/incubator-devlake/plugins/helper"
        "github.com/apache/incubator-devlake/plugins/jira/api"
@@ -38,7 +37,7 @@ var _ core.PluginMeta = (*Jira)(nil)
 var _ core.PluginInit = (*Jira)(nil)
 var _ core.PluginTask = (*Jira)(nil)
 var _ core.PluginApi = (*Jira)(nil)
-var _ core.Migratable = (*Jira)(nil)
+var _ core.PluginMigration = (*Jira)(nil)
 var _ core.PluginBlueprintV100 = (*Jira)(nil)
 var _ core.CloseablePluginTask = (*Jira)(nil)
 
@@ -189,7 +188,7 @@ func (plugin Jira) RootPkgPath() string {
        return "github.com/apache/incubator-devlake/plugins/jira"
 }
 
-func (plugin Jira) MigrationScripts() []migration.Script {
+func (plugin Jira) MigrationScripts() []core.MigrationScript {
        return migrationscripts.All()
 }
 
diff --git a/plugins/jira/models/migrationscripts/20220407_add_source_table.go 
b/plugins/jira/models/migrationscripts/20220407_add_source_table.go
index 36078d84..74528b27 100644
--- a/plugins/jira/models/migrationscripts/20220407_add_source_table.go
+++ b/plugins/jira/models/migrationscripts/20220407_add_source_table.go
@@ -18,28 +18,22 @@ limitations under the License.
 package migrationscripts
 
 import (
-       "context"
        "github.com/apache/incubator-devlake/errors"
+       "github.com/apache/incubator-devlake/helpers/migrationhelper"
+       "github.com/apache/incubator-devlake/plugins/core"
        
"github.com/apache/incubator-devlake/plugins/jira/models/migrationscripts/archived"
-       "gorm.io/gorm"
 )
 
-type InitSchemas struct{}
+type addSourceTable20220407 struct{}
 
-func (*InitSchemas) Up(ctx context.Context, db *gorm.DB) errors.Error {
-       m := db.Migrator()
-       if m.HasTable(&archived.JiraConnection{}) {
-               return nil
-       }
-       return errors.Convert(db.Migrator().AutoMigrate(
-               &archived.JiraSource{},
-       ))
+func (*addSourceTable20220407) Up(basicRes core.BasicRes) errors.Error {
+       return migrationhelper.AutoMigrateTables(basicRes, 
&archived.JiraSource{})
 }
 
-func (*InitSchemas) Version() uint64 {
+func (*addSourceTable20220407) Version() uint64 {
        return 20220407201138
 }
 
-func (*InitSchemas) Name() string {
+func (*addSourceTable20220407) Name() string {
        return "Jira init schemas"
 }
diff --git 
a/plugins/jira/models/migrationscripts/20220505_rename_source_table.go 
b/plugins/jira/models/migrationscripts/20220505_rename_source_table.go
index 56947a15..daff3082 100644
--- a/plugins/jira/models/migrationscripts/20220505_rename_source_table.go
+++ b/plugins/jira/models/migrationscripts/20220505_rename_source_table.go
@@ -18,60 +18,20 @@ limitations under the License.
 package migrationscripts
 
 import (
-       "context"
-
        "github.com/apache/incubator-devlake/errors"
-       "github.com/apache/incubator-devlake/models/migrationscripts/archived"
-       "gorm.io/gorm"
+       "github.com/apache/incubator-devlake/plugins/core"
 )
 
-type JiraConnectionV010 struct {
-       archived.Model
-       Name                       string `gorm:"type:varchar(100);uniqueIndex" 
json:"name" validate:"required"`
-       Endpoint                   string `json:"endpoint" validate:"required"`
-       BasicAuthEncoded           string `json:"basicAuthEncoded" 
validate:"required"`
-       EpicKeyField               string `gorm:"type:varchar(50);" 
json:"epicKeyField"`
-       StoryPointField            string `gorm:"type:varchar(50);" 
json:"storyPointField"`
-       RemotelinkCommitShaPattern string 
`gorm:"type:varchar(255);comment='golang regexp, the first group will be 
recognized as commit sha, ref https://github.com/google/re2/wiki/Syntax'" 
json:"remotelinkCommitShaPattern"`
-       Proxy                      string `json:"proxy"`
-       RateLimit                  int    `comment:"api request rate limt per 
hour" json:"rateLimit"`
-}
-
-func (JiraConnectionV010) TableName() string {
-       return "_tool_jira_connections"
-}
-
-type JiraSource struct {
-       archived.Model
-       Name                       string `gorm:"type:varchar(100);uniqueIndex" 
json:"name" validate:"required"`
-       Endpoint                   string `json:"endpoint" validate:"required"`
-       BasicAuthEncoded           string `json:"basicAuthEncoded" 
validate:"required"`
-       EpicKeyField               string `gorm:"type:varchar(50);" 
json:"epicKeyField"`
-       StoryPointField            string `gorm:"type:varchar(50);" 
json:"storyPointField"`
-       RemotelinkCommitShaPattern string 
`gorm:"type:varchar(255);comment='golang regexp, the first group will be 
recognized as commit sha, ref https://github.com/google/re2/wiki/Syntax'" 
json:"remotelinkCommitShaPattern"`
-       Proxy                      string `json:"proxy"`
-       RateLimit                  int    `comment:"api request rate limt per 
second"`
-}
+type renameSourceTable20220505 struct{}
 
-func (JiraSource) TableName() string {
-       return "_tool_jira_sources"
+func (*renameSourceTable20220505) Up(basicRes core.BasicRes) errors.Error {
+       return basicRes.GetDal().RenameTable("_tool_jira_sources", 
"_tool_jira_connections")
 }
 
-type renameSourceTable struct{}
-
-func (*renameSourceTable) Up(ctx context.Context, db *gorm.DB) errors.Error {
-       err := db.Migrator().RenameTable(JiraSource{}, JiraConnectionV010{})
-       return errors.Convert(err)
-}
-
-func (*renameSourceTable) Version() uint64 {
+func (*renameSourceTable20220505) Version() uint64 {
        return 20220505212344
 }
 
-func (*renameSourceTable) Owner() string {
-       return "Jira"
-}
-
-func (*renameSourceTable) Name() string {
+func (*renameSourceTable20220505) Name() string {
        return "Rename source to connection "
 }
diff --git a/plugins/jira/models/migrationscripts/20220716_add_init_tables.go 
b/plugins/jira/models/migrationscripts/20220716_add_init_tables.go
index 56344d66..87445a22 100644
--- a/plugins/jira/models/migrationscripts/20220716_add_init_tables.go
+++ b/plugins/jira/models/migrationscripts/20220716_add_init_tables.go
@@ -18,30 +18,23 @@ limitations under the License.
 package migrationscripts
 
 import (
-       "context"
        "encoding/base64"
        "strings"
        "time"
 
        "github.com/apache/incubator-devlake/config"
        "github.com/apache/incubator-devlake/errors"
+       "github.com/apache/incubator-devlake/helpers/migrationhelper"
        "github.com/apache/incubator-devlake/plugins/core"
        
"github.com/apache/incubator-devlake/plugins/jira/models/migrationscripts/archived"
-       "gorm.io/gorm"
 )
 
-type JiraConnectionNew struct {
+type jiraConnection20220716After struct {
        archived.RestConnection `mapstructure:",squash"`
        archived.BasicAuth      `mapstructure:",squash"`
 }
 
-func (JiraConnectionNew) TableName() string {
-       return "_tool_jira_connections_new"
-}
-
-const JiraConnectionV011 = "_tool_jira_connections"
-
-type JiraConnectionV011Old struct {
+type jiraConnection20220716Before struct {
        ID                         uint64    `gorm:"primaryKey" json:"id"`
        CreatedAt                  time.Time `json:"createdAt"`
        UpdatedAt                  time.Time `json:"updatedAt"`
@@ -55,15 +48,11 @@ type JiraConnectionV011Old struct {
        RateLimit                  int       `comment:"api request rate limt 
per hour" json:"rateLimit"`
 }
 
-func (JiraConnectionV011Old) TableName() string {
-       return "_tool_jira_connections_old"
-}
-
-type addInitTables struct{}
+type addInitTables20220716 struct{}
 
-func (*addInitTables) Up(ctx context.Context, db *gorm.DB) errors.Error {
-       var err error
-       if err = db.Migrator().DropTable(
+func (script *addInitTables20220716) Up(basicRes core.BasicRes) errors.Error {
+       var err errors.Error
+       if err = basicRes.GetDal().DropTables(
                // history table
                "_raw_jira_api_users",
                "_raw_jira_api_boards",
@@ -90,94 +79,53 @@ func (*addInitTables) Up(ctx context.Context, db *gorm.DB) 
errors.Error {
                &archived.JiraSprintIssue{},
                &archived.JiraWorklog{},
        ); err != nil {
-               return errors.Convert(err)
+               return err
        }
-
-       // In order to avoid postgres reporting "cached plan must not change 
result type",
-       // we have to avoid loading the _tool_jira_connections table before our 
migration. The trick is to rename it before loading.
-       // so need to use JiraConnectionOld, JiraConnectionNew and 
JiraConnection to operate.
-       // step1: create _tool_jira_connections_new table
-       // step2: rename _tool_jira_connections to _tool_jira_connections_old
-       // step3: select data from _tool_jira_connections_old and insert date 
to _tool_jira_connections_new
-       // step4: rename _tool_jira_connections_new to _tool_jira_connections
-
-       // step1
-       if err = db.Migrator().CreateTable(&JiraConnectionNew{}); err != nil {
-               return errors.Convert(err)
-       }
-       //nolint:errcheck
-       defer db.Migrator().DropTable(&JiraConnectionNew{})
-
-       // step2
-       if err = db.Migrator().RenameTable("_tool_jira_connections", 
"_tool_jira_connections_old"); err != nil {
-               return errors.Convert(err)
+       encKey := config.GetConfig().GetString(core.EncodeKeyEnvStr)
+       if encKey == "" {
+               return errors.BadInput.New("jira v0.11 invalid encKey")
        }
-       defer func() {
-               if err != nil {
-                       err = 
db.Migrator().RenameTable("_tool_jira_connections_old", 
"_tool_jira_connections")
-               } else {
-                       err = db.Migrator().DropTable(&JiraConnectionV011Old{})
-               }
-       }()
-
-       // step3
-       var result *gorm.DB
-       var jiraConns []JiraConnectionV011Old
-       result = db.Find(&jiraConns)
-       if result.Error != nil {
-               return errors.Convert(result.Error)
-       }
-
-       for _, v := range jiraConns {
-               conn := &JiraConnectionNew{}
-               conn.ID = v.ID
-               conn.Name = v.Name
-               conn.Endpoint = v.Endpoint
-               conn.Proxy = v.Proxy
-               conn.RateLimitPerHour = v.RateLimit
-
-               c := config.GetConfig()
-               encKey := c.GetString(core.EncodeKeyEnvStr)
-               if encKey == "" {
-                       return errors.BadInput.New("jira v0.11 invalid encKey")
-               }
-               var auth string
-               if auth, err = core.Decrypt(encKey, v.BasicAuthEncoded); err != 
nil {
-                       return errors.Convert(err)
-               }
-               var pk []byte
-               pk, err = base64.StdEncoding.DecodeString(auth)
-               if err != nil {
-                       return errors.Convert(err)
-               }
-               originInfo := strings.Split(string(pk), ":")
-               if len(originInfo) == 2 {
-                       conn.Username = originInfo[0]
-                       conn.Password, err = core.Encrypt(encKey, originInfo[1])
-                       if err != nil {
-                               return errors.Convert(err)
+       err = migrationhelper.TransformTable(
+               basicRes,
+               script,
+               "_tool_jira_connections",
+               func(old *jiraConnection20220716Before) 
(*jiraConnection20220716After, errors.Error) {
+                       conn := &jiraConnection20220716After{}
+                       conn.ID = old.ID
+                       conn.Name = old.Name
+                       conn.Endpoint = old.Endpoint
+                       conn.Proxy = old.Proxy
+                       conn.RateLimitPerHour = old.RateLimit
+
+                       var auth string
+                       if auth, err = core.Decrypt(encKey, 
old.BasicAuthEncoded); err != nil {
+                               return nil, err
                        }
-                       // create
-                       tx := db.Create(&conn)
-                       if tx.Error != nil {
-                               return errors.Default.Wrap(tx.Error, "error 
adding connection to DB")
+                       pk, err1 := base64.StdEncoding.DecodeString(auth)
+                       if err1 != nil {
+                               return nil, errors.Convert(err1)
                        }
-               }
-       }
-
-       // step4
-       err = db.Migrator().RenameTable("_tool_jira_connections_new", 
"_tool_jira_connections")
+                       originInfo := strings.Split(string(pk), ":")
+                       if len(originInfo) == 2 {
+                               conn.Username = originInfo[0]
+                               conn.Password, err = core.Encrypt(encKey, 
originInfo[1])
+                               if err != nil {
+                                       return nil, err
+                               }
+                               return conn, nil
+                       }
+                       return nil, errors.Default.New("invalid 
BasicAuthEncoded")
+               })
        if err != nil {
-               return errors.Convert(err)
+               return err
        }
-
-       return errors.Convert(db.Migrator().AutoMigrate(
+       return migrationhelper.AutoMigrateTables(
+               basicRes,
                &archived.JiraAccount{},
                &archived.JiraBoardIssue{},
                &archived.JiraBoard{},
                &archived.JiraIssueChangelogItems{},
                &archived.JiraIssueChangelogs{},
-               //&archived.JiraConnection{},
                &archived.JiraIssueCommit{},
                &archived.JiraIssueLabel{},
                &archived.JiraIssue{},
@@ -189,13 +137,13 @@ func (*addInitTables) Up(ctx context.Context, db 
*gorm.DB) errors.Error {
                &archived.JiraStatus{},
                &archived.JiraWorklog{},
                &archived.JiraIssueType{},
-       ))
+       )
 }
 
-func (*addInitTables) Version() uint64 {
+func (*addInitTables20220716) Version() uint64 {
        return 20220716201138
 }
 
-func (*addInitTables) Name() string {
+func (*addInitTables20220716) Name() string {
        return "Jira init schemas"
 }
diff --git a/plugins/jira/models/migrationscripts/register.go 
b/plugins/jira/models/migrationscripts/register.go
index 4825b43d..6401fd9f 100644
--- a/plugins/jira/models/migrationscripts/register.go
+++ b/plugins/jira/models/migrationscripts/register.go
@@ -18,14 +18,14 @@ limitations under the License.
 package migrationscripts
 
 import (
-       "github.com/apache/incubator-devlake/migration"
+       "github.com/apache/incubator-devlake/plugins/core"
 )
 
 // All return all the migration scripts
-func All() []migration.Script {
-       return []migration.Script{
-               new(InitSchemas),
-               new(renameSourceTable),
-               new(addInitTables),
+func All() []core.MigrationScript {
+       return []core.MigrationScript{
+               new(addSourceTable20220407),
+               new(renameSourceTable20220505),
+               new(addInitTables20220716),
        }
 }

Reply via email to