driver-vault/DriverVault
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Plugins: create the settings collection instead of waiting for it forever

Browse Source 
01a8fec fixed the advice that led operators into this, but advice is not a
guard: a stack still running PB_BOOTSTRAP=false gets no app_settings
collection on upgrade, and the plugin panel sits at 503 while the retry
loop reads a collection that does not exist.

The fix is not to soften the reading. A missing collection stays "not
ready" rather than "no plugins configured", because the alternative lets
the first save write a fresh document over settings the server merely
failed to find - the failure this whole line of work exists to prevent.
Instead the server now fixes the cause: on a missing collection it creates
that collection and reads again.

Three pieces:

bootstrap.EnsureCollection creates one named collection from the desired
schema if absent, and nothing else. Deliberately narrower than Run - no
field reconcile elsewhere, no super-admin - so it is safe to call on a
deployment that turned the full bootstrap off. It creates the collection
the server cannot start without, not the schema the operator declined.

The store tells a missing collection apart from an outage. A 404 from a
list means the collection itself is gone: an existing but empty one answers
200 with no items. That is tagged errNoCollection, which wraps errNotReady
so every write is still refused, and IsMissingCollection narrows it. The
distinction matters because the remedies are opposites - creating
collections against a flaky database is exactly the wrong reflex, and a
test pins that an outage does not trigger it.

loadPlugins acts on the tag once, then re-reads. Failing to create is
reported as the original read error rather than the repair's, so the log
names the real problem.

Six tests: the tag and its negative in internal/plugins, and three in
internal/api against a fake PocketBase covering the collection being
created exactly once, an existing collection not being recreated, and an
outage creating nothing.

Docs from 01a8fec are corrected in the same pass - they said the panel
would answer 503 forever, which is no longer true. They now say what still
depends on the bootstrap (every other collection and field) and what does
not (app_settings alone).

go build, go vet and go test ./... pass; compose files still parse. Not
verified: no Docker CLI here, so the repair has not been exercised against
a real PocketBase, only the fake.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
tajniak81
2026-08-21 17:07:18 +02:00
co-authored by Claude Opus 5
parent 01a8fecf40
commit 660af5736a
18 changed files with 331 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Docker-AIO/.env.example
+5 -4
View File
@@ -12,10 +12,11 @@ DRIVERVAULT_SUPERADMIN_EMAIL=owner@example.com
DRIVERVAULT_SUPERADMIN_PASSWORD=change-me-long-password
DRIVERVAULT_SUPERADMIN_NAME=Administrator
# Schema creation/reconcile on boot. Leave this true: a release can add a
# collection the server needs (app_settings, which holds the plugin settings),
# and a stack that skipped the bootstrap never gets it — the plugin panel then
# answers 503 forever. Set false only for a database you know matches the release.
# Schema creation/reconcile on boot. Leave this true: a release can add
# collections or fields the server needs, and a stack that skips the bootstrap
# never gets them. (The API Server creates app_settings, which holds the plugin
# settings, on demand — but only that one.) Set false only for a database you
# know already matches the release.
PB_BOOTSTRAP=true
# Allowed CORS origin(s) — match your web origin / WEB_PORT.
Docker-AIO/.env.prod.example
+5 -4
View File
@@ -18,10 +18,11 @@ DRIVERVAULT_SUPERADMIN_EMAIL=owner@example.com
DRIVERVAULT_SUPERADMIN_PASSWORD=change-me-long-password
DRIVERVAULT_SUPERADMIN_NAME=Administrator
# Schema creation/reconcile on boot. Leave this true: a release can add a
# collection the server needs (app_settings, which holds the plugin settings),
# and a stack that skipped the bootstrap never gets it — the plugin panel then
# answers 503 forever. Set false only for a database you know matches the release.
# Schema creation/reconcile on boot. Leave this true: a release can add
# collections or fields the server needs, and a stack that skips the bootstrap
# never gets them. (The API Server creates app_settings, which holds the plugin
# settings, on demand — but only that one.) Set false only for a database you
# know already matches the release.
PB_BOOTSTRAP=true
# Allowed CORS origin(s) — match your public web URL / WEB_PORT.
Docker-AIO/Dockerfile
+3 -3
View File
@@ -220,9 +220,9 @@ ENV API_ADDR=:8080 \
# Required at runtime (no safe defaults): PB_ADMIN_EMAIL, PB_ADMIN_PASSWORD.
# Optional: DRIVERVAULT_SUPERADMIN_EMAIL / DRIVERVAULT_SUPERADMIN_PASSWORD create
# the first app super-admin on boot. PB_BOOTSTRAP=false skips schema setup —
# leave it on: a release can add a collection the server needs (app_settings,
# which holds the plugin settings), and a stack that skipped the bootstrap never
# gets it, leaving the plugin panel answering 503 indefinitely.
# leave it on: a release can add collections or fields the server needs, and a
# stack that skips the bootstrap never gets them. (app_settings, which holds the
# plugin settings, is created on demand; nothing else is.)
# For Anker Solix charger control, OCPP_REQUIRE_TLS (default true) rejects
# chargers that did not arrive over TLS — this image serves plain HTTP, so put a
# TLS-terminating proxy in front and set OCPP_PUBLIC_URL to the public wss://
Docker-AIO/README.md
+7 -6
View File
@@ -64,12 +64,13 @@ Identical to the multi-container stack, and idempotent:
missing collections, reconciles existing ones, and creates the first app
`superadmin` from `DRIVERVAULT_SUPERADMIN_EMAIL` / `_PASSWORD`.
> Leave `PB_BOOTSTRAP` at `true`, including across upgrades. A release can add a
> collection the server needs — `app_settings`, which holds the plugin settings,
> is one — and a stack that skipped the bootstrap never gets it. The plugin panel
> then answers `503` indefinitely, because a missing collection is read as "the
> database is not ready yet", never as "no plugins configured". Turn it off only
> for a database you know already matches the release you are running.
> Leave `PB_BOOTSTRAP` at `true`, including across upgrades. A release can add
> collections or fields the server needs, and a stack that skipped the bootstrap
> never gets them. The API Server self-heals exactly one thing — `app_settings`,
> the collection holding the plugin settings, which it creates on demand because
> it cannot serve the plugin panel without it. Every other schema change still
> depends on this flag, so turn it off only for a database you know already
> matches the release you are running.
## Volumes
Docker-AIO/docker-compose.prod.yml
+7 -6
View File
@@ -26,12 +26,13 @@ services:
# Probed by the panel status page. nginx serves the Web App on port 80
# inside this container, so the default (localhost:8090) would never answer.
WEBAPP_URL: "http://127.0.0.1:80"
# Schema + super-admin bootstrap (idempotent). Leave this ON. A release can
# add a collection the server needs — app_settings, holding the plugin
# settings, is one — and a stack that skipped the bootstrap never gets it:
# the plugin panel then answers 503 forever, because a missing collection
# is read as "database not ready", never as "no plugins configured".
# Turn it off only for a database you know already matches the release.
# Schema + super-admin bootstrap (idempotent). Leave this ON: a release can
# add collections or fields the server needs, and a stack that skips the
# bootstrap never gets them. The API Server self-heals exactly one thing —
# app_settings, the collection holding the plugin settings, which it
# creates on demand because it cannot serve the plugin panel without it.
# Every other schema change still depends on this flag. Turn it off only
# for a database you know already matches the release.
PB_BOOTSTRAP: "${PB_BOOTSTRAP:-true}"
DRIVERVAULT_SUPERADMIN_EMAIL: "${DRIVERVAULT_SUPERADMIN_EMAIL:-}"
DRIVERVAULT_SUPERADMIN_PASSWORD: "${DRIVERVAULT_SUPERADMIN_PASSWORD:-}"
Docker-AIO/docker-compose.yml
+7 -6
View File
@@ -29,12 +29,13 @@ services:
# Probed by the panel status page. nginx serves the Web App on port 80
# inside this container, so the default (localhost:8090) would never answer.
WEBAPP_URL: "http://127.0.0.1:80"
# Schema + super-admin bootstrap (idempotent). Leave this ON. A release can
# add a collection the server needs — app_settings, holding the plugin
# settings, is one — and a stack that skipped the bootstrap never gets it:
# the plugin panel then answers 503 forever, because a missing collection
# is read as "database not ready", never as "no plugins configured".
# Turn it off only for a database you know already matches the release.
# Schema + super-admin bootstrap (idempotent). Leave this ON: a release can
# add collections or fields the server needs, and a stack that skips the
# bootstrap never gets them. The API Server self-heals exactly one thing —
# app_settings, the collection holding the plugin settings, which it
# creates on demand because it cannot serve the plugin panel without it.
# Every other schema change still depends on this flag. Turn it off only
# for a database you know already matches the release.
PB_BOOTSTRAP: "${PB_BOOTSTRAP:-true}"
DRIVERVAULT_SUPERADMIN_EMAIL: "${DRIVERVAULT_SUPERADMIN_EMAIL:-}"
DRIVERVAULT_SUPERADMIN_PASSWORD: "${DRIVERVAULT_SUPERADMIN_PASSWORD:-}"