Create a lock abstract layer and remove old one

custom/conf/app.example.ini

@@ -2487,3 +2487,9 @@ ROUTER = console
 ;PROXY_URL =
 ;; Comma separated list of host names requiring proxy. Glob patterns (*) are accepted; use ** to match all hosts.
 ;PROXY_HOSTS =
+
+;[sync]
+;; Lock service type, could be memory or redis
+;LOCK_SERVICE_TYPE = memory
+;; Ignored by memory type, for redis, it likes "addrs=127.0.0.1:6379 db=0"
+;LOCK_SERVICE_CONN_STR =

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

@@ -1290,6 +1290,11 @@ PROXY_URL = socks://127.0.0.1:1080
 PROXY_HOSTS = *.github.com
 ```
 
+## Sync (`sync`)
+
+- `LOCK_SERVICE_TYPE`: **memory**: Lock service type, could be `memory` or `redis`
+- `LOCK_SERVICE_CONN_STR`: ****: Ignored when `LOCK_SERVICE_TYPE` is `memory` type, for `redis`, it likes `addrs=127.0.0.1:6379 db=0`
+
 ## Other (`other`)
 
 - `SHOW_FOOTER_BRANDING`: **false**: Show Gitea branding in the footer.

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

@@ -453,6 +453,11 @@ PROXY_URL = socks://127.0.0.1:1080
 PROXY_HOSTS = *.github.com
 ```
 
+## Sync (`sync`)
+
+- `LOCK_SERVICE_TYPE`: **memory**: 锁服务类型，可以是 `memory` 或 `redis`
+- `LOCK_SERVICE_CONN_STR`: ****: 如果 `LOCK_SERVICE_TYPE` 是 `memory`，则忽略，如果是 `redis`，则支持形式如 `addrs=127.0.0.1:6379 db=0`
+
 ## Other (`other`)
 
 - `SHOW_FOOTER_BRANDING`: 为真则在页面底部显示Gitea的字样。

go.mod

@@ -41,6 +41,7 @@ require (
 	github.com/go-git/go-git/v5 v5.4.3-0.20220529141257-bc1f419cebcf
 	github.com/go-ldap/ldap/v3 v3.4.4
 	github.com/go-redis/redis/v8 v8.11.5
+	github.com/go-redsync/redsync/v4 v4.7.1
 	github.com/go-sql-driver/mysql v1.6.0
 	github.com/go-swagger/go-swagger v0.30.3
 	github.com/go-testfixtures/testfixtures/v3 v3.8.1
@@ -70,6 +71,7 @@ require (
 	github.com/mholt/archiver/v3 v3.5.1
 	github.com/microcosm-cc/bluemonday v1.0.20
 	github.com/minio/minio-go/v7 v7.0.39
+	github.com/moby/locker v1.0.1
 	github.com/msteinert/pam v1.1.0
 	github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646
 	github.com/niklasfasching/go-org v1.6.5
@@ -203,7 +205,9 @@ require (
 	github.com/grpc-ecosystem/go-grpc-middleware v1.3.0 // indirect
 	github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0 // indirect
 	github.com/grpc-ecosystem/grpc-gateway v1.16.0 // indirect
+	github.com/hashicorp/errwrap v1.0.0 // indirect
 	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
+	github.com/hashicorp/go-multierror v1.1.0 // indirect
 	github.com/hashicorp/go-retryablehttp v0.7.1 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/imdario/mergo v0.3.13 // indirect

modules/setting/setting.go

@@ -1138,6 +1138,8 @@ func loadFromConf(allowEmpty bool, extraConfig string) {
 	for _, emoji := range UI.CustomEmojis {
 		UI.CustomEmojisMap[emoji] = ":" + emoji + ":"
 	}
+
+	parseSyncSetting()
 }
 
 func parseAuthorizedPrincipalsAllow(values []string) ([]string, bool) {

modules/setting/sync.go

@@ -0,0 +1,23 @@
+// Copyright 2023 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package setting
+
+import "code.gitea.io/gitea/modules/log"
+
+// Sync represents configuration of sync
+var Sync = struct {
+	LockServiceType    string
+	LockServiceConnStr string
+}{
+	LockServiceType: "memory",
+}
+
+func parseSyncSetting() {
+	sec := Cfg.Section("sync")
+	Sync.LockServiceType = sec.Key("LOCK_SERVICE_TYPE").MustString("memory")
+	if Sync.LockServiceType != "memory" && Sync.LockServiceType != "redis" {
+		log.Fatal("Unknown sync lock service type: %s", Sync.LockServiceType)
+	}
+	Sync.LockServiceConnStr = sec.Key("LOCK_SERVICE_CONN_STR").MustString("")
+}

modules/sync/lock.go

@@ -0,0 +1,115 @@
+// Copyright 2023 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package sync
+
+import (
+	"sync"
+
+	"code.gitea.io/gitea/modules/nosql"
+	"code.gitea.io/gitea/modules/setting"
+
+	redsync "github.com/go-redsync/redsync/v4"
+	goredis "github.com/go-redsync/redsync/v4/redis/goredis/v8"
+	"github.com/moby/locker"
+)
+
+type Locker interface {
+	Lock() error
+	Unlock() (bool, error)
+}
+
+type LockService interface {
+	GetLock(name string) Locker
+}
+
+type memoryLock struct {
+	locker *locker.Locker
+	name   string
+}
+
+func (r *memoryLock) Lock() error {
+	r.locker.Lock(r.name)
+	return nil
+}
+
+func (r *memoryLock) Unlock() (bool, error) {
+	return true, r.locker.Unlock(r.name)
+}
+
+var _ Locker = &memoryLock{}
+
+type memoryLockService struct {
+	locker *locker.Locker
+}
+
+var _ LockService = &memoryLockService{}
+
+func newMemoryLockService() *memoryLockService {
+	return &memoryLockService{
+		locker: locker.New(),
+	}
+}
+
+func (l *memoryLockService) GetLock(name string) Locker {
+	return &memoryLock{
+		locker: l.locker,
+		name:   name,
+	}
+}
+
+type redisLockService struct {
+	rs *redsync.Redsync
+}
+
+var _ LockService = &redisLockService{}
+
+func newRedisLockService(connection string) *redisLockService {
+	client := nosql.GetManager().GetRedisClient(connection)
+
+	pool := goredis.NewPool(client) // or, pool := redigo.NewPool(...)
+
+	// Create an instance of redisync to be used to obtain a mutual exclusion
+	// lock.
+	rs := redsync.New(pool)
+
+	return &redisLockService{
+		rs: rs,
+	}
+}
+
+type redisLock struct {
+	mutex *redsync.Mutex
+}
+
+func (r *redisLockService) GetLock(name string) Locker {
+	return &redisLock{mutex: r.rs.NewMutex(name)}
+}
+
+func (r *redisLock) Lock() error {
+	return r.mutex.Lock()
+}
+
+func (r *redisLock) Unlock() (bool, error) {
+	return r.mutex.Unlock()
+}
+
+var (
+	syncOnce    sync.Once
+	lockService LockService
+)
+
+func getLockService() LockService {
+	syncOnce.Do(func() {
+		if setting.Sync.LockServiceType == "redis" {
+			lockService = newRedisLockService(setting.Sync.LockServiceConnStr)
+		} else {
+			lockService = newMemoryLockService()
+		}
+	})
+	return lockService
+}
+
+func GetLock(name string) Locker {
+	return getLockService().GetLock(name)
+}

modules/sync/lock_test.go

@@ -0,0 +1,14 @@
+// Copyright 2023 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package sync
+
+import (
+	"testing"
+)
+
+func Test_Lock(t *testing.T) {
+	locker := GetLock("test")
+	locker.Lock()
+	locker.Unlock()
+}