Skip to content

Commit 571de20

Browse files
committed
Add retry for migration http/https requests
1 parent 11208f3 commit 571de20

File tree

7 files changed

+187
-1
lines changed

7 files changed

+187
-1
lines changed

custom/conf/app.ini.sample

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -892,3 +892,9 @@ QUEUE_LENGTH = 1000
892892
; Task queue connection string, available only when `QUEUE_TYPE` is `redis`.
893893
; If there is a password of redis, use `addrs=127.0.0.1:6379 password=123 db=0`.
894894
QUEUE_CONN_STR = "addrs=127.0.0.1:6379 db=0"
895+
896+
[migrations]
897+
; Retry times on migrations for every http/https request.
898+
RETRY_MAX_TIMES = 3
899+
; Time as seconds to delay before next retry.
900+
RETRY_DELAY = 3

docs/content/doc/advanced/config-cheat-sheet.en-us.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -585,6 +585,11 @@ Two special environment variables are passed to the render command:
585585
- `QUEUE_LENGTH`: **1000**: Task queue length, available only when `QUEUE_TYPE` is `channel`.
586586
- `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`.
587587

588+
## Migrations (`migrations`)
589+
590+
- `RETRY_MAX_TIMES`: **3**: Retry times on migrations for every http/https request.
591+
- `RETRY_DELAY`: **3**: Time as seconds to delay before next retry.
592+
588593
## Other (`other`)
589594

590595
- `SHOW_FOOTER_BRANDING`: **false**: Show Gitea branding in the footer.

docs/content/doc/advanced/config-cheat-sheet.zh-cn.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,11 @@ IS_INPUT_FILE = false
272272
- `QUEUE_LENGTH`: **1000**: 任务队列长度,当 `QUEUE_TYPE``channel` 时有效。
273273
- `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`
274274

275+
## Migrations (`migrations`)
276+
277+
- `RETRY_MAX_TIMES`: **3**: 在迁移过程中的 http/https 请求重试次数。
278+
- `RETRY_DELAY`: **3**: 等待下一次重试的时间,单位秒。
279+
275280
## Other (`other`)
276281

277282
- `SHOW_FOOTER_BRANDING`: 为真则在页面底部显示Gitea的字样。

modules/migrations/base/downloader.go

Lines changed: 142 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@
55

66
package base
77

8-
import "code.gitea.io/gitea/modules/structs"
8+
import (
9+
"time"
10+
11+
"code.gitea.io/gitea/modules/structs"
12+
)
913

1014
// Downloader downloads the site repo informations
1115
type Downloader interface {
@@ -25,3 +29,140 @@ type DownloaderFactory interface {
2529
New(opts MigrateOptions) (Downloader, error)
2630
GitServiceType() structs.GitServiceType
2731
}
32+
33+
// RetryDownloader retry the downloads
34+
type RetryDownloader struct {
35+
Downloader
36+
RetryTimes int // the total execute times
37+
RetryDelay int // time to delay seconds
38+
}
39+
40+
// NewRetryDownloader creates a retry downloader
41+
func NewRetryDownloader(downloader Downloader, retryTimes, retryDelay int) *RetryDownloader {
42+
return &RetryDownloader{
43+
Downloader: downloader,
44+
RetryTimes: retryTimes,
45+
RetryDelay: retryDelay,
46+
}
47+
}
48+
49+
func (d *RetryDownloader) GetRepoInfo() (*Repository, error) {
50+
var (
51+
times = d.RetryTimes
52+
repo *Repository
53+
err error
54+
)
55+
for ; times > 0; times-- {
56+
if repo, err = d.Downloader.GetRepoInfo(); err == nil {
57+
return repo, nil
58+
}
59+
time.Sleep(time.Second * time.Duration(d.RetryDelay))
60+
}
61+
return nil, err
62+
}
63+
64+
func (d *RetryDownloader) GetTopics() ([]string, error) {
65+
var (
66+
times = d.RetryTimes
67+
topics []string
68+
err error
69+
)
70+
for ; times > 0; times-- {
71+
if topics, err = d.Downloader.GetTopics(); err == nil {
72+
return topics, nil
73+
}
74+
time.Sleep(time.Second * time.Duration(d.RetryDelay))
75+
}
76+
return nil, err
77+
}
78+
79+
func (d *RetryDownloader) GetMilestones() ([]*Milestone, error) {
80+
var (
81+
times = d.RetryTimes
82+
milestones []*Milestone
83+
err error
84+
)
85+
for ; times > 0; times-- {
86+
if milestones, err = d.Downloader.GetMilestones(); err == nil {
87+
return milestones, nil
88+
}
89+
time.Sleep(time.Second * time.Duration(d.RetryDelay))
90+
}
91+
return nil, err
92+
}
93+
94+
func (d *RetryDownloader) GetReleases() ([]*Release, error) {
95+
var (
96+
times = d.RetryTimes
97+
releases []*Release
98+
err error
99+
)
100+
for ; times > 0; times-- {
101+
if releases, err = d.Downloader.GetReleases(); err == nil {
102+
return releases, nil
103+
}
104+
time.Sleep(time.Second * time.Duration(d.RetryDelay))
105+
}
106+
return nil, err
107+
}
108+
109+
func (d *RetryDownloader) GetLabels() ([]*Label, error) {
110+
var (
111+
times = d.RetryTimes
112+
labels []*Label
113+
err error
114+
)
115+
for ; times > 0; times-- {
116+
if labels, err = d.Downloader.GetLabels(); err == nil {
117+
return labels, nil
118+
}
119+
time.Sleep(time.Second * time.Duration(d.RetryDelay))
120+
}
121+
return nil, err
122+
}
123+
124+
func (d *RetryDownloader) GetIssues(page, perPage int) ([]*Issue, bool, error) {
125+
var (
126+
times = d.RetryTimes
127+
issues []*Issue
128+
isEnd bool
129+
err error
130+
)
131+
for ; times > 0; times-- {
132+
if issues, isEnd, err = d.Downloader.GetIssues(page, perPage); err == nil {
133+
return issues, isEnd, nil
134+
}
135+
time.Sleep(time.Second * time.Duration(d.RetryDelay))
136+
}
137+
return nil, false, err
138+
}
139+
140+
func (d *RetryDownloader) GetComments(issueNumber int64) ([]*Comment, error) {
141+
var (
142+
times = d.RetryTimes
143+
comments []*Comment
144+
err error
145+
)
146+
for ; times > 0; times-- {
147+
if comments, err = d.Downloader.GetComments(issueNumber); err == nil {
148+
return comments, nil
149+
}
150+
time.Sleep(time.Second * time.Duration(d.RetryDelay))
151+
}
152+
return nil, err
153+
}
154+
155+
func (d *RetryDownloader) GetPullRequests(page, perPage int) ([]*PullRequest, error) {
156+
var (
157+
times = d.RetryTimes
158+
prs []*PullRequest
159+
err error
160+
)
161+
for ; times > 0; times-- {
162+
if prs, err = d.Downloader.GetPullRequests(page, perPage); err == nil {
163+
return prs, nil
164+
}
165+
time.Sleep(time.Second * time.Duration(d.RetryDelay))
166+
}
167+
return nil, err
168+
}

modules/migrations/migrate.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import (
1111
"code.gitea.io/gitea/models"
1212
"code.gitea.io/gitea/modules/log"
1313
"code.gitea.io/gitea/modules/migrations/base"
14+
"code.gitea.io/gitea/modules/setting"
1415
"code.gitea.io/gitea/modules/structs"
1516
)
1617

@@ -63,6 +64,11 @@ func MigrateRepository(doer *models.User, ownerName string, opts base.MigrateOpt
6364
}
6465

6566
uploader.gitServiceType = opts.GitServiceType
67+
68+
if setting.Migrations.RetryMaxTimes > 0 {
69+
downloader = base.NewRetryDownloader(downloader, setting.Migrations.RetryMaxTimes+1, setting.Migrations.RetryDelay)
70+
}
71+
6672
if err := migrateRepository(downloader, uploader, opts); err != nil {
6773
if err1 := uploader.Rollback(); err1 != nil {
6874
log.Error("rollback failed: %v", err1)

modules/setting/migrations.go

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// Copyright 2019 The Gitea Authors. All rights reserved.
2+
// Use of this source code is governed by a MIT-style
3+
// license that can be found in the LICENSE file.
4+
5+
package setting
6+
7+
var (
8+
// Migrations settings
9+
Migrations = struct {
10+
RetryMaxTimes int
11+
RetryDelay int
12+
}{
13+
RetryMaxTimes: 2, // after failure, it will try again x times.
14+
RetryDelay: 3, // delay seconds before next retry
15+
}
16+
)
17+
18+
func newMigrationsService() {
19+
sec := Cfg.Section("migrations")
20+
Migrations.RetryMaxTimes = sec.Key("RETRY_MAX_TIMES").MustInt(Migrations.RetryMaxTimes)
21+
Migrations.RetryDelay = sec.Key("RETRY_DELAY").MustInt(Migrations.RetryDelay)
22+
}

modules/setting/setting.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1062,6 +1062,7 @@ func NewServices() {
10621062
newRegisterMailService()
10631063
newNotifyMailService()
10641064
newWebhookService()
1065+
newMigrationsService()
10651066
newIndexerService()
10661067
newTaskService()
10671068
}

0 commit comments

Comments
 (0)