Compare commits
1 Commits
feat/golan
...
a6a744b45f
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a6a744b45f |
@@ -6,5 +6,6 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
# actions/checkout v4.2.2, 2026-02-22
|
# actions/checkout v4.2.2, 2026-02-22
|
||||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
|
||||||
|
# script/cibuild builds both images; it is the only build
|
||||||
|
# step, so how the repo builds stays defined in script/.
|
||||||
- run: script/cibuild
|
- run: script/cibuild
|
||||||
- run: docker build -f Dockerfile.backend .
|
|
||||||
|
|||||||
12
Dockerfile
12
Dockerfile
@@ -5,10 +5,14 @@ COPY package.json yarn.lock ./
|
|||||||
RUN yarn install --frozen-lockfile
|
RUN yarn install --frozen-lockfile
|
||||||
RUN apk add --no-cache git make
|
RUN apk add --no-cache git make
|
||||||
COPY . .
|
COPY . .
|
||||||
# make check runs script/check (test + lint + fmt-check); its test step
|
# make check-frontend runs script/frontend-check (test + lint +
|
||||||
# is the production yarn build, so this both produces dist/ and gates the
|
# fmt-check for the frontend); its test step is the production yarn
|
||||||
# image on lint/fmt-check/test regressions, not merely a broken build.
|
# build, so this both produces dist/ and gates the image on
|
||||||
RUN make check
|
# lint/fmt-check/test regressions, not merely a broken build. It is the
|
||||||
|
# frontend half of `make check` rather than all of it because this stage
|
||||||
|
# is a node image with no Go toolchain; the backend half is gated by
|
||||||
|
# Dockerfile.backend, and script/cibuild builds both images.
|
||||||
|
RUN make check-frontend
|
||||||
|
|
||||||
# nginx:stable-alpine as of 2026-02-22
|
# nginx:stable-alpine as of 2026-02-22
|
||||||
FROM nginx@sha256:15e96e59aa3b0aada3a121296e3bce117721f42d88f5f64217ef4b18f458c6ab
|
FROM nginx@sha256:15e96e59aa3b0aada3a121296e3bce117721f42d88f5f64217ef4b18f458c6ab
|
||||||
|
|||||||
@@ -3,8 +3,8 @@ FROM golang:1.25-alpine@sha256:f6751d823c26342f9506c03797d2527668d095b0a15f1862c
|
|||||||
|
|
||||||
RUN apk add --no-cache git make gcc musl-dev
|
RUN apk add --no-cache git make gcc musl-dev
|
||||||
|
|
||||||
# golangci-lint v2.12.2 (2026-08-09)
|
# golangci-lint v2.7.2 (2026-02-27)
|
||||||
RUN CGO_ENABLED=0 go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@c0d3ddc9cf3faa61a4e378e879ece580256d76e5
|
RUN CGO_ENABLED=0 go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@9f61b0f53f80672872fced07b6874397c3ed197b
|
||||||
|
|
||||||
WORKDIR /repo/backend
|
WORKDIR /repo/backend
|
||||||
COPY backend/go.mod backend/go.sum ./
|
COPY backend/go.mod backend/go.sum ./
|
||||||
|
|||||||
14
Makefile
14
Makefile
@@ -1,8 +1,10 @@
|
|||||||
.PHONY: bootstrap setup dev test lint fmt fmt-check check docker hooks
|
.PHONY: bootstrap setup dev test lint fmt fmt-check check check-frontend \
|
||||||
|
check-backend docker hooks
|
||||||
|
|
||||||
# Standard targets are thin shims; the implementations live in script/
|
# Standard targets are thin shims; the implementations live in script/
|
||||||
# per the scripts-to-rule-them-all pattern (see the Entrypoints section
|
# per the scripts-to-rule-them-all pattern (see the Entrypoints section
|
||||||
# of README.md).
|
# of README.md). test, lint, fmt, fmt-check and check all cover the
|
||||||
|
# whole repo: the frontend at the root and the Go backend in backend/.
|
||||||
|
|
||||||
bootstrap:
|
bootstrap:
|
||||||
@script/bootstrap
|
@script/bootstrap
|
||||||
@@ -28,6 +30,14 @@ fmt-check:
|
|||||||
check:
|
check:
|
||||||
@script/check
|
@script/check
|
||||||
|
|
||||||
|
# Half-repo gates. Used by the two Dockerfiles, whose build stages only
|
||||||
|
# have the toolchain for their own half; prefer `make check` otherwise.
|
||||||
|
check-frontend:
|
||||||
|
@script/frontend-check
|
||||||
|
|
||||||
|
check-backend:
|
||||||
|
@backend/script/check
|
||||||
|
|
||||||
docker:
|
docker:
|
||||||
@script/docker
|
@script/docker
|
||||||
|
|
||||||
|
|||||||
56
README.md
56
README.md
@@ -28,23 +28,55 @@ docker run -p 8080:8080 netwatch
|
|||||||
This repository adheres to the
|
This repository adheres to the
|
||||||
[Scripts to Rule Them All](https://github.com/github/scripts-to-rule-them-all)
|
[Scripts to Rule Them All](https://github.com/github/scripts-to-rule-them-all)
|
||||||
standard: normalized scripts in `script/` are the entrypoints for the
|
standard: normalized scripts in `script/` are the entrypoints for the
|
||||||
development workflow, and the Makefile targets are thin shims that call them. We
|
development workflow, and the Makefile targets are thin shims that call them.
|
||||||
provide:
|
|
||||||
|
The repo holds two projects: the frontend at the repo root and the Go backend in
|
||||||
|
`backend/`, which has its own `script/` directory and its own shim Makefile. The
|
||||||
|
root scripts cover both, so `make check` at the root fails if either half is
|
||||||
|
broken. We provide:
|
||||||
|
|
||||||
- `script/bootstrap` — install all dependencies (pinned node via nvm if needed,
|
- `script/bootstrap` — install all dependencies (pinned node via nvm if needed,
|
||||||
yarn via corepack, `yarn install --frozen-lockfile`)
|
yarn via corepack, `yarn install --frozen-lockfile`)
|
||||||
- `script/setup` — make a fresh clone ready for development: bootstrap plus the
|
- `script/setup` — make a fresh clone ready for development: bootstrap plus the
|
||||||
git pre-commit hook
|
git pre-commit hook
|
||||||
- `script/projectname` — print the project name (used for the Docker image tag)
|
- `script/projectname` — print the project name (used for the Docker image tags)
|
||||||
- `script/test` — run the production build as the test (no unit tests yet)
|
- `script/test` — run the whole repo's tests: `script/frontend-test`, then
|
||||||
- `script/lint` — run prettier in check mode
|
`backend/script/test`
|
||||||
- `script/fmt` — format all files (writes)
|
- `script/lint` — lint the whole repo: `script/frontend-lint`, then
|
||||||
- `script/fmt-check` — check formatting (read-only)
|
`backend/script/lint`
|
||||||
- `script/check` — run test, lint, and fmt-check
|
- `script/fmt` — format the whole repo (writes): `script/frontend-fmt`, then
|
||||||
- `script/docker` — build the Docker image tagged via `script/projectname`
|
`backend/script/fmt`
|
||||||
- `script/cibuild` — CI entrypoint: plain `docker build .`
|
- `script/fmt-check` — check formatting across the whole repo (read-only)
|
||||||
- `script/precommit` — run by the git pre-commit hook; runs `script/check`
|
- `script/check` — run test, lint, and fmt-check; this is the repo-wide gate
|
||||||
- `script/install-precommit` — install the git pre-commit hook
|
- `script/frontend-test` — the frontend's test: the production build (no unit
|
||||||
|
tests yet)
|
||||||
|
- `script/frontend-lint` — run prettier in check mode
|
||||||
|
- `script/frontend-fmt` — format everything prettier understands (writes)
|
||||||
|
- `script/frontend-fmt-check` — check prettier formatting (read-only)
|
||||||
|
- `script/frontend-check` — the frontend half of `script/check`, used by
|
||||||
|
`Dockerfile`, whose build stage is a node image with no Go toolchain
|
||||||
|
- `script/docker` — build both images, tagged via `script/projectname`:
|
||||||
|
`netwatch` from `Dockerfile` and `netwatch-server` from `Dockerfile.backend`
|
||||||
|
- `script/cibuild` — CI entrypoint: builds both images; the only build step in
|
||||||
|
the Gitea workflow
|
||||||
|
- `script/precommit` — run by the git pre-commit hook; runs `script/check`, so a
|
||||||
|
commit is gated on both halves of the repo
|
||||||
|
- `script/install-precommit` — install the git pre-commit hook; this is the
|
||||||
|
repo's only pre-commit hook installer
|
||||||
|
|
||||||
|
The backend's scripts are shimmed by `backend/Makefile` and are also called by
|
||||||
|
the root scripts above:
|
||||||
|
|
||||||
|
- `backend/script/build` — compile `netwatch-server` with version and
|
||||||
|
architecture stamped in
|
||||||
|
- `backend/script/test` — run the Go tests under a 30-second timeout
|
||||||
|
- `backend/script/lint` — assert `.golangci.yml` still matches its pinned
|
||||||
|
sha256, then run golangci-lint
|
||||||
|
- `backend/script/fmt` — format the Go sources (writes)
|
||||||
|
- `backend/script/fmt-check` — check Go formatting (read-only)
|
||||||
|
- `backend/script/check` — run the backend's test, lint, and fmt-check
|
||||||
|
- `backend/script/run` — build and run the server locally
|
||||||
|
- `backend/script/clean` — remove build artifacts
|
||||||
|
|
||||||
## Rationale
|
## Rationale
|
||||||
|
|
||||||
|
|||||||
38
TODO.md
38
TODO.md
@@ -10,31 +10,28 @@
|
|||||||
|
|
||||||
# Status
|
# Status
|
||||||
|
|
||||||
pre-1.0. No git tags. `feat/reportbuf-storage` is merged; the backend, the CI
|
pre-1.0. No git tags. Backend work in flight on feat/reportbuf-storage (dirty:
|
||||||
workflow, and the backend repo standard files are all on `main`. Frontend and
|
src/main.js). Frontend is functional; backend is new and unmerged.
|
||||||
backend are both functional. Working toward the 1.0.0 milestone by closing the
|
|
||||||
remaining repo-compliance issues on the tracker.
|
|
||||||
|
|
||||||
# Next Step
|
# Next Step
|
||||||
|
|
||||||
Compliance top-up as one small commit: add an `.editorconfig` at the repo root.
|
Land feat/reportbuf-storage: finish the in-progress src/main.js change, get make
|
||||||
`backend/.editorconfig` exists but the root has none. (The `hooks` target this
|
check green, and merge the branch to main. The branch adds the backend (buffered
|
||||||
step used to also name is already present in both the root `Makefile` and
|
zstd-compressed report storage), the CI workflow, and backend repo standard
|
||||||
`backend/Makefile`.)
|
files, so merging it also closes most compliance gaps.
|
||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
- 2026-08-09: adopted the org-standard `backend/.golangci.yml` verbatim and
|
- 2026-08-09: unified the gate: the root `make check` now covers the Go backend
|
||||||
bumped the pinned golangci-lint to v2.12.2; the previous config declared
|
as well as the frontend, the backend moved onto scripts-to-rule-them-all
|
||||||
`version: "2"` but used v1 schema keys, so every threshold in it was inert and
|
(`backend/script/*` with `backend/Makefile` as thin shims), the duplicate
|
||||||
its green result was meaningless. `backend/Makefile`'s `lint` target now
|
pre-commit hook installer in `backend/Makefile` was removed, and
|
||||||
asserts the config's sha256 against the canonical file first, so drift from
|
`script/cibuild` now builds both images as the workflow's only build step
|
||||||
the org standard fails the build instead of silently degrading to defaults
|
|
||||||
- 2026-07-07 Adopted scripts-to-rule-them-all: `script/` entrypoints, Makefile
|
- 2026-07-07 Adopted scripts-to-rule-them-all: `script/` entrypoints, Makefile
|
||||||
shims, README Entrypoints section
|
shims, README Entrypoints section
|
||||||
- 2026-02-27: backend with buffered zstd-compressed report storage; CI workflow
|
- 2026-02-27: backend with buffered zstd-compressed report storage; CI workflow
|
||||||
and backend repo standard files; backend Dockerfile fixed (Go 1.25,
|
and backend repo standard files; backend Dockerfile fixed (Go 1.25,
|
||||||
golangci-lint) and moved to repo root (feat/reportbuf-storage)
|
golangci-lint) and moved to repo root (feat/reportbuf-storage, unmerged)
|
||||||
- 2026-02-26: host row layout redesigned with CSS grid; overflow and spacing
|
- 2026-02-26: host row layout redesigned with CSS grid; overflow and spacing
|
||||||
fixes; nginx config extracted; port hardcoded to 8080
|
fixes; nginx config extracted; port hardcoded to 8080
|
||||||
- 2026-02-26: debug log panel, median stats, recovery probe, Docker build fix,
|
- 2026-02-26: debug log panel, median stats, recovery probe, Docker build fix,
|
||||||
@@ -47,12 +44,9 @@ step used to also name is already present in both the root `Makefile` and
|
|||||||
|
|
||||||
# Future Steps
|
# Future Steps
|
||||||
|
|
||||||
- Confirm `.gitea/workflows/check.yml` is on `main` and CI is green (main always
|
- Compliance top-up as one small commit: add .editorconfig and add the hooks
|
||||||
green policy)
|
target to the Makefile
|
||||||
|
- After merge, confirm .gitea/workflows/check.yml is on main and CI is green
|
||||||
|
(main always green policy)
|
||||||
- Decide what to do with untracked resume.sh: commit it, gitignore it, or delete
|
- Decide what to do with untracked resume.sh: commit it, gitignore it, or delete
|
||||||
it
|
it
|
||||||
- Upstream fix needed in `sneak/prompts`: the org-standard `.golangci.yml`
|
|
||||||
enables `gomodguard`, which golangci-lint v2.12.2 reports as deprecated since
|
|
||||||
v2.12.0 and replaced by `gomodguard_v2`, so every backend lint run prints a
|
|
||||||
deprecation warning. The file is standardized and must never be edited in this
|
|
||||||
repo, so nothing can be done here beyond tracking it
|
|
||||||
|
|||||||
@@ -1,9 +1,5 @@
|
|||||||
version: "2"
|
version: "2"
|
||||||
|
|
||||||
# Config schema uses the golangci-lint v2 layout (settings live under
|
|
||||||
# linters.settings, not top-level linters-settings) so that the
|
|
||||||
# thresholds below are actually applied by golangci-lint >= v2.
|
|
||||||
|
|
||||||
run:
|
run:
|
||||||
timeout: 5m
|
timeout: 5m
|
||||||
modules-download-mode: readonly
|
modules-download-mode: readonly
|
||||||
@@ -18,7 +14,8 @@ linters:
|
|||||||
- wsl # Deprecated, replaced by wsl_v5
|
- wsl # Deprecated, replaced by wsl_v5
|
||||||
- wrapcheck # Too verbose for internal packages
|
- wrapcheck # Too verbose for internal packages
|
||||||
- varnamelen # Short names like db, id are idiomatic Go
|
- varnamelen # Short names like db, id are idiomatic Go
|
||||||
settings:
|
|
||||||
|
linters-settings:
|
||||||
lll:
|
lll:
|
||||||
line-length: 88
|
line-length: 88
|
||||||
funlen:
|
funlen:
|
||||||
@@ -30,5 +27,6 @@ linters:
|
|||||||
threshold: 100
|
threshold: 100
|
||||||
|
|
||||||
issues:
|
issues:
|
||||||
|
exclude-use-default: false
|
||||||
max-issues-per-linter: 0
|
max-issues-per-linter: 0
|
||||||
max-same-issues: 0
|
max-same-issues: 0
|
||||||
|
|||||||
@@ -1,71 +1,38 @@
|
|||||||
UNAME_S := $(shell uname -s)
|
# Standard targets are thin shims; the implementations live in
|
||||||
VERSION := $(shell git describe --always --dirty)
|
# backend/script/ per the scripts-to-rule-them-all pattern (see the
|
||||||
BUILDARCH := $(shell uname -m)
|
# Entrypoints section of README.md).
|
||||||
BINARY := netwatch-server
|
#
|
||||||
|
# There is no `hooks` target here: the repo has exactly one pre-commit
|
||||||
|
# hook installer, the root `script/install-precommit`, and the hook it
|
||||||
|
# installs gates both halves of the repo. There is no `docker` target
|
||||||
|
# either: the backend image is built from Dockerfile.backend with the
|
||||||
|
# repo root as its context, so it belongs to the root `make docker` and
|
||||||
|
# `script/cibuild`.
|
||||||
|
|
||||||
GOLDFLAGS += -X main.Version=$(VERSION)
|
.PHONY: all build test lint fmt fmt-check check run clean
|
||||||
GOLDFLAGS += -X main.Buildarch=$(BUILDARCH)
|
|
||||||
|
|
||||||
ifeq ($(UNAME_S),Darwin)
|
|
||||||
GOFLAGS := -ldflags "$(GOLDFLAGS)"
|
|
||||||
SHA256SUM := shasum -a 256
|
|
||||||
else
|
|
||||||
GOFLAGS = -ldflags "-linkmode external -extldflags -static $(GOLDFLAGS)"
|
|
||||||
SHA256SUM := sha256sum
|
|
||||||
endif
|
|
||||||
|
|
||||||
# .golangci.yml is standardized org-wide and must never be edited here
|
|
||||||
# (REPO_POLICIES.md). Its last silent drift replaced the v2 schema with
|
|
||||||
# v1 keys, which left every threshold in the file inert while the build
|
|
||||||
# stayed green. The lint target therefore asserts the file still matches
|
|
||||||
# the canonical copy byte for byte. The check is a local hash comparison:
|
|
||||||
# no network, no remote schema, nothing unpinned in the build path.
|
|
||||||
GOLANGCI_CONFIG_SHA256 := 021cc83f4e6fc7c31b95b34b846723dfcf20b66b7baeea1dc40406e643346bcb
|
|
||||||
|
|
||||||
.PHONY: all build test lint fmt fmt-check check docker hooks run clean
|
|
||||||
|
|
||||||
all: build
|
all: build
|
||||||
|
|
||||||
build: ./$(BINARY)
|
build:
|
||||||
|
@script/build
|
||||||
./$(BINARY): $(shell find . -name '*.go' -type f) go.mod go.sum
|
|
||||||
go build -o $@ $(GOFLAGS) ./cmd/netwatch-server/
|
|
||||||
|
|
||||||
test:
|
test:
|
||||||
timeout 30 go test ./...
|
@script/test
|
||||||
|
|
||||||
lint:
|
lint:
|
||||||
@actual=$$($(SHA256SUM) .golangci.yml | cut -d' ' -f1); \
|
@script/lint
|
||||||
if [ "$$actual" != "$(GOLANGCI_CONFIG_SHA256)" ]; then \
|
|
||||||
echo ".golangci.yml has drifted from the org standard."; \
|
|
||||||
echo " expected $(GOLANGCI_CONFIG_SHA256)"; \
|
|
||||||
echo " actual $$actual"; \
|
|
||||||
echo "Restore it verbatim from sneak/prompts; do not edit it."; \
|
|
||||||
exit 1; \
|
|
||||||
fi
|
|
||||||
golangci-lint run ./...
|
|
||||||
|
|
||||||
fmt:
|
fmt:
|
||||||
go fmt ./...
|
@script/fmt
|
||||||
|
|
||||||
fmt-check:
|
fmt-check:
|
||||||
@test -z "$$(gofmt -l .)" || \
|
@script/fmt-check
|
||||||
(echo "Files not formatted:"; gofmt -l .; exit 1)
|
|
||||||
|
|
||||||
check: test lint fmt-check
|
check:
|
||||||
|
@script/check
|
||||||
|
|
||||||
docker:
|
run:
|
||||||
timeout 300 docker build -t netwatch-server -f ../Dockerfile.backend ..
|
@script/run
|
||||||
|
|
||||||
hooks:
|
|
||||||
@printf '#!/bin/sh\ncd backend && make check\n' > \
|
|
||||||
$$(git rev-parse --show-toplevel)/.git/hooks/pre-commit
|
|
||||||
@chmod +x \
|
|
||||||
$$(git rev-parse --show-toplevel)/.git/hooks/pre-commit
|
|
||||||
@echo "Pre-commit hook installed"
|
|
||||||
|
|
||||||
run: build
|
|
||||||
./$(BINARY)
|
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
rm -f ./$(BINARY)
|
@script/clean
|
||||||
|
|||||||
@@ -11,11 +11,38 @@ make run
|
|||||||
# Run tests, lint, and format check
|
# Run tests, lint, and format check
|
||||||
make check
|
make check
|
||||||
|
|
||||||
# Docker
|
# Docker (from the repo root; the image's build context is the repo root)
|
||||||
docker build -t netwatch-server .
|
make docker
|
||||||
docker run -p 8080:8080 netwatch-server
|
docker run -p 8080:8080 netwatch-server
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Entrypoints
|
||||||
|
|
||||||
|
This project follows the same
|
||||||
|
[Scripts to Rule Them All](https://github.com/github/scripts-to-rule-them-all)
|
||||||
|
pattern as the repo root: the implementations live in `backend/script/` and the
|
||||||
|
targets in `backend/Makefile` are thin shims that call them. The repo root's
|
||||||
|
`script/test`, `script/lint`, `script/fmt` and `script/fmt-check` call these
|
||||||
|
too, so the root `make check` covers the backend.
|
||||||
|
|
||||||
|
- `script/build` — compile `netwatch-server` with the version and architecture
|
||||||
|
stamped in via ldflags (statically linked on Linux)
|
||||||
|
- `script/test` — run the Go tests under a 30-second timeout
|
||||||
|
- `script/lint` — assert `.golangci.yml` still matches its pinned sha256, then
|
||||||
|
run golangci-lint
|
||||||
|
- `script/fmt` — format the Go sources (writes)
|
||||||
|
- `script/fmt-check` — check Go formatting (read-only)
|
||||||
|
- `script/check` — run test, lint, and fmt-check
|
||||||
|
- `script/run` — build and run the server locally
|
||||||
|
- `script/clean` — remove build artifacts
|
||||||
|
|
||||||
|
There is deliberately no `hooks` target here: the repo has exactly one
|
||||||
|
pre-commit hook installer, the root `script/install-precommit`, and the hook it
|
||||||
|
installs runs the root `script/check`, which gates both halves of the repo.
|
||||||
|
There is no `docker` target either: `Dockerfile.backend` lives at the repo root
|
||||||
|
and builds with the repo root as its context, so the backend image is built by
|
||||||
|
the root `make docker` and by `script/cibuild`.
|
||||||
|
|
||||||
## Rationale
|
## Rationale
|
||||||
|
|
||||||
The NetWatch frontend collects latency measurements from the browser but has no
|
The NetWatch frontend collects latency measurements from the browser but has no
|
||||||
|
|||||||
@@ -163,9 +163,7 @@ func (b *Buffer) writeFile(data []byte) {
|
|||||||
name := fmt.Sprintf("reports-%s.jsonl.zst", ts)
|
name := fmt.Sprintf("reports-%s.jsonl.zst", ts)
|
||||||
path := filepath.Join(b.dataDir, name)
|
path := filepath.Join(b.dataDir, name)
|
||||||
|
|
||||||
// path is built from the operator-supplied dataDir plus a
|
f, err := os.OpenFile( //nolint:gosec // path built from controlled dataDir + timestamp
|
||||||
// generated timestamp, so it carries no external input.
|
|
||||||
f, err := os.OpenFile( //nolint:gosec // see comment above
|
|
||||||
path,
|
path,
|
||||||
os.O_WRONLY|os.O_CREATE|os.O_EXCL,
|
os.O_WRONLY|os.O_CREATE|os.O_EXCL,
|
||||||
filePerms,
|
filePerms,
|
||||||
|
|||||||
@@ -62,10 +62,7 @@ func New(
|
|||||||
OnStart: func(_ context.Context) error {
|
OnStart: func(_ context.Context) error {
|
||||||
s.startupTime = time.Now().UTC()
|
s.startupTime = time.Now().UTC()
|
||||||
|
|
||||||
// The fx OnStart context is scoped to startup and is
|
go func() { //nolint:contextcheck // fx OnStart ctx is startup-only; run() creates its own
|
||||||
// cancelled once the hook returns; run() derives its
|
|
||||||
// own context instead of inheriting this one.
|
|
||||||
go func() { //nolint:contextcheck // see comment above
|
|
||||||
s.run()
|
s.run()
|
||||||
}()
|
}()
|
||||||
|
|
||||||
@@ -97,7 +94,7 @@ func (s *Server) run() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (s *Server) serve() int {
|
func (s *Server) serve() int {
|
||||||
var ctx context.Context
|
var ctx context.Context //nolint:wsl // ctx must be declared before multi-assign
|
||||||
|
|
||||||
ctx, s.cancelFunc = context.WithCancel(
|
ctx, s.cancelFunc = context.WithCancel(
|
||||||
context.Background(),
|
context.Background(),
|
||||||
|
|||||||
27
backend/script/build
Executable file
27
backend/script/build
Executable file
@@ -0,0 +1,27 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# script/build: compile the netwatch-server binary into the backend
|
||||||
|
# project root. Version and architecture are stamped into the binary via
|
||||||
|
# ldflags; on Linux the binary is statically linked.
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
|
BINARY="netwatch-server"
|
||||||
|
|
||||||
|
main() {
|
||||||
|
cd "$ROOT"
|
||||||
|
|
||||||
|
# git describe fails outside a working repo (e.g. a source tarball),
|
||||||
|
# which must not abort the build.
|
||||||
|
version="$(git describe --always --dirty 2>/dev/null || echo unknown)"
|
||||||
|
buildarch="$(uname -m)"
|
||||||
|
|
||||||
|
ldflags="-X main.Version=$version -X main.Buildarch=$buildarch"
|
||||||
|
if [ "$(uname -s)" != "Darwin" ]; then
|
||||||
|
ldflags="-linkmode external -extldflags -static $ldflags"
|
||||||
|
fi
|
||||||
|
|
||||||
|
go build -o "$BINARY" -ldflags "$ldflags" ./cmd/netwatch-server/
|
||||||
|
}
|
||||||
|
|
||||||
|
main "$@"
|
||||||
15
backend/script/check
Executable file
15
backend/script/check
Executable file
@@ -0,0 +1,15 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# script/check: run all backend checks (test, lint, fmt-check). Must not
|
||||||
|
# modify any files. The root script/check calls this, so the repo-wide
|
||||||
|
# gate covers the backend.
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
|
|
||||||
|
main() {
|
||||||
|
"$SCRIPT_DIR/test"
|
||||||
|
"$SCRIPT_DIR/lint"
|
||||||
|
"$SCRIPT_DIR/fmt-check"
|
||||||
|
}
|
||||||
|
|
||||||
|
main "$@"
|
||||||
12
backend/script/clean
Executable file
12
backend/script/clean
Executable file
@@ -0,0 +1,12 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# script/clean: remove build artifacts.
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
|
main() {
|
||||||
|
cd "$ROOT"
|
||||||
|
rm -f netwatch-server
|
||||||
|
}
|
||||||
|
|
||||||
|
main "$@"
|
||||||
12
backend/script/fmt
Executable file
12
backend/script/fmt
Executable file
@@ -0,0 +1,12 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# script/fmt: format all Go sources in the backend (writes).
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
|
main() {
|
||||||
|
cd "$ROOT"
|
||||||
|
go fmt ./...
|
||||||
|
}
|
||||||
|
|
||||||
|
main "$@"
|
||||||
18
backend/script/fmt-check
Executable file
18
backend/script/fmt-check
Executable file
@@ -0,0 +1,18 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# script/fmt-check: check Go formatting (read-only). Same scope as
|
||||||
|
# script/fmt, but fails instead of writing.
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
|
main() {
|
||||||
|
cd "$ROOT"
|
||||||
|
unformatted="$(gofmt -l .)"
|
||||||
|
if [ -n "$unformatted" ]; then
|
||||||
|
echo "Files not formatted:"
|
||||||
|
echo "$unformatted"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
main "$@"
|
||||||
46
backend/script/lint
Executable file
46
backend/script/lint
Executable file
@@ -0,0 +1,46 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# script/lint: run the Go linter over the backend.
|
||||||
|
#
|
||||||
|
# .golangci.yml is standardized org-wide and must never be edited here
|
||||||
|
# (REPO_POLICIES.md). Its last silent drift replaced the v2 schema with
|
||||||
|
# v1 keys, which left every threshold in the file inert while the build
|
||||||
|
# stayed green. This script therefore asserts the file still matches the
|
||||||
|
# pinned copy byte for byte before the linter runs. The check is a local
|
||||||
|
# hash comparison: no network, no remote schema, nothing unpinned in the
|
||||||
|
# build path.
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
|
# sha256 of the pinned backend/.golangci.yml.
|
||||||
|
GOLANGCI_CONFIG_SHA256="33ba2bf7fe4a44779d09b0fb31d6daf03685f8dc9d2bc417f963d7aabb0d17dc"
|
||||||
|
|
||||||
|
# sha256 <file>: print the file's sha256, coreutils or Darwin/busybox.
|
||||||
|
sha256() {
|
||||||
|
if command -v sha256sum >/dev/null 2>&1; then
|
||||||
|
sha256sum "$1" | cut -d' ' -f1
|
||||||
|
else
|
||||||
|
shasum -a 256 "$1" | cut -d' ' -f1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
check_config_hash() {
|
||||||
|
actual="$(sha256 .golangci.yml)"
|
||||||
|
if [ "$actual" != "$GOLANGCI_CONFIG_SHA256" ]; then
|
||||||
|
echo ".golangci.yml has drifted from the pinned config."
|
||||||
|
echo " expected $GOLANGCI_CONFIG_SHA256"
|
||||||
|
echo " actual $actual"
|
||||||
|
echo "Restore it verbatim from sneak/prompts; do not edit it."
|
||||||
|
echo "Only update GOLANGCI_CONFIG_SHA256 in this script when the"
|
||||||
|
echo "pinned config is deliberately replaced with a new standard."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
main() {
|
||||||
|
cd "$ROOT"
|
||||||
|
check_config_hash
|
||||||
|
golangci-lint run ./...
|
||||||
|
}
|
||||||
|
|
||||||
|
main "$@"
|
||||||
14
backend/script/run
Executable file
14
backend/script/run
Executable file
@@ -0,0 +1,14 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# script/run: build and run netwatch-server locally.
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
|
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
||||||
|
|
||||||
|
main() {
|
||||||
|
"$SCRIPT_DIR/build"
|
||||||
|
cd "$ROOT"
|
||||||
|
exec ./netwatch-server "$@"
|
||||||
|
}
|
||||||
|
|
||||||
|
main "$@"
|
||||||
12
backend/script/test
Executable file
12
backend/script/test
Executable file
@@ -0,0 +1,12 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# script/test: run the backend test suite.
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
|
main() {
|
||||||
|
cd "$ROOT"
|
||||||
|
timeout 30 go test ./...
|
||||||
|
}
|
||||||
|
|
||||||
|
main "$@"
|
||||||
@@ -1,6 +1,7 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/check: run all checks (test, lint, fmt-check). Our own
|
# script/check: run all checks (test, lint, fmt-check) across the whole
|
||||||
# extension to scripts-to-rule-them-all. Must not modify any files.
|
# repo, frontend and backend. Our own extension to
|
||||||
|
# scripts-to-rule-them-all. Must not modify any files.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
|
|||||||
@@ -1,13 +1,24 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/cibuild: run the CI build. The Dockerfile runs make check, so
|
# script/cibuild: run the CI build. It builds every image in the repo:
|
||||||
# a successful build implies all checks pass.
|
# the frontend image from Dockerfile and the backend image from
|
||||||
|
# Dockerfile.backend. Each Dockerfile runs its half of make check as a
|
||||||
|
# build step, so a successful cibuild implies the whole repo is green.
|
||||||
|
# This is the only build step the Gitea workflow runs.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
|
# build_image <dockerfile>: build one image from the repo root context.
|
||||||
|
# Every docker build CI performs goes through here, so build-wide flags
|
||||||
|
# only ever have to be added in one place.
|
||||||
|
build_image() {
|
||||||
|
timeout 300 docker build -f "$1" .
|
||||||
|
}
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
docker build .
|
build_image Dockerfile
|
||||||
|
build_image Dockerfile.backend
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/docker: build the Docker image tagged with the project name.
|
# script/docker: build the repo's Docker images, tagged from
|
||||||
# The tag comes from script/projectname.
|
# script/projectname: the frontend image as <name> and the backend image
|
||||||
|
# as <name>-server. Both build from the repo root as their context.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
@@ -8,7 +9,9 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
|||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
timeout 300 docker build -t "$("$SCRIPT_DIR/projectname")" .
|
name="$("$SCRIPT_DIR/projectname")"
|
||||||
|
timeout 300 docker build -t "$name" -f Dockerfile .
|
||||||
|
timeout 300 docker build -t "$name-server" -f Dockerfile.backend .
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
@@ -1,12 +1,14 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/fmt: format all files (writes).
|
# script/fmt: format the whole repo (writes): prettier over everything
|
||||||
|
# it understands, then gofmt over the Go backend.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
yarn prettier --write .
|
"$ROOT/script/frontend-fmt"
|
||||||
|
"$ROOT/backend/script/fmt"
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
@@ -1,13 +1,14 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/fmt-check: check formatting (read-only). Same scope as
|
# script/fmt-check: check formatting across the whole repo (read-only).
|
||||||
# script/fmt, but fails instead of writing.
|
# Same scope as script/fmt, but fails instead of writing.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
yarn prettier --check .
|
"$ROOT/script/frontend-fmt-check"
|
||||||
|
"$ROOT/backend/script/fmt-check"
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
17
script/frontend-check
Executable file
17
script/frontend-check
Executable file
@@ -0,0 +1,17 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# script/frontend-check: run the frontend half of the checks only (test,
|
||||||
|
# lint, fmt-check). This exists for the frontend Dockerfile, whose build
|
||||||
|
# stage is a node image with no Go toolchain; the backend half is gated
|
||||||
|
# by Dockerfile.backend. Everywhere else, use script/check, which covers
|
||||||
|
# the whole repo. Must not modify any files.
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
|
|
||||||
|
main() {
|
||||||
|
"$SCRIPT_DIR/frontend-test"
|
||||||
|
"$SCRIPT_DIR/frontend-lint"
|
||||||
|
"$SCRIPT_DIR/frontend-fmt-check"
|
||||||
|
}
|
||||||
|
|
||||||
|
main "$@"
|
||||||
14
script/frontend-fmt
Executable file
14
script/frontend-fmt
Executable file
@@ -0,0 +1,14 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# script/frontend-fmt: format the frontend and every other file prettier
|
||||||
|
# understands, repo-wide (writes). backend/ is in .prettierignore; Go
|
||||||
|
# sources are formatted by backend/script/fmt.
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
|
main() {
|
||||||
|
cd "$ROOT"
|
||||||
|
yarn prettier --write .
|
||||||
|
}
|
||||||
|
|
||||||
|
main "$@"
|
||||||
13
script/frontend-fmt-check
Executable file
13
script/frontend-fmt-check
Executable file
@@ -0,0 +1,13 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# script/frontend-fmt-check: check prettier formatting (read-only). Same
|
||||||
|
# scope as script/frontend-fmt, but fails instead of writing.
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
|
main() {
|
||||||
|
cd "$ROOT"
|
||||||
|
yarn prettier --check .
|
||||||
|
}
|
||||||
|
|
||||||
|
main "$@"
|
||||||
12
script/frontend-lint
Executable file
12
script/frontend-lint
Executable file
@@ -0,0 +1,12 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# script/frontend-lint: run the frontend linter (prettier in check mode).
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
|
main() {
|
||||||
|
cd "$ROOT"
|
||||||
|
yarn prettier --check .
|
||||||
|
}
|
||||||
|
|
||||||
|
main "$@"
|
||||||
14
script/frontend-test
Executable file
14
script/frontend-test
Executable file
@@ -0,0 +1,14 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# script/frontend-test: run the frontend test suite. The frontend has no
|
||||||
|
# unit tests; the production build serves as the test (fails on broken
|
||||||
|
# code).
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
|
main() {
|
||||||
|
cd "$ROOT"
|
||||||
|
timeout 30 yarn build
|
||||||
|
}
|
||||||
|
|
||||||
|
main "$@"
|
||||||
@@ -1,12 +1,14 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/lint: run the linter (prettier in check mode).
|
# script/lint: lint the whole repo: prettier over everything it
|
||||||
|
# understands, then golangci-lint over the Go backend.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
yarn prettier --check .
|
"$ROOT/script/frontend-lint"
|
||||||
|
"$ROOT/backend/script/lint"
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
@@ -1,13 +1,14 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/test: run the test suite. This repo has no unit tests; the
|
# script/test: run the test suite for the whole repo: the frontend at
|
||||||
# production build serves as the test (fails on broken code).
|
# the repo root, then the Go backend in backend/.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
timeout 30 yarn build
|
"$ROOT/script/frontend-test"
|
||||||
|
"$ROOT/backend/script/test"
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
Reference in New Issue
Block a user