Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3ed9a57822
|
||
|
|
0601098ab0
|
||
|
|
49c7da2381
|
||
|
|
794ea6541f
|
||
|
|
ba037c5958
|
||
|
|
1e97c80f6b
|
||
|
|
5b3d1cd65c
|
||
|
|
50b8fd5c61
|
||
|
|
efbe355070
|
||
|
|
fc60214b3e
|
||
|
|
3c794b645b
|
+97
-206
@@ -48,8 +48,9 @@ env:
|
|||||||
# version to exist in the tag and in build.zig.zon and nowhere else, and
|
# version to exist in the tag and in build.zig.zon and nowhere else, and
|
||||||
# ruling 5 makes verify-dist fail when the version under build disagrees with
|
# ruling 5 makes verify-dist fail when the version under build disagrees with
|
||||||
# build.zig.zon. An invented CI string such as "0.0.0-ci" therefore cannot
|
# build.zig.zon. An invented CI string such as "0.0.0-ci" therefore cannot
|
||||||
# pass this file's own packaging gate. The package and container jobs read
|
# pass this file's own packaging gate. The package job reads the version out
|
||||||
# the version out of build.zig.zon instead.
|
# of build.zig.zon instead, and the container job takes it from that job's
|
||||||
|
# output.
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
test:
|
test:
|
||||||
@@ -118,39 +119,39 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
node-version: ${{ env.NODE_VERSION }}
|
node-version: ${{ env.NODE_VERSION }}
|
||||||
cache: npm
|
cache: npm
|
||||||
cache-dependency-path: web/package-lock.json
|
cache-dependency-path: admin/package-lock.json
|
||||||
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
working-directory: web
|
working-directory: admin
|
||||||
run: npm ci
|
run: npm ci
|
||||||
|
|
||||||
- name: Check formatting
|
- name: Check formatting
|
||||||
working-directory: web
|
working-directory: admin
|
||||||
run: npm run format:check
|
run: npm run format:check
|
||||||
|
|
||||||
- name: Lint
|
- name: Lint
|
||||||
working-directory: web
|
working-directory: admin
|
||||||
run: npm run lint
|
run: npm run lint
|
||||||
|
|
||||||
- name: Typecheck
|
- name: Typecheck
|
||||||
working-directory: web
|
working-directory: admin
|
||||||
run: npm run typecheck
|
run: npm run typecheck
|
||||||
|
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
working-directory: web
|
working-directory: admin
|
||||||
run: npm test
|
run: npm test
|
||||||
|
|
||||||
- name: Build
|
- name: Build
|
||||||
working-directory: web
|
working-directory: admin
|
||||||
run: npm run build
|
run: npm run build
|
||||||
|
|
||||||
# The licence inventory has to cover every package whose bytes ship, and
|
# The licence inventory has to cover every package whose bytes ship, and
|
||||||
# the lockfile does not answer that question: it lists what could be
|
# the lockfile does not answer that question: it lists what could be
|
||||||
# reached, not what rollup kept. The bundle is what this reads. The logic
|
# reached, not what rollup kept. The bundle is what this reads. The logic
|
||||||
# lives in web/scripts/, unit-tested by `npm test`, so it runs on a laptop
|
# lives in admin/scripts/, unit-tested by `npm test`, so it runs on a laptop
|
||||||
# exactly as it runs here (milestone-14 deviation 24).
|
# exactly as it runs here (milestone-14 deviation 24).
|
||||||
- name: Assert the packages bundled into web/dist are the recorded ones
|
- name: Assert the packages bundled into admin/dist are the recorded ones
|
||||||
working-directory: web
|
working-directory: admin
|
||||||
run: npm run assert-bundled
|
run: npm run assert-bundled
|
||||||
|
|
||||||
# The package and container jobs consume this bundle instead of building
|
# The package and container jobs consume this bundle instead of building
|
||||||
@@ -163,22 +164,27 @@ jobs:
|
|||||||
#
|
#
|
||||||
# A later move to v4 has to add `include-hidden-files: true` here.
|
# A later move to v4 has to add `include-hidden-files: true` here.
|
||||||
# `npm run build` writes the freshness stamp to the hidden file
|
# `npm run build` writes the freshness stamp to the hidden file
|
||||||
# web/dist/.src-hash (milestone-15 ruling 5), and v4.4.0 and later drop
|
# admin/dist/.src-hash (milestone-15 ruling 5), and v4.4.0 and later drop
|
||||||
# dotfiles by default. It is inactive today — v3 keeps them, and the
|
# dotfiles by default. It is inactive today — v3 keeps them, and the
|
||||||
# package job's target path skips the stamp check regardless — but a move
|
# package job's target path skips the stamp check regardless — but a move
|
||||||
# to v4 that also pointed the download back at web/dist would fail with
|
# to v4 that also pointed the download back at admin/dist would fail with
|
||||||
# "web/dist is stale".
|
# "admin/dist is stale".
|
||||||
- name: Upload the built web UI
|
- name: Upload the built web UI
|
||||||
uses: actions/upload-artifact@c24449f33cd45d4826c6702db7e49f7cdb9b551d # v3.2.1-node20
|
uses: actions/upload-artifact@c24449f33cd45d4826c6702db7e49f7cdb9b551d # v3.2.1-node20
|
||||||
with:
|
with:
|
||||||
name: web-dist
|
name: admin-dist
|
||||||
path: web/dist
|
path: admin/dist
|
||||||
if-no-files-found: error
|
if-no-files-found: error
|
||||||
|
|
||||||
package:
|
package:
|
||||||
needs: [frontend]
|
needs: [frontend]
|
||||||
runs-on: ubuntu-24.04
|
runs-on: ubuntu-24.04
|
||||||
|
|
||||||
|
# The container job needs the version and installs no Zig, so it cannot read
|
||||||
|
# build.zig.zon the way this job does.
|
||||||
|
outputs:
|
||||||
|
version: ${{ steps.zon-version.outputs.version }}
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0
|
- uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0
|
||||||
|
|
||||||
@@ -195,32 +201,37 @@ jobs:
|
|||||||
- name: Create the fetch temp dir zig assumes
|
- name: Create the fetch temp dir zig assumes
|
||||||
run: mkdir -p "${ZIG_GLOBAL_CACHE_DIR:?}/tmp"
|
run: mkdir -p "${ZIG_GLOBAL_CACHE_DIR:?}/tmp"
|
||||||
|
|
||||||
# `dist` refuses web/dist-placeholder (ruling 4), so a real bundle has to
|
# `dist` refuses admin/dist-placeholder (ruling 4), so a real bundle has to
|
||||||
# exist before the packaging gate runs. It arrives from the frontend job,
|
# exist before the packaging gate runs. It arrives from the frontend job,
|
||||||
# already formatted, linted, typechecked, tested and licence-checked.
|
# already formatted, linted, typechecked, tested and licence-checked.
|
||||||
#
|
#
|
||||||
# The target is deliberately not `web/dist`: build.zig runs the freshness
|
# The target is deliberately not `admin/dist`: build.zig runs the freshness
|
||||||
# stamp check for that exact path and no other (milestone-15 ruling 5),
|
# stamp check for that exact path and no other (milestone-15 ruling 5),
|
||||||
# and the check shells out to `node`. Here it would buy nothing — the
|
# and the check shells out to `node`. Here it would buy nothing — the
|
||||||
# stamp hashes the web/ sources, not the bundle, so against a checkout of
|
# stamp hashes the admin/ sources, not the bundle, so against a checkout of
|
||||||
# the same commit that built the bundle it can only agree. An explicit
|
# the same commit that built the bundle it can only agree. An explicit
|
||||||
# path is the case build.zig documents for a bundle built elsewhere, and
|
# path is the case build.zig documents for a bundle built elsewhere, and
|
||||||
# taking it keeps node out of this job entirely.
|
# taking it keeps node out of this job entirely.
|
||||||
- name: Download the web UI built by the frontend job
|
- name: Download the web UI built by the frontend job
|
||||||
uses: actions/download-artifact@ad191675b41f6a5b46da9a048cb6893812da158b # v3.1.0-node20
|
uses: actions/download-artifact@ad191675b41f6a5b46da9a048cb6893812da158b # v3.1.0-node20
|
||||||
with:
|
with:
|
||||||
name: web-dist
|
name: admin-dist
|
||||||
path: web-dist-ci
|
path: admin-dist-ci
|
||||||
|
|
||||||
# Ruling 2: build.zig.zon is the only place besides the tag that carries
|
# Ruling 2: build.zig.zon is the only place besides the tag that carries
|
||||||
# the version, and ruling 5 makes verify-dist assert the two agree. The
|
# the version, and ruling 5 makes verify-dist assert the two agree. The
|
||||||
# gate builds the version the repository declares.
|
# gate builds the version the repository declares.
|
||||||
|
#
|
||||||
|
# This is the only job that reads it. The container job used to run its own
|
||||||
|
# `sed` over the same file; it now receives this step's output, so the two
|
||||||
|
# jobs cannot disagree about what the repository declares. The parse itself
|
||||||
|
# matches verify-dist's, through the zon grammar rather than a regex.
|
||||||
|
- name: Build the container gate tool
|
||||||
|
run: zig build container-check-tool
|
||||||
|
|
||||||
- name: Read the version from build.zig.zon
|
- name: Read the version from build.zig.zon
|
||||||
run: |
|
id: zon-version
|
||||||
set -euo pipefail
|
run: ./zig-out/bin/container_check version
|
||||||
version=$(sed -n 's/^[[:space:]]*\.version[[:space:]]*=[[:space:]]*"\([^"]*\)".*/\1/p' build.zig.zon | head -1)
|
|
||||||
test -n "$version"
|
|
||||||
echo "CI_VERSION=$version" >> "$GITHUB_ENV"
|
|
||||||
|
|
||||||
- name: Build the release artifacts
|
- name: Build the release artifacts
|
||||||
run: |
|
run: |
|
||||||
@@ -228,7 +239,7 @@ jobs:
|
|||||||
zig build dist \
|
zig build dist \
|
||||||
-Dversion-string="$CI_VERSION" \
|
-Dversion-string="$CI_VERSION" \
|
||||||
-Dgit-commit="$GITHUB_SHA" \
|
-Dgit-commit="$GITHUB_SHA" \
|
||||||
-Dweb-dist=web-dist-ci \
|
-Dadmin-dist=admin-dist-ci \
|
||||||
-Doptimize=ReleaseSafe
|
-Doptimize=ReleaseSafe
|
||||||
|
|
||||||
# verify-dist owns every assert the CI shell used to make: ELF static
|
# verify-dist owns every assert the CI shell used to make: ELF static
|
||||||
@@ -244,7 +255,7 @@ jobs:
|
|||||||
zig build verify-dist \
|
zig build verify-dist \
|
||||||
-Dversion-string="$CI_VERSION" \
|
-Dversion-string="$CI_VERSION" \
|
||||||
-Dgit-commit="$GITHUB_SHA" \
|
-Dgit-commit="$GITHUB_SHA" \
|
||||||
-Dweb-dist=web-dist-ci \
|
-Dadmin-dist=admin-dist-ci \
|
||||||
-Doptimize=ReleaseSafe
|
-Doptimize=ReleaseSafe
|
||||||
|
|
||||||
# deploy/docker/Dockerfile copies both of these trees and nothing else
|
# deploy/docker/Dockerfile copies both of these trees and nothing else
|
||||||
@@ -257,7 +268,13 @@ jobs:
|
|||||||
# The zip round-trip drops the executable bit. That is survivable only
|
# The zip round-trip drops the executable bit. That is survivable only
|
||||||
# because the Dockerfile chmods the binary itself and the contents
|
# because the Dockerfile chmods the binary itself and the contents
|
||||||
# assertion compares sha256 of file contents, never modes. The archive
|
# assertion compares sha256 of file contents, never modes. The archive
|
||||||
# modes are asserted by verify-dist, above, on the originals.
|
# modes are asserted by verify-dist, above, on the originals. The gate tool
|
||||||
|
# rides along in the same artifact and the container job chmods it back.
|
||||||
|
#
|
||||||
|
# Adding zig-out/bin/container_check moves the artifact's common root from
|
||||||
|
# zig-out/dist up to zig-out, which is why the container job restores into
|
||||||
|
# zig-out rather than zig-out/dist. The Dockerfile's COPY paths still
|
||||||
|
# resolve; they are relative to the repository root either way.
|
||||||
- name: Upload the staged payload for the container job
|
- name: Upload the staged payload for the container job
|
||||||
uses: actions/upload-artifact@c24449f33cd45d4826c6702db7e49f7cdb9b551d # v3.2.1-node20
|
uses: actions/upload-artifact@c24449f33cd45d4826c6702db7e49f7cdb9b551d # v3.2.1-node20
|
||||||
with:
|
with:
|
||||||
@@ -265,201 +282,69 @@ jobs:
|
|||||||
path: |
|
path: |
|
||||||
zig-out/dist/bin
|
zig-out/dist/bin
|
||||||
zig-out/dist/stage
|
zig-out/dist/stage
|
||||||
|
zig-out/bin/container_check
|
||||||
if-no-files-found: error
|
if-no-files-found: error
|
||||||
|
|
||||||
container:
|
container:
|
||||||
needs: [package]
|
needs: [package]
|
||||||
runs-on: ubuntu-24.04
|
runs-on: ubuntu-24.04
|
||||||
|
|
||||||
|
env:
|
||||||
|
# Ruling 2 and ruling 5: one parse of build.zig.zon per run, done in the
|
||||||
|
# package job. This job installs no Zig and cannot repeat it.
|
||||||
|
CI_VERSION: ${{ needs.package.outputs.version }}
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0
|
- uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0
|
||||||
|
|
||||||
# Restored under zig-out/dist because that is where the Dockerfile's
|
# Restored under zig-out because that is where the Dockerfile's COPY lines
|
||||||
# COPY lines look, with the repository root as the build context. This
|
# look for dist/, with the repository root as the build context, and
|
||||||
# job compiles nothing and bundles nothing: the payload is the one the
|
# because the payload also carries bin/container_check. This job compiles
|
||||||
# package job already built and verify-dist already checked, which is
|
# nothing and bundles nothing: the payload is the one the package job
|
||||||
# also the point — an image built from a second, independent `dist` run
|
# already built and verify-dist already checked, which is also the point —
|
||||||
# would prove nothing about the artifacts the release publishes.
|
# an image built from a second, independent `dist` run would prove nothing
|
||||||
|
# about the artifacts the release publishes.
|
||||||
- name: Download the staged payload built by the package job
|
- name: Download the staged payload built by the package job
|
||||||
uses: actions/download-artifact@ad191675b41f6a5b46da9a048cb6893812da158b # v3.1.0-node20
|
uses: actions/download-artifact@ad191675b41f6a5b46da9a048cb6893812da158b # v3.1.0-node20
|
||||||
with:
|
with:
|
||||||
name: dist-payload
|
name: dist-payload
|
||||||
path: zig-out/dist
|
path: zig-out
|
||||||
|
|
||||||
# Same single source of truth as the package job (rulings 2 and 5). This
|
# The artifact zip carries no modes.
|
||||||
# job still needs the version for the stage directory name it hashes
|
- name: Restore the gate tool's executable bit
|
||||||
# against the image and for the VERSION build arg.
|
run: chmod +x zig-out/bin/container_check
|
||||||
- name: Read the version from build.zig.zon
|
|
||||||
run: |
|
|
||||||
set -euo pipefail
|
|
||||||
version=$(sed -n 's/^[[:space:]]*\.version[[:space:]]*=[[:space:]]*"\([^"]*\)".*/\1/p' build.zig.zon | head -1)
|
|
||||||
test -n "$version"
|
|
||||||
echo "CI_VERSION=$version" >> "$GITHUB_ENV"
|
|
||||||
|
|
||||||
# Image tags, container names and published host ports are all
|
# Everything this gate decides — this run's docker object names, the
|
||||||
# daemon-global. This workflow is called by both ci.yml and release.yml
|
# ownership label, the image build, the contents assertion against the
|
||||||
# and the self-hosted runners share one docker daemon, so the fixed
|
# staged payload, and the smoke test with its topology detection and its
|
||||||
# `nxdns:ci` and `nxdns-smoke` made two concurrent runs collide: the
|
# absolute probe deadline — lives in tools/container_check.zig, along with
|
||||||
# second `docker create --name` fails outright, and worse, whichever run
|
# the rationale comments that used to sit in this file. That is the same
|
||||||
# finishes first deletes the other's container mid-test. The names below
|
# move release.yml made (milestone-14 deviation 24): logic in a `run:`
|
||||||
# carry the run identity plus four random bytes — the run id alone is not
|
# block cannot be type-checked, run on a laptop, or covered by a test.
|
||||||
# enough, because two *repositories* on the same daemon can issue the
|
- name: Run the container acceptance gate
|
||||||
# same one. The published port becomes ephemeral for the same reason.
|
run: ./zig-out/bin/container_check gate
|
||||||
- name: Name this run's docker objects
|
|
||||||
run: |
|
|
||||||
set -euo pipefail
|
|
||||||
rand=$(head -c 4 /dev/urandom | od -An -tx1 | tr -d ' \n')
|
|
||||||
suffix="${GITHUB_RUN_ID:-0}-${GITHUB_RUN_ATTEMPT:-1}-$rand"
|
|
||||||
{
|
|
||||||
echo "CI_IMAGE=nxdns:ci-$suffix"
|
|
||||||
echo "SMOKE_NAME=nxdns-smoke-$suffix"
|
|
||||||
} >> "$GITHUB_ENV"
|
|
||||||
echo "image nxdns:ci-$suffix, container nxdns-smoke-$suffix"
|
|
||||||
|
|
||||||
# The build args carry the OCI label values (ruling 6); release.yml
|
# The gate removes its own container and image on every exit path it
|
||||||
# passes the same three and then asserts the resulting
|
# survives. This step is the exit path for a cancelled job and for a step
|
||||||
# org.opencontainers.image.version label. BuildKit is not optional here:
|
# that died before the gate's own defers ran — on a long-lived self-hosted
|
||||||
# the builder stage is pinned to $BUILDPLATFORM, which the classic
|
# daemon those accumulate one layer set per run. The name pair only exists
|
||||||
# builder does not define, so DOCKER_BUILDKIT=0 fails at the first FROM.
|
# if the gate got as far as writing $GITHUB_ENV, so the label sweep covers
|
||||||
- name: Build the image
|
# the rest of this run.
|
||||||
env:
|
|
||||||
DOCKER_BUILDKIT: "1"
|
|
||||||
run: |
|
|
||||||
set -euo pipefail
|
|
||||||
docker build -t "$CI_IMAGE" -f deploy/docker/Dockerfile \
|
|
||||||
--build-arg VERSION="$CI_VERSION" \
|
|
||||||
--build-arg REVISION="$GITHUB_SHA" \
|
|
||||||
--build-arg CREATED="1970-01-01T00:00:00Z" \
|
|
||||||
.
|
|
||||||
|
|
||||||
# Ruling 6: the binary in the image must be the binary in the tarball.
|
|
||||||
# Ruling 3: distributing the image is distribution, so /LICENSE and
|
|
||||||
# /THIRD-PARTY-NOTICES must be in it and must be the same files the
|
|
||||||
# tarball carries — that is an acceptance criterion and nothing checked
|
|
||||||
# it. Comparing against the staged payload rather than merely asserting
|
|
||||||
# the paths exist costs nothing and catches a stale or empty copy.
|
|
||||||
#
|
#
|
||||||
# Native triple only: this job builds a single-architecture image.
|
# It covers no more than that. `always()` does not run when the runner or
|
||||||
# release.yml covers both platforms against the pushed multi-arch index.
|
# the pod itself dies, and the filter below names THIS attempt's label
|
||||||
- name: Assert the image contents match the packaged artifacts
|
# value exactly — deliberately, since a concurrent run of another
|
||||||
run: |
|
# repository must not be swept, but that also means a later attempt cannot
|
||||||
set -euo pipefail
|
# collect an earlier one's leak. What the label buys for those cases is
|
||||||
stage="zig-out/dist/stage/nxdns-$CI_VERSION-x86_64-linux-musl"
|
# discovery, not recovery: `docker ps -a --filter
|
||||||
test -d "$stage"
|
# label=net.mial.nxdns.ci` and the matching `docker images` list every
|
||||||
|
# object this workflow has ever left behind, with the repository, run and
|
||||||
out=$(mktemp -d)
|
# attempt that owns each one. Reclaiming them is a manual sweep today, and
|
||||||
cid=$(docker create "$CI_IMAGE")
|
# the hook a janitor job would use later.
|
||||||
trap 'docker rm -f "$cid" >/dev/null 2>&1 || true; rm -rf "$out"' EXIT
|
|
||||||
|
|
||||||
rc=0
|
|
||||||
for member in nxdns LICENSE THIRD-PARTY-NOTICES; do
|
|
||||||
docker cp "$cid:/$member" "$out/$member"
|
|
||||||
want=$(sha256sum "$stage/$member" | cut -d' ' -f1)
|
|
||||||
got=$(sha256sum "$out/$member" | cut -d' ' -f1)
|
|
||||||
if [ "$want" = "$got" ]; then
|
|
||||||
echo "/$member matches ($got)"
|
|
||||||
else
|
|
||||||
echo "/$member DIFFERS: image $got, packaged $want"
|
|
||||||
rc=1
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
test "$rc" -eq 0
|
|
||||||
|
|
||||||
- name: Smoke test the container
|
|
||||||
run: |
|
|
||||||
set -euo pipefail
|
|
||||||
|
|
||||||
docker run --rm "$CI_IMAGE" version
|
|
||||||
|
|
||||||
mkdir -p etc-nxdns
|
|
||||||
cat > etc-nxdns/config.zon <<'EOF'
|
|
||||||
.{
|
|
||||||
.groups = .{ .{ .name = "default" } },
|
|
||||||
.upstreams = .{ .{ .url = "https://cloudflare-dns.com/dns-query" } },
|
|
||||||
}
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# No bind mount: the runner talks to the daemon over a mounted
|
|
||||||
# socket, so a -v path would resolve on the docker host (where the
|
|
||||||
# workspace does not exist) and mount an empty directory over
|
|
||||||
# /etc/nxdns. docker cp streams the file through the socket instead.
|
|
||||||
#
|
|
||||||
# Networking: this job itself runs in a container on the runner's
|
|
||||||
# per-job network. A published port binds on the daemon's host, not
|
|
||||||
# here, and docker does not route between the default bridge and
|
|
||||||
# that network — a bridge-IP curl hangs to its connect timeout. So
|
|
||||||
# the smoke container joins the job's own network, where its name
|
|
||||||
# resolves and its port is reachable. On a host runner the inspect
|
|
||||||
# finds no container and the published-port path covers it.
|
|
||||||
#
|
|
||||||
# `-p 127.0.0.1::8080` takes an ephemeral host port instead of a
|
|
||||||
# fixed 18080, which two concurrent runs on this daemon cannot both
|
|
||||||
# bind. The actual port is read back with `docker port`.
|
|
||||||
#
|
|
||||||
# The command and the sysctl mirror deploy/docker/compose.yaml,
|
|
||||||
# because that is the invocation this gate exists to prove. The
|
|
||||||
# invocation is the sole configuration authority (milestone-20 ruling
|
|
||||||
# 1): the image's bare `run` grades the database, and a fresh
|
|
||||||
# /var/lib/nxdns volume holds no upstream, so it exits 2 with
|
|
||||||
# NoUsableUpstreams before it ever binds a port.
|
|
||||||
net=$(docker inspect "$(hostname)" \
|
|
||||||
-f '{{range $k, $v := .NetworkSettings.Networks}}{{$k}}{{end}}' \
|
|
||||||
2>/dev/null || true)
|
|
||||||
cid=$(docker create --name "$SMOKE_NAME" \
|
|
||||||
${net:+--network "$net"} \
|
|
||||||
-p 127.0.0.1::8080 \
|
|
||||||
--sysctl net.ipv4.ip_unprivileged_port_start=0 \
|
|
||||||
"$CI_IMAGE" run --config=/etc/nxdns/config.zon)
|
|
||||||
trap 'docker rm -f "$SMOKE_NAME" >/dev/null 2>&1 || true' EXIT
|
|
||||||
docker cp etc-nxdns/config.zon "$SMOKE_NAME:/etc/nxdns/config.zon"
|
|
||||||
docker start "$SMOKE_NAME"
|
|
||||||
|
|
||||||
# Before anything that assumes a live container. `docker port` fails
|
|
||||||
# on one that already exited, and under `set -e` that failure is the
|
|
||||||
# whole diagnosis the log gets — the container's own stderr never
|
|
||||||
# reaches CI.
|
|
||||||
if [ "$(docker inspect -f '{{.State.Running}}' "$cid")" != "true" ]; then
|
|
||||||
echo "container exited during startup"
|
|
||||||
docker logs "$cid" || true
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
hostport=$(docker port "$SMOKE_NAME" 8080/tcp | head -1 | awk -F: '{ print $NF }')
|
|
||||||
ip=$(docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' "$cid")
|
|
||||||
echo "published host port: ${hostport:-none}, container ip: ${ip:-none}"
|
|
||||||
healthy=""
|
|
||||||
for _ in $(seq 1 30); do
|
|
||||||
if [ "$(docker inspect -f '{{.State.Running}}' "$cid")" != "true" ]; then
|
|
||||||
echo "container exited during startup"
|
|
||||||
docker logs "$cid" || true
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
if curl -fsS --connect-timeout 2 "http://$SMOKE_NAME:8080/api/health" \
|
|
||||||
|| { [ -n "$hostport" ] && curl -fsS --connect-timeout 2 "http://127.0.0.1:$hostport/api/health"; } \
|
|
||||||
|| { [ -n "$ip" ] && curl -fsS --connect-timeout 2 "http://$ip:8080/api/health"; }; then
|
|
||||||
healthy=1
|
|
||||||
break
|
|
||||||
fi
|
|
||||||
sleep 1
|
|
||||||
done
|
|
||||||
if [ -z "$healthy" ]; then
|
|
||||||
echo "no /api/health response within 30 seconds"
|
|
||||||
docker logs "$cid" || true
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
docker stop -t 30 "$SMOKE_NAME"
|
|
||||||
exit_code=$(docker inspect -f '{{.State.ExitCode}}' "$SMOKE_NAME")
|
|
||||||
echo "exit code after SIGTERM: $exit_code"
|
|
||||||
docker logs "$SMOKE_NAME" || true
|
|
||||||
test "$exit_code" -eq 0
|
|
||||||
|
|
||||||
# The per-step traps only cover the step that set them. This is the exit
|
|
||||||
# path for a cancelled job, a step that died before its trap was
|
|
||||||
# installed, and the image itself, which no trap ever removed — on a
|
|
||||||
# long-lived self-hosted daemon those accumulate one layer set per run.
|
|
||||||
- name: Remove this run's docker objects
|
- name: Remove this run's docker objects
|
||||||
if: always()
|
if: always()
|
||||||
|
env:
|
||||||
|
CI_LABEL: net.mial.nxdns.ci=${{ github.repository }}/${{ github.run_id }}/${{ github.run_attempt }}
|
||||||
run: |
|
run: |
|
||||||
set -uo pipefail
|
set -uo pipefail
|
||||||
if [ -n "${SMOKE_NAME:-}" ]; then
|
if [ -n "${SMOKE_NAME:-}" ]; then
|
||||||
@@ -468,4 +353,10 @@ jobs:
|
|||||||
if [ -n "${CI_IMAGE:-}" ]; then
|
if [ -n "${CI_IMAGE:-}" ]; then
|
||||||
docker image rm -f "$CI_IMAGE" >/dev/null 2>&1 || true
|
docker image rm -f "$CI_IMAGE" >/dev/null 2>&1 || true
|
||||||
fi
|
fi
|
||||||
|
for cid in $(docker ps -aq --filter "label=$CI_LABEL"); do
|
||||||
|
docker rm -f "$cid" >/dev/null 2>&1 || true
|
||||||
|
done
|
||||||
|
for iid in $(docker images -q --filter "label=$CI_LABEL"); do
|
||||||
|
docker image rm -f "$iid" >/dev/null 2>&1 || true
|
||||||
|
done
|
||||||
exit 0
|
exit 0
|
||||||
|
|||||||
@@ -269,10 +269,10 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
node-version: ${{ env.NODE_VERSION }}
|
node-version: ${{ env.NODE_VERSION }}
|
||||||
cache: npm
|
cache: npm
|
||||||
cache-dependency-path: web/package-lock.json
|
cache-dependency-path: admin/package-lock.json
|
||||||
|
|
||||||
- name: Build the web UI
|
- name: Build the web UI
|
||||||
working-directory: web
|
working-directory: admin
|
||||||
run: |
|
run: |
|
||||||
npm ci
|
npm ci
|
||||||
npm run build
|
npm run build
|
||||||
@@ -283,7 +283,7 @@ jobs:
|
|||||||
zig build dist
|
zig build dist
|
||||||
-Dversion-string="$VERSION"
|
-Dversion-string="$VERSION"
|
||||||
-Dgit-commit="$TAG_COMMIT"
|
-Dgit-commit="$TAG_COMMIT"
|
||||||
-Dweb-dist=web/dist
|
-Dadmin-dist=admin/dist
|
||||||
-Doptimize=ReleaseSafe
|
-Doptimize=ReleaseSafe
|
||||||
|
|
||||||
- name: Verify the release artifacts
|
- name: Verify the release artifacts
|
||||||
@@ -291,7 +291,7 @@ jobs:
|
|||||||
zig build verify-dist
|
zig build verify-dist
|
||||||
-Dversion-string="$VERSION"
|
-Dversion-string="$VERSION"
|
||||||
-Dgit-commit="$TAG_COMMIT"
|
-Dgit-commit="$TAG_COMMIT"
|
||||||
-Dweb-dist=web/dist
|
-Dadmin-dist=admin/dist
|
||||||
-Doptimize=ReleaseSafe
|
-Doptimize=ReleaseSafe
|
||||||
|
|
||||||
# Step 9. Extracted and validated before anything is pushed anywhere, so
|
# Step 9. Extracted and validated before anything is pushed anywhere, so
|
||||||
|
|||||||
+4
-4
@@ -1,7 +1,7 @@
|
|||||||
.zig-cache/
|
.zig-cache/
|
||||||
zig-out/
|
zig-out/
|
||||||
zig-pkg/
|
zig-pkg/
|
||||||
web/node_modules/
|
admin/node_modules/
|
||||||
web/dist/
|
admin/dist/
|
||||||
web/dist-sourcemap/
|
admin/dist-sourcemap/
|
||||||
web-dist-ci/
|
admin-dist-ci/
|
||||||
|
|||||||
@@ -2,79 +2,42 @@
|
|||||||
|
|
||||||
## Aim
|
## Aim
|
||||||
|
|
||||||
nxdns: a self-hosted DNS sinkhole for a household LAN, written in Zig 0.16.0.
|
nxdns: a self-hosted DNS sinkhole for a household LAN, written in Zig 0.16.0. Portfolio-grade public repo. PLAN.md is the source of truth for scope and design; specs/ holds per-milestone contracts; specs/research/ holds verified stdlib facts.
|
||||||
Portfolio-grade public repo. PLAN.md is the source of truth for scope and design;
|
|
||||||
specs/ holds per-milestone contracts; specs/research/ holds verified stdlib facts.
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
We intentionally architect this code to be robust, maintainable, pragmatic —
|
We intentionally architect this code to be robust, maintainable, pragmatic — good craftsmanship and good engineering. We explicitly avoid tech debt, code smells, bad architecture decisions, and brittle implementations.
|
||||||
good craftsmanship and good engineering. We explicitly avoid tech debt, code
|
|
||||||
smells, bad architecture decisions, and brittle implementations.
|
|
||||||
|
|
||||||
What that means in practice:
|
What that means in practice:
|
||||||
|
|
||||||
- This is a greenfield project. Breaking changes are allowed. Never keep a bad
|
- This is a greenfield project. Breaking changes are allowed. Never keep a bad interface for compatibility; fix it at the root.
|
||||||
interface for compatibility; fix it at the root.
|
- No versioning of scope. A feature is in scope (build it completely) or out of scope (do not build it). No "v2 later", no stubs left behind.
|
||||||
- No versioning of scope. A feature is in scope (build it completely) or out of
|
|
||||||
scope (do not build it). No "v2 later", no stubs left behind.
|
|
||||||
- Fix root causes, not symptoms. Do not iterate on workarounds.
|
- Fix root causes, not symptoms. Do not iterate on workarounds.
|
||||||
- Scope is small on purpose: household scale, two targets, few dependencies.
|
- Scope is small on purpose: household scale, two targets, few dependencies. Do not add generality nobody asked for.
|
||||||
Do not add generality nobody asked for.
|
- Dependencies are liabilities: stdlib first; vendored + pinned C deps (sqlite3, mbedTLS) only where the stdlib has nothing.
|
||||||
- Dependencies are liabilities: stdlib first; vendored + pinned C deps
|
- Verify stdlib claims against ../zig at tag 0.16.0 — pre-0.16 knowledge is stale (std.Io migration). See specs/research/zig-0.16-api-notes.md.
|
||||||
(sqlite3, mbedTLS) only where the stdlib has nothing.
|
- Pure core: dns/, filter/, local/, cache/ take bytes and return bytes — no Io, no sockets, no clocks hidden inside.
|
||||||
- Verify stdlib claims against ../zig at tag 0.16.0 — pre-0.16 knowledge is
|
- Every failure mode must be visible: no silent drops, no unbounded logs, no swallowed errors. Counters + health surfaces over log spam.
|
||||||
stale (std.Io migration). See specs/research/zig-0.16-api-notes.md.
|
- Tests are runnable acceptance criteria, not decoration. Required CI stays deterministic — no network-dependent tests in blocking jobs.
|
||||||
- Pure core: dns/, filter/, local/, cache/ take bytes and return bytes — no Io,
|
- Comments state constraints the code cannot show. No narration, no commented-out code.
|
||||||
no sockets, no clocks hidden inside.
|
- Git: GPG-signed commits (`git commit -S`), simple lowercase messages, no generated-by footers.
|
||||||
- Every failure mode must be visible: no silent drops, no unbounded logs, no
|
|
||||||
swallowed errors. Counters + health surfaces over log spam.
|
|
||||||
- Tests are runnable acceptance criteria, not decoration. Required CI stays
|
|
||||||
deterministic — no network-dependent tests in blocking jobs.
|
|
||||||
- Comments state constraints the code cannot show. No narration, no
|
|
||||||
commented-out code.
|
|
||||||
- Git: GPG-signed commits (`git commit -S`), simple lowercase messages, no
|
|
||||||
generated-by footers.
|
|
||||||
|
|
||||||
## Reading `zig build test` output
|
## Reading `zig build test` output
|
||||||
|
|
||||||
A fully passing `zig build test` still prints a line like `failed command:
|
A fully passing `zig build test` still prints a line like `failed command: .../test --cache-dir=... --seed=... --listen=-`, and still exits 0. That line is a known upstream zig 0.16.0 labelling defect. It does not mean a test failed, and no test binary crashed.
|
||||||
.../test --cache-dir=... --seed=... --listen=-`, and still exits 0. That line
|
|
||||||
is a known upstream zig 0.16.0 labelling defect. It does not mean a test
|
|
||||||
failed, and no test binary crashed.
|
|
||||||
|
|
||||||
The build runner sets a step's `result_failed_command` on every spawn
|
The build runner sets a step's `result_failed_command` on every spawn (`std/Build/Step/Run.zig:1540`) and never clears it on success. It then prints a step's diagnostics whenever the step wrote anything to stderr, explicitly "no matter the result" (`compiler/build_runner.zig:1381`), and that printer emits the `failed command: ` label unconditionally when the field is set (`compiler/build_runner.zig:1515`). Our suite writes to stderr on every run, because the tests that cover the warning paths log through the real sink. A minimal reproducer with no mbedTLS and no C — one passing test whose body is a `std.debug.print` — prints the same label and reports "3/3 steps succeeded; 1/1 tests passed"; deleting the print removes the label. No upstream issue matched a search, so the reference is the 0.16.0 source lines above.
|
||||||
(`std/Build/Step/Run.zig:1540`) and never clears it on success. It then prints
|
|
||||||
a step's diagnostics whenever the step wrote anything to stderr, explicitly "no
|
|
||||||
matter the result" (`compiler/build_runner.zig:1381`), and that printer emits
|
|
||||||
the `failed command: ` label unconditionally when the field is set
|
|
||||||
(`compiler/build_runner.zig:1515`). Our suite writes to stderr on every run,
|
|
||||||
because the tests that cover the warning paths log through the real sink. A
|
|
||||||
minimal reproducer with no mbedTLS and no C — one passing test whose body is a
|
|
||||||
`std.debug.print` — prints the same label and reports "3/3 steps succeeded;
|
|
||||||
1/1 tests passed"; deleting the print removes the label. No upstream issue
|
|
||||||
matched a search, so the reference is the 0.16.0 source lines above.
|
|
||||||
|
|
||||||
Any *other* failure text is real. Trust the summary line: `zig build test`
|
Any *other* failure text is real. Trust the summary line: `zig build test` exiting non-zero, a `N failed` count, or a panic backtrace all mean a genuine failure. Do not filter, wrap, or suppress the runner's output to hide the label — that would hide real failures with it.
|
||||||
exiting non-zero, a `N failed` count, or a panic backtrace all mean a genuine
|
|
||||||
failure. Do not filter, wrap, or suppress the runner's output to hide the
|
|
||||||
label — that would hide real failures with it.
|
|
||||||
|
|
||||||
One trap: running a cached test binary by hand with `--listen=-` aborts with
|
One trap: running a cached test binary by hand with `--listen=-` aborts with `internal test runner failure: EndOfStream`. That is not a teardown bug; the IPC runner is talking to a closed stdin because no build runner is on the other end. Run the binary with no arguments to get the plain stdio report.
|
||||||
`internal test runner failure: EndOfStream`. That is not a teardown bug; the
|
|
||||||
IPC runner is talking to a closed stdin because no build runner is on the other
|
|
||||||
end. Run the binary with no arguments to get the plain stdio report.
|
|
||||||
|
|
||||||
## Regenerating the contract samples
|
## Regenerating the contract samples
|
||||||
|
|
||||||
`web/src/lib/contractSamples.gen.ts` is a committed golden of canonicalized
|
`admin/src/lib/contractSamples.gen.ts` is a committed golden of canonicalized API responses, byte-compared against the live server by a `-Dintegration` test and type-checked by `tsc`. After a deliberate API contract change, regenerate it with:
|
||||||
API responses, byte-compared against the live server by a `-Dintegration`
|
|
||||||
test and type-checked by `tsc`. After a deliberate API contract change,
|
|
||||||
regenerate it with:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
zig build test -Dintegration -Dcontract-samples-out="$PWD/web/src/lib/contractSamples.gen.ts"
|
zig build test -Dintegration -Dcontract-samples-out="$PWD/admin/src/lib/contractSamples.gen.ts"
|
||||||
```
|
```
|
||||||
|
|
||||||
then update `web/src/lib/types.ts` to match and commit both. Never edit the
|
then update `admin/src/lib/types.ts` to match and commit both. Never edit the generated file by hand.
|
||||||
generated file by hand.
|
|
||||||
|
|||||||
+68
-131
@@ -1,104 +1,70 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
All notable changes to nxdns are recorded here. The format follows
|
All notable changes to nxdns are recorded here. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project uses
|
|
||||||
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
||||||
|
|
||||||
Sections are written by hand. Nothing here is generated from commit messages:
|
Sections are written by hand. Nothing here is generated from commit messages: the point of the file is to say what changed for an operator, which a commit subject rarely does.
|
||||||
the point of the file is to say what changed for an operator, which a commit
|
|
||||||
subject rarely does.
|
|
||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
## [0.0.2] - 2026-08-14
|
## [0.0.5] - 2026-08-16
|
||||||
|
|
||||||
Configuration can now be a file that every boot converges to, filtering gains
|
One rendering fix on the 0.0.4 feature, caught the day it shipped.
|
||||||
regex rules and honors blocklist exception lines, and two refresh bugs that
|
|
||||||
silently kept stale state are fixed. Note the three breaking changes below if
|
|
||||||
you script against `nxdns import` or run with `--config`.
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- **Declarative configuration for IaC.** `nxdns run --config=<file>` makes the
|
|
||||||
file the sole source of configuration: every boot converges the database to
|
|
||||||
it in one transaction, preserving blocklist downloads, compiled lists and
|
|
||||||
client history, so an unchanged file costs zero downloads and zero writes.
|
|
||||||
Bare `nxdns run` keeps the database (and the web UI) in charge, exactly as
|
|
||||||
before. In file mode the web UI is read-only for configuration and says so;
|
|
||||||
runtime actions (pause, blocklist refresh, certificate reload) stay live.
|
|
||||||
`GET /api/settings` reports which authority governs the process.
|
|
||||||
- `nxdns import` now refuses a file whose application would delete
|
|
||||||
configuration rows, names the tables and counts, and applies it only with
|
|
||||||
the new `--allow-delete` flag. Additive and edit-in-place imports need no
|
|
||||||
flag.
|
|
||||||
- **Regex rules.** Rules gain a third kind, `regex`, beside `exact` and
|
|
||||||
`wildcard`, for per-group allow and block patterns such as `^ad[0-9]+-`. The
|
|
||||||
engine is homegrown and linear-time by construction, so no pattern can make
|
|
||||||
matching blow up; backreferences and lookaround do not exist, and a bad
|
|
||||||
pattern is refused at insert time with the limit it hit. Matches appear in
|
|
||||||
`/api/lookup` and the query log as `rule_allow_regex` / `rule_block_regex`.
|
|
||||||
Regex still comes only from you: regex lines in downloaded lists stay
|
|
||||||
counted and skipped.
|
|
||||||
- **Blocklist exception lines are honored.** An Adblock-Plus `@@||name^` line
|
|
||||||
in a downloaded list now lifts that name — and its subdomains — out of what
|
|
||||||
the attached lists block. Exceptions sit below every rule you wrote: a
|
|
||||||
downloaded list can reopen only a hole another downloaded list dug, never
|
|
||||||
override an operator decision. Each source reports how many it carried.
|
|
||||||
- **Browser-only lines are counted where you can see them.** Every source now
|
|
||||||
reports how many of its lines nxdns skipped as syntax with no DNS meaning —
|
|
||||||
cosmetic filters, `$`-modifier rules — beside the existing skipped-regex
|
|
||||||
count. Both blocklist tables show the number and the UI explains the
|
|
||||||
difference: a list whose skipped-unsupported count dwarfs its domain count
|
|
||||||
is written for browser extensions, and its DNS or hosts variant will block
|
|
||||||
more. Previously such a list compiled to almost nothing and looked clean.
|
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
- **Breaking: `nxdns run --config <file>` changed meaning.** It used to seed
|
- The query tables no longer repeat the *learned* tag on every row: in the live page and the query log a learned name is just muted, with the address still in the row's tooltip. The clients page keeps the tag, where it appears once per client and says something.
|
||||||
the database once and then ignore the file; it now makes the file the
|
|
||||||
authority on every boot, which deletes any configuration the file does not
|
## [0.0.4] - 2026-08-16
|
||||||
declare — including edits made through the web UI since the seed. Before
|
|
||||||
upgrading a unit that carries `--config`: either drop the flag to keep the
|
The names learned in 0.0.3 now show up where queries do: the live page and the query log name each client instead of printing its address.
|
||||||
database in charge, or adopt file mode with the sequence in the upgrade
|
|
||||||
guide. Order matters there: export the file with the NEW binary (stopped).
|
### Added
|
||||||
- **Breaking: 0.0.1 exports are refused by this version.** A 0.0.1
|
|
||||||
`nxdns export` writes both `.password = ""` and the stored
|
- **Client names in the query tables.** The live page and the query log show each query's client by name, with the same precedence as the clients page: a hand-typed name wins, else the learned name (muted, tagged *learned*), else the bare address. When a name replaces the address, the address stays readable as the row's tooltip. Devices that appear mid-stream show their address first and pick up their name within half a minute.
|
||||||
`.password_hash`, and this version refuses a file that carries both. This
|
|
||||||
bites any old export — an adoption file or a configuration backup fed to
|
## [0.0.3] - 2026-08-15
|
||||||
`nxdns import` alike. Fix an existing export by deleting its
|
|
||||||
`.password = ""` line (keep the `.password_hash` line). Take fresh backups
|
Devices name themselves: the clients table asks the router over reverse DNS instead of waiting for the operator to type every name. The CI container gate also moved from workflow shell into a compiled, tested tool, which fixed a latent temp-directory bug shared with the release tool.
|
||||||
with the new binary.
|
|
||||||
- **Breaking: the offline password-change recipe changed.** Setting
|
### Added
|
||||||
`.password = "new"` together with `.password_hash = ""` is now refused
|
|
||||||
(empty `password_hash` is an explicit "disable authentication", and the two
|
- **Client names learned over reverse DNS.** A client row that carries no hand-typed name gets one from the network: each tracker flush pass takes up to 16 unnamed rows, builds each address's reverse name, matches it against the declared `forward_zones`, and on a match sends one PTR query to that zone's resolver, storing the answer as a *learned* name. This requires a conditional forward zone covering the LAN's reverse space — for example `168.192.in-addr.arpa` pointed at the router; without one, nothing is sent anywhere. A hand-typed name always wins, learned names never appear in `nxdns export` and are never set by `nxdns import`, and each row refreshes once a day (an hour after a failure), so a rename can show stale for up to 24 hours. The API's `Client` object gains a `learned_name` field and the clients page shows it.
|
||||||
fields cannot both be present). To change the password in the file: set
|
|
||||||
`.password` and delete the `.password_hash` line entirely.
|
### Changed
|
||||||
- `nxdns import --force` is renamed `--allow-delete`.
|
|
||||||
- A fresh install no longer seeds from `/etc/nxdns/config.zon` by presence.
|
- The container CI gate — image build, image-contents assertion against the packaged artifacts, and the startup/shutdown smoke test — moved from workflow shell into `tools/container_check.zig`, compiled and unit-tested by `zig build test` and runnable on a laptop against a local docker daemon. The health probe now runs under a real 60-second deadline (the shell loop's "30 seconds" could stretch past three minutes), and the gate's docker objects carry an ownership label so anything a dead runner leaks is discoverable. The version in CI is parsed from `build.zig.zon` through the zon grammar, once, instead of by two copies of a `sed` regex.
|
||||||
Use `nxdns import` once, or run in file mode with `--config`.
|
|
||||||
- The admin UI's internals moved to TypeScript 7 and replaced Tailwind with
|
|
||||||
StyleX and React Aria. The visible change is small: selects are real
|
|
||||||
widgets with working keyboard focus; everything else renders as before.
|
|
||||||
- The `config.db` schema is a single baseline definition again; numbered
|
|
||||||
migration steps start accumulating at v0.1.
|
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
- **A list switching a name between its exact and wildcard forms never took
|
- The release tool's temporary-directory claim was not exclusive: the "create" it relied on succeeds on a directory that already exists, so a stale or concurrent directory could be silently adopted, written into, and deleted on exit. Both the release tool and the new container gate now claim their directories exclusively and retry on collision.
|
||||||
effect.** The compiled-list checksum hashed the exact and wildcard bodies as
|
|
||||||
one unseparated byte stream, so a list carrying `a.example` and the same
|
## [0.0.2] - 2026-08-14
|
||||||
list carrying `*.a.example` produced the same digest, and the refresh kept
|
|
||||||
the old compiled files. The checksum now separates the bodies. Every source
|
Configuration can now be a file that every boot converges to, filtering gains regex rules and honors blocklist exception lines, and two refresh bugs that silently kept stale state are fixed. Note the three breaking changes below if you script against `nxdns import` or run with `--config`.
|
||||||
recompiles once on its first refresh after the upgrade; no re-download of
|
|
||||||
unchanged content is forced beyond the refresh's normal fetch.
|
### Added
|
||||||
- **A refresh could store stale skip counts.** When a refresh found the list
|
|
||||||
content unchanged, it wrote the previously stored skip counters back to the
|
- **Declarative configuration for IaC.** `nxdns run --config=<file>` makes the file the sole source of configuration: every boot converges the database to it in one transaction, preserving blocklist downloads, compiled lists and client history, so an unchanged file costs zero downloads and zero writes. Bare `nxdns run` keeps the database (and the web UI) in charge, exactly as before. In file mode the web UI is read-only for configuration and says so; runtime actions (pause, blocklist refresh, certificate reload) stay live. `GET /api/settings` reports which authority governs the process.
|
||||||
database while showing the fresh ones in the UI, and the next restart
|
- `nxdns import` now refuses a file whose application would delete configuration rows, names the tables and counts, and applies it only with the new `--allow-delete` flag. Additive and edit-in-place imports need no flag.
|
||||||
reverted the numbers to the stale copy. All counters now persist from the
|
- **Regex rules.** Rules gain a third kind, `regex`, beside `exact` and `wildcard`, for per-group allow and block patterns such as `^ad[0-9]+-`. The engine is homegrown and linear-time by construction, so no pattern can make matching blow up; backreferences and lookaround do not exist, and a bad pattern is refused at insert time with the limit it hit. Matches appear in `/api/lookup` and the query log as `rule_allow_regex` / `rule_block_regex`. Regex still comes only from you: regex lines in downloaded lists stay counted and skipped.
|
||||||
fresh compile.
|
- **Blocklist exception lines are honored.** An Adblock-Plus `@@||name^` line in a downloaded list now lifts that name — and its subdomains — out of what the attached lists block. Exceptions sit below every rule you wrote: a downloaded list can reopen only a hole another downloaded list dug, never override an operator decision. Each source reports how many it carried.
|
||||||
- An Adblock-Plus entry with embedded whitespace
|
- **Browser-only lines are counted where you can see them.** Every source now reports how many of its lines nxdns skipped as syntax with no DNS meaning — cosmetic filters, `$`-modifier rules — beside the existing skipped-regex count. Both blocklist tables show the number and the UI explains the difference: a list whose skipped-unsupported count dwarfs its domain count is written for browser extensions, and its DNS or hosts variant will block more. Previously such a list compiled to almost nothing and looked clean.
|
||||||
(`||good.example bad.example^`) compiled into an entry no query could ever
|
|
||||||
match. Such lines are now counted as unsupported instead.
|
### Changed
|
||||||
|
|
||||||
|
- **Breaking: `nxdns run --config <file>` changed meaning.** It used to seed the database once and then ignore the file; it now makes the file the authority on every boot, which deletes any configuration the file does not declare — including edits made through the web UI since the seed. Before upgrading a unit that carries `--config`: either drop the flag to keep the database in charge, or adopt file mode with the sequence in the upgrade guide. Order matters there: export the file with the NEW binary (stopped).
|
||||||
|
- **Breaking: 0.0.1 exports are refused by this version.** A 0.0.1 `nxdns export` writes both `.password = ""` and the stored `.password_hash`, and this version refuses a file that carries both. This bites any old export — an adoption file or a configuration backup fed to `nxdns import` alike. Fix an existing export by deleting its `.password = ""` line (keep the `.password_hash` line). Take fresh backups with the new binary.
|
||||||
|
- **Breaking: the offline password-change recipe changed.** Setting `.password = "new"` together with `.password_hash = ""` is now refused (empty `password_hash` is an explicit "disable authentication", and the two fields cannot both be present). To change the password in the file: set `.password` and delete the `.password_hash` line entirely.
|
||||||
|
- `nxdns import --force` is renamed `--allow-delete`.
|
||||||
|
- A fresh install no longer seeds from `/etc/nxdns/config.zon` by presence. Use `nxdns import` once, or run in file mode with `--config`.
|
||||||
|
- The admin UI's internals moved to TypeScript 7 and replaced Tailwind with StyleX and React Aria. The visible change is small: selects are real widgets with working keyboard focus; everything else renders as before.
|
||||||
|
- The `config.db` schema is a single baseline definition again; numbered migration steps start accumulating at v0.1.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- **A list switching a name between its exact and wildcard forms never took effect.** The compiled-list checksum hashed the exact and wildcard bodies as one unseparated byte stream, so a list carrying `a.example` and the same list carrying `*.a.example` produced the same digest, and the refresh kept the old compiled files. The checksum now separates the bodies. Every source recompiles once on its first refresh after the upgrade; no re-download of unchanged content is forced beyond the refresh's normal fetch.
|
||||||
|
- **A refresh could store stale skip counts.** When a refresh found the list content unchanged, it wrote the previously stored skip counters back to the database while showing the fresh ones in the UI, and the next restart reverted the numbers to the stale copy. All counters now persist from the fresh compile.
|
||||||
|
- An Adblock-Plus entry with embedded whitespace (`||good.example bad.example^`) compiled into an entry no query could ever match. Such lines are now counted as unsupported instead.
|
||||||
|
|
||||||
## [0.0.1] - 2026-08-09
|
## [0.0.1] - 2026-08-09
|
||||||
|
|
||||||
@@ -106,47 +72,18 @@ First release. Everything below is new.
|
|||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- **Forwarding DNS server.** UDP and TCP listeners with a wire-format parser and
|
- **Forwarding DNS server.** UDP and TCP listeners with a wire-format parser and encoder written against RFC 1035 and EDNS(0), a bounded worker model, per-client rate limiting and a `pause` control that stops filtering without stopping resolution.
|
||||||
encoder written against RFC 1035 and EDNS(0), a bounded worker model, per-client
|
- **Encrypted upstreams.** DNS-over-HTTPS and DNS-over-TLS clients over a pool that tracks per-upstream health and fails over, with SNI and certificate verification driven by a per-upstream TLS name.
|
||||||
rate limiting and a `pause` control that stops filtering without stopping
|
- **DoH and DoT endpoints.** nxdns also answers as an encrypted resolver, with a certificate store that reloads on disk changes and through the API, so renewals do not need a restart.
|
||||||
resolution.
|
- **Blocklist filtering.** Subscriptions in hosts, plain-domain and Adblock-Plus-style formats, compiled into a compact matcher; per-group allow and block rules with wildcards; safe-search enforcement.
|
||||||
- **Encrypted upstreams.** DNS-over-HTTPS and DNS-over-TLS clients over a pool
|
- **Per-client policy groups.** Clients are identified by address and assigned to groups, so the filtering a device gets depends on which device it is.
|
||||||
that tracks per-upstream health and fails over, with SNI and certificate
|
- **Local DNS.** Local A/AAAA/CNAME/PTR records and conditional forwarding of internal zones to another resolver.
|
||||||
verification driven by a per-upstream TLS name.
|
- **Cache.** A bounded in-memory cache that respects upstream TTLs and expires entries rather than serving them stale.
|
||||||
- **DoH and DoT endpoints.** nxdns also answers as an encrypted resolver, with a
|
- **Query log.** Queries land in SQLite under a retention policy in both rows and days, with disk-full self-protection that degrades instead of corrupting, and a live SSE stream of the same events.
|
||||||
certificate store that reloads on disk changes and through the API, so renewals
|
- **Web UI and REST API.** A React single-page admin UI embedded in the binary, a REST API with a served OpenAPI document, session authentication, API rate limiting and Prometheus-style `/metrics`.
|
||||||
do not need a restart.
|
- **Configuration.** A ZON configuration file seeds the database on first boot; after that the database is the truth, and `nxdns export` / `nxdns import` move configuration in and out. `nxdns check` validates a file without starting.
|
||||||
- **Blocklist filtering.** Subscriptions in hosts, plain-domain and
|
|
||||||
Adblock-Plus-style formats, compiled into a compact matcher; per-group allow
|
|
||||||
and block rules with wildcards; safe-search enforcement.
|
|
||||||
- **Per-client policy groups.** Clients are identified by address and assigned to
|
|
||||||
groups, so the filtering a device gets depends on which device it is.
|
|
||||||
- **Local DNS.** Local A/AAAA/CNAME/PTR records and conditional forwarding of
|
|
||||||
internal zones to another resolver.
|
|
||||||
- **Cache.** A bounded in-memory cache that respects upstream TTLs and expires
|
|
||||||
entries rather than serving them stale.
|
|
||||||
- **Query log.** Queries land in SQLite under a retention policy in both rows and
|
|
||||||
days, with disk-full self-protection that degrades instead of corrupting, and a
|
|
||||||
live SSE stream of the same events.
|
|
||||||
- **Web UI and REST API.** A React single-page admin UI embedded in the binary,
|
|
||||||
a REST API with a served OpenAPI document, session authentication, API rate
|
|
||||||
limiting and Prometheus-style `/metrics`.
|
|
||||||
- **Configuration.** A ZON configuration file seeds the database on first boot;
|
|
||||||
after that the database is the truth, and `nxdns export` / `nxdns import` move
|
|
||||||
configuration in and out. `nxdns check` validates a file without starting.
|
|
||||||
- **CLI.** `run`, `check`, `export`, `import`, `version` and `help`.
|
- **CLI.** `run`, `check`, `export`, `import`, `version` and `help`.
|
||||||
- **Packaging.** A hardened systemd unit with a sysusers fragment, and a
|
- **Packaging.** A hardened systemd unit with a sysusers fragment, and a `FROM scratch` container image holding the binary, a CA bundle and the licence files, assembled by a builder stage pinned to `alpine:3.22` by digest. Nothing from Alpine ships in the published image except that CA bundle.
|
||||||
`FROM scratch` container image holding the binary, a CA bundle and the licence
|
- **Releases.** Tags publish five assets — static musl tarballs for `x86_64-linux-musl` and `aarch64-linux-musl`, `IMAGE-DIGEST.txt` naming the multi-architecture container image by digest, `SHA256SUMS.txt` over those three, and `SHA256SUMS.txt.asc`, a detached signature over the checksum file. `zig build dist` and `zig build verify-dist` produce and check the same artifacts on a laptop.
|
||||||
files, assembled by a builder stage pinned to `alpine:3.22` by digest. Nothing
|
- **Licensing.** EUPL-1.2, with a `THIRD-PARTY-NOTICES` file in every tarball and image assembled from a reviewed inventory of what the artifacts contain.
|
||||||
from Alpine ships in the published image except that CA bundle.
|
- **Documentation.** A Diátaxis split — tutorial, how-to, reference, explanation — with drift guards that fail the build when the reference pages fall behind the code.
|
||||||
- **Releases.** Tags publish five assets — static musl tarballs for
|
|
||||||
`x86_64-linux-musl` and `aarch64-linux-musl`, `IMAGE-DIGEST.txt` naming the
|
|
||||||
multi-architecture container image by digest, `SHA256SUMS.txt` over those
|
|
||||||
three, and `SHA256SUMS.txt.asc`, a detached signature over the checksum file.
|
|
||||||
`zig build dist` and `zig build verify-dist` produce and check the same
|
|
||||||
artifacts on a laptop.
|
|
||||||
- **Licensing.** EUPL-1.2, with a `THIRD-PARTY-NOTICES` file in every tarball and
|
|
||||||
image assembled from a reviewed inventory of what the artifacts contain.
|
|
||||||
- **Documentation.** A Diátaxis split — tutorial, how-to, reference, explanation —
|
|
||||||
with drift guards that fail the build when the reference pages fall behind the
|
|
||||||
code.
|
|
||||||
|
|||||||
+11
-35
@@ -11,12 +11,9 @@ This directory is an nxdns release for one architecture. It holds:
|
|||||||
| `THIRD-PARTY-NOTICES` | Licences of everything compiled or bundled in |
|
| `THIRD-PARTY-NOTICES` | Licences of everything compiled or bundled in |
|
||||||
| `INSTALL.md` | This file |
|
| `INSTALL.md` | This file |
|
||||||
|
|
||||||
The binary is statically linked against musl and needs nothing installed on the
|
The binary is statically linked against musl and needs nothing installed on the target host.
|
||||||
target host.
|
|
||||||
|
|
||||||
Verify the download before you trust it. `docs/how-to/verify-a-release.md` in
|
Verify the download before you trust it. `docs/how-to/verify-a-release.md` in the repository covers where the public key comes from, what fingerprint to expect, and what the signature does and does not prove.
|
||||||
the repository covers where the public key comes from, what fingerprint to
|
|
||||||
expect, and what the signature does and does not prove.
|
|
||||||
|
|
||||||
## 1. Install the binary, the user and the unit
|
## 1. Install the binary, the user and the unit
|
||||||
|
|
||||||
@@ -34,12 +31,9 @@ systemctl daemon-reload
|
|||||||
mkdir -p -m 0755 /etc/nxdns
|
mkdir -p -m 0755 /etc/nxdns
|
||||||
```
|
```
|
||||||
|
|
||||||
`nxdns.conf` ships under the name it is installed as, so there is no rename to
|
`nxdns.conf` ships under the name it is installed as, so there is no rename to get wrong.
|
||||||
get wrong.
|
|
||||||
|
|
||||||
Do not create `/var/lib/nxdns` or `/var/log/nxdns` by hand. The unit's
|
Do not create `/var/lib/nxdns` or `/var/log/nxdns` by hand. The unit's `StateDirectory` and `LogsDirectory` settings make systemd create them on first start, `/var/lib/nxdns` at mode 0700 owned by `nxdns`.
|
||||||
`StateDirectory` and `LogsDirectory` settings make systemd create them on first
|
|
||||||
start, `/var/lib/nxdns` at mode 0700 owned by `nxdns`.
|
|
||||||
|
|
||||||
## 2. Write the configuration
|
## 2. Write the configuration
|
||||||
|
|
||||||
@@ -53,20 +47,14 @@ nxdns will not start with nothing to forward to. Write `/etc/nxdns/config.zon`:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
That file holds a password in plain text. Root's umask is 022 on most
|
That file holds a password in plain text. Root's umask is 022 on most distributions, so restrict it as soon as you have written it:
|
||||||
distributions, so restrict it as soon as you have written it:
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
chown root:nxdns /etc/nxdns/config.zon
|
chown root:nxdns /etc/nxdns/config.zon
|
||||||
chmod 0640 /etc/nxdns/config.zon
|
chmod 0640 /etc/nxdns/config.zon
|
||||||
```
|
```
|
||||||
|
|
||||||
0640 with group `nxdns` rather than 0600: the service runs as `nxdns`, and
|
0640 with group `nxdns` rather than 0600: the service runs as `nxdns`, and systemd leaves `/etc/nxdns` owned by root. Keep that group read bit for good. Under `run --config` the service reads this file on **every** start, not once, so tightening the mode after the first boot breaks the next restart. Under database authority it is `nxdns import` that reads the file, as whoever runs that command, and a bare `nxdns run` never reads it at all.
|
||||||
systemd leaves `/etc/nxdns` owned by root. Keep that group read bit for good.
|
|
||||||
Under `run --config` the service reads this file on **every** start, not once,
|
|
||||||
so tightening the mode after the first boot breaks the next restart. Under
|
|
||||||
database authority it is `nxdns import` that reads the file, as whoever runs
|
|
||||||
that command, and a bare `nxdns run` never reads it at all.
|
|
||||||
|
|
||||||
Check it before starting the service:
|
Check it before starting the service:
|
||||||
|
|
||||||
@@ -74,9 +62,7 @@ Check it before starting the service:
|
|||||||
nxdns check --config /etc/nxdns/config.zon
|
nxdns check --config /etc/nxdns/config.zon
|
||||||
```
|
```
|
||||||
|
|
||||||
A good file ends with `OK: no problems found`. Exit 2 means `check` found
|
A good file ends with `OK: no problems found`. Exit 2 means `check` found something to fix and printed every problem it found. The upstream probe sends a real query, so this needs working DNS on the host.
|
||||||
something to fix and printed every problem it found. The upstream probe sends a
|
|
||||||
real query, so this needs working DNS on the host.
|
|
||||||
|
|
||||||
Load it into the database:
|
Load it into the database:
|
||||||
|
|
||||||
@@ -84,10 +70,7 @@ Load it into the database:
|
|||||||
nxdns import /etc/nxdns/config.zon
|
nxdns import /etc/nxdns/config.zon
|
||||||
```
|
```
|
||||||
|
|
||||||
The packaged unit runs `nxdns run` with no `--config`, so from here the database
|
The packaged unit runs `nxdns run` with no `--config`, so from here the database is the configuration and nothing reads the file again. `web.password` is hashed and the plaintext is never stored, so once you have logged in you can delete the file:
|
||||||
is the configuration and nothing reads the file again. `web.password` is hashed
|
|
||||||
and the plaintext is never stored, so once you have logged in you can delete the
|
|
||||||
file:
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
rm /etc/nxdns/config.zon
|
rm /etc/nxdns/config.zon
|
||||||
@@ -95,10 +78,7 @@ rm /etc/nxdns/config.zon
|
|||||||
|
|
||||||
A kept file is not a backup. `nxdns export` is.
|
A kept file is not a backup. `nxdns export` is.
|
||||||
|
|
||||||
To keep the file as the configuration instead — converged at every start, with
|
To keep the file as the configuration instead — converged at every start, with the UI refusing configuration edits — do not delete it, and add a drop-in that appends `--config=/etc/nxdns/config.zon` to `ExecStart`. See `docs/how-to/install-with-systemd.md`.
|
||||||
the UI refusing configuration edits — do not delete it, and add a drop-in that
|
|
||||||
appends `--config=/etc/nxdns/config.zon` to `ExecStart`. See
|
|
||||||
`docs/how-to/install-with-systemd.md`.
|
|
||||||
|
|
||||||
## 3. Start it
|
## 3. Start it
|
||||||
|
|
||||||
@@ -107,9 +87,7 @@ systemctl enable --now nxdns
|
|||||||
journalctl -u nxdns -f
|
journalctl -u nxdns -f
|
||||||
```
|
```
|
||||||
|
|
||||||
A healthy start logs a line naming every socket it bound. Port 53 is
|
A healthy start logs a line naming every socket it bound. Port 53 is privileged, and the unit grants `CAP_NET_BIND_SERVICE` through `AmbientCapabilities`.
|
||||||
privileged, and the unit grants `CAP_NET_BIND_SERVICE` through
|
|
||||||
`AmbientCapabilities`.
|
|
||||||
|
|
||||||
## 4. Confirm it answers
|
## 4. Confirm it answers
|
||||||
|
|
||||||
@@ -119,9 +97,7 @@ From another machine on the LAN:
|
|||||||
dig @<server-ip> example.com A +short
|
dig @<server-ip> example.com A +short
|
||||||
```
|
```
|
||||||
|
|
||||||
The admin interface is on port 8080 by default; log in with the password from
|
The admin interface is on port 8080 by default; log in with the password from the configuration file. `http://<server-ip>:8080/api/health` reports upstream availability and disk state without a login.
|
||||||
the configuration file. `http://<server-ip>:8080/api/health` reports upstream
|
|
||||||
availability and disk state without a login.
|
|
||||||
|
|
||||||
## More
|
## More
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
# nxdns — Implementation Plan v3.0 (Zig 0.16.0 Stable)
|
# nxdns — Implementation Plan v3.0 (Zig 0.16.0 Stable)
|
||||||
|
|
||||||
Source of truth for **nxdns**, a self-hosted DNS sinkhole written in Zig 0.16.0 stable.
|
Source of truth for **nxdns**, a self-hosted DNS sinkhole written in Zig 0.16.0 stable. All stdlib claims in this document are verified against the `0.16.0` tag of the Zig repo (`../zig`).
|
||||||
All stdlib claims in this document are verified against the `0.16.0` tag of the Zig repo (`../zig`).
|
|
||||||
|
|
||||||
There is no v1/v2 versioning. Scope is binary: a feature is in scope (and gets built) or out of scope (and does not). "Done" = everything in scope implemented, tested, documented.
|
There is no v1/v2 versioning. Scope is binary: a feature is in scope (and gets built) or out of scope (and does not). "Done" = everything in scope implemented, tested, documented.
|
||||||
|
|
||||||
@@ -121,16 +120,9 @@ Rule kinds: `exact`, parent-walk (implicit via candidate chain), `wildcard` (`*`
|
|||||||
|
|
||||||
Tie-break at same specificity: **allow wins**.
|
Tie-break at same specificity: **allow wins**.
|
||||||
|
|
||||||
Each level is checked against the whole candidate chain before the next level is
|
Each level is checked against the whole candidate chain before the next level is checked against any, which is what makes an allow rule on a parent beat a block rule on the child.
|
||||||
checked against any, which is what makes an allow rule on a parent beat a block
|
|
||||||
rule on the child.
|
|
||||||
|
|
||||||
Two positions carry an argument rather than a preference. The regex levels come
|
Two positions carry an argument rather than a preference. The regex levels come last among the operator rules because they are the only ones that are not a set lookup or a label walk: a regex runs only once every cheaper level has missed. Blocklist exceptions come below **every** operator level because a downloaded list may cancel what another list blocked and must never cancel what the operator decided — no list can open an allow hole the operator did not open.
|
||||||
last among the operator rules because they are the only ones that are not a set
|
|
||||||
lookup or a label walk: a regex runs only once every cheaper level has missed.
|
|
||||||
Blocklist exceptions come below **every** operator level because a downloaded
|
|
||||||
list may cancel what another list blocked and must never cancel what the
|
|
||||||
operator decided — no list can open an allow hole the operator did not open.
|
|
||||||
|
|
||||||
### 3.11 Network Posture
|
### 3.11 Network Posture
|
||||||
|
|
||||||
@@ -250,7 +242,7 @@ src/
|
|||||||
rules.zig local.zig lookup.zig pause.zig settings.zig
|
rules.zig local.zig lookup.zig pause.zig settings.zig
|
||||||
upstream_health.zig certs.zig health.zig version.zig
|
upstream_health.zig certs.zig health.zig version.zig
|
||||||
|
|
||||||
web/ # Vite + React + TS + StyleX + React Aria + TanStack
|
admin/ # Vite + React + TS + StyleX + React Aria + TanStack
|
||||||
vendor/ # sqlite3 amalgamation, mbedtls (pinned)
|
vendor/ # sqlite3 amalgamation, mbedtls (pinned)
|
||||||
docs/ # tutorial/ how-to/ reference/ explanation/ (Diátaxis)
|
docs/ # tutorial/ how-to/ reference/ explanation/ (Diátaxis)
|
||||||
tests/ # dns/ integration/ fuzz/
|
tests/ # dns/ integration/ fuzz/
|
||||||
@@ -290,8 +282,7 @@ Walk chain to depth 8; any target hitting block logic → synthesize blocked res
|
|||||||
|
|
||||||
### 7.1 Evaluation
|
### 7.1 Evaluation
|
||||||
|
|
||||||
For `{domain, group_id}` (the qtype travels with the query for logging and response synthesis, not
|
For `{domain, group_id}` (the qtype travels with the query for logging and response synthesis, not for matching):
|
||||||
for matching):
|
|
||||||
1. Normalize: lowercase, trim trailing dot.
|
1. Normalize: lowercase, trim trailing dot.
|
||||||
2. Build candidate chain (full, parent1, parent2, …).
|
2. Build candidate chain (full, parent1, parent2, …).
|
||||||
3. Explicit rules per §3.10 precedence, allow before block at each level: exact rules against every candidate in the chain, then wildcard patterns and then regex patterns against the whole name (both kinds express their own reach, so neither walks the chain).
|
3. Explicit rules per §3.10 precedence, allow before block at each level: exact rules against every candidate in the chain, then wildcard patterns and then regex patterns against the whole name (both kinds express their own reach, so neither walks the chain).
|
||||||
@@ -300,25 +291,18 @@ for matching):
|
|||||||
6. Group's blocklist wildcards, matched against every proper parent of the query name.
|
6. Group's blocklist wildcards, matched against every proper parent of the query name.
|
||||||
7. No match → allow.
|
7. No match → allow.
|
||||||
|
|
||||||
Blocklist *domain* entries do not parent-walk: they are matched against the query name alone. Wildcard
|
Blocklist *domain* entries do not parent-walk: they are matched against the query name alone. Wildcard entries match every proper parent, and exception entries walk the candidate chain the way rules do (§3.9), so `@@||good.ads.example^` also lifts `y.good.ads.example`. ABP `||x.y^` emits both a domain entry `x.y` and a wildcard entry `x.y`, which together give domain-and-subdomains semantics.
|
||||||
entries match every proper parent, and exception entries walk the candidate chain the way rules do
|
|
||||||
(§3.9), so `@@||good.ads.example^` also lifts `y.good.ads.example`. ABP `||x.y^` emits both a domain
|
|
||||||
entry `x.y` and a wildcard entry `x.y`, which together give domain-and-subdomains semantics.
|
|
||||||
|
|
||||||
### 7.2 Group Assignment
|
### 7.2 Group Assignment
|
||||||
|
|
||||||
- Per source IP: (1) exact match in `clients`, (2) longest-prefix match in `client_prefixes` (ties: longer prefix, then priority), (3) `default` group.
|
- Per source IP: (1) exact match in `clients`, (2) longest-prefix match in `client_prefixes` (ties: longer prefix, then priority), (3) `default` group.
|
||||||
- Auto-materialization: first query from an unseen IP inserts a `clients` row (`hand_edited=0`, `first_seen=now`) for UI visibility and stable group assignment. The query log does **not** FK to it (§3.6).
|
- Auto-materialization: first query from an unseen IP inserts a `clients` row (`hand_edited=0`, `first_seen=now`) for UI visibility and stable group assignment. The query log does **not** FK to it (§3.6).
|
||||||
|
- Materialized clients name themselves: the tracker's flush pass sends one PTR query per unnamed row through the declared forward zones (§6.5), and the answer is runtime state in `learned_name`, never configuration.
|
||||||
- Retention drops `hand_edited=0` clients with no queries in `retention_days`.
|
- Retention drops `hand_edited=0` clients with no queries in `retention_days`.
|
||||||
|
|
||||||
### 7.3 Reload
|
### 7.3 Reload
|
||||||
|
|
||||||
New immutable matcher built from DB + compiled list files → swap under an `std.Io.RwLock` with a
|
New immutable matcher built from DB + compiled list files → swap under an `std.Io.RwLock` with a generation counter. Readers take the shared lock for the microseconds of one evaluate; the writer takes the exclusive lock only for the swap, and the source status table is installed in the same critical section, so a failed reload publishes neither. (Deliberate deviation from "readers lock-free": freeing the old snapshot without a lock needs epoch-based reclamation, unjustifiable at household scale — see specs/milestone-5.md S8.3.)
|
||||||
generation counter. Readers take the shared lock for the microseconds of one evaluate; the writer
|
|
||||||
takes the exclusive lock only for the swap, and the source status table is installed in the same
|
|
||||||
critical section, so a failed reload publishes neither. (Deliberate deviation from "readers
|
|
||||||
lock-free": freeing the old snapshot without a lock needs epoch-based reclamation, unjustifiable at
|
|
||||||
household scale — see specs/milestone-5.md S8.3.)
|
|
||||||
|
|
||||||
### 7.4 Safe-Search
|
### 7.4 Safe-Search
|
||||||
|
|
||||||
@@ -364,14 +348,9 @@ Per-group boolean. Rewrites known engine domains to their safe-search CNAME targ
|
|||||||
|
|
||||||
### 11.2 config.db Schema (v1 baseline)
|
### 11.2 config.db Schema (v1 baseline)
|
||||||
|
|
||||||
The DDL below is the live schema, kept byte-identical to
|
The DDL below is the live schema, kept byte-identical to `src/storage/config_schema.zig`. `src/storage/migrations.zig` carries it as its one and only step, so a database is at **version 1** or it does not exist.
|
||||||
`src/storage/config_schema.zig`. `src/storage/migrations.zig` carries it as its
|
|
||||||
one and only step, so a database is at **version 1** or it does not exist.
|
|
||||||
|
|
||||||
Until nxdns reaches v0.1 this baseline is **editable**: a schema change edits
|
Until nxdns reaches v0.1 this baseline is **editable**: a schema change edits this section and `config_schema.zig` together and adds no migration step. nxdns has no installs, so there is no database for a step to reconcile. At v0.1 the baseline freezes and every later change becomes an append-only step.
|
||||||
this section and `config_schema.zig` together and adds no migration step. nxdns
|
|
||||||
has no installs, so there is no database for a step to reconcile. At v0.1 the
|
|
||||||
baseline freezes and every later change becomes an append-only step.
|
|
||||||
|
|
||||||
```sql
|
```sql
|
||||||
CREATE TABLE schema_version (version INTEGER NOT NULL);
|
CREATE TABLE schema_version (version INTEGER NOT NULL);
|
||||||
@@ -387,6 +366,8 @@ CREATE TABLE clients (
|
|||||||
id INTEGER PRIMARY KEY,
|
id INTEGER PRIMARY KEY,
|
||||||
ip TEXT NOT NULL UNIQUE, -- canonical text form (v4 dotted / v6 RFC 5952)
|
ip TEXT NOT NULL UNIQUE, -- canonical text form (v4 dotted / v6 RFC 5952)
|
||||||
name TEXT,
|
name TEXT,
|
||||||
|
learned_name TEXT,
|
||||||
|
name_attempt_after INTEGER NOT NULL DEFAULT 0,
|
||||||
group_id INTEGER NOT NULL REFERENCES groups(id),
|
group_id INTEGER NOT NULL REFERENCES groups(id),
|
||||||
hand_edited INTEGER NOT NULL DEFAULT 0,
|
hand_edited INTEGER NOT NULL DEFAULT 0,
|
||||||
first_seen INTEGER NOT NULL,
|
first_seen INTEGER NOT NULL,
|
||||||
@@ -506,14 +487,7 @@ Periodic delete of rows older than `retention_days`; scheduled checkpoint/VACUUM
|
|||||||
|
|
||||||
### 12.1 Config ZON Shape
|
### 12.1 Config ZON Shape
|
||||||
|
|
||||||
The canonical shape is not duplicated here. It lives in
|
The canonical shape is not duplicated here. It lives in [docs/reference/configuration.md](docs/reference/configuration.md), which is handwritten against `config/model.zig` and only partly guarded (the drift test covers settings-key rows, not the whole shape, so a new collection can go undocumented while the guard stays green), and `nxdns export` emits it. A copy in this document is how §12.1 came to describe an `.upstream.servers` field that never existed and to omit the required `.groups` and `.upstreams` — a sample nobody could load. The skeleton, for orientation only:
|
||||||
[docs/reference/configuration.md](docs/reference/configuration.md), which is
|
|
||||||
handwritten against `config/model.zig` and only partly guarded (the drift test
|
|
||||||
covers settings-key rows, not the whole shape, so a new collection can go
|
|
||||||
undocumented while the guard stays green), and `nxdns export` emits it. A copy in
|
|
||||||
this document is how §12.1 came to describe an `.upstream.servers` field that
|
|
||||||
never existed and to omit the required `.groups` and `.upstreams` — a sample
|
|
||||||
nobody could load. The skeleton, for orientation only:
|
|
||||||
|
|
||||||
```zon
|
```zon
|
||||||
.{
|
.{
|
||||||
@@ -581,48 +555,37 @@ Requirements: responsive desktop/mobile; route loaders for initial fetch; TanSta
|
|||||||
## 16. Implementation Order
|
## 16. Implementation Order
|
||||||
|
|
||||||
### Phase 0 — Build Baseline
|
### Phase 0 — Build Baseline
|
||||||
Scaffold tree; `build.zig` with 0.16 assertion, musl targets, vendored sqlite3 + mbedtls compiling; version plumbing; Gitea Actions workflows (test, integration, fuzz smoke, OpenAPI lint, frontend build).
|
Scaffold tree; `build.zig` with 0.16 assertion, musl targets, vendored sqlite3 + mbedtls compiling; version plumbing; Gitea Actions workflows (test, integration, fuzz smoke, OpenAPI lint, frontend build). Exit: cross-compiled hello-world linking both C deps on both targets; CI green.
|
||||||
Exit: cross-compiled hello-world linking both C deps on both targets; CI green.
|
|
||||||
|
|
||||||
### Phase 1 — Platform Layer
|
### Phase 1 — Platform Layer
|
||||||
`platform/address.zig` (v4/v6 parity + canonical keys); `platform/tls_client.zig` (deadlines, error classes); `platform/tls_server.zig` (mbedTLS handshake → `std.Io.Reader`/`Writer`).
|
`platform/address.zig` (v4/v6 parity + canonical keys); `platform/tls_client.zig` (deadlines, error classes); `platform/tls_server.zig` (mbedTLS handshake → `std.Io.Reader`/`Writer`). Exit: UDP echo over `std.Io`; TLS client handshake against a real host; mbedTLS server terminating a loopback TLS connection.
|
||||||
Exit: UDP echo over `std.Io`; TLS client handshake against a real host; mbedTLS server terminating a loopback TLS connection.
|
|
||||||
|
|
||||||
### Phase 2 — DNS Core
|
### Phase 2 — DNS Core
|
||||||
Types/header/name/question/record/packet; parser + encoder tests + fuzz target; EDNS + DO passthrough.
|
Types/header/name/question/record/packet; parser + encoder tests + fuzz target; EDNS + DO passthrough. Exit: unit + fuzz smoke pass.
|
||||||
Exit: unit + fuzz smoke pass.
|
|
||||||
|
|
||||||
### Phase 3 — Resolver Transport
|
### Phase 3 — Resolver Transport
|
||||||
UDP server, TCP server, DoH + DoT upstream clients, pool + failover/backoff + health.
|
UDP server, TCP server, DoH + DoT upstream clients, pool + failover/backoff + health. Exit: A/AAAA forwarding over UDP + TCP; health populated.
|
||||||
Exit: A/AAAA forwarding over UDP + TCP; health populated.
|
|
||||||
|
|
||||||
### Phase 4 — Storage + Config
|
### Phase 4 — Storage + Config
|
||||||
SQLite wrapper; config.db schema + migration runner; querylog.db schema + recreate-on-mismatch; repositories; ZON loading + import/export; `nxdns check`.
|
SQLite wrapper; config.db schema + migration runner; querylog.db schema + recreate-on-mismatch; repositories; ZON loading + import/export; `nxdns check`. Exit: export → import round-trips byte-stable. (The ZON bootstrap this phase shipped was replaced in m20 by the two authority modes above.)
|
||||||
Exit: export → import round-trips byte-stable. (The ZON bootstrap this phase shipped was replaced in m20 by the two authority modes above.)
|
|
||||||
|
|
||||||
### Phase 5 — Filtering + Local DNS
|
### Phase 5 — Filtering + Local DNS
|
||||||
Rule matcher (exact/parent/wildcard; `regex` added in m21); blocklist parsers → compiled file format; fetcher + scheduled update; RCU swap; per-group safe-search; local records; forward zones.
|
Rule matcher (exact/parent/wildcard; `regex` added in m21); blocklist parsers → compiled file format; fetcher + scheduled update; RCU swap; per-group safe-search; local records; forward zones. Exit: precedence table validated by tests; local zone answers + conditional forwards work.
|
||||||
Exit: precedence table validated by tests; local zone answers + conditional forwards work.
|
|
||||||
|
|
||||||
### Phase 6 — Cache + Rate Limit + Logging + Disk Monitor
|
### Phase 6 — Cache + Rate Limit + Logging + Disk Monitor
|
||||||
TTL cache + reconstruction; v4/v6 rate limiter; async query logger + backpressure + retention; DiskMonitor + rotation + error-log dedup.
|
TTL cache + reconstruction; v4/v6 rate limiter; async query logger + backpressure + retention; DiskMonitor + rotation + error-log dedup. Exit: disk thresholds trigger degradation + drop counters in integration test.
|
||||||
Exit: disk thresholds trigger degradation + drop counters in integration test.
|
|
||||||
|
|
||||||
### Phase 7 — Handler Integration
|
### Phase 7 — Handler Integration
|
||||||
Full pipeline composition; CNAME uncloaking; pause/resume.
|
Full pipeline composition; CNAME uncloaking; pause/resume. Exit: end-to-end DNS flow with blocking, local records, cache, failover.
|
||||||
Exit: end-to-end DNS flow with blocking, local records, cache, failover.
|
|
||||||
|
|
||||||
### Phase 8 — Web / API / SSE / Auth / Metrics
|
### Phase 8 — Web / API / SSE / Auth / Metrics
|
||||||
HTTP server + router; handlers; SSE; optional auth; API rate limiting; `/metrics`; OpenAPI served + contract tests; embedded frontend + dev-mode disk serving.
|
HTTP server + router; handlers; SSE; optional auth; API rate limiting; `/metrics`; OpenAPI served + contract tests; embedded frontend + dev-mode disk serving. Exit: frontend fully drives config and operations; contract tests green.
|
||||||
Exit: frontend fully drives config and operations; contract tests green.
|
|
||||||
|
|
||||||
### Phase 9 — Local DoH/DoT Endpoints
|
### Phase 9 — Local DoH/DoT Endpoints
|
||||||
DoH server + DoT server on `platform/tls_server.zig`; cert watcher + reload.
|
DoH server + DoT server on `platform/tls_server.zig`; cert watcher + reload. Exit: LAN client resolves via DoH and DoT against local certs.
|
||||||
Exit: LAN client resolves via DoH and DoT against local certs.
|
|
||||||
|
|
||||||
### Phase 10 — Packaging + Ops + Docs
|
### Phase 10 — Packaging + Ops + Docs
|
||||||
systemd unit (`AmbientCapabilities=CAP_NET_BIND_SERVICE`, hardened, writable `/var/lib/nxdns` + optional `/var/log/nxdns`); Dockerfile + compose (53/udp+tcp, 8080; mounts `/etc/nxdns`, `/var/lib/nxdns`); operator/architecture/config-reference/API docs.
|
systemd unit (`AmbientCapabilities=CAP_NET_BIND_SERVICE`, hardened, writable `/var/lib/nxdns` + optional `/var/log/nxdns`); Dockerfile + compose (53/udp+tcp, 8080; mounts `/etc/nxdns`, `/var/lib/nxdns`); operator/architecture/config-reference/API docs. Exit: documented deployment works end-to-end on the Pi 5.
|
||||||
Exit: documented deployment works end-to-end on the Pi 5.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -657,9 +620,7 @@ Exit: documented deployment works end-to-end on the Pi 5.
|
|||||||
|
|
||||||
## 20. Publication
|
## 20. Publication
|
||||||
|
|
||||||
The project publishes released binaries and container images from its own Gitea
|
The project publishes released binaries and container images from its own Gitea instance. Building from source stays fully supported and documented; it is no longer the only path.
|
||||||
instance. Building from source stays fully supported and documented; it is no
|
|
||||||
longer the only path.
|
|
||||||
|
|
||||||
- **Trigger.** Pushing an annotated, GPG-signed tag `vX.Y.Z` to `git.mial.net/mokhtar/nxdns`. Nothing else publishes. Pre-release tags are rejected.
|
- **Trigger.** Pushing an annotated, GPG-signed tag `vX.Y.Z` to `git.mial.net/mokhtar/nxdns`. Nothing else publishes. Pre-release tags are rejected.
|
||||||
- **Version.** The tag is authoritative. `build.zig.zon`'s `.version` must equal the tag, and the packaging gate asserts it. Nowhere else stores a version.
|
- **Version.** The tag is authoritative. `build.zig.zon`'s `.version` must equal the tag, and the packaging gate asserts it. Nowhere else stores a version.
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
# nxdns
|
# nxdns
|
||||||
|
|
||||||
nxdns is a DNS sinkhole for your LAN. It blocks the names you do not want, and
|
nxdns is a DNS sinkhole for your LAN. It blocks the names you do not want, and forwards the rest over an encrypted connection.
|
||||||
forwards the rest over an encrypted connection.
|
|
||||||
|
|
||||||
```mermaid
|
```mermaid
|
||||||
flowchart LR
|
flowchart LR
|
||||||
@@ -12,49 +11,30 @@ flowchart LR
|
|||||||
nxdns -- "blocked" --> sink["0.0.0.0 / NXDOMAIN"]
|
nxdns -- "blocked" --> sink["0.0.0.0 / NXDOMAIN"]
|
||||||
```
|
```
|
||||||
|
|
||||||
One static Zig binary. SQLite holds the state and the query log, which the web
|
One static Zig binary. SQLite holds the state and the query log, which the web UI, the REST API and `/metrics` read.
|
||||||
UI, the REST API and `/metrics` read.
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Blocklist filtering: subscribe to hosts, domain and Adblock Plus lists —
|
- Blocklist filtering: subscribe to hosts, domain and Adblock Plus lists — whose `@@` exception lines are honoured — plus your own allow and block rules, exact, wildcard (`*.example.com`) or regular expression
|
||||||
whose `@@` exception lines are honoured — plus your own allow and block rules,
|
- Two configuration modes: a database the web UI edits, or a ZON file you keep in git and converge onto at every start
|
||||||
exact, wildcard (`*.example.com`) or regular expression
|
- Per-client policy groups: different filtering for the kids' tablet and your workstation
|
||||||
- Two configuration modes: a database the web UI edits, or a ZON file you keep
|
|
||||||
in git and converge onto at every start
|
|
||||||
- Per-client policy groups: different filtering for the kids' tablet and
|
|
||||||
your workstation
|
|
||||||
- Local DNS records and conditional forwarding for internal zones
|
- Local DNS records and conditional forwarding for internal zones
|
||||||
- Encrypted upstreams: DNS-over-HTTPS and DNS-over-TLS with failover
|
- Encrypted upstreams: DNS-over-HTTPS and DNS-over-TLS with failover
|
||||||
- Built-in DoH and DoT server endpoints, with certificate hot-reload
|
- Built-in DoH and DoT server endpoints, with certificate hot-reload
|
||||||
- Bounded in-memory DNS cache with TTL-respecting expiry
|
- Bounded in-memory DNS cache with TTL-respecting expiry
|
||||||
- Query log with retention limits, live-streamed over SSE
|
- Query log with retention limits, live-streamed over SSE
|
||||||
- Web UI (embedded in the binary) and a REST API with a served OpenAPI spec
|
- Web UI (embedded in the binary) and a REST API with a served OpenAPI spec
|
||||||
- Prometheus-style `/metrics`, per-client rate limiting, disk-full
|
- Prometheus-style `/metrics`, per-client rate limiting, disk-full self-protection
|
||||||
self-protection
|
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
**No release exists yet.** This repository has no tags, nothing has been
|
**No release exists yet.** This repository has no tags, nothing has been published to <https://git.mial.net/mokhtar/nxdns/releases>, and no container image has been pushed. Every release URL on this page and in the how-to guides is a 404 today, and `docker pull` finds nothing. Until the first tag ships, building from source is the only way to get nxdns.
|
||||||
published to <https://git.mial.net/mokhtar/nxdns/releases>, and no container
|
|
||||||
image has been pushed. Every release URL on this page and in the how-to guides
|
|
||||||
is a 404 today, and `docker pull` finds nothing. Until the first tag ships,
|
|
||||||
building from source is the only way to get nxdns.
|
|
||||||
|
|
||||||
What a tag will publish, once one exists: five assets — two static musl
|
What a tag will publish, once one exists: five assets — two static musl tarballs (`nxdns-<version>-x86_64-linux-musl.tar.gz`, `nxdns-<version>-aarch64-linux-musl.tar.gz`), `IMAGE-DIGEST.txt` naming the multi-architecture container image by digest, `SHA256SUMS.txt` covering those three files, and `SHA256SUMS.txt.asc`, a detached OpenPGP signature over the checksum file. Verify what you downloaded before you run it: [docs/how-to/verify-a-release.md](docs/how-to/verify-a-release.md), which also says what that signature does and does not prove.
|
||||||
tarballs (`nxdns-<version>-x86_64-linux-musl.tar.gz`,
|
|
||||||
`nxdns-<version>-aarch64-linux-musl.tar.gz`), `IMAGE-DIGEST.txt` naming the
|
|
||||||
multi-architecture container image by digest, `SHA256SUMS.txt` covering those
|
|
||||||
three files, and `SHA256SUMS.txt.asc`, a detached OpenPGP signature over the
|
|
||||||
checksum file. Verify what you downloaded before you run it:
|
|
||||||
[docs/how-to/verify-a-release.md](docs/how-to/verify-a-release.md), which also
|
|
||||||
says what that signature does and does not prove.
|
|
||||||
|
|
||||||
## Quickstart (docker compose)
|
## Quickstart (docker compose)
|
||||||
|
|
||||||
Write a minimal configuration and start the published image. This is what the
|
Write a minimal configuration and start the published image. This is what the first release will make possible; it does not work today, because there is no image in the registry to pull:
|
||||||
first release will make possible; it does not work today, because there is no
|
|
||||||
image in the registry to pull:
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
cd deploy/docker
|
cd deploy/docker
|
||||||
@@ -69,90 +49,52 @@ EOF
|
|||||||
NXDNS_VERSION=<version> docker compose up -d
|
NXDNS_VERSION=<version> docker compose up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
The compose file defaults to `:latest`; pin a version for anything you intend
|
The compose file defaults to `:latest`; pin a version for anything you intend to keep running. To run it before a release exists, build the image yourself and name it — `NXDNS_IMAGE=nxdns docker compose up -d` — as [docs/how-to/install-with-docker.md](docs/how-to/install-with-docker.md) describes. DNS is on port 53, the web UI on <http://localhost:8080>.
|
||||||
to keep running. To run it before a release exists, build the image yourself and
|
|
||||||
name it — `NXDNS_IMAGE=nxdns docker compose up -d` — as
|
|
||||||
[docs/how-to/install-with-docker.md](docs/how-to/install-with-docker.md)
|
|
||||||
describes. DNS is on port 53, the web UI on <http://localhost:8080>.
|
|
||||||
|
|
||||||
The compose file runs `nxdns run --config=/etc/nxdns/config.zon`, which makes
|
The compose file runs `nxdns run --config=/etc/nxdns/config.zon`, which makes that file the configuration: every start reconciles the database onto it, and the UI refuses configuration edits. Edit the file and restart to change anything. Drop the `command:` line to run bare `nxdns run` instead, where the database is the configuration and changes go through the UI, the API, or `nxdns export` / `nxdns import` — the packaged systemd unit does that. Which mode is live is printed at every start (`authority: database` / `authority: file (<path>)`); see [docs/explanation/configuration-model.md](docs/explanation/configuration-model.md).
|
||||||
that file the configuration: every start reconciles the database onto it, and
|
|
||||||
the UI refuses configuration edits. Edit the file and restart to change
|
|
||||||
anything. Drop the `command:` line to run bare `nxdns run` instead, where the
|
|
||||||
database is the configuration and changes go through the UI, the API, or
|
|
||||||
`nxdns export` / `nxdns import` — the packaged systemd unit does that. Which
|
|
||||||
mode is live is printed at every start (`authority: database` /
|
|
||||||
`authority: file (<path>)`); see
|
|
||||||
[docs/explanation/configuration-model.md](docs/explanation/configuration-model.md).
|
|
||||||
|
|
||||||
Full install instructions, including the systemd path and the Pi 5 recipe, are
|
Full install instructions, including the systemd path and the Pi 5 recipe, are in [docs/how-to/install-with-systemd.md](docs/how-to/install-with-systemd.md) and [docs/how-to/install-with-docker.md](docs/how-to/install-with-docker.md).
|
||||||
in
|
|
||||||
[docs/how-to/install-with-systemd.md](docs/how-to/install-with-systemd.md) and
|
|
||||||
[docs/how-to/install-with-docker.md](docs/how-to/install-with-docker.md).
|
|
||||||
|
|
||||||
## Building from source
|
## Building from source
|
||||||
|
|
||||||
Requires [Zig 0.16.0](https://ziglang.org/download/) and Node.js 24 (for
|
Requires [Zig 0.16.0](https://ziglang.org/download/) and Node.js 24 (for the web UI). C dependencies (SQLite, mbedTLS) are vendored and built by `zig build`.
|
||||||
the web UI). C dependencies (SQLite, mbedTLS) are vendored and built by
|
|
||||||
`zig build`.
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
(cd web && npm ci && npm run build) # web UI -> web/dist
|
(cd admin && npm ci && npm run build) # web UI -> admin/dist
|
||||||
zig build -Dweb-dist=web/dist # native binary -> zig-out/bin/nxdns
|
zig build -Dadmin-dist=admin/dist # native binary -> zig-out/bin/nxdns
|
||||||
zig build test --summary all # unit tests
|
zig build test --summary all # unit tests
|
||||||
```
|
```
|
||||||
|
|
||||||
The release artifacts come out of the same build graph, so the whole release
|
The release artifacts come out of the same build graph, so the whole release build runs on a laptop exactly as it runs on the CI runner:
|
||||||
build runs on a laptop exactly as it runs on the CI runner:
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
(cd web && npm ci && npm run build) # required: dist refuses the placeholder
|
(cd admin && npm ci && npm run build) # required: dist refuses the placeholder
|
||||||
VERSION=$(sed -n 's/^[[:space:]]*\.version[[:space:]]*=[[:space:]]*"\([^"]*\)".*/\1/p' build.zig.zon)
|
VERSION=$(sed -n 's/^[[:space:]]*\.version[[:space:]]*=[[:space:]]*"\([^"]*\)".*/\1/p' build.zig.zon)
|
||||||
zig build dist -Dversion-string="$VERSION" -Dgit-commit=$(git rev-parse HEAD) \
|
zig build dist -Dversion-string="$VERSION" -Dgit-commit=$(git rev-parse HEAD) \
|
||||||
-Dweb-dist=web/dist -Doptimize=ReleaseSafe # tarballs -> zig-out/dist/
|
-Dadmin-dist=admin/dist -Doptimize=ReleaseSafe # tarballs -> zig-out/dist/
|
||||||
zig build verify-dist -Dversion-string="$VERSION" -Dgit-commit=$(git rev-parse HEAD) \
|
zig build verify-dist -Dversion-string="$VERSION" -Dgit-commit=$(git rev-parse HEAD) \
|
||||||
-Dweb-dist=web/dist -Doptimize=ReleaseSafe # the release checks
|
-Dadmin-dist=admin/dist -Doptimize=ReleaseSafe # the release checks
|
||||||
```
|
```
|
||||||
|
|
||||||
The version comes from `build.zig.zon` because `verify-dist` asserts the two
|
The version comes from `build.zig.zon` because `verify-dist` asserts the two agree; a tag sets both.
|
||||||
agree; a tag sets both.
|
|
||||||
|
|
||||||
That is not a claim that your tarball will hash the same as a published one.
|
That is not a claim that your tarball will hash the same as a published one. Nothing in this project measures whether two builds of the same commit on two different machines land on the same bytes, so no document here describes the build as reproducible. The gate that would settle it is a recorded deferral — `specs/milestone-14.md` ruling 12 — and [docs/how-to/verify-a-release.md](docs/how-to/verify-a-release.md) explains what a matching or differing hash is worth in the meantime.
|
||||||
Nothing in this project measures whether two builds of the same commit on two
|
|
||||||
different machines land on the same bytes, so no document here describes the
|
|
||||||
build as reproducible. The gate that would settle it is a recorded deferral —
|
|
||||||
`specs/milestone-14.md` ruling 12 — and
|
|
||||||
[docs/how-to/verify-a-release.md](docs/how-to/verify-a-release.md) explains what
|
|
||||||
a matching or differing hash is worth in the meantime.
|
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
Start at [docs/README.md](docs/README.md), which splits the documentation
|
Start at [docs/README.md](docs/README.md), which splits the documentation into a tutorial, how-to guides, reference and explanation.
|
||||||
into a tutorial, how-to guides, reference and explanation.
|
|
||||||
|
|
||||||
- [docs/tutorial/first-run.md](docs/tutorial/first-run.md) — build it, resolve
|
- [docs/tutorial/first-run.md](docs/tutorial/first-run.md) — build it, resolve a name, block a domain, on a scratch directory
|
||||||
a name, block a domain, on a scratch directory
|
- [docs/how-to/install-with-systemd.md](docs/how-to/install-with-systemd.md) — a real install, including the Raspberry Pi 5
|
||||||
- [docs/how-to/install-with-systemd.md](docs/how-to/install-with-systemd.md) —
|
- [docs/how-to/verify-a-release.md](docs/how-to/verify-a-release.md) — checking the hashes and the signature before you install
|
||||||
a real install, including the Raspberry Pi 5
|
- [docs/reference/configuration.md](docs/reference/configuration.md) — every configuration field
|
||||||
- [docs/how-to/verify-a-release.md](docs/how-to/verify-a-release.md) — checking
|
|
||||||
the hashes and the signature before you install
|
|
||||||
- [docs/reference/configuration.md](docs/reference/configuration.md) — every
|
|
||||||
configuration field
|
|
||||||
- [docs/reference/api.md](docs/reference/api.md) — REST API, auth and SSE
|
- [docs/reference/api.md](docs/reference/api.md) — REST API, auth and SSE
|
||||||
- [docs/reference/cli.md](docs/reference/cli.md) — subcommands, flags and exit
|
- [docs/reference/cli.md](docs/reference/cli.md) — subcommands, flags and exit codes
|
||||||
codes
|
- [docs/explanation/architecture.md](docs/explanation/architecture.md) — module map and design
|
||||||
- [docs/explanation/architecture.md](docs/explanation/architecture.md) — module
|
- [PLAN.md](PLAN.md) and [specs/](specs/) — scope, design decisions and per-milestone contracts
|
||||||
map and design
|
|
||||||
- [PLAN.md](PLAN.md) and [specs/](specs/) — scope, design decisions and
|
|
||||||
per-milestone contracts
|
|
||||||
|
|
||||||
## Licence
|
## Licence
|
||||||
|
|
||||||
Copyright (c) 2026 Mokhtar Mial. nxdns is licensed under the European Union
|
Copyright (c) 2026 Mokhtar Mial. nxdns is licensed under the European Union Public Licence v. 1.2 (`EUPL-1.2`); the full text is in [LICENSE](LICENSE).
|
||||||
Public Licence v. 1.2 (`EUPL-1.2`); the full text is in [LICENSE](LICENSE).
|
|
||||||
|
|
||||||
Every released tarball and image carries a `THIRD-PARTY-NOTICES` file assembled
|
Every released tarball and image carries a `THIRD-PARTY-NOTICES` file assembled from the reviewed inventory in [licenses/](licenses/), which covers what the artifacts actually contain: musl, the Zig runtime, SQLite, Mbed TLS and its vendored Everest and p256-m code, and the JavaScript and CSS bundled into the admin UI.
|
||||||
from the reviewed inventory in [licenses/](licenses/), which covers what the
|
|
||||||
artifacts actually contain: musl, the Zig runtime, SQLite, Mbed TLS and its
|
|
||||||
vendored Everest and p256-m code, and the JavaScript and CSS bundled into the
|
|
||||||
admin UI.
|
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 303 B After Width: | Height: | Size: 303 B |
+2
-2
@@ -1,11 +1,11 @@
|
|||||||
{
|
{
|
||||||
"name": "nxdns-web",
|
"name": "nxdns-admin",
|
||||||
"version": "0.0.0",
|
"version": "0.0.0",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "nxdns-web",
|
"name": "nxdns-admin",
|
||||||
"version": "0.0.0",
|
"version": "0.0.0",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@stylexjs/stylex": "0.19.0",
|
"@stylexjs/stylex": "0.19.0",
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
{
|
{
|
||||||
"name": "nxdns-web",
|
"name": "nxdns-admin",
|
||||||
"private": true,
|
"private": true,
|
||||||
"version": "0.0.0",
|
"version": "0.0.0",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
|
Before Width: | Height: | Size: 262 B After Width: | Height: | Size: 262 B |
@@ -1,11 +1,11 @@
|
|||||||
#!/usr/bin/env node
|
#!/usr/bin/env node
|
||||||
// The set of npm packages whose bytes reach web/dist must be exactly the set
|
// The set of npm packages whose bytes reach admin/dist must be exactly the set
|
||||||
// recorded in licenses/dependency-identity.txt (milestone-14 ruling 3).
|
// recorded in licenses/dependency-identity.txt (milestone-14 ruling 3).
|
||||||
//
|
//
|
||||||
// The shipped build carries no sourcemaps, so this makes a second build with
|
// The shipped build carries no sourcemaps, so this makes a second build with
|
||||||
// them into its own directory: the `sources` list of each chunk names the
|
// them into its own directory: the `sources` list of each chunk names the
|
||||||
// modules that went into it, and the artifact `npm run build` produced stays
|
// modules that went into it, and the artifact `npm run build` produced stays
|
||||||
// untouched. Runs from web/ as `npm run assert-bundled`, on a laptop exactly as
|
// untouched. Runs from admin/ as `npm run assert-bundled`, on a laptop exactly as
|
||||||
// on the runner.
|
// on the runner.
|
||||||
|
|
||||||
import { execFileSync } from "node:child_process";
|
import { execFileSync } from "node:child_process";
|
||||||
@@ -85,10 +85,10 @@ try {
|
|||||||
|
|
||||||
const recorded = recordedPackages(identity);
|
const recorded = recordedPackages(identity);
|
||||||
if (recorded === null) {
|
if (recorded === null) {
|
||||||
fail("assert-bundled: licenses/dependency-identity.txt has no '[npm packages bundled into web/dist]' section");
|
fail("assert-bundled: licenses/dependency-identity.txt has no '[npm packages bundled into admin/dist]' section");
|
||||||
}
|
}
|
||||||
if (recorded.length === 0) {
|
if (recorded.length === 0) {
|
||||||
fail("assert-bundled: the '[npm packages bundled into web/dist]' section is empty");
|
fail("assert-bundled: the '[npm packages bundled into admin/dist]' section is empty");
|
||||||
}
|
}
|
||||||
|
|
||||||
const { added, removed } = comparePackages(recorded, bundled);
|
const { added, removed } = comparePackages(recorded, bundled);
|
||||||
@@ -96,12 +96,12 @@ if (added.length !== 0 || removed.length !== 0) {
|
|||||||
process.stderr.write(`${formatDiff(recorded, bundled)}\n\n`);
|
process.stderr.write(`${formatDiff(recorded, bundled)}\n\n`);
|
||||||
fail(
|
fail(
|
||||||
[
|
[
|
||||||
"the set of npm packages in web/dist has changed (-recorded +current).",
|
"the set of npm packages in admin/dist has changed (-recorded +current).",
|
||||||
"Work out what the change means for licenses/inventory.zon first, then record",
|
"Work out what the change means for licenses/inventory.zon first, then record",
|
||||||
"the new list in that section of licenses/dependency-identity.txt.",
|
"the new list in that section of licenses/dependency-identity.txt.",
|
||||||
].join("\n"),
|
].join("\n"),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
process.stdout.write(`web/dist bundles exactly the ${bundled.length} recorded packages:\n`);
|
process.stdout.write(`admin/dist bundles exactly the ${bundled.length} recorded packages:\n`);
|
||||||
for (const name of bundled) process.stdout.write(`${name}\n`);
|
for (const name of bundled) process.stdout.write(`${name}\n`);
|
||||||
@@ -14,7 +14,7 @@
|
|||||||
// brace inside a string blinds the stripper; and with several stylesheets it
|
// brace inside a string blinds the stripper; and with several stylesheets it
|
||||||
// judges each alone, not their load order in the document.
|
// judges each alone, not their load order in the document.
|
||||||
//
|
//
|
||||||
// This check runs from web/ as part of `npm run build`.
|
// This check runs from admin/ as part of `npm run build`.
|
||||||
|
|
||||||
import { readdirSync, readFileSync } from "node:fs";
|
import { readdirSync, readFileSync } from "node:fs";
|
||||||
import { dirname, join } from "node:path";
|
import { dirname, join } from "node:path";
|
||||||
@@ -110,7 +110,7 @@ for (const sheet of sheets) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (failed) {
|
if (failed) {
|
||||||
console.error("Wrap it in a layer declared before StyleX's, as web/src/styles.css does.");
|
console.error("Wrap it in a layer declared before StyleX's, as admin/src/styles.css does.");
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
}
|
}
|
||||||
console.log(
|
console.log(
|
||||||
@@ -8,7 +8,7 @@
|
|||||||
// lockfile, no version and no dependency set changes — only the bundle does. So
|
// lockfile, no version and no dependency set changes — only the bundle does. So
|
||||||
// the bundle is what this reads.
|
// the bundle is what this reads.
|
||||||
|
|
||||||
const sectionHeading = "[npm packages bundled into web/dist]";
|
const sectionHeading = "[npm packages bundled into admin/dist]";
|
||||||
|
|
||||||
// A sourcemap `sources` entry for a dependency ends in
|
// A sourcemap `sources` entry for a dependency ends in
|
||||||
// `node_modules/<name>/<file>` or `node_modules/@<scope>/<name>/<file>`. Only
|
// `node_modules/<name>/<file>` or `node_modules/@<scope>/<name>/<file>`. Only
|
||||||
@@ -48,7 +48,7 @@ describe("recordedPackages", () => {
|
|||||||
"[some earlier section]",
|
"[some earlier section]",
|
||||||
"ignored",
|
"ignored",
|
||||||
"",
|
"",
|
||||||
"[npm packages bundled into web/dist]",
|
"[npm packages bundled into admin/dist]",
|
||||||
"react",
|
"react",
|
||||||
"@tanstack/react-query",
|
"@tanstack/react-query",
|
||||||
"",
|
"",
|
||||||
@@ -64,7 +64,7 @@ describe("recordedPackages", () => {
|
|||||||
|
|
||||||
it("distinguishes a missing section from an empty one", () => {
|
it("distinguishes a missing section from an empty one", () => {
|
||||||
expect(recordedPackages("[other]\nx\n")).toBeNull();
|
expect(recordedPackages("[other]\nx\n")).toBeNull();
|
||||||
expect(recordedPackages("[npm packages bundled into web/dist]\n\n[next]\n")).toEqual([]);
|
expect(recordedPackages("[npm packages bundled into admin/dist]\n\n[next]\n")).toEqual([]);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
#!/usr/bin/env node
|
#!/usr/bin/env node
|
||||||
// Freshness stamp for web/dist (milestone-15 ruling 5). A stale dist has
|
// Freshness stamp for admin/dist (milestone-15 ruling 5). A stale dist has
|
||||||
// already shipped a crashing settings page once. Write mode runs from web/ as
|
// already shipped a crashing settings page once. Write mode runs from admin/ as
|
||||||
// part of `npm run build`; check mode runs from the repository root as a
|
// part of `npm run build`; check mode runs from the repository root as a
|
||||||
// build.zig system command. Every path resolves from this file's own location
|
// build.zig system command. Every path resolves from this file's own location
|
||||||
// so both working directories hash the same set.
|
// so both working directories hash the same set.
|
||||||
@@ -13,7 +13,7 @@ import { fileURLToPath } from "node:url";
|
|||||||
const webRoot = dirname(dirname(fileURLToPath(import.meta.url)));
|
const webRoot = dirname(dirname(fileURLToPath(import.meta.url)));
|
||||||
const distDir = join(webRoot, "dist");
|
const distDir = join(webRoot, "dist");
|
||||||
const stampFile = join(distDir, ".src-hash");
|
const stampFile = join(distDir, ".src-hash");
|
||||||
const stampRelative = "web/dist/.src-hash";
|
const stampRelative = "admin/dist/.src-hash";
|
||||||
|
|
||||||
const inputDirs = ["src", "public"];
|
const inputDirs = ["src", "public"];
|
||||||
const inputFiles = [
|
const inputFiles = [
|
||||||
@@ -26,7 +26,7 @@ const inputFiles = [
|
|||||||
"tsconfig.node.json",
|
"tsconfig.node.json",
|
||||||
];
|
];
|
||||||
|
|
||||||
const staleMessage = "web/dist is stale: rebuild the frontend (npm run build)";
|
const staleMessage = "admin/dist is stale: rebuild the frontend (npm run build)";
|
||||||
|
|
||||||
function fail(message) {
|
function fail(message) {
|
||||||
process.stderr.write(`${message}\n`);
|
process.stderr.write(`${message}\n`);
|
||||||
@@ -39,7 +39,7 @@ function walk(relativeDir) {
|
|||||||
try {
|
try {
|
||||||
entries = readdirSync(absolute, { withFileTypes: true });
|
entries = readdirSync(absolute, { withFileTypes: true });
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
fail(`stamp-dist: cannot read web/${relativeDir}: ${err.message}`);
|
fail(`stamp-dist: cannot read admin/${relativeDir}: ${err.message}`);
|
||||||
}
|
}
|
||||||
const found = [];
|
const found = [];
|
||||||
for (const entry of entries) {
|
for (const entry of entries) {
|
||||||
@@ -57,9 +57,9 @@ function inputSet() {
|
|||||||
const paths = [...inputFiles, ...inputDirs.flatMap(walk)];
|
const paths = [...inputFiles, ...inputDirs.flatMap(walk)];
|
||||||
for (const path of inputFiles) {
|
for (const path of inputFiles) {
|
||||||
try {
|
try {
|
||||||
if (!statSync(join(webRoot, path)).isFile()) fail(`stamp-dist: web/${path} is not a file`);
|
if (!statSync(join(webRoot, path)).isFile()) fail(`stamp-dist: admin/${path} is not a file`);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
fail(`stamp-dist: cannot stat web/${path}: ${err.message}`);
|
fail(`stamp-dist: cannot stat admin/${path}: ${err.message}`);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// Sorted by path so the digest does not depend on directory order.
|
// Sorted by path so the digest does not depend on directory order.
|
||||||
+5
-2
@@ -47,9 +47,12 @@ const styles = stylex.create({
|
|||||||
export default function ClientEditDialog({ client, groups, onClose }: Props) {
|
export default function ClientEditDialog({ client, groups, onClose }: Props) {
|
||||||
const queryClient = useQueryClient();
|
const queryClient = useQueryClient();
|
||||||
const mutation = useMutation(clientUpdateMutation(queryClient));
|
const mutation = useMutation(clientUpdateMutation(queryClient));
|
||||||
const [name, setName] = useState(client.name);
|
|
||||||
const [groupId, setGroupId] = useState(client.group_id);
|
|
||||||
const readOnly = useReadOnlyConfig();
|
const readOnly = useReadOnlyConfig();
|
||||||
|
// Adopting the learned name as a typed one is the natural gesture, but only
|
||||||
|
// where the save can land: under file authority the PUT answers 403, and the
|
||||||
|
// file's declared name is the one that wins.
|
||||||
|
const [name, setName] = useState(client.name === "" && !readOnly ? client.learned_name : client.name);
|
||||||
|
const [groupId, setGroupId] = useState(client.group_id);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Dialog label={`Edit client ${client.ip}`} isOpen onClose={onClose}>
|
<Dialog label={`Edit client ${client.ip}`} isOpen onClose={onClose}>
|
||||||
+21
@@ -18,6 +18,7 @@ const CLIENTS = {
|
|||||||
id: 1,
|
id: 1,
|
||||||
ip: "192.168.1.10",
|
ip: "192.168.1.10",
|
||||||
name: "laptop",
|
name: "laptop",
|
||||||
|
learned_name: "laptop-1.lan",
|
||||||
group_id: 1,
|
group_id: 1,
|
||||||
group: "default",
|
group: "default",
|
||||||
hand_edited: true,
|
hand_edited: true,
|
||||||
@@ -28,6 +29,7 @@ const CLIENTS = {
|
|||||||
id: 2,
|
id: 2,
|
||||||
ip: "192.168.1.11",
|
ip: "192.168.1.11",
|
||||||
name: "",
|
name: "",
|
||||||
|
learned_name: "kids-tablet.lan",
|
||||||
group_id: 2,
|
group_id: 2,
|
||||||
group: "kids",
|
group: "kids",
|
||||||
hand_edited: false,
|
hand_edited: false,
|
||||||
@@ -95,6 +97,25 @@ test("renders the client table with group names and one hand-edited badge", asyn
|
|||||||
expect(screen.getAllByRole("cell", { name: "kids" })).toHaveLength(1);
|
expect(screen.getAllByRole("cell", { name: "kids" })).toHaveLength(1);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test("a named row shows the typed name and hides the learned one", async () => {
|
||||||
|
await renderClientsPage(BASE);
|
||||||
|
|
||||||
|
expect(screen.getByText("laptop")).toBeTruthy();
|
||||||
|
expect(screen.queryByText("laptop-1.lan")).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an unnamed row shows the learned name with the learned affordance", async () => {
|
||||||
|
await renderClientsPage(BASE);
|
||||||
|
|
||||||
|
// The cell holds the learned name followed by the tag, so the match is on
|
||||||
|
// the containing span rather than on a bare text node.
|
||||||
|
const learned = screen.getByText(
|
||||||
|
(content, element) => element?.tagName === "SPAN" && content.startsWith("kids-tablet.lan"),
|
||||||
|
);
|
||||||
|
// The affordance is text, not colour, so a screen reader announces it too.
|
||||||
|
expect(within(learned).getByText("learned")).toBeTruthy();
|
||||||
|
});
|
||||||
|
|
||||||
test("shows the DNS-activity empty state when there are no clients", async () => {
|
test("shows the DNS-activity empty state when there are no clients", async () => {
|
||||||
await renderClientsPage({ ...BASE, "GET /api/clients": { clients: [] } });
|
await renderClientsPage({ ...BASE, "GET /api/clients": { clients: [] } });
|
||||||
|
|
||||||
+8
-3
@@ -133,10 +133,15 @@ export default function ClientsPage() {
|
|||||||
<tr key={client.id} {...stylex.props(styles.bodyRow)}>
|
<tr key={client.id} {...stylex.props(styles.bodyRow)}>
|
||||||
<td {...stylex.props(styles.cell, shared.mono)}>{client.ip}</td>
|
<td {...stylex.props(styles.cell, shared.mono)}>{client.ip}</td>
|
||||||
<td {...stylex.props(styles.cell)}>
|
<td {...stylex.props(styles.cell)}>
|
||||||
{client.name === "" ? (
|
{client.name !== "" ? (
|
||||||
<span {...stylex.props(styles.dash)}>—</span>
|
|
||||||
) : (
|
|
||||||
client.name
|
client.name
|
||||||
|
) : client.learned_name !== "" ? (
|
||||||
|
<span {...stylex.props(shared.learnedName)}>
|
||||||
|
{client.learned_name}
|
||||||
|
<span {...stylex.props(shared.learnedTag)}>learned</span>
|
||||||
|
</span>
|
||||||
|
) : (
|
||||||
|
<span {...stylex.props(styles.dash)}>—</span>
|
||||||
)}
|
)}
|
||||||
{client.hand_edited && <span {...stylex.props(styles.badge)}>edited</span>}
|
{client.hand_edited && <span {...stylex.props(styles.badge)}>edited</span>}
|
||||||
</td>
|
</td>
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
/**
|
||||||
|
* The client column of the query tables reads as a name wherever one is known,
|
||||||
|
* with the same precedence the Clients page applies: a hand-typed `name` wins,
|
||||||
|
* the reverse-DNS `learned_name` stands in muted behind it, and an address with
|
||||||
|
* neither — including one the loaded list has never seen — stays bare.
|
||||||
|
*
|
||||||
|
* The muted colour is the whole of the affordance here. The Clients page pairs
|
||||||
|
* it with an outlined "learned" tag, and keeps it: one mention per client is
|
||||||
|
* information. Repeating that tag down every row of a query table is noise, so
|
||||||
|
* the tables carry the name alone.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useMemo } from "react";
|
||||||
|
import { useQuery } from "@tanstack/react-query";
|
||||||
|
import * as stylex from "@stylexjs/stylex";
|
||||||
|
import { clientsQuery } from "@/lib/queries";
|
||||||
|
import type { Client } from "@/lib/types";
|
||||||
|
import { styles as shared } from "@/ui/styles";
|
||||||
|
|
||||||
|
export type ClientNames = ReadonlyMap<string, Pick<Client, "name" | "learned_name">>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The live stream names clients the loaded list has never seen. Polling folds
|
||||||
|
* them in on the next tick, which keeps the lookup a single cached query
|
||||||
|
* instead of a fetch fired per unknown address.
|
||||||
|
*/
|
||||||
|
const CLIENTS_POLL_MS = 30_000;
|
||||||
|
|
||||||
|
export function useClientNames(): ClientNames {
|
||||||
|
const { data } = useQuery({ ...clientsQuery(), refetchInterval: CLIENTS_POLL_MS });
|
||||||
|
return useMemo(
|
||||||
|
() =>
|
||||||
|
new Map(
|
||||||
|
(data ?? []).map((client) => [client.ip, { name: client.name, learned_name: client.learned_name }]),
|
||||||
|
),
|
||||||
|
[data],
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function ClientName({ ip, names }: { ip: string; names: ClientNames }) {
|
||||||
|
const client = names.get(ip);
|
||||||
|
if (client === undefined || (client.name === "" && client.learned_name === "")) {
|
||||||
|
return <span {...stylex.props(shared.mono)}>{ip}</span>;
|
||||||
|
}
|
||||||
|
// The name replaces the address on screen, so the address stays reachable
|
||||||
|
// as the tooltip rather than disappearing from the row entirely.
|
||||||
|
if (client.name !== "") return <span title={ip}>{client.name}</span>;
|
||||||
|
return (
|
||||||
|
<span title={ip} {...stylex.props(shared.learnedName)}>
|
||||||
|
{client.learned_name}
|
||||||
|
</span>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,194 @@
|
|||||||
|
import { act, fireEvent, render, screen, within } from "@testing-library/react";
|
||||||
|
import { QueryClientProvider } from "@tanstack/react-query";
|
||||||
|
import { createQueryClient } from "@/lib/queryClient";
|
||||||
|
import type { Client, LiveQueryEvent } from "@/lib/types";
|
||||||
|
import { FakeEventSource } from "./fakeEventSource";
|
||||||
|
import LiveLogPage from "./LiveLogPage";
|
||||||
|
|
||||||
|
function client(ip: string, name: string, learnedName: string): Client {
|
||||||
|
return {
|
||||||
|
id: Number(ip.split(".").pop()),
|
||||||
|
ip,
|
||||||
|
name,
|
||||||
|
learned_name: learnedName,
|
||||||
|
group_id: 1,
|
||||||
|
group: "default",
|
||||||
|
hand_edited: name !== "",
|
||||||
|
first_seen: 1_700_000_000,
|
||||||
|
last_seen: 1_700_000_100,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const CLIENTS: Client[] = [
|
||||||
|
client("192.0.2.10", "Kitchen Pi", "pi.lan"),
|
||||||
|
client("192.0.2.11", "", "laptop.lan"),
|
||||||
|
client("192.0.2.12", "", ""),
|
||||||
|
];
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
vi.stubGlobal(
|
||||||
|
"fetch",
|
||||||
|
vi.fn(async (input: RequestInfo | URL) => {
|
||||||
|
if (String(input) !== "/api/clients") {
|
||||||
|
return new Response(JSON.stringify({ error: "not stubbed" }), { status: 404 });
|
||||||
|
}
|
||||||
|
return new Response(JSON.stringify({ clients: CLIENTS }), {
|
||||||
|
status: 200,
|
||||||
|
headers: { "content-type": "application/json" },
|
||||||
|
});
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
vi.unstubAllGlobals();
|
||||||
|
});
|
||||||
|
|
||||||
|
function frame(ts: number, domain: string, overrides: Partial<LiveQueryEvent> = {}): { data: string } {
|
||||||
|
const payload: LiveQueryEvent = {
|
||||||
|
ts,
|
||||||
|
domain,
|
||||||
|
client_ip: "192.0.2.10",
|
||||||
|
qtype: 1,
|
||||||
|
blocked: false,
|
||||||
|
block_reason: "",
|
||||||
|
response_time_us: 500,
|
||||||
|
cache_hit: true,
|
||||||
|
upstream: "",
|
||||||
|
...overrides,
|
||||||
|
};
|
||||||
|
return { data: JSON.stringify(payload) };
|
||||||
|
}
|
||||||
|
|
||||||
|
function renderPage() {
|
||||||
|
const sources: FakeEventSource[] = [];
|
||||||
|
const createEventSource = (url: string) => {
|
||||||
|
const es = new FakeEventSource(url);
|
||||||
|
sources.push(es);
|
||||||
|
return es;
|
||||||
|
};
|
||||||
|
render(
|
||||||
|
<QueryClientProvider client={createQueryClient()}>
|
||||||
|
<LiveLogPage createEventSource={createEventSource} />
|
||||||
|
</QueryClientProvider>,
|
||||||
|
);
|
||||||
|
return sources;
|
||||||
|
}
|
||||||
|
|
||||||
|
test("streams rows, flags blocked ones, and freezes the display", () => {
|
||||||
|
const sources = renderPage();
|
||||||
|
expect(screen.getByText("Connecting…")).toBeTruthy();
|
||||||
|
|
||||||
|
act(() => sources[0]!.emit("open"));
|
||||||
|
expect(screen.getByRole("status", { name: "Live" })).toBeTruthy();
|
||||||
|
expect(screen.getByText("Waiting for queries…")).toBeTruthy();
|
||||||
|
|
||||||
|
act(() => {
|
||||||
|
sources[0]!.emit("query", frame(1000, "ok.example"));
|
||||||
|
sources[0]!.emit(
|
||||||
|
"query",
|
||||||
|
frame(1001, "ads.example", { blocked: true, block_reason: "blocklist:stevenblack", qtype: 28 }),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(screen.getByText("ok.example")).toBeTruthy();
|
||||||
|
expect(screen.getByText("Blocked")).toBeTruthy();
|
||||||
|
expect(screen.getByText("blocklist:stevenblack")).toBeTruthy();
|
||||||
|
expect(screen.getByText("AAAA")).toBeTruthy();
|
||||||
|
// StyleX compiles to opaque class names, so the check is structural: a blocked
|
||||||
|
// row carries every class a plain row does, plus the ones the flag adds.
|
||||||
|
const blockedRow = screen.getByText("ads.example").closest("tr");
|
||||||
|
const plainRow = screen.getByText("ok.example").closest("tr");
|
||||||
|
const blockedClasses = new Set(blockedRow?.className.split(" "));
|
||||||
|
const plainClasses = plainRow?.className.split(" ") ?? [];
|
||||||
|
expect(plainClasses.every((name) => blockedClasses.has(name))).toBe(true);
|
||||||
|
expect(blockedClasses.size).toBeGreaterThan(plainClasses.length);
|
||||||
|
|
||||||
|
const freeze = screen.getByRole("button", { name: "Freeze" });
|
||||||
|
fireEvent.click(freeze);
|
||||||
|
expect(freeze.getAttribute("aria-pressed")).toBe("true");
|
||||||
|
|
||||||
|
act(() => sources[0]!.emit("query", frame(1002, "later.example")));
|
||||||
|
expect(screen.queryByText("later.example")).toBeNull();
|
||||||
|
expect(screen.getByText(/3 in buffer/)).toBeTruthy();
|
||||||
|
|
||||||
|
fireEvent.click(screen.getByRole("button", { name: "Resume" }));
|
||||||
|
expect(screen.getByText("later.example")).toBeTruthy();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("resolves each row's client to its display name, keeping the IP as the tooltip", async () => {
|
||||||
|
const sources = renderPage();
|
||||||
|
act(() => sources[0]!.emit("open"));
|
||||||
|
act(() => {
|
||||||
|
sources[0]!.emit("query", frame(1000, "named.example", { client_ip: "192.0.2.10" }));
|
||||||
|
sources[0]!.emit("query", frame(1001, "learned.example", { client_ip: "192.0.2.11" }));
|
||||||
|
sources[0]!.emit("query", frame(1002, "nameless.example", { client_ip: "192.0.2.12" }));
|
||||||
|
sources[0]!.emit("query", frame(1003, "stranger.example", { client_ip: "192.0.2.99" }));
|
||||||
|
});
|
||||||
|
|
||||||
|
// A hand-typed name wins outright; the learned name never surfaces for it.
|
||||||
|
const named = await screen.findByText("Kitchen Pi");
|
||||||
|
expect(named.getAttribute("title")).toBe("192.0.2.10");
|
||||||
|
expect(screen.queryByText("pi.lan")).toBeNull();
|
||||||
|
|
||||||
|
// A learned name reads muted and nothing more here: the "learned" tag would
|
||||||
|
// repeat on every row of the table, so the Clients page carries it instead.
|
||||||
|
const learned = screen.getByText("laptop.lan");
|
||||||
|
expect(learned.getAttribute("title")).toBe("192.0.2.11");
|
||||||
|
expect(within(learned.closest("tr")!).queryByText("learned")).toBeNull();
|
||||||
|
|
||||||
|
// A known client with neither name, and a client the loaded list has never
|
||||||
|
// seen, both fall back to the bare address with no tooltip standing in.
|
||||||
|
const nameless = screen.getByText("192.0.2.12");
|
||||||
|
expect(nameless.getAttribute("title")).toBeNull();
|
||||||
|
const stranger = screen.getByText("192.0.2.99");
|
||||||
|
expect(stranger.getAttribute("title")).toBeNull();
|
||||||
|
expect(screen.getByText("stranger.example").closest("tr")?.textContent).toContain("192.0.2.99");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("rows stream in as bare IPs while the client list is still loading", async () => {
|
||||||
|
let releaseClients: () => void = () => {};
|
||||||
|
vi.stubGlobal(
|
||||||
|
"fetch",
|
||||||
|
vi.fn(
|
||||||
|
(input: RequestInfo | URL) =>
|
||||||
|
new Promise<Response>((resolve) => {
|
||||||
|
if (String(input) !== "/api/clients") {
|
||||||
|
resolve(new Response(JSON.stringify({ error: "not stubbed" }), { status: 404 }));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
releaseClients = () =>
|
||||||
|
resolve(
|
||||||
|
new Response(JSON.stringify({ clients: CLIENTS }), {
|
||||||
|
status: 200,
|
||||||
|
headers: { "content-type": "application/json" },
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
}),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
|
||||||
|
const sources = renderPage();
|
||||||
|
act(() => sources[0]!.emit("open"));
|
||||||
|
act(() => sources[0]!.emit("query", frame(1000, "named.example", { client_ip: "192.0.2.10" })));
|
||||||
|
|
||||||
|
expect(screen.getByText("192.0.2.10")).toBeTruthy();
|
||||||
|
expect(screen.queryByText("Kitchen Pi")).toBeNull();
|
||||||
|
|
||||||
|
releaseClients();
|
||||||
|
expect(await screen.findByText("Kitchen Pi")).toBeTruthy();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("repeated connection failures show the viewer-cap state with a retry button", () => {
|
||||||
|
const sources = renderPage();
|
||||||
|
act(() => {
|
||||||
|
sources[0]!.emit("error");
|
||||||
|
sources[0]!.emit("error");
|
||||||
|
sources[0]!.emit("error");
|
||||||
|
});
|
||||||
|
expect(screen.getByRole("alert").textContent).toContain("too many live viewers");
|
||||||
|
|
||||||
|
fireEvent.click(screen.getByRole("button", { name: "Retry" }));
|
||||||
|
expect(sources).toHaveLength(2);
|
||||||
|
expect(screen.getByText("Connecting…")).toBeTruthy();
|
||||||
|
});
|
||||||
@@ -1,4 +1,5 @@
|
|||||||
import * as stylex from "@stylexjs/stylex";
|
import * as stylex from "@stylexjs/stylex";
|
||||||
|
import { useClientNames } from "@/features/clients/clientNames";
|
||||||
import { QueryCells, QueryTableHead } from "@/features/queries/QueryLogPage";
|
import { QueryCells, QueryTableHead } from "@/features/queries/QueryLogPage";
|
||||||
import { RING_CAPACITY } from "./ringBuffer";
|
import { RING_CAPACITY } from "./ringBuffer";
|
||||||
import { useLiveQueries, type EventSourceFactory, type StreamStatus } from "./useLiveQueries";
|
import { useLiveQueries, type EventSourceFactory, type StreamStatus } from "./useLiveQueries";
|
||||||
@@ -168,6 +169,7 @@ function StatusPill({ status }: { status: StreamStatus }) {
|
|||||||
* filling; Resume shows the current buffer (anything pushed out meanwhile is gone). */
|
* filling; Resume shows the current buffer (anything pushed out meanwhile is gone). */
|
||||||
export default function LiveLogPage({ createEventSource }: { createEventSource?: EventSourceFactory } = {}) {
|
export default function LiveLogPage({ createEventSource }: { createEventSource?: EventSourceFactory } = {}) {
|
||||||
const live = useLiveQueries({ createEventSource });
|
const live = useLiveQueries({ createEventSource });
|
||||||
|
const clientNames = useClientNames();
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<section>
|
<section>
|
||||||
@@ -240,7 +242,7 @@ export default function LiveLogPage({ createEventSource }: { createEventSource?:
|
|||||||
<tbody>
|
<tbody>
|
||||||
{live.rows.map((row) => (
|
{live.rows.map((row) => (
|
||||||
<tr key={row.key} {...stylex.props(styles.row, row.blocked && styles.rowBlocked)}>
|
<tr key={row.key} {...stylex.props(styles.row, row.blocked && styles.rowBlocked)}>
|
||||||
<QueryCells row={row} />
|
<QueryCells row={row} clientNames={clientNames} />
|
||||||
</tr>
|
</tr>
|
||||||
))}
|
))}
|
||||||
</tbody>
|
</tbody>
|
||||||
+61
-2
@@ -1,9 +1,29 @@
|
|||||||
import { act, fireEvent, render, screen, waitFor } from "@testing-library/react";
|
import { act, fireEvent, render, screen, waitFor, within } from "@testing-library/react";
|
||||||
import { QueryClientProvider } from "@tanstack/react-query";
|
import { QueryClientProvider } from "@tanstack/react-query";
|
||||||
import { createQueryClient } from "@/lib/queryClient";
|
import { createQueryClient } from "@/lib/queryClient";
|
||||||
import type { QueriesPage, QueryRow } from "@/lib/types";
|
import type { Client, QueriesPage, QueryRow } from "@/lib/types";
|
||||||
import QueryLogPage from "./QueryLogPage";
|
import QueryLogPage from "./QueryLogPage";
|
||||||
|
|
||||||
|
function client(id: number, ip: string, name: string, learnedName: string): Client {
|
||||||
|
return {
|
||||||
|
id,
|
||||||
|
ip,
|
||||||
|
name,
|
||||||
|
learned_name: learnedName,
|
||||||
|
group_id: 1,
|
||||||
|
group: "default",
|
||||||
|
hand_edited: name !== "",
|
||||||
|
first_seen: 1_700_000_000,
|
||||||
|
last_seen: 1_700_000_100,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const CLIENTS: Client[] = [
|
||||||
|
client(1, "192.0.2.10", "Kitchen Pi", "pi.lan"),
|
||||||
|
client(2, "192.0.2.11", "", "laptop.lan"),
|
||||||
|
client(3, "192.0.2.12", "", ""),
|
||||||
|
];
|
||||||
|
|
||||||
function row(id: number, domain: string, overrides: Partial<QueryRow> = {}): QueryRow {
|
function row(id: number, domain: string, overrides: Partial<QueryRow> = {}): QueryRow {
|
||||||
return {
|
return {
|
||||||
id,
|
id,
|
||||||
@@ -48,6 +68,7 @@ beforeEach(() => {
|
|||||||
"fetch",
|
"fetch",
|
||||||
vi.fn(async (input: RequestInfo | URL) => {
|
vi.fn(async (input: RequestInfo | URL) => {
|
||||||
const url = String(input);
|
const url = String(input);
|
||||||
|
if (url === "/api/clients") return json({ clients: CLIENTS });
|
||||||
const payload = PAGES[url];
|
const payload = PAGES[url];
|
||||||
if (payload === undefined) return new Response(JSON.stringify({ error: "not stubbed" }), { status: 404 });
|
if (payload === undefined) return new Response(JSON.stringify({ error: "not stubbed" }), { status: 404 });
|
||||||
return new Response(JSON.stringify(payload), {
|
return new Response(JSON.stringify(payload), {
|
||||||
@@ -90,6 +111,44 @@ test("renders the first page with type names, blocked badge, and formatted cells
|
|||||||
expect(screen.getByText(/Showing 2 queries/)).toBeTruthy();
|
expect(screen.getByText(/Showing 2 queries/)).toBeTruthy();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test("resolves each row's client to its display name, keeping the IP as the tooltip", async () => {
|
||||||
|
vi.stubGlobal(
|
||||||
|
"fetch",
|
||||||
|
vi.fn(async (input: RequestInfo | URL) => {
|
||||||
|
const url = String(input);
|
||||||
|
if (url === "/api/clients") return json({ clients: CLIENTS });
|
||||||
|
if (url !== "/api/queries") return new Response(JSON.stringify({ error: "not stubbed" }), { status: 404 });
|
||||||
|
return json({
|
||||||
|
queries: [
|
||||||
|
row(20, "named.example", { client_ip: "192.0.2.10" }),
|
||||||
|
row(19, "learned.example", { client_ip: "192.0.2.11" }),
|
||||||
|
row(18, "nameless.example", { client_ip: "192.0.2.12" }),
|
||||||
|
row(17, "stranger.example", { client_ip: "192.0.2.99" }),
|
||||||
|
],
|
||||||
|
next_before: null,
|
||||||
|
} satisfies QueriesPage);
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
renderPage();
|
||||||
|
|
||||||
|
// A hand-typed name wins outright; the learned name never surfaces for it.
|
||||||
|
const named = await screen.findByText("Kitchen Pi");
|
||||||
|
expect(named.getAttribute("title")).toBe("192.0.2.10");
|
||||||
|
expect(screen.queryByText("pi.lan")).toBeNull();
|
||||||
|
|
||||||
|
// A learned name reads muted and nothing more here: the "learned" tag would
|
||||||
|
// repeat on every row of the table, so the Clients page carries it instead.
|
||||||
|
const learned = screen.getByText("laptop.lan");
|
||||||
|
expect(learned.getAttribute("title")).toBe("192.0.2.11");
|
||||||
|
expect(within(learned.closest("tr")!).queryByText("learned")).toBeNull();
|
||||||
|
|
||||||
|
// A known client with neither name, and a client the loaded list has never
|
||||||
|
// seen, both fall back to the bare address with no tooltip standing in.
|
||||||
|
expect(screen.getByText("192.0.2.12").getAttribute("title")).toBeNull();
|
||||||
|
expect(screen.getByText("192.0.2.99").getAttribute("title")).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
test("load more appends the next page and stops at the end of the log", async () => {
|
test("load more appends the next page and stops at the end of the log", async () => {
|
||||||
renderPage();
|
renderPage();
|
||||||
await screen.findByText("first.example");
|
await screen.findByText("first.example");
|
||||||
+7
-3
@@ -5,6 +5,7 @@ import * as api from "@/lib/api";
|
|||||||
import { formatMicros, formatTime } from "@/lib/format";
|
import { formatMicros, formatTime } from "@/lib/format";
|
||||||
import { queriesInfiniteQuery } from "@/lib/queries";
|
import { queriesInfiniteQuery } from "@/lib/queries";
|
||||||
import type { QueriesFilter, QueryRow } from "@/lib/types";
|
import type { QueriesFilter, QueryRow } from "@/lib/types";
|
||||||
|
import { ClientName, useClientNames, type ClientNames } from "@/features/clients/clientNames";
|
||||||
import { qtypeName } from "./qtype";
|
import { qtypeName } from "./qtype";
|
||||||
import Select from "@/ui/Select";
|
import Select from "@/ui/Select";
|
||||||
import { styles as shared } from "@/ui/styles";
|
import { styles as shared } from "@/ui/styles";
|
||||||
@@ -162,12 +163,14 @@ export function BlockedCell({ row }: { row: Pick<QueryRow, "blocked" | "block_re
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
export function QueryCells({ row }: { row: Omit<QueryRow, "id"> }) {
|
export function QueryCells({ row, clientNames }: { row: Omit<QueryRow, "id">; clientNames: ClientNames }) {
|
||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
<td {...stylex.props(styles.cell, styles.nowrap, styles.muted)}>{formatTime(row.ts)}</td>
|
<td {...stylex.props(styles.cell, styles.nowrap, styles.muted)}>{formatTime(row.ts)}</td>
|
||||||
<td {...stylex.props(styles.cell, styles.small, styles.breakAll, shared.mono)}>{row.domain}</td>
|
<td {...stylex.props(styles.cell, styles.small, styles.breakAll, shared.mono)}>{row.domain}</td>
|
||||||
<td {...stylex.props(styles.cell, styles.small, styles.nowrap, shared.mono)}>{row.client_ip}</td>
|
<td {...stylex.props(styles.cell, styles.small, styles.nowrap)}>
|
||||||
|
<ClientName ip={row.client_ip} names={clientNames} />
|
||||||
|
</td>
|
||||||
<td {...stylex.props(styles.cell, styles.nowrap)}>{qtypeName(row.qtype)}</td>
|
<td {...stylex.props(styles.cell, styles.nowrap)}>{qtypeName(row.qtype)}</td>
|
||||||
<td {...stylex.props(styles.cell)}>
|
<td {...stylex.props(styles.cell)}>
|
||||||
<BlockedCell row={row} />
|
<BlockedCell row={row} />
|
||||||
@@ -212,6 +215,7 @@ export default function QueryLogPage() {
|
|||||||
const [applied, setApplied] = useState<QueriesFilter>({});
|
const [applied, setApplied] = useState<QueriesFilter>({});
|
||||||
|
|
||||||
const base = useInfiniteQuery(queriesInfiniteQuery(applied));
|
const base = useInfiniteQuery(queriesInfiniteQuery(applied));
|
||||||
|
const clientNames = useClientNames();
|
||||||
|
|
||||||
const pages = base.data?.pages ?? [];
|
const pages = base.data?.pages ?? [];
|
||||||
const rows: QueryRow[] = pages.flatMap((page) => page.queries);
|
const rows: QueryRow[] = pages.flatMap((page) => page.queries);
|
||||||
@@ -336,7 +340,7 @@ export default function QueryLogPage() {
|
|||||||
<tbody>
|
<tbody>
|
||||||
{rows.map((row) => (
|
{rows.map((row) => (
|
||||||
<tr key={row.id} {...stylex.props(styles.row)}>
|
<tr key={row.id} {...stylex.props(styles.row)}>
|
||||||
<QueryCells row={row} />
|
<QueryCells row={row} clientNames={clientNames} />
|
||||||
</tr>
|
</tr>
|
||||||
))}
|
))}
|
||||||
</tbody>
|
</tbody>
|
||||||
@@ -9,7 +9,7 @@
|
|||||||
// declare, and a string outside a literal union.
|
// declare, and a string outside a literal union.
|
||||||
//
|
//
|
||||||
// Regenerate with:
|
// Regenerate with:
|
||||||
// zig build test -Dintegration -Dcontract-samples-out="$PWD/web/src/lib/contractSamples.gen.ts"
|
// zig build test -Dintegration -Dcontract-samples-out="$PWD/admin/src/lib/contractSamples.gen.ts"
|
||||||
|
|
||||||
import type {
|
import type {
|
||||||
Blocklist,
|
Blocklist,
|
||||||
@@ -259,6 +259,7 @@ export const sample_list_clients: { clients: Client[] } = {
|
|||||||
id: 0,
|
id: 0,
|
||||||
ip: "192.168.1.50",
|
ip: "192.168.1.50",
|
||||||
last_seen: 0,
|
last_seen: 0,
|
||||||
|
learned_name: "",
|
||||||
name: "laptop",
|
name: "laptop",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
@@ -272,6 +273,7 @@ export const sample_update_client: Client = {
|
|||||||
id: 0,
|
id: 0,
|
||||||
ip: "192.168.1.50",
|
ip: "192.168.1.50",
|
||||||
last_seen: 0,
|
last_seen: 0,
|
||||||
|
learned_name: "",
|
||||||
name: "laptop-renamed",
|
name: "laptop-renamed",
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -6,4 +6,4 @@
|
|||||||
pub const bytes = @embedFile("contractSamples.gen.ts");
|
pub const bytes = @embedFile("contractSamples.gen.ts");
|
||||||
|
|
||||||
/// Repo-relative path, so a failing assertion names the file to regenerate.
|
/// Repo-relative path, so a failing assertion names the file to regenerate.
|
||||||
pub const path = "web/src/lib/contractSamples.gen.ts";
|
pub const path = "admin/src/lib/contractSamples.gen.ts";
|
||||||
@@ -256,6 +256,8 @@ export interface Client {
|
|||||||
id: number;
|
id: number;
|
||||||
ip: string;
|
ip: string;
|
||||||
name: string;
|
name: string;
|
||||||
|
/** Learned over reverse DNS. `name` wins whenever it is non-empty. */
|
||||||
|
learned_name: string;
|
||||||
group_id: number;
|
group_id: number;
|
||||||
group: string;
|
group: string;
|
||||||
hand_edited: boolean;
|
hand_edited: boolean;
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user