From 4529749baab239a05cd8092e927660dcf2f0bfa5 Mon Sep 17 00:00:00 2001 From: Florian Zumpe Date: Tue, 16 Jun 2026 16:45:58 +0200 Subject: [PATCH] Reworked watcher events and describing texts --- .env.example | 1 - README.md | 49 +++++++++++--- package-lock.json | 4 +- package.json | 2 +- public/css/app.css | 68 +++++++++++++++++-- public/images/icons/pause.svg | 1 + public/images/icons/play.svg | 1 + public/images/icons/stop.svg | 1 + public/index.html | 12 +++- public/js/app.js | 109 ++++++++++++++++++++++-------- public/js/bootstrap-loader.js | 1 - server.js | 2 +- src/config.js | 1 - src/routes/api.js | 1 - test/mobile-navigation-ui.test.js | 105 ++++++++++++++++++++++++++++ test/route-selection-ui.test.js | 22 ++++++ test/server-config.test.js | 24 +++++-- 17 files changed, 347 insertions(+), 57 deletions(-) create mode 100644 public/images/icons/pause.svg create mode 100644 public/images/icons/play.svg create mode 100644 public/images/icons/stop.svg create mode 100644 test/mobile-navigation-ui.test.js create mode 100644 test/route-selection-ui.test.js diff --git a/.env.example b/.env.example index 1d570df..f2feb98 100644 --- a/.env.example +++ b/.env.example @@ -1,6 +1,5 @@ HOST=127.0.0.1 PORT=47145 -INSTANCE_NAME=Atlas DATA_DIR=./data STORAGE_DIR=./storage MAX_UPLOAD_MB=50 diff --git a/README.md b/README.md index 9e7d72e..5b67911 100644 --- a/README.md +++ b/README.md @@ -19,26 +19,24 @@ npm run init-db npm start ``` -Danach lauscht die Instanz **Atlas** ausschließlich auf dem lokalen Socket `127.0.0.1:47145` und ist unter `http://127.0.0.1:47145` erreichbar. Die offiziellen, exakt versionierten Distributionsdateien sind bereits unter `public/vendor` enthalten. `npm install` installiert zusätzlich die Pakete `jquery@4.0.0` und `jquery-ui@1.14.2` und synchronisiert daraus JavaScript, Base-Theme, Themebilder und Lizenzdateien erneut in das Vendor-Verzeichnis. Der Browser lädt keine Bibliotheken von einem CDN. +Danach lauscht Wegwichtel ausschließlich auf dem lokalen Socket `127.0.0.1:47145` und ist unter `http://127.0.0.1:47145` erreichbar. Die offiziellen, exakt versionierten Distributionsdateien sind bereits unter `public/vendor` enthalten. `npm install` installiert zusätzlich die Pakete `jquery@4.0.0` und `jquery-ui@1.14.2` und synchronisiert daraus JavaScript, Base-Theme, Themebilder und Lizenzdateien erneut in das Vendor-Verzeichnis. Der Browser lädt keine Bibliotheken von einem CDN. -## Server-Socket und Instanz Atlas +## Server-Socket Die Standardwerte stehen in `.env.example` und werden auch verwendet, wenn keine `.env` vorhanden ist: ```dotenv HOST=127.0.0.1 PORT=47145 -INSTANCE_NAME=Atlas ``` -`HOST` ist die tatsächliche Bind-Adresse des Node.js-Servers. `INSTANCE_NAME` ist eine lesbare Bezeichnung und ändert weder DNS noch die Bind-Adresse. Dadurch verweist die Anwendung auf **Atlas**, bleibt aber auf den lokalen Loopback-Socket beschränkt. Der Health-Endpunkt meldet beispielsweise: +`HOST` ist die tatsächliche Bind-Adresse des Node.js-Servers. Der Health-Endpunkt meldet beispielsweise: ```json { "ok": true, "service": "wegwichtel", - "instance": "Atlas", "socket": "127.0.0.1:47145" } ``` @@ -51,7 +49,7 @@ INSTANCE_NAME=Atlas 4. die Clientmodule werden sequenziell geladen, 5. `/api/health` prüft Server und SQLite, 6. der Client lädt die Routenliste, -7. anschließend wird die Position ermittelt und die Liste auf nahe Routen eingeschränkt, +7. anschließend wird die Position ermittelt; daraus entstehen nahe Empfehlungen, während die Gesamtliste vollständig erhalten bleibt, 8. die responsive Routenansicht wird freigeschaltet. Scheitert ein Schritt, bleibt der Initialisierungsbildschirm mit einer konkreten Fehlermeldung und einem Wiederholungsbutton sichtbar. @@ -113,7 +111,9 @@ curl -X POST http://127.0.0.1:47145/api/routes/1/pois \ ```text public/ mobiler Client + index.html reduzierte semantische Seitenstruktur js/bootstrap-loader.js lädt und prüft lokale Bibliotheken + js/orientation.js Kompassausrichtung für den Navigationspfeil vendor/ lokale jQuery-/jQuery-UI-Dateien samt Themebildern src/routes/ REST-Routing src/services/ GPX-, Geodaten-, Speicher- und Fachlogik @@ -132,8 +132,10 @@ test/ Basistests - GPX-Erweiterungen ergänzen die Trackpunkte in SQLite. Das Original-GPX bleibt im Skelett unverändert; ein späterer Exportdienst sollte aus den Datenbankpunkten eine konsolidierte GPX-Datei generieren. - Schreibzugriffe sind noch nicht authentifiziert. Vor einem öffentlichen Einsatz sind Rollen, Login, CSRF-Schutz, Rate-Limits, Dateisignaturprüfung und ein Moderationsworkflow zwingend zu ergänzen. - Der Server bindet standardmäßig nur an `127.0.0.1`; Zugriffe von anderen Geräten sind damit bewusst ausgeschlossen. -- Die Instanzbezeichnung `Atlas` erscheint im Startprotokoll, im Initialisierungsbildschirm und in `/api/health`. -- Für die Geolokalisierung sollte der Client über `http://127.0.0.1:47145` geöffnet werden. Ein frei aufgelöster Hostname wie `http://Atlas:47145` gilt in Browsern ohne HTTPS in der Regel nicht als sicherer Kontext. +- Anwendungsaktionen verwenden Pointer Events für Touch, Stift und Maus. Enter und Leertaste bleiben als Tastaturbedienung erhalten. +- Bei gestarteter Route zeigt ein fixierter Footer die Entfernung zum nächsten GPX-Trackpunkt auf ganze Meter und dreht einen SVG-Pfeil relativ zur Geräteausrichtung. Ohne Kompassdaten wird die Peilung mit Norden oben dargestellt. +- Auf iPhone und iPad wird die Freigabe der Geräteausrichtung beim Start der Route innerhalb der Benutzeraktion angefordert. +- Für die Geolokalisierung sollte der Client lokal über `http://127.0.0.1:47145` oder online ausschließlich über HTTPS geöffnet werden. Das betrifft ebenso den Gerätekompass. ## Nächste Ausbaustufen @@ -144,3 +146,34 @@ test/ Basistests - Bildunterschriften, Sortierung und gezieltes Entfernen einzelner Medien - Hintergrundbereinigung des Papierkorbs nach einer konfigurierbaren Aufbewahrungsfrist - Integritätsjournal für Dateiverschiebungen und Wiederherstellungen + +## Routenauswahl + +Die Startseite zeigt standortbasierte Empfehlungen und darunter alle aktiven Routen. Die Gesamtliste bleibt auch bei verweigertem oder nicht verfügbarem GPS auswählbar und kann nach Name, Schule oder Beschreibung durchsucht werden. + +## Mobile Bedienung und Routennavigation + +Das HTML verwendet nur IDs, die von den Clientmodulen tatsächlich angesprochen werden. Die wenigen Klassen bilden wiederverwendete Layoutbausteine wie Seiten, Inhalte, Hinweise, Routenlisten und Routendaten ab. Automatisierte Tests gleichen diese Verwendungen ab. + +Alle selbst implementierten Schaltaktionen reagieren primär auf `pointerup`; dadurch funktionieren dieselben Handler mit Touchscreen, Eingabestift und Maus. Die Diashow kann zusätzlich horizontal gewischt werden. Für die Tastatur werden Enter und Leertaste separat behandelt. + +Beim Start der Route wird der aktuellen Position nächstgelegene GPX-Trackpunkt gesucht. Als Navigationsziel dient der folgende Trackpunkt. Der Fortschritt läuft nur vorwärts und wird in einem lokalen Fenster entlang der Punktfolge nachgeführt, um Rücksprünge durch GPS-Schwankungen zu vermeiden. Der Footer zeigt: + +- die auf ganze Meter gerundete Luftlinienentfernung zum nächsten Trackpunkt, +- einen frei rotierenden SVG-Pfeil, +- die relative Richtung zum Ziel, sofern Kompass- oder Bewegungsrichtung verfügbar ist, +- andernfalls die absolute Peilung bei Norden oben, +- und `Ziel der Route erreicht`, sobald der letzte Trackpunkt innerhalb der GPS-Toleranz liegt. + + +## Routensteuerung und GPS-Tracking + +Die Routenansicht besitzt drei nebeneinanderliegende, semantische Schaltflächen mit lokalen SVG-Symbolen: + +- **Route starten beziehungsweise fortsetzen:** aktiviert `navigator.geolocation.watchPosition()` und die Geräteausrichtung. +- **Route pausieren:** beendet den aktiven GPS-Watcher und den Kompass-Listener, behält aber Routenfortschritt und bereits ausgelöste POIs bei. +- **Route beenden:** beendet alle Sensor-Listener, setzt den Fortschritt zurück und leert die Liste bereits ausgelöster POIs. + +Während die Route läuft, werden Positionsänderungen fortlaufend verarbeitet. Eine Browser-Webanwendung ist jedoch kein nativer Hintergrunddienst: Betriebssystem und Browser können die Aktualisierung bei gesperrtem Bildschirm, Energiesparmodus oder im Hintergrund drosseln beziehungsweise anhalten. + +Die Symbole liegen unter `public/images/icons/`. Sie befinden sich innerhalb nativer ` +
+ + + +

Stationen

diff --git a/public/js/app.js b/public/js/app.js index cf1212c..cbcd903 100644 --- a/public/js/app.js +++ b/public/js/app.js @@ -6,7 +6,7 @@ route: null, position: null, triggered: new Set(), - tracking: false, + routeState: 'idle', activePage: null, routeProgressIndex: null, deviceHeading: null @@ -151,27 +151,55 @@ $('#app-shell').addClass('has-navigation'); } - function updateTrackingButton() { - const button = $('#start-tracking'); - button.button('option', { - label: state.tracking ? 'GPS-Begleitung stoppen' : 'GPS-Begleitung starten', - icon: state.tracking ? 'ui-icon-stop' : 'ui-icon-pin-s' - }); - } - - function stopTracking() { - state.tracking = false; - state.routeProgressIndex = null; - state.deviceHeading = null; + function stopRouteSensors() { ns.Geo.stop(); ns.Orientation.stop(); - $('#tracking-status').prop('hidden', true).text(''); + state.deviceHeading = null; + } + + function updateRouteControls() { + const running = state.routeState === 'running'; + const paused = state.routeState === 'paused'; + const startLabel = paused ? 'Route fortsetzen' : 'Route starten'; + + $('#start-route') + .prop('disabled', running) + .attr({ 'aria-label': startLabel, title: startLabel }); + $('#pause-route').prop('disabled', !running); + $('#stop-route').prop('disabled', state.routeState === 'idle'); + } + + function endRoute({ announce = true } = {}) { + const wasActive = state.routeState !== 'idle'; + state.routeState = 'idle'; + state.routeProgressIndex = null; + state.triggered.clear(); + stopRouteSensors(); hideNavigation(); - updateTrackingButton(); + + if (announce && wasActive) { + $('#tracking-status').prop('hidden', false).text('Route beendet.'); + } else { + $('#tracking-status').prop('hidden', true).text(''); + } + + updateRouteControls(); + } + + function pauseRoute() { + if (state.routeState !== 'running') return; + + state.routeState = 'paused'; + stopRouteSensors(); + $('#tracking-status') + .prop('hidden', false) + .text('Route pausiert. Die Standortverfolgung ist angehalten.'); + showNavigation('Route pausiert', $('#navigation-distance').text() || '–'); + updateRouteControls(); } function renderRoute(route) { - if (state.tracking) stopTracking(); + if (state.routeState !== 'idle') endRoute({ announce: false }); state.route = route; state.triggered.clear(); @@ -181,6 +209,8 @@ $('#route-distance').text(ns.Distance.format(route.distanceM)); $('#route-elevation').text(`${Math.round(route.elevationGainM)} m`); $('#route-poi-count').text(route.pois.length); + $('#tracking-status').prop('hidden', true).text(''); + updateRouteControls(); const list = $('#poi-list').empty(); if (!route.pois.length) { @@ -235,7 +265,7 @@ function updateNavigation(position) { const points = state.route?.points || []; - if (!state.tracking || !points.length) return; + if (state.routeState !== 'running' || !points.length) return; const nearestIndex = nearestRoutePointIndex(position); if (nearestIndex == null) return; @@ -298,7 +328,7 @@ function evaluatePosition(position) { state.position = position; - if (!state.route || !state.tracking) return; + if (!state.route || state.routeState !== 'running') return; updateNavigation(position); @@ -321,13 +351,22 @@ } } - async function startTracking() { - state.tracking = true; - state.routeProgressIndex = null; + async function startRoute() { + if (!state.route || state.routeState === 'running') return; + + const resumed = state.routeState === 'paused'; + if (!resumed) { + state.routeProgressIndex = null; + state.triggered.clear(); + } + + state.routeState = 'running'; state.deviceHeading = null; - updateTrackingButton(); - $('#tracking-status').prop('hidden', false).text('GPS wird gestartet.'); - showNavigation(); + updateRouteControls(); + $('#tracking-status') + .prop('hidden', false) + .text(resumed ? 'Route wird fortgesetzt.' : 'Route wird gestartet. GPS wird aktiviert.'); + showNavigation(resumed ? 'Route wird fortgesetzt' : 'Position wird ermittelt'); ns.Geo.start( evaluatePosition, @@ -335,7 +374,12 @@ ); const orientationAvailable = await ns.Orientation.start(updateHeading); - if (!orientationAvailable && state.tracking) { + if (state.routeState !== 'running') { + ns.Orientation.stop(); + return; + } + + if (!orientationAvailable) { $('#navigation-mode').text('Norden oben · nächster Routenpunkt'); } } @@ -372,9 +416,16 @@ else navigate(target, { replace: true }); }); - activate('#start-tracking', async function () { - if (state.tracking) stopTracking(); - else await startTracking(); + activate('#start-route', async function () { + await startRoute(); + }); + + activate('#pause-route', function () { + pauseRoute(); + }); + + activate('#stop-route', function () { + endRoute(); }); window.addEventListener('popstate', event => { @@ -415,7 +466,7 @@ context.markStep('location', 'done'); initializeRouteSearch(); renderRoutes(); - updateTrackingButton(); + updateRouteControls(); hideNavigation(); } }; diff --git a/public/js/bootstrap-loader.js b/public/js/bootstrap-loader.js index d794d63..66b7dd6 100644 --- a/public/js/bootstrap-loader.js +++ b/public/js/bootstrap-loader.js @@ -44,7 +44,6 @@ const $ = window.jQuery; $('#bootstrap-retry').button({ icon: 'ui-icon-refresh' }); $('.back-button').button({ icon: 'ui-icon-caret-1-w' }); - $('#start-tracking').button({ icon: 'ui-icon-pin-s' }); $('#clear-route-search').button({ icon: 'ui-icon-close', showLabel: false }); $('#slide-prev').button({ icon: 'ui-icon-caret-1-w', showLabel: false }); $('#slide-next').button({ icon: 'ui-icon-caret-1-e', showLabel: false }); diff --git a/server.js b/server.js index 41c55f8..7485ff1 100644 --- a/server.js +++ b/server.js @@ -27,7 +27,7 @@ app.use(notFoundHandler); app.use(errorHandler); const server = app.listen(config.port, config.host, () => { - console.log(`${config.instanceName}: Wegwichtel läuft auf http://${config.host}:${config.port}`); + console.log(`Wegwichtel läuft auf http://${config.host}:${config.port}`); }); function shutdown(signal) { diff --git a/src/config.js b/src/config.js index 7cfc288..b7cf12f 100644 --- a/src/config.js +++ b/src/config.js @@ -9,7 +9,6 @@ export const config = Object.freeze({ projectRoot, host: process.env.HOST || '127.0.0.1', port: Number.parseInt(process.env.PORT || '47145', 10), - instanceName: process.env.INSTANCE_NAME || 'Atlas', dataDir: resolveFromRoot(process.env.DATA_DIR, 'data'), storageDir: resolveFromRoot(process.env.STORAGE_DIR, 'storage'), maxUploadBytes: Number.parseInt(process.env.MAX_UPLOAD_MB || '50', 10) * 1024 * 1024, diff --git a/src/routes/api.js b/src/routes/api.js index 3c868ed..f5af0c3 100644 --- a/src/routes/api.js +++ b/src/routes/api.js @@ -20,7 +20,6 @@ export function createApiRouter(db) { res.json({ ok: true, service: 'wegwichtel', - instance: config.instanceName, socket: `${config.host}:${config.port}`, sqliteVersion, timestamp: new Date().toISOString() diff --git a/test/mobile-navigation-ui.test.js b/test/mobile-navigation-ui.test.js new file mode 100644 index 0000000..e572438 --- /dev/null +++ b/test/mobile-navigation-ui.test.js @@ -0,0 +1,105 @@ +import assert from 'node:assert/strict'; +import fs from 'node:fs/promises'; +import path from 'node:path'; +import test from 'node:test'; +import vm from 'node:vm'; + +const root = path.resolve(import.meta.dirname, '..'); + +async function read(relativePath) { + return fs.readFile(path.join(root, relativePath), 'utf8'); +} + +async function clientSources() { + const directory = path.join(root, 'public/js'); + const names = await fs.readdir(directory); + return Promise.all(names.filter(name => name.endsWith('.js')).map(name => read(`public/js/${name}`))); +} + +test('every static HTML id is referenced by authored client JavaScript', async () => { + const html = await read('public/index.html'); + const scripts = (await clientSources()).join('\n'); + const ids = [...html.matchAll(/\bid="([^"]+)"/g)].map(match => match[1]); + + assert.ok(ids.length > 0); + for (const id of ids) { + assert.match(scripts, new RegExp(id.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')), `unused id: ${id}`); + } +}); + +test('every static HTML class is used by CSS or authored JavaScript', async () => { + const html = await read('public/index.html'); + const css = `${await read('public/css/bootstrap.css')}\n${await read('public/css/app.css')}`; + const scripts = (await clientSources()).join('\n'); + const classes = [...html.matchAll(/\bclass="([^"]+)"/g)] + .flatMap(match => match[1].split(/\s+/)) + .filter(Boolean); + + for (const className of new Set(classes)) { + assert.ok(css.includes(className) || scripts.includes(className), `unused class: ${className}`); + } +}); + +test('application actions use pointer events instead of click handlers', async () => { + const scripts = (await Promise.all([ + read('public/js/app.js'), + read('public/js/slideshow.js'), + read('public/js/bootstrap-loader.js') + ])).join('\n'); + + assert.match(scripts, /pointerup/); + assert.match(scripts, /keydown/); + assert.doesNotMatch(scripts, /(?:\.on|addEventListener)\(\s*['"]click['"]/); +}); + +test('mobile navigation footer contains a rotating SVG arrow and exact metre output', async () => { + const html = await read('public/index.html'); + const app = await read('public/js/app.js'); + const css = await read('public/css/app.css'); + + assert.match(html, /