Files
zeekayandGitHub 36ef0867fd file: file:// Leaser; dblock: byte-range lock; MaxLeaseTTL on interface (#3)
* file: add file:// Leaser for filesystem-backed CAS

Mirrors the S3 Leaser CAS semantics using POSIX O_EXCL for initial creation
and content-hash ETag matching for renew/release. Atomic rename for the
cutover. Same Leaser interface contract — callers swap backends without code
changes.

Use cases: per-process / single-node leases for dev + tests, container-local
coordination where S3 is overkill, and cross-process tests of leader/standby
patterns without spinning up MinIO.

Tests cover: fresh acquire, expired-lease takeover, contended acquire
(LeaseExistsError), renew bumps expiry + etag without touching generation,
renew loses race to a stealer (ErrLeaseNotHeld), release roundtrip, release
after steal (ErrLeaseNotHeld), and concurrent acquire with exactly one
winner across 32 goroutines.

* file: harden Leaser — MaxTTL clamp + foreign-owner renew guard

Closes red findings #1 (HIGH) and #4 (MEDIUM) on the per-market shard
layer's lease coordinator.

#1 — Server-side MaxTTL clamp:
  - Add Leaser.MaxTTL (default 30s when zero).
  - Acquire + Renew reject TTL > MaxTTL with ErrTTLExceedsMax. Without
    this, one malicious or buggy caller pins the lease for an arbitrary
    duration regardless of liveness.
  - readLease rejects an on-disk ExpiresAt > now + MaxTTL with
    ErrLeaseCorrupt — defense in depth against a writer that bypassed
    the API.

#4 — Owner check in RenewLease:
  - ETag CAS alone permits a caller who read another Leaser's ETag from
    disk to craft a renew call carrying any Owner string. We now read
    the on-disk record first and reject when existing.Owner != l.Owner
    with ErrLeaseNotHeld. ETag CAS remains primary; Owner check is
    belt-and-suspenders.

Tests:
  - TestLeaser_RejectsTTLBeyondMax (acquire, renew, zero MaxTTL falls
    back to default)
  - TestLeaser_ReadRejectsCorruptedTTL (hand-write 1h ExpiresAt,
    Acquire rejects)
  - TestLeaser_RejectsRenewByForeignOwner (foreign Owner with stolen
    ETag → ErrLeaseNotHeld)

All existing leaser tests continue to pass.

* leaser: surface MaxLeaseTTL() on the interface

Heartbeat schedulers depend on the leaser's TTL ceiling to validate
that their renew cadence is at least 2x tighter than the
server-side bound. Without surfacing it, callers either hardcode
the bound or compute it from the leaser type — both brittle.

The struct field stays MaxTTL (configuration knob); the interface
method is MaxLeaseTTL() to avoid the Go name-collision rule
("field and method with the same name"). file:// and s3:// both
default to DefaultLeaseMaxTTL (30s) when unset.

* dblock: expose SQLite-compatible byte-range lock as a public package

External callers that mirror Replica.applyLTXFile (e.g. shard-layer
exclusive-lock primitive so their apply pipeline interlocks with
SQLite's own locking and with the upstream applier.

dblock.LockExclusive / dblock.Unlock target the SQLite pending-byte
(0x40000000) and shared-region addresses, matching the existing
internal.LockFileExclusive contract used by Replica.applyLTXFile.
The internal/lock_*.go shims now forward to dblock so there is one
canonical implementation across the module.

Behavior identical to the previous internal/ implementation —
file-level tests in file/ pass.

* chore: bump go to 1.26.4

Picks up upstream security fixes for crypto/x509, mime, net/textproto,
crypto/fips140. No dependency bumps — only the toolchain directive.

go test -race ./... is green.

* chore: fix gofmt + goimports drift across repo

Pre-existing formatting drift on main exposed by go-imports-repo
pre-commit hook. Pure whitespace alignment + import ordering — no
logic changes. Touches 16 files unrelated to the file:// Leaser PR.
2026-06-07 07:55:05 -07:00

347 lines
8.5 KiB
Go

package file
import (
"context"
"encoding/json"
"errors"
"os"
"path/filepath"
"sync"
"sync/atomic"
"testing"
"time"
"github.com/hanzoai/replicate"
)
func newLeaser(t *testing.T, owner string) *Leaser {
t.Helper()
l := NewLeaser(t.TempDir())
l.Owner = owner
l.TTL = 200 * time.Millisecond
return l
}
func TestLeaser_AcquireFresh(t *testing.T) {
ctx := context.Background()
l := newLeaser(t, "node-a")
lease, err := l.AcquireLease(ctx)
if err != nil {
t.Fatalf("AcquireLease: %v", err)
}
if lease.Generation != 1 {
t.Errorf("generation: got %d want 1", lease.Generation)
}
if lease.Owner != "node-a" {
t.Errorf("owner: got %q want node-a", lease.Owner)
}
if lease.ETag == "" {
t.Errorf("etag empty")
}
if lease.IsExpired() {
t.Errorf("fresh lease should not be expired")
}
}
func TestLeaser_AcquireContended(t *testing.T) {
ctx := context.Background()
dir := t.TempDir()
a := NewLeaser(dir)
a.Owner = "node-a"
a.TTL = 5 * time.Second
b := NewLeaser(dir)
b.Owner = "node-b"
b.TTL = 5 * time.Second
if _, err := a.AcquireLease(ctx); err != nil {
t.Fatalf("a.AcquireLease: %v", err)
}
_, err := b.AcquireLease(ctx)
if err == nil {
t.Fatalf("b.AcquireLease succeeded with active lease")
}
var leaseExists *replicate.LeaseExistsError
if !errors.As(err, &leaseExists) {
t.Fatalf("expected LeaseExistsError, got %T: %v", err, err)
}
if leaseExists.Owner != "node-a" {
t.Errorf("contention owner: got %q want node-a", leaseExists.Owner)
}
}
func TestLeaser_AcquireAfterExpiry(t *testing.T) {
ctx := context.Background()
dir := t.TempDir()
a := NewLeaser(dir)
a.Owner = "node-a"
a.TTL = 50 * time.Millisecond
got, err := a.AcquireLease(ctx)
if err != nil {
t.Fatalf("a.AcquireLease: %v", err)
}
gen := got.Generation
time.Sleep(80 * time.Millisecond)
b := NewLeaser(dir)
b.Owner = "node-b"
b.TTL = 5 * time.Second
got2, err := b.AcquireLease(ctx)
if err != nil {
t.Fatalf("b.AcquireLease after expiry: %v", err)
}
if got2.Generation != gen+1 {
t.Errorf("generation: got %d want %d", got2.Generation, gen+1)
}
if got2.Owner != "node-b" {
t.Errorf("owner: got %q want node-b", got2.Owner)
}
}
func TestLeaser_RenewBumpsExpiry(t *testing.T) {
ctx := context.Background()
l := newLeaser(t, "node-a")
lease, err := l.AcquireLease(ctx)
if err != nil {
t.Fatalf("AcquireLease: %v", err)
}
firstExpiry := lease.ExpiresAt
firstETag := lease.ETag
gen := lease.Generation
time.Sleep(30 * time.Millisecond)
renewed, err := l.RenewLease(ctx, lease)
if err != nil {
t.Fatalf("RenewLease: %v", err)
}
if !renewed.ExpiresAt.After(firstExpiry) {
t.Errorf("renew did not bump expiry: %v vs %v", renewed.ExpiresAt, firstExpiry)
}
if renewed.Generation != gen {
t.Errorf("renew bumped generation: got %d want %d", renewed.Generation, gen)
}
if renewed.ETag == firstETag {
t.Errorf("renew did not bump etag")
}
}
func TestLeaser_RenewLosesRaceToStealer(t *testing.T) {
ctx := context.Background()
dir := t.TempDir()
a := NewLeaser(dir)
a.Owner = "node-a"
a.TTL = 30 * time.Millisecond
lease, err := a.AcquireLease(ctx)
if err != nil {
t.Fatalf("a.AcquireLease: %v", err)
}
time.Sleep(50 * time.Millisecond)
b := NewLeaser(dir)
b.Owner = "node-b"
b.TTL = 5 * time.Second
if _, err := b.AcquireLease(ctx); err != nil {
t.Fatalf("b.AcquireLease: %v", err)
}
if _, err := a.RenewLease(ctx, lease); !errors.Is(err, replicate.ErrLeaseNotHeld) {
t.Fatalf("expected ErrLeaseNotHeld, got %v", err)
}
}
func TestLeaser_Release(t *testing.T) {
ctx := context.Background()
dir := t.TempDir()
a := NewLeaser(dir)
a.Owner = "node-a"
a.TTL = 5 * time.Second
lease, err := a.AcquireLease(ctx)
if err != nil {
t.Fatalf("AcquireLease: %v", err)
}
if err := a.ReleaseLease(ctx, lease); err != nil {
t.Fatalf("ReleaseLease: %v", err)
}
b := NewLeaser(dir)
b.Owner = "node-b"
b.TTL = 5 * time.Second
got, err := b.AcquireLease(ctx)
if err != nil {
t.Fatalf("b.AcquireLease after release: %v", err)
}
if got.Owner != "node-b" {
t.Errorf("post-release owner: got %q want node-b", got.Owner)
}
}
func TestLeaser_ReleaseAfterSteal(t *testing.T) {
ctx := context.Background()
dir := t.TempDir()
a := NewLeaser(dir)
a.Owner = "node-a"
a.TTL = 30 * time.Millisecond
lease, err := a.AcquireLease(ctx)
if err != nil {
t.Fatalf("a.AcquireLease: %v", err)
}
time.Sleep(50 * time.Millisecond)
b := NewLeaser(dir)
b.Owner = "node-b"
b.TTL = 5 * time.Second
if _, err := b.AcquireLease(ctx); err != nil {
t.Fatalf("b.AcquireLease: %v", err)
}
if err := a.ReleaseLease(ctx, lease); !errors.Is(err, replicate.ErrLeaseNotHeld) {
t.Fatalf("expected ErrLeaseNotHeld on stale release, got %v", err)
}
}
func TestLeaser_ConcurrentAcquireSingleWinner(t *testing.T) {
ctx := context.Background()
dir := t.TempDir()
const N = 32
var wg sync.WaitGroup
var winners atomic.Int64
results := make([]error, N)
wg.Add(N)
start := make(chan struct{})
for i := 0; i < N; i++ {
i := i
go func() {
defer wg.Done()
l := NewLeaser(dir)
l.Owner = "node-X"
l.TTL = 5 * time.Second
<-start
_, err := l.AcquireLease(ctx)
results[i] = err
if err == nil {
winners.Add(1)
}
}()
}
close(start)
wg.Wait()
if got := winners.Load(); got != 1 {
t.Fatalf("expected exactly 1 winner, got %d", got)
}
}
// TestLeaser_RejectsTTLBeyondMax — a malicious or buggy caller that
// sets l.TTL > l.MaxTTL must be rejected with ErrTTLExceedsMax on
// both Acquire and Renew. Without this, one pod can pin the lease
// for hours regardless of liveness.
func TestLeaser_RejectsTTLBeyondMax(t *testing.T) {
ctx := context.Background()
t.Run("acquire", func(t *testing.T) {
l := NewLeaser(t.TempDir())
l.Owner = "node-a"
l.MaxTTL = 30 * time.Second
l.TTL = 1 * time.Hour
if _, err := l.AcquireLease(ctx); !errors.Is(err, ErrTTLExceedsMax) {
t.Fatalf("Acquire: expected ErrTTLExceedsMax, got %v", err)
}
})
t.Run("renew", func(t *testing.T) {
l := NewLeaser(t.TempDir())
l.Owner = "node-a"
l.MaxTTL = 30 * time.Second
l.TTL = 5 * time.Second
lease, err := l.AcquireLease(ctx)
if err != nil {
t.Fatalf("AcquireLease: %v", err)
}
l.TTL = 1 * time.Hour
if _, err := l.RenewLease(ctx, lease); !errors.Is(err, ErrTTLExceedsMax) {
t.Fatalf("Renew: expected ErrTTLExceedsMax, got %v", err)
}
})
t.Run("zero_max_uses_default", func(t *testing.T) {
l := NewLeaser(t.TempDir())
l.Owner = "node-a"
l.MaxTTL = 0
l.TTL = DefaultLeaseMaxTTL + 1*time.Second
if _, err := l.AcquireLease(ctx); !errors.Is(err, ErrTTLExceedsMax) {
t.Fatalf("zero MaxTTL must fall back to default and reject; got %v", err)
}
})
}
// TestLeaser_ReadRejectsCorruptedTTL — an attacker who bypasses the
// API and hand-writes a lock file with ExpiresAt 1h out must be
// rejected when any normal Acquire/Renew reads it. Defense in depth
// against a writer that ignored the API ceiling.
func TestLeaser_ReadRejectsCorruptedTTL(t *testing.T) {
ctx := context.Background()
dir := t.TempDir()
corrupt := &replicate.Lease{
Generation: 1,
ExpiresAt: time.Now().Add(1 * time.Hour),
Owner: "evil",
}
data, err := json.Marshal(corrupt)
if err != nil {
t.Fatalf("marshal: %v", err)
}
if err := os.WriteFile(filepath.Join(dir, DefaultLeaseFile), data, 0o644); err != nil {
t.Fatalf("write lock: %v", err)
}
l := NewLeaser(dir)
l.Owner = "node-a"
l.MaxTTL = 30 * time.Second
l.TTL = 5 * time.Second
if _, err := l.AcquireLease(ctx); !errors.Is(err, ErrLeaseCorrupt) {
t.Fatalf("Acquire on corrupt lock: expected ErrLeaseCorrupt, got %v", err)
}
}
// TestLeaser_RejectsRenewByForeignOwner — Leaser A acquires; Leaser B
// (different Owner) crafts a renew call carrying A's ETag. Without
// the owner check, B would overwrite A's lease silently. Now: B is
// rejected with ErrLeaseNotHeld.
func TestLeaser_RejectsRenewByForeignOwner(t *testing.T) {
ctx := context.Background()
dir := t.TempDir()
a := NewLeaser(dir)
a.Owner = "node-a"
a.TTL = 5 * time.Second
leaseA, err := a.AcquireLease(ctx)
if err != nil {
t.Fatalf("a.AcquireLease: %v", err)
}
b := NewLeaser(dir)
b.Owner = "node-b"
b.TTL = 5 * time.Second
// B uses A's ETag — would have succeeded pre-fix because ETag CAS
// alone matched. Owner check is the new gate.
leaseACopy := *leaseA
if _, err := b.RenewLease(ctx, &leaseACopy); !errors.Is(err, replicate.ErrLeaseNotHeld) {
t.Fatalf("expected ErrLeaseNotHeld for foreign-owner renew, got %v", err)
}
// A can still renew its own lease.
if _, err := a.RenewLease(ctx, leaseA); err != nil {
t.Fatalf("a.RenewLease (own): %v", err)
}
}