mirror of
https://gitea.com/gitea/tea.git
synced 2026-02-22 06:13:32 +01:00
Move versions/filelocker into dedicated subpackages, and consistent headers in http requests (#888)
- move filelocker logic into dedicated subpackage - consistent useragent in requests Reviewed-on: https://gitea.com/gitea/tea/pulls/888 Co-authored-by: techknowlogick <techknowlogick@gitea.com> Co-committed-by: techknowlogick <techknowlogick@gitea.com>
This commit is contained in:
committed by
techknowlogick
parent
982adb4d02
commit
49a9032d8a
70
modules/filelock/filelock.go
Normal file
70
modules/filelock/filelock.go
Normal file
@@ -0,0 +1,70 @@
|
||||
// Copyright 2026 The Gitea Authors. All rights reserved.
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package filelock
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"time"
|
||||
)
|
||||
|
||||
const (
|
||||
// DefaultTimeout is the default timeout for acquiring a file lock.
|
||||
DefaultTimeout = 5 * time.Second
|
||||
|
||||
// FileLockPollInterval is how often to retry acquiring the file lock.
|
||||
FileLockPollInterval = 50 * time.Millisecond
|
||||
)
|
||||
|
||||
// Locker provides file-based locking with timeout.
|
||||
type Locker struct {
|
||||
path string
|
||||
timeout time.Duration
|
||||
}
|
||||
|
||||
// New creates a Locker for the given lock file path.
|
||||
func New(lockPath string, timeout time.Duration) *Locker {
|
||||
return &Locker{
|
||||
path: lockPath,
|
||||
timeout: timeout,
|
||||
}
|
||||
}
|
||||
|
||||
// WithLock executes fn while holding the lock.
|
||||
func (l *Locker) WithLock(fn func() error) (retErr error) {
|
||||
unlock, err := l.Acquire()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer func() {
|
||||
if unlockErr := unlock(); unlockErr != nil && retErr == nil {
|
||||
retErr = fmt.Errorf("failed to release file lock: %w", unlockErr)
|
||||
}
|
||||
}()
|
||||
|
||||
return fn()
|
||||
}
|
||||
|
||||
// Acquire acquires the file lock and returns an unlock function.
|
||||
// The caller must call the unlock function to release the lock.
|
||||
func (l *Locker) Acquire() (unlock func() error, err error) {
|
||||
file, err := os.OpenFile(l.path, os.O_CREATE|os.O_RDWR, 0o600)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to open lock file: %w", err)
|
||||
}
|
||||
|
||||
if err := lockFile(file, l.timeout); err != nil {
|
||||
file.Close()
|
||||
return nil, fmt.Errorf("failed to acquire file lock: %w", err)
|
||||
}
|
||||
|
||||
return func() error {
|
||||
unlockErr := unlockFile(file)
|
||||
closeErr := file.Close()
|
||||
if unlockErr != nil {
|
||||
return unlockErr
|
||||
}
|
||||
return closeErr
|
||||
}, nil
|
||||
}
|
||||
92
modules/filelock/filelock_test.go
Normal file
92
modules/filelock/filelock_test.go
Normal file
@@ -0,0 +1,92 @@
|
||||
// Copyright 2026 The Gitea Authors. All rights reserved.
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package filelock
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
func TestLocker_WithLock(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
lockPath := filepath.Join(tmpDir, "test.lock")
|
||||
|
||||
locker := New(lockPath, DefaultTimeout)
|
||||
|
||||
counter := 0
|
||||
err := locker.WithLock(func() error {
|
||||
counter++
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("WithLock failed: %v", err)
|
||||
}
|
||||
if counter != 1 {
|
||||
t.Errorf("Expected counter to be 1, got %d", counter)
|
||||
}
|
||||
|
||||
// Lock file should have been created
|
||||
if _, err := os.Stat(lockPath); os.IsNotExist(err) {
|
||||
t.Error("Lock file should have been created")
|
||||
}
|
||||
}
|
||||
|
||||
func TestLocker_Acquire(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
lockPath := filepath.Join(tmpDir, "test.lock")
|
||||
|
||||
locker := New(lockPath, DefaultTimeout)
|
||||
|
||||
unlock, err := locker.Acquire()
|
||||
if err != nil {
|
||||
t.Fatalf("Acquire failed: %v", err)
|
||||
}
|
||||
|
||||
// Lock should be held
|
||||
if unlock == nil {
|
||||
t.Fatal("unlock function should not be nil")
|
||||
}
|
||||
|
||||
// Release the lock
|
||||
if err := unlock(); err != nil {
|
||||
t.Fatalf("unlock failed: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLocker_ConcurrentAccess(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
lockPath := filepath.Join(tmpDir, "test.lock")
|
||||
|
||||
locker := New(lockPath, 5*time.Second)
|
||||
|
||||
var wg sync.WaitGroup
|
||||
counter := 0
|
||||
numGoroutines := 10
|
||||
|
||||
for i := 0; i < numGoroutines; i++ {
|
||||
wg.Add(1)
|
||||
go func() {
|
||||
defer wg.Done()
|
||||
err := locker.WithLock(func() error {
|
||||
// Read-modify-write to check for race conditions
|
||||
tmp := counter
|
||||
time.Sleep(1 * time.Millisecond)
|
||||
counter = tmp + 1
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
t.Errorf("WithLock failed: %v", err)
|
||||
}
|
||||
}()
|
||||
}
|
||||
|
||||
wg.Wait()
|
||||
|
||||
if counter != numGoroutines {
|
||||
t.Errorf("Expected counter to be %d, got %d (possible race condition)", numGoroutines, counter)
|
||||
}
|
||||
}
|
||||
39
modules/filelock/filelock_unix.go
Normal file
39
modules/filelock/filelock_unix.go
Normal file
@@ -0,0 +1,39 @@
|
||||
// Copyright 2026 The Gitea Authors. All rights reserved.
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
//go:build unix
|
||||
|
||||
package filelock
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"syscall"
|
||||
"time"
|
||||
)
|
||||
|
||||
// lockFile acquires an exclusive lock on the file using flock.
|
||||
// It polls with non-blocking flock until timeout.
|
||||
func lockFile(file *os.File, timeout time.Duration) error {
|
||||
deadline := time.Now().Add(timeout)
|
||||
|
||||
for {
|
||||
err := syscall.Flock(int(file.Fd()), syscall.LOCK_EX|syscall.LOCK_NB)
|
||||
if err == nil {
|
||||
return nil
|
||||
}
|
||||
if err != syscall.EWOULDBLOCK {
|
||||
return fmt.Errorf("flock failed: %w", err)
|
||||
}
|
||||
|
||||
if time.Now().After(deadline) {
|
||||
return fmt.Errorf("timeout waiting for file lock")
|
||||
}
|
||||
time.Sleep(FileLockPollInterval)
|
||||
}
|
||||
}
|
||||
|
||||
// unlockFile releases the lock on the file.
|
||||
func unlockFile(file *os.File) error {
|
||||
return syscall.Flock(int(file.Fd()), syscall.LOCK_UN)
|
||||
}
|
||||
48
modules/filelock/filelock_windows.go
Normal file
48
modules/filelock/filelock_windows.go
Normal file
@@ -0,0 +1,48 @@
|
||||
// Copyright 2026 The Gitea Authors. All rights reserved.
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
//go:build windows
|
||||
|
||||
package filelock
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"time"
|
||||
|
||||
"golang.org/x/sys/windows"
|
||||
)
|
||||
|
||||
// lockFile acquires an exclusive lock on the file using LockFileEx.
|
||||
// It polls with non-blocking LockFileEx until timeout.
|
||||
func lockFile(file *os.File, timeout time.Duration) error {
|
||||
deadline := time.Now().Add(timeout)
|
||||
handle := windows.Handle(file.Fd())
|
||||
|
||||
// LOCKFILE_EXCLUSIVE_LOCK | LOCKFILE_FAIL_IMMEDIATELY
|
||||
const flags = windows.LOCKFILE_EXCLUSIVE_LOCK | windows.LOCKFILE_FAIL_IMMEDIATELY
|
||||
|
||||
for {
|
||||
// Lock the first byte (advisory lock)
|
||||
var overlapped windows.Overlapped
|
||||
err := windows.LockFileEx(handle, flags, 0, 1, 0, &overlapped)
|
||||
if err == nil {
|
||||
return nil
|
||||
}
|
||||
if err != windows.ERROR_LOCK_VIOLATION {
|
||||
return fmt.Errorf("LockFileEx failed: %w", err)
|
||||
}
|
||||
|
||||
if time.Now().After(deadline) {
|
||||
return fmt.Errorf("timeout waiting for file lock")
|
||||
}
|
||||
time.Sleep(FileLockPollInterval)
|
||||
}
|
||||
}
|
||||
|
||||
// unlockFile releases the lock on the file.
|
||||
func unlockFile(file *os.File) error {
|
||||
handle := windows.Handle(file.Fd())
|
||||
var overlapped windows.Overlapped
|
||||
return windows.UnlockFileEx(handle, 0, 1, 0, &overlapped)
|
||||
}
|
||||
Reference in New Issue
Block a user