Compare commits
1
Commits
next
..
0fb647e8be
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0fb647e8be |
+21
-29
@@ -5,11 +5,11 @@
|
|||||||
#
|
#
|
||||||
# The lint and test phases are the gates: `make lint` (script/lint)
|
# The lint and test phases are the gates: `make lint` (script/lint)
|
||||||
# builds the lint stage alone and `make test` (script/test) the test
|
# builds the lint stage alone and `make test` (script/test) the test
|
||||||
# stage alone, and the two build stages, frontend-build and builder,
|
# stage alone, and the builder stage depends on both, so the image
|
||||||
# depend on both, so the image cannot be built unless they pass. Each
|
# cannot be built unless they pass. Each covers the frontend as well,
|
||||||
# phase covers the frontend as well, through a copy from a node stage.
|
# through a copy from a node stage. Inside them each tool is invoked
|
||||||
# Inside them each tool is invoked directly, never through make or
|
# directly, never through make or script/, whose lint and test are
|
||||||
# script/, whose lint and test are themselves docker builds.
|
# themselves docker builds.
|
||||||
|
|
||||||
# Frontend lint stage: eslint with the rules in eslint.config.js. The
|
# Frontend lint stage: eslint with the rules in eslint.config.js. The
|
||||||
# lint phase below runs it.
|
# lint phase below runs it.
|
||||||
@@ -35,26 +35,30 @@ RUN golangci-lint run --config .golangci.yml ./...
|
|||||||
# phase run it.
|
# phase run it.
|
||||||
COPY --from=frontend-lint /app/yarn.lock /dev/null
|
COPY --from=frontend-lint /app/yarn.lock /dev/null
|
||||||
|
|
||||||
# Frontend test stage: the unit tests in test/unit/. The test phase
|
# Frontend stage: the unit tests in test/unit/, then the production
|
||||||
# below runs it, and the frontend-build stage starts from it. The tests
|
# build into dist/, which the runtime stage serves. The test phase below
|
||||||
# print a dot each; if any fails, they run again with every test listed,
|
# runs it. The tests print a dot each; if any fails, they run again with
|
||||||
# and the step fails even if that run passes. NODE_OPTIONS chooses the
|
# every test listed, and the step fails even if that run passes.
|
||||||
# reporter because yarn adds its arguments after the test files, where
|
# NODE_OPTIONS chooses the reporter because yarn adds its arguments
|
||||||
# node would take a reporter option for one more file.
|
# after the test files, where node would take a reporter option for one
|
||||||
|
# more file.
|
||||||
# node:22-alpine as of 2026-02-22
|
# node:22-alpine as of 2026-02-22
|
||||||
FROM node@sha256:e4bf2a82ad0a4037d28035ae71529873c069b13eb0455466ae0bc13363826e34 AS frontend-test
|
FROM node@sha256:e4bf2a82ad0a4037d28035ae71529873c069b13eb0455466ae0bc13363826e34 AS frontend
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
COPY package.json yarn.lock ./
|
COPY package.json yarn.lock ./
|
||||||
RUN yarn install --frozen-lockfile
|
RUN yarn install --frozen-lockfile
|
||||||
|
# vite.config.js reads the commit for the page's footer with git.
|
||||||
|
RUN apk add --no-cache git
|
||||||
COPY . .
|
COPY . .
|
||||||
RUN NODE_OPTIONS=--test-reporter=dot timeout 90 yarn --silent run test || \
|
RUN NODE_OPTIONS=--test-reporter=dot timeout 90 yarn --silent run test || \
|
||||||
{ echo "--- Rerunning with every test listed for details ---"; \
|
{ echo "--- Rerunning with every test listed for details ---"; \
|
||||||
NODE_OPTIONS=--test-reporter=spec timeout 90 yarn --silent run test; \
|
NODE_OPTIONS=--test-reporter=spec timeout 90 yarn --silent run test; \
|
||||||
exit 1; }
|
exit 1; }
|
||||||
|
RUN yarn build
|
||||||
|
|
||||||
# Test phase: the backend's tests with the race detector and coverage,
|
# Test phase: the backend's tests with the race detector and coverage,
|
||||||
# and the frontend's through the copy from the frontend-test stage at
|
# and the frontend's through the copy from the frontend stage at the
|
||||||
# the end. -race needs cgo and so a C compiler, which the Debian Go image
|
# end. -race needs cgo and so a C compiler, which the Debian Go image
|
||||||
# ships and the alpine one does not. -timeout 90s is a backstop above
|
# ships and the alpine one does not. -timeout 90s is a backstop above
|
||||||
# the 60-second cap on the suite. The rerun with -v only shows details:
|
# the 60-second cap on the suite. The rerun with -v only shows details:
|
||||||
# the step fails however it ends, because the first run already failed.
|
# the step fails however it ends, because the first run already failed.
|
||||||
@@ -71,21 +75,9 @@ RUN --mount=type=tmpfs,target=/go/pkg/mod \
|
|||||||
go test -timeout 90s -race -cover ./... || \
|
go test -timeout 90s -race -cover ./... || \
|
||||||
{ echo "--- Rerunning with -v for details ---"; \
|
{ echo "--- Rerunning with -v for details ---"; \
|
||||||
go test -timeout 90s -race -v ./...; exit 1; }
|
go test -timeout 90s -race -v ./...; exit 1; }
|
||||||
# Nothing is wanted from the frontend-test stage; the copy is what makes
|
# Nothing is wanted from the frontend stage; the copy is what makes
|
||||||
# this phase run its tests.
|
# this phase run its tests.
|
||||||
COPY --from=frontend-test /app/yarn.lock /dev/null
|
COPY --from=frontend /app/yarn.lock /dev/null
|
||||||
|
|
||||||
# Frontend build stage: the production build into dist/, which the
|
|
||||||
# runtime stage serves, on the yarn packages and source of the
|
|
||||||
# frontend-test stage. Nothing is wanted from the two phases; the copies
|
|
||||||
# are what make BuildKit build them first, so this stage cannot run
|
|
||||||
# unless lint and test passed.
|
|
||||||
FROM frontend-test AS frontend-build
|
|
||||||
COPY --from=lint /src/go.sum /dev/null
|
|
||||||
COPY --from=test /src/go.sum /dev/null
|
|
||||||
# vite.config.js reads the commit for the page's footer with git.
|
|
||||||
RUN apk add --no-cache git
|
|
||||||
RUN yarn build
|
|
||||||
|
|
||||||
# Backend build stage. Nothing is wanted from the two phases; the copies
|
# Backend build stage. Nothing is wanted from the two phases; the copies
|
||||||
# are what make BuildKit build them first, so this stage cannot run
|
# are what make BuildKit build them first, so this stage cannot run
|
||||||
@@ -139,7 +131,7 @@ RUN addgroup -g 1000 -S netwatch && \
|
|||||||
RUN rm /etc/nginx/conf.d/default.conf
|
RUN rm /etc/nginx/conf.d/default.conf
|
||||||
COPY configs/nginx.conf /etc/nginx/templates/netwatch.conf.template
|
COPY configs/nginx.conf /etc/nginx/templates/netwatch.conf.template
|
||||||
COPY configs/security-headers.conf /etc/nginx/security-headers.conf
|
COPY configs/security-headers.conf /etc/nginx/security-headers.conf
|
||||||
COPY --from=frontend-build /app/dist /usr/share/nginx/html
|
COPY --from=frontend /app/dist /usr/share/nginx/html
|
||||||
COPY --from=builder /src/netwatch-server /usr/local/bin/netwatch-server
|
COPY --from=builder /src/netwatch-server /usr/local/bin/netwatch-server
|
||||||
COPY bin/entrypoint.sh /usr/local/bin/entrypoint.sh
|
COPY bin/entrypoint.sh /usr/local/bin/entrypoint.sh
|
||||||
|
|
||||||
|
|||||||
@@ -59,9 +59,8 @@ either one is broken. We provide:
|
|||||||
- `script/clean` — remove what `script/build` writes
|
- `script/clean` — remove what `script/build` writes
|
||||||
- `script/projectname` — print the project name (used for the Docker image tag)
|
- `script/projectname` — print the project name (used for the Docker image tag)
|
||||||
- `script/test` — build the `test` phase of `Dockerfile` without the cache: the
|
- `script/test` — build the `test` phase of `Dockerfile` without the cache: the
|
||||||
frontend's unit tests in its `frontend-test` stage, and the backend's Go tests
|
frontend's unit tests and production build in its `frontend` stage, and the
|
||||||
with the race detector and coverage. The frontend's production build is left
|
backend's Go tests with the race detector and coverage
|
||||||
to the image build, in the `frontend-build` stage
|
|
||||||
- `script/lint` — build the `lint` phase of `Dockerfile` without the cache:
|
- `script/lint` — build the `lint` phase of `Dockerfile` without the cache:
|
||||||
eslint in its `frontend-lint` stage, and golangci-lint over the Go packages
|
eslint in its `frontend-lint` stage, and golangci-lint over the Go packages
|
||||||
- `script/fmt` — format all files (writes): prettier over the JavaScript, CSS,
|
- `script/fmt` — format all files (writes): prettier over the JavaScript, CSS,
|
||||||
@@ -79,8 +78,8 @@ either one is broken. We provide:
|
|||||||
- `script/frontend-test` — run the unit tests in `test/unit/` on the host with
|
- `script/frontend-test` — run the unit tests in `test/unit/` on the host with
|
||||||
Node's built-in test runner, through the `test` script in `package.json`, and
|
Node's built-in test runner, through the `test` script in `package.json`, and
|
||||||
if any fails, run them again listing every test, and fail; then the production
|
if any fails, run them again listing every test, and fail; then the production
|
||||||
build. Each test run has a 90-second timeout. `make test` runs the same tests
|
build. Each test run has a 90-second timeout. `make test` runs the same in
|
||||||
in Docker, without the production build
|
Docker
|
||||||
- `script/frontend-fmt` — format the JavaScript, CSS, HTML and Markdown with
|
- `script/frontend-fmt` — format the JavaScript, CSS, HTML and Markdown with
|
||||||
prettier (writes)
|
prettier (writes)
|
||||||
- `script/frontend-fmt-check` — check prettier formatting (read-only)
|
- `script/frontend-fmt-check` — check prettier formatting (read-only)
|
||||||
|
|||||||
@@ -21,35 +21,6 @@ Run `make frontend-viewport-test` in CI as its own step; it is not part of
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
- 2026-10-14: stopping the server waits for a report file write already under
|
|
||||||
way, the periodic flush's or the one `Append` starts when 10 MiB are waiting,
|
|
||||||
before the final flush
|
|
||||||
([#122](https://git.eeqj.de/sneak/netwatch/issues/122)). It used to return at
|
|
||||||
once, and the process exiting cut the write off, losing its reports. A write
|
|
||||||
under way that fails puts its reports back in memory, so the final flush
|
|
||||||
writes them; the stop fails, and the process exits non-zero, only if that
|
|
||||||
flush fails too. Two tests hold the periodic write and the one at 10 MiB open
|
|
||||||
and find the stop waiting until each is released; a third makes the held write
|
|
||||||
fail and finds its report written by the final flush. They run in a
|
|
||||||
`testing/synctest` bubble, so the periodic flush comes without waiting a
|
|
||||||
minute
|
|
||||||
- 2026-10-14: `make test` no longer runs the frontend's production build, which
|
|
||||||
the tests do not need ([#118](https://git.eeqj.de/sneak/netwatch/issues/118)).
|
|
||||||
`yarn build` moved out of the stage that runs the frontend's unit tests, now
|
|
||||||
named `frontend-test`, into a new `frontend-build` stage, which starts from it
|
|
||||||
and, like the `builder` stage, waits on the lint and test phases, so the image
|
|
||||||
still cannot be built unless they pass. The runtime stage copies `dist/` from
|
|
||||||
it, and the `git` that `vite.config.js` reads the commit with is installed
|
|
||||||
there. No build cache was added
|
|
||||||
- 2026-10-14: opening the debug log no longer raises the measured latencies
|
|
||||||
([#131](https://git.eeqj.de/sneak/netwatch/issues/131)). With the panel open,
|
|
||||||
each line written drew the panel again with every line before it, up to 1000,
|
|
||||||
and a check that ends while the page draws is timed only when the drawing is
|
|
||||||
done. Each line is now added at the end of the open panel, its first line is
|
|
||||||
dropped once it holds more than 1000, and it scrolls to its newest line once a
|
|
||||||
frame rather than once a line; the whole panel is drawn only when it is
|
|
||||||
opened. A unit test writes more lines than the panel keeps and checks that the
|
|
||||||
lines already shown are left as they are
|
|
||||||
- 2026-10-14: unset, the backend's own `TRUSTED_PROXIES` trusts `10.0.0.0/8`,
|
- 2026-10-14: unset, the backend's own `TRUSTED_PROXIES` trusts `10.0.0.0/8`,
|
||||||
`172.16.0.0/12` and `192.168.0.0/16`, and no longer loopback; a list replaces
|
`172.16.0.0/12` and `192.168.0.0/16`, and no longer loopback; a list replaces
|
||||||
that; set and empty, it trusts no proxy, where it used to get the default, as
|
that; set and empty, it trusts no proxy, where it used to get the default, as
|
||||||
@@ -523,9 +494,3 @@ Run `make frontend-viewport-test` in CI as its own step; it is not part of
|
|||||||
- A configurable host list (an environment variable or a config file)
|
- A configurable host list (an environment variable or a config file)
|
||||||
- Export of the latency history (CSV or JSON)
|
- Export of the latency history (CSV or JSON)
|
||||||
- A notification when the health status changes to DEGRADED
|
- A notification when the health status changes to DEGRADED
|
||||||
- `make test` within the 20-second target
|
|
||||||
([#118](https://git.eeqj.de/sneak/netwatch/issues/118)): every run compiles
|
|
||||||
the Go standard library and every dependency with the race detector from
|
|
||||||
nothing. Whether test builds may keep Go's compiled packages between runs
|
|
||||||
waits on sneak's ruling in
|
|
||||||
[prompts#113](https://git.eeqj.de/sneak/prompts/issues/113)
|
|
||||||
|
|||||||
@@ -96,10 +96,6 @@ type Buffer struct {
|
|||||||
// refuses reports, and the reports of that write wait in buf for
|
// refuses reports, and the reports of that write wait in buf for
|
||||||
// the next flush.
|
// the next flush.
|
||||||
writeErr error
|
writeErr error
|
||||||
// writers are the goroutines that write report files: flushLoop,
|
|
||||||
// and each one Append starts at flushSizeThreshold. OnStop waits
|
|
||||||
// for them before the final flush.
|
|
||||||
writers sync.WaitGroup
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// New creates a Buffer and registers lifecycle hooks to
|
// New creates a Buffer and registers lifecycle hooks to
|
||||||
@@ -151,7 +147,7 @@ func New(
|
|||||||
|
|
||||||
b.mu.Unlock()
|
b.mu.Unlock()
|
||||||
|
|
||||||
b.writers.Go(b.flushLoop)
|
go b.flushLoop()
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
},
|
},
|
||||||
@@ -162,14 +158,7 @@ func New(
|
|||||||
var err error
|
var err error
|
||||||
|
|
||||||
b.stopOnce.Do(func() {
|
b.stopOnce.Do(func() {
|
||||||
// Closing done ends flushLoop after any flush it is
|
|
||||||
// running. Wait for it and for the writes Append
|
|
||||||
// started, which the process exiting would cut off;
|
|
||||||
// one that fails puts its reports back in buf, for the
|
|
||||||
// final flush to write.
|
|
||||||
close(b.done)
|
close(b.done)
|
||||||
b.writers.Wait()
|
|
||||||
|
|
||||||
err = b.flushLocked()
|
err = b.flushLocked()
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -222,12 +211,12 @@ func (b *Buffer) Append(v any) error {
|
|||||||
data := b.drainBuf()
|
data := b.drainBuf()
|
||||||
b.mu.Unlock()
|
b.mu.Unlock()
|
||||||
|
|
||||||
b.writers.Go(func() {
|
go func() {
|
||||||
writeErr := b.writeFile(data)
|
writeErr := b.writeFile(data)
|
||||||
if writeErr != nil {
|
if writeErr != nil {
|
||||||
b.log.Error("flush reports failed", "error", writeErr)
|
b.log.Error("flush reports failed", "error", writeErr)
|
||||||
}
|
}
|
||||||
})
|
}()
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -15,7 +15,6 @@ import (
|
|||||||
"sync"
|
"sync"
|
||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"testing"
|
"testing"
|
||||||
"testing/synctest"
|
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"sneak.berlin/go/netwatch/internal/config"
|
"sneak.berlin/go/netwatch/internal/config"
|
||||||
@@ -108,174 +107,9 @@ func TestFailedFinalFlushFailsStop(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestStopWaitsForPeriodicWrite holds open the write the periodic flush
|
// startBuffer starts a Buffer through fx, as main does, with the
|
||||||
// starts, then stops the app. The stop must wait until the write is
|
// DATA_DIR and DATA_DIR_MAX_BYTES the calling test has set.
|
||||||
// released, and the report must then be in its file. The test runs in
|
func startBuffer(t *testing.T) *reportbuf.Buffer {
|
||||||
// a synctest bubble, whose clock moves on at once when every goroutine
|
|
||||||
// in it is waiting, so the periodic flush does not take a minute.
|
|
||||||
func TestStopWaitsForPeriodicWrite(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
t.Setenv("DATA_DIR", dir)
|
|
||||||
|
|
||||||
synctest.Test(t, func(t *testing.T) {
|
|
||||||
buf, app := startApp(t)
|
|
||||||
|
|
||||||
created := make(chan struct{})
|
|
||||||
release := make(chan struct{})
|
|
||||||
|
|
||||||
buf.OnFileCreated(func(*os.File) {
|
|
||||||
created <- struct{}{}
|
|
||||||
|
|
||||||
<-release
|
|
||||||
})
|
|
||||||
|
|
||||||
err := buf.Append(map[string]string{"id": "periodic"})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("append report: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
<-created
|
|
||||||
|
|
||||||
err = stopWhileHeld(t, app, release)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("stop: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
files, err := readReportFiles(dir)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("read report files: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
want := `{"id":"periodic"}` + "\n"
|
|
||||||
if len(files) != 1 || files[0] != want {
|
|
||||||
t.Fatalf("report files = %q, want one holding %q", files, want)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestStopWaitsForWriteAtSizeThreshold holds open the write Append
|
|
||||||
// starts when the buffer reaches FlushSizeThreshold, then stops the
|
|
||||||
// app. The stop must wait until the write is released, and the reports
|
|
||||||
// must then be in its file.
|
|
||||||
func TestStopWaitsForWriteAtSizeThreshold(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
t.Setenv("DATA_DIR", dir)
|
|
||||||
|
|
||||||
synctest.Test(t, func(t *testing.T) {
|
|
||||||
buf, app := startApp(t)
|
|
||||||
|
|
||||||
created := make(chan struct{})
|
|
||||||
release := make(chan struct{})
|
|
||||||
|
|
||||||
buf.OnFileCreated(func(*os.File) {
|
|
||||||
created <- struct{}{}
|
|
||||||
|
|
||||||
<-release
|
|
||||||
})
|
|
||||||
|
|
||||||
appended := appendToThreshold(t, buf)
|
|
||||||
|
|
||||||
<-created
|
|
||||||
|
|
||||||
err := stopWhileHeld(t, app, release)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("stop: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
files, err := readReportFiles(dir)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("read report files: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(files) != 1 || files[0] != appended {
|
|
||||||
t.Fatalf("%d report files, want one holding the %d bytes "+
|
|
||||||
"appended", len(files), len(appended))
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestFinalFlushWritesReportsOfFailedWrite holds open the write the
|
|
||||||
// periodic flush starts, makes it fail, then stops the app. The stop
|
|
||||||
// waits for the write, which puts its report back in the buffer, and
|
|
||||||
// the final flush writes it, so the stop succeeds with nothing lost.
|
|
||||||
func TestFinalFlushWritesReportsOfFailedWrite(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
t.Setenv("DATA_DIR", dir)
|
|
||||||
|
|
||||||
synctest.Test(t, func(t *testing.T) {
|
|
||||||
buf, app := startApp(t)
|
|
||||||
|
|
||||||
created := make(chan *os.File)
|
|
||||||
release := make(chan struct{})
|
|
||||||
|
|
||||||
buf.OnFileCreated(func(f *os.File) {
|
|
||||||
created <- f
|
|
||||||
|
|
||||||
<-release
|
|
||||||
})
|
|
||||||
|
|
||||||
err := buf.Append(map[string]string{"id": "failed"})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("append report: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
held := <-created
|
|
||||||
|
|
||||||
// Closing the file under the write makes the write fail.
|
|
||||||
_ = held.Close()
|
|
||||||
|
|
||||||
// The final flush's write goes through.
|
|
||||||
buf.OnFileCreated(func(*os.File) {})
|
|
||||||
|
|
||||||
err = stopWhileHeld(t, app, release)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("stop: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
files, err := readReportFiles(dir)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("read report files: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
want := `{"id":"failed"}` + "\n"
|
|
||||||
if len(files) != 1 || files[0] != want {
|
|
||||||
t.Fatalf("report files = %q, want one holding %q", files, want)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// stopWhileHeld stops app while a report file write is held open until
|
|
||||||
// release is closed, and fails the test if the stop returns before
|
|
||||||
// that. It then closes release and returns the stop's error. It must
|
|
||||||
// be called in a synctest bubble.
|
|
||||||
func stopWhileHeld(
|
|
||||||
t *testing.T,
|
|
||||||
app *fxtest.App,
|
|
||||||
release chan<- struct{},
|
|
||||||
) error {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
stopped := make(chan error, 1)
|
|
||||||
|
|
||||||
go func() { stopped <- app.Stop(t.Context()) }()
|
|
||||||
|
|
||||||
// Wait returns once every other goroutine in the bubble is waiting:
|
|
||||||
// the stop has got as far as it can while the write is held.
|
|
||||||
synctest.Wait()
|
|
||||||
|
|
||||||
if len(stopped) != 0 {
|
|
||||||
t.Error("stop returned while a report file write was held open")
|
|
||||||
}
|
|
||||||
|
|
||||||
close(release)
|
|
||||||
|
|
||||||
return <-stopped
|
|
||||||
}
|
|
||||||
|
|
||||||
// startApp starts a Buffer through fx, as main does, with the DATA_DIR
|
|
||||||
// and DATA_DIR_MAX_BYTES the calling test has set, and returns it with
|
|
||||||
// the app, for tests that stop the app themselves.
|
|
||||||
func startApp(t *testing.T) (*reportbuf.Buffer, *fxtest.App) {
|
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
var buf *reportbuf.Buffer
|
var buf *reportbuf.Buffer
|
||||||
@@ -293,16 +127,6 @@ func startApp(t *testing.T) (*reportbuf.Buffer, *fxtest.App) {
|
|||||||
app.RequireStart()
|
app.RequireStart()
|
||||||
t.Cleanup(app.RequireStop)
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
return buf, app
|
|
||||||
}
|
|
||||||
|
|
||||||
// startBuffer starts a Buffer through fx, as main does, with the
|
|
||||||
// DATA_DIR and DATA_DIR_MAX_BYTES the calling test has set.
|
|
||||||
func startBuffer(t *testing.T) *reportbuf.Buffer {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
buf, _ := startApp(t)
|
|
||||||
|
|
||||||
return buf
|
return buf
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1068,32 +892,6 @@ func TestFlushAtSizeThreshold(t *testing.T) {
|
|||||||
|
|
||||||
buf := startBuffer(t)
|
buf := startBuffer(t)
|
||||||
|
|
||||||
appended := appendToThreshold(t, buf)
|
|
||||||
|
|
||||||
// Append writes the file in the background, so wait for it.
|
|
||||||
deadline := time.Now().Add(10 * time.Second)
|
|
||||||
|
|
||||||
for {
|
|
||||||
files, err := readReportFiles(dir)
|
|
||||||
if err == nil && len(files) == 1 && files[0] == appended {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if time.Now().After(deadline) {
|
|
||||||
t.Fatalf("%d report files (error: %v), want one holding the "+
|
|
||||||
"%d bytes appended", len(files), err, len(appended))
|
|
||||||
}
|
|
||||||
|
|
||||||
time.Sleep(10 * time.Millisecond)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// appendToThreshold appends reports to buf until it holds
|
|
||||||
// FlushSizeThreshold bytes, so that the last append starts writing them
|
|
||||||
// to a report file, and returns the lines appended.
|
|
||||||
func appendToThreshold(t *testing.T, buf *reportbuf.Buffer) string {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
// Large reports, so the threshold takes a few hundred appends.
|
// Large reports, so the threshold takes a few hundred appends.
|
||||||
pad := strings.Repeat("a", 64<<10)
|
pad := strings.Repeat("a", 64<<10)
|
||||||
|
|
||||||
@@ -1116,7 +914,22 @@ func appendToThreshold(t *testing.T, buf *reportbuf.Buffer) string {
|
|||||||
appended.WriteByte('\n')
|
appended.WriteByte('\n')
|
||||||
}
|
}
|
||||||
|
|
||||||
return appended.String()
|
// Append writes the file in the background, so wait for it.
|
||||||
|
deadline := time.Now().Add(10 * time.Second)
|
||||||
|
|
||||||
|
for {
|
||||||
|
files, err := readReportFiles(dir)
|
||||||
|
if err == nil && len(files) == 1 && files[0] == appended.String() {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if time.Now().After(deadline) {
|
||||||
|
t.Fatalf("%d report files (error: %v), want one holding the "+
|
||||||
|
"%d bytes appended", len(files), err, appended.Len())
|
||||||
|
}
|
||||||
|
|
||||||
|
time.Sleep(10 * time.Millisecond)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// reportFilesBytes returns the total size of the report files in dir.
|
// reportFilesBytes returns the total size of the report files in dir.
|
||||||
|
|||||||
@@ -2,10 +2,9 @@
|
|||||||
# script/frontend-test: run the frontend test suite on the host: the
|
# script/frontend-test: run the frontend test suite on the host: the
|
||||||
# unit tests in test/unit/, through the test script in package.json,
|
# unit tests in test/unit/, through the test script in package.json,
|
||||||
# then the production build, which fails on broken code. make test runs
|
# then the production build, which fails on broken code. make test runs
|
||||||
# the same tests in the frontend-test stage of Dockerfile, and the image
|
# the same in the frontend stage of Dockerfile. The tests print a dot
|
||||||
# build runs the production build in its frontend-build stage. The tests
|
# each; if any fails, they run again with every test listed, and the
|
||||||
# print a dot each; if any fails, they run again with every test listed,
|
# script fails even if that run passes. NODE_OPTIONS chooses the
|
||||||
# and the script fails even if that run passes. NODE_OPTIONS chooses the
|
|
||||||
# reporter because yarn adds its arguments after the test files, where
|
# reporter because yarn adds its arguments after the test files, where
|
||||||
# node would take a reporter option for one more file.
|
# node would take a reporter option for one more file.
|
||||||
set -eu
|
set -eu
|
||||||
|
|||||||
+8
-46
@@ -13,22 +13,20 @@ import {
|
|||||||
humanDuration,
|
humanDuration,
|
||||||
latencyClass,
|
latencyClass,
|
||||||
latencyHex,
|
latencyHex,
|
||||||
log,
|
|
||||||
measureLatency,
|
measureLatency,
|
||||||
Reporter,
|
Reporter,
|
||||||
tick,
|
tick,
|
||||||
} from "../../web/src/main.js";
|
} from "../../web/src/main.js";
|
||||||
|
|
||||||
// There is no page here, so the tests stand in for it. The debug log looks
|
// There is no page here, so the tests stand in for it. The debug log looks
|
||||||
// for its panel by id and finds none, an element the page creates is a
|
// for its panel by id and finds none. Each element of a host's row that
|
||||||
// plain object, and no frame the page asks for ever comes. Each element of
|
// tick or greyOutUI draws into is a plain object, made the first time a
|
||||||
// a host's row that tick or greyOutUI draws into is a plain object, made
|
// test looks it up and kept in elements under its selector until the next
|
||||||
// the first time a test looks it up and kept in elements under its
|
// test starts. As on a page, writing its text replaces its markup; the
|
||||||
// selector until the next test starts. As on a page, writing its text
|
// status dot greyOutUI looks for in it is not there. Drawing a sparkline
|
||||||
// replaces its markup; the status dot greyOutUI looks for in it is not
|
// does nothing; it looks for the pixel ratio on window and finds none. In
|
||||||
// there. Drawing a sparkline does nothing; it looks for the pixel ratio on
|
// each test, console.error and console.info print nothing and keep what
|
||||||
// window and finds none. In each test, console.error and console.info
|
// they are given.
|
||||||
// print nothing and keep what they are given.
|
|
||||||
const doNothing = () => {};
|
const doNothing = () => {};
|
||||||
let elements;
|
let elements;
|
||||||
beforeEach((t) => {
|
beforeEach((t) => {
|
||||||
@@ -48,11 +46,8 @@ const canvasContext = {
|
|||||||
arc: doNothing,
|
arc: doNothing,
|
||||||
};
|
};
|
||||||
globalThis.window = {};
|
globalThis.window = {};
|
||||||
globalThis.requestAnimationFrame = doNothing;
|
|
||||||
globalThis.cancelAnimationFrame = doNothing;
|
|
||||||
globalThis.document = {
|
globalThis.document = {
|
||||||
getElementById: () => null,
|
getElementById: () => null,
|
||||||
createElement: () => ({}),
|
|
||||||
querySelector: (selector) =>
|
querySelector: (selector) =>
|
||||||
(elements[selector] ??= {
|
(elements[selector] ??= {
|
||||||
getContext: () => canvasContext,
|
getContext: () => canvasContext,
|
||||||
@@ -476,39 +471,6 @@ test("of the checks interval changes cleared before they were reported, the next
|
|||||||
assert.equal(sent.at(-1).t, 120000);
|
assert.equal(sent.at(-1).t, 120000);
|
||||||
});
|
});
|
||||||
|
|
||||||
// panel stands in for the open debug log panel, and for the element in it
|
|
||||||
// that holds its lines, whichever the page looks up by id; the lines are
|
|
||||||
// kept in order in lines. Drawing the whole panel, as opening it does,
|
|
||||||
// replaces every line with a new one.
|
|
||||||
test("with the debug log open, writing more lines than it keeps adds each to the panel and leaves the lines already shown as they are", (t) => {
|
|
||||||
const lines = [];
|
|
||||||
const panel = {
|
|
||||||
classList: { contains: () => false },
|
|
||||||
children: lines,
|
|
||||||
get firstElementChild() {
|
|
||||||
return lines[0];
|
|
||||||
},
|
|
||||||
append: (line) => lines.push(line),
|
|
||||||
removeChild: (line) => lines.splice(lines.indexOf(line), 1),
|
|
||||||
replaceChildren: (...newLines) =>
|
|
||||||
lines.splice(0, lines.length, ...newLines),
|
|
||||||
};
|
|
||||||
t.mock.method(globalThis.document, "getElementById", () => panel);
|
|
||||||
const kept = CONFIG.maxLogEntries;
|
|
||||||
|
|
||||||
for (let i = 1; i <= kept; i++) log.info(`line ${i}`);
|
|
||||||
const shown = [...lines];
|
|
||||||
for (let i = kept + 1; i <= kept + 5; i++) log.info(`line ${i}`);
|
|
||||||
|
|
||||||
assert.deepEqual(
|
|
||||||
lines.map((line) => line.textContent.match(/line \d+$/)?.[0]),
|
|
||||||
Array.from({ length: kept }, (_, i) => `line ${i + 6}`),
|
|
||||||
);
|
|
||||||
// The first five lines shown were dropped, and the rest are the same
|
|
||||||
// lines, not drawn again.
|
|
||||||
shown.slice(5).forEach((line, i) => assert.equal(lines[i], line));
|
|
||||||
});
|
|
||||||
|
|
||||||
// The page shows < > " & and ' in a row's markup as
|
// The page shows < > " & and ' in a row's markup as
|
||||||
// < > " & and '.
|
// < > " & and '.
|
||||||
test(`a target whose name and URL hold < > " & and ' shows those characters in its row`, () => {
|
test(`a target whose name and URL hold < > " & and ' shows those characters in its row`, () => {
|
||||||
|
|||||||
+16
-41
@@ -144,15 +144,13 @@ const WAN_HOSTS = [
|
|||||||
|
|
||||||
const debugLog = [];
|
const debugLog = [];
|
||||||
|
|
||||||
export const log = (() => {
|
const log = (() => {
|
||||||
function append(level, message) {
|
function append(level, message) {
|
||||||
const entry = { timestamp: new Date(), level, message };
|
debugLog.push({ timestamp: new Date(), level, message });
|
||||||
debugLog.push(entry);
|
|
||||||
if (debugLog.length > CONFIG.maxLogEntries)
|
if (debugLog.length > CONFIG.maxLogEntries)
|
||||||
debugLog.splice(0, debugLog.length - CONFIG.maxLogEntries);
|
debugLog.splice(0, debugLog.length - CONFIG.maxLogEntries);
|
||||||
const panel = document.getElementById("debug-panel");
|
const panel = document.getElementById("debug-panel");
|
||||||
if (panel && !panel.classList.contains("hidden"))
|
if (panel && !panel.classList.contains("hidden")) renderDebugLog();
|
||||||
appendDebugLogLine(entry);
|
|
||||||
}
|
}
|
||||||
return {
|
return {
|
||||||
error: (msg) => append("error", msg),
|
error: (msg) => append("error", msg),
|
||||||
@@ -1109,8 +1107,9 @@ function updateHealthBox(state) {
|
|||||||
|
|
||||||
// --- Debug Log Renderer ------------------------------------------------------
|
// --- Debug Log Renderer ------------------------------------------------------
|
||||||
|
|
||||||
// One line of the debug log panel, its message set as text.
|
function renderDebugLog() {
|
||||||
function debugLogLine(entry) {
|
const el = document.getElementById("debug-log");
|
||||||
|
if (!el) return;
|
||||||
const levelColors = {
|
const levelColors = {
|
||||||
error: "text-red-400",
|
error: "text-red-400",
|
||||||
warning: "text-orange-400",
|
warning: "text-orange-400",
|
||||||
@@ -1118,43 +1117,19 @@ function debugLogLine(entry) {
|
|||||||
info: "text-gray-300",
|
info: "text-gray-300",
|
||||||
debug: "text-gray-500",
|
debug: "text-gray-500",
|
||||||
};
|
};
|
||||||
const ts = formatUTCTimestamp(entry.timestamp);
|
el.replaceChildren(
|
||||||
const lvl = entry.level.toUpperCase().padEnd(7);
|
...debugLog.map((entry) => {
|
||||||
const line = document.createElement("div");
|
const ts = formatUTCTimestamp(entry.timestamp);
|
||||||
line.className = levelColors[entry.level] || "text-gray-400";
|
const lvl = entry.level.toUpperCase().padEnd(7);
|
||||||
line.textContent = `${ts} ${lvl} ${entry.message}`;
|
const line = document.createElement("div");
|
||||||
return line;
|
line.className = levelColors[entry.level] || "text-gray-400";
|
||||||
}
|
line.textContent = `${ts} ${lvl} ${entry.message}`;
|
||||||
|
return line;
|
||||||
// Draws every line of the debug log into the panel, when it is opened.
|
}),
|
||||||
function renderDebugLog() {
|
);
|
||||||
const el = document.getElementById("debug-log");
|
|
||||||
if (!el) return;
|
|
||||||
el.replaceChildren(...debugLog.map((entry) => debugLogLine(entry)));
|
|
||||||
el.scrollTop = el.scrollHeight;
|
el.scrollTop = el.scrollHeight;
|
||||||
}
|
}
|
||||||
|
|
||||||
// The request that scrolls the open panel to its newest line in the next
|
|
||||||
// frame. One waits at most, also in a hidden tab, where frames do not run.
|
|
||||||
let debugLogScrollFrame = 0;
|
|
||||||
|
|
||||||
// Adds entry to the open panel as its last line, and drops the first line
|
|
||||||
// once the panel holds more than maxLogEntries. A check that ends while the
|
|
||||||
// page is busy is timed only when the page is done, so the lines already
|
|
||||||
// shown are left as they are, and the panel is scrolled once a frame
|
|
||||||
// rather than once a line: scrolling it lays out all of its lines again.
|
|
||||||
function appendDebugLogLine(entry) {
|
|
||||||
const el = document.getElementById("debug-log");
|
|
||||||
if (!el) return;
|
|
||||||
el.append(debugLogLine(entry));
|
|
||||||
if (el.children.length > CONFIG.maxLogEntries)
|
|
||||||
el.removeChild(el.firstElementChild);
|
|
||||||
cancelAnimationFrame(debugLogScrollFrame);
|
|
||||||
debugLogScrollFrame = requestAnimationFrame(() => {
|
|
||||||
el.scrollTop = el.scrollHeight;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// --- Sorting -----------------------------------------------------------------
|
// --- Sorting -----------------------------------------------------------------
|
||||||
|
|
||||||
// Sort WAN hosts: pinned hosts first (alphabetically), then unpinned hosts
|
// Sort WAN hosts: pinned hosts first (alphabetically), then unpinned hosts
|
||||||
|
|||||||
Reference in New Issue
Block a user