mirror of
https://github.com/legop3/MultiRoombaRover.git
synced 2026-11-17 12:12:16 -05:00
Compare commits
50
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
008c90edf1 | ||
|
|
eed88983ca | ||
|
|
923c04736b | ||
|
|
bdc3eb640d | ||
|
|
01354c56e6 | ||
|
|
0ff03a74a5 | ||
|
|
73a78eef20 | ||
|
|
dbcb7f6a7a | ||
|
|
aeeff6fe1b | ||
|
|
e750712a39 | ||
|
|
ff8b0c530e | ||
|
|
69c5bfe544 | ||
|
|
3ad95b376a | ||
|
|
bda740b08d | ||
|
|
3c8c5f5883 | ||
|
|
c35544e515 | ||
|
|
0df4a5ec89 | ||
|
|
8e301e7db7 | ||
|
|
b712fb89c6 | ||
|
|
fe2c29371f | ||
|
|
61ee692815 | ||
|
|
487666eed8 | ||
|
|
51b42ea778 | ||
|
|
318cad1846 | ||
|
|
f3e3b6a803 | ||
|
|
b48348d89e | ||
|
|
785cc85476 | ||
|
|
b47f1ba2ae | ||
|
|
8fb9278109 | ||
|
|
609eb6c35e | ||
|
|
c3c60fde18 | ||
|
|
aa3c0c0e7b | ||
|
|
8b5d7372f9 | ||
|
|
7539898f98 | ||
|
|
73255831f1 | ||
|
|
3b585b06b4 | ||
|
|
55ee6e05bb | ||
|
|
5d4f7fe5cc | ||
|
|
bdb32d13ac | ||
|
|
6b6fbcf871 | ||
|
|
5a81ff7716 | ||
|
|
470e95b0f9 | ||
|
|
9ce6550f13 | ||
|
|
ef9baf6063 | ||
|
|
43274e7371 | ||
|
|
e7d7f2a270 | ||
|
|
1c34849bd0 | ||
|
|
edc1b825f2 | ||
|
|
c56a8b1000 | ||
|
|
91e0cc3886 |
@@ -0,0 +1,16 @@
|
|||||||
|
# Docker Build Context
|
||||||
|
# Purpose: Keeps local state, cached dependencies, and host-built artifacts out
|
||||||
|
# of the production image build context. Every required artifact is recreated
|
||||||
|
# by the Dockerfile from tracked source and lockfiles.
|
||||||
|
.git
|
||||||
|
.gitignore
|
||||||
|
**/node_modules
|
||||||
|
# Neither the legacy state directory nor the Compose-mounted replacement may
|
||||||
|
# enter an image build. This prevents credentials and backups from becoming
|
||||||
|
# image layers after an operator has started using either deployment layout.
|
||||||
|
/server/data
|
||||||
|
/data
|
||||||
|
server/public
|
||||||
|
server/src/services/kinectService/native/kinect_worker
|
||||||
|
server/src/services/balanceBoardService/native/balance_board_worker
|
||||||
|
**/*.log
|
||||||
@@ -0,0 +1,67 @@
|
|||||||
|
# Build the exact production image on pull requests, publish branch-named images
|
||||||
|
# for development, and replace `latest` only after a successful main-branch
|
||||||
|
# push. Keeping every channel in one job prevents a second build path from
|
||||||
|
# drifting away from what servers actually download.
|
||||||
|
name: Container image
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
# Every repository branch gets one moving development image. GitHub does not
|
||||||
|
# grant package-write access to untrusted fork pull requests, which remain
|
||||||
|
# build-only through the separate pull_request event above.
|
||||||
|
push:
|
||||||
|
|
||||||
|
# Repository contents are read to build the image. Package write access is used
|
||||||
|
# only by the conditional GHCR login and push steps on repository branch pushes.
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
packages: write
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
image:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Check out repository
|
||||||
|
uses: actions/checkout@v7
|
||||||
|
|
||||||
|
# Buildx supplies the cache and the explicit amd64 build used both for
|
||||||
|
# pull-request verification and publication. QEMU is intentionally absent
|
||||||
|
# because the central server image supports only linux/amd64.
|
||||||
|
- name: Set up Docker Buildx
|
||||||
|
uses: docker/setup-buildx-action@v4
|
||||||
|
|
||||||
|
# GitHub's built-in token can publish to this repository's package. Pull
|
||||||
|
# requests never authenticate to GHCR and therefore cannot publish.
|
||||||
|
- name: Log in to GHCR
|
||||||
|
if: github.event_name == 'push'
|
||||||
|
uses: docker/login-action@v4
|
||||||
|
with:
|
||||||
|
registry: ghcr.io
|
||||||
|
username: ${{ github.actor }}
|
||||||
|
password: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
|
# Docker's maintained metadata action converts branch names into valid
|
||||||
|
# container tags, including replacing separators such as `/`. Main gets
|
||||||
|
# only `latest`; every other pushed branch gets only its branch tag.
|
||||||
|
- name: Select image tag
|
||||||
|
id: image-metadata
|
||||||
|
uses: docker/metadata-action@v6
|
||||||
|
with:
|
||||||
|
images: ghcr.io/legop3/multiroombarover
|
||||||
|
flavor: latest=false
|
||||||
|
tags: |
|
||||||
|
type=raw,value=latest,enable={{is_default_branch}}
|
||||||
|
type=ref,event=branch,enable={{is_not_default_branch}}
|
||||||
|
|
||||||
|
# The push switch keeps pull requests build-only. Branch images are
|
||||||
|
# replaced on each successful push, just as main replaces `latest`.
|
||||||
|
- name: Build and optionally publish
|
||||||
|
uses: docker/build-push-action@v7
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
platforms: linux/amd64
|
||||||
|
push: ${{ github.event_name == 'push' }}
|
||||||
|
tags: ${{ steps.image-metadata.outputs.tags }}
|
||||||
|
cache-from: type=gha
|
||||||
|
cache-to: type=gha,mode=max
|
||||||
+3
-3
@@ -13,8 +13,6 @@ config.h
|
|||||||
robots.json
|
robots.json
|
||||||
roverd-dummy
|
roverd-dummy
|
||||||
server/config.yaml
|
server/config.yaml
|
||||||
server/package-lock.json
|
|
||||||
package-lock.json
|
|
||||||
server/data/discord-guilds.json
|
server/data/discord-guilds.json
|
||||||
server/data/global-objective.json
|
server/data/global-objective.json
|
||||||
server/data/admin-reason.json
|
server/data/admin-reason.json
|
||||||
@@ -22,7 +20,9 @@ server/data/buttonbox-state.json
|
|||||||
server/data/barcode-tts-cache/
|
server/data/barcode-tts-cache/
|
||||||
server/data/rover-odometers.json
|
server/data/rover-odometers.json
|
||||||
server/data/mediamtx.yml
|
server/data/mediamtx.yml
|
||||||
webui/package-lock.json
|
# npm lockfiles are deliberately tracked. The production image uses `npm ci`,
|
||||||
|
# so a clean GitHub checkout must contain the exact dependency resolution used
|
||||||
|
# by local builds rather than resolving a different dependency tree.
|
||||||
!server/data/
|
!server/data/
|
||||||
!server/data/barcode-registry.json
|
!server/data/barcode-registry.json
|
||||||
webui/src/config/analytics.jsx
|
webui/src/config/analytics.jsx
|
||||||
|
|||||||
+200
@@ -0,0 +1,200 @@
|
|||||||
|
# syntax=docker/dockerfile:1
|
||||||
|
|
||||||
|
# MultiRover Production Application Image
|
||||||
|
# Purpose: Builds the web application, Node dependencies, native hardware
|
||||||
|
# workers, and pinned runtime tools into one amd64 server image.
|
||||||
|
# Scope: Packages the application and its private controller command in one
|
||||||
|
# image. Compose still isolates their processes, mounts, and privileges.
|
||||||
|
|
||||||
|
ARG FEDORA_VERSION=43
|
||||||
|
|
||||||
|
FROM fedora:${FEDORA_VERSION} AS architecture-check
|
||||||
|
ARG TARGETARCH
|
||||||
|
# The central server is currently deployed and verified only on amd64. Failing
|
||||||
|
# here avoids publishing an ARM image whose native workers and hardware paths
|
||||||
|
# have never been exercised on a real ARM server.
|
||||||
|
RUN test "${TARGETARCH}" = "amd64" || (echo "MultiRover server images support only linux/amd64." >&2; exit 1)
|
||||||
|
|
||||||
|
FROM architecture-check AS webui-build
|
||||||
|
RUN dnf install -y --setopt=install_weak_deps=False nodejs npm \
|
||||||
|
&& dnf clean all
|
||||||
|
WORKDIR /build
|
||||||
|
# Copy dependency manifests first so ordinary source edits retain the expensive
|
||||||
|
# npm cache layer. npm ci makes the checked-in lockfile the exact dependency
|
||||||
|
# source rather than resolving a new tree during image publication.
|
||||||
|
COPY webui/package.json webui/package-lock.json ./webui/
|
||||||
|
RUN --mount=type=cache,target=/root/.npm \
|
||||||
|
cd webui && npm ci
|
||||||
|
COPY webui ./webui
|
||||||
|
# Vite deliberately emits into ../server/public. Create that destination in the
|
||||||
|
# isolated builder and copy only its finished files into the runtime stage.
|
||||||
|
RUN mkdir -p server/public && cd webui && npm run build
|
||||||
|
|
||||||
|
FROM architecture-check AS server-dependencies
|
||||||
|
RUN dnf install -y --setopt=install_weak_deps=False nodejs npm gcc-c++ make python3 \
|
||||||
|
&& dnf clean all
|
||||||
|
WORKDIR /build/server
|
||||||
|
COPY server/package.json server/package-lock.json ./
|
||||||
|
# Native Node modules compile here when a matching prebuild is unavailable;
|
||||||
|
# neither the compiler nor npm's download cache is copied into the final image.
|
||||||
|
RUN --mount=type=cache,target=/root/.npm \
|
||||||
|
npm ci --omit=dev
|
||||||
|
|
||||||
|
FROM architecture-check AS native-workers
|
||||||
|
RUN dnf install -y --setopt=install_weak_deps=False \
|
||||||
|
bluez-libs-devel \
|
||||||
|
gcc-c++ \
|
||||||
|
libcap \
|
||||||
|
libfreenect-devel \
|
||||||
|
libusb1-devel \
|
||||||
|
make \
|
||||||
|
pkgconf-pkg-config \
|
||||||
|
wiiuse-devel \
|
||||||
|
&& dnf clean all
|
||||||
|
WORKDIR /build
|
||||||
|
COPY server/src/services/kinectService/native ./kinect
|
||||||
|
COPY server/src/services/balanceBoardService/native ./balance-board
|
||||||
|
# Build both hardware workers from source for the image's Fedora ABI instead of
|
||||||
|
# copying workstation binaries whose linked libraries may not match.
|
||||||
|
RUN make -C kinect \
|
||||||
|
&& make -C balance-board
|
||||||
|
|
||||||
|
FROM architecture-check AS packaged-tools
|
||||||
|
ARG MEDIAMTX_VERSION=1.15.3
|
||||||
|
ARG MEDIAMTX_SHA256=cddc98d17f23689848d5a935151264e117cfb27cee2db87b5079b19572e4b48d
|
||||||
|
ARG NEOLINK_VERSION=0.6.2
|
||||||
|
ARG NEOLINK_SHA256=0cb963b44dca7ccc5333154092186e1536c687aef0e1ad119b7f310a7471dbbb
|
||||||
|
ARG GOOGLE_TTS_VERSION=26.5
|
||||||
|
ARG GOOGLE_TTS_SHA256=6a9eae6726871788da52e767dad964a1c83e7feb7e7dbac508a2574a2345ac24
|
||||||
|
RUN dnf install -y --setopt=install_weak_deps=False curl findutils tar unzip xz \
|
||||||
|
&& dnf clean all
|
||||||
|
WORKDIR /build/tools
|
||||||
|
# Each external artifact is pinned and checked before extraction. A changed or
|
||||||
|
# truncated upstream download therefore fails the image build instead of being
|
||||||
|
# silently promoted as the new production server.
|
||||||
|
RUN curl --fail --location --retry 3 \
|
||||||
|
"https://github.com/bluenviron/mediamtx/releases/download/v${MEDIAMTX_VERSION}/mediamtx_v${MEDIAMTX_VERSION}_linux_amd64.tar.gz" \
|
||||||
|
--output mediamtx.tar.gz \
|
||||||
|
&& echo "${MEDIAMTX_SHA256} mediamtx.tar.gz" | sha256sum --check --strict \
|
||||||
|
&& tar -xzf mediamtx.tar.gz mediamtx \
|
||||||
|
&& install -D -m 0755 mediamtx /output/usr/local/bin/mediamtx
|
||||||
|
RUN curl --fail --location --retry 3 \
|
||||||
|
"https://github.com/QuantumEntangledAndy/neolink/releases/download/v${NEOLINK_VERSION}/neolink_linux_x86_64_ubuntu.zip" \
|
||||||
|
--output neolink.zip \
|
||||||
|
&& echo "${NEOLINK_SHA256} neolink.zip" | sha256sum --check --strict \
|
||||||
|
&& unzip -q neolink.zip -d neolink \
|
||||||
|
&& neolink_binary="$(find neolink -type f -name neolink -print -quit)" \
|
||||||
|
&& test -n "${neolink_binary}" \
|
||||||
|
&& install -D -m 0755 "${neolink_binary}" /output/usr/local/bin/neolink
|
||||||
|
RUN curl --fail --location --retry 3 \
|
||||||
|
"https://storage.googleapis.com/chromeos-localmirror/distfiles/googletts-${GOOGLE_TTS_VERSION}.tar.xz" \
|
||||||
|
--output googletts.tar.xz \
|
||||||
|
&& echo "${GOOGLE_TTS_SHA256} googletts.tar.xz" | sha256sum --check --strict \
|
||||||
|
&& tar -xf googletts.tar.xz en-us-x-multi.zvoice libchrometts_x86_64.so \
|
||||||
|
&& install -D -m 0644 libchrometts_x86_64.so /output/opt/roverd/googletts/libchrometts.so \
|
||||||
|
&& mkdir -p /output/opt/roverd/googletts/en-us-x-multi-r30 \
|
||||||
|
&& unzip -q en-us-x-multi.zvoice -d /output/opt/roverd/googletts/en-us-x-multi-r30 \
|
||||||
|
&& find /output/opt/roverd/googletts -type d -exec chmod 0755 {} + \
|
||||||
|
&& find /output/opt/roverd/googletts -type f -exec chmod 0644 {} +
|
||||||
|
|
||||||
|
FROM architecture-check AS learning-dependencies
|
||||||
|
# CPU-only learning dependencies are built once. Disabled installations never
|
||||||
|
# launch Python or install packages as a side effect of starting Node.
|
||||||
|
RUN dnf install -y --setopt=install_weak_deps=False python3 python3-pip \
|
||||||
|
&& dnf clean all
|
||||||
|
COPY server/src/services/roverLearningService/workers/requirements.txt /tmp/learning-requirements.txt
|
||||||
|
RUN python3 -m venv /opt/rover-learning \
|
||||||
|
&& /opt/rover-learning/bin/pip install --no-cache-dir -r /tmp/learning-requirements.txt
|
||||||
|
|
||||||
|
FROM fedora:${FEDORA_VERSION} AS runtime
|
||||||
|
ARG FEDORA_VERSION
|
||||||
|
ARG TARGETARCH
|
||||||
|
RUN test "${TARGETARCH}" = "amd64" || (echo "MultiRover server images support only linux/amd64." >&2; exit 1)
|
||||||
|
# Fedora's restricted ffmpeg-free build omits the libx264 encoder used by every
|
||||||
|
# replay output path. Enable RPM Fusion Free before installing runtime packages
|
||||||
|
# so the image receives the complete FFmpeg build instead of requiring replay
|
||||||
|
# code to work around a deployment-only codec omission.
|
||||||
|
RUN dnf install -y --setopt=install_weak_deps=False \
|
||||||
|
"https://download1.rpmfusion.org/free/fedora/rpmfusion-free-release-${FEDORA_VERSION}.noarch.rpm"
|
||||||
|
# This is the complete runtime package set. Build headers and compilers live in
|
||||||
|
# earlier stages, while media, TTS, USB, and Bluetooth libraries remain here
|
||||||
|
# because enabled services invoke them after startup. Weak dependencies are
|
||||||
|
# deliberately disabled: Fedora otherwise installs desktop portals, graphical
|
||||||
|
# themes, and GPU drivers that a headless server neither starts nor uses.
|
||||||
|
RUN dnf install -y --setopt=install_weak_deps=False \
|
||||||
|
bluez \
|
||||||
|
bluez-libs \
|
||||||
|
espeak \
|
||||||
|
ffmpeg \
|
||||||
|
flite \
|
||||||
|
gstreamer1 \
|
||||||
|
gstreamer1-plugins-bad-free \
|
||||||
|
gstreamer1-plugins-base \
|
||||||
|
gstreamer1-plugins-good \
|
||||||
|
gstreamer1-rtsp-server \
|
||||||
|
libcxx \
|
||||||
|
libcxxabi \
|
||||||
|
libcap \
|
||||||
|
libfreenect \
|
||||||
|
libusb1 \
|
||||||
|
nodejs \
|
||||||
|
python3 \
|
||||||
|
shadow-utils \
|
||||||
|
tini \
|
||||||
|
wiiuse \
|
||||||
|
--allowerasing \
|
||||||
|
&& dnf clean all \
|
||||||
|
&& useradd --uid 1000 --create-home --home-dir /home/multirover --shell /sbin/nologin multirover \
|
||||||
|
&& install -d -o multirover -g multirover -m 0755 /data /opt/multirover/server
|
||||||
|
|
||||||
|
WORKDIR /opt/multirover/server
|
||||||
|
COPY server/index.js server/package.json server/package-lock.json ./
|
||||||
|
COPY server/src ./src
|
||||||
|
COPY server/assets ./assets
|
||||||
|
COPY server/prompts ./prompts
|
||||||
|
COPY --from=server-dependencies /build/server/node_modules ./node_modules
|
||||||
|
COPY --from=webui-build /build/server/public ./public
|
||||||
|
COPY --from=native-workers /build/kinect/kinect_worker ./src/services/kinectService/native/kinect_worker
|
||||||
|
COPY --from=native-workers /build/balance-board/balance_board_worker ./src/services/balanceBoardService/native/balance_board_worker
|
||||||
|
COPY --from=packaged-tools /output/ /
|
||||||
|
COPY --from=learning-dependencies /opt/rover-learning /opt/rover-learning
|
||||||
|
COPY --chmod=0755 server/bin/chromegtts-wav.py /usr/local/bin/chromegtts-wav
|
||||||
|
COPY --chmod=0755 server/mediamtx/rover-snapshot-writer.sh /usr/local/bin/rover-snapshot-writer.sh
|
||||||
|
|
||||||
|
# Only the audited Balance Board bridge receives its two required socket
|
||||||
|
# capabilities. Node and the rest of the application continue to run without
|
||||||
|
# ambient capabilities; Compose must also allow these capabilities when the
|
||||||
|
# optional Balance Board feature is used.
|
||||||
|
RUN setcap cap_net_admin,cap_net_bind_service+ep \
|
||||||
|
./src/services/balanceBoardService/native/balance_board_worker \
|
||||||
|
&& /usr/local/bin/chromegtts-wav \
|
||||||
|
--text "test" \
|
||||||
|
--voice tpf \
|
||||||
|
--pitch 1 \
|
||||||
|
--speed 1 \
|
||||||
|
--output /tmp/chromegtts-smoke.wav \
|
||||||
|
&& test -s /tmp/chromegtts-smoke.wav \
|
||||||
|
&& rm /tmp/chromegtts-smoke.wav
|
||||||
|
|
||||||
|
ENV NODE_ENV=production \
|
||||||
|
SERVER_DATA_DIR=/data \
|
||||||
|
ROVER_SNAPSHOT_WRITER_BIN=/usr/local/bin/rover-snapshot-writer.sh
|
||||||
|
|
||||||
|
USER multirover
|
||||||
|
# Declaring the persistence boundary also protects direct `docker run` users:
|
||||||
|
# when no explicit host path or named volume is supplied, Docker still places
|
||||||
|
# `/data` on an anonymous volume rather than the replaceable image layer.
|
||||||
|
VOLUME ["/data"]
|
||||||
|
EXPOSE 8080/tcp 8554/tcp 8189/tcp 8189/udp
|
||||||
|
# Use Node's built-in fetch so container readiness does not require curl or a
|
||||||
|
# second probe binary in the runtime image. The endpoint verifies the writable
|
||||||
|
# data mount and MediaMTX; reaching it already proves Node is accepting HTTP.
|
||||||
|
HEALTHCHECK --interval=30s --timeout=5s --start-period=15s --retries=3 \
|
||||||
|
CMD node -e "fetch('http://127.0.0.1:'+(process.env.PORT||8080)+'/health').then(response=>process.exit(response.ok?0:1)).catch(()=>process.exit(1))"
|
||||||
|
ENTRYPOINT ["/usr/bin/tini", "--"]
|
||||||
|
CMD ["node", "index.js"]
|
||||||
|
|
||||||
|
# OCI metadata links the unversioned latest image to its source without
|
||||||
|
# introducing release numbers or additional image tags.
|
||||||
|
LABEL org.opencontainers.image.source="https://github.com/legop3/MultiRoombaRover" \
|
||||||
|
org.opencontainers.image.title="MultiRoombaRover"
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
# MultiRover production deployment
|
||||||
|
name: multirover
|
||||||
|
|
||||||
|
# Change this one line to use a development branch image.
|
||||||
|
x-multirover-image: &multirover-image ghcr.io/legop3/multiroombarover:latest
|
||||||
|
|
||||||
|
services:
|
||||||
|
server:
|
||||||
|
image: *multirover-image
|
||||||
|
container_name: multirover
|
||||||
|
|
||||||
|
network_mode: host
|
||||||
|
restart: unless-stopped
|
||||||
|
stop_grace_period: 20s
|
||||||
|
|
||||||
|
security_opt:
|
||||||
|
- label=disable
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
# All persistent application data is stored in this volume.
|
||||||
|
- data:/data
|
||||||
|
- lifecycle-socket:/run/multirover
|
||||||
|
# Required for Bluetooth hardware such as the Balance Board.
|
||||||
|
- /run/dbus/system_bus_socket:/run/dbus/system_bus_socket:ro
|
||||||
|
|
||||||
|
# Required for Kinect USB access.
|
||||||
|
devices:
|
||||||
|
- /dev/bus/usb:/dev/bus/usb
|
||||||
|
|
||||||
|
cap_add:
|
||||||
|
- NET_ADMIN
|
||||||
|
|
||||||
|
lifecycle:
|
||||||
|
image: *multirover-image
|
||||||
|
container_name: multirover-lifecycle
|
||||||
|
command: ["node", "src/services/serverControlService/controller.js"]
|
||||||
|
user: root
|
||||||
|
network_mode: none
|
||||||
|
restart: unless-stopped
|
||||||
|
healthcheck:
|
||||||
|
disable: true
|
||||||
|
security_opt:
|
||||||
|
- label=disable
|
||||||
|
environment:
|
||||||
|
MULTIROVER_TARGET_IMAGE: *multirover-image
|
||||||
|
volumes:
|
||||||
|
- lifecycle-socket:/run/multirover
|
||||||
|
# Do not add this Docker socket mount to the server service.
|
||||||
|
- /var/run/docker.sock:/var/run/docker.sock
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
# `docker compose down -v` permanently deletes these volumes.
|
||||||
|
data:
|
||||||
|
name: multirover-data
|
||||||
|
lifecycle-socket:
|
||||||
|
name: multirover-lifecycle-socket
|
||||||
@@ -6,10 +6,16 @@ This document is the live implementation tracker for the migration.
|
|||||||
|
|
||||||
- [x] Phase 1, step 1: Establish the single data-directory contract
|
- [x] Phase 1, step 1: Establish the single data-directory contract
|
||||||
- [x] Phase 1, steps 2-5: Configuration database, manual setup-file import, setup, and centralized admin UI
|
- [x] Phase 1, steps 2-5: Configuration database, manual setup-file import, setup, and centralized admin UI
|
||||||
- [ ] Phase 1, steps 6-9: Backup/restore, restart, and internal video proxy
|
- [x] Phase 1, steps 6-8: Restart, backup/restore, and internal video proxy
|
||||||
|
- [x] Phase 1, step 9: Complete the remaining legacy-deployment integration and hardware verification
|
||||||
|
- [x] Phase 2, step 10: Build and locally verify the production application image
|
||||||
|
- [x] Phase 2, steps 11-12: Add the single-container Compose deployment and locally verify its host-access contract
|
||||||
|
- [x] Phase 2, step 13: Add application and container health checks
|
||||||
|
- [x] Phase 2, step 14: Add the restricted lifecycle container and connect the System UI
|
||||||
|
- [x] Phase 2, step 15: Build pull requests and publish the main branch to the single GHCR `latest` channel
|
||||||
- [ ] Phase 2: Containerization, GHCR publishing, and container lifecycle controls
|
- [ ] Phase 2: Containerization, GHCR publishing, and container lifecycle controls
|
||||||
|
|
||||||
The single data-directory implementation and local verification are complete. Real snapshot generation, legacy-directory cleanup, and runtime filesystem tracing remain deployment checks for the actual server; they do not leave the implementation step open.
|
Phase 1 is complete. The current application has run successfully on the production server with the new configuration, administration, persistence, backup/restore, and internal video-proxy contracts.
|
||||||
|
|
||||||
The work is deliberately split into two phases:
|
The work is deliberately split into two phases:
|
||||||
|
|
||||||
@@ -20,8 +26,15 @@ Phase 1 must be complete and verified before Phase 2 begins. Containerization mu
|
|||||||
|
|
||||||
## Decision log
|
## Decision log
|
||||||
|
|
||||||
|
- 2026-09-14: Publish `ghcr.io/legop3/multiroombarover:latest` only from the repository's main branch. Every other repository branch publishes one moving development image named for that branch, with invalid tag separators normalized; these are development selectors rather than numbered releases. Pull requests only verify that the image builds. There are no release numbers, semantic-version tags, stable/edge channels, or operator-facing version selection. Docker image digests remain an internal mechanism for detecting an available update and retaining the previously running image for rollback.
|
||||||
|
- 2026-09-15: Support only `linux/amd64` for the central server image. Rover computers remain independently ARM-capable, but publishing an untested ARM server image would multiply native-worker, media-binary, TTS-library, and hardware validation without serving the current deployment. ARM server support can be added later when a real ARM server exists to verify it.
|
||||||
|
- 2026-09-15: Mount the application data directory from the Docker-managed `multirover-data` named volume instead of a host bind path. Docker initializes the empty volume with the image's non-root ownership, eliminating host UID matching, directory creation, ownership commands, and root application startup. The admin backup/restore system is the supported portable interface to the complete data tree.
|
||||||
|
- 2026-09-14: Apply every committed configuration revision immediately. The configuration coordinator atomically replaces the process-wide snapshot, compares top-level service sections, serially reloads only affected service runtimes, and then refreshes all sessions. Long-lived HTTP/socket handlers remain registered once and delegate to the current runtime; integrations may reconnect or replace their own child process, worker, client, timers, and subscriptions without restarting Node.
|
||||||
- 2026-09-14: Render the schema-driven configuration editor as a YAML-like tree inside one `CardFrame`. Every object or array introduces an ordered header and one indentation guide, every scalar occupies one key/value row, and array operations remain beside their item instead of moving to the far edge. Keep all route-specific RJSF styling in `webui/src/admin/styles.css`, outside the shared global stylesheet.
|
- 2026-09-14: Render the schema-driven configuration editor as a YAML-like tree inside one `CardFrame`. Every object or array introduces an ordered header and one indentation guide, every scalar occupies one key/value row, and array operations remain beside their item instead of moving to the far edge. Keep all route-specific RJSF styling in `webui/src/admin/styles.css`, outside the shared global stylesheet.
|
||||||
- 2026-09-14: Treat container deployment as a fresh installation. Neither startup nor the installer searches for, imports, removes, or otherwise manages an old `config.yaml`; the only old-file path retained is an operator-selected YAML upload on `/setup`. The separate command-line importer and its dry-run mode are removed. Internal SQLite schema migrations remain because they evolve the active database rather than discovering an old installation.
|
- 2026-09-14: Restart only the application process, never the host. A lockdown administrator with recent password confirmation requests one audited restart, Node acknowledges and announces it, then sends itself SIGTERM. Existing service signal handlers clean up their owned children, while systemd `Restart=always` and the later container restart policy start the application again.
|
||||||
|
- 2026-09-14: Keep backup and restore together in one server service after application restart exists. Neither operation stops running services or writers, and no command-line interface is maintained. Backup uses online SQLite snapshots and stable copies of non-database files; restore validates and stages an uploaded archive, records a marker, and uses the normal application restart to replace the data directory during earliest startup.
|
||||||
|
- 2026-09-14: Define this server's canonical `publicUrl` once at the top of configuration beside `timezone`. Discord links, inter-instance identity, page metadata, and MediaMTX's primary public ICE hostname derive from it. Browser WHEP and WHIP signaling always uses the same-origin `/video` path; `media.additionalHosts` remains only for genuinely additional ICE names or addresses.
|
||||||
|
- 2026-09-14: Treat container deployment as a fresh installation. Neither startup nor the installer searches for, imports, removes, or otherwise manages an old `config.yaml`; the only old-file paths retained are operator-selected YAML uploads on `/setup` and the protected Configuration page. The separate command-line importer and its dry-run mode are removed. Internal SQLite schema migrations remain because they evolve the active database rather than discovering an old installation.
|
||||||
- 2026-09-14: Keep the one-time first-run setup code in `data/setup-code.txt` with owner-only permissions instead of writing the credential into server logs. Reuse it across restarts and delete it permanently when setup completes.
|
- 2026-09-14: Keep the one-time first-run setup code in `data/setup-code.txt` with owner-only permissions instead of writing the credential into server logs. Reuse it across restarts and delete it permanently when setup completes.
|
||||||
- 2026-09-14: Feature enablement is exactly the service-owned `enabled` boolean. A service-owned configuration definition marks itself with `feature: true` when that switch belongs in the public feature map; the configuration system derives the map for sessions and command availability, including nested service definitions, without a separate feature registry. Missing credentials, hardware, connections, data, or enabled dependencies are runtime health conditions and never silently change that choice.
|
- 2026-09-14: Feature enablement is exactly the service-owned `enabled` boolean. A service-owned configuration definition marks itself with `feature: true` when that switch belongs in the public feature map; the configuration system derives the map for sessions and command availability, including nested service definitions, without a separate feature registry. Missing credentials, hardware, connections, data, or enabled dependencies are runtime health conditions and never silently change that choice.
|
||||||
- 2026-09-14: Keep configuration as one ordered hierarchical document, matching the former YAML layout. The admin application presents one continuous configuration page and saves the complete document as one revision. There are no artificial Hardware, Integrations, Media, or similar configuration categories and no backend or frontend section registries.
|
- 2026-09-14: Keep configuration as one ordered hierarchical document, matching the former YAML layout. The admin application presents one continuous configuration page and saves the complete document as one revision. There are no artificial Hardware, Integrations, Media, or similar configuration categories and no backend or frontend section registries.
|
||||||
@@ -35,13 +48,13 @@ Phase 1 must be complete and verified before Phase 2 begins. Containerization mu
|
|||||||
- All operator-controlled server configuration is stored in a validated database and managed through the web UI.
|
- All operator-controlled server configuration is stored in a validated database and managed through the web UI.
|
||||||
- All mutable runtime state, generated files, caches, snapshots, recordings, and databases live under one server data directory.
|
- All mutable runtime state, generated files, caches, snapshots, recordings, and databases live under one server data directory.
|
||||||
- A complete backup can capture that one data directory consistently, and a restore can safely replace it.
|
- A complete backup can capture that one data directory consistently, and a restore can safely replace it.
|
||||||
- `/setup` may initialize the database from a YAML file explicitly selected by the operator; no automatic host migration exists.
|
- `/setup` may initialize the database from a YAML file explicitly selected by the operator, and the protected Configuration page may explicitly replace configuration from one later; no automatic host migration or persistent YAML source exists.
|
||||||
- A dedicated `/admin` application contains all server administration.
|
- A dedicated `/admin` application contains all server administration.
|
||||||
- The public `/video` route is proxied to MediaMTX by the Node server, eliminating the special external MediaMTX proxy rule.
|
- The public `/video` route is proxied to MediaMTX by the Node server, eliminating the special external MediaMTX proxy rule.
|
||||||
- The completed server is packaged as a replaceable container whose only persistent mount is the data directory.
|
- The completed server is packaged as a replaceable container whose only persistent mount is the data directory.
|
||||||
- Release images are built automatically and published to GHCR.
|
- The latest successful main-branch image is built automatically and published to GHCR as `ghcr.io/legop3/multiroombarover:latest`.
|
||||||
- The admin UI can restart, update, health-check, and roll back the application container without giving the main application direct Docker access.
|
- The admin UI can restart, update, health-check, and roll back the application container without giving the main application direct Docker access.
|
||||||
- The final host installation contains as little project-specific material as possible: a Compose file, a data directory, and unavoidable hardware preparation.
|
- The final host installation contains as little project-specific material as possible: a Compose file, one Docker-managed data volume, and unavoidable hardware preparation.
|
||||||
|
|
||||||
## Important boundary: application files versus server data
|
## Important boundary: application files versus server data
|
||||||
|
|
||||||
@@ -132,7 +145,7 @@ Implementation architecture:
|
|||||||
- The database validates and commits that complete document as one coherent immutable revision.
|
- The database validates and commits that complete document as one coherent immutable revision.
|
||||||
- The admin UI presents one continuous configuration page in the same top-to-bottom order as the former YAML file.
|
- The admin UI presents one continuous configuration page in the same top-to-bottom order as the former YAML file.
|
||||||
- Nested cards make object relationships readable, but do not create separate categories, navigation destinations, persistence boundaries, or registries.
|
- Nested cards make object relationships readable, but do not create separate categories, navigation destinations, persistence boundaries, or registries.
|
||||||
- Shared editor infrastructure owns loading, dirty state, validation errors, revision conflicts, secret operations, and restart-required status for the whole document.
|
- Shared editor infrastructure owns loading, dirty state, validation errors, revision conflicts, secret operations, and live-application status for the whole document.
|
||||||
- The browser receives this same schema from the protected admin endpoint and renders it with a maintained JSON Schema form library.
|
- The browser receives this same schema from the protected admin endpoint and renders it with a maintained JSON Schema form library.
|
||||||
- Standard JSON Schema types drive ordinary fields, nested objects, enums, and arrays. One field-agnostic widget handles every `writeOnly` secret; there are no feature-specific configuration components in React.
|
- Standard JSON Schema types drive ordinary fields, nested objects, enums, and arrays. One field-agnostic widget handles every `writeOnly` secret; there are no feature-specific configuration components in React.
|
||||||
|
|
||||||
@@ -186,11 +199,15 @@ Configuration changes use one intentionally simple application rule:
|
|||||||
|
|
||||||
1. Validate the complete proposed document.
|
1. Validate the complete proposed document.
|
||||||
2. Commit it as a new database revision.
|
2. Commit it as a new database revision.
|
||||||
3. Report that an application restart is required.
|
3. Atomically replace the process-wide configuration snapshot.
|
||||||
4. Let the administrator restart immediately or later.
|
4. Compare the old and new top-level sections.
|
||||||
5. Load one coherent configuration snapshot at the next process start.
|
5. Reload every service that owns a changed section, replacing its complete internal runtime when necessary.
|
||||||
|
6. Report per-service application failures without preventing unrelated services from applying the revision.
|
||||||
|
7. Refresh sessions only after all affected service reloads finish.
|
||||||
|
|
||||||
Operational actions such as changing server mode, locking a rover, or issuing a rover command remain live actions and do not become restart-required configuration edits.
|
HTTP routes, Socket.IO connection handlers, and process signal handlers are registered once. They consult live state or delegate to the current service runtime, preventing duplicate listeners after repeated saves. Service reloads may reconnect an integration or restart an application-owned child such as MediaMTX, ffmpeg, Kinect, or the Balance Board worker, but never restart the Node application.
|
||||||
|
|
||||||
|
Operational actions such as changing server mode, locking a rover, or issuing a rover command remain direct live actions rather than configuration edits.
|
||||||
|
|
||||||
After migration is complete:
|
After migration is complete:
|
||||||
|
|
||||||
@@ -199,25 +216,35 @@ After migration is complete:
|
|||||||
- Remove `config.yaml` and `config.example.yaml` from the repository and installation process.
|
- Remove `config.yaml` and `config.example.yaml` from the repository and installation process.
|
||||||
- Remove `js-yaml` if MediaMTX generation is changed to avoid it or if it is otherwise no longer needed. Generated MediaMTX YAML is an internal artifact, not operator configuration, so retaining `js-yaml` solely for that generator is acceptable.
|
- Remove `js-yaml` if MediaMTX generation is changed to avoid it or if it is otherwise no longer needed. Generated MediaMTX YAML is an internal artifact, not operator configuration, so retaining `js-yaml` solely for that generator is acceptable.
|
||||||
|
|
||||||
## 3. Add optional configuration-file upload to setup
|
## 3. Add explicit configuration-file upload to setup and administration
|
||||||
|
|
||||||
Container deployment starts with a new data directory and never discovers an old installation automatically. As a convenience, the first-run setup page may initialize the empty database from a YAML configuration file deliberately selected by the operator. This is not a startup loader, installer migration, command-line workflow, or permanent second source of truth.
|
Container deployment starts with a new data directory and never discovers an old installation automatically. As a convenience, the first-run setup page may initialize the empty database from a YAML configuration file deliberately selected by the operator. The protected Configuration page may later replace only the configuration from another explicitly selected legacy file. Neither path is a startup loader, installer migration, command-line workflow, or permanent second source of truth.
|
||||||
|
|
||||||
The setup upload must:
|
Every upload must:
|
||||||
|
|
||||||
- Accept only an explicitly selected YAML file from `/setup`.
|
- Accept only an explicitly selected YAML file from `/setup` or the protected Configuration page.
|
||||||
- Require the one-time setup code before processing it.
|
|
||||||
- Parse the complete document.
|
- Parse the complete document.
|
||||||
- Map every recognized field into the new configuration schema.
|
- Map every recognized field into the new configuration schema.
|
||||||
- Preserve existing bcrypt administrator password hashes.
|
|
||||||
- Preserve lockdown roles and Discord IDs.
|
|
||||||
- Preserve secrets without printing them.
|
- Preserve secrets without printing them.
|
||||||
- Apply current defaults for absent fields.
|
- Apply current defaults for absent fields.
|
||||||
- Ignore fields that do not exist in the current schema, while reporting invalid values supplied for current fields.
|
- Ignore fields that do not exist in the current schema, while reporting invalid values supplied for current fields.
|
||||||
- Validate the entire result before writing anything.
|
- Validate the entire result before writing anything.
|
||||||
|
- Record the uploaded filename without storing secret values in the audit event.
|
||||||
|
|
||||||
|
The setup upload additionally must:
|
||||||
|
|
||||||
|
- Require the one-time setup code before processing it.
|
||||||
|
- Preserve existing bcrypt administrator password hashes, lockdown roles, and Discord IDs.
|
||||||
- Refuse to replace an already-configured database.
|
- Refuse to replace an already-configured database.
|
||||||
- Write the configuration, administrators, and audit event atomically.
|
- Write the configuration, administrators, and audit event atomically.
|
||||||
- Record the uploaded filename without storing secret values in the audit event.
|
|
||||||
|
The initialized-server upload additionally must:
|
||||||
|
|
||||||
|
- Require a lockdown administrator with recent password confirmation.
|
||||||
|
- Use optimistic revision checking so it cannot overwrite an intervening edit.
|
||||||
|
- Ignore the entire legacy `admins` collection and leave all current accounts unchanged.
|
||||||
|
- Preserve stored secrets omitted from the file, replace supplied secrets, and clear explicitly empty secrets.
|
||||||
|
- Commit through the normal revision path and immediately reload affected services.
|
||||||
|
|
||||||
The browser uploads the selected contents directly. The server never scans the host for a file, and it does not retain, watch, remove, or reuse the uploaded YAML after the database transaction completes.
|
The browser uploads the selected contents directly. The server never scans the host for a file, and it does not retain, watch, remove, or reuse the uploaded YAML after the database transaction completes.
|
||||||
|
|
||||||
@@ -262,9 +289,26 @@ Authorization rules:
|
|||||||
|
|
||||||
Configuration uses one schema-generated typed form rather than a raw YAML or JSON text editor. Repeatable values such as cameras, entities, links, and buttons receive the form library's generic add, remove, and reorder workflow.
|
Configuration uses one schema-generated typed form rather than a raw YAML or JSON text editor. Repeatable values such as cameras, entities, links, and buttons receive the form library's generic add, remove, and reorder workflow.
|
||||||
|
|
||||||
## 6. Implement complete backup and restore
|
## 6. Standardize application restart
|
||||||
|
|
||||||
Everything durable living under one data directory makes the backup boundary simple, but copying live SQLite files and JSON files without coordination would not guarantee a consistent backup. The implementation must create a consistent snapshot before archiving it.
|
Replace the current host reboot operation with one deployment-neutral **Restart application** operation.
|
||||||
|
|
||||||
|
The restart operation must:
|
||||||
|
|
||||||
|
1. Require a lockdown administrator and recent password confirmation.
|
||||||
|
2. Reject a second request while one is already pending.
|
||||||
|
3. Persist an audit event, acknowledge the requester, and notify connected browsers.
|
||||||
|
4. Stop accepting new HTTP connections and send SIGTERM to the Node process after a short acknowledgement delay.
|
||||||
|
5. Reuse the cleanup hooks already owned by MediaMTX, ffmpeg, Kinect, Balance Board, and other child-process services.
|
||||||
|
6. Exit normally and rely on the process supervisor to start the application again.
|
||||||
|
|
||||||
|
During Phase 1, systemd uses `Restart=always`. During Phase 2, the container uses a restart policy such as `unless-stopped`. An explicit operator `systemctl stop` or container stop remains stopped; only a process exit is restarted. The browser shows the announced reconnect state and reloads the active administration snapshot after Socket.IO reconnects.
|
||||||
|
|
||||||
|
Host rebooting is a separate privilege and is not part of this application contract. The server never invokes `systemctl reboot`.
|
||||||
|
|
||||||
|
## 7. Implement complete backup and restore
|
||||||
|
|
||||||
|
Everything durable living under one data directory makes the backup boundary simple. Backup and restore remain together under one `backupRestoreService`; there is no generic maintenance framework and no command-line workflow.
|
||||||
|
|
||||||
### Full backup
|
### Full backup
|
||||||
|
|
||||||
@@ -279,29 +323,25 @@ The primary admin action is **Download full backup**. A full backup includes the
|
|||||||
- Generated and cached files that are part of the current server state
|
- Generated and cached files that are part of the current server state
|
||||||
- A manifest describing the application and schema versions
|
- A manifest describing the application and schema versions
|
||||||
|
|
||||||
The backup service must:
|
The backup operation must:
|
||||||
|
|
||||||
1. Require a lockdown administrator and recent password confirmation.
|
1. Require a lockdown administrator and recent password confirmation.
|
||||||
2. Enter a short maintenance/snapshot state that prevents new persistent mutations.
|
2. Leave every service and writer running.
|
||||||
3. Ask services with buffered state to flush it, stop active audio/replay workers, and clear `runtime/` so FIFOs and incomplete scratch files are never archived.
|
3. Create consistent SQLite snapshots using SQLite's online backup support rather than copying active WAL files.
|
||||||
4. Create consistent SQLite snapshots using SQLite's supported backup/checkpoint facilities rather than copying active WAL files blindly.
|
4. Copy non-database durable files and verify their size and modification time before and after each copy, retrying a file that changed during the copy.
|
||||||
5. Copy non-database durable files into temporary staging.
|
5. Exclude `runtime/`, backup/restore staging, SQLite WAL/SHM files, and incomplete files that never become stable during bounded retries.
|
||||||
6. Produce a manifest containing creation time, application version, schema versions, included paths, sizes, and checksums.
|
6. Produce a manifest containing creation time, application version, schema versions, included paths, sizes, and checksums.
|
||||||
7. Create the archive in temporary storage and stream it to the browser.
|
7. Stream the completed archive to the authorized browser and remove temporary staging afterward.
|
||||||
8. Remove temporary staging whether the operation succeeds or fails.
|
|
||||||
9. Resume normal mutations after the consistent snapshot has been captured; archive compression does not need to hold the server in maintenance mode.
|
|
||||||
|
|
||||||
The downloaded archive contains credentials and integration secrets. The UI must say so clearly. It must not be exposed through a permanent public URL or retained indefinitely inside the data directory.
|
The downloaded archive contains credentials and integration secrets. The UI must say so clearly. It must not be exposed through a permanent public URL or retained indefinitely inside the data directory.
|
||||||
|
|
||||||
`runtime/` is inside the filesystem boundary but is not durable backup content. Excluding it is necessary because an audio FIFO is a live process primitive rather than a regular file, and incomplete uploads or replay builds have no restore value. The backup coordinator must quiesce the owning services before clearing it so exclusion cannot disrupt active work.
|
`runtime/` is inside the filesystem boundary but is not durable backup content. Audio FIFOs, incomplete uploads, and in-progress replay builds have no restore value and are excluded without stopping their owners. The initial implementation provides only the authoritative full backup.
|
||||||
|
|
||||||
An optional smaller **Download settings and state backup** may exclude explicitly regenerable, high-volume snapshots, replay segments, completed replays, and caches. This is secondary; the full backup remains the authoritative complete-server backup.
|
|
||||||
|
|
||||||
### Restore
|
### Restore
|
||||||
|
|
||||||
Restore cannot safely overwrite databases underneath running services. It must be a staged, restart-bound operation.
|
Restore cannot safely overwrite databases underneath running services. It must be a staged, restart-bound operation.
|
||||||
|
|
||||||
The restore service must:
|
The restore operation must:
|
||||||
|
|
||||||
1. Require a lockdown administrator and recent password confirmation.
|
1. Require a lockdown administrator and recent password confirmation.
|
||||||
2. Upload the archive into bounded staging controlled by the data directory.
|
2. Upload the archive into bounded staging controlled by the data directory.
|
||||||
@@ -312,45 +352,14 @@ The restore service must:
|
|||||||
7. Display exactly what will be replaced.
|
7. Display exactly what will be replaced.
|
||||||
8. Require a final explicit confirmation.
|
8. Require a final explicit confirmation.
|
||||||
9. Record a pending-restore marker.
|
9. Record a pending-restore marker.
|
||||||
10. Gracefully stop the application.
|
10. Request the normal application restart.
|
||||||
11. Apply the restore before ordinary services open their databases on the next start.
|
11. Apply the restore before ordinary services open their databases on the next start.
|
||||||
12. Run database migrations against the restored data when necessary.
|
12. Run database migrations against the restored data when necessary.
|
||||||
13. Start the application and verify its health.
|
13. Start the application and verify its health.
|
||||||
|
|
||||||
The startup restore path must preserve a local rollback snapshot until the restored server passes validation. If extraction, migration, or startup validation fails, it must put the prior data back and report the failure. Restore coordination files may live under `data/system/restore`, but they must be excluded from the restored payload where necessary to avoid recursively restoring an in-progress operation.
|
The startup restore path must preserve a local rollback snapshot until the restored server passes validation. If extraction, migration, or startup validation fails, it must put the prior data back and report the failure. Restore coordination files may live under `data/system/restore`, but they must be excluded from the restored payload where necessary to avoid recursively restoring an in-progress operation.
|
||||||
|
|
||||||
Restoring configuration also restores administrator accounts and secrets. The initiating browser may therefore lose authentication after restart; the reconnect UI must explain this and return to login normally.
|
Restoring configuration also restores administrator accounts and secrets. The initiating browser may therefore lose authentication after restart; the reconnect UI must explain this and return to login normally. Backup and restore exist only in the protected admin application.
|
||||||
|
|
||||||
### Command-line recovery
|
|
||||||
|
|
||||||
Backup and restore must also have command-line entry points that use the same implementation as the admin UI. They are needed when the web server cannot start or authentication data is damaged.
|
|
||||||
|
|
||||||
The command-line tools must support:
|
|
||||||
|
|
||||||
- Creating a consistent backup while the server is stopped
|
|
||||||
- Validating a backup without applying it
|
|
||||||
- Restoring while the server is stopped
|
|
||||||
- Printing a concise manifest summary
|
|
||||||
- Refusing unsafe or malformed archives
|
|
||||||
|
|
||||||
The UI and command line must not develop separate archive formats or validation behavior.
|
|
||||||
|
|
||||||
## 7. Standardize graceful application restart
|
|
||||||
|
|
||||||
Replace the current host reboot operation with a deployment-neutral **Restart application** operation.
|
|
||||||
|
|
||||||
The restart coordinator must:
|
|
||||||
|
|
||||||
1. Authorize and acknowledge the request.
|
|
||||||
2. Stop accepting new persistent mutations.
|
|
||||||
3. Flush or close persistent stores.
|
|
||||||
4. Stop MediaMTX, ffmpeg, and native workers.
|
|
||||||
5. Close HTTP and socket listeners within a bounded timeout.
|
|
||||||
6. Exit with the status expected by the current supervisor.
|
|
||||||
|
|
||||||
During Phase 1, systemd restarts the process. During Phase 2, the container restart policy or lifecycle service restarts it. The browser should show a reconnect state and confirm the active configuration revision after reconnecting.
|
|
||||||
|
|
||||||
Host rebooting is a separate privilege and is not part of this application restart contract.
|
|
||||||
|
|
||||||
## 8. Internalize MediaMTX WHEP signaling
|
## 8. Internalize MediaMTX WHEP signaling
|
||||||
|
|
||||||
@@ -398,7 +407,7 @@ Phase 1 is complete only when all of the following are true:
|
|||||||
- Configuration, administrator accounts, and secrets survive restart.
|
- Configuration, administrator accounts, and secrets survive restart.
|
||||||
- The final lockdown administrator cannot be removed accidentally.
|
- The final lockdown administrator cannot be removed accidentally.
|
||||||
- All administrative surfaces are available through `/admin` with server-side authorization.
|
- All administrative surfaces are available through `/admin` with server-side authorization.
|
||||||
- Configuration changes create auditable revisions and apply after restart.
|
- Configuration changes create auditable revisions and apply to the running services without an application restart.
|
||||||
- `/video` works through Node without a special public proxy rule for MediaMTX.
|
- `/video` works through Node without a special public proxy rule for MediaMTX.
|
||||||
- Rover sockets, RTSP publishing, WHEP playback, snapshots, replays, PTZ, Discord, Home Assistant, Kinect, Balance Board, and reporting retain their intended behavior when enabled.
|
- Rover sockets, RTSP publishing, WHEP playback, snapshots, replays, PTZ, Discord, Home Assistant, Kinect, Balance Board, and reporting retain their intended behavior when enabled.
|
||||||
|
|
||||||
@@ -439,6 +448,8 @@ Implemented on 2026-09-14:
|
|||||||
- Redacted secrets from browser responses and audit data. The one complete save operation preserves stored secrets unless the administrator explicitly replaces or clears them.
|
- Redacted secrets from browser responses and audit data. The one complete save operation preserves stored secrets unless the administrator explicitly replaces or clears them.
|
||||||
- Converted every runtime configuration consumer to the synchronous database-backed configuration service and removed the YAML loader, `SERVER_CONFIG`, and the tracked example YAML.
|
- Converted every runtime configuration consumer to the synchronous database-backed configuration service and removed the YAML loader, `SERVER_CONFIG`, and the tracked example YAML.
|
||||||
- Added an explicit one-time YAML upload to `/setup`. Existing bcrypt hashes, lockdown roles, Discord identities, configuration, and secrets can be imported only when the operator selects the file; the installer and startup perform no automatic discovery or migration, and there is no command-line importer.
|
- Added an explicit one-time YAML upload to `/setup`. Existing bcrypt hashes, lockdown roles, Discord identities, configuration, and secrets can be imported only when the operator selects the file; the installer and startup perform no automatic discovery or migration, and there is no command-line importer.
|
||||||
|
- Added the same explicit legacy YAML picker to the protected Configuration page for replacing an initialized server's configuration. It requires recent lockdown-password confirmation, ignores every YAML administrator entry, filters nonexistent settings, validates current fields, preserves omitted secrets, applies explicitly supplied or empty secrets, uses optimistic revision checking, records the selected filename in audit history, and reloads affected services immediately.
|
||||||
|
- The one-time setup upload now passes its committed configuration through the same live-application coordinator, so a fresh installation does not need an immediate restart after importing YAML.
|
||||||
- Made setup-file import recursively retain only fields present in the current schema. Stale keys from the permissive YAML era are ignored without aliases or historical translations, while invalid values for real current settings still fail validation; stream-only and snapshot-only room-camera entries remain accepted as they were by the runtime.
|
- Made setup-file import recursively retain only fields present in the current schema. Stale keys from the permissive YAML era are ignored without aliases or historical translations, while invalid values for real current settings still fail validation; stream-only and snapshot-only room-camera entries remain accepted as they were by the runtime.
|
||||||
- Added safe empty-data startup, a file-backed one-time setup code, the restricted `/setup` route, and a console administrator-recovery command. The credential persists at `data/setup-code.txt` across restarts with `0600` permissions, never appears in logs, and is deleted when setup completes.
|
- Added safe empty-data startup, a file-backed one-time setup code, the restricted `/setup` route, and a console administrator-recovery command. The credential persists at `data/setup-code.txt` across restarts with `0600` permissions, never appears in logs, and is deleted when setup completes.
|
||||||
- Added the centralized `/admin` route with Overview, Fleet operations, Users and administrators, and one schema-generated hierarchical Configuration page in legacy YAML order.
|
- Added the centralized `/admin` route with Overview, Fleet operations, Users and administrators, and one schema-generated hierarchical Configuration page in legacy YAML order.
|
||||||
@@ -449,20 +460,40 @@ Implemented on 2026-09-14:
|
|||||||
- Restored the former example YAML's installation-specific values as both schema-owned input examples and the actual initial values for non-secret settings and collection shapes. The only intentionally empty defaults are the three credentials and active driver HTML; their placeholders still explain the expected input without falsely marking credentials as configured or publishing sample content.
|
- Restored the former example YAML's installation-specific values as both schema-owned input examples and the actual initial values for non-secret settings and collection shapes. The only intentionally empty defaults are the three credentials and active driver HTML; their placeholders still explain the expected input without falsely marking credentials as configured or publishing sample content.
|
||||||
- Strengthened top-level hierarchy with a 1.5-rem sibling gap while retaining compact spacing within each configuration section.
|
- Strengthened top-level hierarchy with a 1.5-rem sibling gap while retaining compact spacing within each configuration section.
|
||||||
- Extended `CardFrame` with an optional explicit accent while preserving its assigned-rover default, then gave every configuration nesting level its own complete header-and-border accent. Nested CardFrames themselves now carry the YAML-like indentation, scalar contents remain aligned with their owning card, and descriptions use a larger, higher-contrast treatment.
|
- Extended `CardFrame` with an optional explicit accent while preserving its assigned-rover default, then gave every configuration nesting level its own complete header-and-border accent. Nested CardFrames themselves now carry the YAML-like indentation, scalar contents remain aligned with their owning card, and descriptions use a larger, higher-contrast treatment.
|
||||||
|
- Added an opt-in sticky-header behavior to the shared `CardFrame`. Top-level configuration titles use it beneath the independently sticky action toolbar while nested titles remain in normal flow to prevent overlap, and scalar key labels are now visually stronger than their descriptions.
|
||||||
- Traced all 156 schema nodes to their runtime consumers and added operator-facing descriptions for every root, section, collection, array item, and scalar option. A recursive configuration test now rejects any future schema node without a description; currently reserved settings explicitly state that they have no runtime effect.
|
- Traced all 156 schema nodes to their runtime consumers and added operator-facing descriptions for every root, section, collection, array item, and scalar option. A recursive configuration test now rejects any future schema node without a description; currently reserved settings explicitly state that they have no runtime effect.
|
||||||
- Converged feature control into service-owned configuration: each public feature opts in beside its own schema, and the configuration system derives those exact `enabled` switches for sessions and command discovery. The former server feature registry was removed; configuration completeness and hardware availability remain visible as runtime status instead of becoming hidden enablement rules.
|
- Converged feature control into service-owned configuration: each public feature opts in beside its own schema, and the configuration system derives those exact `enabled` switches for sessions and command discovery. The former server feature registry was removed; configuration completeness and hardware availability remain visible as runtime status instead of becoming hidden enablement rules.
|
||||||
- Lazy-loaded setup and administration so the schema-form dependency is not included in ordinary driver-page downloads.
|
- Lazy-loaded setup and administration so the schema-form dependency is not included in ordinary driver-page downloads.
|
||||||
- Reused the existing fleet and identity administration surfaces, added password reconfirmation for sensitive operations, and prevented removal or demotion of the final lockdown administrator.
|
- Reused the existing fleet and identity administration surfaces, added password reconfirmation for sensitive operations, and prevented removal or demotion of the final lockdown administrator.
|
||||||
- Added configuration revision history, rollback, audit history, and restart-required reporting. Graceful restart itself remains step 7.
|
- Added configuration revision history, rollback, audit history, and immediate application reporting.
|
||||||
|
- Added a serialized live-configuration coordinator and converted configurable service runtimes to apply changed sections without restarting Node. Passive policies read the current immutable snapshot; network, hardware, timer, and child-process services replace or retune their owned runtime while stable HTTP/socket handlers continue delegating to it. The admin editor reports any service-specific reload failure after the revision is safely committed.
|
||||||
|
- Replaced the privileged host-reboot action with one lockdown-only, recently confirmed, audited application restart on the admin Overview. Node announces the restart, stops accepting new HTTP connections, and signals itself after acknowledging the browser; the existing service signal hooks clean up owned child processes, and systemd now restarts clean application exits without making `systemctl stop` ineffective.
|
||||||
|
- Added one protected backup-and-restore service and admin page. Backups keep the application online, use SQLite's online snapshot API for all three databases, make verified stable copies of the remaining durable files, and produce a checksummed archive through a short-lived one-use download. Restore uploads are size-limited, reject unsafe archive entries, verify the complete manifest, checksums, SQLite integrity, and supported schema versions, then remain staged until explicit recent-password confirmation.
|
||||||
|
- Restore now uses the normal application restart rather than stopping services itself. The earliest server startup swaps the validated replacement into the data directory, retains one rollback copy, and removes that copy only after the restored application reaches a stabilization point; an interrupted or failed first startup automatically puts the previous data back on the following start. Backup/restore control files and all staging remain inside `data/backup-restore`.
|
||||||
|
- Fixed production WAL-mode snapshots creating unmanifested SQLite `-wal` and `-shm` files during schema inspection. Backup and restore validation now remove only those temporary staged sidecars before archiving or applying data, and the regression fixture uses WAL mode to match the real databases.
|
||||||
|
- Added the early streaming `/video` middleware with `http-proxy-middleware`. Express removes the public prefix before forwarding WHEP/WHIP requests to `127.0.0.1:8889`, while root-relative MediaMTX session locations receive the prefix again so subsequent browser `PATCH` and `DELETE` requests follow the same path. MediaMTX signaling now binds to loopback; its ICE UDP/TCP listener remains directly reachable on port 8189.
|
||||||
|
- Replaced Discord's `siteUrl`, the inter-instance profile's `publicUrl`, and media `whepBaseUrl` with one top-level `publicUrl`. A numbered internal database migration transforms every saved configuration revision before current validation, and the media section now contains only optional additional ICE hosts. WHEP and microphone WHIP URLs are fixed relative paths, so they work through the current origin without knowing its hostname.
|
||||||
|
- Discord command authorization and lockdown moderation recipients now read the live administrator registry, so setup imports and later Discord-ID or role edits take effect without restarting the server.
|
||||||
|
- Full-data restore now leaves `runtime/` untouched, matching its existing exclusion from backup archives and preventing the non-root application from trying to remove lifecycle-controller state owned by the root controller container.
|
||||||
|
- The Users and administrators tab now requests at most 100 lightweight identity summaries through one bounded SQLite query. Search and moderation filters run on the server, while complete signals, permissions, and feature state load only after selecting a user, preventing large identity databases from blocking Socket.IO heartbeats or freezing the browser.
|
||||||
|
- Removed the remaining server-local SRT hops after Fedora's newer libSRT rejected the zero-payload ACKACK packets emitted by MediaMTX's GoSRT implementation on every acknowledgement cycle. PTZ publishing, replay capture, and snapshot capture now share the existing RTSP/TCP listener, SRT is disabled, and browser-session authorization is bypassed only for loopback readers and rover `-fwd` speaker feeds.
|
||||||
|
- Fixed inter-instance public payload generation to read feature flags and social links from the same live configuration revision. Social links enabled through the new configuration system no longer trigger an undefined legacy-config reference and an HTTP 500 response.
|
||||||
|
|
||||||
Local verification completed:
|
Local verification completed:
|
||||||
|
|
||||||
- All 107 server tests passed, including populated legacy-style default coverage, complete schema-description and input-example coverage, file-backed setup-code lifecycle and symlink rejection, service-definition-derived feature projection, schema-derived secret paths, configuration defaults and strict validation, full-document revision conflicts, secret preservation, administrator invariants, explicit setup-file import with recursive removal of nonexistent fields, and the earlier filesystem coverage.
|
- All 119 server tests passed, including populated legacy-style default coverage, complete schema-description and input-example coverage, file-backed setup-code lifecycle and symlink rejection, service-definition-derived feature projection, schema-derived secret paths, configuration defaults and strict validation, full-document revision conflicts, secret preservation, administrator invariants, setup and initialized-server YAML import safety, recursive removal of nonexistent fields, inter-instance payload generation with social links enabled, and the earlier filesystem coverage.
|
||||||
|
- All 27 server test files passed after live application, backup/restore, the internal media proxy, and the inter-instance regression coverage were added. The media tests stream exact SDP and trickle-ICE bodies through `POST`, `PATCH`, and `DELETE`, preserve headers, verify prefix and session-location rewriting, confirm loopback-only signaling, and derive the public ICE hostname from the canonical URL. The database migration and production-style WAL backup/restore paths are also covered. Application restart was not signaled on the development machine.
|
||||||
- Focused admin, route, and identity UI lint passed.
|
- Focused admin, route, and identity UI lint passed.
|
||||||
- All 20 existing focused web UI tests passed.
|
- All 20 existing focused web UI tests passed.
|
||||||
- The production web UI build completed successfully and regenerated the checked-in server assets.
|
- The production web UI build completed successfully and regenerated the checked-in server assets.
|
||||||
- Installer syntax and repository whitespace checks passed.
|
- Installer syntax and repository whitespace checks passed.
|
||||||
- A local startup smoke test reached listener initialization. MediaMTX then exited because `/usr/local/bin/mediamtx` is intentionally absent on this development machine; actual enabled integrations and media remain deployment checks for the real server.
|
- A local startup smoke test reached listener initialization. MediaMTX then exited because `/usr/local/bin/mediamtx` is intentionally absent on this development machine; actual enabled integrations and media remain deployment checks for the real server.
|
||||||
|
- A second empty-data startup smoke test loaded every reloadable service and reached the HTTP listener without listener-limit warnings. A deliberately substituted failing MediaMTX executable then ended the process as expected; enabled hardware and external integrations still require verification on the actual server.
|
||||||
|
|
||||||
|
Testing-server verification completed:
|
||||||
|
|
||||||
|
- A full backup created from the running application successfully validated and restored through the admin UI after the WAL-sidecar fix.
|
||||||
|
- WHEP video playback works when the testing server is published through an ordinary whole-application reverse proxy. No special `/video` upstream, prefix rewrite, buffering rule, or direct public MediaMTX signaling route is present, confirming that Node now owns the complete public signaling path.
|
||||||
|
|
||||||
# Phase 2: containerization and image delivery
|
# Phase 2: containerization and image delivery
|
||||||
|
|
||||||
@@ -488,7 +519,7 @@ Use a Fedora-based multi-stage build to remain close to the dependencies already
|
|||||||
|
|
||||||
- Build the Kinect worker against libfreenect/libusb.
|
- Build the Kinect worker against libfreenect/libusb.
|
||||||
- Build the Balance Board worker against wiiuse/BlueZ.
|
- Build the Balance Board worker against wiiuse/BlueZ.
|
||||||
- Build for the target image architecture rather than copying checked-in workstation binaries.
|
- Build for `linux/amd64` rather than copying checked-in workstation binaries.
|
||||||
|
|
||||||
### Packaged runtime tools
|
### Packaged runtime tools
|
||||||
|
|
||||||
@@ -512,19 +543,39 @@ The final image should:
|
|||||||
- Use a minimal init process to reap child processes.
|
- Use a minimal init process to reap child processes.
|
||||||
- Treat `/data` as its only persistent writable location.
|
- Treat `/data` as its only persistent writable location.
|
||||||
- Use `/tmp` only for disposable work.
|
- Use `/tmp` only for disposable work.
|
||||||
- Include release version and commit metadata.
|
- Include ordinary OCI source metadata linking the image to this repository, without introducing an application version number.
|
||||||
- Handle `SIGTERM` through the Phase 1 graceful shutdown coordinator.
|
- Handle `SIGTERM` through the Phase 1 graceful shutdown coordinator.
|
||||||
|
|
||||||
|
### Production image implementation notes
|
||||||
|
|
||||||
|
Implemented and locally verified on 2026-09-15:
|
||||||
|
|
||||||
|
- Added one root multi-stage `Dockerfile` that builds the Vite application, locked production Node dependencies, Kinect worker, and Balance Board worker, then copies only their runtime outputs into a Fedora 43 image.
|
||||||
|
- Downloaded pinned amd64 MediaMTX 1.15.3, Neolink 0.6.2, and ChromeOS Google TTS 26.5 artifacts during the build and rejected downloads that did not match their recorded SHA-256 checksums.
|
||||||
|
- Installed the media, TTS, USB, Bluetooth, and native-worker runtime libraries without Fedora weak dependencies. This avoids pulling unrelated desktop recommendations into the headless image while retaining the libraries explicitly required by the current server installer.
|
||||||
|
- Added a root `.dockerignore` so local dependencies, mutable server data, generated public assets, compiled host workers, logs, and Git metadata cannot leak into the image build context.
|
||||||
|
- Configured `/data` as `SERVER_DATA_DIR`, ran Node as the dedicated uid 1000 `multirover` user, retained only the Balance Board worker's required capabilities, and used `tini` as the container init process.
|
||||||
|
- Successfully built and loaded `multiroombarover:local` for `linux/amd64`. Its registry-style compressed content size is approximately 828 MB; Docker reports approximately 2.87 GB of local unpacked disk usage because the complete GStreamer, ffmpeg, Kinect, Node, and offline TTS runtime is intentionally included.
|
||||||
|
- Confirmed at build time that Chrome TTS loads its packaged voice model and produces a nonempty WAV file.
|
||||||
|
- Replaced Fedora's restricted `ffmpeg-free` package with RPM Fusion Free's complete `ffmpeg` package after development-container testing exposed that `ffmpeg-free` omits the `libx264` encoder required by rover replay capture, room-camera replay rendering, replay sidebars, and final replay assembly.
|
||||||
|
- Started the image with host networking and a temporary SELinux-relabeled `/data` bind mount. The application reached its HTTP listener, generated first-run state only inside the mount, and started the packaged MediaMTX with its generated configuration under `/data`.
|
||||||
|
- Confirmed `/`, `/setup`, and `/admin` return the production UI; `/video/` reaches the loopback MediaMTX proxy; MediaMTX and Neolink execute; both native workers link against the runtime image; and the Balance Board worker retains only `cap_net_admin` and `cap_net_bind_service`.
|
||||||
|
- Restarted the same container and confirmed the setup credential and configuration database were byte-for-byte unchanged, then confirmed `/admin` returned successfully again.
|
||||||
|
- Stopped and removed the smoke-test container and deleted its temporary data. No test server process was left running on the development machine.
|
||||||
|
|
||||||
## 11. Compose deployment
|
## 11. Compose deployment
|
||||||
|
|
||||||
The host-visible installation should be only:
|
The host-visible project installation should be only:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
multirover/
|
multirover/
|
||||||
├── compose.yaml
|
└── compose.yaml
|
||||||
└── data/
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Docker owns the separately persisted `multirover-data` volume. Operators move
|
||||||
|
or inspect its complete contents through the administration backup/restore UI
|
||||||
|
rather than coordinating host filesystem ownership with the container user.
|
||||||
|
|
||||||
The Compose project contains:
|
The Compose project contains:
|
||||||
|
|
||||||
- The main Multirover application container
|
- The main Multirover application container
|
||||||
@@ -533,7 +584,7 @@ The Compose project contains:
|
|||||||
The application mounts:
|
The application mounts:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
./data:/data
|
data:/data
|
||||||
```
|
```
|
||||||
|
|
||||||
Host networking is the initial preferred design because it most closely preserves current rover RTSP, WebRTC ICE, UDP media, camera, and LAN integration behavior. The exact listeners must be audited before finalizing the Compose file.
|
Host networking is the initial preferred design because it most closely preserves current rover RTSP, WebRTC ICE, UDP media, camera, and LAN integration behavior. The exact listeners must be audited before finalizing the Compose file.
|
||||||
@@ -544,7 +595,17 @@ Expected externally relevant listeners are:
|
|||||||
- Rover RTSP publishing on TCP 8554
|
- Rover RTSP publishing on TCP 8554
|
||||||
- WebRTC media on TCP and UDP 8189
|
- WebRTC media on TCP and UDP 8189
|
||||||
|
|
||||||
MediaMTX WHEP on 8889, API/metrics listeners, and server-local SRT should stay on loopback unless an identified remote consumer requires otherwise.
|
MediaMTX WHEP on 8889 and API/metrics listeners should stay on loopback unless an identified remote consumer requires otherwise. Publishers and server-local replay/snapshot readers use the single RTSP/TCP listener on 8554; SRT is disabled.
|
||||||
|
|
||||||
|
### Compose implementation notes
|
||||||
|
|
||||||
|
Implemented and locally verified on 2026-09-15:
|
||||||
|
|
||||||
|
- Added one root `compose.yaml` containing only the main application. It uses `ghcr.io/legop3/multiroombarover:latest`, host networking, `restart: unless-stopped`, and the single `data:/data` persistent named-volume mount. The lifecycle service remains a later, separate step rather than a placeholder in the initial deployment.
|
||||||
|
- Added both possible local data directories to `.dockerignore`, alongside the legacy `server/data`, so credentials, databases, recordings, backups, and generated state cannot enter later image builds even during development or manual inspection.
|
||||||
|
- Started the exact Compose definition from an empty Docker-managed volume using the locally built image tagged with the final GHCR name. The application created its configuration database, setup credential, and generated MediaMTX configuration only under that volume.
|
||||||
|
- Confirmed the production UI responds on `/`, `/setup`, and `/admin`. A request to `/video/` reached the internal MediaMTX proxy and received MediaMTX's expected not-found response because the empty configuration had no requested stream.
|
||||||
|
- Restarted through Compose and confirmed the setup credential and configuration database remained byte-for-byte unchanged. A separate marker created through `/data` also remained present after restart.
|
||||||
|
|
||||||
## 12. Hardware access with minimal host setup
|
## 12. Hardware access with minimal host setup
|
||||||
|
|
||||||
@@ -565,6 +626,15 @@ Balance Board requirements:
|
|||||||
|
|
||||||
The exact capabilities and device permissions must be proven on the real server hardware. This development machine is not the actual server and cannot complete that validation.
|
The exact capabilities and device permissions must be proven on the real server hardware. This development machine is not the actual server and cannot complete that validation.
|
||||||
|
|
||||||
|
### Hardware-access implementation notes
|
||||||
|
|
||||||
|
Implemented and locally verified as far as this development host permits on 2026-09-15:
|
||||||
|
|
||||||
|
- Added the BlueZ command-line package to the runtime image because the Balance Board service commissions devices through `bluetoothctl`; the rebuilt image reports BlueZ 5.87.
|
||||||
|
- Exposed `/dev/bus/usb` so reconnecting Kinect devices do not depend on a temporary bus/device number, and granted only `NET_ADMIN` for the Balance Board worker rather than using privileged mode.
|
||||||
|
- Mounted only the host system D-Bus socket for BlueZ access. Docker's per-container SELinux label is disabled because Fedora blocks access to the shared host socket and USB device nodes otherwise, while relabeling the system socket would affect the host; the process remains non-root and Docker's namespace, capability, and seccomp isolation remain active.
|
||||||
|
- Confirmed the container can open the mounted system D-Bus socket and that its native Balance Board worker retains only its existing file capabilities. The development host's Bluetooth daemon is inactive and no production Kinect or Balance Board is attached, so real discovery, reconnect, and streaming remain part of the actual-server validation.
|
||||||
|
|
||||||
The host should not need Node, npm, MediaMTX, ffmpeg, neolink, application source, or a Multirover systemd unit after cutover.
|
The host should not need Node, npm, MediaMTX, ffmpeg, neolink, application source, or a Multirover systemd unit after cutover.
|
||||||
|
|
||||||
## 13. Health checks
|
## 13. Health checks
|
||||||
@@ -581,6 +651,14 @@ Optional remote integrations should report degraded status to administrators wit
|
|||||||
|
|
||||||
Compose should use the health endpoint and a restart policy suitable for unattended operation.
|
Compose should use the health endpoint and a restart policy suitable for unattended operation.
|
||||||
|
|
||||||
|
### Health-check implementation notes
|
||||||
|
|
||||||
|
Implemented on 2026-09-15:
|
||||||
|
|
||||||
|
- Added an unauthenticated `GET /health` readiness endpoint that exposes only two non-sensitive booleans: whether the application user can read and write the configured data directory and whether MediaMTX answers through its loopback-only metrics listener.
|
||||||
|
- Treated successful route execution as proof that Node is accepting HTTP and that configuration initialization completed. This avoids repeatedly querying every SQLite database or turning optional integrations and currently offline media sources into container restart conditions.
|
||||||
|
- Added the image-level Docker health check using Node's built-in `fetch`, so Compose receives the readiness state without installing another command-line probe utility.
|
||||||
|
|
||||||
## 14. Restricted lifecycle container
|
## 14. Restricted lifecycle container
|
||||||
|
|
||||||
The main web application must not mount the Docker socket. Docker socket access is effectively host-root access.
|
The main web application must not mount the Docker socket. Docker socket access is effectively host-root access.
|
||||||
@@ -592,15 +670,15 @@ A small lifecycle container should be the only component with Docker control. It
|
|||||||
- Operate only on the fixed Multirover application service.
|
- Operate only on the fixed Multirover application service.
|
||||||
- Reject arbitrary command lines, service names, image names, and Compose arguments.
|
- Reject arbitrary command lines, service names, image names, and Compose arguments.
|
||||||
- Persist update job state so it survives replacement of the application container.
|
- Persist update job state so it survives replacement of the application container.
|
||||||
- Report current version and image digest.
|
- Compare the running image's internal digest with the current `latest` digest.
|
||||||
- Pull the configured release image.
|
- Pull the fixed `ghcr.io/legop3/multiroombarover:latest` image.
|
||||||
- Restart or recreate the application container.
|
- Restart or recreate the application container.
|
||||||
- Wait for the application health check.
|
- Wait for the application health check.
|
||||||
- Retain and restore the previous image when the replacement fails.
|
- Retain and restore the previous image when the replacement fails.
|
||||||
|
|
||||||
The `/admin` System section should expose:
|
The `/admin` System section should expose:
|
||||||
|
|
||||||
- Current version and image digest
|
- Whether the running application is current or an update is available
|
||||||
- Check for update
|
- Check for update
|
||||||
- Update and restart
|
- Update and restart
|
||||||
- Restart application
|
- Restart application
|
||||||
@@ -610,21 +688,43 @@ The `/admin` System section should expose:
|
|||||||
|
|
||||||
These operations require a lockdown administrator and recent password confirmation. The browser must expect its socket to disappear, show a reconnect state, and retrieve the persistent job result after the new application becomes healthy.
|
These operations require a lockdown administrator and recent password confirmation. The browser must expect its socket to disappear, show a reconnect state, and retrieve the persistent job result after the new application becomes healthy.
|
||||||
|
|
||||||
The Compose contract should remain stable so ordinary application releases replace only the application image. Updating the lifecycle component or changing host mounts/capabilities is a separate, rarer deployment-format update and must not be disguised as an ordinary application update.
|
The Compose contract should remain stable so ordinary main-branch image updates replace only the application image. Updating the lifecycle component or changing host mounts/capabilities is a separate, rarer deployment-format update and must not be disguised as an ordinary application update.
|
||||||
|
|
||||||
## 15. GHCR release automation
|
### Lifecycle-controller implementation notes
|
||||||
|
|
||||||
|
Implemented on 2026-09-15:
|
||||||
|
|
||||||
|
- Reused the single published application image for the lifecycle service with a controller-only command. This avoids a second Dockerfile, image name, GHCR workflow, and release lifecycle while the two containers still run separate processes with separate privileges.
|
||||||
|
- Mounted `/var/run/docker.sock` only in the network-disabled lifecycle container. The application communicates through a dedicated Unix-socket volume and cannot submit an image name, container name, command, or Docker option; the controller operates only on the fixed `multirover` container and the deployment-selected MultiRover image.
|
||||||
|
- Added fixed status, update-check, restart, and update operations. Update checks pull the configured moving image and compare Docker image IDs. Updates retain the previous image ID, recreate the application with its existing Compose host contract, wait for the image health check, and restore the previous image when replacement health fails.
|
||||||
|
- Persisted the current operation and result in the private lifecycle Unix-socket volume. This survives ordinary application replacement and browser reconnection without mounting the root lifecycle controller into the application's `/data` volume, leaving all application runtime paths owned by the non-root server.
|
||||||
|
- Connected the existing lockdown-administrator password confirmation and audit history to the lifecycle operations. The Administration overview polls persisted progress, reports update and rollback results, and keeps the legacy process-level restart only when no controller socket exists.
|
||||||
|
- Accepted self-updates, administrator restarts, and backup-restore restarts share a helper that sets the persistent admin reason to "server is restarting" and removes every current rover driver with the same notice. This does not change server mode or automatically clear the reason after startup.
|
||||||
|
- Defined the deployment image once through a Compose YAML anchor. Both services and the controller target reuse that exact value, so production stays on `ghcr.io/legop3/multiroombarover:latest` and development requires changing only the single visible selector line to a branch tag.
|
||||||
|
|
||||||
|
## 15. GHCR publishing automation
|
||||||
|
|
||||||
Add repository automation that:
|
Add repository automation that:
|
||||||
|
|
||||||
- Builds the production image from a clean checkout.
|
- On pull requests, runs all required verification and proves that the production image builds without publishing it.
|
||||||
- Runs server tests, focused web UI tests/lint, and the production web build before publishing.
|
- On each repository branch push, builds the production image from a clean checkout.
|
||||||
- Builds each explicitly supported server architecture.
|
- Uses the production Dockerfile as the single verification path. Its locked dependency installs, web UI production build, native worker builds, external-artifact checksum checks, and TTS smoke test must all pass before publication.
|
||||||
- Publishes immutable commit/release tags to GHCR.
|
- Builds the supported `linux/amd64` image without QEMU or a multi-architecture manifest.
|
||||||
- Publishes one documented stable channel used by the lifecycle updater.
|
- Publishes `ghcr.io/legop3/multiroombarover:latest` from main and one sanitized branch-name tag from every other repository branch; there are no numbered, commit, stable, edge, or release tags.
|
||||||
- Records image digests and source revision metadata.
|
- Leaves the previously published image for that branch untouched when any required verification or build step fails.
|
||||||
- Avoids publishing when required verification fails.
|
- Uses registry-generated digests only inside the lifecycle implementation for update comparison and rollback.
|
||||||
|
|
||||||
The deployed server pulls a prebuilt image. It does not run `git pull`, `npm install`, native compilation, or web UI compilation.
|
The deployed server pulls the prebuilt `latest` image. It does not run `git pull`, `npm install`, native compilation, or web UI compilation.
|
||||||
|
|
||||||
|
### GHCR automation implementation notes
|
||||||
|
|
||||||
|
Implemented on 2026-09-15:
|
||||||
|
|
||||||
|
- Added one `Container image` GitHub Actions workflow. Pull requests build the complete production Dockerfile without logging in or publishing. Main-branch pushes publish `ghcr.io/legop3/multiroombarover:latest`, while every other repository branch publishes one moving image using its sanitized branch name.
|
||||||
|
- Used GitHub's repository-scoped token with only contents-read and packages-write permissions. No separate registry secret, release process, version calculation, QEMU setup, or custom tag-generation code is required.
|
||||||
|
- Kept one Buildx job for all event types so pull-request verification, development branches, and main-branch publication cannot drift into different image recipes. Docker's maintained metadata action owns branch-name sanitization, and GitHub Actions layer caching avoids repeatedly downloading and rebuilding the image's large pinned media and TTS dependencies.
|
||||||
|
- Removed the legacy package-lock ignore rules and added the server lockfile required by `npm ci` to the migration change set. Local Docker builds and clean GitHub checkouts now receive the same locked server and web UI dependency inputs instead of allowing an ignored workstation file to mask a missing build input.
|
||||||
|
- The workflow file was parsed locally and its event, permission, architecture, tag-selection, and conditional-publish contract were checked. The first actual GHCR publication necessarily remains a GitHub-hosted verification after these changes are pushed.
|
||||||
|
|
||||||
## 16. Container cutover
|
## 16. Container cutover
|
||||||
|
|
||||||
@@ -633,7 +733,7 @@ The actual deployment migration should:
|
|||||||
1. Download and validate a full Phase 1 backup.
|
1. Download and validate a full Phase 1 backup.
|
||||||
2. Stop and disable the legacy Multirover systemd service.
|
2. Stop and disable the legacy Multirover systemd service.
|
||||||
3. Ensure no legacy MediaMTX service remains active.
|
3. Ensure no legacy MediaMTX service remains active.
|
||||||
4. Place the Compose file beside the existing data directory or move that directory once while the service is stopped.
|
4. Place the Compose file on the host; Docker creates the named data volume on first start.
|
||||||
5. Start the application and lifecycle containers.
|
5. Start the application and lifecycle containers.
|
||||||
6. Confirm that database migrations complete.
|
6. Confirm that database migrations complete.
|
||||||
7. Confirm the active configuration revision and administrator access.
|
7. Confirm the active configuration revision and administrator access.
|
||||||
@@ -648,16 +748,16 @@ The old systemd application and the Compose application must never run concurren
|
|||||||
|
|
||||||
Containerization is complete when:
|
Containerization is complete when:
|
||||||
|
|
||||||
- A new host can start from one Compose file and an empty data directory.
|
- A new host can start from one Compose file and an automatically created empty data volume.
|
||||||
- Existing state can be restored from a Phase 1 full backup.
|
- Existing state can be restored from a Phase 1 full backup.
|
||||||
- `./data:/data` is the only persistent application mount.
|
- `data:/data` is the only persistent application mount.
|
||||||
- Replacing the application container preserves all state.
|
- Replacing the application container preserves all state.
|
||||||
- The special external `/video` MediaMTX route is unnecessary.
|
- The special external `/video` MediaMTX route is unnecessary.
|
||||||
- The main container has no Docker socket access and is not fully privileged.
|
- The main container has no Docker socket access and is not fully privileged.
|
||||||
- Admin-triggered restart works.
|
- Admin-triggered restart works.
|
||||||
- Admin-triggered update works and persists progress across reconnection.
|
- Admin-triggered update works and persists progress across reconnection.
|
||||||
- A failed image health check rolls back to the prior image.
|
- A failed image health check rolls back to the prior image.
|
||||||
- GHCR images are reproducibly built from repository releases.
|
- The GHCR `latest` image is reproducibly built from the newest successful main-branch commit.
|
||||||
- Kinect and Balance Board behavior has been verified on the actual host.
|
- Kinect and Balance Board behavior has been verified on the actual host.
|
||||||
- Node, npm, application source, and media binaries are no longer installed directly on the host.
|
- Node, npm, application source, and media binaries are no longer installed directly on the host.
|
||||||
|
|
||||||
@@ -672,14 +772,15 @@ Within the two hard phase boundaries, the safest order is:
|
|||||||
- [x] Converge optional feature control into service-owned `enabled` switches and derive the public feature map from those definitions.
|
- [x] Converge optional feature control into service-owned `enabled` switches and derive the public feature map from those definitions.
|
||||||
- [x] Build the centralized admin configuration UI.
|
- [x] Build the centralized admin configuration UI.
|
||||||
- [x] Add persistent audit history.
|
- [x] Add persistent audit history.
|
||||||
- [ ] Implement coordinated backup and staged restore.
|
- [x] Apply every configuration revision to running services without restarting the application.
|
||||||
- [ ] Standardize graceful application restart.
|
- [x] Standardize graceful application restart.
|
||||||
- [ ] Add the internal `/video` proxy and remove the special external route.
|
- [x] Implement online backup and restart-bound staged restore in one service.
|
||||||
- [ ] Run the full Phase 1 completion gate on the legacy deployment.
|
- [x] Add the internal `/video` proxy and make the special external route unnecessary.
|
||||||
- [ ] Build and verify the production application image.
|
- [x] Run the full Phase 1 completion gate on the legacy deployment.
|
||||||
- [ ] Add Compose, data mounting, networking, and hardware access.
|
- [x] Build and verify the production application image.
|
||||||
- [ ] Add GHCR build and publication automation.
|
- [x] Add Compose, data mounting, networking, and hardware access.
|
||||||
- [ ] Add the restricted lifecycle container and connect the System UI.
|
- [x] Add GHCR build and publication automation.
|
||||||
|
- [x] Add the restricted lifecycle container and connect the System UI.
|
||||||
- [ ] Test update, rollback, backup restore, and hardware on the actual server.
|
- [ ] Test update, rollback, backup restore, and hardware on the actual server.
|
||||||
- [ ] Perform the final systemd-to-Compose cutover.
|
- [ ] Perform the final systemd-to-Compose cutover.
|
||||||
|
|
||||||
|
|||||||
Generated
+56
@@ -0,0 +1,56 @@
|
|||||||
|
{
|
||||||
|
"name": "perf",
|
||||||
|
"lockfileVersion": 3,
|
||||||
|
"requires": true,
|
||||||
|
"packages": {
|
||||||
|
"": {
|
||||||
|
"dependencies": {
|
||||||
|
"playwright": "^1.60.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/fsevents": {
|
||||||
|
"version": "2.3.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz",
|
||||||
|
"integrity": "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==",
|
||||||
|
"hasInstallScript": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"optional": true,
|
||||||
|
"os": [
|
||||||
|
"darwin"
|
||||||
|
],
|
||||||
|
"engines": {
|
||||||
|
"node": "^8.16.0 || ^10.6.0 || >=11.0.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/playwright": {
|
||||||
|
"version": "1.60.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/playwright/-/playwright-1.60.0.tgz",
|
||||||
|
"integrity": "sha512-hheHdokM8cdqCb0lcE3s+zT4t4W+vvjpGxsZlDnikarzx8tSzMebh3UiFtgqwFwnTnjYQcsyMF8ei2mCO/tpeA==",
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"dependencies": {
|
||||||
|
"playwright-core": "1.60.0"
|
||||||
|
},
|
||||||
|
"bin": {
|
||||||
|
"playwright": "cli.js"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18"
|
||||||
|
},
|
||||||
|
"optionalDependencies": {
|
||||||
|
"fsevents": "2.3.2"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/playwright-core": {
|
||||||
|
"version": "1.60.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.60.0.tgz",
|
||||||
|
"integrity": "sha512-9bW6zvX/m0lEbgTKJ6YppOKx8H3VOPBMOCFh2irXFOT4BbHgrx5hPjwJYLT40Lu+4qtD36qKc/Hn56StUW57IA==",
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"bin": {
|
||||||
|
"playwright-core": "cli.js"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,214 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Finite, CPU-only rover policy compute benchmark. No rover/server connections.
|
||||||
|
|
||||||
|
Run from the repo root on Linux:
|
||||||
|
python3 -m venv ~/.venvs/rover-bench
|
||||||
|
~/.venvs/rover-bench/bin/pip install torch --index-url https://download.pytorch.org/whl/cpu
|
||||||
|
~/.venvs/rover-bench/bin/python perf/rover-model-benchmark.py
|
||||||
|
|
||||||
|
Quick run:
|
||||||
|
.../python perf/rover-model-benchmark.py --threads 4 --rovers 1 --seconds 2
|
||||||
|
|
||||||
|
Random inputs/weights measure compute cost ONLY, not learned driving ability.
|
||||||
|
This is a representative architecture, not a selected production policy.
|
||||||
|
Video decoding, network delay, dataset I/O, and simultaneous training/inference
|
||||||
|
are excluded. No packages are installed automatically and no files are written.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import json
|
||||||
|
import math
|
||||||
|
import os
|
||||||
|
import platform
|
||||||
|
import resource
|
||||||
|
import statistics
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
import time
|
||||||
|
|
||||||
|
|
||||||
|
def positive_int(value):
|
||||||
|
number = int(value)
|
||||||
|
if number < 1:
|
||||||
|
raise argparse.ArgumentTypeError("must be positive")
|
||||||
|
return number
|
||||||
|
|
||||||
|
|
||||||
|
def positive_seconds(value):
|
||||||
|
number = float(value)
|
||||||
|
if not math.isfinite(number) or number <= 0:
|
||||||
|
raise argparse.ArgumentTypeError("must be finite and positive")
|
||||||
|
return number
|
||||||
|
|
||||||
|
|
||||||
|
def arguments():
|
||||||
|
parser = argparse.ArgumentParser(description=__doc__,
|
||||||
|
formatter_class=argparse.RawDescriptionHelpFormatter)
|
||||||
|
parser.add_argument("--threads", type=positive_int, nargs="+", default=[4, 8, 16])
|
||||||
|
parser.add_argument("--rovers", type=positive_int, nargs="+", default=[1, 2, 4])
|
||||||
|
parser.add_argument("--seconds", type=positive_seconds, default=10,
|
||||||
|
help="minimum measured seconds per case (default: 10)")
|
||||||
|
parser.add_argument("--frames", type=positive_int, default=4)
|
||||||
|
parser.add_argument("--height", type=positive_int, default=120)
|
||||||
|
parser.add_argument("--width", type=positive_int, default=160)
|
||||||
|
parser.add_argument("--batch-size", type=positive_int, default=16,
|
||||||
|
help="training batch size")
|
||||||
|
parser.add_argument("--hz", type=positive_int, default=10,
|
||||||
|
help="target decision frequency per rover")
|
||||||
|
parser.add_argument("--worker", choices=["inference", "training"],
|
||||||
|
help=argparse.SUPPRESS)
|
||||||
|
return parser.parse_args()
|
||||||
|
|
||||||
|
|
||||||
|
def worker(args):
|
||||||
|
import torch
|
||||||
|
from torch import nn
|
||||||
|
|
||||||
|
torch.set_num_threads(args.threads[0])
|
||||||
|
torch.set_num_interop_threads(1)
|
||||||
|
torch.manual_seed(42)
|
||||||
|
|
||||||
|
class Policy(nn.Module):
|
||||||
|
def __init__(self):
|
||||||
|
super().__init__()
|
||||||
|
# Preserve coarse spatial layout: global pooling alone would discard
|
||||||
|
# information about which side of the image contains an obstacle.
|
||||||
|
self.vision = nn.Sequential(
|
||||||
|
nn.Conv2d(3, 24, 5, stride=2, padding=2), nn.ReLU(),
|
||||||
|
nn.Conv2d(24, 48, 3, stride=2, padding=1), nn.ReLU(),
|
||||||
|
nn.Conv2d(48, 96, 3, stride=2, padding=1), nn.ReLU(),
|
||||||
|
nn.Conv2d(96, 128, 3, stride=2, padding=1), nn.ReLU(),
|
||||||
|
nn.AdaptiveAvgPool2d((3, 4)), nn.Flatten(),
|
||||||
|
nn.Linear(128 * 3 * 4, 128), nn.ReLU(),
|
||||||
|
)
|
||||||
|
# 32 sensor values + 32 previous-control/state values per frame.
|
||||||
|
self.history = nn.GRU(128 + 64, 128, batch_first=True)
|
||||||
|
self.continuous = nn.Linear(128, 8)
|
||||||
|
self.buttons = nn.Linear(128, 16)
|
||||||
|
|
||||||
|
def forward(self, images, state):
|
||||||
|
batch, frames, channels, height, width = images.shape
|
||||||
|
features = self.vision(images.reshape(-1, channels, height, width))
|
||||||
|
features = features.reshape(batch, frames, -1)
|
||||||
|
history, _ = self.history(torch.cat((features, state), dim=-1))
|
||||||
|
last = history[:, -1]
|
||||||
|
return self.continuous(last).tanh(), self.buttons(last)
|
||||||
|
|
||||||
|
model = Policy().cpu().float()
|
||||||
|
training = args.worker == "training"
|
||||||
|
model.train(training)
|
||||||
|
batch = args.batch_size if training else args.rovers[0]
|
||||||
|
# Keep several independent windows in RAM. Allocation/random generation is
|
||||||
|
# outside timing; full frame-history encoding IS included on every decision.
|
||||||
|
windows = [(
|
||||||
|
torch.rand(batch, args.frames, 3, args.height, args.width),
|
||||||
|
torch.rand(batch, args.frames, 64),
|
||||||
|
) for _ in range(4)]
|
||||||
|
targets = (torch.rand(batch, 8) * 2 - 1, torch.randint(0, 2, (batch, 16)).float())
|
||||||
|
optimizer = torch.optim.AdamW(model.parameters(), lr=1e-4) if training else None
|
||||||
|
|
||||||
|
def step(index):
|
||||||
|
if training:
|
||||||
|
optimizer.zero_grad(set_to_none=True)
|
||||||
|
continuous, buttons = model(*windows[index % len(windows)])
|
||||||
|
if training:
|
||||||
|
loss = (nn.functional.mse_loss(continuous, targets[0])
|
||||||
|
+ nn.functional.binary_cross_entropy_with_logits(buttons, targets[1]))
|
||||||
|
loss.backward()
|
||||||
|
optimizer.step()
|
||||||
|
|
||||||
|
context = torch.enable_grad if training else torch.inference_mode
|
||||||
|
with context():
|
||||||
|
for index in range(5):
|
||||||
|
step(index)
|
||||||
|
timings = []
|
||||||
|
cpu_start = time.process_time()
|
||||||
|
start = time.perf_counter()
|
||||||
|
# CPU execution is synchronous, so these durations include completion.
|
||||||
|
while time.perf_counter() - start < args.seconds or len(timings) < 10:
|
||||||
|
before = time.perf_counter()
|
||||||
|
step(len(timings))
|
||||||
|
timings.append(time.perf_counter() - before)
|
||||||
|
elapsed = time.perf_counter() - start
|
||||||
|
cpu_elapsed = time.process_time() - cpu_start
|
||||||
|
|
||||||
|
ordered = sorted(timings)
|
||||||
|
print(json.dumps({
|
||||||
|
"mode": args.worker, "threads": args.threads[0], "batch": batch,
|
||||||
|
"parameters": sum(p.numel() for p in model.parameters()),
|
||||||
|
"torch": torch.__version__, "iterations": len(timings),
|
||||||
|
"p50_ms": statistics.median(timings) * 1000,
|
||||||
|
"p95_ms": ordered[math.ceil(len(ordered) * .95) - 1] * 1000,
|
||||||
|
"max_ms": max(timings) * 1000,
|
||||||
|
"steps_s": len(timings) / elapsed,
|
||||||
|
"examples_s": len(timings) * batch / elapsed,
|
||||||
|
"cpu_cores": cpu_elapsed / elapsed,
|
||||||
|
"peak_mib": resource.getrusage(resource.RUSAGE_SELF).ru_maxrss / 1024,
|
||||||
|
}))
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
args = arguments()
|
||||||
|
if args.worker:
|
||||||
|
worker(args)
|
||||||
|
return
|
||||||
|
try:
|
||||||
|
import torch
|
||||||
|
except ImportError:
|
||||||
|
sys.exit("PyTorch is required. Run the three setup/run commands shown by --help.")
|
||||||
|
|
||||||
|
print(f"CPU-only FP32 | {platform.platform()} | Python {platform.python_version()}"
|
||||||
|
f" | PyTorch {torch.__version__}", flush=True)
|
||||||
|
print(f"Logical CPUs: {os.cpu_count()} | initial load averages: {os.getloadavg()}")
|
||||||
|
print(f"Input: {args.frames} RGB frames at {args.width}x{args.height},"
|
||||||
|
" 32 sensors + 32 controls/state per frame")
|
||||||
|
print("Output: 8 continuous controls + 16 button logits (placeholder dimensions)")
|
||||||
|
print("Synthetic in-memory data; full history re-encoded each decision.")
|
||||||
|
print("Excludes video decode/network/dataset I/O and concurrent training/inference.")
|
||||||
|
print("Each case has 5 warmups, then at least 10 iterations and the requested duration.")
|
||||||
|
print("CPU cores = process CPU seconds / wall seconds; peak MiB includes runtime/data.")
|
||||||
|
print("Multi-rover inference batches one independent history per rover per step.\n")
|
||||||
|
print("mode threads batch p50 ms p95 ms max ms steps/s examples/s CPU cores peak MiB", flush=True)
|
||||||
|
results = []
|
||||||
|
for mode in ("inference", "training"):
|
||||||
|
batches = args.rovers if mode == "inference" else [args.batch_size]
|
||||||
|
for threads in args.threads:
|
||||||
|
for batch in batches:
|
||||||
|
# Fresh processes isolate thread pools and peak memory per case.
|
||||||
|
command = [sys.executable, os.path.abspath(__file__), "--worker", mode,
|
||||||
|
"--threads", str(threads), "--rovers", str(batch),
|
||||||
|
"--batch-size", str(args.batch_size), "--seconds", str(args.seconds),
|
||||||
|
"--frames", str(args.frames), "--height", str(args.height),
|
||||||
|
"--width", str(args.width)]
|
||||||
|
process = subprocess.run(command, capture_output=True, text=True)
|
||||||
|
if process.returncode:
|
||||||
|
print(process.stderr, file=sys.stderr)
|
||||||
|
sys.exit(f"Failed: {mode}, threads={threads}, batch={batch}"
|
||||||
|
" (if killed for memory use, reduce --batch-size or --rovers).")
|
||||||
|
result = json.loads(process.stdout)
|
||||||
|
results.append(result)
|
||||||
|
print(f"{mode:10} {threads:7} {batch:5}"
|
||||||
|
f" {result['p50_ms']:7.1f} {result['p95_ms']:7.1f}"
|
||||||
|
f" {result['max_ms']:7.1f} {result['steps_s']:8.2f}"
|
||||||
|
f" {result['examples_s']:10.2f} {result['cpu_cores']:9.2f}"
|
||||||
|
f" {result['peak_mib']:8.0f}", flush=True)
|
||||||
|
|
||||||
|
print(f"\nModel parameters: {results[0]['parameters']:,}")
|
||||||
|
print(f"At {args.hz} Hz, each rover batch must finish every {1000 / args.hz:.1f} ms;")
|
||||||
|
print("p95 needs headroom for the excluded pipeline. This is not a deployment pass/fail.")
|
||||||
|
fastest = max((r for r in results if r['mode'] == 'training'), key=lambda r: r['examples_s'])
|
||||||
|
examples = 3600 * args.hz
|
||||||
|
minutes = examples / fastest['examples_s'] / 60
|
||||||
|
print(f"Best measured training: {fastest['examples_s']:.1f} windows/s at"
|
||||||
|
f" {fastest['threads']} threads.")
|
||||||
|
print(f"One pass over one rover-hour sampled at {args.hz} Hz ({examples:,} windows):"
|
||||||
|
f" about {minutes:.1f} compute-only minutes.")
|
||||||
|
print("Multiply by dataset hours and training passes; this does not predict convergence.")
|
||||||
|
print("Paste this complete output, along with the command/options used.")
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
try:
|
||||||
|
main()
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
sys.exit("\nBenchmark interrupted.")
|
||||||
@@ -0,0 +1,788 @@
|
|||||||
|
# Rover learning service implementation tracker
|
||||||
|
|
||||||
|
## Resume here
|
||||||
|
|
||||||
|
Latest change: one ongoing learner, gated Latest/Previous checkpoints, and
|
||||||
|
admin-created permanent snapshots replace automatic permanent publications.
|
||||||
|
|
||||||
|
Status: policy format 2 now predicts continuous wheel speeds plus accessory events.
|
||||||
|
Copyable diagnostics and main-card wheel/action displays with a session threshold
|
||||||
|
slider are implemented. Older model files remain stored but cannot run in this format.
|
||||||
|
Recording, bounded dataset/training, permanent named models, live inference,
|
||||||
|
checked autonomous command submission, and the verified VIP card are coded.
|
||||||
|
Human commands do not stop or pause autonomy (explicit latest user requirement).
|
||||||
|
Focused local checks passed; actual recording/training, live autonomous behavior,
|
||||||
|
concurrent server performance, and browser appearance remain unverified.
|
||||||
|
The standalone CPU benchmark was run successfully on the actual server.
|
||||||
|
|
||||||
|
This document preserves the conversation's decisions across compactions and
|
||||||
|
usage cutoffs. Keep the checklist and handoff section current during authorized
|
||||||
|
implementation. Do not treat proposals or open questions as user decisions.
|
||||||
|
|
||||||
|
The user explicitly authorized feature implementation with: "okay cool. begin
|
||||||
|
implementation, use the md to track. IPI". Continue the agreed implementation
|
||||||
|
without requesting IPI again. Follow the current
|
||||||
|
AGENTS.md instructions: targeted investigation, minimal edits, no new tests unless
|
||||||
|
requested, proportional direct verification, and no development processes left
|
||||||
|
running. This development machine is not the actual rover server.
|
||||||
|
|
||||||
|
The user declined the manual server checklist and explicitly asked to continue.
|
||||||
|
Do not block further work or repeatedly ask them to do it. Preserve the unverified
|
||||||
|
status and have the reader reject unusable recordings automatically.
|
||||||
|
|
||||||
|
Latest increment: internal card gating, dock lead-in/tail capture, live prediction
|
||||||
|
diagnostics, ongoing retained-data sampling, and gated model publication are coded.
|
||||||
|
See the final handoff section for settings and the new training lineage.
|
||||||
|
|
||||||
|
Next work: verify the integrated feature against actual recordings and the real
|
||||||
|
camera/rover pipeline when that environment is available; inspect the VIP card in
|
||||||
|
the running browser. Do not invent successful driving results or block further
|
||||||
|
implementation on the previously declined manual checklist.
|
||||||
|
|
||||||
|
## Intended product
|
||||||
|
|
||||||
|
Learn from ordinary human rover use, then let a user select a saved model and
|
||||||
|
press Start to have it roam and operate the rover's controls. No destination or
|
||||||
|
structured route is required. Users should not need dedicated demonstration
|
||||||
|
sessions before collection becomes useful. Build the complete collection and
|
||||||
|
training pipeline; do not reduce the intended product to a single-route demo.
|
||||||
|
|
||||||
|
Chat is out of scope. The user explicitly dropped it to keep the model compact.
|
||||||
|
This is a learned control policy, not a language model generating instructions.
|
||||||
|
|
||||||
|
Learning useful behavior is an experimental objective, not a guaranteed result
|
||||||
|
of accumulating recordings. Autonomous performance must be observed; low training
|
||||||
|
loss or fast inference alone does not establish competent driving.
|
||||||
|
|
||||||
|
## Agreed requirements
|
||||||
|
|
||||||
|
- One self-contained server service, provisionally `roverLearningService`.
|
||||||
|
- Minimal integration elsewhere: configuration/startup, command recording hook,
|
||||||
|
checked command submission hook, and the necessary UI connection.
|
||||||
|
- The service owns its video recorder processes. Do not move this feature into
|
||||||
|
replay, rover management, turn management, or unrelated services.
|
||||||
|
- Configuration defaults to disabled. Disabled means no active feature runtime.
|
||||||
|
- Record every rover control input, video, and all available rover sensors.
|
||||||
|
- Model inputs use recent control history/current state, useful sensors, and
|
||||||
|
video. Model outputs can use the rover's supported operating controls, not just
|
||||||
|
wheel speeds. Available hardware/control capabilities must be accounted for.
|
||||||
|
- Record broadly; choosing training features must not discard raw source data
|
||||||
|
prematurely within the configured retention window.
|
||||||
|
- Retain a reasonable bounded rolling training dataset, with ongoing background
|
||||||
|
training. The model architecture/parameter count remains bounded as it learns.
|
||||||
|
- Periodically publish immutable named model versions. Two random words plus a
|
||||||
|
unique identifier/sequence is the proposed naming scheme.
|
||||||
|
- Keep every published model permanently. No automatic model pruning.
|
||||||
|
- Users can choose which compatible model controls their rover.
|
||||||
|
- Add the UI card at the top of the VIP tab, using the existing verified-feature
|
||||||
|
mechanism. The card is absent when the feature is disabled.
|
||||||
|
- Model control must use the same permissions and eligibility rules as manual
|
||||||
|
rover control. Verified feature access does not grant rover control.
|
||||||
|
- Favorites are client-side saved model IDs only. No server favorite/pin state,
|
||||||
|
endpoints, or retention behavior tied to favorites.
|
||||||
|
- All server information needed to populate the card arrives in one coherent
|
||||||
|
state object. Action commands remain separate from that state object.
|
||||||
|
|
||||||
|
Earlier suggestions to prune old model versions or retain only server-pinned
|
||||||
|
favorites are superseded. Rolling retention applies to training data, not the
|
||||||
|
published model catalog.
|
||||||
|
|
||||||
|
## Architecture and containment
|
||||||
|
|
||||||
|
Proposed internal ownership (not a requirement to scaffold empty directories):
|
||||||
|
|
||||||
|
```text
|
||||||
|
server/src/services/roverLearningService/
|
||||||
|
configuration.js Schema/defaults; no runtime side effects
|
||||||
|
index.js Small enable/disable lifecycle entry point
|
||||||
|
runtime.js Enabled runtime coordination
|
||||||
|
recording/ Commands, sensors, video processes, synchronization
|
||||||
|
dataset/ Rolling storage, training sampling, retention
|
||||||
|
training/ Training scheduling and checkpoint production
|
||||||
|
models/ Permanent catalog, names, metadata, publication
|
||||||
|
driving/ Inference sessions and action scheduling
|
||||||
|
workers/ Python model/training implementation
|
||||||
|
socketGateway.js Full card state and authorized user actions
|
||||||
|
```
|
||||||
|
|
||||||
|
Persistent video, datasets, checkpoints, and catalog metadata belong under the
|
||||||
|
application's existing data-path convention, not the service source directory.
|
||||||
|
The agreed root is `<data>/rover-learning/`, normally `/data/rover-learning/` in
|
||||||
|
the deployed container (`SERVER_DATA_DIR`), or `server/data/rover-learning/` with
|
||||||
|
the default development path. Intended layout:
|
||||||
|
|
||||||
|
```text
|
||||||
|
rover-learning/
|
||||||
|
recordings/ Rolling video/events/session metadata (implemented)
|
||||||
|
models/ Permanent UUID directories: weights.pt and model.json
|
||||||
|
training/ resume-v3.pt, schedule-v3.json, and current job.json
|
||||||
|
```
|
||||||
|
|
||||||
|
Training/model directories are created only when service and training are enabled.
|
||||||
|
Session/model manifests and a small scheduling ledger are sufficient at present;
|
||||||
|
the previously proposed catalog.sqlite is not needed or created.
|
||||||
|
Python compute and video processing must not block the Node event loop. Worker
|
||||||
|
dependencies, deployment packaging, and process shutdown must be included in the
|
||||||
|
implementation plan; installing Python packages at server startup is not assumed.
|
||||||
|
|
||||||
|
The outside command system should know only about optional observation and
|
||||||
|
checked submission. It should know nothing about model architecture, datasets,
|
||||||
|
training, model names, or video recorders.
|
||||||
|
|
||||||
|
### Existing integration findings (recheck before edits)
|
||||||
|
|
||||||
|
- `server/index.js` explicitly loads services.
|
||||||
|
- `server/src/configuration/definition.js` assembles service-owned configuration
|
||||||
|
fragments. `configuration/index.js` provides live reload handlers.
|
||||||
|
- `server/src/services/commandService/index.js` exports `issueCommand()` and
|
||||||
|
`commandEvents`. Existing `observation` events intentionally omit payloads;
|
||||||
|
they are analytics events and insufficient as training examples.
|
||||||
|
- `issueCommand()` is a low-level send function. Many authorization, turn,
|
||||||
|
cooldown, private-drive safety, and overcurrent checks occur in the browser
|
||||||
|
command handler before calling it. Direct autonomous calls must not bypass
|
||||||
|
those checks.
|
||||||
|
- `roverManager.managerEvents` already emits decoded `sensor` events and rover
|
||||||
|
lifecycle events. The sensor event is not necessarily every raw telemetry field;
|
||||||
|
inventory what is available before claiming complete sensor capture.
|
||||||
|
- `fleetReportService` demonstrates subscriptions and configuration lifecycle,
|
||||||
|
but its persistent storage/lifecycle is not automatically the desired disabled
|
||||||
|
behavior for this new service.
|
||||||
|
- `replayEngineV2` demonstrates FFmpeg capture and RTSP/TCP source handling. Reuse
|
||||||
|
applicable media conventions without making this feature depend on replay
|
||||||
|
being enabled or sharing replay's retention ownership.
|
||||||
|
|
||||||
|
### Command recording
|
||||||
|
|
||||||
|
Proposed optional observation contract includes timestamp, rover, operator/source,
|
||||||
|
requested command payload, dispatched payload, outcome, and command ID where
|
||||||
|
available. Requested and dispatched values can differ due to safety processing.
|
||||||
|
Distinguish dispatched/acknowledged commands from measured physical execution.
|
||||||
|
|
||||||
|
Record human, autonomous, and service-generated commands with distinct provenance.
|
||||||
|
Autonomous predictions are not automatically correct human training labels.
|
||||||
|
Include rejected/ignored outcomes where relevant; do not present them as executed
|
||||||
|
actions. Inventory control paths outside the common browser command handler so
|
||||||
|
camera/accessory controls are not silently omitted.
|
||||||
|
|
||||||
|
The hook only enqueues bounded work. Recording failures or disk pressure must not
|
||||||
|
block/fail manual command delivery. Preserve the existing payload-free analytics
|
||||||
|
event contract instead of putting detailed recordings into general logging.
|
||||||
|
Requested payload snapshots must precede any in-place command transformation.
|
||||||
|
|
||||||
|
### Checked command sending and ownership
|
||||||
|
|
||||||
|
Proposed implementation: extract a reusable checked submission path from the
|
||||||
|
current browser command handler, preserving existing manual behavior. Autonomy
|
||||||
|
submits on behalf of its initiating user's actual control context. Do not invent
|
||||||
|
an admin identity or send directly to the rover WebSocket.
|
||||||
|
|
||||||
|
Recheck permissions server-side for actions and continued control. Losing the
|
||||||
|
turn/assignment/connection or otherwise losing eligibility stops the autonomous
|
||||||
|
session. A safe stop must still be possible after ordinary permission is revoked.
|
||||||
|
Explicit user decision: incoming human commands do not stop or pause autonomy.
|
||||||
|
Both pass through the existing checked command path; subsequent model commands
|
||||||
|
can replace human commands. Stop remains explicit, with permission/disconnect,
|
||||||
|
stale input, and worker failure stops. Model-influenced sessions are excluded
|
||||||
|
from human demonstration recording, including manual inputs during autonomy.
|
||||||
|
|
||||||
|
Model actions describe operating controls, not arbitrary server maintenance.
|
||||||
|
Inventory reboot/update/raw commands and capability restrictions explicitly rather
|
||||||
|
than allowing unrestricted command dictionaries from model outputs.
|
||||||
|
|
||||||
|
### Disabled lifecycle
|
||||||
|
|
||||||
|
Only configuration metadata and a small lifecycle handler remain registered while
|
||||||
|
disabled, to support live enablement. Lazy-load runtime modules on enable.
|
||||||
|
|
||||||
|
When disabled there are no feature recording subscriptions, command observers,
|
||||||
|
video/Python workers, runtime timers, dataset scans, open feature databases,
|
||||||
|
created directories, inference/training, or feature socket handlers. The existing
|
||||||
|
config/feature mechanism hides the card without starting this runtime.
|
||||||
|
|
||||||
|
On disable: stop autonomous motion, detach observers, stop and await owned child
|
||||||
|
processes, flush/close storage appropriately, remove socket handlers/timers, and
|
||||||
|
release runtime state. Preserve all saved data/models. Serialize enable/disable
|
||||||
|
transitions so overlapping reloads cannot leave duplicate workers or listeners.
|
||||||
|
|
||||||
|
## Data and model design
|
||||||
|
|
||||||
|
The benchmark architecture is a representative workload, not a selected final
|
||||||
|
policy. It uses four RGB frames at 160x120, 32 sensor and 32 control/state values
|
||||||
|
per frame, a spatial CNN and GRU, eight continuous outputs, and sixteen button
|
||||||
|
logits. These counts are placeholders, not the actual rover control schema.
|
||||||
|
|
||||||
|
- Past controls/current state are inputs; the human's next action is a training
|
||||||
|
target. Avoid future-action leakage into model input.
|
||||||
|
- Maintain temporal coherence. Independent guesses can hesitate or oscillate;
|
||||||
|
multiple human intentions must not simply average into meaningless controls.
|
||||||
|
- Continuous controls and discrete button/toggle events require different output
|
||||||
|
semantics. Do not retrigger a one-shot action every inference tick.
|
||||||
|
- Include camera pose/state when available, and supported control capabilities.
|
||||||
|
- Preserve synchronized timestamps and sequence boundaries. Server receive time
|
||||||
|
does not prove which frame the remote driver saw. Exact displayed-frame timing
|
||||||
|
may need a small frontend timing hook; that is not yet designed or authorized as
|
||||||
|
a settled integration requirement.
|
||||||
|
- Human takeovers/corrections are valuable demonstrations. Do not indiscriminately
|
||||||
|
discard playful behavior: the goal includes human-like unstructured roaming.
|
||||||
|
- An action timeout/stale-video stop and existing hardware safety remain outside
|
||||||
|
the model's learned decision-making.
|
||||||
|
|
||||||
|
Training proposal: shuffle windows from retained sessions, including recent and
|
||||||
|
older examples. Publish after a configured amount of training work, potentially
|
||||||
|
with a minimum elapsed interval. Steps/examples are less ambiguous than epochs
|
||||||
|
over a continuously changing dataset. Continue training independently of active
|
||||||
|
inference; published models are immutable and do not change beneath a session.
|
||||||
|
|
||||||
|
Background work should be resource-limited and lower priority. Pausing after
|
||||||
|
sufficient reuse of unchanged data is proposed; continuous repeated passes are
|
||||||
|
not automatically useful. A small reserve of older valuable sessions was suggested
|
||||||
|
to reduce forgetting but is not a settled retention requirement.
|
||||||
|
|
||||||
|
Training readers must not lose files mid-batch to retention. Publish checkpoints
|
||||||
|
atomically so clients cannot select partially written models. Store sufficient
|
||||||
|
architecture, feature/action schema, normalization, and training metadata to load
|
||||||
|
each permanent model correctly or report it as incompatible.
|
||||||
|
|
||||||
|
## Model catalog and UI mechanics
|
||||||
|
|
||||||
|
Proposed model names: `curious-otter-0042`, `amber-finch-0043`. Names are display
|
||||||
|
labels; stable unique IDs are used for selection and local favorites. Record
|
||||||
|
creation time, architecture/schema identity, training progress, and dataset
|
||||||
|
provenance/summary. Never assume a newer model is better.
|
||||||
|
|
||||||
|
Card scope: model selection with local favorites, Start/Stop, current session
|
||||||
|
status, and compact training status. Reuse current VIP appearance and existing
|
||||||
|
settings persistence rather than inventing a new storage layer. UI implementation
|
||||||
|
locations have not been inspected yet.
|
||||||
|
|
||||||
|
Illustrative single state object (not a finalized protocol):
|
||||||
|
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
available: true,
|
||||||
|
roverId,
|
||||||
|
control: { canStart, canStop, reason },
|
||||||
|
session: { status, modelId, startedBy, startedAt },
|
||||||
|
models: [{ id, name, createdAt, trainingSteps, compatible }],
|
||||||
|
training: { status, examplesProcessed, latestModelId }
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Derive per-user permissions on the server and recheck on execution. State updates
|
||||||
|
should be coherent and event-driven/coalesced, not broadcast at camera frequency.
|
||||||
|
The permanent catalog can grow; avoid blocking command handling while assembling
|
||||||
|
or delivering card state. Any future pagination must preserve the user's single
|
||||||
|
card-state contract rather than silently introducing independent UI data feeds.
|
||||||
|
|
||||||
|
Selection semantics proposed earlier: stop before switching an active model,
|
||||||
|
reset temporal state, and resume only explicitly. Confirm exact behavior as part
|
||||||
|
of UI design. Client favorites do not affect server retention or permissions.
|
||||||
|
|
||||||
|
## Hardware and measured feasibility
|
||||||
|
|
||||||
|
Actual server: Fedora 43, two Xeon E5-2620 v4 processors, 16 physical cores / 32
|
||||||
|
threads, AVX2, about 125 GiB RAM with 118 GiB available in the initial sample.
|
||||||
|
The server only runs the rover server. Approximately 80% CPU idle was measured
|
||||||
|
under normal working load, not on an otherwise idle test machine.
|
||||||
|
|
||||||
|
The relevant benchmark is the custom vision/control workload, not the earlier
|
||||||
|
Qwen text benchmark. Server run: Python 3.14.7, PyTorch 2.14.0+cpu, FP32,
|
||||||
|
488,008 parameters, four RGB frames at 160x120. Training batch size 16.
|
||||||
|
|
||||||
|
| Mode | Threads | Rover/training batch | p50 ms | p95 ms | Max ms | Examples/s | CPU cores used | Peak MiB |
|
||||||
|
|---|---:|---:|---:|---:|---:|---:|---:|---:|
|
||||||
|
| Inference | 4 | 1 | 5.8 | 8.0 | 16.5 | 165.43 | 3.97 | 321 |
|
||||||
|
| Inference | 4 | 2 | 10.4 | 13.6 | 24.1 | 187.39 | 3.96 | 334 |
|
||||||
|
| Inference | 4 | 4 | 18.7 | 25.1 | 34.1 | 207.08 | 3.96 | 357 |
|
||||||
|
| Inference | 8 | 1 | 4.4 | 5.9 | 12.9 | 219.98 | 7.95 | 318 |
|
||||||
|
| Inference | 8 | 2 | 7.5 | 9.2 | 13.2 | 272.28 | 7.95 | 330 |
|
||||||
|
| Inference | 8 | 4 | 15.3 | 17.5 | 26.0 | 263.88 | 7.81 | 359 |
|
||||||
|
| Inference | 16 | 1 | 4.9 | 7.3 | 23.1 | 191.94 | 15.77 | 318 |
|
||||||
|
| Inference | 16 | 2 | 7.5 | 10.9 | 21.0 | 257.54 | 15.76 | 333 |
|
||||||
|
| Inference | 16 | 4 | 11.6 | 17.9 | 33.6 | 319.84 | 14.98 | 359 |
|
||||||
|
| Training | 4 | 16 | 210.7 | 227.4 | 245.5 | 75.36 | 3.79 | 655 |
|
||||||
|
| Training | 8 | 16 | 141.2 | 172.8 | 176.5 | 108.57 | 7.09 | 673 |
|
||||||
|
| Training | 16 | 16 | 121.6 | 228.9 | 263.4 | 112.37 | 13.29 | 669 |
|
||||||
|
|
||||||
|
Inference latency is per entire batch, not per rover within it. CPU measurements
|
||||||
|
are saturation runs, not paced 10 Hz operation. Eight threads is a promising
|
||||||
|
starting point, not a finalized resource allocation. At 10 Hz there are 36,000
|
||||||
|
training windows per recorded rover-hour; one pass takes about 5.5 compute-only
|
||||||
|
minutes at eight threads. Dataset hours and repeat passes multiply that cost.
|
||||||
|
|
||||||
|
Limits: synthetic data/random weights, no decoding/resizing/network/dataset I/O,
|
||||||
|
no concurrent inference and training, and no measured autonomous driving quality.
|
||||||
|
The target of 10 decisions/second is provisional. A larger model or higher image
|
||||||
|
resolution requires renewed measurement. These results do not mandate a GPU.
|
||||||
|
|
||||||
|
Approximate storage for this architecture: 1.9 MiB FP32 inference weights; 5.6 MiB
|
||||||
|
for weights plus Adam optimizer state, before metadata/serialization overhead.
|
||||||
|
One hundred inference versions are about 186 MiB. Dataset video dominates storage.
|
||||||
|
Published inference artifacts and resumable training state need not be identical.
|
||||||
|
|
||||||
|
## Open implementation decisions
|
||||||
|
|
||||||
|
- Exact operating-control catalog, continuous/event action encoding, capability
|
||||||
|
masking, selected sensors, model architecture/history, and update rate.
|
||||||
|
- Dataset disk budget, segment format, sampling strategy, session quality markers,
|
||||||
|
and whether to retain a reserved historical subset.
|
||||||
|
- Time alignment between video observed by the driver and command generation.
|
||||||
|
- Python packaging, IPC, process supervision, CPU limits, and worker failure policy.
|
||||||
|
- Checkpoint cadence/names, resume-state retention, evaluation metadata, and how
|
||||||
|
new versions become selectable. Do not add an unrequested admin approval flow.
|
||||||
|
- Exact ownership/takeover behavior, disconnect/turn-loss handling, model switch
|
||||||
|
behavior, and which user may stop an active session under existing permissions.
|
||||||
|
- Card fields and existing client persistence mechanism; current UI paths still
|
||||||
|
need targeted inspection.
|
||||||
|
|
||||||
|
## Implementation checklist
|
||||||
|
|
||||||
|
- [x] Discuss scope: autonomous roaming, full rover controls, no chat.
|
||||||
|
- [x] Add standalone CPU benchmark and verify its execution locally.
|
||||||
|
- [x] Obtain and interpret results from the actual server.
|
||||||
|
- [x] Record containment, default-disabled behavior, VIP placement, permissions,
|
||||||
|
permanent model retention, client favorites, and single card-state requirement.
|
||||||
|
- [x] Obtain IPI for feature implementation.
|
||||||
|
- [ ] Inspect remaining UI/control paths and settle concrete contracts.
|
||||||
|
- [x] Add service-owned config and dormant lifecycle integration.
|
||||||
|
- [x] Add optional detailed command observer and shared checked submission path.
|
||||||
|
- [ ] Implement timestamped recording, video worker ownership, and bounded dataset.
|
||||||
|
Code is implemented for common commands, raw/decoded rover sensor frames,
|
||||||
|
host stats, and existing rover state events. Live video/timing/retention
|
||||||
|
verification and full control-path inventory remain; do not mark complete yet.
|
||||||
|
- [x] Implement feature/action encoding and training worker with resource limits.
|
||||||
|
Runtime import/dependency checks passed; training on actual recordings is still
|
||||||
|
unverified. The current schema limits and next inference work are described below.
|
||||||
|
- [x] Implement atomic checkpoint publication and permanent model catalog.
|
||||||
|
Code complete; no actual-data published checkpoint has been produced locally.
|
||||||
|
- [x] Implement model inference, ownership, explicit stops, and worker cleanup.
|
||||||
|
Human input does not stop autonomy; live execution remains unverified.
|
||||||
|
- [x] Implement service socket gateway with complete per-user card state.
|
||||||
|
- [x] Implement verified VIP card at top, model selection, local favorites, controls,
|
||||||
|
and expandable diagnostics. Browser appearance remains unverified.
|
||||||
|
- [ ] Verify disabled startup and enable/disable cleanup directly.
|
||||||
|
- [ ] Verify manual-control behavior remains intact and autonomous permission loss
|
||||||
|
stops motion using an appropriate authorized runtime.
|
||||||
|
- [ ] Measure real video pipeline and concurrent training/inference on the server.
|
||||||
|
- [ ] Evaluate autonomous behavior with supervised rover runs before claiming
|
||||||
|
useful driving performance.
|
||||||
|
|
||||||
|
Verification must follow user policy: no new/expanded tests unless explicitly
|
||||||
|
requested; use existing small relevant checks or actual affected runtime. Do not
|
||||||
|
automatically run full suites/builds. Hardware/server checks must be handed to
|
||||||
|
the user when the development environment cannot perform them.
|
||||||
|
|
||||||
|
## Handoff log
|
||||||
|
|
||||||
|
### First implementation increment
|
||||||
|
|
||||||
|
Implemented files:
|
||||||
|
|
||||||
|
- `server/src/services/roverLearningService/configuration.js`: default disabled;
|
||||||
|
recording budget 20 GiB, minimum free space 2 GiB, session duration 300 seconds.
|
||||||
|
These are initial implementation defaults, adjustable in the existing admin
|
||||||
|
configuration editor, not measured final production sizing.
|
||||||
|
- `server/src/services/roverLearningService/index.js`: serialized lifecycle bridge;
|
||||||
|
lazy runtime require; no recording side effects while disabled.
|
||||||
|
- `server/src/services/roverLearningService/runtime.js`: enabled-only subscriptions,
|
||||||
|
recorder ownership, bounded startup/rotation event buffering, retention scheduling,
|
||||||
|
disconnect/rotation handling, and signal/disable cleanup.
|
||||||
|
- `server/src/services/roverLearningService/recording.js`: per-session metadata,
|
||||||
|
bounded NDJSON output, and FFmpeg RTSP/TCP video packet copy into Matroska.
|
||||||
|
No camera re-encoding, Python process, training, or autonomous commands yet.
|
||||||
|
- `server/src/services/roverLearningService/storage.js`: oldest-first recording
|
||||||
|
retention, free-space enforcement, and interrupted-session recovery.
|
||||||
|
- `server/src/services/commandService/recording.js`: optional failure-isolated
|
||||||
|
request/dispatch/result/ack observer with payload snapshots and IDs. Source is
|
||||||
|
`client` or `server`; browser automation is not falsely classified as proven
|
||||||
|
intentional human action. Async safety timers do not retain client attribution.
|
||||||
|
|
||||||
|
External changes are limited to startup, configuration definition, command-hook
|
||||||
|
wiring, and adding the new feature to an existing configuration test's expected
|
||||||
|
feature list (required by the feature addition). No new tests were created.
|
||||||
|
Raw sensor capture reads `lastSensor.raw` during the existing synchronous sensor
|
||||||
|
event; rover manager/sensor pipeline did not need modification.
|
||||||
|
|
||||||
|
Recording format:
|
||||||
|
|
||||||
|
```text
|
||||||
|
recordings/<unix-ms>-<uuid>/
|
||||||
|
session.json Schema version, rover/session identity, timing description,
|
||||||
|
start/end/reason/error, loss count, video exit information
|
||||||
|
events.ndjson Unix ms + process monotonic ns, kind, data
|
||||||
|
video.mkv Original video codec; receiver wall-clock PTS retained
|
||||||
|
```
|
||||||
|
|
||||||
|
Request/dispatch/ack IDs let later training join requested and applied commands.
|
||||||
|
The recorded `source` is provenance, not proof of a correct demonstration.
|
||||||
|
Queued events preserve their observation timestamp; file order around a new
|
||||||
|
session's snapshot is not necessarily chronological. Sort by timestamps when
|
||||||
|
constructing training windows. Rotations can have video gaps; do not train across
|
||||||
|
session boundaries as if footage were continuous.
|
||||||
|
|
||||||
|
Limits and follow-up:
|
||||||
|
|
||||||
|
- Retention is checked every 15 seconds and is a soft disk budget, not a filesystem
|
||||||
|
quota. Active files are closed before becoming eligible for pruning. Low free
|
||||||
|
space pauses capture. Models/training paths are never traversed by retention.
|
||||||
|
- Record only rovers with a connected human driver who currently passes the
|
||||||
|
existing control checks, including deterrence. Membership is required even for
|
||||||
|
admins so an admin login alone does not record unattended rovers. Preserve pauses
|
||||||
|
within an eligible human-control session. Driver/turn/mode/permission changes
|
||||||
|
reconcile recording immediately; telemetry buffering uses the same eligibility.
|
||||||
|
This supersedes the initial all-connected-rovers policy at the user's request.
|
||||||
|
Autonomous sessions will need explicit exclusion/provenance when implemented;
|
||||||
|
there are currently no autonomous controllers.
|
||||||
|
- Each event stream has a 2 MiB pending-write bound; startup/rotation buffering has
|
||||||
|
a shared 4 MiB bound. Session loss counters/capture-gap events identify overload.
|
||||||
|
- Video timestamps represent packet receipt at this server, not the frame a human
|
||||||
|
browser displayed. Actual FFmpeg output PTS still needs inspection on the server.
|
||||||
|
- Enabled recorders are stopped on disable and awaited; process-exit hooks kill
|
||||||
|
surviving children. Existing MediaMTX shutdown can exit the whole Node process
|
||||||
|
before async metadata flush finishes; next enable marks those sessions interrupted.
|
||||||
|
- Storage leases for concurrent training reads are pending with dataset sampling.
|
||||||
|
- Safe command submission extraction, autonomous provenance, model selection,
|
||||||
|
client favorites, and UI remain pending. Training/catalog code follows below.
|
||||||
|
|
||||||
|
Verification completed:
|
||||||
|
|
||||||
|
- `node --check` on new recording/lifecycle modules and modified command service:
|
||||||
|
passed (repeat only for subsequently changed modules as needed).
|
||||||
|
- `node --test server/src/configuration/configuration.test.js`: 14 passed, 1 failed.
|
||||||
|
The failing pre-existing default-values assertion omits
|
||||||
|
`$.discord.channels.liveStatus`; the current HEAD already defines it as empty.
|
||||||
|
New configuration validation, descriptions, normalization, and feature flags
|
||||||
|
passed. Leave the unrelated Discord assertion untouched.
|
||||||
|
- Direct disabled service startup with a disposable `SERVER_DATA_DIR` returned
|
||||||
|
`{"runtimeLoaded":false,"storageCreated":false}` and exited normally. Temporary
|
||||||
|
configuration storage was removed. No development service was left running.
|
||||||
|
- Local FFmpeg help confirms the RTSP transport and timeout options used.
|
||||||
|
- No full build, full lint, new tests, live server startup, or rover hardware run.
|
||||||
|
|
||||||
|
Optional server verification reference (user declined doing this checklist;
|
||||||
|
do not require it before continuing implementation):
|
||||||
|
|
||||||
|
1. Deploy normally, initially disabled; confirm no `rover-learning` directory or
|
||||||
|
learning FFmpeg workers are created by a fresh disabled startup.
|
||||||
|
2. Enable `roverLearning.enabled` through the existing admin configuration. An
|
||||||
|
online unattended rover must not produce recordings. Take human control and
|
||||||
|
confirm session files appear beneath the actual data mount; pauses should keep
|
||||||
|
recording. Release control/disconnect the last eligible driver and confirm
|
||||||
|
capture stops. Repeat across turn changes and mode/permission changes.
|
||||||
|
3. Drive, move the camera, and operate accessories. Check that event records contain
|
||||||
|
requested and dispatched payloads with matching IDs, sensor frames, and host stats.
|
||||||
|
4. For a completed session, inspect video with:
|
||||||
|
`ffprobe -v error -select_streams v:0 -read_intervals '%+#3' -show_entries packet=pts_time,dts_time -of json /actual/session/video.mkv`.
|
||||||
|
Compare packet timestamps (seconds) with event timestamps (milliseconds).
|
||||||
|
Report FFmpeg/session errors rather than assuming timestamp alignment is correct.
|
||||||
|
5. Disable: confirm owned FFmpeg processes exit, session metadata closes, no further
|
||||||
|
writes occur, and saved recordings remain. Re-enable to check clean restart.
|
||||||
|
6. Verify rotation and retention with an intentionally chosen small recording
|
||||||
|
budget, and confirm manual driving remains responsive during recording.
|
||||||
|
|
||||||
|
Actual server capture/timing and live cleanup remain unverified. These steps are
|
||||||
|
a reference for future runtime investigation, not a pending request to the user.
|
||||||
|
|
||||||
|
### Dataset/training/checkpoint increment
|
||||||
|
|
||||||
|
The user supplied IPI, then asked to continue after a rate-limit interruption.
|
||||||
|
Authorization remains in effect. Implemented:
|
||||||
|
|
||||||
|
- `workers/policy.py`: fixed-size spatial CNN/GRU with 64 action-shape slots and
|
||||||
|
up to 8 numeric output fields per shape. Four 160x120 RGB frames, spaced roughly
|
||||||
|
300 ms apart, with 32 selected sensors plus missing-value masks and previous
|
||||||
|
command values/ages/known flags. About 805k parameters (larger than the benchmark).
|
||||||
|
- Numeric controls are normalized with `2/pi * atan(value/scale)`; the model
|
||||||
|
produces per-shape event logits and numeric values for the next 100 ms.
|
||||||
|
Command types supported: drive, motors, servo, headlight, laser, horn, peripheral,
|
||||||
|
song, raw. Strings/bools/arrays remain exact template constants; variable-size
|
||||||
|
songs/raw OI payloads are discrete demonstrations, not generated arbitrary bytes.
|
||||||
|
Maintenance commands, audio/text and sensor-stream setup are not action targets.
|
||||||
|
All recordings remain intact until normal dataset retention, regardless of
|
||||||
|
whether the trainer can use their commands.
|
||||||
|
- The schema grows only into unused fixed slots and is saved with each model.
|
||||||
|
Overflow (64 shapes/8 numeric fields/4096-byte commands) skips the affected
|
||||||
|
recording with a reason instead of silently truncating controls. This is a
|
||||||
|
concrete initial encoding limit, not a promise to represent unlimited hardware
|
||||||
|
or arbitrary song libraries. Revisit it if real recordings exhaust capacity.
|
||||||
|
- `workers/dataset.py`: bounded event loading (64 MiB/session), PyAV decoding,
|
||||||
|
absolute timestamp checks, causal sensor/action history, accepted-client-command
|
||||||
|
targets, and masks for observed action slots. Actual measured wheel speeds are
|
||||||
|
among the selected sensor inputs. Missing/stale sensors, video gaps, clock shifts,
|
||||||
|
incomplete recordings, data loss, and ambiguous conflicting actions are excluded.
|
||||||
|
Server-generated control overrides are history/boundaries, not demonstrations.
|
||||||
|
- Validation is automatic and cannot establish what frame a browser displayed.
|
||||||
|
A session is only accepted after its video finishes decoding; samples from a
|
||||||
|
subsequently corrupt session are discarded. Commands/sensors at future times
|
||||||
|
do not enter observation history.
|
||||||
|
- `workers/train.py`: finite CPU jobs, lower OS priority, shuffled bounded reservoir
|
||||||
|
sampling, sparse-event classification plus masked numeric regression, gradient
|
||||||
|
clipping, finite-loss checks, and AdamW resume state. Never sends rover commands.
|
||||||
|
- `training.js`: one owned worker, recording leases acquired within serialized
|
||||||
|
maintenance, bounded stdout/stderr, interval and wall-clock limits, shutdown,
|
||||||
|
persistent per-recording visit/rejection ledger, and progress state for the
|
||||||
|
future card. Retention protects leased recordings. Disk pressure cancels the
|
||||||
|
training job before files become eligible for pruning again.
|
||||||
|
- Atomic `training/resume.pt` includes model and optimizer state, schema, cumulative
|
||||||
|
steps/examples, and publication progress. Permanent model directories are
|
||||||
|
atomically renamed into visibility with weights and metadata together.
|
||||||
|
- `models.js`: reads the permanent metadata catalog. Each model has a UUID, two-word
|
||||||
|
generated name plus UUID suffix, creation time, steps/examples, schema, source
|
||||||
|
session IDs, trained rover IDs, training loss, parameter count, weight hash/size,
|
||||||
|
and `evaluation: unevaluated`. No model pruning, favorites, or server pin state.
|
||||||
|
- Dockerfile packages a CPU-only Python venv at `/opt/rover-learning` during image
|
||||||
|
build. Pinned requirements: torch 2.14.0+cpu, NumPy 2.5.3, PyAV 18.1.0. No runtime
|
||||||
|
downloads/installers. A disabled service does not load or run these dependencies.
|
||||||
|
|
||||||
|
Training defaults beneath `roverLearning.training`:
|
||||||
|
|
||||||
|
| Setting | Default |
|
||||||
|
|---|---:|
|
||||||
|
| enabled (still gated by outer service enabled=false) | true |
|
||||||
|
| threads | 8 |
|
||||||
|
| batchSize | 16 |
|
||||||
|
| maxSamples / minimumSamples | 1024 / 128 |
|
||||||
|
| passesPerJob | 2 |
|
||||||
|
| minimumDrivingMinutes / newDrivingMinutesPerModel | 30 / 10 |
|
||||||
|
| maxStepsPerJob | 200 |
|
||||||
|
| checkpointEverySteps | 1000 |
|
||||||
|
| intervalSeconds | 60 |
|
||||||
|
| maxJobSeconds | 600 |
|
||||||
|
|
||||||
|
Defaults tuned to the user's dual E5-2620 v4 server benchmark: eight training
|
||||||
|
threads improved throughput substantially over four, while sixteen gave little
|
||||||
|
additional benefit. The larger sample pool and shorter interval are starting
|
||||||
|
choices for its available resources, not measured learning-quality improvements.
|
||||||
|
Inference remains four threads per rover. Existing explicit configuration values
|
||||||
|
override these defaults; this change does not rewrite deployed configuration.
|
||||||
|
|
||||||
|
At most four completed retained sessions are selected per job. Samples are spread
|
||||||
|
over each full video via reservoir sampling, not always taken from its beginning.
|
||||||
|
The prior three-visit limit is removed. Retained usable training sessions remain
|
||||||
|
eligible for repeated sampling; finite jobs still yield between runs.
|
||||||
|
Candidate publication happens at job boundaries after data, step, and held-out gates;
|
||||||
|
it does not automatically deploy a model. No all-no-action sample pool is trained.
|
||||||
|
|
||||||
|
Container rebuild is needed to include Python packages. For a non-container
|
||||||
|
deployment, install `workers/requirements.txt` into a dedicated venv and set
|
||||||
|
`training.python` to its Python path. The default path is container-specific.
|
||||||
|
|
||||||
|
Verification performed in this increment:
|
||||||
|
|
||||||
|
- Installed the actual pinned requirements in `/tmp/rover-bench-check-env`.
|
||||||
|
- Ran the production worker's `--check-dependencies`: PyTorch/PyAV/NumPy imports,
|
||||||
|
dataset imports, policy construction, and specification output succeeded.
|
||||||
|
- Four existing focused configuration tests passed (defaults, descriptions,
|
||||||
|
generated feature paths, normalization). The unrelated prior Discord default
|
||||||
|
assertion was not rerun or changed.
|
||||||
|
- Node syntax checks on scheduler/runtime/catalog passed.
|
||||||
|
- No new tests, fake recording fixtures, or throwaway test programs were created.
|
||||||
|
- No real recordings are available locally. Actual decoding/alignment, optimizer
|
||||||
|
execution against recordings, checkpoint publication/resume, and concurrent
|
||||||
|
server performance are not claimed verified. No full container build was run.
|
||||||
|
|
||||||
|
The following controller/UI increment implements those remaining code paths.
|
||||||
|
Real-data and live-hardware verification still remain before claiming usable autonomy. The initial model is an experimental imitation policy, not a demonstrated
|
||||||
|
competent driver or a final architecture choice.
|
||||||
|
|
||||||
|
When resuming after implementation begins, append concrete changed files, commands
|
||||||
|
run/results, unresolved failures, decisions approved by the user, and the next
|
||||||
|
bounded task here. Do not mark a checkbox complete merely because code exists;
|
||||||
|
record verification limits and outstanding server/hardware work explicitly.
|
||||||
|
|
||||||
|
|
||||||
|
### Controller and VIP card increment
|
||||||
|
|
||||||
|
- `commandService/index.js` exports the existing checked handler as `submitCommand`;
|
||||||
|
browser behavior remains in the same handler. Recording distinguishes model
|
||||||
|
requests from human requests without changing command payloads.
|
||||||
|
- `driving.js` owns per-rover CPU workers under the initiating live socket's
|
||||||
|
permissions. Explicit Stop, permission/connection loss, stale predictions, or
|
||||||
|
worker failure stop the session and send zero drive/motors and horn stop.
|
||||||
|
Human commands deliberately neither stop nor pause the model.
|
||||||
|
- `workers/infer.py` consumes live RTSP/TCP video plus sensor/command observations,
|
||||||
|
uses the training history format, validates weights/specification, resolves
|
||||||
|
competing command families, and latches discrete actions. It never writes to
|
||||||
|
the rover directly. Driving defaults: four CPU threads, 0.7 action threshold,
|
||||||
|
2000ms stale limit, with a 30-second worker startup allowance.
|
||||||
|
- `capabilities.js` matches recorded hardware control profiles against the target
|
||||||
|
rover. Recordings, resumable training state, and published manifests preserve
|
||||||
|
those profiles; models without a matching profile are not selectable for Start.
|
||||||
|
- `runtime.js` excludes autonomous sessions from human demonstrations, manages
|
||||||
|
controller shutdown, and supplies bounded recent activity and storage state.
|
||||||
|
- `socketGateway.js` emits one complete authorized card object every second to
|
||||||
|
subscribers, refreshes the permanent catalog every 15 seconds, and accepts
|
||||||
|
checked Start/Stop actions. No server-side favorites are stored.
|
||||||
|
- `VipRoverLearningCard.jsx` is at the top of the verified VIP tab, gated by the
|
||||||
|
service feature flag. It uses existing CardFrame, field/button/surface styles;
|
||||||
|
favorites use browser settings. Its expandable section includes storage,
|
||||||
|
recording sessions, dataset rejection reasons, training progress/resource
|
||||||
|
limits, model size/loss/control count, inference timing, last action, and events.
|
||||||
|
- Verification: focused ESLint on the new card and VipPanel passed; four existing
|
||||||
|
configuration tests passed. The live worker's actual `--help` entry point loaded
|
||||||
|
PyTorch/PyAV/NumPy successfully. Shared-handler diff reviewed with whitespace
|
||||||
|
ignored: extraction preserves the previous command handler logic.
|
||||||
|
- No real dataset, checkpoint, camera stream, or rover was available locally;
|
||||||
|
end-to-end inference/training and browser rendering remain unverified. No new
|
||||||
|
tests or background processes were added for verification, and no full build
|
||||||
|
or full test suite was run.
|
||||||
|
|
||||||
|
|
||||||
|
### Dock capture, live diagnostics, and publication correction
|
||||||
|
|
||||||
|
Authorized by IPI after the user reported idle dock recording, many premature
|
||||||
|
models, silent controllers, and training stopping after a few jobs.
|
||||||
|
|
||||||
|
- VipPanel now renders only `<VipRoverLearningCard />`; the card owns feature and
|
||||||
|
verification gating, rover selection context, and grid wrapper. The user's
|
||||||
|
pre-existing card edit was preserved.
|
||||||
|
- Human docked sessions maintain disposable packet-copy video segments and a
|
||||||
|
bounded five-second event buffer. Segments are keyframe-aligned (target two
|
||||||
|
seconds); old closed segments are pruned, with an extra edge segment retained
|
||||||
|
for decoding. Undocking promotes the buffer and sets trainingStartedAt to five
|
||||||
|
seconds earlier. After docking, recording closes after five seconds (250ms
|
||||||
|
polling granularity) and returns to buffering. Never-undocked buffers are
|
||||||
|
deleted on close/recovery and never offered to training. Disk retention still
|
||||||
|
applies. The reader handles chronological segments and filters the lead-in
|
||||||
|
boundary; no RTSP restart is needed to promote a dock buffer.
|
||||||
|
- The service still excludes autonomous sessions and still requires an eligible
|
||||||
|
human. Human input does not stop or pause autonomy.
|
||||||
|
- Expanded card diagnostics opt into complete volatile snapshots at 10Hz;
|
||||||
|
collapsed cards receive 1Hz. Predictions include all known command shapes,
|
||||||
|
scores, decoded controls, below-threshold/competing/latched reasons, and actual
|
||||||
|
submission results. "Predicting no new action" is separate from worker running.
|
||||||
|
- Removed roundsPerSession from configuration and scheduling. Completed usable
|
||||||
|
recordings remain eligible indefinitely within rolling retention. Jobs remain
|
||||||
|
finite, lower-priority, and separated by the configured interval. Waiting and
|
||||||
|
publication reasons are visible in the card.
|
||||||
|
- Default publication gates: 1000 optimizer steps, 30 distinct usable training
|
||||||
|
minutes, and 10 additional distinct minutes since the previous publication.
|
||||||
|
Usable minutes count enumerated aligned 100ms windows once per training session,
|
||||||
|
not repeated optimizer exposures; only a reservoir is used in each job.
|
||||||
|
- Entire sessions are deterministically partitioned 80/20 by session-ID hash.
|
||||||
|
Held-out sessions never supply gradient updates or new command vocabulary.
|
||||||
|
Evaluation requires at least 128 windows and 32 positive events, precision and
|
||||||
|
recall >=0.5 at the configured action threshold, and normalized numeric MSE
|
||||||
|
<=0.1 with numeric targets present. These are initial imitation gates, not proof
|
||||||
|
of autonomous competence. Evaluation uses the current job's held-out reservoir;
|
||||||
|
jobs with no usable held-out cohort cannot publish.
|
||||||
|
- Fresh `training/resume-v2.pt` prevents old training exposure contaminating the
|
||||||
|
new validation split. Existing published models and old resume.pt are preserved.
|
||||||
|
New checkpoints retain optimizer progress even when publication is blocked.
|
||||||
|
- Deployment config: migration 3 automatically removes the obsolete
|
||||||
|
`training.roundsPerSession` key from saved revisions before startup validation. Set `checkpointEverySteps: 1000`, `minimumDrivingMinutes: 30`,
|
||||||
|
and `newDrivingMinutesPerModel: 10`; saved values override changed defaults.
|
||||||
|
- Verification: four focused configuration tests passed, modified Node entry
|
||||||
|
points passed syntax checks, targeted VIP ESLint passed, and the production
|
||||||
|
training dependency entry point loaded the policy and segmented dataset reader.
|
||||||
|
No fixtures/test files, full builds, or background servers were created.
|
||||||
|
- Still unverified on this development machine: live RTSP segment timestamps and
|
||||||
|
dock transitions, actual optimizer/evaluation/publication runs on recordings,
|
||||||
|
browser appearance/live updates, and real autonomous behavior. Do not claim
|
||||||
|
these checks passed or that the existing event-based policy now drives well.
|
||||||
|
|
||||||
|
|
||||||
|
### Startup regression repair
|
||||||
|
|
||||||
|
The actual server crash reported CONFIG_VALIDATION_FAILED for the removed
|
||||||
|
roverLearning.training.roundsPerSession field. Added configuration database
|
||||||
|
migration 3 to remove only that obsolete key from all saved revisions before
|
||||||
|
startup validation. Other settings remain intact; normal default filling adds
|
||||||
|
new fields. No manual database/config edits are required. Existing focused
|
||||||
|
migration and normalization tests passed (2/2); production restart is unverified.
|
||||||
|
|
||||||
|
|
||||||
|
### Continuous wheel policy and copyable diagnostics (latest IPI)
|
||||||
|
|
||||||
|
Requirements: learn solely from ordinary use. Never require prescribed routes,
|
||||||
|
exercises, or demonstrations. Keep eight training threads until actual timings
|
||||||
|
justify changes. No artificial model-size increase. Manual controls still do not
|
||||||
|
stop or pause the controller. Keep card layout in the existing feature-card stack.
|
||||||
|
|
||||||
|
Implemented:
|
||||||
|
- Policy format 2 adds an independent two-value tanh wheel head (805,234 total
|
||||||
|
parameters), scaled to +/-500 mm/s. Accessory event/value heads remain separate;
|
||||||
|
drive command shapes remain causal history inputs but are masked as event targets.
|
||||||
|
- Dataset reconstructs accepted human wheel intent at frame time +100ms, using
|
||||||
|
dispatched wheel values, explicit zero stops, and the recorded hardware limit
|
||||||
|
when available. Inspection of roverd dispatch found persistent wheel commands,
|
||||||
|
not a short wheel-command expiry timer. Permission boundaries, server overrides,
|
||||||
|
failed/ambiguous drive commands and raw/mode/system changes invalidate wheel
|
||||||
|
intent until another accepted human drive. Uncertain windows are excluded.
|
||||||
|
Raw OI controls are consequently not reliable trainable events in this revision;
|
||||||
|
their effects require dedicated decoding before relaxing that exclusion.
|
||||||
|
- Four bounded training reservoirs preserve stopped, forward, reverse and turn
|
||||||
|
examples without requiring humans to behave differently. Held-out reservoirs
|
||||||
|
remain uniformly sampled and entire sessions retain deterministic partitioning.
|
||||||
|
- Loss reports separate wheel, accessory-event and accessory-value components.
|
||||||
|
Held-out wheel MAE is compared with stopped-wheel and previous-command baselines,
|
||||||
|
with separate error on actual wheel changes. Publication needs >=128 evaluation
|
||||||
|
windows, >=32 moving and >=32 changed windows, improvement over stopped and
|
||||||
|
changed-window persistence baselines, and overall error no worse than persistence.
|
||||||
|
Accessory precision/recall gates remain when events exist; absent accessory
|
||||||
|
events must not produce false positives. These remain experimental imitation
|
||||||
|
criteria, not proof of autonomous competence.
|
||||||
|
- Existing footage can be reused. New learning state is resume-v3.pt and
|
||||||
|
schedule-v3.json, preventing old-shape weights or stale rejection ledgers from
|
||||||
|
being reused. Existing published files remain untouched and visibly marked as
|
||||||
|
older format/incompatible. New compatible models are required to start driving.
|
||||||
|
- Live inference emits a wheel command every decision, independent of the accessory
|
||||||
|
threshold. Server clamps wheel values to hardware limits through the unchanged
|
||||||
|
shared authorization path. Start/Stop and manual-input behavior are preserved.
|
||||||
|
- Main card shows centered signed wheel bars, accessory score/status bars and a
|
||||||
|
session-local threshold slider (0.05..0.99). Only users with current rover control
|
||||||
|
can adjust it. Worker receives settings over its existing stdin channel; desired
|
||||||
|
and applied thresholds are separately observable. Active controllers get 10Hz
|
||||||
|
snapshots even when details are collapsed.
|
||||||
|
- Copy diagnostics exports compact reportVersion=1 JSON from the same complete
|
||||||
|
card object. It includes application version, service-source SHA256 fingerprint,
|
||||||
|
policy version, settings, host load/memory, dataset timing/availability counters,
|
||||||
|
separate losses, baseline evaluation, decode/train/evaluation/checkpoint timing,
|
||||||
|
CPU seconds and peak RSS, publication blockers, 20 job summaries and up to 30s
|
||||||
|
of controller history sampled at 2Hz (top eight action scores per entry).
|
||||||
|
- Reports use an explicit allowlist: no socket IDs, nicknames, rover IDs, filesystem
|
||||||
|
paths, raw video, credential-bearing URLs or raw command templates. Errors are
|
||||||
|
categorized rather than copying potentially sensitive arbitrary exception text.
|
||||||
|
Browser video latency and actual physical command execution are explicitly
|
||||||
|
unavailable. Diagnostics payloads are sent only while details are expanded;
|
||||||
|
active action visualization remains live in the main card.
|
||||||
|
- Clipboard failure exposes a selectable compact report instead of silently failing.
|
||||||
|
- No recorded dataset exists under this checkout's server/data/rover-learning.
|
||||||
|
Production worker dependency/entry-point checks succeeded; policy construction
|
||||||
|
reports 805,234 parameters. Targeted card ESLint and Node syntax checks passed.
|
||||||
|
Actual optimizer execution, held-out results, RTSP inference, clipboard/slider
|
||||||
|
behavior and browser appearance remain unverified here. No new tests, fake data,
|
||||||
|
or background development processes were created.
|
||||||
|
|
||||||
|
Next: use real diagnostic reports to assess timing, sample rejection, target
|
||||||
|
coverage and baseline performance. Do not infer competence from lower training
|
||||||
|
loss or increase architecture size without that evidence. If training was disabled
|
||||||
|
through the configuration UI, the operator must re-enable it to train this policy.
|
||||||
|
|
||||||
|
|
||||||
|
### Ongoing learner and administrator snapshots
|
||||||
|
|
||||||
|
Authorized by the latest IPI. Training continues from the same resume-v3.pt;
|
||||||
|
no new training reset or configuration migration is required.
|
||||||
|
|
||||||
|
- Each completed training job exports immutable weights/metadata beneath
|
||||||
|
training/checkpoints/<uuid>. A serialized Node catalog atomically updates
|
||||||
|
index.json with candidate, latest, and previous pointers after worker exit.
|
||||||
|
- Existing data/step/evaluation gates govern Latest promotion. Previous retains
|
||||||
|
the former Latest. Candidate tracks the latest completed learner even when
|
||||||
|
those gates fail. No automatic permanent named-model creation remains.
|
||||||
|
- The model picker exposes Latest and Previous alongside existing permanent
|
||||||
|
snapshots. Running sessions acquire a checkpoint lease and keep their original
|
||||||
|
weights; promotion does not reload them. Retention removes superseded automatic
|
||||||
|
checkpoints, with leased ones removed after their running session closes.
|
||||||
|
- Admin-only Save learner snapshot copies the candidate atomically to a new
|
||||||
|
permanent two-word/UUID model directory, carrying its evaluation and source
|
||||||
|
checkpoint ID. Candidates without a passing evaluation are labeled experimental.
|
||||||
|
Non-admin requests are rejected server-side. Normal rover-control permissions
|
||||||
|
still apply when starting any model. Existing models/favorites remain intact.
|
||||||
|
- Source fingerprints and controller diagnostics include the pinned checkpoint ID.
|
||||||
|
Configuration field names are unchanged; descriptions now refer to Latest
|
||||||
|
promotion rather than permanent publication. Permanent snapshots are never pruned.
|
||||||
|
- Focused Node syntax and Python worker entry-point checks passed. Targeted card
|
||||||
|
lint is run for the UI change. End-to-end training/promotion, snapshot copying,
|
||||||
|
active-session pinning and browser behavior remain unverified without live data.
|
||||||
@@ -1,3 +1,10 @@
|
|||||||
|
const backupRestoreService = require('./src/services/backupRestoreService');
|
||||||
|
|
||||||
|
// A staged restore must replace data before configuration, identity, or report
|
||||||
|
// services open SQLite. Requiring the service here is safe because its runtime
|
||||||
|
// HTTP/socket dependencies remain lazy until register() is called below.
|
||||||
|
backupRestoreService.applyPendingRestore();
|
||||||
|
|
||||||
require('./src/globals/logger');
|
require('./src/globals/logger');
|
||||||
require('./src/globals/config');
|
require('./src/globals/config');
|
||||||
require('./src/globals/http');
|
require('./src/globals/http');
|
||||||
@@ -61,9 +68,11 @@ require('./src/services/batteryManager');
|
|||||||
// subscriptions see fully decoded state without becoming an initialization
|
// subscriptions see fully decoded state without becoming an initialization
|
||||||
// dependency of either control path.
|
// dependency of either control path.
|
||||||
require('./src/services/fleetReportService');
|
require('./src/services/fleetReportService');
|
||||||
|
require('./src/services/roverLearningService');
|
||||||
require('./src/services/replayEngineV2');
|
require('./src/services/replayEngineV2');
|
||||||
// Replay delivery is a core service. It must subscribe before the optional
|
// Replay delivery is a core service. It must subscribe before the optional
|
||||||
// Discord feature so web requests always have a local delivery path.
|
// Discord feature so web requests always have a local delivery path.
|
||||||
require('./src/services/replayDeliveryService');
|
require('./src/services/replayDeliveryService');
|
||||||
require('./src/services/discordBotService');
|
require('./src/services/discordBotService');
|
||||||
|
backupRestoreService.register();
|
||||||
require('./src/services/httpServer');
|
require('./src/services/httpServer');
|
||||||
|
|||||||
@@ -305,7 +305,10 @@ Environment=NODE_ENV=production
|
|||||||
Environment=SERVER_DATA_DIR=$DATA_DIR
|
Environment=SERVER_DATA_DIR=$DATA_DIR
|
||||||
Environment=ROVER_SNAPSHOT_WRITER_BIN=$ROVER_SNAPSHOT_WRITER_BIN
|
Environment=ROVER_SNAPSHOT_WRITER_BIN=$ROVER_SNAPSHOT_WRITER_BIN
|
||||||
ExecStart=$NODE_BIN $SERVER_DIR/index.js
|
ExecStart=$NODE_BIN $SERVER_DIR/index.js
|
||||||
Restart=on-failure
|
# Application-requested restarts use the same clean SIGTERM path as an
|
||||||
|
# operator stop. Restart=always lets that process exit come back automatically,
|
||||||
|
# while an explicit `systemctl stop` still remains stopped by systemd design.
|
||||||
|
Restart=always
|
||||||
RestartSec=2
|
RestartSec=2
|
||||||
SuccessExitStatus=130 143
|
SuccessExitStatus=130 143
|
||||||
|
|
||||||
|
|||||||
@@ -40,7 +40,8 @@ case "$PATH_NAME" in
|
|||||||
esac
|
esac
|
||||||
|
|
||||||
exec ffmpeg -hide_banner -loglevel warning -nostdin -y \
|
exec ffmpeg -hide_banner -loglevel warning -nostdin -y \
|
||||||
-i "srt://127.0.0.1:9000?streamid=read:${PATH_NAME}" \
|
-rtsp_transport tcp \
|
||||||
|
-i "rtsp://127.0.0.1:8554/${PATH_NAME}" \
|
||||||
-an \
|
-an \
|
||||||
-vf "$FILTER" \
|
-vf "$FILTER" \
|
||||||
-q:v "$QUALITY" \
|
-q:v "$QUALITY" \
|
||||||
|
|||||||
Generated
+4400
File diff suppressed because it is too large
Load Diff
@@ -14,9 +14,11 @@
|
|||||||
"bcrypt": "^6.0.0",
|
"bcrypt": "^6.0.0",
|
||||||
"better-sqlite3": "^12.11.1",
|
"better-sqlite3": "^12.11.1",
|
||||||
"discord.js": "^14.25.1",
|
"discord.js": "^14.25.1",
|
||||||
|
"dockerode": "^5.0.1",
|
||||||
"express": "^4.19.2",
|
"express": "^4.19.2",
|
||||||
"fuse.js": "^7.4.2",
|
"fuse.js": "^7.4.2",
|
||||||
"home-assistant-js-websocket": "^3.1.2",
|
"home-assistant-js-websocket": "^3.1.2",
|
||||||
|
"http-proxy-middleware": "^3.0.7",
|
||||||
"js-yaml": "^4.1.1",
|
"js-yaml": "^4.1.1",
|
||||||
"kokoro-js": "^1.2.1",
|
"kokoro-js": "^1.2.1",
|
||||||
"luxon": "^3.7.2",
|
"luxon": "^3.7.2",
|
||||||
@@ -27,6 +29,7 @@
|
|||||||
"reolink-nvr-api": "^0.3.0",
|
"reolink-nvr-api": "^0.3.0",
|
||||||
"sharp": "^0.33.5",
|
"sharp": "^0.33.5",
|
||||||
"socket.io": "^4.7.5",
|
"socket.io": "^4.7.5",
|
||||||
|
"tar": "^7.5.22",
|
||||||
"uuid": "^9.0.1",
|
"uuid": "^9.0.1",
|
||||||
"ws": "^8.18.0"
|
"ws": "^8.18.0"
|
||||||
},
|
},
|
||||||
|
|||||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -1 +0,0 @@
|
|||||||
.configuration-tree{margin-top:.25rem}.configuration-tree>:not([hidden])~:not([hidden]){--tw-space-y-reverse: 0;margin-top:calc(1.5rem * calc(1 - var(--tw-space-y-reverse)));margin-bottom:calc(1.5rem * var(--tw-space-y-reverse))}.configuration-card{min-width:0px}.configuration-card .configuration-card{margin-left:1rem;width:calc(100% - 1rem)}.configuration-card-body>:not([hidden])~:not([hidden]){--tw-space-y-reverse: 0;margin-top:calc(.125rem * calc(1 - var(--tw-space-y-reverse)));margin-bottom:calc(.125rem * var(--tw-space-y-reverse))}.configuration-card-body{padding:.125rem}.configuration-children>:not([hidden])~:not([hidden]){--tw-space-y-reverse: 0;margin-top:calc(.125rem * calc(1 - var(--tw-space-y-reverse)));margin-bottom:calc(.125rem * var(--tw-space-y-reverse))}.configuration-line{display:grid;min-width:0px;grid-template-columns:repeat(1,minmax(0,1fr));align-items:flex-start;gap:.125rem;border-radius:.375rem;--tw-bg-opacity: 1;background-color:rgb(38 38 38 / var(--tw-bg-opacity));padding:.125rem}@media(min-width:640px){.configuration-line{grid-template-columns:minmax(9rem,16rem) minmax(12rem,40rem)}}.configuration-line{justify-content:start}.configuration-key,.configuration-value{min-width:0px}.configuration-root-description,.configuration-branch-description,.configuration-item-description,.configuration-value-description{display:block;font-size:.875rem;line-height:1.25rem;line-height:1.375;--tw-text-opacity: 1;color:rgb(203 213 225 / var(--tw-text-opacity));margin-top:.125rem}.configuration-root-description{margin-bottom:.25rem}.configuration-branch-description,.configuration-item-description{max-width:56rem}.configuration-value-description{margin-bottom:.125rem;max-width:40rem}.configuration-value input:not([type=checkbox]),.configuration-value select,.configuration-value textarea{width:100%;border-radius:.375rem;border-width:1px;--tw-border-opacity: 1;border-color:rgb(82 82 82 / var(--tw-border-opacity));--tw-bg-opacity: 1;background-color:rgb(64 64 64 / var(--tw-bg-opacity));padding:.125rem;--tw-text-opacity: 1;color:rgb(255 255 255 / var(--tw-text-opacity))}.configuration-value input:not([type=checkbox])::-moz-placeholder,.configuration-value select::-moz-placeholder,.configuration-value textarea::-moz-placeholder{--tw-text-opacity: 1;color:rgb(148 163 184 / var(--tw-text-opacity))}.configuration-value input:not([type=checkbox])::placeholder,.configuration-value select::placeholder,.configuration-value textarea::placeholder{--tw-text-opacity: 1;color:rgb(148 163 184 / var(--tw-text-opacity))}.configuration-value input:not([type=checkbox]):focus,.configuration-value select:focus,.configuration-value textarea:focus{outline:2px solid transparent;outline-offset:2px;--tw-ring-offset-shadow: var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color);--tw-ring-shadow: var(--tw-ring-inset) 0 0 0 calc(1px + var(--tw-ring-offset-width)) var(--tw-ring-color);box-shadow:var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow, 0 0 #0000);--tw-ring-opacity: 1;--tw-ring-color: rgb(14 165 233 / var(--tw-ring-opacity))}.configuration-value input[type=checkbox]{height:1rem;width:1rem;vertical-align:middle;accent-color:#0ea5e9}.configuration-value .checkbox label{display:flex;min-height:1.75rem;align-items:center;--tw-text-opacity: 1;color:rgb(241 245 249 / var(--tw-text-opacity))}.configuration-value .error-detail{margin-top:.125rem;font-size:.75rem;line-height:1rem;--tw-text-opacity: 1;color:rgb(252 165 165 / var(--tw-text-opacity))}.configuration-value .help-block{margin-top:.125rem;display:block;font-size:.7rem;--tw-text-opacity: 1;color:rgb(100 116 139 / var(--tw-text-opacity))}.configuration-secret{min-width:0px}.configuration-item-actions,.configuration-array-actions{display:flex;flex-wrap:wrap;gap:.125rem}
|
|
||||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+2
-2
File diff suppressed because one or more lines are too long
+1
-1
File diff suppressed because one or more lines are too long
@@ -0,0 +1,2 @@
|
|||||||
|
import{r as g,R as a}from"./index-dJH5nUWV.js";const d="64px",u={},k=({src:s,light:t,oEmbedUrl:o,onClickPreview:n,playIcon:b,previewTabIndex:_,previewAriaLabel:p})=>{const[f,r]=g.useState(null);g.useEffect(()=>{!s||!t||!o||x({src:s,light:t,oEmbedUrl:o})},[s,t,o]);const x=async({src:e,light:i,oEmbedUrl:E})=>{if(a.isValidElement(i))return;if(typeof i=="string"){r(i);return}if(u[e]){r(u[e]);return}r(null);const m=await(await fetch(E.replace("{url}",e))).json();if(m.thumbnail_url){const h=m.thumbnail_url.replace("height=100","height=480").replace("-d_295x166","-d_640");r(h),u[e]=h}},I=e=>{(e.key==="Enter"||e.key===" ")&&n?.(e)},v=e=>{n?.(e)},l=a.isValidElement(t),y={display:"flex",alignItems:"center",justifyContent:"center"},c={preview:{width:"100%",height:"100%",backgroundImage:f&&!l?`url(${f})`:void 0,backgroundSize:"cover",backgroundPosition:"center",cursor:"pointer",...y},shadow:{background:"radial-gradient(rgb(0, 0, 0, 0.3), rgba(0, 0, 0, 0) 60%)",borderRadius:d,width:d,height:d,position:l?"absolute":void 0,...y},playIcon:{borderStyle:"solid",borderWidth:"16px 0 16px 26px",borderColor:"transparent transparent transparent white",marginLeft:"7px"}},w=a.createElement("div",{style:c.shadow,className:"react-player__shadow"},a.createElement("div",{style:c.playIcon,className:"react-player__play-icon"}));return a.createElement("div",{style:c.preview,className:"react-player__preview",tabIndex:_,onClick:v,onKeyDown:I,...p?{"aria-label":p}:{}},l?t:null,b||w)};var C=k;export{C as default};
|
||||||
|
//# sourceMappingURL=Preview-BBzOMZjy.js.map
|
||||||
File diff suppressed because one or more lines are too long
+2
-2
@@ -1,2 +1,2 @@
|
|||||||
import{e as F,r as s,j as e,S as P,C as c,L as $}from"./index-CqMkCfQw.js";import{e as q,f as D,i as I}from"./api-C0PIt_OP.js";function R(){const l=F(),[a,m]=s.useState(null),[n,b]=s.useState(""),[d,C]=s.useState(""),[p,N]=s.useState(""),[r,S]=s.useState(""),[f,v]=s.useState(""),[o,w]=s.useState(null),[x,h]=s.useState(!1),[g,i]=s.useState("");s.useEffect(()=>{q(l).then(t=>m(t.required)).catch(t=>i(t.message))},[l]);async function j(t){h(!0),i("");try{await t(),m(!1),i("Setup completed. You can now open the administration application and log in.")}catch(u){const E=Array.isArray(u.validationErrors)?` ${u.validationErrors.map(y=>`${y.path}: ${y.message}`).join("; ")}`:"";i(`${u.message}${E}`)}finally{h(!1)}}function k(t){if(t.preventDefault(),r!==f){i("Passwords do not match.");return}j(()=>D(l,{setupCode:n,username:d,discordId:p,password:r}))}function A(t){t.preventDefault(),o&&j(async()=>I(l,{setupCode:n,fileName:o.name,yaml:await o.text()}))}return e.jsxs("div",{className:"min-h-screen bg-neutral-950 p-1 text-slate-100",children:[e.jsx(P,{}),e.jsxs("main",{className:"mx-auto flex min-h-screen w-full max-w-3xl flex-col justify-center gap-0.5",children:[e.jsxs(c,{title:"MultiRover setup",meta:a===null?"checking":a?"required":"complete",bodyClassName:"space-y-0.5 p-1 text-sm",children:[a?e.jsx("p",{children:"Enter the one-time code from setup-code.txt in the server data folder, then create the first lockdown administrator or import an existing configuration."}):null,a===!1?e.jsx($,{className:"button-dark inline-block",to:"/admin",children:"Open administration"}):null,g?e.jsx("p",{className:"surface p-1 text-sm text-slate-200",children:g}):null]}),a?e.jsxs(e.Fragment,{children:[e.jsxs(c,{title:"Setup authorization",bodyClassName:"p-1",children:[e.jsx("label",{className:"block text-xs font-semibold text-slate-200",children:"One-time setup code"}),e.jsx("input",{className:"field-input mt-0.5 w-full font-mono",value:n,onChange:t=>b(t.target.value)})]}),e.jsx(c,{title:"Create first administrator",bodyClassName:"p-1",children:e.jsxs("form",{className:"grid gap-0.5 md:grid-cols-2",onSubmit:k,children:[e.jsx("input",{className:"field-input",placeholder:"Username",value:d,onChange:t=>C(t.target.value)}),e.jsx("input",{className:"field-input",placeholder:"Discord id (optional)",value:p,onChange:t=>N(t.target.value)}),e.jsx("input",{className:"field-input",type:"password",placeholder:"Password",value:r,onChange:t=>S(t.target.value)}),e.jsx("input",{className:"field-input",type:"password",placeholder:"Confirm password",value:f,onChange:t=>v(t.target.value)}),e.jsx("button",{className:"button-dark md:col-span-2",type:"submit",disabled:x||!n||!d||!r,children:"Create lockdown administrator"})]})}),e.jsxs(c,{title:"Import configuration file",bodyClassName:"space-y-0.5 p-1 text-sm",children:[e.jsx("p",{className:"text-xs text-slate-400",children:"Choose an existing YAML configuration explicitly. The server validates and imports it once, and its secrets are never displayed back in the browser."}),e.jsxs("form",{className:"flex flex-col gap-0.5 md:flex-row",onSubmit:A,children:[e.jsx("input",{className:"field-input flex-1",type:"file",accept:".yaml,.yml,text/yaml",onChange:t=>w(t.target.files?.[0]||null)}),e.jsx("button",{className:"button-dark",type:"submit",disabled:x||!n||!o,children:"Import selected YAML"})]})]})]}):null]})]})}export{R as default};
|
import{e as F,r as s,j as e,S as P,C as c,L as q}from"./index-dJH5nUWV.js";import{o as $,p as D,q as I}from"./api-B8GGCEeo.js";function R(){const l=F(),[a,m]=s.useState(null),[n,b]=s.useState(""),[d,C]=s.useState(""),[p,N]=s.useState(""),[r,S]=s.useState(""),[f,v]=s.useState(""),[o,w]=s.useState(null),[x,h]=s.useState(!1),[g,i]=s.useState("");s.useEffect(()=>{$(l).then(t=>m(t.required)).catch(t=>i(t.message))},[l]);async function j(t){h(!0),i("");try{await t(),m(!1),i("Setup completed. You can now open the administration application and log in.")}catch(u){const E=Array.isArray(u.validationErrors)?` ${u.validationErrors.map(y=>`${y.path}: ${y.message}`).join("; ")}`:"";i(`${u.message}${E}`)}finally{h(!1)}}function k(t){if(t.preventDefault(),r!==f){i("Passwords do not match.");return}j(()=>D(l,{setupCode:n,username:d,discordId:p,password:r}))}function A(t){t.preventDefault(),o&&j(async()=>I(l,{setupCode:n,fileName:o.name,yaml:await o.text()}))}return e.jsxs("div",{className:"min-h-screen bg-neutral-950 p-1 text-slate-100",children:[e.jsx(P,{}),e.jsxs("main",{className:"mx-auto flex min-h-screen w-full max-w-3xl flex-col justify-center gap-0.5",children:[e.jsxs(c,{title:"MultiRover setup",meta:a===null?"checking":a?"required":"complete",bodyClassName:"space-y-0.5 p-1 text-sm",children:[a?e.jsx("p",{children:"Enter the one-time code from setup-code.txt in the server data folder, then create the first lockdown administrator or import an existing configuration."}):null,a===!1?e.jsx(q,{className:"button-dark inline-block",to:"/admin",children:"Open administration"}):null,g?e.jsx("p",{className:"surface p-1 text-sm text-slate-200",children:g}):null]}),a?e.jsxs(e.Fragment,{children:[e.jsxs(c,{title:"Setup authorization",bodyClassName:"p-1",children:[e.jsx("label",{className:"block text-xs font-semibold text-slate-200",children:"One-time setup code"}),e.jsx("input",{className:"field-input mt-0.5 w-full font-mono",value:n,onChange:t=>b(t.target.value)})]}),e.jsx(c,{title:"Create first administrator",bodyClassName:"p-1",children:e.jsxs("form",{className:"grid gap-0.5 md:grid-cols-2",onSubmit:k,children:[e.jsx("input",{className:"field-input",placeholder:"Username",value:d,onChange:t=>C(t.target.value)}),e.jsx("input",{className:"field-input",placeholder:"Discord id (optional)",value:p,onChange:t=>N(t.target.value)}),e.jsx("input",{className:"field-input",type:"password",placeholder:"Password",value:r,onChange:t=>S(t.target.value)}),e.jsx("input",{className:"field-input",type:"password",placeholder:"Confirm password",value:f,onChange:t=>v(t.target.value)}),e.jsx("button",{className:"button-dark md:col-span-2",type:"submit",disabled:x||!n||!d||!r,children:"Create lockdown administrator"})]})}),e.jsxs(c,{title:"Import configuration file",bodyClassName:"space-y-0.5 p-1 text-sm",children:[e.jsx("p",{className:"text-xs text-slate-400",children:"Choose an existing YAML configuration explicitly. The server validates and imports it once, and its secrets are never displayed back in the browser."}),e.jsxs("form",{className:"flex flex-col gap-0.5 md:flex-row",onSubmit:A,children:[e.jsx("input",{className:"field-input flex-1",type:"file",accept:".yaml,.yml,text/yaml",onChange:t=>w(t.target.files?.[0]||null)}),e.jsx("button",{className:"button-dark",type:"submit",disabled:x||!n||!o,children:"Import selected YAML"})]})]})]}):null]})]})}export{R as default};
|
||||||
//# sourceMappingURL=SetupApp-C2cP8ApY.js.map
|
//# sourceMappingURL=SetupApp-Ya006OtX.js.map
|
||||||
+1
-1
File diff suppressed because one or more lines are too long
@@ -0,0 +1,2 @@
|
|||||||
|
function o(t,i,a={}){return new Promise((n,s)=>{t.emit(i,a,(e={})=>{if(e?.error){const r=new Error(e.error);r.code=e.code||null,r.validationErrors=e.validationErrors||[],r.currentRevision=e.currentRevision||null,s(r);return}n(e)})})}const c=t=>o(t,"adminConfig:get"),u=(t,i)=>o(t,"adminConfig:confirmPassword",{password:i}),d=(t,i)=>o(t,"adminConfig:updateConfiguration",i),p=(t,i)=>o(t,"adminConfig:importConfigurationFile",i),m=(t,i)=>o(t,"adminConfig:restoreRevision",i),l=(t,i)=>o(t,"adminConfig:createAdministrator",i),f=(t,i)=>o(t,"adminConfig:updateAdministrator",i),g=(t,i)=>o(t,"adminConfig:deleteAdministrator",{id:i}),A=t=>o(t,"server:restartApplication"),C=t=>o(t,"server:lifecycleStatus"),R=t=>o(t,"server:checkForUpdate"),k=t=>o(t,"server:updateApplication"),v=t=>o(t,"backupRestore:status"),F=t=>o(t,"backupRestore:createBackup"),S=t=>o(t,"backupRestore:createRestoreUpload"),b=(t,i)=>o(t,"backupRestore:confirmRestore",{restoreId:i}),h=t=>o(t,"setup:status"),w=(t,i)=>o(t,"setup:createAdministrator",i),U=(t,i)=>o(t,"setup:importConfigurationFile",i);export{A as a,R as b,l as c,g as d,k as e,v as f,C as g,F as h,S as i,b as j,d as k,p as l,c as m,u as n,h as o,w as p,U as q,m as r,f as u};
|
||||||
|
//# sourceMappingURL=api-B8GGCEeo.js.map
|
||||||
File diff suppressed because one or more lines are too long
@@ -1,2 +0,0 @@
|
|||||||
function n(t,i,a={}){return new Promise((e,s)=>{t.emit(i,a,(r={})=>{if(r?.error){const o=new Error(r.error);o.code=r.code||null,o.validationErrors=r.validationErrors||[],o.currentRevision=r.currentRevision||null,s(o);return}e(r)})})}const d=t=>n(t,"adminConfig:get"),m=(t,i)=>n(t,"adminConfig:confirmPassword",{password:i}),u=(t,i)=>n(t,"adminConfig:updateConfiguration",i),c=(t,i)=>n(t,"adminConfig:restoreRevision",i),f=(t,i)=>n(t,"adminConfig:createAdministrator",i),g=(t,i)=>n(t,"adminConfig:updateAdministrator",i),C=(t,i)=>n(t,"adminConfig:deleteAdministrator",{id:i}),A=t=>n(t,"setup:status"),l=(t,i)=>n(t,"setup:createAdministrator",i),p=(t,i)=>n(t,"setup:importConfigurationFile",i);export{u as a,m as b,f as c,C as d,A as e,l as f,d as g,p as i,c as r,g as u};
|
|
||||||
//# sourceMappingURL=api-C0PIt_OP.js.map
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
{"version":3,"file":"api-C0PIt_OP.js","sources":["../../../webui/src/admin/api.js"],"sourcesContent":["// Admin Socket API\n// Purpose: Gives the setup and administration applications one promise-based boundary around acknowledged socket events.\n// Scope: Preserves server error codes and validation details so shared UI infrastructure can respond consistently.\nexport function emitAdminRequest(socket, eventName, payload = {}) {\n return new Promise((resolve, reject) => {\n socket.emit(eventName, payload, (response = {}) => {\n if (response?.error) {\n const error = new Error(response.error);\n error.code = response.code || null;\n error.validationErrors = response.validationErrors || [];\n error.currentRevision = response.currentRevision || null;\n reject(error);\n return;\n }\n resolve(response);\n });\n });\n}\n\nexport const getAdminSnapshot = (socket) => emitAdminRequest(socket, 'adminConfig:get');\nexport const confirmAdminPassword = (socket, password) => emitAdminRequest(socket, 'adminConfig:confirmPassword', { password });\nexport const updateConfiguration = (socket, payload) => emitAdminRequest(socket, 'adminConfig:updateConfiguration', payload);\nexport const restoreConfigurationRevision = (socket, payload) => emitAdminRequest(socket, 'adminConfig:restoreRevision', payload);\nexport const createAdministrator = (socket, payload) => emitAdminRequest(socket, 'adminConfig:createAdministrator', payload);\nexport const updateAdministrator = (socket, payload) => emitAdminRequest(socket, 'adminConfig:updateAdministrator', payload);\nexport const deleteAdministrator = (socket, id) => emitAdminRequest(socket, 'adminConfig:deleteAdministrator', { id });\n\nexport const getSetupStatus = (socket) => emitAdminRequest(socket, 'setup:status');\nexport const createFirstAdministrator = (socket, payload) => emitAdminRequest(socket, 'setup:createAdministrator', payload);\nexport const importConfigurationFile = (socket, payload) => emitAdminRequest(socket, 'setup:importConfigurationFile', payload);\n"],"names":["emitAdminRequest","socket","eventName","payload","resolve","reject","response","error","getAdminSnapshot","confirmAdminPassword","password","updateConfiguration","restoreConfigurationRevision","createAdministrator","updateAdministrator","deleteAdministrator","id","getSetupStatus","createFirstAdministrator","importConfigurationFile"],"mappings":"AAGO,SAASA,EAAiBC,EAAQC,EAAWC,EAAU,CAAA,EAAI,CAChE,OAAO,IAAI,QAAQ,CAACC,EAASC,IAAW,CACtCJ,EAAO,KAAKC,EAAWC,EAAS,CAACG,EAAW,CAAA,IAAO,CACjD,GAAIA,GAAU,MAAO,CACnB,MAAMC,EAAQ,IAAI,MAAMD,EAAS,KAAK,EACtCC,EAAM,KAAOD,EAAS,MAAQ,KAC9BC,EAAM,iBAAmBD,EAAS,kBAAoB,CAAA,EACtDC,EAAM,gBAAkBD,EAAS,iBAAmB,KACpDD,EAAOE,CAAK,EACZ,MACF,CACAH,EAAQE,CAAQ,CAClB,CAAC,CACH,CAAC,CACH,CAEY,MAACE,EAAoBP,GAAWD,EAAiBC,EAAQ,iBAAiB,EACzEQ,EAAuB,CAACR,EAAQS,IAAaV,EAAiBC,EAAQ,8BAA+B,CAAE,SAAAS,CAAQ,CAAE,EACjHC,EAAsB,CAACV,EAAQE,IAAYH,EAAiBC,EAAQ,kCAAmCE,CAAO,EAC9GS,EAA+B,CAACX,EAAQE,IAAYH,EAAiBC,EAAQ,8BAA+BE,CAAO,EACnHU,EAAsB,CAACZ,EAAQE,IAAYH,EAAiBC,EAAQ,kCAAmCE,CAAO,EAC9GW,EAAsB,CAACb,EAAQE,IAAYH,EAAiBC,EAAQ,kCAAmCE,CAAO,EAC9GY,EAAsB,CAACd,EAAQe,IAAOhB,EAAiBC,EAAQ,kCAAmC,CAAE,GAAAe,CAAE,CAAE,EAExGC,EAAkBhB,GAAWD,EAAiBC,EAAQ,cAAc,EACpEiB,EAA2B,CAACjB,EAAQE,IAAYH,EAAiBC,EAAQ,4BAA6BE,CAAO,EAC7GgB,EAA0B,CAAClB,EAAQE,IAAYH,EAAiBC,EAAQ,gCAAiCE,CAAO"}
|
|
||||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,2 @@
|
|||||||
|
function u(i){return class extends i{_playedRanges=[];_currentPlayedRange=null;_RANGE_EPSILON=.5;_seeking=!1;connectedCallback(){super.connectedCallback&&super.connectedCallback(),this.addEventListener("play",()=>this.onPlaybackStart({time:this.currentTime})),this.addEventListener("pause",()=>this.onPlaybackStop({time:this.currentTime})),this.addEventListener("ended",()=>this.onPlaybackStop({time:this.currentTime})),this.addEventListener("seeking",()=>this.onSeeking()),this.addEventListener("seeked",()=>this.onSeeked({time:this.currentTime}))}onPlaybackStart(e={}){this._seeking=!1;const{time:t}=e,n=typeof t=="number"?t:this.currentTime;this._currentPlayedRange||(this._currentPlayedRange={start:n,end:n})}onSeeking(){this._seeking=!0,this._commitCurrentRange()}onSeeked(e={}){this._seeking=!1;const{time:t}=e,n=typeof t=="number"?t:this.currentTime;this._currentPlayedRange={start:n,end:n}}onPlaybackStop(e={}){const{time:t}=e,n=typeof t=="number"?t:this.currentTime;this._commitCurrentRange(n)}_commitCurrentRange(e){if(!this._currentPlayedRange)return;typeof e=="number"&&(this._currentPlayedRange.end=e);const{start:t,end:n}=this._currentPlayedRange;this._currentPlayedRange=null,this.addPlayedRange(t,n)}addPlayedRange(e,t){if(e>=t)return;const n=this._RANGE_EPSILON,c=[...this._playedRanges,{start:e,end:t}];c.sort((a,s)=>a.start-s.start);const r=[];for(const a of c){if(!r.length){r.push({...a});continue}const s=r[r.length-1];a.start<=s.end+n?(s.start=Math.min(s.start,a.start),s.end=Math.max(s.end,a.end)):r.push({...a})}this._playedRanges=r}get played(){const e=this.currentTime;return!this.paused&&!this._currentPlayedRange&&typeof e=="number"&&(this._currentPlayedRange={start:e,end:e}),this._currentPlayedRange&&typeof e=="number"&&(e>this._currentPlayedRange.end&&(this._currentPlayedRange.end=e),this.addPlayedRange(this._currentPlayedRange.start,this._currentPlayedRange.end)),this._playedRanges.length?l(this._playedRanges.map(t=>[t.start,t.end])):l([[0,0]])}}}function l(i){return Object.defineProperties(i,{start:{value:d=>i[d][0]},end:{value:d=>i[d][1]}}),i}export{u as M};
|
||||||
|
//# sourceMappingURL=index-B4nclofW.js.map
|
||||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+7
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+7
@@ -0,0 +1,7 @@
|
|||||||
|
import{_ as N,R as A}from"./index-dJH5nUWV.js";import{M as D,C as S}from"./mixin-BY5xW4uI.js";class P extends D(S){static shadowRootOptions={...S.shadowRootOptions};static getTemplateHTML=i=>{const{src:n,...o}=i;return S.getTemplateHTML(o)};#t;attributeChangedCallback(i,n,o){i!=="src"&&super.attributeChangedCallback(i,n,o),i==="src"&&n!=o&&this.load()}async _initThumbnails(i){const n=async(d,m)=>{const v=[],g=i.timescale||1,h=i.startNumber||1,E=i.presentationTimeOffset?i.presentationTimeOffset/g:0,_=i.segmentDuration;for(let l=0;l<d;l++){const T=C({thIndex:l,thduration:m,ttiles:d,tduration:_,startNumber:h,pto:E}),w=T+m,M=new Promise((f,y)=>{this.api.provideThumbnail(T,({url:a,width:s,height:c,x:p,y:b})=>{try{const R=new VTTCue(T,w,`${a}#xywh=${p},${b},${s},${c}`);f(R)}catch(R){y(R)}})});v.push(M)}return await Promise.all(v).catch(l=>console.error("Error processing thumbnails",l))},{totalThumbnails:o,thumbnailDuration:e}=$(i),u=await n(o,e);let r=this.nativeEl.querySelector('track[label="thumbnails"]');if(!r){r=O(),this.nativeEl.appendChild(r);const d=x(u);r.src=d,r.dispatchEvent(new Event("change"))}}async load(){if(this.#t){this.api.attachSource(this.src);return}this.#t=!0;const i=await N(()=>import("./dash.all.min-C9gxBrL1.js"),[]);this.api=i.MediaPlayer().create(),this.api.initialize(this.nativeEl,this.src,this.autoplay),this.api.on(i.MediaPlayer.events.STREAM_INITIALIZED,()=>{const n=this.api.getRepresentationsByType("video");let o=this.videoTracks.getTrackById("main");o||(o=this.addVideoTrack("main"),o.id="main",o.selected=!0),n.forEach(e=>{const u=e.bandwidth??e.bitrate??(Number.isFinite(e.bitrateInKbit)?e.bitrateInKbit*1e3:void 0),r=o.addRendition(e.id,e.width,e.height,e.mimeType??e.codec,u);r.id=e.id}),this.videoRenditions.addEventListener("change",()=>{const e=this.videoRenditions[this.videoRenditions.selectedIndex];e?.id?(this.api.updateSettings({streaming:{abr:{autoSwitchBitrate:{video:!1}}}}),this.api.setRepresentationForTypeById("video",e.id,!0)):this.api.updateSettings({streaming:{abr:{autoSwitchBitrate:{video:!0}}}})}),this.api.isDynamic()||this.api.getRepresentationsByType("image").forEach(async(u,r)=>{r>0||this._initThumbnails(u)})})}}function $(t){var i,n;const o=t.essentialProperties[0],[e,u]=o.value.split("x").map(Number),r=e*u,d=((n=(i=t.adaptation)==null?void 0:i.period)==null?void 0:n.duration)||null,m=t.segmentDuration,v=t.timescale||1,h=m/v/r;return{totalThumbnails:d!=null?Math.ceil(d/h):Math.ceil(m/h),thumbnailDuration:h}}function C({thIndex:t,tduration:i,thduration:n,ttiles:o,startNumber:e,pto:u}){const r=Math.floor(t/o)+e,d=t%o+1,m=(r-1)*i-u,v=(d-1)*n;return m+v}function O(){const t=document.createElement("track");return t.kind="metadata",t.label="thumbnails",t.srclang="en",t.mode="hidden",t.default=!0,t}function x(t){let i=`WEBVTT
|
||||||
|
|
||||||
|
`;for(const e of t)i+=`${o(e.startTime)} --> ${o(e.endTime)}
|
||||||
|
`,i+=`${e.text}
|
||||||
|
|
||||||
|
`;const n=new Blob([i],{type:"text/vtt"});return URL.createObjectURL(n);function o(e){const u=String(Math.floor(e/3600)).padStart(2,"0"),r=String(Math.floor(e%3600/60)).padStart(2,"0"),d=(e%60).toFixed(3).padStart(6,"0");return`${u}:${r}:${d}`}}globalThis.customElements&&!globalThis.customElements.get("dash-video")&&globalThis.customElements.define("dash-video",P);var B=P,H=new Set(["style","children","ref","key","suppressContentEditableWarning","suppressHydrationWarning","dangerouslySetInnerHTML"]),F={className:"class",htmlFor:"for"};function I(t){return t.toLowerCase()}function k(t){if(typeof t=="boolean")return t?"":void 0;if(typeof t!="function"&&!(typeof t=="object"&&t!==null))return t}function W({react:t,tagName:i,elementClass:n,events:o,displayName:e,defaultProps:u,toAttributeName:r=I,toAttributeValue:d=k}){const m=Number.parseInt(t.version)>=19,v=t.forwardRef((g,h)=>{var E,_;const l=t.useRef(null),T=t.useRef(new Map),w={},M={},f={},y={};for(const[a,s]of Object.entries(g)){if(H.has(a)){f[a]=s;continue}const c=r(F[a]??a);if(n.prototype&&a in n.prototype&&!(a in(((E=globalThis.HTMLElement)==null?void 0:E.prototype)??{}))&&!((_=n.observedAttributes)!=null&&_.some(b=>b===c))){y[a]=s;continue}if(a.startsWith("on")){w[a]=s;continue}const p=d(s);if(c&&p!=null&&(M[c]=String(p),m||(f[c]=p)),c&&m){const b=k(s);p!==b?f[c]=p:f[c]=s}}if(typeof window<"u"){for(const a in w){const s=w[a],c=a.endsWith("Capture"),p=(o?.[a]??a.slice(2).toLowerCase()).slice(0,c?-7:void 0);t.useLayoutEffect(()=>{const b=l?.current;if(!(!b||typeof s!="function"))return b.addEventListener(p,s,c),()=>{b.removeEventListener(p,s,c)}},[l?.current,s])}t.useLayoutEffect(()=>{if(l.current===null)return;const a=new Map;for(const s in y)L(l.current,s,y[s]),T.current.delete(s),a.set(s,y[s]);for(const[s,c]of T.current)L(l.current,s,void 0);T.current=a})}if(typeof window>"u"&&n?.getTemplateHTML&&n?.shadowRootOptions){const{mode:a,delegatesFocus:s}=n.shadowRootOptions,c=t.createElement("template",{shadowrootmode:a,shadowrootdelegatesfocus:s,dangerouslySetInnerHTML:{__html:n.getTemplateHTML(M,g)},key:"ce-la-react-ssr-template-shadow-root"});f.children=[c,f.children]}return t.createElement(i,{...u,...f,ref:t.useCallback(a=>{l.current=a,typeof h=="function"?h(a):h!==null&&(h.current=a)},[h])},f.children)});return v.displayName=e??n.name,v}function L(t,i,n){var o;t[i]=n,n==null&&i in(((o=globalThis.HTMLElement)==null?void 0:o.prototype)??{})&&t.removeAttribute(i)}var V=W({react:A,tagName:"dash-video",elementClass:B,toAttributeName(t){return t==="muted"?"":t==="defaultMuted"?"muted":I(t)}});export{V as default};
|
||||||
|
//# sourceMappingURL=react-C61Q8sy9.js.map
|
||||||
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+35
@@ -0,0 +1,35 @@
|
|||||||
|
import{R as W}from"./index-dJH5nUWV.js";const $=["abort","canplay","canplaythrough","durationchange","emptied","encrypted","ended","error","loadeddata","loadedmetadata","loadstart","pause","play","playing","progress","ratechange","seeked","seeking","stalled","suspend","timeupdate","volumechange","waiting","waitingforkey","resize","enterpictureinpicture","leavepictureinpicture","webkitbeginfullscreen","webkitendfullscreen","webkitpresentationmodechanged"],A=globalThis.document?.createElement("template");A&&(A.innerHTML=`
|
||||||
|
<style>
|
||||||
|
:host {
|
||||||
|
display: inline-block;
|
||||||
|
line-height: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
video,
|
||||||
|
audio {
|
||||||
|
max-width: 100%;
|
||||||
|
max-height: 100%;
|
||||||
|
min-width: 100%;
|
||||||
|
min-height: 100%;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
<slot></slot>
|
||||||
|
`);const N=(i,{tag:t,is:s})=>{const d=globalThis.document?.createElement(t,{is:s}),f=d?S(d):[];return class g extends i{static Events=$;static template=A;static skipAttributes=[];static#t;static get observedAttributes(){return g.#l(),[...d?.constructor?.observedAttributes??[],"autopictureinpicture","disablepictureinpicture","disableremoteplayback","autoplay","controls","controlslist","crossorigin","loop","muted","playsinline","poster","preload","src"]}static#l(){if(this.#t)return;this.#t=!0;const e=new Set(this.observedAttributes);e.delete("muted");for(let o of f){if(o in this.prototype)continue;if(typeof d[o]=="function")this.prototype[o]=function(...r){this.#e();const a=()=>this.call?this.call(o,...r):this.nativeEl[o].apply(this.nativeEl,r);return this.loadComplete&&!this.isLoaded?this.loadComplete.then(a):a()};else{let r={get(){this.#e();let a=o.toLowerCase();if(e.has(a)){const p=this.getAttribute(a);return p===null?!1:p===""?!0:p}return this.get?.(o)??this.nativeEl?.[o]??this.#s[o]}};o!==o.toUpperCase()&&(r.set=async function(a){this.#e();let p=o.toLowerCase();if(e.has(p)){a===!0||a===!1||a==null?this.toggleAttribute(p,!!a):this.setAttribute(p,a);return}if(this.loadComplete&&!this.isLoaded&&await this.loadComplete,this.set){this.set(o,a);return}this.nativeEl[o]=a}),Object.defineProperty(this.prototype,o,r)}}}#o;#n;#r=!1;#i=!1;#a;#s;constructor(){super(),this.shadowRoot||(this.attachShadow({mode:"open"}),this.shadowRoot.append(this.constructor.template.content.cloneNode(!0))),this.load!==g.prototype.load&&(this.loadComplete=new O)}get loadComplete(){return this.#n}set loadComplete(e){this.#i=!1,this.#n=e,e?.then(()=>{this.#i=!0})}get isLoaded(){return this.#i}get nativeEl(){return this.#a??this.shadowRoot.querySelector(t)??this.querySelector(t)}set nativeEl(e){this.#a=e}get defaultMuted(){return this.hasAttribute("muted")}set defaultMuted(e){this.toggleAttribute("muted",!!e)}get src(){return this.getAttribute("src")}set src(e){this.setAttribute("src",`${e}`)}get preload(){return this.getAttribute("preload")??this.nativeEl?.preload}set preload(e){this.setAttribute("preload",`${e}`)}async#e(){if(this.#o)return;this.#o=!0,this.#u(),this.#c();for(let u of f)this.#d(u);const e=new Map,o=this.shadowRoot.querySelector("slot:not([name])");o?.addEventListener("slotchange",()=>{const u=new Map(e);o.assignedElements().filter(r=>["track","source"].includes(r.localName)).forEach(async r=>{u.delete(r);let a=e.get(r);a||(a=r.cloneNode(),e.set(r,a)),this.loadComplete&&!this.isLoaded&&await this.loadComplete,this.nativeEl.append?.(a)}),u.forEach(r=>r.remove())});for(let u of this.constructor.Events)this.shadowRoot.addEventListener?.(u,r=>{r.target===this.nativeEl&&this.dispatchEvent(new CustomEvent(r.type,{detail:r.detail}))},!0)}#d(e){if(Object.prototype.hasOwnProperty.call(this,e)){const o=this[e];delete this[e],this[e]=o}}#u(){const e=document.createElement(t,{is:s});e.muted=this.hasAttribute("muted");for(let{name:o,value:u}of this.attributes)e.setAttribute(o,u);this.#s={};for(let o of S(e))this.#s[o]=e[o];e.removeAttribute("src"),e.load()}async#c(){if(this.loadComplete&&!this.isLoaded&&await this.loadComplete,!this.nativeEl){const e=document.createElement(t,{is:s});e.part=t,this.shadowRoot.append(e)}this.nativeEl.muted=this.hasAttribute("muted")}attributeChangedCallback(e,o,u){this.#e(),e==="src"&&this.load!==g.prototype.load&&this.#h(),this.#p(e,o,u)}async#h(){this.#r&&(this.loadComplete=new O),this.#r=!0,await Promise.resolve(),await this.load(),this.loadComplete?.resolve(),await this.loadComplete}async#p(e,o,u){this.loadComplete&&!this.isLoaded&&await this.loadComplete,!["id","class",...this.constructor.skipAttributes].includes(e)&&(u===null?this.nativeEl.removeAttribute?.(e):this.nativeEl.setAttribute?.(e,u))}connectedCallback(){this.#e()}}};function S(i){let t=[];for(let s=Object.getPrototypeOf(i);s&&s!==HTMLElement.prototype;s=Object.getPrototypeOf(s))t.push(...Object.getOwnPropertyNames(s));return t}class O extends Promise{constructor(t=()=>{}){let s,d;super((f,c)=>{t(f,c),s=f,d=c}),this.resolve=s,this.reject=d}}const B=globalThis.document?N(HTMLElement,{tag:"video"}):class{};globalThis.document&&N(HTMLElement,{tag:"audio"});var H,R;const L=(H=globalThis.document)==null?void 0:H.createElement("template");L&&(L.innerHTML=`
|
||||||
|
<div class="wistia_embed"></div>
|
||||||
|
`);const P=(R=globalThis.document)==null?void 0:R.createElement("template");P&&(P.innerHTML=`
|
||||||
|
<style>
|
||||||
|
:host {
|
||||||
|
display: inline-block;
|
||||||
|
min-width: 300px;
|
||||||
|
min-height: 150px;
|
||||||
|
position: relative;
|
||||||
|
}
|
||||||
|
::slotted(.wistia_embed) {
|
||||||
|
position: absolute;
|
||||||
|
width: 100%;
|
||||||
|
height: 100%;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
<slot></slot>
|
||||||
|
`);function D(i,t){if(Object.hasOwn(i,t)){const s=i[t];delete i[t],i[t]=s}}class q extends B{static template=P;static skipAttributes=["src"];#t=null;constructor(){super(),D(this,"config")}get config(){return this.#t}set config(t){this.#t=t}get nativeEl(){var t;return((t=this.api)==null?void 0:t.elem())??this.querySelector("video")}async load(){var t;if((t=this.querySelector(".wistia_embed"))==null||t.remove(),!this.src)return;await new Promise(o=>setTimeout(o,50));const s=/(?:wistia\.com|wi\.st)\/(?:medias|embed)\/(.*)$/i,d=this.src.match(s)[1],f={autoPlay:this.autoplay,silentAutoPlay:this.autoplay?"allow":void 0,preload:this.preload??"metadata",playsinline:this.playsInline,endVideoBehavior:this.loop?"loop":void 0,chromeless:!this.controls,playButton:this.controls,muted:this.defaultMuted,...this.#t??{}};this.append(L.content.cloneNode(!0));const c=this.querySelector(".wistia_embed");c.id||(c.id=z(d)),c.classList.add(`wistia_async_${d}`),await F("https://fast.wistia.com/assets/external/E-v1.js","Wistia"),this.api=await new Promise(o=>{globalThis._wq.push({id:c.id,onReady:o,options:f})})}async attributeChangedCallback(t,s,d){if(t==="controls"){switch(await this.loadComplete,t){case"controls":this.api.bigPlayButtonEnabled(this.controls),this.controls?this.api.releaseChromeless():this.api.requestChromeless();break}return}super.attributeChangedCallback(t,s,d)}get duration(){var t;return(t=this.api)==null?void 0:t.duration()}async play(){return await this.loadComplete,this.api.play(),new Promise(t=>this.addEventListener("playing",t))}}const T={};async function F(i,t){if(T[i])return T[i];if(self[t])return self[t];const s=new Promise((d,f)=>{const c=document.createElement("script");c.defer=!0,c.src=i,c.onload=()=>d(self[t]),c.onerror=f,document.head.append(c)});return T[i]=s,s}let U=0;function z(i){const t=++U;return`${i}${t}`}globalThis.customElements&&!globalThis.customElements.get("wistia-video")&&globalThis.customElements.define("wistia-video",q);var V=q,G=new Set(["style","children","ref","key","suppressContentEditableWarning","suppressHydrationWarning","dangerouslySetInnerHTML"]),J={className:"class",htmlFor:"for"};function I(i){return i.toLowerCase()}function j(i){if(typeof i=="boolean")return i?"":void 0;if(typeof i!="function"&&!(typeof i=="object"&&i!==null))return i}function K({react:i,tagName:t,elementClass:s,events:d,displayName:f,defaultProps:c,toAttributeName:e=I,toAttributeValue:o=j}){const u=Number.parseInt(i.version)>=19,r=i.forwardRef((a,p)=>{var M,k;const m=i.useRef(null),E=i.useRef(new Map),C={},_={},v={},w={};for(const[n,l]of Object.entries(a)){if(G.has(n)){v[n]=l;continue}const h=e(J[n]??n);if(s.prototype&&n in s.prototype&&!(n in(((M=globalThis.HTMLElement)==null?void 0:M.prototype)??{}))&&!((k=s.observedAttributes)!=null&&k.some(b=>b===h))){w[n]=l;continue}if(n.startsWith("on")){C[n]=l;continue}const y=o(l);if(h&&y!=null&&(_[h]=String(y),u||(v[h]=y)),h&&u){const b=j(l);y!==b?v[h]=y:v[h]=l}}if(typeof window<"u"){for(const n in C){const l=C[n],h=n.endsWith("Capture"),y=(d?.[n]??n.slice(2).toLowerCase()).slice(0,h?-7:void 0);i.useLayoutEffect(()=>{const b=m?.current;if(!(!b||typeof l!="function"))return b.addEventListener(y,l,h),()=>{b.removeEventListener(y,l,h)}},[m?.current,l])}i.useLayoutEffect(()=>{if(m.current===null)return;const n=new Map;for(const l in w)x(m.current,l,w[l]),E.current.delete(l),n.set(l,w[l]);for(const[l,h]of E.current)x(m.current,l,void 0);E.current=n})}if(typeof window>"u"&&s?.getTemplateHTML&&s?.shadowRootOptions){const{mode:n,delegatesFocus:l}=s.shadowRootOptions,h=i.createElement("template",{shadowrootmode:n,shadowrootdelegatesfocus:l,dangerouslySetInnerHTML:{__html:s.getTemplateHTML(_,a)},key:"ce-la-react-ssr-template-shadow-root"});v.children=[h,v.children]}return i.createElement(t,{...c,...v,ref:i.useCallback(n=>{m.current=n,typeof p=="function"?p(n):p!==null&&(p.current=n)},[p])},v.children)});return r.displayName=f??s.name,r}function x(i,t,s){var d;i[t]=s,s==null&&t in(((d=globalThis.HTMLElement)==null?void 0:d.prototype)??{})&&i.removeAttribute(t)}var X=K({react:W,tagName:"wistia-video",elementClass:V,toAttributeName(i){return i==="muted"?"":i==="defaultMuted"?"muted":I(i)}});export{X as default};
|
||||||
|
//# sourceMappingURL=react-CVBBC_mw.js.map
|
||||||
File diff suppressed because one or more lines are too long
+23
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+22
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+18
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -12,8 +12,8 @@
|
|||||||
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" />
|
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" />
|
||||||
<!-- site-metadata:inject -->
|
<!-- site-metadata:inject -->
|
||||||
<!-- analytics:inject -->
|
<!-- analytics:inject -->
|
||||||
<script type="module" crossorigin src="/assets/index-CqMkCfQw.js"></script>
|
<script type="module" crossorigin src="/assets/index-dJH5nUWV.js"></script>
|
||||||
<link rel="stylesheet" crossorigin href="/assets/index-1O6avznD.css">
|
<link rel="stylesheet" crossorigin href="/assets/index-DOmNOCX4.css">
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<div id="root"></div>
|
<div id="root"></div>
|
||||||
|
|||||||
@@ -6,11 +6,18 @@ const assert = require('node:assert/strict');
|
|||||||
const fs = require('fs');
|
const fs = require('fs');
|
||||||
const os = require('os');
|
const os = require('os');
|
||||||
const path = require('path');
|
const path = require('path');
|
||||||
|
const { execFileSync } = require('child_process');
|
||||||
|
const Database = require('better-sqlite3');
|
||||||
const { defaultConfig, normalizeConfig, assertValidConfig } = require('./validation');
|
const { defaultConfig, normalizeConfig, assertValidConfig } = require('./validation');
|
||||||
const { definitions, rootSchema, secretPaths, featureDefinitions } = require('./definition');
|
const { definitions, rootSchema, secretPaths, featureDefinitions } = require('./definition');
|
||||||
|
const { migrations } = require('./migrations');
|
||||||
const { getFeatureFlags } = require('./index');
|
const { getFeatureFlags } = require('./index');
|
||||||
const { createConfigurationDatabase } = require('./database');
|
const { createConfigurationDatabase } = require('./database');
|
||||||
const { parseConfigurationFile, importConfigurationFile } = require('./configurationFileImporter');
|
const {
|
||||||
|
parseConfigurationFile,
|
||||||
|
buildSecretOperationsForImport,
|
||||||
|
importConfigurationFile,
|
||||||
|
} = require('./configurationFileImporter');
|
||||||
|
|
||||||
const temporaryRoots = [];
|
const temporaryRoots = [];
|
||||||
|
|
||||||
@@ -166,6 +173,8 @@ test('service definitions generate public feature paths without a separate regis
|
|||||||
{ key: 'homeAssistant', path: ['homeAssistant', 'enabled'] },
|
{ key: 'homeAssistant', path: ['homeAssistant', 'enabled'] },
|
||||||
{ key: 'neato', path: ['homeAssistant', 'neato', 'enabled'] },
|
{ key: 'neato', path: ['homeAssistant', 'neato', 'enabled'] },
|
||||||
{ key: 'lift', path: ['homeAssistant', 'lift', 'enabled'] },
|
{ key: 'lift', path: ['homeAssistant', 'lift', 'enabled'] },
|
||||||
|
// Activities remain independently configurable from the shared connection.
|
||||||
|
{ key: 'homeAssistantActivities', path: ['homeAssistantActivities', 'enabled'] },
|
||||||
{ key: 'roomCameras', path: ['roomCameras', 'enabled'] },
|
{ key: 'roomCameras', path: ['roomCameras', 'enabled'] },
|
||||||
{ key: 'ptzCamera', path: ['ptzCamera', 'enabled'] },
|
{ key: 'ptzCamera', path: ['ptzCamera', 'enabled'] },
|
||||||
{ key: 'kinect', path: ['kinect', 'enabled'] },
|
{ key: 'kinect', path: ['kinect', 'enabled'] },
|
||||||
@@ -175,6 +184,7 @@ test('service definitions generate public feature paths without a separate regis
|
|||||||
{ key: 'discord', path: ['discord', 'enabled'] },
|
{ key: 'discord', path: ['discord', 'enabled'] },
|
||||||
{ key: 'socials', path: ['socials', 'enabled'] },
|
{ key: 'socials', path: ['socials', 'enabled'] },
|
||||||
{ key: 'fleetReports', path: ['fleetReports', 'enabled'] },
|
{ key: 'fleetReports', path: ['fleetReports', 'enabled'] },
|
||||||
|
{ key: 'roverLearning', path: ['roverLearning', 'enabled'] },
|
||||||
]);
|
]);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -210,14 +220,12 @@ test('generated feature flags use only each declared enabled switch', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test('normalization fills missing legacy fields but strict validation rejects unknown fields', () => {
|
test('normalization fills missing legacy fields but strict validation rejects unknown fields', () => {
|
||||||
const normalized = normalizeConfig({ media: { whepBaseUrl: 'http://localhost:8889/video' } });
|
const normalized = normalizeConfig({ media: { additionalHosts: [] } });
|
||||||
// Missing fields now receive the same populated template defaults as a new
|
assert.equal(normalized.publicUrl, 'https://rover.example.com');
|
||||||
// installation; normalization must not silently revert this one collection
|
assert.deepEqual(normalized.media.additionalHosts, []);
|
||||||
// to the former empty-safe-default policy.
|
|
||||||
assert.deepEqual(normalized.media.additionalHosts, ['rover.example.com', 'media-server.local']);
|
|
||||||
assert.doesNotThrow(() => assertValidConfig(normalized));
|
assert.doesNotThrow(() => assertValidConfig(normalized));
|
||||||
|
|
||||||
const invalid = normalizeConfig({ media: { whepBaseUrl: 'http://localhost:8889/video', misspelledHost: 'x' } });
|
const invalid = normalizeConfig({ media: { additionalHosts: [], misspelledHost: 'x' } });
|
||||||
assert.throws(() => assertValidConfig(invalid), (error) => {
|
assert.throws(() => assertValidConfig(invalid), (error) => {
|
||||||
assert.equal(error.code, 'CONFIG_VALIDATION_FAILED');
|
assert.equal(error.code, 'CONFIG_VALIDATION_FAILED');
|
||||||
assert.ok(error.validationErrors.some((entry) => entry.path.includes('misspelledHost')));
|
assert.ok(error.validationErrors.some((entry) => entry.path.includes('misspelledHost')));
|
||||||
@@ -225,6 +233,40 @@ test('normalization fills missing legacy fields but strict validation rejects un
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('database migration consolidates existing public URLs and removes obsolete media addressing', () => {
|
||||||
|
const root = fs.mkdtempSync(path.join(os.tmpdir(), 'multirover-public-url-migration-'));
|
||||||
|
temporaryRoots.push(root);
|
||||||
|
const databasePath = path.join(root, 'configuration.sqlite');
|
||||||
|
const legacyDatabase = new Database(databasePath);
|
||||||
|
legacyDatabase.exec(`
|
||||||
|
CREATE TABLE schema_migrations (version INTEGER PRIMARY KEY, applied_at INTEGER NOT NULL);
|
||||||
|
${migrations[0].sql}
|
||||||
|
`);
|
||||||
|
legacyDatabase.prepare('INSERT INTO schema_migrations (version, applied_at) VALUES (1, ?)').run(Date.now());
|
||||||
|
|
||||||
|
const legacyConfig = structuredClone(defaultConfig);
|
||||||
|
delete legacyConfig.publicUrl;
|
||||||
|
legacyConfig.interInstance.profile.publicUrl = 'https://rover.example.com';
|
||||||
|
legacyConfig.discord.enabled = true;
|
||||||
|
legacyConfig.discord.siteUrl = 'https://canonical.example.com';
|
||||||
|
legacyConfig.media.whepBaseUrl = 'http://127.0.0.1:8889/video';
|
||||||
|
const inserted = legacyDatabase.prepare(`
|
||||||
|
INSERT INTO configuration_revisions (config_json, created_at, actor, source)
|
||||||
|
VALUES (?, ?, 'test', 'legacy-shape')
|
||||||
|
`).run(JSON.stringify(legacyConfig), Date.now());
|
||||||
|
legacyDatabase.prepare('INSERT INTO configuration_state (singleton, active_revision_id) VALUES (1, ?)')
|
||||||
|
.run(inserted.lastInsertRowid);
|
||||||
|
legacyDatabase.close();
|
||||||
|
|
||||||
|
const migrated = createConfigurationDatabase({ databasePath });
|
||||||
|
const active = migrated.getActiveConfigurationRecord().config;
|
||||||
|
assert.equal(active.publicUrl, 'https://canonical.example.com');
|
||||||
|
assert.equal(Object.hasOwn(active.interInstance.profile, 'publicUrl'), false);
|
||||||
|
assert.equal(Object.hasOwn(active.discord, 'siteUrl'), false);
|
||||||
|
assert.equal(Object.hasOwn(active.media, 'whepBaseUrl'), false);
|
||||||
|
migrated.close();
|
||||||
|
});
|
||||||
|
|
||||||
test('full-document updates preserve secrets and reject a stale browser revision', () => {
|
test('full-document updates preserve secrets and reject a stale browser revision', () => {
|
||||||
const database = createTestDatabase();
|
const database = createTestDatabase();
|
||||||
const initial = database.getActiveConfigurationRecord();
|
const initial = database.getActiveConfigurationRecord();
|
||||||
@@ -286,6 +328,7 @@ admins:
|
|||||||
password_hash: "$2b$10$preservedHash"
|
password_hash: "$2b$10$preservedHash"
|
||||||
discord_id: "1234"
|
discord_id: "1234"
|
||||||
lockdown: true
|
lockdown: true
|
||||||
|
publicUrl: https://production.example.com
|
||||||
timezone: America/Chicago
|
timezone: America/Chicago
|
||||||
media:
|
media:
|
||||||
whepBaseUrl: http://localhost:8889/video
|
whepBaseUrl: http://localhost:8889/video
|
||||||
@@ -315,6 +358,7 @@ fleetReports:
|
|||||||
immediateCriticalAlerts: true
|
immediateCriticalAlerts: true
|
||||||
`;
|
`;
|
||||||
const parsed = parseConfigurationFile(yamlText);
|
const parsed = parseConfigurationFile(yamlText);
|
||||||
|
assert.equal(parsed.config.publicUrl, 'https://production.example.com');
|
||||||
assert.equal(parsed.config.timezone, 'America/Chicago');
|
assert.equal(parsed.config.timezone, 'America/Chicago');
|
||||||
assert.equal(parsed.administrators[0].passwordHash, '$2b$10$preservedHash');
|
assert.equal(parsed.administrators[0].passwordHash, '$2b$10$preservedHash');
|
||||||
assert.equal(Object.hasOwn(parsed.config.overseerControl, 'heartbeatMs'), false);
|
assert.equal(Object.hasOwn(parsed.config.overseerControl, 'heartbeatMs'), false);
|
||||||
@@ -353,3 +397,115 @@ bandwidthSavings:
|
|||||||
return true;
|
return true;
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('an administrative YAML replacement ignores accounts and only changes secrets present in the file', () => {
|
||||||
|
const database = createTestDatabase();
|
||||||
|
const initial = database.getClientConfiguration();
|
||||||
|
const seededRevision = database.updateConfiguration({
|
||||||
|
value: initial.config,
|
||||||
|
expectedRevision: initial.revision,
|
||||||
|
actor: 'secret-seed',
|
||||||
|
secretOperations: {
|
||||||
|
'homeAssistant.token': { action: 'replace', value: 'preserve-this-token' },
|
||||||
|
'ptzCamera.password': { action: 'replace', value: 'clear-this-password' },
|
||||||
|
'discord.token': { action: 'replace', value: 'replace-this-token' },
|
||||||
|
},
|
||||||
|
});
|
||||||
|
const yamlText = `
|
||||||
|
admins:
|
||||||
|
- this obsolete account entry is deliberately malformed
|
||||||
|
timezone: America/Chicago
|
||||||
|
ptzCamera:
|
||||||
|
password:
|
||||||
|
discord:
|
||||||
|
token: new-discord-token
|
||||||
|
`;
|
||||||
|
|
||||||
|
/*
|
||||||
|
An initialized installation treats the YAML as configuration data only.
|
||||||
|
Even malformed account data is ignored, while presence-aware secret
|
||||||
|
operations preserve an omitted credential, clear an explicit empty value,
|
||||||
|
and replace an explicit non-empty value.
|
||||||
|
*/
|
||||||
|
const parsed = parseConfigurationFile(yamlText, { includeAdministrators: false });
|
||||||
|
assert.deepEqual(parsed.administrators, []);
|
||||||
|
assert.equal(parsed.uploadedAdministratorCount, 1);
|
||||||
|
assert.deepEqual(parsed.providedSecretPaths, ['ptzCamera.password', 'discord.token']);
|
||||||
|
const revision = database.updateConfiguration({
|
||||||
|
value: parsed.config,
|
||||||
|
expectedRevision: seededRevision,
|
||||||
|
secretOperations: buildSecretOperationsForImport(parsed),
|
||||||
|
actor: 'admin-import-test',
|
||||||
|
source: 'admin-yaml:production.yaml',
|
||||||
|
});
|
||||||
|
|
||||||
|
const active = database.getActiveConfigurationRecord();
|
||||||
|
assert.equal(active.revision, revision);
|
||||||
|
assert.equal(active.source, 'admin-yaml:production.yaml');
|
||||||
|
assert.equal(active.config.homeAssistant.token, 'preserve-this-token');
|
||||||
|
assert.equal(active.config.ptzCamera.password, '');
|
||||||
|
assert.equal(active.config.discord.token, 'new-discord-token');
|
||||||
|
assert.equal(active.config.timezone, 'America/Chicago');
|
||||||
|
assert.equal(database.listAdministrators().length, 0);
|
||||||
|
database.close();
|
||||||
|
});
|
||||||
|
|
||||||
|
test('committed revisions replace the live snapshot and isolate service reload failures', () => {
|
||||||
|
const root = fs.mkdtempSync(path.join(os.tmpdir(), 'multirover-live-configuration-'));
|
||||||
|
temporaryRoots.push(root);
|
||||||
|
const serverRoot = path.resolve(__dirname, '../..');
|
||||||
|
const script = `
|
||||||
|
const configuration = require('./src/configuration');
|
||||||
|
const applied = [];
|
||||||
|
configuration.registerConfigurationHandler('timezone', (next, previous) => {
|
||||||
|
applied.push({ section: 'timezone', next, previous });
|
||||||
|
});
|
||||||
|
configuration.registerConfigurationHandler('media', () => {
|
||||||
|
throw new Error('simulated media reload failure');
|
||||||
|
});
|
||||||
|
const database = configuration.getConfigurationDatabase();
|
||||||
|
const record = database.getClientConfiguration();
|
||||||
|
const next = structuredClone(record.config);
|
||||||
|
next.timezone = 'America/Chicago';
|
||||||
|
next.media.additionalHosts = ['media.example.test'];
|
||||||
|
database.updateConfiguration({
|
||||||
|
value: next,
|
||||||
|
expectedRevision: record.revision,
|
||||||
|
actor: 'live-configuration-test',
|
||||||
|
});
|
||||||
|
configuration.applyCommittedConfiguration().then((application) => {
|
||||||
|
console.log(JSON.stringify({
|
||||||
|
application,
|
||||||
|
applied,
|
||||||
|
liveTimezone: configuration.loadConfig().timezone,
|
||||||
|
liveRevision: configuration.getRuntimeConfigurationRevision(),
|
||||||
|
}));
|
||||||
|
database.close();
|
||||||
|
});
|
||||||
|
`;
|
||||||
|
const output = execFileSync(process.execPath, ['-e', script], {
|
||||||
|
cwd: serverRoot,
|
||||||
|
env: { ...process.env, SERVER_DATA_DIR: root },
|
||||||
|
encoding: 'utf8',
|
||||||
|
});
|
||||||
|
const result = JSON.parse(output.trim());
|
||||||
|
|
||||||
|
/*
|
||||||
|
A failing integration remains visible in application status but cannot
|
||||||
|
roll back the valid revision or prevent an unrelated service from seeing
|
||||||
|
it. This is the central guarantee that makes live application usable on a
|
||||||
|
server where optional hardware may be offline during an ordinary edit.
|
||||||
|
*/
|
||||||
|
assert.equal(result.liveTimezone, 'America/Chicago');
|
||||||
|
assert.equal(result.liveRevision, result.application.revision);
|
||||||
|
assert.deepEqual(result.application.changedSections, ['timezone', 'media']);
|
||||||
|
assert.deepEqual(result.applied, [{
|
||||||
|
section: 'timezone',
|
||||||
|
next: 'America/Chicago',
|
||||||
|
previous: defaultConfig.timezone,
|
||||||
|
}]);
|
||||||
|
assert.deepEqual(result.application.services, [
|
||||||
|
{ section: 'timezone', status: 'applied' },
|
||||||
|
{ section: 'media', status: 'failed', error: 'simulated media reload failure' },
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|||||||
@@ -1,8 +1,44 @@
|
|||||||
// Configuration File Importer
|
// Configuration File Importer
|
||||||
// Purpose: Validates one YAML file deliberately uploaded during first-run setup and stores it in the configuration database.
|
// Purpose: Validates a deliberately uploaded legacy YAML file for first-run setup or an explicit administrative replacement.
|
||||||
// Scope: This is an explicit setup action only; startup and installation never search for or consume configuration files.
|
// Scope: Startup and installation never search for or consume configuration files; every import begins with a browser-selected file.
|
||||||
const yaml = require('js-yaml');
|
const yaml = require('js-yaml');
|
||||||
const { rootSchema, normalizeConfig, assertValidConfig } = require('./validation');
|
const {
|
||||||
|
rootSchema,
|
||||||
|
secretPaths,
|
||||||
|
normalizeConfig,
|
||||||
|
assertValidConfig,
|
||||||
|
} = require('./validation');
|
||||||
|
|
||||||
|
const MAX_CONFIGURATION_FILE_BYTES = 1024 * 1024;
|
||||||
|
|
||||||
|
function getAtPath(object, dottedPath) {
|
||||||
|
return String(dottedPath || '').split('.').filter(Boolean)
|
||||||
|
.reduce((value, key) => value?.[key], object);
|
||||||
|
}
|
||||||
|
|
||||||
|
function setAtPath(object, dottedPath, value) {
|
||||||
|
const parts = String(dottedPath || '').split('.').filter(Boolean);
|
||||||
|
let cursor = object;
|
||||||
|
parts.slice(0, -1).forEach((key) => {
|
||||||
|
cursor = cursor[key];
|
||||||
|
});
|
||||||
|
cursor[parts.at(-1)] = value;
|
||||||
|
}
|
||||||
|
|
||||||
|
function hasAtPath(object, dottedPath) {
|
||||||
|
/*
|
||||||
|
Presence, rather than truthiness, distinguishes an omitted legacy secret
|
||||||
|
from an explicitly empty one. An omitted credential must preserve the
|
||||||
|
running installation's value, while an empty YAML value deliberately
|
||||||
|
clears it through the same operation used by the schema form.
|
||||||
|
*/
|
||||||
|
let cursor = object;
|
||||||
|
for (const key of String(dottedPath || '').split('.').filter(Boolean)) {
|
||||||
|
if (cursor === null || typeof cursor !== 'object' || !Object.hasOwn(cursor, key)) return false;
|
||||||
|
cursor = cursor[key];
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
function keepCurrentSchemaFields(value, schema) {
|
function keepCurrentSchemaFields(value, schema) {
|
||||||
/*
|
/*
|
||||||
@@ -46,28 +82,65 @@ function normalizeUploadedAdministrator(entry, index) {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
function parseConfigurationFile(text) {
|
function parseConfigurationFile(text, { includeAdministrators = true } = {}) {
|
||||||
const parsed = yaml.load(String(text || ''));
|
const parsed = yaml.load(String(text || ''));
|
||||||
if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) {
|
if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) {
|
||||||
throw new Error('The configuration file must contain a YAML object.');
|
throw new Error('The configuration file must contain a YAML object.');
|
||||||
}
|
}
|
||||||
|
|
||||||
const administrators = Array.isArray(parsed.admins)
|
const uploadedAdministrators = Array.isArray(parsed.admins) ? parsed.admins : [];
|
||||||
? parsed.admins.map(normalizeUploadedAdministrator)
|
/*
|
||||||
|
First-run setup is the sole workflow allowed to create accounts from the
|
||||||
|
legacy file. An initialized server ignores the entire admins collection,
|
||||||
|
including obsolete or malformed entries, so importing configuration can
|
||||||
|
never rename accounts, replace password hashes, or remove the last
|
||||||
|
lockdown administrator.
|
||||||
|
*/
|
||||||
|
const administrators = includeAdministrators
|
||||||
|
? uploadedAdministrators.map(normalizeUploadedAdministrator)
|
||||||
: [];
|
: [];
|
||||||
const configInput = Object.fromEntries(
|
const configInput = Object.fromEntries(
|
||||||
Object.entries(parsed).filter(([key]) => key !== 'admins'),
|
Object.entries(parsed).filter(([key]) => key !== 'admins'),
|
||||||
);
|
);
|
||||||
|
secretPaths.forEach((secretPath) => {
|
||||||
|
/*
|
||||||
|
YAML commonly represents `token:` as null even though the application
|
||||||
|
models an unconfigured credential as an empty string. Translate null only
|
||||||
|
for known secret fields so a plainly empty legacy credential has the same
|
||||||
|
clear meaning as the admin form; null in any ordinary current field still
|
||||||
|
fails its schema normally.
|
||||||
|
*/
|
||||||
|
if (hasAtPath(configInput, secretPath) && getAtPath(configInput, secretPath) === null) {
|
||||||
|
setAtPath(configInput, secretPath, '');
|
||||||
|
}
|
||||||
|
});
|
||||||
const config = normalizeConfig(keepCurrentSchemaFields(configInput, rootSchema));
|
const config = normalizeConfig(keepCurrentSchemaFields(configInput, rootSchema));
|
||||||
|
const providedSecretPaths = secretPaths.filter((secretPath) => hasAtPath(configInput, secretPath));
|
||||||
|
|
||||||
// Filtering applies only to nonexistent keys. Values retained for current
|
// Filtering applies only to nonexistent keys. Values retained for current
|
||||||
// schema fields still have to satisfy every type, range, and format rule
|
// schema fields still have to satisfy every type, range, and format rule
|
||||||
// before the importer can atomically initialize the database.
|
// before the importer can atomically initialize the database.
|
||||||
assertValidConfig(config);
|
assertValidConfig(config);
|
||||||
if (!administrators.some((admin) => admin.role === 'lockdown')) {
|
return {
|
||||||
throw new Error('The configuration file must contain at least one lockdown administrator.');
|
config,
|
||||||
}
|
administrators,
|
||||||
return { config, administrators };
|
uploadedAdministratorCount: uploadedAdministrators.length,
|
||||||
|
providedSecretPaths,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function buildSecretOperationsForImport({ config, providedSecretPaths = [] }) {
|
||||||
|
return Object.fromEntries(providedSecretPaths.map((secretPath) => {
|
||||||
|
const value = getAtPath(config, secretPath);
|
||||||
|
/*
|
||||||
|
Current secret schemas are strings. Keeping this conversion beside the
|
||||||
|
importer produces the database's narrow replace/clear contract and
|
||||||
|
avoids granting the import route a way around ordinary secret handling.
|
||||||
|
*/
|
||||||
|
return value === ''
|
||||||
|
? [secretPath, { action: 'clear' }]
|
||||||
|
: [secretPath, { action: 'replace', value }];
|
||||||
|
}));
|
||||||
}
|
}
|
||||||
|
|
||||||
function importConfigurationFile({ text, database, actor = 'setup-file-upload', source = 'uploaded-config.yaml' }) {
|
function importConfigurationFile({ text, database, actor = 'setup-file-upload', source = 'uploaded-config.yaml' }) {
|
||||||
@@ -85,6 +158,8 @@ function importConfigurationFile({ text, database, actor = 'setup-file-upload',
|
|||||||
}
|
}
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
|
MAX_CONFIGURATION_FILE_BYTES,
|
||||||
parseConfigurationFile,
|
parseConfigurationFile,
|
||||||
|
buildSecretOperationsForImport,
|
||||||
importConfigurationFile,
|
importConfigurationFile,
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -161,7 +161,13 @@ function createConfigurationDatabase({ databasePath = DEFAULT_DATABASE_PATH } =
|
|||||||
return { ...record, ...redacted };
|
return { ...record, ...redacted };
|
||||||
}
|
}
|
||||||
|
|
||||||
function updateConfiguration({ value, expectedRevision, secretOperations = {}, actor }) {
|
function updateConfiguration({
|
||||||
|
value,
|
||||||
|
expectedRevision,
|
||||||
|
secretOperations = {},
|
||||||
|
actor,
|
||||||
|
source = 'admin-ui',
|
||||||
|
}) {
|
||||||
const active = getActiveConfigurationRecord();
|
const active = getActiveConfigurationRecord();
|
||||||
const candidate = clone(value);
|
const candidate = clone(value);
|
||||||
|
|
||||||
@@ -187,7 +193,12 @@ function createConfigurationDatabase({ databasePath = DEFAULT_DATABASE_PATH } =
|
|||||||
return commitRevisionTransaction(candidate, {
|
return commitRevisionTransaction(candidate, {
|
||||||
expectedRevision,
|
expectedRevision,
|
||||||
actor,
|
actor,
|
||||||
source: 'admin-ui',
|
/*
|
||||||
|
Administrative imports use this same safe update path but identify the
|
||||||
|
selected filename in revision and audit history. The source remains
|
||||||
|
server-controlled metadata and never contains configuration values.
|
||||||
|
*/
|
||||||
|
source,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -331,6 +342,16 @@ function createConfigurationDatabase({ databasePath = DEFAULT_DATABASE_PATH } =
|
|||||||
}));
|
}));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function recordAuditEvent(actor, action, details = {}) {
|
||||||
|
/*
|
||||||
|
Operational admin services need the same persistent audit trail as
|
||||||
|
configuration changes, but they must not gain access to the underlying
|
||||||
|
statement or database handle. This narrow method retains the existing
|
||||||
|
redacted-details contract at the database boundary.
|
||||||
|
*/
|
||||||
|
writeAudit(actor, action, details);
|
||||||
|
}
|
||||||
|
|
||||||
const importConfigurationFileTransaction = db.transaction(({ config, administrators, actor, source }) => {
|
const importConfigurationFileTransaction = db.transaction(({ config, administrators, actor, source }) => {
|
||||||
// A setup upload initializes an empty installation; it is deliberately not
|
// A setup upload initializes an empty installation; it is deliberately not
|
||||||
// a general-purpose replacement path for a running server's configuration.
|
// a general-purpose replacement path for a running server's configuration.
|
||||||
@@ -351,6 +372,15 @@ function createConfigurationDatabase({ databasePath = DEFAULT_DATABASE_PATH } =
|
|||||||
return importConfigurationFileTransaction(payload);
|
return importConfigurationFileTransaction(payload);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function backupDatabase(destinationPath) {
|
||||||
|
/*
|
||||||
|
SQLite's online backup API produces one coherent database file while the
|
||||||
|
live WAL-backed connection remains open. The backup service receives only
|
||||||
|
this narrow operation, never the private database handle.
|
||||||
|
*/
|
||||||
|
return db.backup(destinationPath);
|
||||||
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
databasePath,
|
databasePath,
|
||||||
getActiveConfigurationRecord,
|
getActiveConfigurationRecord,
|
||||||
@@ -366,7 +396,9 @@ function createConfigurationDatabase({ databasePath = DEFAULT_DATABASE_PATH } =
|
|||||||
countLockdownAdministrators,
|
countLockdownAdministrators,
|
||||||
isSetupComplete,
|
isSetupComplete,
|
||||||
listAuditEvents,
|
listAuditEvents,
|
||||||
|
recordAuditEvent,
|
||||||
importConfigurationFile,
|
importConfigurationFile,
|
||||||
|
backupDatabase,
|
||||||
close: () => db.close(),
|
close: () => db.close(),
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ const bandwidthSavings = require('../helpers/bandwidthSavings.configuration');
|
|||||||
const audioForward = require('../services/audioForwardService/configuration');
|
const audioForward = require('../services/audioForwardService/configuration');
|
||||||
const audioLevels = require('../services/audioLevelsService/configuration');
|
const audioLevels = require('../services/audioLevelsService/configuration');
|
||||||
const homeAssistant = require('../services/homeAssistantService/configuration');
|
const homeAssistant = require('../services/homeAssistantService/configuration');
|
||||||
|
const homeAssistantActivities = require('../services/homeAssistantActivitiesService/configuration');
|
||||||
const roomCameras = require('../services/roomCameraService/configuration');
|
const roomCameras = require('../services/roomCameraService/configuration');
|
||||||
const ptzCamera = require('../services/ptzCameraService/configuration');
|
const ptzCamera = require('../services/ptzCameraService/configuration');
|
||||||
const kinect = require('../services/kinectService/configuration');
|
const kinect = require('../services/kinectService/configuration');
|
||||||
@@ -21,6 +22,7 @@ const barcodeScanner = require('../services/barcodeScannerService/configuration'
|
|||||||
const commands = require('../services/operatorCommandService/configuration');
|
const commands = require('../services/operatorCommandService/configuration');
|
||||||
const discord = require('../services/discordBotService/configuration');
|
const discord = require('../services/discordBotService/configuration');
|
||||||
const fleetReports = require('../services/fleetReportService/configuration');
|
const fleetReports = require('../services/fleetReportService/configuration');
|
||||||
|
const roverLearning = require('../services/roverLearningService/configuration');
|
||||||
|
|
||||||
/*
|
/*
|
||||||
Object property order is preserved by JSON serialization and JSON Schema
|
Object property order is preserved by JSON serialization and JSON Schema
|
||||||
@@ -30,6 +32,7 @@ const fleetReports = require('../services/fleetReportService/configuration');
|
|||||||
those fragments are placed independently at their historical positions.
|
those fragments are placed independently at their historical positions.
|
||||||
*/
|
*/
|
||||||
const definitions = [
|
const definitions = [
|
||||||
|
sessionConfiguration.publicUrl,
|
||||||
sessionConfiguration.timezone,
|
sessionConfiguration.timezone,
|
||||||
interInstance,
|
interInstance,
|
||||||
llmCommentary,
|
llmCommentary,
|
||||||
@@ -40,6 +43,8 @@ const definitions = [
|
|||||||
audioForward,
|
audioForward,
|
||||||
audioLevels,
|
audioLevels,
|
||||||
homeAssistant,
|
homeAssistant,
|
||||||
|
// Activities own a separate catalog even though the HA connection is shared.
|
||||||
|
homeAssistantActivities,
|
||||||
roomCameras,
|
roomCameras,
|
||||||
ptzCamera,
|
ptzCamera,
|
||||||
kinect,
|
kinect,
|
||||||
@@ -51,6 +56,7 @@ const definitions = [
|
|||||||
sessionConfiguration.socials,
|
sessionConfiguration.socials,
|
||||||
sessionConfiguration.driverAd,
|
sessionConfiguration.driverAd,
|
||||||
fleetReports,
|
fleetReports,
|
||||||
|
roverLearning,
|
||||||
];
|
];
|
||||||
|
|
||||||
const defaultConfig = Object.fromEntries(
|
const defaultConfig = Object.fromEntries(
|
||||||
@@ -61,7 +67,7 @@ const properties = Object.fromEntries(
|
|||||||
);
|
);
|
||||||
const rootSchema = strictObject(properties, {
|
const rootSchema = strictObject(properties, {
|
||||||
title: 'Configuration',
|
title: 'Configuration',
|
||||||
description: 'Complete server configuration. Changes are validated and saved as one revision, then loaded when the application restarts.',
|
description: 'Complete server configuration. Changes are validated, saved as one revision, and applied live by reloading affected services.',
|
||||||
required: definitions.map(({ key }) => key),
|
required: definitions.map(({ key }) => key),
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -1,22 +1,34 @@
|
|||||||
// Configuration Service
|
// Configuration Service
|
||||||
// Purpose: Exposes the process-wide synchronous configuration snapshot and the underlying administration store.
|
// Purpose: Exposes the process-wide live configuration snapshot, service reload registry, and administration store.
|
||||||
// Scope: Keeps existing require-time startup semantics while making SQLite the only runtime configuration source.
|
// Scope: Makes SQLite the durable source while applying each committed revision coherently to the running process.
|
||||||
|
const EventEmitter = require('events');
|
||||||
|
const { isDeepStrictEqual } = require('util');
|
||||||
const { createConfigurationDatabase } = require('./database');
|
const { createConfigurationDatabase } = require('./database');
|
||||||
const { rootSchema, featureDefinitions } = require('./definition');
|
const { definitions, rootSchema, featureDefinitions } = require('./definition');
|
||||||
|
|
||||||
let singleton;
|
let singleton;
|
||||||
|
let runtimeConfiguration;
|
||||||
let runtimeConfigurationRevision = null;
|
let runtimeConfigurationRevision = null;
|
||||||
|
let applicationQueue = Promise.resolve();
|
||||||
|
let lastApplication = null;
|
||||||
|
const reloadHandlers = new Map();
|
||||||
|
const configurationEvents = new EventEmitter();
|
||||||
|
|
||||||
function getConfigurationDatabase() {
|
function getConfigurationDatabase() {
|
||||||
if (!singleton) {
|
if (!singleton) {
|
||||||
singleton = createConfigurationDatabase();
|
singleton = createConfigurationDatabase();
|
||||||
/*
|
// Durable state is read once at startup and then replaced atomically after
|
||||||
Capture the active revision once when the process opens its configuration
|
// each committed save or rollback. Every caller therefore sees one complete
|
||||||
store. Later admin saves are intentionally restart-bound, so comparing
|
// revision rather than independently rereading SQLite mid-application.
|
||||||
against this value gives every reconnecting browser an authoritative
|
const active = singleton.getActiveConfigurationRecord();
|
||||||
pending-restart indicator.
|
runtimeConfiguration = Object.freeze(active.config);
|
||||||
*/
|
runtimeConfigurationRevision = active.revision;
|
||||||
runtimeConfigurationRevision = singleton.getActiveConfigurationRecord().revision;
|
lastApplication = {
|
||||||
|
revision: active.revision,
|
||||||
|
changedSections: [],
|
||||||
|
services: [],
|
||||||
|
appliedAt: Date.now(),
|
||||||
|
};
|
||||||
}
|
}
|
||||||
return singleton;
|
return singleton;
|
||||||
}
|
}
|
||||||
@@ -27,16 +39,78 @@ function getRuntimeConfigurationRevision() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function loadConfig() {
|
function loadConfig() {
|
||||||
/*
|
getConfigurationDatabase();
|
||||||
Services intentionally receive one coherent snapshot for this process.
|
return runtimeConfiguration;
|
||||||
Configuration commits are restart-bound, so re-reading during runtime would
|
}
|
||||||
let only some modules observe the new revision and create a split-brain
|
|
||||||
process. The database remains queryable through its administrative API.
|
function registerConfigurationHandler(section, handler) {
|
||||||
*/
|
if (!rootSchema.properties?.[section]) {
|
||||||
if (!loadConfig.cached) {
|
throw new Error(`Cannot register configuration handler for unknown section ${section}.`);
|
||||||
loadConfig.cached = Object.freeze(getConfigurationDatabase().getActiveConfigurationRecord().config);
|
|
||||||
}
|
}
|
||||||
return loadConfig.cached;
|
if (typeof handler !== 'function') {
|
||||||
|
throw new Error(`Configuration handler for ${section} must be a function.`);
|
||||||
|
}
|
||||||
|
const handlers = reloadHandlers.get(section) || new Set();
|
||||||
|
handlers.add(handler);
|
||||||
|
reloadHandlers.set(section, handlers);
|
||||||
|
return () => handlers.delete(handler);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function applyCommittedConfiguration() {
|
||||||
|
/*
|
||||||
|
Saves are serialized even though SQLite commits synchronously. A service
|
||||||
|
reload may need to close a worker or network client asynchronously, and a
|
||||||
|
later revision must never overtake that cleanup and start a second runtime.
|
||||||
|
*/
|
||||||
|
const apply = async () => {
|
||||||
|
const active = getConfigurationDatabase().getActiveConfigurationRecord();
|
||||||
|
const previous = loadConfig();
|
||||||
|
const next = Object.freeze(active.config);
|
||||||
|
const changedSections = definitions
|
||||||
|
.map(({ key }) => key)
|
||||||
|
.filter((key) => !isDeepStrictEqual(previous[key], next[key]));
|
||||||
|
|
||||||
|
// Swap the complete document before invoking handlers. Any service helper
|
||||||
|
// consulted during a reload consequently observes the same new revision.
|
||||||
|
runtimeConfiguration = next;
|
||||||
|
runtimeConfigurationRevision = active.revision;
|
||||||
|
|
||||||
|
const services = [];
|
||||||
|
for (const section of changedSections) {
|
||||||
|
for (const handler of reloadHandlers.get(section) || []) {
|
||||||
|
try {
|
||||||
|
// Sequential application preserves the server's existing dependency
|
||||||
|
// order, notably Home Assistant before its Neato and lift consumers.
|
||||||
|
await handler(next[section], previous[section], next, previous);
|
||||||
|
services.push({ section, status: 'applied' });
|
||||||
|
} catch (error) {
|
||||||
|
// One unavailable integration must not prevent unrelated services or
|
||||||
|
// the session feature map from receiving the committed revision.
|
||||||
|
services.push({ section, status: 'failed', error: error.message });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
lastApplication = {
|
||||||
|
revision: active.revision,
|
||||||
|
changedSections,
|
||||||
|
services,
|
||||||
|
appliedAt: Date.now(),
|
||||||
|
};
|
||||||
|
configurationEvents.emit('applied', lastApplication);
|
||||||
|
return lastApplication;
|
||||||
|
};
|
||||||
|
|
||||||
|
const queued = applicationQueue.then(apply, apply);
|
||||||
|
// Retain a fulfilled tail even if an unexpected coordinator error escapes;
|
||||||
|
// otherwise one failure would permanently poison every later save.
|
||||||
|
applicationQueue = queued.catch(() => undefined);
|
||||||
|
return queued;
|
||||||
|
}
|
||||||
|
|
||||||
|
function getLastConfigurationApplication() {
|
||||||
|
getConfigurationDatabase();
|
||||||
|
return lastApplication;
|
||||||
}
|
}
|
||||||
|
|
||||||
function getValueAtPath(value, path) {
|
function getValueAtPath(value, path) {
|
||||||
@@ -62,6 +136,10 @@ function isFeatureEnabled(featureName) {
|
|||||||
module.exports = {
|
module.exports = {
|
||||||
getConfigurationDatabase,
|
getConfigurationDatabase,
|
||||||
getRuntimeConfigurationRevision,
|
getRuntimeConfigurationRevision,
|
||||||
|
getLastConfigurationApplication,
|
||||||
|
registerConfigurationHandler,
|
||||||
|
applyCommittedConfiguration,
|
||||||
|
configurationEvents,
|
||||||
loadConfig,
|
loadConfig,
|
||||||
getFeatureFlags,
|
getFeatureFlags,
|
||||||
isFeatureEnabled,
|
isFeatureEnabled,
|
||||||
|
|||||||
@@ -37,6 +37,53 @@ const migrations = [
|
|||||||
);
|
);
|
||||||
`,
|
`,
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
version: 2,
|
||||||
|
run(db) {
|
||||||
|
const rows = db.prepare('SELECT id, config_json FROM configuration_revisions').all();
|
||||||
|
const update = db.prepare('UPDATE configuration_revisions SET config_json = ? WHERE id = ?');
|
||||||
|
|
||||||
|
rows.forEach((row) => {
|
||||||
|
const config = JSON.parse(row.config_json);
|
||||||
|
/*
|
||||||
|
publicUrl was formerly repeated under inter-instance, Discord, and
|
||||||
|
media settings. Preserve the public identity already selected by the
|
||||||
|
operator: enabled consumers win first, then non-example values, with
|
||||||
|
inter-instance winning an otherwise equal conflict. Remove only the
|
||||||
|
three fields replaced by the root setting and fixed /video proxy.
|
||||||
|
*/
|
||||||
|
const previousInterInstanceUrl = config.interInstance?.profile?.publicUrl;
|
||||||
|
const previousDiscordUrl = config.discord?.siteUrl;
|
||||||
|
const previousCandidates = [
|
||||||
|
config.interInstance?.enabled ? previousInterInstanceUrl : '',
|
||||||
|
config.discord?.enabled ? previousDiscordUrl : '',
|
||||||
|
previousInterInstanceUrl !== 'https://rover.example.com' ? previousInterInstanceUrl : '',
|
||||||
|
previousDiscordUrl !== 'https://rover.example.com' ? previousDiscordUrl : '',
|
||||||
|
previousInterInstanceUrl,
|
||||||
|
previousDiscordUrl,
|
||||||
|
];
|
||||||
|
config.publicUrl = config.publicUrl
|
||||||
|
|| previousCandidates.find((value) => typeof value === 'string' && value.trim())
|
||||||
|
|| 'https://rover.example.com';
|
||||||
|
if (config.interInstance?.profile) delete config.interInstance.profile.publicUrl;
|
||||||
|
if (config.discord) delete config.discord.siteUrl;
|
||||||
|
if (config.media) delete config.media.whepBaseUrl;
|
||||||
|
update.run(JSON.stringify(config), row.id);
|
||||||
|
});
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
version: 3,
|
||||||
|
run(db) {
|
||||||
|
// Migrate historical revisions too, so rolling back settings cannot
|
||||||
|
// restore the removed training-visit limit and break startup again.
|
||||||
|
db.prepare(`
|
||||||
|
UPDATE configuration_revisions
|
||||||
|
SET config_json = json_remove(config_json, '$.roverLearning.training.roundsPerSession')
|
||||||
|
WHERE json_type(config_json, '$.roverLearning.training.roundsPerSession') IS NOT NULL
|
||||||
|
`).run();
|
||||||
|
},
|
||||||
|
},
|
||||||
];
|
];
|
||||||
|
|
||||||
function applySchemaMigrations(db) {
|
function applySchemaMigrations(db) {
|
||||||
@@ -57,7 +104,8 @@ function applySchemaMigrations(db) {
|
|||||||
changed database whose version incorrectly appears current.
|
changed database whose version incorrectly appears current.
|
||||||
*/
|
*/
|
||||||
db.transaction(() => {
|
db.transaction(() => {
|
||||||
db.exec(migration.sql);
|
if (migration.sql) db.exec(migration.sql);
|
||||||
|
if (migration.run) migration.run(db);
|
||||||
record.run(migration.version, Date.now());
|
record.run(migration.version, Date.now());
|
||||||
})();
|
})();
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -4,10 +4,32 @@ const http = require('http');
|
|||||||
const express = require('express');
|
const express = require('express');
|
||||||
const morgan = require('morgan');
|
const morgan = require('morgan');
|
||||||
const config = require('./config');
|
const config = require('./config');
|
||||||
|
const logger = require('./logger').child('mediaMtxProxy');
|
||||||
|
const { PUBLIC_MEDIA_PREFIX, createMediaMtxProxy } = require('../services/mediaMtxService/proxy');
|
||||||
|
|
||||||
const app = express();
|
const app = express();
|
||||||
app.use(morgan('dev'));
|
app.use(morgan('dev'));
|
||||||
|
/*
|
||||||
|
Mount signaling before body parsers so SDP offers and trickle-ICE fragments
|
||||||
|
remain untouched streams. Express removes the /video mount prefix while the
|
||||||
|
proxy is active, giving MediaMTX its native /<path>/whep or /<path>/whip URL.
|
||||||
|
*/
|
||||||
|
app.use(PUBLIC_MEDIA_PREFIX, createMediaMtxProxy({ logger }));
|
||||||
app.use(express.json());
|
app.use(express.json());
|
||||||
|
/*
|
||||||
|
Docker and the later lifecycle controller need one stable readiness result,
|
||||||
|
but they do not need administrator credentials or application details. Load
|
||||||
|
the health service only when the route is called so the global HTTP module
|
||||||
|
remains safe to initialize before the service graph during bootstrap.
|
||||||
|
*/
|
||||||
|
app.get('/health', async (_req, res) => {
|
||||||
|
const { getContainerHealth } = require('../services/healthService');
|
||||||
|
const health = await getContainerHealth();
|
||||||
|
res.status(health.healthy ? 200 : 503).json({
|
||||||
|
status: health.healthy ? 'healthy' : 'unhealthy',
|
||||||
|
checks: health.checks,
|
||||||
|
});
|
||||||
|
});
|
||||||
app.use(express.static(config.staticDir, { index: false }));
|
app.use(express.static(config.staticDir, { index: false }));
|
||||||
|
|
||||||
const httpServer = http.createServer(app);
|
const httpServer = http.createServer(app);
|
||||||
|
|||||||
@@ -13,8 +13,13 @@ const io = new SocketIOServer(httpServer, {
|
|||||||
maxHttpBufferSize: 16 * 1024 * 1024,
|
maxHttpBufferSize: 16 * 1024 * 1024,
|
||||||
});
|
});
|
||||||
|
|
||||||
// Allow more service listeners without warnings.
|
/*
|
||||||
io.sockets.setMaxListeners(30);
|
Optional feature gateways now remain registered while disabled so an admin
|
||||||
io.of('/').setMaxListeners(30);
|
can enable them live without adding a second listener tree. Forty is a small
|
||||||
|
explicit allowance for those one-time service owners, not an unlimited value
|
||||||
|
that could hide duplicate registrations during repeated configuration saves.
|
||||||
|
*/
|
||||||
|
io.sockets.setMaxListeners(40);
|
||||||
|
io.of('/').setMaxListeners(40);
|
||||||
|
|
||||||
module.exports = io;
|
module.exports = io;
|
||||||
|
|||||||
@@ -83,9 +83,9 @@ function buildBandwidthSavingsPolicy(config = loadConfig()) {
|
|||||||
|
|
||||||
function getBandwidthSavingsPolicy() {
|
function getBandwidthSavingsPolicy() {
|
||||||
/*
|
/*
|
||||||
loadConfig() is cached by configuration service, so rebuilding this small object per
|
The configuration service returns an in-memory snapshot, so rebuilding this
|
||||||
caller is cheap while still letting tests pass explicit config objects into
|
small normalized object per caller is cheap and immediately follows a newly
|
||||||
buildBandwidthSavingsPolicy().
|
applied revision. Tests may still supply explicit documents directly.
|
||||||
*/
|
*/
|
||||||
return buildBandwidthSavingsPolicy(loadConfig());
|
return buildBandwidthSavingsPolicy(loadConfig());
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -87,6 +87,7 @@ function resolveSiteMetadata(config = loadConfig()) {
|
|||||||
const interInstance = config?.interInstance;
|
const interInstance = config?.interInstance;
|
||||||
const profile = interInstance?.profile;
|
const profile = interInstance?.profile;
|
||||||
const profileName = asTrimmedString(profile?.name);
|
const profileName = asTrimmedString(profile?.name);
|
||||||
|
const publicUrl = normalizePublicUrl(config?.publicUrl);
|
||||||
|
|
||||||
/*
|
/*
|
||||||
A partially filled profile must not unexpectedly rename the site. The
|
A partially filled profile must not unexpectedly rename the site. The
|
||||||
@@ -95,7 +96,11 @@ function resolveSiteMetadata(config = loadConfig()) {
|
|||||||
the coherent default set above.
|
the coherent default set above.
|
||||||
*/
|
*/
|
||||||
if (interInstance?.enabled !== true || !profileName) {
|
if (interInstance?.enabled !== true || !profileName) {
|
||||||
return { ...DEFAULT_SITE_METADATA, accentTextColor: getReadableAccentText(DEFAULT_SITE_METADATA.accentColor) };
|
return {
|
||||||
|
...DEFAULT_SITE_METADATA,
|
||||||
|
publicUrl,
|
||||||
|
accentTextColor: getReadableAccentText(DEFAULT_SITE_METADATA.accentColor),
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
const accentColor = normalizeHexColor(profile.color) || DEFAULT_SITE_METADATA.accentColor;
|
const accentColor = normalizeHexColor(profile.color) || DEFAULT_SITE_METADATA.accentColor;
|
||||||
@@ -110,7 +115,7 @@ function resolveSiteMetadata(config = loadConfig()) {
|
|||||||
BACKGROUND_BLEND_AMOUNT,
|
BACKGROUND_BLEND_AMOUNT,
|
||||||
),
|
),
|
||||||
accentTextColor: getReadableAccentText(accentColor),
|
accentTextColor: getReadableAccentText(accentColor),
|
||||||
publicUrl: normalizePublicUrl(profile.publicUrl),
|
publicUrl,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -44,7 +44,7 @@ module.exports = {
|
|||||||
goal: 400,
|
goal: 400,
|
||||||
async run(ctx) {
|
async run(ctx) {
|
||||||
startStrobe(ctx, { endsAt: Date.now() + STROBE_MS, on: false });
|
startStrobe(ctx, { endsAt: Date.now() + STROBE_MS, on: false });
|
||||||
ctx.sendAlert({ color: '#ffc107', title: 'Light Strobe', message: 'All room controls strobing for 60 seconds.' });
|
ctx.sendAlert({ color: '#ffc107', title: 'Light Strobe', message: 'All room lights strobing for 60 seconds.' });
|
||||||
},
|
},
|
||||||
async recover(ctx, effect) {
|
async recover(ctx, effect) {
|
||||||
if (!effect || Number(effect.endsAt || 0) <= Date.now()) {
|
if (!effect || Number(effect.endsAt || 0) <= Date.now()) {
|
||||||
|
|||||||
@@ -7,8 +7,15 @@ const logger = require('../../globals/logger').child('adminConfigurationService'
|
|||||||
const {
|
const {
|
||||||
getConfigurationDatabase,
|
getConfigurationDatabase,
|
||||||
getRuntimeConfigurationRevision,
|
getRuntimeConfigurationRevision,
|
||||||
|
getLastConfigurationApplication,
|
||||||
|
applyCommittedConfiguration,
|
||||||
rootSchema,
|
rootSchema,
|
||||||
} = require('../../configuration');
|
} = require('../../configuration');
|
||||||
|
const {
|
||||||
|
MAX_CONFIGURATION_FILE_BYTES,
|
||||||
|
parseConfigurationFile,
|
||||||
|
buildSecretOperationsForImport,
|
||||||
|
} = require('../../configuration/configurationFileImporter');
|
||||||
const { getRole } = require('../roleService');
|
const { getRole } = require('../roleService');
|
||||||
|
|
||||||
const PASSWORD_CONFIRMATION_WINDOW_MS = 5 * 60 * 1000;
|
const PASSWORD_CONFIRMATION_WINDOW_MS = 5 * 60 * 1000;
|
||||||
@@ -32,6 +39,18 @@ function actorFor(socket) {
|
|||||||
return socket?.data?.user?.username || socket.id;
|
return socket?.data?.user?.username || socket.id;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function safeUploadedFileName(value) {
|
||||||
|
/*
|
||||||
|
The filename is audit metadata only and is never opened on the server.
|
||||||
|
Removing control characters keeps logs and history readable while
|
||||||
|
retaining the operator-visible name that identifies the imported file.
|
||||||
|
*/
|
||||||
|
return String(value || 'uploaded-config.yaml')
|
||||||
|
.replace(/[\u0000-\u001f\u007f]/g, '')
|
||||||
|
.trim()
|
||||||
|
.slice(0, 255) || 'uploaded-config.yaml';
|
||||||
|
}
|
||||||
|
|
||||||
function errorPayload(error) {
|
function errorPayload(error) {
|
||||||
return {
|
return {
|
||||||
error: error.message,
|
error: error.message,
|
||||||
@@ -69,7 +88,8 @@ function buildAdminSnapshot() {
|
|||||||
a second field definition.
|
a second field definition.
|
||||||
*/
|
*/
|
||||||
configuration: { ...configuration, schema: rootSchema },
|
configuration: { ...configuration, schema: rootSchema },
|
||||||
restartRequired: configuration.revision !== getRuntimeConfigurationRevision(),
|
appliedRevision: getRuntimeConfigurationRevision(),
|
||||||
|
configurationApplication: getLastConfigurationApplication(),
|
||||||
administrators: database.listAdministrators(),
|
administrators: database.listAdministrators(),
|
||||||
revisions: database.listConfigurationRevisions(),
|
revisions: database.listConfigurationRevisions(),
|
||||||
auditEvents: database.listAuditEvents(),
|
auditEvents: database.listAuditEvents(),
|
||||||
@@ -88,23 +108,56 @@ io.on('connection', (socket) => {
|
|||||||
return { confirmedUntil: socket.data.adminPasswordConfirmedAt + PASSWORD_CONFIRMATION_WINDOW_MS };
|
return { confirmedUntil: socket.data.adminPasswordConfirmedAt + PASSWORD_CONFIRMATION_WINDOW_MS };
|
||||||
});
|
});
|
||||||
|
|
||||||
ackHandler(socket, 'adminConfig:updateConfiguration', requireRecentPassword, (payload) => {
|
ackHandler(socket, 'adminConfig:updateConfiguration', requireRecentPassword, async (payload) => {
|
||||||
const revision = database.updateConfiguration({
|
const revision = database.updateConfiguration({
|
||||||
value: payload.value,
|
value: payload.value,
|
||||||
expectedRevision: payload.expectedRevision,
|
expectedRevision: payload.expectedRevision,
|
||||||
secretOperations: payload.secretOperations,
|
secretOperations: payload.secretOperations,
|
||||||
actor: actorFor(socket),
|
actor: actorFor(socket),
|
||||||
});
|
});
|
||||||
return { revision, snapshot: buildAdminSnapshot(), restartRequired: true };
|
const application = await applyCommittedConfiguration();
|
||||||
|
return { revision, application, snapshot: buildAdminSnapshot() };
|
||||||
});
|
});
|
||||||
|
|
||||||
ackHandler(socket, 'adminConfig:restoreRevision', requireRecentPassword, (payload) => {
|
ackHandler(socket, 'adminConfig:importConfigurationFile', requireRecentPassword, async (payload) => {
|
||||||
|
const yamlText = String(payload.yaml || '');
|
||||||
|
if (!yamlText || Buffer.byteLength(yamlText, 'utf8') > MAX_CONFIGURATION_FILE_BYTES) {
|
||||||
|
throw new Error('The YAML configuration file must be present and no larger than 1 MiB.');
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
Parsing deliberately excludes administrators on an initialized server.
|
||||||
|
Configuration is still filtered to today's schema and strictly
|
||||||
|
validated, then committed through the ordinary optimistic update path so
|
||||||
|
missing secrets survive and explicitly supplied secrets replace or clear
|
||||||
|
their current values.
|
||||||
|
*/
|
||||||
|
const parsed = parseConfigurationFile(yamlText, { includeAdministrators: false });
|
||||||
|
const fileName = safeUploadedFileName(payload.fileName);
|
||||||
|
const revision = database.updateConfiguration({
|
||||||
|
value: parsed.config,
|
||||||
|
expectedRevision: payload.expectedRevision,
|
||||||
|
secretOperations: buildSecretOperationsForImport(parsed),
|
||||||
|
actor: actorFor(socket),
|
||||||
|
source: `admin-yaml:${fileName}`,
|
||||||
|
});
|
||||||
|
const application = await applyCommittedConfiguration();
|
||||||
|
return {
|
||||||
|
revision,
|
||||||
|
application,
|
||||||
|
ignoredAdministratorCount: parsed.uploadedAdministratorCount,
|
||||||
|
snapshot: buildAdminSnapshot(),
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
ackHandler(socket, 'adminConfig:restoreRevision', requireRecentPassword, async (payload) => {
|
||||||
const revision = database.restoreConfigurationRevision({
|
const revision = database.restoreConfigurationRevision({
|
||||||
revision: payload.revision,
|
revision: payload.revision,
|
||||||
expectedRevision: payload.expectedRevision,
|
expectedRevision: payload.expectedRevision,
|
||||||
actor: actorFor(socket),
|
actor: actorFor(socket),
|
||||||
});
|
});
|
||||||
return { revision, snapshot: buildAdminSnapshot(), restartRequired: true };
|
const application = await applyCommittedConfiguration();
|
||||||
|
return { revision, application, snapshot: buildAdminSnapshot() };
|
||||||
});
|
});
|
||||||
|
|
||||||
ackHandler(socket, 'adminConfig:createAdministrator', requireRecentPassword, async (payload) => {
|
ackHandler(socket, 'adminConfig:createAdministrator', requireRecentPassword, async (payload) => {
|
||||||
@@ -155,4 +208,5 @@ io.on('connection', (socket) => {
|
|||||||
module.exports = {
|
module.exports = {
|
||||||
PASSWORD_CONFIRMATION_WINDOW_MS,
|
PASSWORD_CONFIRMATION_WINDOW_MS,
|
||||||
requireLockdownAdministrator,
|
requireLockdownAdministrator,
|
||||||
|
requireRecentPassword,
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ function registerAudioForwardHooks(deps) {
|
|||||||
roverManager,
|
roverManager,
|
||||||
turnService,
|
turnService,
|
||||||
logger,
|
logger,
|
||||||
serviceEnabled,
|
isServiceEnabled,
|
||||||
workers,
|
workers,
|
||||||
whipOwners,
|
whipOwners,
|
||||||
ensureWorker,
|
ensureWorker,
|
||||||
@@ -57,7 +57,7 @@ function registerAudioForwardHooks(deps) {
|
|||||||
stopWorker(roverId);
|
stopWorker(roverId);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
if (action === 'upsert' && serviceEnabled && !workers.has(roverId)) {
|
if (action === 'upsert' && isServiceEnabled() && !workers.has(roverId)) {
|
||||||
// A rover coming online should not create ffmpeg publishers by itself.
|
// A rover coming online should not create ffmpeg publishers by itself.
|
||||||
// The audio worker is intentionally lazy because uploads, mic forwarding,
|
// The audio worker is intentionally lazy because uploads, mic forwarding,
|
||||||
// and automatic sounds are the moments that actually need a media pipe;
|
// and automatic sounds are the moments that actually need a media pipe;
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ const path = require('path');
|
|||||||
const EventEmitter = require('events');
|
const EventEmitter = require('events');
|
||||||
const io = require('../../globals/io');
|
const io = require('../../globals/io');
|
||||||
const logger = require('../../globals/logger').child('audioForwardService');
|
const logger = require('../../globals/logger').child('audioForwardService');
|
||||||
const { loadConfig } = require('../../configuration');
|
const { loadConfig, registerConfigurationHandler } = require('../../configuration');
|
||||||
const { resolveRuntimePath } = require('../../helpers/dataPaths');
|
const { resolveRuntimePath } = require('../../helpers/dataPaths');
|
||||||
const roverManager = require('../roverManager');
|
const roverManager = require('../roverManager');
|
||||||
const turnService = require('../turnService');
|
const turnService = require('../turnService');
|
||||||
@@ -17,18 +17,7 @@ const { registerAudioForwardHooks } = require('./hooks');
|
|||||||
const { registerChargeCompleteSound } = require('./chargeCompleteSound');
|
const { registerChargeCompleteSound } = require('./chargeCompleteSound');
|
||||||
|
|
||||||
const audioForwardEvents = new EventEmitter();
|
const audioForwardEvents = new EventEmitter();
|
||||||
const config = loadConfig();
|
let serviceEnabled = false;
|
||||||
const audioForwardConfig = config.audioForward || {};
|
|
||||||
const mediaConfig = config.media || {};
|
|
||||||
// Configuration defaults always provide this boolean. Treat only an explicit
|
|
||||||
// true as enabled so no credential, path, or historical fallback can opt the
|
|
||||||
// service in on the operator's behalf.
|
|
||||||
const serviceEnabled = Boolean(audioForwardConfig.enabled);
|
|
||||||
const ffmpegBin = audioForwardConfig.ffmpegBin || 'ffmpeg';
|
|
||||||
const streamSuffix =
|
|
||||||
typeof audioForwardConfig.streamSuffix === 'string' && audioForwardConfig.streamSuffix.trim()
|
|
||||||
? audioForwardConfig.streamSuffix.trim()
|
|
||||||
: '-fwd';
|
|
||||||
/*
|
/*
|
||||||
FIFOs and uploaded clips are disposable, but they are deliberately created
|
FIFOs and uploaded clips are disposable, but they are deliberately created
|
||||||
and managed by this application. A fixed path below SERVER_DATA_DIR keeps the
|
and managed by this application. A fixed path below SERVER_DATA_DIR keeps the
|
||||||
@@ -37,9 +26,6 @@ const streamSuffix =
|
|||||||
*/
|
*/
|
||||||
const runtimeDir = resolveRuntimePath('audio-forward');
|
const runtimeDir = resolveRuntimePath('audio-forward');
|
||||||
const uploadsDir = path.join(runtimeDir, 'uploads');
|
const uploadsDir = path.join(runtimeDir, 'uploads');
|
||||||
const maxUploadBytes = Number.isFinite(audioForwardConfig.maxUploadBytes)
|
|
||||||
? Math.max(256 * 1024, Math.floor(audioForwardConfig.maxUploadBytes))
|
|
||||||
: 8 * 1024 * 1024;
|
|
||||||
|
|
||||||
const states = new Map(); // roverId -> { state, source, error, startedAt, updatedAt }
|
const states = new Map(); // roverId -> { state, source, error, startedAt, updatedAt }
|
||||||
const workers = new Map(); // roverId -> worker
|
const workers = new Map(); // roverId -> worker
|
||||||
@@ -70,51 +56,65 @@ function getAudioForwardState() {
|
|||||||
return payload;
|
return payload;
|
||||||
}
|
}
|
||||||
|
|
||||||
const audioForwardPolicy = createAudioForwardPolicy({
|
let operations;
|
||||||
isVerified,
|
|
||||||
isMuted,
|
|
||||||
roverManager,
|
|
||||||
turnService,
|
|
||||||
streamSuffix,
|
|
||||||
mediaConfig,
|
|
||||||
});
|
|
||||||
const {
|
|
||||||
ensureAudioForwardPermission,
|
|
||||||
resolveForwardUrl,
|
|
||||||
resolveForwardPathId,
|
|
||||||
buildWhipUrl,
|
|
||||||
} = audioForwardPolicy;
|
|
||||||
|
|
||||||
const workerEngine = createAudioForwardWorkerEngine({
|
function replaceAudioForwardRuntime(fullConfig) {
|
||||||
logger,
|
operations?.stopAllWorkers('configuration-change');
|
||||||
io,
|
const audioForwardConfig = fullConfig.audioForward || {};
|
||||||
roverManager,
|
serviceEnabled = Boolean(audioForwardConfig.enabled);
|
||||||
turnService,
|
const streamSuffix = typeof audioForwardConfig.streamSuffix === 'string' && audioForwardConfig.streamSuffix.trim()
|
||||||
videoSessions,
|
? audioForwardConfig.streamSuffix.trim()
|
||||||
serviceEnabled,
|
: '-fwd';
|
||||||
ffmpegBin,
|
const policy = createAudioForwardPolicy({
|
||||||
runtimeDir,
|
isVerified,
|
||||||
uploadsDir,
|
isMuted,
|
||||||
maxUploadBytes,
|
roverManager,
|
||||||
workers,
|
turnService,
|
||||||
whipOwners,
|
streamSuffix,
|
||||||
setState,
|
});
|
||||||
resolveForwardUrl,
|
const maxUploadBytes = Number.isFinite(audioForwardConfig.maxUploadBytes)
|
||||||
resolveForwardPathId,
|
? Math.max(256 * 1024, Math.floor(audioForwardConfig.maxUploadBytes))
|
||||||
});
|
: 8 * 1024 * 1024;
|
||||||
|
operations = {
|
||||||
|
...policy,
|
||||||
|
...createAudioForwardWorkerEngine({
|
||||||
|
logger,
|
||||||
|
io,
|
||||||
|
roverManager,
|
||||||
|
turnService,
|
||||||
|
videoSessions,
|
||||||
|
serviceEnabled,
|
||||||
|
ffmpegBin: audioForwardConfig.ffmpegBin || 'ffmpeg',
|
||||||
|
runtimeDir,
|
||||||
|
uploadsDir,
|
||||||
|
maxUploadBytes,
|
||||||
|
workers,
|
||||||
|
whipOwners,
|
||||||
|
setState,
|
||||||
|
resolveForwardUrl: policy.resolveForwardUrl,
|
||||||
|
resolveForwardPathId: policy.resolveForwardPathId,
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
const {
|
replaceAudioForwardRuntime(loadConfig());
|
||||||
ensureWorker,
|
|
||||||
stopWorker,
|
// Stable delegates keep the one-time socket/event registrations below pointed
|
||||||
stopAllWorkers,
|
// at the newest policy and worker engine after audio-forward changes.
|
||||||
playUploadedAudio,
|
const delegate = (name) => (...args) => operations[name](...args);
|
||||||
playServerAudioFile,
|
const ensureWorker = delegate('ensureWorker');
|
||||||
stopPlayback,
|
const stopWorker = delegate('stopWorker');
|
||||||
revokeWhipSessionForRover,
|
const stopAllWorkers = delegate('stopAllWorkers');
|
||||||
stopWhipForRover,
|
const playUploadedAudio = delegate('playUploadedAudio');
|
||||||
stopOwnedAudioIfUnauthorized,
|
const playServerAudioFile = delegate('playServerAudioFile');
|
||||||
startSilenceWriter,
|
const stopPlayback = delegate('stopPlayback');
|
||||||
} = workerEngine;
|
const revokeWhipSessionForRover = delegate('revokeWhipSessionForRover');
|
||||||
|
const stopWhipForRover = delegate('stopWhipForRover');
|
||||||
|
const stopOwnedAudioIfUnauthorized = delegate('stopOwnedAudioIfUnauthorized');
|
||||||
|
const startSilenceWriter = delegate('startSilenceWriter');
|
||||||
|
const ensureAudioForwardPermission = delegate('ensureAudioForwardPermission');
|
||||||
|
const resolveForwardPathId = delegate('resolveForwardPathId');
|
||||||
|
const buildWhipUrl = delegate('buildWhipUrl');
|
||||||
|
|
||||||
function installShutdownHooks() {
|
function installShutdownHooks() {
|
||||||
const shutdown = (signal) => {
|
const shutdown = (signal) => {
|
||||||
@@ -136,7 +136,7 @@ registerAudioForwardHooks({
|
|||||||
roverManager,
|
roverManager,
|
||||||
turnService,
|
turnService,
|
||||||
logger,
|
logger,
|
||||||
serviceEnabled,
|
isServiceEnabled: () => serviceEnabled,
|
||||||
workers,
|
workers,
|
||||||
whipOwners,
|
whipOwners,
|
||||||
ensureWorker,
|
ensureWorker,
|
||||||
@@ -161,6 +161,10 @@ registerChargeCompleteSound({
|
|||||||
playServerAudioFile,
|
playServerAudioFile,
|
||||||
});
|
});
|
||||||
|
|
||||||
|
registerConfigurationHandler('audioForward', (_section, _previous, nextConfig) => {
|
||||||
|
replaceAudioForwardRuntime(nextConfig);
|
||||||
|
});
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
getAudioForwardState,
|
getAudioForwardState,
|
||||||
audioForwardEvents,
|
audioForwardEvents,
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
// audio Forward Service policy
|
// audio Forward Service policy
|
||||||
// Purpose: Encapsulates permission checks and media path/url derivation helpers.
|
// Purpose: Encapsulates permission checks and media path/url derivation helpers.
|
||||||
// Scope: Keeps runtime behavior unchanged while isolating validation and path-construction logic.
|
// Scope: Keeps runtime behavior unchanged while isolating validation and path-construction logic.
|
||||||
|
const { PUBLIC_MEDIA_PREFIX } = require('../mediaMtxService/proxy');
|
||||||
|
|
||||||
function createAudioForwardPolicy(deps) {
|
function createAudioForwardPolicy(deps) {
|
||||||
const {
|
const {
|
||||||
isVerified,
|
isVerified,
|
||||||
@@ -8,7 +10,6 @@ function createAudioForwardPolicy(deps) {
|
|||||||
roverManager,
|
roverManager,
|
||||||
turnService,
|
turnService,
|
||||||
streamSuffix,
|
streamSuffix,
|
||||||
mediaConfig,
|
|
||||||
} = deps;
|
} = deps;
|
||||||
|
|
||||||
function ensureVipVerified(socket) {
|
function ensureVipVerified(socket) {
|
||||||
@@ -43,23 +44,8 @@ function createAudioForwardPolicy(deps) {
|
|||||||
return `${roverId}${streamSuffix}`;
|
return `${roverId}${streamSuffix}`;
|
||||||
}
|
}
|
||||||
|
|
||||||
function getMediaPrefix() {
|
|
||||||
const base = mediaConfig.whepBaseUrl;
|
|
||||||
if (!base) return '';
|
|
||||||
try {
|
|
||||||
const parsed = new URL(base);
|
|
||||||
return `${parsed.origin}${parsed.pathname}`.replace(/\/+$/, '');
|
|
||||||
} catch {
|
|
||||||
return String(base).replace(/\/+$/, '');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function buildWhipUrl(pathId) {
|
function buildWhipUrl(pathId) {
|
||||||
const prefix = getMediaPrefix();
|
return `${PUBLIC_MEDIA_PREFIX}/${encodeURIComponent(pathId)}/whip`;
|
||||||
if (!prefix) {
|
|
||||||
throw new Error('Server media base URL missing');
|
|
||||||
}
|
|
||||||
return `${prefix}/${encodeURIComponent(pathId)}/whip`;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
|
|||||||
@@ -12,7 +12,6 @@ function createPolicy({ verified = true, muted = false, driver = true, canDrive
|
|||||||
roverManager: { isDriver: () => driver },
|
roverManager: { isDriver: () => driver },
|
||||||
turnService: { canDrive: () => canDrive },
|
turnService: { canDrive: () => canDrive },
|
||||||
streamSuffix: '-fwd',
|
streamSuffix: '-fwd',
|
||||||
mediaConfig: {},
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -30,3 +29,8 @@ test('publishes forwarded audio to the local MediaMTX RTSP path', () => {
|
|||||||
const policy = createPolicy();
|
const policy = createPolicy();
|
||||||
assert.equal(policy.resolveForwardUrl('rover one'), 'rtsp://127.0.0.1:8554/rover%20one-fwd');
|
assert.equal(policy.resolveForwardUrl('rover one'), 'rtsp://127.0.0.1:8554/rover%20one-fwd');
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('publishes browser microphone signaling through the same-origin proxy', () => {
|
||||||
|
const policy = createPolicy();
|
||||||
|
assert.equal(policy.buildWhipUrl('rover one-fwd'), '/video/rover%20one-fwd/whip');
|
||||||
|
});
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ const fs = require('fs');
|
|||||||
const EventEmitter = require('events');
|
const EventEmitter = require('events');
|
||||||
const io = require('../../globals/io');
|
const io = require('../../globals/io');
|
||||||
const logger = require('../../globals/logger').child('audioLevelsService');
|
const logger = require('../../globals/logger').child('audioLevelsService');
|
||||||
const { loadConfig } = require('../../configuration');
|
const { loadConfig, registerConfigurationHandler } = require('../../configuration');
|
||||||
const { resolveDataDir, resolveDataPath } = require('../../helpers/dataPaths');
|
const { resolveDataDir, resolveDataPath } = require('../../helpers/dataPaths');
|
||||||
const { isAdmin, roleEvents } = require('../roleService');
|
const { isAdmin, roleEvents } = require('../roleService');
|
||||||
const roverManager = require('../roverManager');
|
const roverManager = require('../roverManager');
|
||||||
@@ -344,6 +344,32 @@ io.on('connection', (socket) => {
|
|||||||
|
|
||||||
loadState();
|
loadState();
|
||||||
|
|
||||||
|
registerConfigurationHandler('audioLevels', async (nextConfig) => {
|
||||||
|
/*
|
||||||
|
Audio levels also have a durable operational store because administrators
|
||||||
|
can adjust them outside the configuration editor. Applying a configuration
|
||||||
|
revision intentionally updates that same live state, rather than changing
|
||||||
|
startup fallbacks that an existing store would immediately override.
|
||||||
|
*/
|
||||||
|
const current = loadState();
|
||||||
|
persistState({
|
||||||
|
...current,
|
||||||
|
hornGain: clampGain(nextConfig.hornGain, current.hornGain),
|
||||||
|
ttsGain: clampGain(nextConfig.ttsGain, current.ttsGain),
|
||||||
|
forwardGain: clampGain(nextConfig.forwardGain, current.forwardGain),
|
||||||
|
maxPersonalAdjustmentPercent: clampMaximumAdjustmentPercent(
|
||||||
|
nextConfig.maxPersonalAdjustmentPercent,
|
||||||
|
current.maxPersonalAdjustmentPercent,
|
||||||
|
),
|
||||||
|
updatedAt: Date.now(),
|
||||||
|
updatedBy: 'configuration',
|
||||||
|
adjustmentRangeUpdatedAt: Date.now(),
|
||||||
|
adjustmentRangeUpdatedBy: 'configuration',
|
||||||
|
});
|
||||||
|
pushLevelsToAllRovers();
|
||||||
|
emitChange('configuration_applied');
|
||||||
|
});
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
ADJUSTMENT_FIELDS,
|
ADJUSTMENT_FIELDS,
|
||||||
PERSONAL_ADJUSTMENT_PERMISSION,
|
PERSONAL_ADJUSTMENT_PERMISSION,
|
||||||
|
|||||||
@@ -0,0 +1,199 @@
|
|||||||
|
// Full Data Backup
|
||||||
|
// Purpose: Creates one validated archive of the durable server data without stopping live services or writers.
|
||||||
|
// Scope: Uses service-owned online database snapshots and stable file copies inside the canonical data directory.
|
||||||
|
const fs = require('fs');
|
||||||
|
const fsp = require('fs/promises');
|
||||||
|
const path = require('path');
|
||||||
|
const crypto = require('crypto');
|
||||||
|
const tar = require('tar');
|
||||||
|
const Database = require('better-sqlite3');
|
||||||
|
const { resolveDataDir, resolveDataPath } = require('../../helpers/dataPaths');
|
||||||
|
const packageInfo = require('../../../package.json');
|
||||||
|
|
||||||
|
const FORMAT_VERSION = 1;
|
||||||
|
const CONTROL_DIR_NAME = 'backup-restore';
|
||||||
|
const EXCLUDED_TOP_LEVEL_NAMES = new Set([CONTROL_DIR_NAME, 'runtime']);
|
||||||
|
const DATABASE_NAMES = ['configuration.sqlite', 'identity.sqlite', 'fleet-reports.sqlite'];
|
||||||
|
const DATABASE_FILES = new Set(DATABASE_NAMES.flatMap((name) => [name, `${name}-wal`, `${name}-shm`]));
|
||||||
|
const FILE_COPY_ATTEMPTS = 3;
|
||||||
|
|
||||||
|
async function removeSnapshotSidecars(payloadDir) {
|
||||||
|
/*
|
||||||
|
SQLite online backup produces a complete standalone main database file.
|
||||||
|
Reopening that snapshot to inspect its schema can still create empty WAL
|
||||||
|
and shared-memory coordination files because the database retains WAL as
|
||||||
|
its journal mode. Those files describe no durable backup content and must
|
||||||
|
be removed before the manifest inventory and tar archive are produced.
|
||||||
|
*/
|
||||||
|
await Promise.all(DATABASE_NAMES.flatMap((name) => [
|
||||||
|
fsp.rm(path.join(payloadDir, `${name}-wal`), { force: true }),
|
||||||
|
fsp.rm(path.join(payloadDir, `${name}-shm`), { force: true }),
|
||||||
|
]));
|
||||||
|
}
|
||||||
|
|
||||||
|
function readDatabaseSchemaVersions(payloadDir) {
|
||||||
|
const configuration = new Database(path.join(payloadDir, 'configuration.sqlite'), { readonly: true });
|
||||||
|
const identity = new Database(path.join(payloadDir, 'identity.sqlite'), { readonly: true });
|
||||||
|
const fleetReports = new Database(path.join(payloadDir, 'fleet-reports.sqlite'), { readonly: true });
|
||||||
|
try {
|
||||||
|
return {
|
||||||
|
configuration: Number(configuration.prepare('SELECT MAX(version) AS version FROM schema_migrations').get()?.version) || 0,
|
||||||
|
identity: Number(identity.pragma('user_version', { simple: true })) || 0,
|
||||||
|
// Fleet reporting currently evolves with additive startup checks and has
|
||||||
|
// no numbered migration table, so zero accurately identifies that scheme.
|
||||||
|
fleetReports: Number(fleetReports.pragma('user_version', { simple: true })) || 0,
|
||||||
|
};
|
||||||
|
} finally {
|
||||||
|
configuration.close();
|
||||||
|
identity.close();
|
||||||
|
fleetReports.close();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function sha256File(filePath) {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
const hash = crypto.createHash('sha256');
|
||||||
|
const stream = fs.createReadStream(filePath);
|
||||||
|
stream.on('error', reject);
|
||||||
|
stream.on('data', (chunk) => hash.update(chunk));
|
||||||
|
stream.on('end', () => resolve(hash.digest('hex')));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
async function copyStableFile(sourcePath, destinationPath) {
|
||||||
|
for (let attempt = 0; attempt < FILE_COPY_ATTEMPTS; attempt += 1) {
|
||||||
|
try {
|
||||||
|
const before = await fsp.stat(sourcePath);
|
||||||
|
if (!before.isFile()) throw new Error(`Backup source is not a regular file: ${sourcePath}`);
|
||||||
|
await fsp.mkdir(path.dirname(destinationPath), { recursive: true });
|
||||||
|
await fsp.copyFile(sourcePath, destinationPath);
|
||||||
|
await fsp.chmod(destinationPath, before.mode & 0o777);
|
||||||
|
|
||||||
|
/*
|
||||||
|
A writer may replace or append to a media file while it is copied. Size
|
||||||
|
and timestamp checks catch ordinary changes, while comparing hashes
|
||||||
|
catches a same-size replacement. Only the unstable file is retried;
|
||||||
|
no owning service is paused.
|
||||||
|
*/
|
||||||
|
const [sourceHash, destinationHash] = await Promise.all([
|
||||||
|
sha256File(sourcePath),
|
||||||
|
sha256File(destinationPath),
|
||||||
|
]);
|
||||||
|
// Read the final metadata only after both hashes finish. Starting this
|
||||||
|
// stat concurrently could miss a write that occurred during hashing.
|
||||||
|
const after = await fsp.stat(sourcePath);
|
||||||
|
if (before.size === after.size
|
||||||
|
&& before.mtimeMs === after.mtimeMs
|
||||||
|
&& sourceHash === destinationHash) return true;
|
||||||
|
} catch (error) {
|
||||||
|
if (error.code !== 'ENOENT') throw error;
|
||||||
|
// A rotating snapshot can disappear between directory enumeration and
|
||||||
|
// copying. Treat that exact race like any other unstable active file.
|
||||||
|
}
|
||||||
|
await fsp.rm(destinationPath, { force: true });
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function copyDurableTree(sourceDir, destinationDir, relativeDir = '') {
|
||||||
|
let entries;
|
||||||
|
try {
|
||||||
|
entries = await fsp.readdir(path.join(sourceDir, relativeDir), { withFileTypes: true });
|
||||||
|
} catch (error) {
|
||||||
|
if (error.code === 'ENOENT') return [];
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
|
||||||
|
const skipped = [];
|
||||||
|
for (const entry of entries) {
|
||||||
|
const relativePath = path.join(relativeDir, entry.name);
|
||||||
|
if (!relativeDir && EXCLUDED_TOP_LEVEL_NAMES.has(entry.name)) continue;
|
||||||
|
if (!relativeDir && DATABASE_FILES.has(entry.name)) continue;
|
||||||
|
if (entry.isSymbolicLink()) throw new Error(`Backup cannot include symbolic link: ${relativePath}`);
|
||||||
|
if (entry.isDirectory()) {
|
||||||
|
skipped.push(...await copyDurableTree(sourceDir, destinationDir, relativePath));
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (!entry.isFile()) throw new Error(`Backup cannot include special file: ${relativePath}`);
|
||||||
|
const copied = await copyStableFile(
|
||||||
|
path.join(sourceDir, relativePath),
|
||||||
|
path.join(destinationDir, relativePath),
|
||||||
|
);
|
||||||
|
if (!copied) skipped.push(relativePath.split(path.sep).join('/'));
|
||||||
|
}
|
||||||
|
return skipped;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function listManifestFiles(rootDir, relativeDir = '') {
|
||||||
|
const entries = await fsp.readdir(path.join(rootDir, relativeDir), { withFileTypes: true });
|
||||||
|
const files = [];
|
||||||
|
for (const entry of entries) {
|
||||||
|
const relativePath = path.join(relativeDir, entry.name);
|
||||||
|
if (entry.isDirectory()) {
|
||||||
|
files.push(...await listManifestFiles(rootDir, relativePath));
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (!entry.isFile()) throw new Error(`Backup staging contains a special file: ${relativePath}`);
|
||||||
|
const filePath = path.join(rootDir, relativePath);
|
||||||
|
const stat = await fsp.stat(filePath);
|
||||||
|
files.push({
|
||||||
|
path: relativePath.split(path.sep).join('/'),
|
||||||
|
size: stat.size,
|
||||||
|
sha256: await sha256File(filePath),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return files.sort((left, right) => left.path.localeCompare(right.path));
|
||||||
|
}
|
||||||
|
|
||||||
|
async function createFullBackup({ configurationDatabase, identityService, fleetReportService, jobId }) {
|
||||||
|
const dataDir = resolveDataDir();
|
||||||
|
const jobDir = resolveDataPath(path.join(CONTROL_DIR_NAME, `backup-${jobId}`));
|
||||||
|
const payloadDir = path.join(jobDir, 'data');
|
||||||
|
const archivePath = path.join(jobDir, 'multirover-backup.tar.gz');
|
||||||
|
await fsp.rm(jobDir, { recursive: true, force: true });
|
||||||
|
await fsp.mkdir(payloadDir, { recursive: true });
|
||||||
|
|
||||||
|
try {
|
||||||
|
// Each database owner remains live and writes a coherent SQLite snapshot
|
||||||
|
// directly into the same staging tree as the ordinary durable files.
|
||||||
|
await Promise.all([
|
||||||
|
configurationDatabase.backupDatabase(path.join(payloadDir, DATABASE_NAMES[0])),
|
||||||
|
identityService.backupDatabase(path.join(payloadDir, DATABASE_NAMES[1])),
|
||||||
|
fleetReportService.backupDatabase(path.join(payloadDir, DATABASE_NAMES[2])),
|
||||||
|
]);
|
||||||
|
const skippedUnstableFiles = await copyDurableTree(dataDir, payloadDir);
|
||||||
|
/*
|
||||||
|
Finish every operation that can create a staged file before inventorying
|
||||||
|
the payload. Production databases use WAL mode, so schema inspection must
|
||||||
|
precede both sidecar cleanup and the final immutable file list.
|
||||||
|
*/
|
||||||
|
const databaseSchemaVersions = readDatabaseSchemaVersions(payloadDir);
|
||||||
|
await removeSnapshotSidecars(payloadDir);
|
||||||
|
const files = await listManifestFiles(payloadDir);
|
||||||
|
const manifest = {
|
||||||
|
format: 'multirover-full-backup',
|
||||||
|
formatVersion: FORMAT_VERSION,
|
||||||
|
applicationVersion: packageInfo.version,
|
||||||
|
createdAt: Date.now(),
|
||||||
|
databaseSchemaVersions,
|
||||||
|
files,
|
||||||
|
skippedUnstableFiles,
|
||||||
|
};
|
||||||
|
await fsp.writeFile(path.join(jobDir, 'manifest.json'), `${JSON.stringify(manifest, null, 2)}\n`, 'utf8');
|
||||||
|
await tar.c({ cwd: jobDir, file: archivePath, gzip: true, portable: true }, ['manifest.json', 'data']);
|
||||||
|
return { archivePath, jobDir, manifest };
|
||||||
|
} catch (error) {
|
||||||
|
await fsp.rm(jobDir, { recursive: true, force: true });
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
CONTROL_DIR_NAME,
|
||||||
|
DATABASE_NAMES,
|
||||||
|
FORMAT_VERSION,
|
||||||
|
createFullBackup,
|
||||||
|
readDatabaseSchemaVersions,
|
||||||
|
removeSnapshotSidecars,
|
||||||
|
sha256File,
|
||||||
|
};
|
||||||
@@ -0,0 +1,148 @@
|
|||||||
|
// Backup and Restore Service Tests
|
||||||
|
// Purpose: Verifies complete archive round trips, exclusions, malicious entry rejection, startup replacement, and rollback.
|
||||||
|
// Scope: Uses one isolated SERVER_DATA_DIR and injected SQLite owners; it never reads or changes development server data.
|
||||||
|
const test = require('node:test');
|
||||||
|
const assert = require('node:assert/strict');
|
||||||
|
const fs = require('fs');
|
||||||
|
const fsp = require('fs/promises');
|
||||||
|
const os = require('os');
|
||||||
|
const path = require('path');
|
||||||
|
const Database = require('better-sqlite3');
|
||||||
|
const tar = require('tar');
|
||||||
|
|
||||||
|
const temporaryRoot = fs.mkdtempSync(path.join(os.tmpdir(), 'multirover-backup-restore-'));
|
||||||
|
process.env.SERVER_DATA_DIR = temporaryRoot;
|
||||||
|
|
||||||
|
const { createFullBackup } = require('./backup');
|
||||||
|
const { inspectArchive, prepareRestoreArchive, validateExtractedRestore } = require('./restore');
|
||||||
|
const startupRestore = require('./startupRestore');
|
||||||
|
const VALID_RESTORE_ID = 'a'.repeat(64);
|
||||||
|
|
||||||
|
function createSourceDatabase(name) {
|
||||||
|
/*
|
||||||
|
Real service databases use WAL mode. Keeping fixture sources under the
|
||||||
|
excluded runtime directory both mirrors that behavior and ensures their
|
||||||
|
own live WAL files are not mistaken for ordinary durable backup content.
|
||||||
|
*/
|
||||||
|
const sourceDirectory = path.join(temporaryRoot, 'runtime', 'database-sources');
|
||||||
|
fs.mkdirSync(sourceDirectory, { recursive: true });
|
||||||
|
const filePath = path.join(sourceDirectory, name);
|
||||||
|
const database = new Database(filePath);
|
||||||
|
database.pragma('journal_mode = WAL');
|
||||||
|
database.exec('CREATE TABLE example (value TEXT NOT NULL); INSERT INTO example VALUES (\'preserved\');');
|
||||||
|
if (name === 'configuration.sqlite') {
|
||||||
|
database.exec('CREATE TABLE schema_migrations (version INTEGER PRIMARY KEY); INSERT INTO schema_migrations VALUES (1);');
|
||||||
|
} else if (name === 'identity.sqlite') {
|
||||||
|
database.pragma('user_version = 4');
|
||||||
|
}
|
||||||
|
return database;
|
||||||
|
}
|
||||||
|
|
||||||
|
test.after(() => {
|
||||||
|
fs.rmSync(temporaryRoot, { recursive: true, force: true });
|
||||||
|
});
|
||||||
|
|
||||||
|
test('creates and validates a complete backup while excluding runtime and control data', async () => {
|
||||||
|
await fsp.writeFile(path.join(temporaryRoot, 'state.json'), '{"preserved":true}\n');
|
||||||
|
await fsp.mkdir(path.join(temporaryRoot, 'replays'), { recursive: true });
|
||||||
|
await fsp.writeFile(path.join(temporaryRoot, 'replays', 'complete.mp4'), 'complete replay');
|
||||||
|
await fsp.mkdir(path.join(temporaryRoot, 'runtime'), { recursive: true });
|
||||||
|
await fsp.writeFile(path.join(temporaryRoot, 'runtime', 'active.tmp'), 'discard me');
|
||||||
|
|
||||||
|
const sources = ['configuration.sqlite', 'identity.sqlite', 'fleet-reports.sqlite']
|
||||||
|
.map(createSourceDatabase);
|
||||||
|
const owners = sources.map((database) => ({
|
||||||
|
backupDatabase: (destinationPath) => database.backup(destinationPath),
|
||||||
|
}));
|
||||||
|
const result = await createFullBackup({
|
||||||
|
configurationDatabase: owners[0],
|
||||||
|
identityService: owners[1],
|
||||||
|
fleetReportService: owners[2],
|
||||||
|
jobId: 'test-backup',
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.ok(fs.statSync(result.archivePath).size > 0);
|
||||||
|
assert.ok(result.manifest.files.some((entry) => entry.path === 'state.json'));
|
||||||
|
assert.ok(result.manifest.files.some((entry) => entry.path === 'replays/complete.mp4'));
|
||||||
|
assert.equal(result.manifest.files.some((entry) => entry.path.includes('runtime')), false);
|
||||||
|
assert.equal(result.manifest.files.some((entry) => entry.path.includes('backup-restore')), false);
|
||||||
|
assert.equal(result.manifest.files.some((entry) => entry.path.endsWith('-wal') || entry.path.endsWith('-shm')), false);
|
||||||
|
|
||||||
|
const restoreJob = path.join(temporaryRoot, 'backup-restore', `restore-${VALID_RESTORE_ID}`);
|
||||||
|
await fsp.mkdir(restoreJob, { recursive: true });
|
||||||
|
const uploadedArchive = path.join(restoreJob, 'upload.tar.gz');
|
||||||
|
await fsp.copyFile(result.archivePath, uploadedArchive);
|
||||||
|
const summary = await prepareRestoreArchive({ archivePath: uploadedArchive, jobDir: restoreJob, actor: 'test' });
|
||||||
|
assert.equal(summary.fileCount, result.manifest.files.length);
|
||||||
|
const restoredNames = await fsp.readdir(path.join(restoreJob, 'extracted', 'data'));
|
||||||
|
assert.equal(restoredNames.some((name) => name.endsWith('-wal') || name.endsWith('-shm')), false);
|
||||||
|
|
||||||
|
sources.forEach((database) => database.close());
|
||||||
|
});
|
||||||
|
|
||||||
|
test('rejects a staged restore whose contents no longer match the manifest', async () => {
|
||||||
|
const restoreJob = path.join(temporaryRoot, 'backup-restore', `restore-${VALID_RESTORE_ID}`);
|
||||||
|
const statePath = path.join(restoreJob, 'extracted', 'data', 'state.json');
|
||||||
|
await fsp.writeFile(statePath, '{"tampered":true}\n');
|
||||||
|
await assert.rejects(validateExtractedRestore(path.join(restoreJob, 'extracted')), /checksum or size mismatch/);
|
||||||
|
// Restore the known source content so the following startup-application test
|
||||||
|
// continues to exercise a genuinely validated replacement payload.
|
||||||
|
await fsp.writeFile(statePath, '{"preserved":true}\n');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('rejects symbolic links before extracting an archive', async () => {
|
||||||
|
const unsafeRoot = path.join(temporaryRoot, 'unsafe-archive');
|
||||||
|
await fsp.mkdir(path.join(unsafeRoot, 'data'), { recursive: true });
|
||||||
|
await fsp.writeFile(path.join(unsafeRoot, 'manifest.json'), '{}');
|
||||||
|
await fsp.symlink('/etc/passwd', path.join(unsafeRoot, 'data', 'escape'));
|
||||||
|
const archivePath = path.join(temporaryRoot, 'unsafe.tar.gz');
|
||||||
|
await tar.c({ cwd: unsafeRoot, file: archivePath, gzip: true }, ['manifest.json', 'data']);
|
||||||
|
await assert.rejects(inspectArchive(archivePath), /unsupported entry type/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('applies validated replacement data and removes rollback only after startup succeeds', () => {
|
||||||
|
const restoreId = VALID_RESTORE_ID;
|
||||||
|
const jobDir = path.join(temporaryRoot, 'backup-restore', `restore-${restoreId}`);
|
||||||
|
fs.writeFileSync(path.join(temporaryRoot, 'old-state.txt'), 'old');
|
||||||
|
fs.mkdirSync(path.join(temporaryRoot, 'runtime'), { recursive: true });
|
||||||
|
fs.writeFileSync(path.join(temporaryRoot, 'runtime', 'active.tmp'), 'discard during restore');
|
||||||
|
startupRestore.writeJson(startupRestore.pendingPath, {
|
||||||
|
restoreId,
|
||||||
|
state: 'pending',
|
||||||
|
requestedAt: Date.now(),
|
||||||
|
actor: 'test',
|
||||||
|
});
|
||||||
|
|
||||||
|
const applied = startupRestore.applyPendingRestore();
|
||||||
|
assert.equal(applied.status, 'awaiting-health');
|
||||||
|
assert.equal(fs.existsSync(path.join(temporaryRoot, 'old-state.txt')), false);
|
||||||
|
// Runtime is outside the durable backup payload and can contain state owned
|
||||||
|
// by the separate lifecycle controller, so applying a restore preserves it.
|
||||||
|
assert.equal(fs.readFileSync(path.join(temporaryRoot, 'runtime', 'active.tmp'), 'utf8'), 'discard during restore');
|
||||||
|
assert.equal(fs.readFileSync(path.join(temporaryRoot, 'state.json'), 'utf8'), '{"preserved":true}\n');
|
||||||
|
assert.equal(fs.existsSync(path.join(temporaryRoot, 'backup-restore', 'rollback', 'old-state.txt')), true);
|
||||||
|
|
||||||
|
const completed = startupRestore.markStartupSuccessful();
|
||||||
|
assert.equal(completed.status, 'restored');
|
||||||
|
assert.equal(fs.existsSync(jobDir), false);
|
||||||
|
assert.equal(fs.existsSync(startupRestore.pendingPath), false);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('restores the rollback copy when a replaced application did not reach health', () => {
|
||||||
|
const restoreId = 'b'.repeat(64);
|
||||||
|
const rollbackDir = path.join(temporaryRoot, 'backup-restore', 'rollback');
|
||||||
|
fs.mkdirSync(rollbackDir, { recursive: true });
|
||||||
|
fs.writeFileSync(path.join(rollbackDir, 'state.json'), 'previous state');
|
||||||
|
fs.writeFileSync(path.join(temporaryRoot, 'state.json'), 'failed replacement');
|
||||||
|
startupRestore.writeJson(startupRestore.pendingPath, {
|
||||||
|
restoreId,
|
||||||
|
state: 'awaiting-health',
|
||||||
|
requestedAt: Date.now(),
|
||||||
|
actor: 'test',
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = startupRestore.applyPendingRestore();
|
||||||
|
assert.equal(result.status, 'rolled-back');
|
||||||
|
assert.equal(fs.readFileSync(path.join(temporaryRoot, 'state.json'), 'utf8'), 'previous state');
|
||||||
|
assert.equal(startupRestore.getLastRestoreResult().status, 'rolled-back');
|
||||||
|
});
|
||||||
@@ -0,0 +1,267 @@
|
|||||||
|
// Backup and Restore Service
|
||||||
|
// Purpose: Owns full-data archive creation, browser transfer, staged restore confirmation, startup replacement, and rollback.
|
||||||
|
// Scope: All backup/restore orchestration stays in this service; database owners expose only their online snapshot operations.
|
||||||
|
const fs = require('fs');
|
||||||
|
const fsp = require('fs/promises');
|
||||||
|
const path = require('path');
|
||||||
|
const crypto = require('crypto');
|
||||||
|
const { Transform } = require('stream');
|
||||||
|
const { pipeline } = require('stream/promises');
|
||||||
|
const { resolveDataPath } = require('../../helpers/dataPaths');
|
||||||
|
const { CONTROL_DIR_NAME, createFullBackup } = require('./backup');
|
||||||
|
const { MAX_ARCHIVE_BYTES, prepareRestoreArchive } = require('./restore');
|
||||||
|
const startupRestore = require('./startupRestore');
|
||||||
|
|
||||||
|
const TOKEN_LIFETIME_MS = 10 * 60 * 1000;
|
||||||
|
const controlDir = resolveDataPath(CONTROL_DIR_NAME);
|
||||||
|
const downloads = new Map();
|
||||||
|
const uploads = new Map();
|
||||||
|
let backupInProgress = false;
|
||||||
|
let registered = false;
|
||||||
|
let app;
|
||||||
|
let io;
|
||||||
|
let logger;
|
||||||
|
let getConfigurationDatabase;
|
||||||
|
let identityService;
|
||||||
|
let fleetReportService;
|
||||||
|
let requireLockdownAdministrator;
|
||||||
|
let requireRecentPassword;
|
||||||
|
let requestApplicationRestart;
|
||||||
|
let isApplicationRestartPending;
|
||||||
|
|
||||||
|
function actorFor(socket) {
|
||||||
|
return socket?.data?.user?.username || socket.id;
|
||||||
|
}
|
||||||
|
|
||||||
|
function createToken() {
|
||||||
|
return crypto.randomBytes(32).toString('hex');
|
||||||
|
}
|
||||||
|
|
||||||
|
function pruneExpiredTransfers() {
|
||||||
|
const now = Date.now();
|
||||||
|
for (const [token, transfer] of [...downloads, ...uploads]) {
|
||||||
|
if (transfer.expiresAt > now) continue;
|
||||||
|
downloads.delete(token);
|
||||||
|
uploads.delete(token);
|
||||||
|
if (transfer.jobDir) fsp.rm(transfer.jobDir, { recursive: true, force: true }).catch(() => undefined);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function responseError(cb, error) {
|
||||||
|
logger.warn('Backup or restore request failed', { error: error.message });
|
||||||
|
cb({ error: error.message, code: error.code || null });
|
||||||
|
}
|
||||||
|
|
||||||
|
function removeOrphanedStaging() {
|
||||||
|
let pendingRestoreId = null;
|
||||||
|
try {
|
||||||
|
pendingRestoreId = JSON.parse(fs.readFileSync(startupRestore.pendingPath, 'utf8')).restoreId || null;
|
||||||
|
} catch (error) {
|
||||||
|
if (error.code !== 'ENOENT') throw error;
|
||||||
|
}
|
||||||
|
for (const entry of fs.readdirSync(controlDir, { withFileTypes: true })) {
|
||||||
|
if (!entry.isDirectory()) continue;
|
||||||
|
const preservedName = pendingRestoreId ? `restore-${pendingRestoreId}` : null;
|
||||||
|
if ((entry.name.startsWith('backup-') || entry.name.startsWith('restore-'))
|
||||||
|
&& entry.name !== preservedName) {
|
||||||
|
/*
|
||||||
|
Transfer authorization lives only in process memory. After a restart,
|
||||||
|
an unconfirmed upload or undownloaded archive can no longer be reached,
|
||||||
|
so deleting it prevents abandoned full-data copies from accumulating.
|
||||||
|
*/
|
||||||
|
fs.rmSync(path.join(controlDir, entry.name), { recursive: true, force: true });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function registerSocketApi() {
|
||||||
|
io.on('connection', (socket) => {
|
||||||
|
socket.on('backupRestore:status', (_payload = {}, cb = () => {}) => {
|
||||||
|
try {
|
||||||
|
requireLockdownAdministrator(socket);
|
||||||
|
cb({ success: true, lastRestore: startupRestore.getLastRestoreResult() });
|
||||||
|
} catch (error) {
|
||||||
|
responseError(cb, error);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
socket.on('backupRestore:createBackup', (_payload = {}, cb = () => {}) => {
|
||||||
|
Promise.resolve().then(async () => {
|
||||||
|
requireRecentPassword(socket);
|
||||||
|
if (backupInProgress) throw new Error('A full backup is already being created.');
|
||||||
|
backupInProgress = true;
|
||||||
|
try {
|
||||||
|
pruneExpiredTransfers();
|
||||||
|
const jobId = createToken();
|
||||||
|
const result = await createFullBackup({
|
||||||
|
configurationDatabase: getConfigurationDatabase(),
|
||||||
|
identityService,
|
||||||
|
fleetReportService,
|
||||||
|
jobId,
|
||||||
|
});
|
||||||
|
const token = createToken();
|
||||||
|
downloads.set(token, {
|
||||||
|
archivePath: result.archivePath,
|
||||||
|
jobDir: result.jobDir,
|
||||||
|
expiresAt: Date.now() + TOKEN_LIFETIME_MS,
|
||||||
|
});
|
||||||
|
getConfigurationDatabase().recordAuditEvent(actorFor(socket), 'backup.created', {
|
||||||
|
fileCount: result.manifest.files.length,
|
||||||
|
skippedUnstableFileCount: result.manifest.skippedUnstableFiles.length,
|
||||||
|
});
|
||||||
|
cb({
|
||||||
|
success: true,
|
||||||
|
downloadUrl: `/admin-api/backup/${token}`,
|
||||||
|
fileCount: result.manifest.files.length,
|
||||||
|
skippedUnstableFiles: result.manifest.skippedUnstableFiles,
|
||||||
|
});
|
||||||
|
} finally {
|
||||||
|
backupInProgress = false;
|
||||||
|
}
|
||||||
|
}).catch((error) => responseError(cb, error));
|
||||||
|
});
|
||||||
|
|
||||||
|
socket.on('backupRestore:createRestoreUpload', (_payload = {}, cb = () => {}) => {
|
||||||
|
try {
|
||||||
|
requireRecentPassword(socket);
|
||||||
|
pruneExpiredTransfers();
|
||||||
|
const token = createToken();
|
||||||
|
uploads.set(token, {
|
||||||
|
actor: actorFor(socket),
|
||||||
|
expiresAt: Date.now() + TOKEN_LIFETIME_MS,
|
||||||
|
});
|
||||||
|
cb({ success: true, uploadUrl: `/admin-api/restore/${token}` });
|
||||||
|
} catch (error) {
|
||||||
|
responseError(cb, error);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
socket.on('backupRestore:confirmRestore', ({ restoreId } = {}, cb = () => {}) => {
|
||||||
|
try {
|
||||||
|
requireRecentPassword(socket);
|
||||||
|
const safeRestoreId = String(restoreId || '');
|
||||||
|
if (!/^[a-f0-9]{64}$/.test(safeRestoreId)) throw new Error('Validated restore was not found.');
|
||||||
|
if (isApplicationRestartPending()) throw new Error('Application restart already pending.');
|
||||||
|
if (fs.existsSync(startupRestore.pendingPath)) throw new Error('A restore is already pending.');
|
||||||
|
const jobDir = path.join(controlDir, `restore-${safeRestoreId}`);
|
||||||
|
if (!fs.existsSync(path.join(jobDir, 'validated.json'))) throw new Error('Validated restore was not found.');
|
||||||
|
startupRestore.writeJson(startupRestore.pendingPath, {
|
||||||
|
restoreId: safeRestoreId,
|
||||||
|
state: 'pending',
|
||||||
|
requestedAt: Date.now(),
|
||||||
|
actor: actorFor(socket),
|
||||||
|
});
|
||||||
|
getConfigurationDatabase().recordAuditEvent(actorFor(socket), 'restore.requested', { restoreId: safeRestoreId });
|
||||||
|
requestApplicationRestart({ actor: actorFor(socket), reason: 'restore-requested' });
|
||||||
|
cb({ success: true });
|
||||||
|
} catch (error) {
|
||||||
|
responseError(cb, error);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function registerHttpApi() {
|
||||||
|
app.get('/admin-api/backup/:token', (req, res) => {
|
||||||
|
pruneExpiredTransfers();
|
||||||
|
const transfer = downloads.get(String(req.params.token || ''));
|
||||||
|
if (!transfer) {
|
||||||
|
res.status(404).send('Backup download is missing or expired.');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
downloads.delete(req.params.token);
|
||||||
|
res.set({
|
||||||
|
'Content-Type': 'application/gzip',
|
||||||
|
'Content-Disposition': `attachment; filename="multirover-backup-${new Date().toISOString().slice(0, 10)}.tar.gz"`,
|
||||||
|
'Cache-Control': 'no-store',
|
||||||
|
});
|
||||||
|
const cleanup = () => fsp.rm(transfer.jobDir, { recursive: true, force: true }).catch(() => undefined);
|
||||||
|
res.once('close', cleanup);
|
||||||
|
fs.createReadStream(transfer.archivePath).on('error', (error) => {
|
||||||
|
logger.warn('Backup download failed', { error: error.message });
|
||||||
|
if (!res.headersSent) res.status(500).end();
|
||||||
|
else res.destroy(error);
|
||||||
|
}).pipe(res);
|
||||||
|
});
|
||||||
|
|
||||||
|
app.put('/admin-api/restore/:token', async (req, res) => {
|
||||||
|
pruneExpiredTransfers();
|
||||||
|
const token = String(req.params.token || '');
|
||||||
|
const transfer = uploads.get(token);
|
||||||
|
uploads.delete(token);
|
||||||
|
if (!transfer) {
|
||||||
|
res.status(404).json({ error: 'Restore upload is missing or expired.' });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const contentLength = Number(req.headers['content-length']);
|
||||||
|
if (Number.isFinite(contentLength) && contentLength > MAX_ARCHIVE_BYTES) {
|
||||||
|
res.status(413).json({ error: 'Backup archive exceeds the restore size limit.' });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const restoreId = createToken();
|
||||||
|
const jobDir = path.join(controlDir, `restore-${restoreId}`);
|
||||||
|
const archivePath = path.join(jobDir, 'upload.tar.gz');
|
||||||
|
try {
|
||||||
|
await fsp.mkdir(jobDir, { recursive: true });
|
||||||
|
let receivedBytes = 0;
|
||||||
|
const limiter = new Transform({
|
||||||
|
transform(chunk, _encoding, callback) {
|
||||||
|
receivedBytes += chunk.length;
|
||||||
|
callback(receivedBytes > MAX_ARCHIVE_BYTES
|
||||||
|
? new Error('Backup archive exceeds the restore size limit.')
|
||||||
|
: null, chunk);
|
||||||
|
},
|
||||||
|
});
|
||||||
|
await pipeline(req, limiter, fs.createWriteStream(archivePath, { mode: 0o600 }));
|
||||||
|
const summary = await prepareRestoreArchive({ archivePath, jobDir, actor: transfer.actor });
|
||||||
|
getConfigurationDatabase().recordAuditEvent(transfer.actor, 'restore.validated', {
|
||||||
|
restoreId,
|
||||||
|
fileCount: summary.fileCount,
|
||||||
|
totalBytes: summary.totalBytes,
|
||||||
|
});
|
||||||
|
res.set('Cache-Control', 'no-store').json({ success: true, restoreId, summary });
|
||||||
|
} catch (error) {
|
||||||
|
await fsp.rm(jobDir, { recursive: true, force: true });
|
||||||
|
logger.warn('Restore upload failed validation', { actor: transfer.actor, error: error.message });
|
||||||
|
res.status(error.message.includes('size limit') ? 413 : 400).json({ error: error.message });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function register() {
|
||||||
|
if (registered) return;
|
||||||
|
registered = true;
|
||||||
|
/*
|
||||||
|
These runtime dependencies are deliberately loaded only after earliest
|
||||||
|
startup restore has run. Several of them open SQLite immediately, so
|
||||||
|
importing them at module scope would make replacement too late and unsafe.
|
||||||
|
*/
|
||||||
|
({ app } = require('../../globals/http'));
|
||||||
|
io = require('../../globals/io');
|
||||||
|
logger = require('../../globals/logger').child('backupRestoreService');
|
||||||
|
({ getConfigurationDatabase } = require('../../configuration'));
|
||||||
|
identityService = require('../identityService');
|
||||||
|
fleetReportService = require('../fleetReportService');
|
||||||
|
({ requireLockdownAdministrator, requireRecentPassword } = require('../adminConfigurationService'));
|
||||||
|
({ isApplicationRestartPending, requestApplicationRestart } = require('../serverControlService'));
|
||||||
|
fs.mkdirSync(controlDir, { recursive: true });
|
||||||
|
removeOrphanedStaging();
|
||||||
|
registerHttpApi();
|
||||||
|
registerSocketApi();
|
||||||
|
}
|
||||||
|
|
||||||
|
function markStartupSuccessful() {
|
||||||
|
const result = startupRestore.markStartupSuccessful();
|
||||||
|
if (result) {
|
||||||
|
const configuration = require('../../configuration');
|
||||||
|
configuration.getConfigurationDatabase().recordAuditEvent('system', 'restore.completed', { restoreId: result.restoreId });
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
applyPendingRestore: startupRestore.applyPendingRestore,
|
||||||
|
markStartupSuccessful,
|
||||||
|
register,
|
||||||
|
};
|
||||||
@@ -0,0 +1,216 @@
|
|||||||
|
// Full Data Restore Validation
|
||||||
|
// Purpose: Safely extracts and validates an uploaded MultiRover backup before it can become a pending restore.
|
||||||
|
// Scope: Never changes active data; startupRestore owns the later replacement and rollback transaction.
|
||||||
|
const fs = require('fs');
|
||||||
|
const fsp = require('fs/promises');
|
||||||
|
const path = require('path');
|
||||||
|
const Database = require('better-sqlite3');
|
||||||
|
const tar = require('tar');
|
||||||
|
const {
|
||||||
|
DATABASE_NAMES,
|
||||||
|
FORMAT_VERSION,
|
||||||
|
readDatabaseSchemaVersions,
|
||||||
|
removeSnapshotSidecars,
|
||||||
|
sha256File,
|
||||||
|
} = require('./backup');
|
||||||
|
|
||||||
|
const MAX_ARCHIVE_BYTES = 100 * 1024 * 1024 * 1024;
|
||||||
|
const MAX_EXTRACTED_BYTES = 200 * 1024 * 1024 * 1024;
|
||||||
|
const MAX_ARCHIVE_ENTRIES = 100000;
|
||||||
|
const RESERVED_DATA_NAMES = new Set(['backup-restore', 'runtime']);
|
||||||
|
const SUPPORTED_DATABASE_SCHEMA_VERSIONS = {
|
||||||
|
configuration: 2,
|
||||||
|
identity: 4,
|
||||||
|
fleetReports: 0,
|
||||||
|
};
|
||||||
|
|
||||||
|
function normalizeArchivePath(value) {
|
||||||
|
const raw = String(value || '');
|
||||||
|
if (!raw || raw.includes('\\') || path.posix.isAbsolute(raw)) return null;
|
||||||
|
const withoutTrailingSlash = raw.replace(/\/+$/, '');
|
||||||
|
const normalized = path.posix.normalize(withoutTrailingSlash);
|
||||||
|
if (!normalized || normalized === '.' || normalized === '..' || normalized.startsWith('../')) return null;
|
||||||
|
return normalized;
|
||||||
|
}
|
||||||
|
|
||||||
|
function assertAllowedArchiveEntry(entry) {
|
||||||
|
const normalized = normalizeArchivePath(entry.path);
|
||||||
|
if (!normalized || (normalized !== 'manifest.json' && normalized !== 'data' && !normalized.startsWith('data/'))) {
|
||||||
|
throw new Error(`Backup contains an invalid archive path: ${entry.path}`);
|
||||||
|
}
|
||||||
|
if (!['File', 'Directory'].includes(entry.type)) {
|
||||||
|
throw new Error(`Backup contains unsupported entry type ${entry.type}: ${entry.path}`);
|
||||||
|
}
|
||||||
|
if (normalized.startsWith('data/')) {
|
||||||
|
const topLevelName = normalized.slice('data/'.length).split('/')[0];
|
||||||
|
if (RESERVED_DATA_NAMES.has(topLevelName)) {
|
||||||
|
throw new Error(`Backup contains reserved data path: ${entry.path}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return normalized;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function inspectArchive(archivePath) {
|
||||||
|
let entryCount = 0;
|
||||||
|
let extractedBytes = 0;
|
||||||
|
const paths = new Set();
|
||||||
|
let validationError = null;
|
||||||
|
await tar.t({
|
||||||
|
file: archivePath,
|
||||||
|
strict: true,
|
||||||
|
onentry: (entry) => {
|
||||||
|
if (validationError) return;
|
||||||
|
try {
|
||||||
|
entryCount += 1;
|
||||||
|
extractedBytes += Number(entry.size) || 0;
|
||||||
|
if (entryCount > MAX_ARCHIVE_ENTRIES) throw new Error('Backup contains too many files.');
|
||||||
|
if (extractedBytes > MAX_EXTRACTED_BYTES) throw new Error('Backup expands beyond the restore size limit.');
|
||||||
|
const normalized = assertAllowedArchiveEntry(entry);
|
||||||
|
if (paths.has(normalized)) throw new Error(`Backup contains duplicate path: ${normalized}`);
|
||||||
|
paths.add(normalized);
|
||||||
|
} catch (error) {
|
||||||
|
/*
|
||||||
|
tar invokes onentry from its parser event stack, where throwing would
|
||||||
|
become an uncaught exception instead of rejecting tar.t(). Retain the
|
||||||
|
first failure and raise it immediately after the bounded listing.
|
||||||
|
*/
|
||||||
|
validationError = error;
|
||||||
|
}
|
||||||
|
},
|
||||||
|
});
|
||||||
|
if (validationError) throw validationError;
|
||||||
|
if (!paths.has('manifest.json') || !paths.has('data')) {
|
||||||
|
throw new Error('Backup must contain manifest.json and one data directory.');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function listExtractedFiles(rootDir, relativeDir = '') {
|
||||||
|
const entries = await fsp.readdir(path.join(rootDir, relativeDir), { withFileTypes: true });
|
||||||
|
const files = [];
|
||||||
|
for (const entry of entries) {
|
||||||
|
const relativePath = path.join(relativeDir, entry.name);
|
||||||
|
const fullPath = path.join(rootDir, relativePath);
|
||||||
|
const stat = await fsp.lstat(fullPath);
|
||||||
|
if (stat.isSymbolicLink()) throw new Error(`Restored data contains symbolic link: ${relativePath}`);
|
||||||
|
if (stat.isDirectory()) {
|
||||||
|
files.push(...await listExtractedFiles(rootDir, relativePath));
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (!stat.isFile()) throw new Error(`Restored data contains special file: ${relativePath}`);
|
||||||
|
files.push({
|
||||||
|
path: relativePath.split(path.sep).join('/'),
|
||||||
|
size: stat.size,
|
||||||
|
sha256: await sha256File(fullPath),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return files.sort((left, right) => left.path.localeCompare(right.path));
|
||||||
|
}
|
||||||
|
|
||||||
|
function verifySqliteDatabase(filePath, name) {
|
||||||
|
const database = new Database(filePath, { readonly: true, fileMustExist: true });
|
||||||
|
try {
|
||||||
|
const result = database.pragma('quick_check', { simple: true });
|
||||||
|
if (result !== 'ok') throw new Error(`${name} failed SQLite integrity validation.`);
|
||||||
|
} finally {
|
||||||
|
database.close();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function validateExtractedRestore(extractDir) {
|
||||||
|
const manifestPath = path.join(extractDir, 'manifest.json');
|
||||||
|
const payloadDir = path.join(extractDir, 'data');
|
||||||
|
const manifestStat = await fsp.stat(manifestPath);
|
||||||
|
if (manifestStat.size > 10 * 1024 * 1024) throw new Error('Backup manifest is unreasonably large.');
|
||||||
|
const manifest = JSON.parse(await fsp.readFile(manifestPath, 'utf8'));
|
||||||
|
if (manifest.format !== 'multirover-full-backup' || manifest.formatVersion !== FORMAT_VERSION) {
|
||||||
|
throw new Error('Backup format or version is not supported.');
|
||||||
|
}
|
||||||
|
if (!Array.isArray(manifest.files)) throw new Error('Backup manifest has no file inventory.');
|
||||||
|
|
||||||
|
const expected = [...manifest.files].sort((left, right) => String(left.path).localeCompare(String(right.path)));
|
||||||
|
const actual = await listExtractedFiles(payloadDir);
|
||||||
|
if (expected.length !== actual.length) {
|
||||||
|
/*
|
||||||
|
Keep the strict complete-inventory check, but identify a few differences
|
||||||
|
so an operator can distinguish a missing file from an unexpected archive
|
||||||
|
entry without weakening restore validation or exposing file contents.
|
||||||
|
*/
|
||||||
|
const expectedPaths = new Set(expected.map((entry) => entry.path));
|
||||||
|
const actualPaths = new Set(actual.map((entry) => entry.path));
|
||||||
|
const missing = expected.filter((entry) => !actualPaths.has(entry.path)).map((entry) => entry.path).slice(0, 5);
|
||||||
|
const unexpected = actual.filter((entry) => !expectedPaths.has(entry.path)).map((entry) => entry.path).slice(0, 5);
|
||||||
|
const details = [
|
||||||
|
missing.length ? `missing: ${missing.join(', ')}` : '',
|
||||||
|
unexpected.length ? `unexpected: ${unexpected.join(', ')}` : '',
|
||||||
|
].filter(Boolean).join('; ');
|
||||||
|
throw new Error(`Backup file inventory does not match the archive${details ? ` (${details})` : ''}.`);
|
||||||
|
}
|
||||||
|
for (let index = 0; index < expected.length; index += 1) {
|
||||||
|
const wanted = expected[index];
|
||||||
|
const found = actual[index];
|
||||||
|
if (wanted.path !== found.path || wanted.size !== found.size || wanted.sha256 !== found.sha256) {
|
||||||
|
throw new Error(`Backup checksum or size mismatch: ${wanted.path || found.path}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const databaseName of DATABASE_NAMES) {
|
||||||
|
if (!actual.some((entry) => entry.path === databaseName)) {
|
||||||
|
throw new Error(`Backup is missing required database: ${databaseName}`);
|
||||||
|
}
|
||||||
|
verifySqliteDatabase(path.join(payloadDir, databaseName), databaseName);
|
||||||
|
}
|
||||||
|
const actualSchemaVersions = readDatabaseSchemaVersions(payloadDir);
|
||||||
|
for (const [databaseName, version] of Object.entries(actualSchemaVersions)) {
|
||||||
|
// JSON object property order has no meaning. Compare each known database by
|
||||||
|
// name so an otherwise valid manifest is not rejected merely because a
|
||||||
|
// different JSON writer emitted its keys in another order.
|
||||||
|
if (Number(manifest.databaseSchemaVersions?.[databaseName]) !== version) {
|
||||||
|
throw new Error('Backup database schema versions do not match its manifest.');
|
||||||
|
}
|
||||||
|
if (version > SUPPORTED_DATABASE_SCHEMA_VERSIONS[databaseName]) {
|
||||||
|
throw new Error(`Backup ${databaseName} database is newer than this application supports.`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
/*
|
||||||
|
Integrity and schema reads can create fresh WAL coordination files even
|
||||||
|
though the uploaded snapshot initially matched its manifest exactly. Remove
|
||||||
|
those validation-only files so startup applies only inventoried content.
|
||||||
|
*/
|
||||||
|
await removeSnapshotSidecars(payloadDir);
|
||||||
|
return manifest;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function prepareRestoreArchive({ archivePath, jobDir, actor }) {
|
||||||
|
const archiveStat = await fsp.stat(archivePath);
|
||||||
|
if (!archiveStat.isFile() || archiveStat.size <= 0 || archiveStat.size > MAX_ARCHIVE_BYTES) {
|
||||||
|
throw new Error('Backup archive is empty or exceeds the restore size limit.');
|
||||||
|
}
|
||||||
|
await inspectArchive(archivePath);
|
||||||
|
const extractDir = path.join(jobDir, 'extracted');
|
||||||
|
await fsp.rm(extractDir, { recursive: true, force: true });
|
||||||
|
await fsp.mkdir(extractDir, { recursive: true });
|
||||||
|
// Data files never need executable or set-id permissions from an uploaded
|
||||||
|
// archive. Let the server account's umask choose safe extraction modes.
|
||||||
|
await tar.x({ cwd: extractDir, file: archivePath, strict: true, preservePaths: false, noChmod: true });
|
||||||
|
const manifest = await validateExtractedRestore(extractDir);
|
||||||
|
const summary = {
|
||||||
|
createdAt: manifest.createdAt,
|
||||||
|
applicationVersion: manifest.applicationVersion,
|
||||||
|
fileCount: manifest.files.length,
|
||||||
|
totalBytes: manifest.files.reduce((total, entry) => total + Number(entry.size || 0), 0),
|
||||||
|
skippedUnstableFiles: Array.isArray(manifest.skippedUnstableFiles) ? manifest.skippedUnstableFiles : [],
|
||||||
|
};
|
||||||
|
await fsp.writeFile(
|
||||||
|
path.join(jobDir, 'validated.json'),
|
||||||
|
`${JSON.stringify({ actor, validatedAt: Date.now(), summary }, null, 2)}\n`,
|
||||||
|
{ encoding: 'utf8', mode: 0o600 },
|
||||||
|
);
|
||||||
|
return summary;
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
MAX_ARCHIVE_BYTES,
|
||||||
|
inspectArchive,
|
||||||
|
prepareRestoreArchive,
|
||||||
|
validateExtractedRestore,
|
||||||
|
};
|
||||||
@@ -0,0 +1,147 @@
|
|||||||
|
// Startup Data Restore
|
||||||
|
// Purpose: Applies a previously validated restore before any application database opens and rolls back an interrupted start.
|
||||||
|
// Scope: Operates only on top-level entries inside SERVER_DATA_DIR while preserving backupRestoreService control state.
|
||||||
|
const fs = require('fs');
|
||||||
|
const path = require('path');
|
||||||
|
const { resolveDataDir, resolveDataPath } = require('../../helpers/dataPaths');
|
||||||
|
const { CONTROL_DIR_NAME } = require('./backup');
|
||||||
|
|
||||||
|
const controlDir = resolveDataPath(CONTROL_DIR_NAME);
|
||||||
|
const pendingPath = path.join(controlDir, 'pending.json');
|
||||||
|
const rollbackDir = path.join(controlDir, 'rollback');
|
||||||
|
const lastResultPath = path.join(controlDir, 'last-result.json');
|
||||||
|
|
||||||
|
function writeJson(filePath, value) {
|
||||||
|
fs.mkdirSync(path.dirname(filePath), { recursive: true });
|
||||||
|
const temporaryPath = `${filePath}.tmp`;
|
||||||
|
fs.writeFileSync(temporaryPath, `${JSON.stringify(value, null, 2)}\n`, { encoding: 'utf8', mode: 0o600 });
|
||||||
|
fs.renameSync(temporaryPath, filePath);
|
||||||
|
}
|
||||||
|
|
||||||
|
function readPending() {
|
||||||
|
try {
|
||||||
|
return JSON.parse(fs.readFileSync(pendingPath, 'utf8'));
|
||||||
|
} catch (error) {
|
||||||
|
if (error.code === 'ENOENT') return null;
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function listActiveDataEntries({ includeRuntime = true } = {}) {
|
||||||
|
fs.mkdirSync(resolveDataDir(), { recursive: true });
|
||||||
|
return fs.readdirSync(resolveDataDir()).filter((name) => (
|
||||||
|
name !== CONTROL_DIR_NAME && (includeRuntime || name !== 'runtime')
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
function removeActiveData() {
|
||||||
|
// Runtime contains disposable work owned by active companion processes as
|
||||||
|
// well as the lifecycle controller's status directory. It is deliberately
|
||||||
|
// absent from backup archives, so restore must leave it untouched instead
|
||||||
|
// of trying to delete root-owned controller state from the non-root server.
|
||||||
|
for (const name of listActiveDataEntries({ includeRuntime: false })) {
|
||||||
|
fs.rmSync(path.join(resolveDataDir(), name), { recursive: true, force: true });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function moveChildren(sourceDir, destinationDir) {
|
||||||
|
fs.mkdirSync(destinationDir, { recursive: true });
|
||||||
|
for (const name of fs.readdirSync(sourceDir)) {
|
||||||
|
fs.renameSync(path.join(sourceDir, name), path.join(destinationDir, name));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function restoreRollback(pending, errorMessage) {
|
||||||
|
removeActiveData();
|
||||||
|
moveChildren(rollbackDir, resolveDataDir());
|
||||||
|
writeJson(lastResultPath, {
|
||||||
|
status: 'rolled-back',
|
||||||
|
restoreId: pending.restoreId,
|
||||||
|
completedAt: Date.now(),
|
||||||
|
error: errorMessage,
|
||||||
|
});
|
||||||
|
fs.rmSync(pendingPath, { force: true });
|
||||||
|
}
|
||||||
|
|
||||||
|
function applyPendingRestore() {
|
||||||
|
const pending = readPending();
|
||||||
|
if (!pending) return null;
|
||||||
|
|
||||||
|
/*
|
||||||
|
Reaching startup again in either state means the replacement process did
|
||||||
|
not reach the HTTP-listening success marker. The complete rollback copy was
|
||||||
|
created before active data was touched, so restoring it is deterministic.
|
||||||
|
*/
|
||||||
|
if (pending.state === 'applying' || pending.state === 'awaiting-health') {
|
||||||
|
restoreRollback(pending, 'The restored application did not finish starting.');
|
||||||
|
return { status: 'rolled-back', restoreId: pending.restoreId };
|
||||||
|
}
|
||||||
|
|
||||||
|
const jobDir = path.join(controlDir, `restore-${pending.restoreId}`);
|
||||||
|
const replacementDir = path.join(jobDir, 'extracted', 'data');
|
||||||
|
if (!fs.existsSync(path.join(jobDir, 'validated.json'))
|
||||||
|
|| !fs.existsSync(replacementDir)
|
||||||
|
|| !fs.statSync(replacementDir).isDirectory()) {
|
||||||
|
fs.rmSync(pendingPath, { force: true });
|
||||||
|
writeJson(lastResultPath, {
|
||||||
|
status: 'failed',
|
||||||
|
restoreId: pending.restoreId,
|
||||||
|
completedAt: Date.now(),
|
||||||
|
error: 'Validated restore staging is missing.',
|
||||||
|
});
|
||||||
|
return { status: 'failed', restoreId: pending.restoreId };
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
fs.rmSync(rollbackDir, { recursive: true, force: true });
|
||||||
|
fs.mkdirSync(rollbackDir, { recursive: true });
|
||||||
|
// Startup runs before any database or writer opens. Copying the entire
|
||||||
|
// current payload first gives every later replacement step one complete,
|
||||||
|
// local rollback source even if the process is interrupted halfway through.
|
||||||
|
for (const name of listActiveDataEntries({ includeRuntime: false })) {
|
||||||
|
fs.cpSync(path.join(resolveDataDir(), name), path.join(rollbackDir, name), { recursive: true });
|
||||||
|
}
|
||||||
|
writeJson(pendingPath, { ...pending, state: 'applying', applyingAt: Date.now() });
|
||||||
|
removeActiveData();
|
||||||
|
moveChildren(replacementDir, resolveDataDir());
|
||||||
|
writeJson(pendingPath, { ...pending, state: 'awaiting-health', appliedAt: Date.now() });
|
||||||
|
return { status: 'awaiting-health', restoreId: pending.restoreId };
|
||||||
|
} catch (error) {
|
||||||
|
if (fs.existsSync(rollbackDir)) restoreRollback(pending, error.message);
|
||||||
|
else fs.rmSync(pendingPath, { force: true });
|
||||||
|
return { status: 'rolled-back', restoreId: pending.restoreId, error: error.message };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function markStartupSuccessful() {
|
||||||
|
const pending = readPending();
|
||||||
|
if (!pending || pending.state !== 'awaiting-health') return null;
|
||||||
|
const jobDir = path.join(controlDir, `restore-${pending.restoreId}`);
|
||||||
|
fs.rmSync(rollbackDir, { recursive: true, force: true });
|
||||||
|
fs.rmSync(jobDir, { recursive: true, force: true });
|
||||||
|
fs.rmSync(pendingPath, { force: true });
|
||||||
|
const result = {
|
||||||
|
status: 'restored',
|
||||||
|
restoreId: pending.restoreId,
|
||||||
|
completedAt: Date.now(),
|
||||||
|
};
|
||||||
|
writeJson(lastResultPath, result);
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
function getLastRestoreResult() {
|
||||||
|
try {
|
||||||
|
return JSON.parse(fs.readFileSync(lastResultPath, 'utf8'));
|
||||||
|
} catch (error) {
|
||||||
|
if (error.code === 'ENOENT') return null;
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
applyPendingRestore,
|
||||||
|
getLastRestoreResult,
|
||||||
|
markStartupSuccessful,
|
||||||
|
pendingPath,
|
||||||
|
writeJson,
|
||||||
|
};
|
||||||
@@ -8,7 +8,7 @@ module.exports = {
|
|||||||
feature: true,
|
feature: true,
|
||||||
defaultValue: { enabled: false, simulate: false },
|
defaultValue: { enabled: false, simulate: false },
|
||||||
schema: strictObject({
|
schema: strictObject({
|
||||||
enabled: boolean({ description: 'Starts the Wii Balance Board service and exposes its readings and controls after restart.' }),
|
enabled: boolean({ description: 'Immediately starts the Wii Balance Board service and exposes its readings and controls.' }),
|
||||||
simulate: boolean({ description: 'Runs the native worker with generated cyclic sensor data instead of connecting to Bluetooth hardware.' }),
|
simulate: boolean({ description: 'Runs the native worker with generated cyclic sensor data instead of connecting to Bluetooth hardware.' }),
|
||||||
}, {
|
}, {
|
||||||
title: 'Balance Board',
|
title: 'Balance Board',
|
||||||
|
|||||||
@@ -7,15 +7,15 @@ const { promisify } = require('util');
|
|||||||
const EventEmitter = require('events');
|
const EventEmitter = require('events');
|
||||||
const io = require('../../globals/io');
|
const io = require('../../globals/io');
|
||||||
const logger = require('../../globals/logger').child('balanceBoardService');
|
const logger = require('../../globals/logger').child('balanceBoardService');
|
||||||
const { loadConfig } = require('../../configuration');
|
const { loadConfig, registerConfigurationHandler } = require('../../configuration');
|
||||||
const { resolveDataDir, resolveDataPath } = require('../../helpers/dataPaths');
|
const { resolveDataDir, resolveDataPath } = require('../../helpers/dataPaths');
|
||||||
const { isAdmin } = require('../roleService');
|
const { isAdmin } = require('../roleService');
|
||||||
const { sendAlert } = require('../alertService');
|
const { sendAlert } = require('../alertService');
|
||||||
const { createBalanceBoardHardware } = require('./hardware');
|
const { createBalanceBoardHardware } = require('./hardware');
|
||||||
|
|
||||||
const events = new EventEmitter();
|
const events = new EventEmitter();
|
||||||
const rawConfig = loadConfig().balanceBoard || {};
|
let rawConfig = loadConfig().balanceBoard || {};
|
||||||
const enabled = Boolean(rawConfig.enabled);
|
let enabled = Boolean(rawConfig.enabled);
|
||||||
const DATA_DIR = resolveDataDir();
|
const DATA_DIR = resolveDataDir();
|
||||||
const STORE_PATH = resolveDataPath('balance-board.json');
|
const STORE_PATH = resolveDataPath('balance-board.json');
|
||||||
const FRAME_ROOM = 'balance-board-viewers';
|
const FRAME_ROOM = 'balance-board-viewers';
|
||||||
@@ -452,12 +452,14 @@ function handleWorkerMessage(message = {}) {
|
|||||||
|
|
||||||
io.on('connection', (socket) => {
|
io.on('connection', (socket) => {
|
||||||
socket.on('balanceBoard:subscribe', (_payload = {}, cb = () => {}) => {
|
socket.on('balanceBoard:subscribe', (_payload = {}, cb = () => {}) => {
|
||||||
|
if (!enabled) return cb({ error: 'Balance Board is disabled' });
|
||||||
socket.join(FRAME_ROOM);
|
socket.join(FRAME_ROOM);
|
||||||
if (latestFrame) socket.emit('balanceBoard:frame', latestFrame);
|
if (latestFrame) socket.emit('balanceBoard:frame', latestFrame);
|
||||||
cb({ success: true });
|
cb({ success: true });
|
||||||
});
|
});
|
||||||
socket.on('balanceBoard:unsubscribe', () => socket.leave(FRAME_ROOM));
|
socket.on('balanceBoard:unsubscribe', () => socket.leave(FRAME_ROOM));
|
||||||
socket.on('balanceBoard:zero', (_payload = {}, cb = () => {}) => {
|
socket.on('balanceBoard:zero', (_payload = {}, cb = () => {}) => {
|
||||||
|
if (!enabled) return cb({ error: 'Balance Board is disabled' });
|
||||||
if (!isAdmin(socket)) {
|
if (!isAdmin(socket)) {
|
||||||
cb({ error: 'Admin access required' });
|
cb({ error: 'Admin access required' });
|
||||||
return;
|
return;
|
||||||
@@ -470,6 +472,7 @@ io.on('connection', (socket) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
socket.on('balanceBoard:resetRecord', (_payload = {}, cb = () => {}) => {
|
socket.on('balanceBoard:resetRecord', (_payload = {}, cb = () => {}) => {
|
||||||
|
if (!enabled) return cb({ error: 'Balance Board is disabled' });
|
||||||
if (!isAdmin(socket)) {
|
if (!isAdmin(socket)) {
|
||||||
cb({ error: 'Admin access required' });
|
cb({ error: 'Admin access required' });
|
||||||
return;
|
return;
|
||||||
@@ -484,6 +487,7 @@ io.on('connection', (socket) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
socket.on('balanceBoard:unpair', async (_payload = {}, cb = () => {}) => {
|
socket.on('balanceBoard:unpair', async (_payload = {}, cb = () => {}) => {
|
||||||
|
if (!enabled) return cb({ error: 'Balance Board is disabled' });
|
||||||
if (!isAdmin(socket)) {
|
if (!isAdmin(socket)) {
|
||||||
cb({ error: 'Admin access required' });
|
cb({ error: 'Admin access required' });
|
||||||
return;
|
return;
|
||||||
@@ -546,7 +550,7 @@ io.on('connection', (socket) => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
if (enabled) {
|
function startHardware() {
|
||||||
hardware = createBalanceBoardHardware({
|
hardware = createBalanceBoardHardware({
|
||||||
logger,
|
logger,
|
||||||
address: store.address,
|
address: store.address,
|
||||||
@@ -554,10 +558,38 @@ if (enabled) {
|
|||||||
});
|
});
|
||||||
hardware.events.on('message', handleWorkerMessage);
|
hardware.events.on('message', handleWorkerMessage);
|
||||||
hardware.start();
|
hardware.start();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (enabled) {
|
||||||
|
startHardware();
|
||||||
} else {
|
} else {
|
||||||
logger.info('Balance Board disabled by config');
|
logger.info('Balance Board disabled by config');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
registerConfigurationHandler('balanceBoard', (nextConfig = {}) => {
|
||||||
|
const wasEnabled = enabled;
|
||||||
|
hardware?.stop();
|
||||||
|
hardware = null;
|
||||||
|
clearZeroTimer();
|
||||||
|
rawConfig = nextConfig;
|
||||||
|
enabled = Boolean(rawConfig.enabled);
|
||||||
|
if (!wasEnabled && enabled) store = loadStore();
|
||||||
|
connected = false;
|
||||||
|
batteryPercent = null;
|
||||||
|
latestFrame = null;
|
||||||
|
latestRawCorners = null;
|
||||||
|
latestRawFrameAt = 0;
|
||||||
|
if (enabled) {
|
||||||
|
status = store.address ? 'waiting' : 'starting';
|
||||||
|
detail = store.address ? 'Press the front power button.' : 'Starting Bluetooth discovery.';
|
||||||
|
startHardware();
|
||||||
|
} else {
|
||||||
|
status = 'disabled';
|
||||||
|
detail = 'Balance Board support is disabled.';
|
||||||
|
}
|
||||||
|
events.emit('change', getState());
|
||||||
|
});
|
||||||
|
|
||||||
function installShutdownHooks() {
|
function installShutdownHooks() {
|
||||||
const shutdown = () => {
|
const shutdown = () => {
|
||||||
clearZeroTimer();
|
clearZeroTimer();
|
||||||
|
|||||||
@@ -5,7 +5,7 @@
|
|||||||
// remain thin IO surfaces that subscribe to state and send votes/scans.
|
// remain thin IO surfaces that subscribe to state and send votes/scans.
|
||||||
const io = require('../../globals/io');
|
const io = require('../../globals/io');
|
||||||
const logger = require('../../globals/logger').child('barcodeGameService');
|
const logger = require('../../globals/logger').child('barcodeGameService');
|
||||||
const { loadConfig } = require('../../configuration');
|
const { loadConfig, registerConfigurationHandler } = require('../../configuration');
|
||||||
const { subscribe } = require('../eventBus');
|
const { subscribe } = require('../eventBus');
|
||||||
const { sendSystemMessage } = require('../chatService');
|
const { sendSystemMessage } = require('../chatService');
|
||||||
const { getActiveDrivers } = require('../turnService');
|
const { getActiveDrivers } = require('../turnService');
|
||||||
@@ -28,11 +28,17 @@ const RESULTS_WINDOW_MS = 45 * 1000;
|
|||||||
|
|
||||||
const GAME_DEFINITIONS = [scanQuest, scansPerSecond, mostItems];
|
const GAME_DEFINITIONS = [scanQuest, scansPerSecond, mostItems];
|
||||||
const GAMES_BY_ID = Object.fromEntries(GAME_DEFINITIONS.map((game) => [game.id, game]));
|
const GAMES_BY_ID = Object.fromEntries(GAME_DEFINITIONS.map((game) => [game.id, game]));
|
||||||
const config = loadConfig();
|
let enabled;
|
||||||
const barcodeGamesConfig = config.barcodeGames || {};
|
let botName;
|
||||||
const enabled = Boolean(barcodeGamesConfig.enabled);
|
let botProfileImageUrl;
|
||||||
const botName = String(barcodeGamesConfig.botName || 'Barcode Games').trim() || 'Barcode Games';
|
|
||||||
const botProfileImageUrl = String(barcodeGamesConfig.profileImageUrl || '').trim() || null;
|
function applyBarcodeGameConfig(barcodeGamesConfig = {}) {
|
||||||
|
enabled = Boolean(barcodeGamesConfig.enabled);
|
||||||
|
botName = String(barcodeGamesConfig.botName || 'Barcode Games').trim() || 'Barcode Games';
|
||||||
|
botProfileImageUrl = String(barcodeGamesConfig.profileImageUrl || '').trim() || null;
|
||||||
|
}
|
||||||
|
|
||||||
|
applyBarcodeGameConfig(loadConfig().barcodeGames || {});
|
||||||
|
|
||||||
function sendBarcodeGameChat(text) {
|
function sendBarcodeGameChat(text) {
|
||||||
const message = String(text || '').trim();
|
const message = String(text || '').trim();
|
||||||
@@ -767,6 +773,7 @@ function settleActiveGameIfNeeded() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function handleScan(scan) {
|
function handleScan(scan) {
|
||||||
|
if (!enabled) return;
|
||||||
const now = Number.isFinite(scan?.scannedAt) ? scan.scannedAt : Date.now();
|
const now = Number.isFinite(scan?.scannedAt) ? scan.scannedAt : Date.now();
|
||||||
withGameStore((draft) => {
|
withGameStore((draft) => {
|
||||||
updateGlobalCounters(draft, scan, now);
|
updateGlobalCounters(draft, scan, now);
|
||||||
@@ -1121,15 +1128,9 @@ function broadcastState() {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
if (enabled) {
|
io.on('connection', (socket) => {
|
||||||
/*
|
|
||||||
Barcode games are an optional layer on top of the physical scanner station.
|
|
||||||
The game's own switch controls whether its sockets and subscriptions exist.
|
|
||||||
Scanner availability is runtime state and must not silently override the
|
|
||||||
operator's explicit choice to enable the game service.
|
|
||||||
*/
|
|
||||||
io.on('connection', (socket) => {
|
|
||||||
socket.on('barcodeGame:subscribe', (_payload = {}, cb = () => {}) => {
|
socket.on('barcodeGame:subscribe', (_payload = {}, cb = () => {}) => {
|
||||||
|
if (!enabled) return cb({ error: 'barcode games disabled' });
|
||||||
socket.join(GAME_SOCKET_ROOM);
|
socket.join(GAME_SOCKET_ROOM);
|
||||||
const state = buildStatePayload(socket);
|
const state = buildStatePayload(socket);
|
||||||
socket.emit('barcodeGame:state', state);
|
socket.emit('barcodeGame:state', state);
|
||||||
@@ -1137,6 +1138,7 @@ if (enabled) {
|
|||||||
});
|
});
|
||||||
|
|
||||||
socket.on('barcodeGame:vote', ({ gameId } = {}, cb = () => {}) => {
|
socket.on('barcodeGame:vote', ({ gameId } = {}, cb = () => {}) => {
|
||||||
|
if (!enabled) return cb({ error: 'barcode games disabled' });
|
||||||
try {
|
try {
|
||||||
cb(setVote(socket, gameId));
|
cb(setVote(socket, gameId));
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
@@ -1145,9 +1147,9 @@ if (enabled) {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
});
|
});
|
||||||
|
|
||||||
subscribe('barcode.scanned', (event) => {
|
subscribe('barcode.scanned', (event) => {
|
||||||
try {
|
try {
|
||||||
handleScan(event.payload);
|
handleScan(event.payload);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
@@ -1155,21 +1157,25 @@ if (enabled) {
|
|||||||
// are logged and skipped so the scanner page can keep resolving barcodes.
|
// are logged and skipped so the scanner page can keep resolving barcodes.
|
||||||
logger.warn('Barcode game scan handling failed', { error: err.message });
|
logger.warn('Barcode game scan handling failed', { error: err.message });
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
} else {
|
|
||||||
|
if (!enabled) {
|
||||||
logger.info('Barcode games disabled by config');
|
logger.info('Barcode games disabled by config');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
registerConfigurationHandler('barcodeGames', (barcodeGamesConfig = {}) => {
|
||||||
|
applyBarcodeGameConfig(barcodeGamesConfig);
|
||||||
|
broadcastState();
|
||||||
|
});
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
buildStatePayload,
|
buildStatePayload,
|
||||||
handleScan,
|
handleScan,
|
||||||
setVote,
|
setVote,
|
||||||
};
|
};
|
||||||
|
|
||||||
if (enabled) {
|
setInterval(() => {
|
||||||
setInterval(() => {
|
if (enabled && settleActiveGameIfNeeded()) {
|
||||||
if (settleActiveGameIfNeeded()) {
|
broadcastState();
|
||||||
broadcastState();
|
}
|
||||||
}
|
}, GAME_TICK_MS).unref?.();
|
||||||
}, GAME_TICK_MS).unref?.();
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ module.exports = {
|
|||||||
feature: true,
|
feature: true,
|
||||||
defaultValue: { enabled: false },
|
defaultValue: { enabled: false },
|
||||||
schema: strictObject({
|
schema: strictObject({
|
||||||
enabled: boolean({ description: 'Registers barcode scanning, barcode administration, and scan-triggered server behavior after restart.' }),
|
enabled: boolean({ description: 'Immediately enables barcode scanning, barcode administration, and scan-triggered server behavior.' }),
|
||||||
}, {
|
}, {
|
||||||
title: 'Barcode scanner',
|
title: 'Barcode scanner',
|
||||||
description: 'Optional physical barcode scanning and barcode registry service.',
|
description: 'Optional physical barcode scanning and barcode registry service.',
|
||||||
|
|||||||
@@ -4,7 +4,7 @@
|
|||||||
const fs = require('fs');
|
const fs = require('fs');
|
||||||
const io = require('../../globals/io');
|
const io = require('../../globals/io');
|
||||||
const logger = require('../../globals/logger').child('barcodeScannerService');
|
const logger = require('../../globals/logger').child('barcodeScannerService');
|
||||||
const { loadConfig } = require('../../configuration');
|
const { loadConfig, registerConfigurationHandler } = require('../../configuration');
|
||||||
const { resolveDataDir, resolveDataPath } = require('../../helpers/dataPaths');
|
const { resolveDataDir, resolveDataPath } = require('../../helpers/dataPaths');
|
||||||
const { getMode, MODES, modeEvents } = require('../modeManager');
|
const { getMode, MODES, modeEvents } = require('../modeManager');
|
||||||
const { publishEvent } = require('../eventBus');
|
const { publishEvent } = require('../eventBus');
|
||||||
@@ -15,7 +15,7 @@ const REGISTRY_PATH = resolveDataPath('barcode-registry.json');
|
|||||||
const RECENT_SCAN_LIMIT = 8;
|
const RECENT_SCAN_LIMIT = 8;
|
||||||
const VALID_CODE_PATTERN = /^[a-z][0-9]{3}$/;
|
const VALID_CODE_PATTERN = /^[a-z][0-9]{3}$/;
|
||||||
const SCANNER_SOCKET_ROOM = 'barcode-scanner';
|
const SCANNER_SOCKET_ROOM = 'barcode-scanner';
|
||||||
const enabled = Boolean(loadConfig().barcodeScanner?.enabled);
|
let enabled = Boolean(loadConfig().barcodeScanner?.enabled);
|
||||||
|
|
||||||
let lastKnownGoodRegistry = null;
|
let lastKnownGoodRegistry = null;
|
||||||
let lastRegistryError = null;
|
let lastRegistryError = null;
|
||||||
@@ -312,19 +312,16 @@ async function applyScan(rawCode) {
|
|||||||
return { result };
|
return { result };
|
||||||
}
|
}
|
||||||
|
|
||||||
if (enabled) {
|
io.on('connection', (socket) => {
|
||||||
/*
|
|
||||||
Barcode scanning is tied to a physical scanner station. Disabled installs
|
|
||||||
should not create the registry file or expose scanner socket commands.
|
|
||||||
*/
|
|
||||||
io.on('connection', (socket) => {
|
|
||||||
socket.on('barcode:subscribe', (_payload = {}, cb = () => {}) => {
|
socket.on('barcode:subscribe', (_payload = {}, cb = () => {}) => {
|
||||||
|
if (!enabled) return cb({ error: 'barcode scanner disabled' });
|
||||||
socket.join(SCANNER_SOCKET_ROOM);
|
socket.join(SCANNER_SOCKET_ROOM);
|
||||||
socket.emit('barcode:state', buildStatePayload());
|
socket.emit('barcode:state', buildStatePayload());
|
||||||
cb({ success: true, state: buildStatePayload() });
|
cb({ success: true, state: buildStatePayload() });
|
||||||
});
|
});
|
||||||
|
|
||||||
socket.on('barcode:scan', async ({ code } = {}, cb = () => {}) => {
|
socket.on('barcode:scan', async ({ code } = {}, cb = () => {}) => {
|
||||||
|
if (!enabled) return cb({ error: 'barcode scanner disabled' });
|
||||||
try {
|
try {
|
||||||
const { result } = await applyScan(code);
|
const { result } = await applyScan(code);
|
||||||
cb({ success: true, result, state: buildStatePayload() });
|
cb({ success: true, result, state: buildStatePayload() });
|
||||||
@@ -336,20 +333,28 @@ if (enabled) {
|
|||||||
cb({ error: err.message || 'barcode scan failed' });
|
cb({ error: err.message || 'barcode scan failed' });
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
modeEvents.on('change', () => {
|
modeEvents.on('change', () => {
|
||||||
// Access-mode changes affect whether the scanner page should beep when it
|
// Access-mode changes affect whether the scanner page should beep when it
|
||||||
// submits a code, so scanner clients need a fresh state packet even without a
|
// submits a code, so scanner clients need a fresh state packet even without a
|
||||||
// new scan.
|
// new scan.
|
||||||
broadcastState();
|
broadcastState();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
if (enabled) {
|
||||||
loadRegistryForScan();
|
loadRegistryForScan();
|
||||||
} else {
|
} else {
|
||||||
logger.info('Barcode scanner disabled by config');
|
logger.info('Barcode scanner disabled by config');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
registerConfigurationHandler('barcodeScanner', (scannerConfig = {}) => {
|
||||||
|
const wasEnabled = enabled;
|
||||||
|
enabled = Boolean(scannerConfig.enabled);
|
||||||
|
if (!wasEnabled && enabled) loadRegistryForScan();
|
||||||
|
broadcastState();
|
||||||
|
});
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
REGISTRY_PATH,
|
REGISTRY_PATH,
|
||||||
applyScan: (...args) => {
|
applyScan: (...args) => {
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ module.exports = {
|
|||||||
feature: true,
|
feature: true,
|
||||||
defaultValue: { enabled: false },
|
defaultValue: { enabled: false },
|
||||||
schema: strictObject({
|
schema: strictObject({
|
||||||
enabled: boolean({ description: 'Registers the physical button-box input route and enables its persistent button rewards and effects after restart.' }),
|
enabled: boolean({ description: 'Immediately enables the physical button-box input route and its persistent button rewards and effects.' }),
|
||||||
}, {
|
}, {
|
||||||
title: 'Button box',
|
title: 'Button box',
|
||||||
description: 'Optional physical button-box input and reward system.',
|
description: 'Optional physical button-box input and reward system.',
|
||||||
|
|||||||
@@ -10,6 +10,7 @@ function registerButtonBoxRoute(deps) {
|
|||||||
buttonCount,
|
buttonCount,
|
||||||
normalizeIp,
|
normalizeIp,
|
||||||
isLocalNetwork,
|
isLocalNetwork,
|
||||||
|
isEnabled,
|
||||||
applyPress,
|
applyPress,
|
||||||
} = deps;
|
} = deps;
|
||||||
|
|
||||||
@@ -39,6 +40,13 @@ function registerButtonBoxRoute(deps) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
app.post('/buttonbox/press', express.text({ type: 'text/plain' }), async (req, res) => {
|
app.post('/buttonbox/press', express.text({ type: 'text/plain' }), async (req, res) => {
|
||||||
|
// The route stays registered for the life of Express, but the service gate
|
||||||
|
// is evaluated per request so the physical endpoint enables and disables
|
||||||
|
// immediately without accumulating duplicate routes.
|
||||||
|
if (!isEnabled()) {
|
||||||
|
res.status(503).json({ error: 'Button box is disabled' });
|
||||||
|
return;
|
||||||
|
}
|
||||||
if (denyIfNotLocal(req, res)) return;
|
if (denyIfNotLocal(req, res)) return;
|
||||||
const buttonId = parseButtonId(req.body);
|
const buttonId = parseButtonId(req.body);
|
||||||
if (!Number.isFinite(buttonId) || buttonId < 1 || buttonId > buttonCount) {
|
if (!Number.isFinite(buttonId) || buttonId < 1 || buttonId > buttonCount) {
|
||||||
|
|||||||
@@ -4,7 +4,7 @@
|
|||||||
const { app } = require('../../globals/http');
|
const { app } = require('../../globals/http');
|
||||||
const io = require('../../globals/io');
|
const io = require('../../globals/io');
|
||||||
const logger = require('../../globals/logger').child('buttonBoxService');
|
const logger = require('../../globals/logger').child('buttonBoxService');
|
||||||
const { loadConfig } = require('../../configuration');
|
const { loadConfig, registerConfigurationHandler } = require('../../configuration');
|
||||||
const { resolveDataDir, resolveDataPath } = require('../../helpers/dataPaths');
|
const { resolveDataDir, resolveDataPath } = require('../../helpers/dataPaths');
|
||||||
const { publishEvent } = require('../eventBus');
|
const { publishEvent } = require('../eventBus');
|
||||||
const { getRewardById, listRewards } = require('../../rewards');
|
const { getRewardById, listRewards } = require('../../rewards');
|
||||||
@@ -30,7 +30,7 @@ const DATA_DIR = resolveDataDir();
|
|||||||
const STORE_PATH = resolveDataPath('buttonbox-state.json');
|
const STORE_PATH = resolveDataPath('buttonbox-state.json');
|
||||||
const BUTTON_COUNT = 4;
|
const BUTTON_COUNT = 4;
|
||||||
const STORE_VERSION = 1;
|
const STORE_VERSION = 1;
|
||||||
const enabled = Boolean(loadConfig().buttonBox?.enabled);
|
let enabled = Boolean(loadConfig().buttonBox?.enabled);
|
||||||
|
|
||||||
const store = createButtonBoxStore({
|
const store = createButtonBoxStore({
|
||||||
logger,
|
logger,
|
||||||
@@ -73,28 +73,38 @@ const core = createButtonBoxCore({
|
|||||||
store,
|
store,
|
||||||
});
|
});
|
||||||
|
|
||||||
if (enabled) {
|
registerButtonBoxRoute({
|
||||||
/*
|
app,
|
||||||
The button box is physical local hardware, so disabled public installs
|
logger,
|
||||||
should not expose its LAN-only press endpoint or initialize its reward file.
|
buttonCount: BUTTON_COUNT,
|
||||||
*/
|
normalizeIp,
|
||||||
registerButtonBoxRoute({
|
isLocalNetwork,
|
||||||
app,
|
isEnabled: () => enabled,
|
||||||
logger,
|
applyPress: core.applyPress,
|
||||||
buttonCount: BUTTON_COUNT,
|
});
|
||||||
normalizeIp,
|
|
||||||
isLocalNetwork,
|
|
||||||
applyPress: core.applyPress,
|
|
||||||
});
|
|
||||||
|
|
||||||
|
function enableButtonBox() {
|
||||||
store.loadState();
|
store.loadState();
|
||||||
core.recoverEffects().catch((err) => {
|
core.recoverEffects().catch((err) => {
|
||||||
logger.warn('Button box effect recovery failed', err.message);
|
logger.warn('Button box effect recovery failed', err.message);
|
||||||
});
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (enabled) {
|
||||||
|
enableButtonBox();
|
||||||
} else {
|
} else {
|
||||||
logger.info('Button box disabled by config');
|
logger.info('Button box disabled by config');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
registerConfigurationHandler('buttonBox', (buttonBoxConfig = {}) => {
|
||||||
|
const wasEnabled = enabled;
|
||||||
|
enabled = Boolean(buttonBoxConfig.enabled);
|
||||||
|
// Persistent state is loaded only on the transition to enabled. The core has
|
||||||
|
// no long-running hardware client, so disabling is completely represented by
|
||||||
|
// the route and public-method gates.
|
||||||
|
if (!wasEnabled && enabled) enableButtonBox();
|
||||||
|
});
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
getButtonBoxState: () => {
|
getButtonBoxState: () => {
|
||||||
/*
|
/*
|
||||||
|
|||||||
@@ -10,6 +10,8 @@ const { getNickname } = require('../nicknameService');
|
|||||||
const { getGlobalObjective, setGlobalObjective, clearGlobalObjective } = require('../globalObjectiveService');
|
const { getGlobalObjective, setGlobalObjective, clearGlobalObjective } = require('../globalObjectiveService');
|
||||||
const { getAdminReason, setAdminReason, clearAdminReason } = require('../adminReasonService');
|
const { getAdminReason, setAdminReason, clearAdminReason } = require('../adminReasonService');
|
||||||
const homeAssistantService = require('../homeAssistantService');
|
const homeAssistantService = require('../homeAssistantService');
|
||||||
|
// Both command transports use the same activity lock owner.
|
||||||
|
const homeAssistantActivitiesService = require('../homeAssistantActivitiesService');
|
||||||
const greenModeService = require('../greenModeService');
|
const greenModeService = require('../greenModeService');
|
||||||
const liftService = require('../liftService');
|
const liftService = require('../liftService');
|
||||||
const neatoService = require('../neatoService');
|
const neatoService = require('../neatoService');
|
||||||
@@ -43,11 +45,8 @@ const {
|
|||||||
createReplaySourceResolver,
|
createReplaySourceResolver,
|
||||||
} = require('../replayDeliveryService/workflow');
|
} = require('../replayDeliveryService/workflow');
|
||||||
|
|
||||||
const config = loadConfig();
|
|
||||||
const discordConfig = config.discord || {};
|
|
||||||
|
|
||||||
function isTextCommand(text) {
|
function isTextCommand(text) {
|
||||||
return parseCommandText(text, config).matched;
|
return parseCommandText(text).matched;
|
||||||
}
|
}
|
||||||
|
|
||||||
function sanitizeMentions(text) {
|
function sanitizeMentions(text) {
|
||||||
@@ -142,6 +141,11 @@ function createChatCommandRequest({ socket, text, sendSystemMessage }) {
|
|||||||
|
|
||||||
async function runChatTextCommand({ text, socket, sendSystemMessage }) {
|
async function runChatTextCommand({ text, socket, sendSystemMessage }) {
|
||||||
if (!isTextCommand(text)) return false;
|
if (!isTextCommand(text)) return false;
|
||||||
|
// Commands are assembled per message already, so reading the live snapshot
|
||||||
|
// here applies prefix, URL, and integration settings without retaining a
|
||||||
|
// stale dependency object between configuration revisions.
|
||||||
|
const config = loadConfig();
|
||||||
|
const discordConfig = config.discord || {};
|
||||||
// ReplayEngineV2 has startup side effects by design. Loading it lazily here
|
// ReplayEngineV2 has startup side effects by design. Loading it lazily here
|
||||||
// keeps ordinary chatService initialization from changing the service boot
|
// keeps ordinary chatService initialization from changing the service boot
|
||||||
// order, while still letting `rs replay` use the existing replay pipeline.
|
// order, while still letting `rs replay` use the existing replay pipeline.
|
||||||
@@ -175,6 +179,7 @@ async function runChatTextCommand({ text, socket, sendSystemMessage }) {
|
|||||||
// lights lock/unlock` from becoming transport-specific, and it preserves
|
// lights lock/unlock` from becoming transport-specific, and it preserves
|
||||||
// the existing session update path for all connected browsers.
|
// the existing session update path for all connected browsers.
|
||||||
homeAssistantService,
|
homeAssistantService,
|
||||||
|
homeAssistantActivitiesService,
|
||||||
greenModeService,
|
greenModeService,
|
||||||
liftService,
|
liftService,
|
||||||
neatoService,
|
neatoService,
|
||||||
@@ -201,7 +206,7 @@ async function runChatTextCommand({ text, socket, sendSystemMessage }) {
|
|||||||
isAdminUser: (id) => String(id) === String(socket.id) && isAdmin(socket),
|
isAdminUser: (id) => String(id) === String(socket.id) && isAdmin(socket),
|
||||||
isLockdownAdminUser: (id) => String(id) === String(socket.id) && isLockdownAdmin(socket),
|
isLockdownAdminUser: (id) => String(id) === String(socket.id) && isLockdownAdmin(socket),
|
||||||
discordConfig,
|
discordConfig,
|
||||||
siteUrl: String(discordConfig.siteUrl || ''),
|
publicUrl: String(config.publicUrl || ''),
|
||||||
config,
|
config,
|
||||||
createReplayTextCommand: createWebReplayTextCommand(socket, sendSystemMessage, replayApi),
|
createReplayTextCommand: createWebReplayTextCommand(socket, sendSystemMessage, replayApi),
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ const logger = require('../../globals/logger').child('commandService');
|
|||||||
const { isHeadlightBlocked } = require('../../rewards/definitions/darkness');
|
const { isHeadlightBlocked } = require('../../rewards/definitions/darkness');
|
||||||
const homeAssistantService = require('../homeAssistantService');
|
const homeAssistantService = require('../homeAssistantService');
|
||||||
const overcurrentProtectionService = require('../overcurrentProtectionService');
|
const overcurrentProtectionService = require('../overcurrentProtectionService');
|
||||||
|
const { subscribeCommandRecording, observeCommand, recordCommandRequest } = require('./recording');
|
||||||
|
|
||||||
// Command observations are intentionally separate from the global event bus.
|
// Command observations are intentionally separate from the global event bus.
|
||||||
// Drive and motor commands can run at control-loop frequency, and publishing
|
// Drive and motor commands can run at control-loop frequency, and publishing
|
||||||
@@ -96,6 +97,7 @@ function issueCommand(roverId, payload) {
|
|||||||
const normalizedPayload = normalizeOutboundCommandPayload(payload);
|
const normalizedPayload = normalizeOutboundCommandPayload(payload);
|
||||||
const message = { ...normalizedPayload, id };
|
const message = { ...normalizedPayload, id };
|
||||||
record.ws.send(JSON.stringify(message));
|
record.ws.send(JSON.stringify(message));
|
||||||
|
observeCommand({ phase: 'dispatched', roverId, commandId: id, command: normalizedPayload });
|
||||||
pendingCommands.set(id, { roverId, ts: Date.now(), type: normalizedPayload.type });
|
pendingCommands.set(id, { roverId, ts: Date.now(), type: normalizedPayload.type });
|
||||||
logger.info('Issued command', roverId, normalizedPayload.type, id);
|
logger.info('Issued command', roverId, normalizedPayload.type, id);
|
||||||
return id;
|
return id;
|
||||||
@@ -130,6 +132,7 @@ function handleAck(msg) {
|
|||||||
const pending = pendingCommands.get(msg.id);
|
const pending = pendingCommands.get(msg.id);
|
||||||
if (!pending) return;
|
if (!pending) return;
|
||||||
pendingCommands.delete(msg.id);
|
pendingCommands.delete(msg.id);
|
||||||
|
observeCommand({ phase: 'acknowledged', roverId: pending.roverId, commandId: msg.id, acknowledgement: msg });
|
||||||
logger.info('Command acknowledged', pending.roverId, pending.type, msg.status);
|
logger.info('Command acknowledged', pending.roverId, pending.type, msg.status);
|
||||||
io.emit('commandAck', {
|
io.emit('commandAck', {
|
||||||
roverId: pending.roverId,
|
roverId: pending.roverId,
|
||||||
@@ -255,145 +258,149 @@ module.exports = {
|
|||||||
getRecentDriveActivity,
|
getRecentDriveActivity,
|
||||||
setDriveCooldown,
|
setDriveCooldown,
|
||||||
commandEvents,
|
commandEvents,
|
||||||
|
subscribeCommandRecording,
|
||||||
|
submitCommand,
|
||||||
};
|
};
|
||||||
|
|
||||||
io.on('connection', (socket) => {
|
// Shared authorization/safety boundary for browser and service-owned control.
|
||||||
function handleCommand({ roverId, type, data } = {}, cb) {
|
function submitCommand(socket, { roverId, type, data } = {}, cb) {
|
||||||
const reply = typeof cb === 'function' ? cb : () => {};
|
const reply = typeof cb === 'function' ? cb : () => {};
|
||||||
try {
|
try {
|
||||||
if (!roverId) {
|
if (!roverId) {
|
||||||
throw new Error('roverId required');
|
throw new Error('roverId required');
|
||||||
|
}
|
||||||
|
if (!type) {
|
||||||
|
throw new Error('type required');
|
||||||
|
}
|
||||||
|
if (type === 'audioLevels') {
|
||||||
|
throw new Error('audioLevels command is service-managed');
|
||||||
|
}
|
||||||
|
let payload = data ? { ...data } : {};
|
||||||
|
if (type === 'headlight' && isHeadlightBlocked()) {
|
||||||
|
logger.info('Ignoring headlight command while darkness lock is active', { socketId: socket.id, roverId });
|
||||||
|
reply({ ignored: true, reason: 'darknessActive' });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (type === 'laser' && isLaserCommandBlockedByRoomLightLock(payload)) {
|
||||||
|
logger.info('Ignoring laser command while room lights are locked on', {
|
||||||
|
socketId: socket.id,
|
||||||
|
roverId,
|
||||||
|
action: getLaserAction(payload),
|
||||||
|
});
|
||||||
|
reply({ ignored: true, reason: 'roomLightsLockedOn' });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const isRebootCommand = type === 'reboot';
|
||||||
|
const isUpdateCommand = type === 'update';
|
||||||
|
const isSongCommand = type === 'song' || (type === 'raw' && isSongRawPayload(payload));
|
||||||
|
const isAdminSocket = isAdmin(socket);
|
||||||
|
if (!isAdminSocket && isDeterred(socket)) {
|
||||||
|
throw new Error('Not authorized');
|
||||||
|
}
|
||||||
|
/*
|
||||||
|
Both structured song commands and raw Open Interface song payloads
|
||||||
|
reach this shared flag. Enforcing mute here covers the VIP MIDI beeper
|
||||||
|
and any future browser beeper without affecting unrelated driving.
|
||||||
|
*/
|
||||||
|
if (!isAdminSocket && isSongCommand && isMuted(socket)) {
|
||||||
|
throw new Error('Muted');
|
||||||
|
}
|
||||||
|
// Rover updates run a privileged, root-owned helper on the Pi. Keep this
|
||||||
|
// in the same explicit admin-only branch as reboot instead of relying on
|
||||||
|
// drive ownership checks, because having a turn should not grant system
|
||||||
|
// maintenance privileges.
|
||||||
|
if ((isRebootCommand || isUpdateCommand) && !isAdminSocket) {
|
||||||
|
throw new Error('Not authorized');
|
||||||
|
}
|
||||||
|
if (!isSongCommand && !isRebootCommand && !isUpdateCommand && !roverManager.canDrive(roverId, socket)) {
|
||||||
|
throw new Error('Not your turn or no control');
|
||||||
|
}
|
||||||
|
const driveDirect = payload?.driveDirect;
|
||||||
|
if (type === 'drive' && driveDirect) {
|
||||||
|
if (!isAdminSocket) {
|
||||||
|
const safeDrive = roverManager.applyPrivateDriveSafety(roverId, socket, driveDirect);
|
||||||
|
if (safeDrive) {
|
||||||
|
payload.driveDirect = safeDrive;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
if (!type) {
|
const left = Number(payload?.driveDirect?.left);
|
||||||
throw new Error('type required');
|
const right = Number(payload?.driveDirect?.right);
|
||||||
}
|
const speed = Math.max(Math.abs(left), Math.abs(right));
|
||||||
if (type === 'audioLevels') {
|
if (!isAdminSocket) {
|
||||||
throw new Error('audioLevels command is service-managed');
|
const blockedUntil = driveCooldowns.get(roverId);
|
||||||
}
|
if (blockedUntil && Date.now() < blockedUntil && speed > 0) {
|
||||||
let payload = data ? { ...data } : {};
|
const reason = isLockdownAdmin(socket)
|
||||||
if (type === 'headlight' && isHeadlightBlocked()) {
|
? 'Drive blocked: cooldown'
|
||||||
logger.info('Ignoring headlight command while darkness lock is active', { socketId: socket.id, roverId });
|
: 'Drive blocked: safety cooldown';
|
||||||
reply({ ignored: true, reason: 'darknessActive' });
|
throw new Error(reason);
|
||||||
return;
|
}
|
||||||
}
|
}
|
||||||
if (type === 'laser' && isLaserCommandBlockedByRoomLightLock(payload)) {
|
if (speed > 0) {
|
||||||
logger.info('Ignoring laser command while room lights are locked on', {
|
let direction = 'turn';
|
||||||
|
if (left > 0 && right > 0) direction = 'forward';
|
||||||
|
if (left < 0 && right < 0) direction = 'backward';
|
||||||
|
lastDriveActivity.set(roverId, {
|
||||||
|
ts: Date.now(),
|
||||||
socketId: socket.id,
|
socketId: socket.id,
|
||||||
roverId,
|
direction,
|
||||||
action: getLaserAction(payload),
|
speed,
|
||||||
});
|
isAdmin: isAdminSocket,
|
||||||
reply({ ignored: true, reason: 'roomLightsLockedOn' });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const isRebootCommand = type === 'reboot';
|
|
||||||
const isUpdateCommand = type === 'update';
|
|
||||||
const isSongCommand = type === 'song' || (type === 'raw' && isSongRawPayload(payload));
|
|
||||||
const isAdminSocket = isAdmin(socket);
|
|
||||||
if (!isAdminSocket && isDeterred(socket)) {
|
|
||||||
throw new Error('Not authorized');
|
|
||||||
}
|
|
||||||
/*
|
|
||||||
Both structured song commands and raw Open Interface song payloads
|
|
||||||
reach this shared flag. Enforcing mute here covers the VIP MIDI beeper
|
|
||||||
and any future browser beeper without affecting unrelated driving.
|
|
||||||
*/
|
|
||||||
if (!isAdminSocket && isSongCommand && isMuted(socket)) {
|
|
||||||
throw new Error('Muted');
|
|
||||||
}
|
|
||||||
// Rover updates run a privileged, root-owned helper on the Pi. Keep this
|
|
||||||
// in the same explicit admin-only branch as reboot instead of relying on
|
|
||||||
// drive ownership checks, because having a turn should not grant system
|
|
||||||
// maintenance privileges.
|
|
||||||
if ((isRebootCommand || isUpdateCommand) && !isAdminSocket) {
|
|
||||||
throw new Error('Not authorized');
|
|
||||||
}
|
|
||||||
if (!isSongCommand && !isRebootCommand && !isUpdateCommand && !roverManager.canDrive(roverId, socket)) {
|
|
||||||
throw new Error('Not your turn or no control');
|
|
||||||
}
|
|
||||||
const driveDirect = payload?.driveDirect;
|
|
||||||
if (type === 'drive' && driveDirect) {
|
|
||||||
if (!isAdminSocket) {
|
|
||||||
const safeDrive = roverManager.applyPrivateDriveSafety(roverId, socket, driveDirect);
|
|
||||||
if (safeDrive) {
|
|
||||||
payload.driveDirect = safeDrive;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
const left = Number(payload?.driveDirect?.left);
|
|
||||||
const right = Number(payload?.driveDirect?.right);
|
|
||||||
const speed = Math.max(Math.abs(left), Math.abs(right));
|
|
||||||
if (!isAdminSocket) {
|
|
||||||
const blockedUntil = driveCooldowns.get(roverId);
|
|
||||||
if (blockedUntil && Date.now() < blockedUntil && speed > 0) {
|
|
||||||
const reason = isLockdownAdmin(socket)
|
|
||||||
? 'Drive blocked: cooldown'
|
|
||||||
: 'Drive blocked: safety cooldown';
|
|
||||||
throw new Error(reason);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (speed > 0) {
|
|
||||||
let direction = 'turn';
|
|
||||||
if (left > 0 && right > 0) direction = 'forward';
|
|
||||||
if (left < 0 && right < 0) direction = 'backward';
|
|
||||||
lastDriveActivity.set(roverId, {
|
|
||||||
ts: Date.now(),
|
|
||||||
socketId: socket.id,
|
|
||||||
direction,
|
|
||||||
speed,
|
|
||||||
isAdmin: isAdminSocket,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (type === 'drive' || type === 'motors') {
|
|
||||||
/*
|
|
||||||
Role is supplied at the command boundary because telemetry does not
|
|
||||||
identify the operator who produced the active motor intent. Admin and
|
|
||||||
lockdown commands therefore enter the service explicitly bypassed;
|
|
||||||
they are recorded for status visibility but are never scaled, blocked,
|
|
||||||
or countermanded by a later sensor frame.
|
|
||||||
*/
|
|
||||||
payload = overcurrentProtectionService.protectCommand(roverId, type, payload, {
|
|
||||||
bypassed: isAdminSocket,
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
const id = issueCommand(roverId, { type, ...payload });
|
|
||||||
commandEvents.emit('observation', {
|
|
||||||
ts: Date.now(),
|
|
||||||
roverId: String(roverId),
|
|
||||||
type,
|
|
||||||
commandId: id,
|
|
||||||
outcome: 'issued',
|
|
||||||
socketId: socket.id,
|
|
||||||
// Payloads are omitted deliberately: raw OI, TTS, and maintenance
|
|
||||||
// commands can carry arbitrary content. Their structured type/outcome
|
|
||||||
// supplies analytics without accidentally persisting secret material.
|
|
||||||
});
|
|
||||||
logger.info('Queued command', socket.id, roverId, type);
|
|
||||||
if (shouldRecordTurnActivity(type, payload)) {
|
|
||||||
try {
|
|
||||||
const { recordActivity } = require('../turnService');
|
|
||||||
recordActivity(roverId, socket.id);
|
|
||||||
} catch (err) {
|
|
||||||
// Activity recording is best-effort because command delivery should not fail if turn bookkeeping has a transient issue.
|
|
||||||
}
|
|
||||||
}
|
|
||||||
reply({ id });
|
|
||||||
} catch (err) {
|
|
||||||
logger.warn('Command rejected', socket.id, err.message);
|
|
||||||
commandEvents.emit('observation', {
|
|
||||||
ts: Date.now(),
|
|
||||||
roverId: roverId ? String(roverId) : null,
|
|
||||||
type: type || 'unknown',
|
|
||||||
outcome: 'rejected',
|
|
||||||
socketId: socket.id,
|
|
||||||
error: err.message,
|
|
||||||
});
|
|
||||||
reply({ error: err.message });
|
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
socket.on('command', handleCommand);
|
if (type === 'drive' || type === 'motors') {
|
||||||
socket.on('command:issue', handleCommand);
|
/*
|
||||||
|
Role is supplied at the command boundary because telemetry does not
|
||||||
|
identify the operator who produced the active motor intent. Admin and
|
||||||
|
lockdown commands therefore enter the service explicitly bypassed;
|
||||||
|
they are recorded for status visibility but are never scaled, blocked,
|
||||||
|
or countermanded by a later sensor frame.
|
||||||
|
*/
|
||||||
|
payload = overcurrentProtectionService.protectCommand(roverId, type, payload, {
|
||||||
|
bypassed: isAdminSocket,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
const id = issueCommand(roverId, { type, ...payload });
|
||||||
|
commandEvents.emit('observation', {
|
||||||
|
ts: Date.now(),
|
||||||
|
roverId: String(roverId),
|
||||||
|
type,
|
||||||
|
commandId: id,
|
||||||
|
outcome: 'issued',
|
||||||
|
socketId: socket.id,
|
||||||
|
// Payloads are omitted deliberately: raw OI, TTS, and maintenance
|
||||||
|
// commands can carry arbitrary content. Their structured type/outcome
|
||||||
|
// supplies analytics without accidentally persisting secret material.
|
||||||
|
});
|
||||||
|
logger.info('Queued command', socket.id, roverId, type);
|
||||||
|
if (shouldRecordTurnActivity(type, payload)) {
|
||||||
|
try {
|
||||||
|
const { recordActivity } = require('../turnService');
|
||||||
|
recordActivity(roverId, socket.id);
|
||||||
|
} catch (err) {
|
||||||
|
// Activity recording is best-effort because command delivery should not fail if turn bookkeeping has a transient issue.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
reply({ id });
|
||||||
|
} catch (err) {
|
||||||
|
logger.warn('Command rejected', socket.id, err.message);
|
||||||
|
commandEvents.emit('observation', {
|
||||||
|
ts: Date.now(),
|
||||||
|
roverId: roverId ? String(roverId) : null,
|
||||||
|
type: type || 'unknown',
|
||||||
|
outcome: 'rejected',
|
||||||
|
socketId: socket.id,
|
||||||
|
error: err.message,
|
||||||
|
});
|
||||||
|
reply({ error: err.message });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
io.on('connection', (socket) => {
|
||||||
|
const recordedCommand = (request, reply) => recordCommandRequest(socket, request, reply, (message, cb) => submitCommand(socket, message, cb));
|
||||||
|
socket.on('command', recordedCommand);
|
||||||
|
socket.on('command:issue', recordedCommand);
|
||||||
|
|
||||||
socket.on('command:updateAllRovers', (_payload = {}, cb) => {
|
socket.on('command:updateAllRovers', (_payload = {}, cb) => {
|
||||||
const reply = typeof cb === 'function' ? cb : () => {};
|
const reply = typeof cb === 'function' ? cb : () => {};
|
||||||
|
|||||||
@@ -0,0 +1,55 @@
|
|||||||
|
// Optional detailed command observation, separate from payload-free analytics.
|
||||||
|
// Subscribers must only enqueue work; recorder failures cannot fail a command.
|
||||||
|
const { AsyncLocalStorage } = require('node:async_hooks');
|
||||||
|
const { randomUUID } = require('node:crypto');
|
||||||
|
|
||||||
|
const observers = new Set();
|
||||||
|
const requests = new AsyncLocalStorage();
|
||||||
|
|
||||||
|
function subscribeCommandRecording(observer) {
|
||||||
|
observers.add(observer);
|
||||||
|
return () => observers.delete(observer);
|
||||||
|
}
|
||||||
|
|
||||||
|
function observeCommand(event) {
|
||||||
|
if (!observers.size) return;
|
||||||
|
const scope = requests.getStore();
|
||||||
|
const context = scope?.active ? scope.context : null;
|
||||||
|
for (const observer of observers) {
|
||||||
|
try {
|
||||||
|
// Snapshot before safety code or a caller mutates a nested payload. Each
|
||||||
|
// subscriber receives its own copy and cannot change command delivery.
|
||||||
|
observer(structuredClone({
|
||||||
|
ts: Date.now(),
|
||||||
|
monotonicNs: process.hrtime.bigint().toString(),
|
||||||
|
source: context ? 'client' : 'server',
|
||||||
|
...context,
|
||||||
|
...event,
|
||||||
|
}));
|
||||||
|
} catch {
|
||||||
|
// Recording is deliberately best-effort at this boundary. The owning
|
||||||
|
// recorder reports its storage health independently of driver replies.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function recordCommandRequest(socket, request, reply, execute, source = 'client') {
|
||||||
|
if (!observers.size) return execute(request, reply);
|
||||||
|
const context = { requestId: randomUUID(), socketId: socket.id, userId: socket.data?.userId || null, source };
|
||||||
|
const scope = { active: true, context };
|
||||||
|
return requests.run(scope, () => {
|
||||||
|
try {
|
||||||
|
observeCommand({ phase: 'requested', roverId: request?.roverId, command: request });
|
||||||
|
return execute(request, (result) => {
|
||||||
|
observeCommand({ phase: 'result', roverId: request?.roverId, result });
|
||||||
|
if (typeof reply === 'function') reply(result);
|
||||||
|
});
|
||||||
|
} finally {
|
||||||
|
// The command handler is synchronous. A safety timer created inside it
|
||||||
|
// inherits async context but its later commands are server actions.
|
||||||
|
scope.active = false;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = { subscribeCommandRecording, observeCommand, recordCommandRequest };
|
||||||
@@ -6,12 +6,14 @@ const { MessageFlags } = require('discord.js');
|
|||||||
function createChannelIO({ client, logger, sanitizeMentions }) {
|
function createChannelIO({ client, logger, sanitizeMentions }) {
|
||||||
const channelCache = new Map();
|
const channelCache = new Map();
|
||||||
const typingMessageCache = new Map();
|
const typingMessageCache = new Map();
|
||||||
|
let stopped = false;
|
||||||
|
|
||||||
async function fetchChannel(id) {
|
async function fetchChannel(id) {
|
||||||
if (!id) return null;
|
if (stopped || !client.isReady() || !id) return null;
|
||||||
if (channelCache.has(id)) return channelCache.get(id);
|
if (channelCache.has(id)) return channelCache.get(id);
|
||||||
try {
|
try {
|
||||||
const channel = await client.channels.fetch(id);
|
const channel = await client.channels.fetch(id);
|
||||||
|
if (stopped) return null;
|
||||||
if (channel) {
|
if (channel) {
|
||||||
channelCache.set(id, channel);
|
channelCache.set(id, channel);
|
||||||
return channel;
|
return channel;
|
||||||
@@ -68,6 +70,7 @@ function createChannelIO({ client, logger, sanitizeMentions }) {
|
|||||||
const content = `-# *${username} is typing...*`;
|
const content = `-# *${username} is typing...*`;
|
||||||
try {
|
try {
|
||||||
const message = await channel.send({ content, allowedMentions: { parse: [] }, flags: [MessageFlags.SuppressNotifications]});
|
const message = await channel.send({ content, allowedMentions: { parse: [] }, flags: [MessageFlags.SuppressNotifications]});
|
||||||
|
if (stopped) return;
|
||||||
const timeoutId = setTimeout(() => {
|
const timeoutId = setTimeout(() => {
|
||||||
clearTypingMessage(entry.guildId, typingId);
|
clearTypingMessage(entry.guildId, typingId);
|
||||||
}, 20000);
|
}, 20000);
|
||||||
@@ -78,6 +81,12 @@ function createChannelIO({ client, logger, sanitizeMentions }) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
|
stop() {
|
||||||
|
stopped = true;
|
||||||
|
for (const record of typingMessageCache.values()) clearTimeout(record.timeoutId);
|
||||||
|
typingMessageCache.clear();
|
||||||
|
channelCache.clear();
|
||||||
|
},
|
||||||
fetchChannel,
|
fetchChannel,
|
||||||
sendToChannel,
|
sendToChannel,
|
||||||
clearTypingMessage,
|
clearTypingMessage,
|
||||||
|
|||||||
@@ -33,7 +33,7 @@ function createReplayCommand({
|
|||||||
getActiveDrivers,
|
getActiveDrivers,
|
||||||
getNickname,
|
getNickname,
|
||||||
rovers,
|
rovers,
|
||||||
discordConfig,
|
config,
|
||||||
}) {
|
}) {
|
||||||
const sourceResolver = createReplaySourceResolver({
|
const sourceResolver = createReplaySourceResolver({
|
||||||
rovers,
|
rovers,
|
||||||
@@ -137,8 +137,8 @@ function createReplayCommand({
|
|||||||
if (progressMessage?.edit) {
|
if (progressMessage?.edit) {
|
||||||
await progressMessage.edit({ content: sanitizeMentions(buildStatusMessage(job, 'ready')), allowedMentions: DEFAULT_ALLOWED_MENTIONS });
|
await progressMessage.edit({ content: sanitizeMentions(buildStatusMessage(job, 'ready')), allowedMentions: DEFAULT_ALLOWED_MENTIONS });
|
||||||
}
|
}
|
||||||
const siteUrl = String(discordConfig?.siteUrl || '').replace(/\/$/, '');
|
const publicBaseUrl = String(config?.publicUrl || '').replace(/\/$/, '');
|
||||||
const publicUrl = siteUrl ? `${siteUrl}${media.url}` : media.url;
|
const publicUrl = publicBaseUrl ? `${publicBaseUrl}${media.url}` : media.url;
|
||||||
await progressMessage.reply({ content: `Replay hosted by the rover server: ${publicUrl}`, allowedMentions: DEFAULT_ALLOWED_MENTIONS });
|
await progressMessage.reply({ content: `Replay hosted by the rover server: ${publicUrl}`, allowedMentions: DEFAULT_ALLOWED_MENTIONS });
|
||||||
return;
|
return;
|
||||||
} catch (fallbackError) {
|
} catch (fallbackError) {
|
||||||
|
|||||||
@@ -3,12 +3,12 @@
|
|||||||
// Scope: Builds a concise time embed for common zones and server local zone.
|
// Scope: Builds a concise time embed for common zones and server local zone.
|
||||||
const { EmbedBuilder } = require('discord.js');
|
const { EmbedBuilder } = require('discord.js');
|
||||||
|
|
||||||
function createTimeStatusCommand({ config, discordConfig }) {
|
function createTimeStatusCommand({ config }) {
|
||||||
function buildEmbed({ title, description, color, includeSiteUrl = true }) {
|
function buildEmbed({ title, description, color, includeSiteUrl = true }) {
|
||||||
const embed = new EmbedBuilder().setTitle(title || 'Update').setColor(color || 0x2196f3);
|
const embed = new EmbedBuilder().setTitle(title || 'Update').setColor(color || 0x2196f3);
|
||||||
const siteUrl = includeSiteUrl && discordConfig.siteUrl ? String(discordConfig.siteUrl) : '';
|
const publicUrl = includeSiteUrl && config.publicUrl ? String(config.publicUrl) : '';
|
||||||
if (description) embed.setDescription(siteUrl ? `${description}\n\n${siteUrl}` : description);
|
if (description) embed.setDescription(publicUrl ? `${description}\n\n${publicUrl}` : description);
|
||||||
else if (siteUrl) embed.setDescription(siteUrl);
|
else if (publicUrl) embed.setDescription(publicUrl);
|
||||||
embed.setTimestamp(new Date());
|
embed.setTimestamp(new Date());
|
||||||
return embed;
|
return embed;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -12,13 +12,13 @@ module.exports = {
|
|||||||
enabled: false,
|
enabled: false,
|
||||||
token: '',
|
token: '',
|
||||||
guildId: '123456789012345678',
|
guildId: '123456789012345678',
|
||||||
siteUrl: 'https://rover.example.com',
|
|
||||||
channels: {
|
channels: {
|
||||||
general: '123456789012345678',
|
general: '123456789012345678',
|
||||||
announcements: '123456789012345678',
|
announcements: '123456789012345678',
|
||||||
adminAlerts: '123456789012345678',
|
adminAlerts: '123456789012345678',
|
||||||
replay: '123456789012345678',
|
replay: '123456789012345678',
|
||||||
humanAlerts: '123456789012345678',
|
humanAlerts: '123456789012345678',
|
||||||
|
liveStatus: '',
|
||||||
},
|
},
|
||||||
roles: {
|
roles: {
|
||||||
stalkerPing: '123456789012345678',
|
stalkerPing: '123456789012345678',
|
||||||
@@ -28,11 +28,11 @@ module.exports = {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
schema: strictObject({
|
schema: strictObject({
|
||||||
enabled: boolean({ description: 'Logs the Discord bot in and enables commands, chat bridges, replay delivery, and configured announcements after restart.' }),
|
enabled: boolean({ description: 'Logs the Discord bot in and immediately enables commands, chat bridges, replay delivery, and configured announcements.' }),
|
||||||
token: string({ title: 'Bot token', description: 'Discord bot token used to log in. The saved value is never returned to the browser.', examples: ['DISCORD_BOT_TOKEN'], writeOnly: true, maxLength: 10000 }),
|
token: string({ title: 'Bot token', description: 'Discord bot token used to log in. The saved value is never returned to the browser.', examples: ['DISCORD_BOT_TOKEN'], writeOnly: true, maxLength: 10000 }),
|
||||||
guildId: string({ title: 'Guild id', description: 'Reserved Discord server identifier. The current bot runtime does not restrict commands or events using this value.', examples: ['123456789012345678'], maxLength: 100 }),
|
guildId: string({ title: 'Guild id', description: 'Reserved Discord server identifier. The current bot runtime does not restrict commands or events using this value.', examples: ['123456789012345678'], maxLength: 100 }),
|
||||||
siteUrl: string({ title: 'Public site URL', description: 'Public base URL appended to announcement embeds and server-hosted replay links.', examples: ['https://rover.example.com'], maxLength: 2048 }),
|
|
||||||
channels: strictObject({
|
channels: strictObject({
|
||||||
|
liveStatus: string({ title: 'Live status', description: 'Dedicated live fleet report channel ID. The bot deletes ALL other messages here. Requires View Channel, Read Message History, Send Messages, and Manage Messages. Leave empty to disable.', examples: ['123456789012345678'], maxLength: 100 }),
|
||||||
general: string({ description: 'Channel ID used by the button-box stalker-role and everyone-ping rewards.', examples: ['123456789012345678'], maxLength: 100 }),
|
general: string({ description: 'Channel ID used by the button-box stalker-role and everyone-ping rewards.', examples: ['123456789012345678'], maxLength: 100 }),
|
||||||
announcements: string({ description: 'Channel ID used for public-mode openings, objective changes, and all-rovers-unlocked announcements.', examples: ['123456789012345678'], maxLength: 100 }),
|
announcements: string({ description: 'Channel ID used for public-mode openings, objective changes, and all-rovers-unlocked announcements.', examples: ['123456789012345678'], maxLength: 100 }),
|
||||||
adminAlerts: string({ description: 'Channel ID used for rover health, battery, dock, help, and daily fleet-report notifications.', examples: ['123456789012345678'], maxLength: 100 }),
|
adminAlerts: string({ description: 'Channel ID used for rover health, battery, dock, help, and daily fleet-report notifications.', examples: ['123456789012345678'], maxLength: 100 }),
|
||||||
@@ -55,7 +55,7 @@ module.exports = {
|
|||||||
}),
|
}),
|
||||||
}, {
|
}, {
|
||||||
title: 'Discord',
|
title: 'Discord',
|
||||||
description: 'Optional Discord bot credentials, public URL, and notification routing.',
|
description: 'Optional Discord bot credentials and notification routing; public links use the top-level public URL.',
|
||||||
required: ['enabled', 'token', 'guildId', 'siteUrl', 'channels', 'roles'],
|
required: ['enabled', 'token', 'guildId', 'channels', 'roles'],
|
||||||
}),
|
}),
|
||||||
};
|
};
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user