1 Commits

Author SHA1 Message Date
520ce79709 build: isolate golangci-lint cache and lock per checkout (closes #121)
All checks were successful
check / check (push) Successful in 54s
script/lint used golangci-lint's per-user global state, which breaks
when several checkouts on one host lint concurrently. Two independent
failure modes, two causes:

- Cross-contamination. The analysis cache (GOLANGCI_LINT_CACHE,
  default ~/.cache/golangci-lint) is keyed by content, not by
  checkout, so a hit written by another checkout is replayed with
  that checkout's file paths. A run reports findings for files it
  never linted.

- Lock collision. golangci-lint locks os.TempDir()/golangci-lint.lock
  (pkg/commands/run.go, acquireFileLock), which is NOT in the cache
  directory, with a 5s timeout. Peers that hold it longer make the
  run abort with "parallel golangci-lint is running" - a non-result
  that reads as a lint failure. Isolating the cache does not move it.

Point GOLANGCI_LINT_CACHE and TMPDIR at .lint-cache/ under the
checkout root, using the existing $ROOT idiom. TMPDIR is what makes
the lock per-checkout, so the lock keeps serialising the runs that
actually share a cache instead of being disabled. .lint-cache/ is
git-ignored and Docker-ignored, and the cache persists across runs in
a checkout, so caching is not lost.

Reproduced both modes on the unfixed script across 12 copies of this
tree: 10 of 12 concurrent runs void with the lock error, and 11 of 12
sequential runs reported findings at ../w1/... after an identical
lint-failing file was added to every copy. After the fix, 20-way
concurrency gives 0 void and 0 foreign paths, and each copy reports
only its own relative path.
2026-08-09 14:35:42 +00:00
6 changed files with 53 additions and 52 deletions

View File

@@ -1,5 +1,6 @@
.git/
bin/
.lint-cache/
*.md
LICENSE
.editorconfig

1
.gitignore vendored
View File

@@ -1,6 +1,7 @@
bin/
vendor/
data/
.lint-cache/
.env
*.exe
/dnswatcher

View File

@@ -387,7 +387,10 @@ them. We provide:
- `script/projectname` — print the project name (used for the Docker
image tag)
- `script/test` — run the test suite (race detector, coverage)
- `script/lint` — run golangci-lint
- `script/lint` — run golangci-lint, with its cache and its lock file
isolated to this checkout (under the git-ignored `.lint-cache/`) so
concurrent checkouts on one host cannot share cache entries or
contend on a single lock
- `script/fmt` — format all code (gofmt -s, goimports)
- `script/fmt-check` — check formatting (read-only)
- `script/check` — run test, lint, and fmt-check

16
TODO.md
View File

@@ -25,13 +25,15 @@ confirm make check still passes.
# Completed Steps
- 2026-08-09: `script/bootstrap` now installs the pinned `golangci-lint`
and `goimports` unconditionally instead of only when the binary is
absent from `PATH`, so the commit pins actually take effect on
already-provisioned machines; it also warns when `PATH` resolves
either tool to a copy outside the directory `go install` writes to.
The `missing` presence check is retained for `git`, `make`, and `go`
(#117)
- 2026-08-09: `script/lint` now isolates golangci-lint's per-user global
state to the checkout (#121): `GOLANGCI_LINT_CACHE` and `TMPDIR` are
both pointed at the git-ignored, Docker-ignored `.lint-cache/`. The
cache fixes cross-contamination; `TMPDIR` is what moves the lock,
which lives at `$TMPDIR/golangci-lint.lock` and not in the cache
directory. Reproduced both failure modes on the unfixed script (10 of
12 concurrent runs void with `parallel golangci-lint is running`; 11
of 12 reporting another checkout's paths) and both are gone at 20-way
concurrency after the fix
- 2026-08-07: golangci-lint bumped to v2.12.2 (commit-pinned installs
in `Dockerfile` and `script/bootstrap`); `.golangci.yml` set to the
org-standard v2-schema config used across the org's repos

View File

@@ -1,13 +1,10 @@
#!/bin/sh
# script/bootstrap: install all dependencies needed to build and develop
# this repo. Base tooling (git, make, go) comes from nix, apt, brew, or
# apk (detected in that order) and is installed only when absent;
# assumes nothing is present. golangci-lint and goimports are always
# (re)installed via `go install` at the same pinned commits the
# Dockerfile uses (never "latest") -- a presence check cannot tell the
# pinned build from an arbitrary one already on PATH, so guarding them
# would make the pins inert. Idempotent either way: running this twice
# succeeds both times and leaves the same result.
# this repo. Idempotent: every install is guarded by a check so already
# installed tools are skipped. Base tooling comes from nix, apt, brew,
# or apk (detected in that order); assumes nothing is present.
# golangci-lint and goimports are installed via `go install` at the same
# pinned commits the Dockerfile uses (never "latest").
set -eu
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
@@ -65,31 +62,6 @@ missing() {
! command -v "$1" >/dev/null 2>&1
}
# go_bin_dir: directory `go install` writes binaries to.
go_bin_dir() {
gobin="$(go env GOBIN)"
if [ -n "$gobin" ]; then
echo "$gobin"
else
echo "$(go env GOPATH)/bin"
fi
}
# warn_if_shadowed <tool> <dir>: the pinned build was just installed
# into <dir>. If PATH resolves <tool> anywhere else, that other copy is
# what `make lint` and `make fmt` will actually run, and it is not the
# pinned version. Warn loudly rather than failing, since the fix is the
# user's PATH and not anything this script can do.
warn_if_shadowed() {
resolved="$(command -v "$1" 2>/dev/null || true)"
if [ "$resolved" != "$2/$1" ]; then
echo "bootstrap: WARNING: installed pinned $1 to $2/$1, but PATH" >&2
echo "bootstrap: WARNING: resolves $1 to ${resolved:-(not on PATH)};" >&2
echo "bootstrap: WARNING: put $2 first on PATH or lint results will" >&2
echo "bootstrap: WARNING: not match CI." >&2
fi
}
main() {
cd "$ROOT"
@@ -97,17 +69,10 @@ main() {
if missing make; then pkg_install gnumake make make make; fi
if missing go; then pkg_install go golang go go; fi
# Lint/format tools, pinned via go install. These are installed
# unconditionally: `command -v` only proves *some* build is on PATH,
# and a wrong golangci-lint either cannot parse our v2-schema
# .golangci.yml at all or silently disagrees with CI. Installing at
# a fixed commit ref is idempotent and cheap with a warm module
# cache, so there is nothing to save by skipping it.
GOBIN_DIR="$(go_bin_dir)"
go install "$GOLANGCI_LINT_REF"
go install "$GOIMPORTS_REF"
warn_if_shadowed golangci-lint "$GOBIN_DIR"
warn_if_shadowed goimports "$GOBIN_DIR"
# Lint/format tools, pinned via go install (installs into
# "$(go env GOPATH)/bin"; ensure that is on your PATH).
if missing golangci-lint; then go install "$GOLANGCI_LINT_REF"; fi
if missing goimports; then go install "$GOIMPORTS_REF"; fi
go mod download

View File

@@ -1,11 +1,40 @@
#!/bin/sh
# script/lint: run the linter.
#
# golangci-lint keeps two pieces of per-user global state, and both of
# them break when several checkouts on one host lint concurrently:
#
# 1. Its analysis cache (GOLANGCI_LINT_CACHE, default
# ~/.cache/golangci-lint). Entries are keyed by content, not by
# checkout, so a hit written by another checkout is replayed
# verbatim - including that checkout's file paths. The run then
# reports findings for files it never linted.
#
# 2. Its "one runner at a time" lock, which does NOT live in the
# cache directory: golangci-lint locks
# $(os.TempDir())/golangci-lint.lock, i.e.
# "$TMPDIR"/golangci-lint.lock (pkg/commands/run.go,
# acquireFileLock). It waits 5s, then aborts with "parallel
# golangci-lint is running" - a non-result that looks like a lint
# failure. Setting GOLANGCI_LINT_CACHE alone does not move it.
#
# So both are pinned under the checkout root. The cache is never shared,
# and TMPDIR makes the lock file per-checkout, which keeps the lock
# doing its actual job (serialising runs that share one cache) at the
# right scope. .lint-cache/ is git-ignored and Docker-ignored, and
# caching still works: it persists across runs in this checkout.
set -eu
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
main() {
cd "$ROOT"
GOLANGCI_LINT_CACHE="$ROOT/.lint-cache/cache"
TMPDIR="$ROOT/.lint-cache/tmp"
export GOLANGCI_LINT_CACHE TMPDIR
mkdir -p "$GOLANGCI_LINT_CACHE" "$TMPDIR"
golangci-lint run --config .golangci.yml ./...
}