Files
OwnCord/Server/admin/backup_maintenance.go
T
Claude 7a4e5dc357 refactor: rename the Go module to github.com/J3vb/OwnCord/Server (RL-13)
`Server/go.mod` declared `github.com/owncord/server` while the public
repository is `github.com/J3vb/OwnCord`. Nothing resolves that path — there is
no `owncord` GitHub org and no vanity-import host serving go-import metadata
for it — so every import line in the tree named a location that does not
exist. It compiles because a main module's own path is never fetched, which is
exactly why it went unnoticed.

The obvious fix — an AST-aware import rewriter (`gomvpkg`, `go mod edit`) —
is wrong here, and provably so. Six of the 722 occurrences are not imports at
all: `api/main_test.go:20` (a goleak `IgnoreTopFunction` pattern),
`telemetry/metrics.go:17-19` (three OTel instrumentation-scope names),
`invariants/syncutil_locks.go:73` (a diagnostic message), and
`invariants/syncutil_locks_test.go:56` (an import line inside a raw-string Go
fixture). An import rewriter touches none of them, and the compiler cannot
see any of them either.

Done as one scripted substitution over `git ls-files`, anchored on the full
`github.com/owncord/server` string. The anchor matters: `owncord-server` is a
different identifier — the OTel `service.name` (`config/config.go`,
`telemetry/telemetry_otel.go`) and the GHCR image name
(`.github/workflows/release.yml`, `docker-compose.yml`) — and a looser pattern
would have moved it. It is untouched: 10 occurrences across 9 files, before
and after.

350 files, 728 insertions, 728 deletions. 722 occurrences in 344 Go files,
plus `go.mod:1`, the `sed` at `Makefile:67`, `Server/CLAUDE.md:3`,
`docs/architecture/server.md:5`, and the ledger pair
(`findings-ledger.json:3758` plus a `render-ledger.mjs` re-render of
`FINDINGS.md`). Zero in any workflow, zero in the Dockerfile, zero in
`Server/.golangci.yml` (no `local-prefixes`, `gci`, `importas` or `depguard`
rule keys on the module path, so import grouping is not configured anywhere).

The plan's blast-radius estimate missed one thing, and it is the one that
would have gone red: **gofmt**. `J` (0x4A) sorts before every lowercase
letter, so in the 36 files where a module-local import shares a contiguous
group with a third-party one, the module's imports must move above
`github.com/go-chi/...`. `gofmt -l` was clean before the substitution and
listed exactly 36 files after it; `gofmt -w` on those 36 restores it to
clean. `gofmt` is an enforced gate — the `formatters` block in
`Server/.golangci.yml`, which is S-05 — so a substitution-only commit fails
Lint.

Verified: both directions, and the line accounting is exact. Every added line
in this diff contains the new module path (728) and every removed line
contains the old one (728); the count of changed lines containing neither is
**zero**, so the gofmt re-sort moved module-path lines only and touched no
third-party import. The residual check
(`git ls-files -z | xargs -0 grep -n 'github\.com/owncord/server'`) returns
exactly two hits, both deliberately out of scope: the RL-13 row in
`docs/audit-2026-08-23-repository-layout.md` and the measurement row in this
phase's own plan. The compiler-invisible half was proven by reverting *only*
`api/main_test.go:20` to the old path on the otherwise-renamed tree:
`go build ./...` and `go vet ./api/` both still pass — they see nothing wrong
— while `go test ./api/` FAILS, because the runtime function name now carries
the new path and goleak stops ignoring `ws.(*Hub).Run.func1`. Restoring the
line makes it pass. `go.sum` is byte-identical (no `go mod tidy` was run and
none was needed). All four build-tag variants compile; `go vet ./...`,
`go vet -tags otel,wazero ./...` and `go vet -tags deadlock ./...` pass;
`go test -race ./...` is 16/16 packages green; `go test -tags deadlock ./...`
passes; the tag-gated `./plugin/...` (wazero) and `./telemetry/...` (otel)
runs pass. `golangci-lint` v2.11.3 — the pinned CI version, rebuilt locally
against Go 1.26 because the packaged binary cannot load a 1.26 config —
reports **0 issues**. `go run ./cmd/genprotocol` leaves
`git diff --exit-code ws/message_types.go ../Client/src/lib/protocolTypes.ts`
clean, so the rename does not reach the generated protocol constants.
`npx prettier --check .` and `node .superpowers/render-ledger.mjs --check`
pass.

Not included: `docs/audit-2026-08-23-repository-layout.md` and
`docs/plans/b1-repository-foundation-2026-08-25.md` keep the old path — they
are the audit row and the measurement that motivated this change, and
rewriting them would erase the record of what was measured. They are why the
residual check needs a two-path allowance rather than being empty; that
allowance is stated above rather than hidden in a pathspec.
`telemetry/metrics.go:19` declares `scopeVoice` for a `Server/voice` package
that does not exist; the substitution carried the dead path forward verbatim
as `github.com/J3vb/OwnCord/Server/voice` rather than fixing it, because
correcting a real observability bug inside a mechanical rename would hide it
in a 350-file diff. It needs its own item. No `go.work`, no second module,
and no vanity-import host was set up — the new path resolves against the real
repository, but nothing imports this module as a library, so `go get`
reachability was not exercised either way.

Refs RL-13, L-12
2026-08-26 20:23:49 +00:00

190 lines
5.9 KiB
Go

package admin
import (
"context"
"errors"
"fmt"
"log/slog"
"os"
"path/filepath"
"strconv"
"strings"
"time"
"github.com/J3vb/OwnCord/Server/db"
)
// Scheduled-backup intervals for the backup_schedule setting values the admin
// UI offers. "off" (or anything unrecognised) disables scheduling.
const (
backupIntervalDaily = 24 * time.Hour
backupIntervalWeekly = 7 * 24 * time.Hour
)
// MaintainBackups implements the backup_schedule / backup_retention settings
// the admin panel has always offered. It is driven by main.go's 15-minute
// maintenance loop, mirroring the expired-session sweep: read the settings
// each tick, take a scheduled backup when the newest backup on disk is older
// than the schedule interval, and prune backups past the retention window.
//
// Freshness is judged by the newest *.db file's mtime, manual backups
// included — an operator who clicked "Backup now" this morning does not need
// a second copy tonight. Retention prunes by mtime in whole days, but never
// removes the newest backup, so a long-dead schedule cannot delete the last
// copy in the directory.
//
// The returned error feeds the maintenance loop's circuit breaker; settings
// simply not existing (fresh DB mid-migration) is not an error.
func MaintainBackups(ctx context.Context, database *db.DB) error {
schedule, err := database.GetSetting(ctx, "backup_schedule")
if err != nil {
if errors.Is(err, db.ErrNotFound) {
return nil
}
return fmt.Errorf("MaintainBackups: reading backup_schedule: %w", err)
}
var interval time.Duration
switch strings.ToLower(strings.TrimSpace(schedule)) {
case "daily":
interval = backupIntervalDaily
case "weekly":
interval = backupIntervalWeekly
}
var firstErr error
if interval > 0 {
if err := runScheduledBackup(ctx, database, interval); err != nil {
slog.Warn("scheduled backup failed", "error", err)
firstErr = err
}
}
if err := pruneExpiredBackups(ctx, database); err != nil {
slog.Warn("backup retention pruning failed", "error", err)
if firstErr == nil {
firstErr = err
}
}
return firstErr
}
// runScheduledBackup takes a backup when the newest existing one is older
// than interval (or none exists).
func runScheduledBackup(ctx context.Context, database *db.DB, interval time.Duration) error {
newest, _, err := scanBackups()
if err != nil {
return err
}
if !newest.IsZero() && time.Since(newest) < interval {
return nil
}
if err := os.MkdirAll(backupBaseDir, 0o750); err != nil {
return fmt.Errorf("creating backup dir: %w", err)
}
// VACUUM INTO refuses an existing destination, and the timestamp only has
// second resolution — suffix on collision instead of failing the tick.
base := "scheduled_" + time.Now().UTC().Format("20060102_150405")
name := base + ".db"
path := filepath.Join(backupBaseDir, name)
for i := 2; ; i++ {
if _, err := os.Stat(path); err != nil {
// ENOENT is the free-slot case. Any OTHER stat error (EACCES on
// the dir, an unreadable mount) cannot be fixed by trying more
// suffixes — stop probing and let VACUUM INTO surface the real
// failure with a legible error instead of spinning this loop.
break
}
if i > 100 {
return fmt.Errorf("scheduled backup: no free filename after %s (tried 100 suffixes)", base)
}
name = fmt.Sprintf("%s_%d.db", base, i)
path = filepath.Join(backupBaseDir, name)
}
if err := database.BackupToSafe(ctx, path, backupBaseDir); err != nil {
return err
}
if err := db.CheckBackupIntegrity(ctx, path); err != nil {
_ = os.Remove(path)
return fmt.Errorf("scheduled backup failed verification: %w", err)
}
slog.Info("scheduled backup created", "name", name)
// Actor 0 = system, same audit action the manual handler writes.
db.WriteAudit(ctx, database, 0, "backup_create", "server", 0, "scheduled backup saved: "+name)
return nil
}
// pruneExpiredBackups deletes *.db backups whose mtime is older than the
// backup_retention window (in days), always keeping the newest one.
func pruneExpiredBackups(ctx context.Context, database *db.DB) error {
retStr, err := database.GetSetting(ctx, "backup_retention")
if err != nil {
if errors.Is(err, db.ErrNotFound) {
return nil
}
return fmt.Errorf("reading backup_retention: %w", err)
}
// Malformed values parse to 0; zero-or-below means retention is off, so a
// typo disables pruning rather than failing the maintenance tick.
days, _ := strconv.Atoi(strings.TrimSpace(retStr))
if days <= 0 {
return nil
}
newest, entries, err := scanBackups()
if err != nil || len(entries) == 0 {
return err
}
cutoff := time.Now().Add(-time.Duration(days) * 24 * time.Hour)
pruned := 0
for _, e := range entries {
if e.mtime.Before(cutoff) && !e.mtime.Equal(newest) {
if rmErr := os.Remove(e.path); rmErr != nil {
slog.Warn("backup retention: failed to remove expired backup", "path", e.path, "error", rmErr)
continue
}
pruned++
}
}
if pruned > 0 {
slog.Info("backup retention: pruned expired backups", "count", pruned, "retention_days", days)
db.WriteAudit(ctx, database, 0, "backup_delete", "server", 0,
fmt.Sprintf("retention pruned %d backup(s) older than %d days", pruned, days))
}
return nil
}
type backupFile struct {
path string
mtime time.Time
}
// scanBackups lists *.db files in the backup dir, returning the newest mtime
// and all entries. A missing directory is "no backups", not an error.
func scanBackups() (newest time.Time, files []backupFile, err error) {
entries, err := os.ReadDir(backupBaseDir)
if err != nil {
if os.IsNotExist(err) {
return time.Time{}, nil, nil
}
return time.Time{}, nil, fmt.Errorf("reading backup dir: %w", err)
}
for _, e := range entries {
if e.IsDir() || filepath.Ext(e.Name()) != ".db" {
continue
}
info, infoErr := e.Info()
if infoErr != nil {
continue
}
mt := info.ModTime()
files = append(files, backupFile{path: filepath.Join(backupBaseDir, e.Name()), mtime: mt})
if mt.After(newest) {
newest = mt
}
}
return newest, files, nil
}