5fde0ee58e
ci/woodpecker/tag/docker Pipeline was successful
## Why This stacks the Debian/apt analog of `github_rpm` on top of the deb local+remote work (#111). It lets a GitHub repo's `.deb` release assets be consumed as a real apt repository without artifactapi ever precaching whole packages: it derives per-asset control metadata from a ranged prefix fetch, synthesizes a flat apt repo from the cache, and redirects the actual `.deb` downloads to a backend `releases_remote` (the generic github.com remote). Base is `benvin/deb-local-remote` (stacked) to keep the diff atomic. ## How - Adds `github_deb` to the package-type enum and validity map. - Adds the `github_deb` provider mirroring `github_rpm`: `ServeRemote` serves `Packages`/`Packages.gz`/`Release`, returns 404 for `InRelease`/`Release.gpg` (unsigned, consumed via `[trusted=yes]`), and 302-redirects `*.deb` to `{proxyBaseURL}/api/v1/remote/{releases_remote}/{path}`; cold-start prime with a retryable 503. - `deriveAsset` ranged-GETs the front of the `.deb` (an `ar` archive), locates and fully reads `control.tar.*`, and parses the control paragraph — doubling the range if the control member is truncated. The Packages `SHA256` comes from the GitHub asset `digest` when present, else a one-time full stream; `MD5sum` is left unset (apt verifies against SHA256 under `[trusted=yes]`). - Adds a `github_deb` background Syncer (own worker pool, shared rate limiter, deduped queue) with per-remote DB-lease-gated scans so only one replica scans per window. - Adds the `github_deb_sync_state` table plus `ListGitHubDebRemotes` / `ClaimGitHubDebSyncLease` / `ReleaseGitHubDebSyncLease` DB helpers, kept separate from the rpm ones. - Primes `github_deb` remotes on create and runs the deb syncer alongside the rpm one; prime-on-create is routed by package type. - Reuses the deb apt-index generators and control parser; the Packages generator now skips empty hash lines so a SHA256-only entry is valid. ## Notes / deviations - **Filename convention:** the `Filename` stored in the Packages index is the **github-relative** asset path (same as rpm's `assetPath`), not `pool/<asset>`. This is required for the `.deb` 302 to `{releases_remote=github}/{path}` to resolve against github.com; it still matches the `*.deb` redirect rule. - **GitHub client helpers** (releases pagination, ranged GET, auth headers) are duplicated into the deb package rather than shared, because the rpm equivalents are unexported in `package rpm` and the task requires not modifying the rpm provider. - `go build`, `go vet`, `go mod tidy`, and `make test` (`-race`, incl. the Postgres lease integration tests) all pass; pre-commit clean. Do not merge — for review. --------- Co-authored-by: unkin-agent <unkin-agent@git.unkin.net> Reviewed-on: #112 Co-authored-by: unkin-agent <unkin-agent@unkin.net> Co-committed-by: unkin-agent <unkin-agent@unkin.net>
239 lines
6.2 KiB
Go
239 lines
6.2 KiB
Go
package deb
|
|
|
|
import (
|
|
"context"
|
|
"crypto/rand"
|
|
"encoding/hex"
|
|
"log/slog"
|
|
"os"
|
|
"sync"
|
|
"time"
|
|
|
|
"golang.org/x/time/rate"
|
|
|
|
"git.unkin.net/unkin/artifactapi/internal/provider"
|
|
"git.unkin.net/unkin/artifactapi/pkg/models"
|
|
)
|
|
|
|
const (
|
|
syncLeaseDuration = 15 * time.Minute
|
|
defaultSyncFreshness = 5 * time.Minute
|
|
jobQueueDepth = 256
|
|
)
|
|
|
|
// SyncStore is the persistence surface the deb syncer needs: the metadata cache
|
|
// it primes plus the shared sync-state coordination (remote enumeration and the
|
|
// per-remote lease). *database.DB satisfies it.
|
|
type SyncStore interface {
|
|
provider.RemoteMetadataStore
|
|
ListGitHubDebRemotes(ctx context.Context) ([]models.Remote, error)
|
|
ClaimGitHubDebSyncLease(ctx context.Context, remoteName, owner string, freshness, lease time.Duration) (claimed bool, etag string, err error)
|
|
ReleaseGitHubDebSyncLease(ctx context.Context, remoteName, owner, etag string, syncedAt time.Time) error
|
|
}
|
|
|
|
// SyncConfig tunes the shared syncer. Zero values fall back to safe defaults.
|
|
type SyncConfig struct {
|
|
RatePerSec float64
|
|
Burst int
|
|
Workers int
|
|
PollInterval time.Duration
|
|
}
|
|
|
|
type syncJob struct {
|
|
remote models.Remote
|
|
prime bool
|
|
}
|
|
|
|
// Syncer is the single per-process background worker that keeps every github_deb
|
|
// remote's derived metadata fresh. It owns a deduped work queue, a pool of
|
|
// workers, and a global token-bucket rate limiter shared across all remotes and
|
|
// bound onto the github_deb provider. Periodic checks are gated by a shared DB
|
|
// lease so, across replicas, only one performs each scan.
|
|
type Syncer struct {
|
|
store SyncStore
|
|
prov *GitHubProvider
|
|
limiter *rate.Limiter
|
|
cfg SyncConfig
|
|
owner string
|
|
|
|
jobs chan syncJob
|
|
mu sync.Mutex
|
|
active map[string]bool
|
|
}
|
|
|
|
// NewSyncer builds the syncer bound to the process-wide github_deb provider
|
|
// singleton. Call Run to start it.
|
|
func NewSyncer(store SyncStore, cfg SyncConfig) *Syncer {
|
|
return newSyncer(store, gitHubProvider, cfg)
|
|
}
|
|
|
|
func newSyncer(store SyncStore, prov *GitHubProvider, cfg SyncConfig) *Syncer {
|
|
if cfg.RatePerSec <= 0 {
|
|
cfg.RatePerSec = 1
|
|
}
|
|
if cfg.Burst <= 0 {
|
|
cfg.Burst = 5
|
|
}
|
|
if cfg.Workers <= 0 {
|
|
cfg.Workers = 3
|
|
}
|
|
if cfg.PollInterval <= 0 {
|
|
cfg.PollInterval = 60 * time.Second
|
|
}
|
|
|
|
lim := rate.NewLimiter(rate.Limit(cfg.RatePerSec), cfg.Burst)
|
|
s := &Syncer{
|
|
store: store,
|
|
prov: prov,
|
|
limiter: lim,
|
|
cfg: cfg,
|
|
owner: leaseOwner(),
|
|
jobs: make(chan syncJob, jobQueueDepth),
|
|
active: map[string]bool{},
|
|
}
|
|
prov.limiter = lim
|
|
prov.syncer = s
|
|
return s
|
|
}
|
|
|
|
// Run starts the worker pool and the periodic scheduler and blocks until ctx is
|
|
// canceled, at which point it drains in-flight scans and returns.
|
|
func (s *Syncer) Run(ctx context.Context) {
|
|
slog.Info("github_deb syncer started",
|
|
"rate_per_sec", s.cfg.RatePerSec, "burst", s.cfg.Burst,
|
|
"workers", s.cfg.Workers, "poll_interval", s.cfg.PollInterval, "owner", s.owner)
|
|
|
|
var wg sync.WaitGroup
|
|
for i := 0; i < s.cfg.Workers; i++ {
|
|
wg.Add(1)
|
|
go func() {
|
|
defer wg.Done()
|
|
s.worker(ctx)
|
|
}()
|
|
}
|
|
|
|
ticker := time.NewTicker(s.cfg.PollInterval)
|
|
defer ticker.Stop()
|
|
|
|
s.schedule(ctx)
|
|
for {
|
|
select {
|
|
case <-ctx.Done():
|
|
wg.Wait()
|
|
slog.Info("github_deb syncer stopped")
|
|
return
|
|
case <-ticker.C:
|
|
s.schedule(ctx)
|
|
}
|
|
}
|
|
}
|
|
|
|
// schedule enqueues a periodic check for every github_deb remote. The DB lease
|
|
// enforces the per-remote mutable_ttl cadence and cross-replica coordination.
|
|
func (s *Syncer) schedule(ctx context.Context) {
|
|
remotes, err := s.store.ListGitHubDebRemotes(ctx)
|
|
if err != nil {
|
|
slog.Error("github_deb syncer: list remotes", "error", err)
|
|
return
|
|
}
|
|
for _, r := range remotes {
|
|
s.enqueue(r, false)
|
|
}
|
|
}
|
|
|
|
// EnqueuePrime queues an immediate background prime for a freshly created remote.
|
|
func (s *Syncer) EnqueuePrime(remote models.Remote) {
|
|
if s == nil {
|
|
return
|
|
}
|
|
s.enqueue(remote, true)
|
|
}
|
|
|
|
// enqueue adds a job unless the remote is already queued or in-flight, coalescing
|
|
// duplicate requests down to one scan. It never blocks.
|
|
func (s *Syncer) enqueue(remote models.Remote, prime bool) {
|
|
s.mu.Lock()
|
|
if s.active[remote.Name] {
|
|
s.mu.Unlock()
|
|
return
|
|
}
|
|
s.active[remote.Name] = true
|
|
s.mu.Unlock()
|
|
|
|
select {
|
|
case s.jobs <- syncJob{remote: remote, prime: prime}:
|
|
default:
|
|
s.mu.Lock()
|
|
delete(s.active, remote.Name)
|
|
s.mu.Unlock()
|
|
}
|
|
}
|
|
|
|
func (s *Syncer) worker(ctx context.Context) {
|
|
for {
|
|
select {
|
|
case <-ctx.Done():
|
|
return
|
|
case job := <-s.jobs:
|
|
s.process(ctx, job)
|
|
}
|
|
}
|
|
}
|
|
|
|
// process claims the shared lease and, if won, runs an incremental scan. Losing
|
|
// the claim (another replica scanning, or not yet due) is a no-op.
|
|
func (s *Syncer) process(ctx context.Context, job syncJob) {
|
|
defer func() {
|
|
s.mu.Lock()
|
|
delete(s.active, job.remote.Name)
|
|
s.mu.Unlock()
|
|
}()
|
|
|
|
freshness := time.Duration(job.remote.MutableTTL) * time.Second
|
|
if freshness <= 0 {
|
|
freshness = defaultSyncFreshness
|
|
}
|
|
if job.prime {
|
|
freshness = 0
|
|
}
|
|
|
|
claimed, etag, err := s.store.ClaimGitHubDebSyncLease(ctx, job.remote.Name, s.owner, freshness, syncLeaseDuration)
|
|
if err != nil {
|
|
slog.Error("github_deb syncer: claim lease", "remote", job.remote.Name, "error", err)
|
|
return
|
|
}
|
|
if !claimed {
|
|
return
|
|
}
|
|
|
|
scanCtx, cancel := context.WithTimeout(ctx, s.prov.scanTimeout)
|
|
defer cancel()
|
|
|
|
newEtag, changed, scanErr := s.prov.scanWithState(scanCtx, job.remote, s.store, etag)
|
|
releaseEtag := etag
|
|
if scanErr == nil {
|
|
releaseEtag = newEtag
|
|
} else {
|
|
slog.Error("github_deb syncer: scan failed", "remote", job.remote.Name, "error", scanErr)
|
|
}
|
|
|
|
relCtx, relCancel := context.WithTimeout(context.WithoutCancel(ctx), 10*time.Second)
|
|
defer relCancel()
|
|
if err := s.store.ReleaseGitHubDebSyncLease(relCtx, job.remote.Name, s.owner, releaseEtag, time.Now()); err != nil {
|
|
slog.Warn("github_deb syncer: release lease", "remote", job.remote.Name, "error", err)
|
|
}
|
|
|
|
if scanErr == nil && changed {
|
|
slog.Info("github_deb syncer: refreshed", "remote", job.remote.Name, "prime", job.prime)
|
|
}
|
|
}
|
|
|
|
// leaseOwner is a per-replica identity for the lease: hostname plus a random
|
|
// suffix so restarts and colocated replicas never collide.
|
|
func leaseOwner() string {
|
|
host, _ := os.Hostname()
|
|
var b [6]byte
|
|
_, _ = rand.Read(b[:])
|
|
return host + "-" + hex.EncodeToString(b[:])
|
|
}
|