From 571de20b4c8b9ea65c56bfcddd02cfcd38642785 Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Fri, 15 Nov 2019 19:09:37 +0800 Subject: [PATCH 1/4] Add retry for migration http/https requests --- custom/conf/app.ini.sample | 6 + .../doc/advanced/config-cheat-sheet.en-us.md | 5 + .../doc/advanced/config-cheat-sheet.zh-cn.md | 5 + modules/migrations/base/downloader.go | 143 +++++++++++++++++- modules/migrations/migrate.go | 6 + modules/setting/migrations.go | 22 +++ modules/setting/setting.go | 1 + 7 files changed, 187 insertions(+), 1 deletion(-) create mode 100644 modules/setting/migrations.go diff --git a/custom/conf/app.ini.sample b/custom/conf/app.ini.sample index 34c3ee9db5466..04eba43a4b6d4 100644 --- a/custom/conf/app.ini.sample +++ b/custom/conf/app.ini.sample @@ -892,3 +892,9 @@ QUEUE_LENGTH = 1000 ; Task queue connection string, available only when `QUEUE_TYPE` is `redis`. ; If there is a password of redis, use `addrs=127.0.0.1:6379 password=123 db=0`. QUEUE_CONN_STR = "addrs=127.0.0.1:6379 db=0" + +[migrations] +; Retry times on migrations for every http/https request. +RETRY_MAX_TIMES = 3 +; Time as seconds to delay before next retry. +RETRY_DELAY = 3 \ No newline at end of file diff --git a/docs/content/doc/advanced/config-cheat-sheet.en-us.md b/docs/content/doc/advanced/config-cheat-sheet.en-us.md index ab353f9d5aa6f..b68e9d26fe169 100644 --- a/docs/content/doc/advanced/config-cheat-sheet.en-us.md +++ b/docs/content/doc/advanced/config-cheat-sheet.en-us.md @@ -585,6 +585,11 @@ Two special environment variables are passed to the render command: - `QUEUE_LENGTH`: **1000**: Task queue length, available only when `QUEUE_TYPE` is `channel`. - `QUEUE_CONN_STR`: **addrs=127.0.0.1:6379 db=0**: Task queue connection string, available only when `QUEUE_TYPE` is `redis`. If there redis needs a password, use `addrs=127.0.0.1:6379 password=123 db=0`. +## Migrations (`migrations`) + +- `RETRY_MAX_TIMES`: **3**: Retry times on migrations for every http/https request. +- `RETRY_DELAY`: **3**: Time as seconds to delay before next retry. + ## Other (`other`) - `SHOW_FOOTER_BRANDING`: **false**: Show Gitea branding in the footer. diff --git a/docs/content/doc/advanced/config-cheat-sheet.zh-cn.md b/docs/content/doc/advanced/config-cheat-sheet.zh-cn.md index b545d9a99d1f3..ba4aa3762293e 100644 --- a/docs/content/doc/advanced/config-cheat-sheet.zh-cn.md +++ b/docs/content/doc/advanced/config-cheat-sheet.zh-cn.md @@ -272,6 +272,11 @@ IS_INPUT_FILE = false - `QUEUE_LENGTH`: **1000**: 任务队列长度，当 `QUEUE_TYPE` 为 `channel` 时有效。 - `QUEUE_CONN_STR`: **addrs=127.0.0.1:6379 db=0**: 任务队列连接字符串，当 `QUEUE_TYPE` 为 `redis` 时有效。如果redis有密码，则可以 `addrs=127.0.0.1:6379 password=123 db=0`。 +## Migrations (`migrations`) + +- `RETRY_MAX_TIMES`: **3**: 在迁移过程中的 http/https 请求重试次数。 +- `RETRY_DELAY`: **3**: 等待下一次重试的时间，单位秒。 + ## Other (`other`) - `SHOW_FOOTER_BRANDING`: 为真则在页面底部显示Gitea的字样。 diff --git a/modules/migrations/base/downloader.go b/modules/migrations/base/downloader.go index 69c2adb9e9503..020df9af9b9c2 100644 --- a/modules/migrations/base/downloader.go +++ b/modules/migrations/base/downloader.go @@ -5,7 +5,11 @@ package base -import "code.gitea.io/gitea/modules/structs" +import ( + "time" + + "code.gitea.io/gitea/modules/structs" +) // Downloader downloads the site repo informations type Downloader interface { @@ -25,3 +29,140 @@ type DownloaderFactory interface { New(opts MigrateOptions) (Downloader, error) GitServiceType() structs.GitServiceType } + +// RetryDownloader retry the downloads +type RetryDownloader struct { + Downloader + RetryTimes int // the total execute times + RetryDelay int // time to delay seconds +} + +// NewRetryDownloader creates a retry downloader +func NewRetryDownloader(downloader Downloader, retryTimes, retryDelay int) *RetryDownloader { + return &RetryDownloader{ + Downloader: downloader, + RetryTimes: retryTimes, + RetryDelay: retryDelay, + } +} + +func (d *RetryDownloader) GetRepoInfo() (*Repository, error) { + var ( + times = d.RetryTimes + repo *Repository + err error + ) + for ; times > 0; times-- { + if repo, err = d.Downloader.GetRepoInfo(); err == nil { + return repo, nil + } + time.Sleep(time.Second * time.Duration(d.RetryDelay)) + } + return nil, err +} + +func (d *RetryDownloader) GetTopics() ([]string, error) { + var ( + times = d.RetryTimes + topics []string + err error + ) + for ; times > 0; times-- { + if topics, err = d.Downloader.GetTopics(); err == nil { + return topics, nil + } + time.Sleep(time.Second * time.Duration(d.RetryDelay)) + } + return nil, err +} + +func (d *RetryDownloader) GetMilestones() ([]*Milestone, error) { + var ( + times = d.RetryTimes + milestones []*Milestone + err error + ) + for ; times > 0; times-- { + if milestones, err = d.Downloader.GetMilestones(); err == nil { + return milestones, nil + } + time.Sleep(time.Second * time.Duration(d.RetryDelay)) + } + return nil, err +} + +func (d *RetryDownloader) GetReleases() ([]*Release, error) { + var ( + times = d.RetryTimes + releases []*Release + err error + ) + for ; times > 0; times-- { + if releases, err = d.Downloader.GetReleases(); err == nil { + return releases, nil + } + time.Sleep(time.Second * time.Duration(d.RetryDelay)) + } + return nil, err +} + +func (d *RetryDownloader) GetLabels() ([]*Label, error) { + var ( + times = d.RetryTimes + labels []*Label + err error + ) + for ; times > 0; times-- { + if labels, err = d.Downloader.GetLabels(); err == nil { + return labels, nil + } + time.Sleep(time.Second * time.Duration(d.RetryDelay)) + } + return nil, err +} + +func (d *RetryDownloader) GetIssues(page, perPage int) ([]*Issue, bool, error) { + var ( + times = d.RetryTimes + issues []*Issue + isEnd bool + err error + ) + for ; times > 0; times-- { + if issues, isEnd, err = d.Downloader.GetIssues(page, perPage); err == nil { + return issues, isEnd, nil + } + time.Sleep(time.Second * time.Duration(d.RetryDelay)) + } + return nil, false, err +} + +func (d *RetryDownloader) GetComments(issueNumber int64) ([]*Comment, error) { + var ( + times = d.RetryTimes + comments []*Comment + err error + ) + for ; times > 0; times-- { + if comments, err = d.Downloader.GetComments(issueNumber); err == nil { + return comments, nil + } + time.Sleep(time.Second * time.Duration(d.RetryDelay)) + } + return nil, err +} + +func (d *RetryDownloader) GetPullRequests(page, perPage int) ([]*PullRequest, error) { + var ( + times = d.RetryTimes + prs []*PullRequest + err error + ) + for ; times > 0; times-- { + if prs, err = d.Downloader.GetPullRequests(page, perPage); err == nil { + return prs, nil + } + time.Sleep(time.Second * time.Duration(d.RetryDelay)) + } + return nil, err +} diff --git a/modules/migrations/migrate.go b/modules/migrations/migrate.go index 7a5071e1258dd..120dc141545fa 100644 --- a/modules/migrations/migrate.go +++ b/modules/migrations/migrate.go @@ -11,6 +11,7 @@ import ( "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/log" "code.gitea.io/gitea/modules/migrations/base" + "code.gitea.io/gitea/modules/setting" "code.gitea.io/gitea/modules/structs" ) @@ -63,6 +64,11 @@ func MigrateRepository(doer *models.User, ownerName string, opts base.MigrateOpt } uploader.gitServiceType = opts.GitServiceType + + if setting.Migrations.RetryMaxTimes > 0 { + downloader = base.NewRetryDownloader(downloader, setting.Migrations.RetryMaxTimes+1, setting.Migrations.RetryDelay) + } + if err := migrateRepository(downloader, uploader, opts); err != nil { if err1 := uploader.Rollback(); err1 != nil { log.Error("rollback failed: %v", err1) diff --git a/modules/setting/migrations.go b/modules/setting/migrations.go new file mode 100644 index 0000000000000..fcd564b184ffc --- /dev/null +++ b/modules/setting/migrations.go @@ -0,0 +1,22 @@ +// Copyright 2019 The Gitea Authors. All rights reserved. +// Use of this source code is governed by a MIT-style +// license that can be found in the LICENSE file. + +package setting + +var ( + // Migrations settings + Migrations = struct { + RetryMaxTimes int + RetryDelay int + }{ + RetryMaxTimes: 2, // after failure, it will try again x times. + RetryDelay: 3, // delay seconds before next retry + } +) + +func newMigrationsService() { + sec := Cfg.Section("migrations") + Migrations.RetryMaxTimes = sec.Key("RETRY_MAX_TIMES").MustInt(Migrations.RetryMaxTimes) + Migrations.RetryDelay = sec.Key("RETRY_DELAY").MustInt(Migrations.RetryDelay) +} diff --git a/modules/setting/setting.go b/modules/setting/setting.go index c0b9b99e3cbbe..6a45797cf2ebd 100644 --- a/modules/setting/setting.go +++ b/modules/setting/setting.go @@ -1062,6 +1062,7 @@ func NewServices() { newRegisterMailService() newNotifyMailService() newWebhookService() + newMigrationsService() newIndexerService() newTaskService() } From f52bf7dfceb34ad9e849a7ba7034f23fa5d3c964 Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Fri, 15 Nov 2019 22:37:55 +0800 Subject: [PATCH 2/4] give the more suitable name for retry configuraion items --- custom/conf/app.ini.sample | 8 ++++---- modules/migrations/migrate.go | 4 ++-- modules/setting/migrations.go | 12 ++++++------ 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/custom/conf/app.ini.sample b/custom/conf/app.ini.sample index 04eba43a4b6d4..599498a4b62c5 100644 --- a/custom/conf/app.ini.sample +++ b/custom/conf/app.ini.sample @@ -894,7 +894,7 @@ QUEUE_LENGTH = 1000 QUEUE_CONN_STR = "addrs=127.0.0.1:6379 db=0" [migrations] -; Retry times on migrations for every http/https request. -RETRY_MAX_TIMES = 3 -; Time as seconds to delay before next retry. -RETRY_DELAY = 3 \ No newline at end of file +; Max attempts per http/https request on migrations. +MAX_ATTEMPTS = 3 +; Backoff time per http/https request retry (seconds) +RETRY_BACKOFF = 3 \ No newline at end of file diff --git a/modules/migrations/migrate.go b/modules/migrations/migrate.go index 120dc141545fa..17f4faca488de 100644 --- a/modules/migrations/migrate.go +++ b/modules/migrations/migrate.go @@ -65,8 +65,8 @@ func MigrateRepository(doer *models.User, ownerName string, opts base.MigrateOpt uploader.gitServiceType = opts.GitServiceType - if setting.Migrations.RetryMaxTimes > 0 { - downloader = base.NewRetryDownloader(downloader, setting.Migrations.RetryMaxTimes+1, setting.Migrations.RetryDelay) + if setting.Migrations.MaxAttempts > 0 { + downloader = base.NewRetryDownloader(downloader, setting.Migrations.MaxAttempts, setting.Migrations.RetryBackoff) } if err := migrateRepository(downloader, uploader, opts); err != nil { diff --git a/modules/setting/migrations.go b/modules/setting/migrations.go index fcd564b184ffc..51d6bbcf11be1 100644 --- a/modules/setting/migrations.go +++ b/modules/setting/migrations.go @@ -7,16 +7,16 @@ package setting var ( // Migrations settings Migrations = struct { - RetryMaxTimes int - RetryDelay int + MaxAttempts int + RetryBackoff int }{ - RetryMaxTimes: 2, // after failure, it will try again x times. - RetryDelay: 3, // delay seconds before next retry + MaxAttempts: 3, + RetryBackoff: 3, } ) func newMigrationsService() { sec := Cfg.Section("migrations") - Migrations.RetryMaxTimes = sec.Key("RETRY_MAX_TIMES").MustInt(Migrations.RetryMaxTimes) - Migrations.RetryDelay = sec.Key("RETRY_DELAY").MustInt(Migrations.RetryDelay) + Migrations.MaxAttempts = sec.Key("MAX_ATTEMPTS").MustInt(Migrations.MaxAttempts) + Migrations.RetryBackoff = sec.Key("RETRY_BACKOFF").MustInt(Migrations.RetryBackoff) } From 8c76204bbaa7877d9dc5e8026b7f5296c49a2964 Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Sat, 16 Nov 2019 00:32:00 +0800 Subject: [PATCH 3/4] fix docs and lint --- docs/content/doc/advanced/config-cheat-sheet.en-us.md | 4 ++-- docs/content/doc/advanced/config-cheat-sheet.zh-cn.md | 4 ++-- modules/migrations/base/downloader.go | 8 ++++++++ 3 files changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/content/doc/advanced/config-cheat-sheet.en-us.md b/docs/content/doc/advanced/config-cheat-sheet.en-us.md index b68e9d26fe169..f56ed34e431e4 100644 --- a/docs/content/doc/advanced/config-cheat-sheet.en-us.md +++ b/docs/content/doc/advanced/config-cheat-sheet.en-us.md @@ -587,8 +587,8 @@ Two special environment variables are passed to the render command: ## Migrations (`migrations`) -- `RETRY_MAX_TIMES`: **3**: Retry times on migrations for every http/https request. -- `RETRY_DELAY`: **3**: Time as seconds to delay before next retry. +- `MAX_ATTEMPTS`: **3**: Max attempts per http/https request on migrations. +- `RETRY_BACKOFF`: **3**: Backoff time per http/https request retry (seconds) ## Other (`other`) diff --git a/docs/content/doc/advanced/config-cheat-sheet.zh-cn.md b/docs/content/doc/advanced/config-cheat-sheet.zh-cn.md index ba4aa3762293e..22e47f810f6df 100644 --- a/docs/content/doc/advanced/config-cheat-sheet.zh-cn.md +++ b/docs/content/doc/advanced/config-cheat-sheet.zh-cn.md @@ -274,8 +274,8 @@ IS_INPUT_FILE = false ## Migrations (`migrations`) -- `RETRY_MAX_TIMES`: **3**: 在迁移过程中的 http/https 请求重试次数。 -- `RETRY_DELAY`: **3**: 等待下一次重试的时间，单位秒。 +- `MAX_ATTEMPTS`: **3**: 在迁移过程中的 http/https 请求重试次数。 +- `RETRY_BACKOFF`: **3**: 等待下一次重试的时间，单位秒。 ## Other (`other`) diff --git a/modules/migrations/base/downloader.go b/modules/migrations/base/downloader.go index 020df9af9b9c2..b853ec30209a1 100644 --- a/modules/migrations/base/downloader.go +++ b/modules/migrations/base/downloader.go @@ -46,6 +46,7 @@ func NewRetryDownloader(downloader Downloader, retryTimes, retryDelay int) *Retr } } +// GetRepoInfo returns a repository information with retry func (d *RetryDownloader) GetRepoInfo() (*Repository, error) { var ( times = d.RetryTimes @@ -61,6 +62,7 @@ func (d *RetryDownloader) GetRepoInfo() (*Repository, error) { return nil, err } +// GetTopics returns a repository's topics with retry func (d *RetryDownloader) GetTopics() ([]string, error) { var ( times = d.RetryTimes @@ -76,6 +78,7 @@ func (d *RetryDownloader) GetTopics() ([]string, error) { return nil, err } +// GetMilestones returns a repository's milestones with retry func (d *RetryDownloader) GetMilestones() ([]*Milestone, error) { var ( times = d.RetryTimes @@ -91,6 +94,7 @@ func (d *RetryDownloader) GetMilestones() ([]*Milestone, error) { return nil, err } +// GetReleases returns a repository's releases with retry func (d *RetryDownloader) GetReleases() ([]*Release, error) { var ( times = d.RetryTimes @@ -106,6 +110,7 @@ func (d *RetryDownloader) GetReleases() ([]*Release, error) { return nil, err } +// GetLabels returns a repository's labels with retry func (d *RetryDownloader) GetLabels() ([]*Label, error) { var ( times = d.RetryTimes @@ -121,6 +126,7 @@ func (d *RetryDownloader) GetLabels() ([]*Label, error) { return nil, err } +// GetIssues returns a repository's issues with retry func (d *RetryDownloader) GetIssues(page, perPage int) ([]*Issue, bool, error) { var ( times = d.RetryTimes @@ -137,6 +143,7 @@ func (d *RetryDownloader) GetIssues(page, perPage int) ([]*Issue, bool, error) { return nil, false, err } +// GetComments returns a repository's comments with retry func (d *RetryDownloader) GetComments(issueNumber int64) ([]*Comment, error) { var ( times = d.RetryTimes @@ -152,6 +159,7 @@ func (d *RetryDownloader) GetComments(issueNumber int64) ([]*Comment, error) { return nil, err } +// GetPullRequests returns a repository's pull requests with retry func (d *RetryDownloader) GetPullRequests(page, perPage int) ([]*PullRequest, error) { var ( times = d.RetryTimes From 8b4c58faff19976339f2fd67908418a910f46e9b Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Sat, 16 Nov 2019 09:39:53 +0800 Subject: [PATCH 4/4] Only use retryDownloader when setting > 1 --- modules/migrations/migrate.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/migrations/migrate.go b/modules/migrations/migrate.go index 17f4faca488de..cfaedf78e3504 100644 --- a/modules/migrations/migrate.go +++ b/modules/migrations/migrate.go @@ -65,7 +65,7 @@ func MigrateRepository(doer *models.User, ownerName string, opts base.MigrateOpt uploader.gitServiceType = opts.GitServiceType - if setting.Migrations.MaxAttempts > 0 { + if setting.Migrations.MaxAttempts > 1 { downloader = base.NewRetryDownloader(downloader, setting.Migrations.MaxAttempts, setting.Migrations.RetryBackoff) }