Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions tests/sw_asset_hash.test.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
// Wächter gegen veraltete Service-Worker-Caches (Vorlage: assistassets-ai/mediplaner a0363a2, PR #8).
// Der Service Worker liefert cache-first: ändert sich eine gecachte Datei, ohne dass CACHE_NAME steigt,
// behalten installierte PWAs den alten Code. ASSET_HASH bindet die Version an den Inhalt.
// Der Service Worker selbst zählt nicht mit (ein Eintrag von sich selbst wäre zirkulär; Browser prüfen ihn ohnehin per Byte-Vergleich).
// Die Dateiliste kommt aus dem Asset-Array des Service Workers selbst (inkl. Manifest und Icons);
// eine eigene Liste hier würde still veralten. Schlägt der Test fehl:
// CACHE_NAME in service-worker.js erhöhen und ASSET_HASH auf den genannten Wert setzen.
import { describe, it } from 'node:test';
import assert from 'node:assert/strict';
import { createHash } from 'node:crypto';
import fs from 'node:fs';
import path from 'node:path';
import { fileURLToPath } from 'node:url';

const ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../webapp/static');
const SW = 'service-worker.js';
const ARRAY = 'STATIC_ASSETS';
// Asset-URL im Service Worker -> Datei relativ zu ROOT ('' = ausgelassen)
const toFile = (asset) => (asset === '/' ? 'index.html' : asset.startsWith('/assets/') ? '../../store_assets/' + asset.slice(8) : asset.slice(1));
const TEXT = /\.(html|js|mjs|css|webmanifest|json|svg|txt|xml)$/i;

// Exakte Groß-/Kleinschreibung: Windows/macOS verbergen Abweichungen, ein Linux-Server liefert dann 404
// (und cache.addAll() bricht die gesamte Installation des Service Workers ab).
const exists = (rel) => {
const abs = path.resolve(ROOT, rel);
for (let cur = abs; cur !== ROOT && cur !== path.dirname(cur); cur = path.dirname(cur)) {
let names;
try { names = fs.readdirSync(path.dirname(cur)); } catch { continue; }
if (!names.includes(path.basename(cur))) return false;
}
return fs.existsSync(abs);
};
const read = (rel) => fs.readFileSync(path.join(ROOT, rel), 'utf-8');

describe('Service-Worker-Cache', () => {
it('ASSET_HASH passt zum Inhalt aller gecachten Dateien', () => {
const sw = read(SW);
const block = sw.match(new RegExp(`const ${ARRAY}\\s*=\\s*\\[([\\s\\S]*?)\\];?`));
assert.ok(block, `${ARRAY} fehlt in ${SW}`);
const assets = [...new Set([...block[1].matchAll(/['"]([^'"]+)['"]/g)]
.map((m) => toFile(m[1]))
.filter((rel) => rel !== '' && rel !== SW))];
assert.ok(assets.includes('index.html'), `index.html fehlt in ${ARRAY}`);
const hash = createHash('sha256');
for (const rel of assets) {
assert.ok(exists(rel), `In ${ARRAY} gelistet, aber nicht vorhanden: ${rel}`);
const content = TEXT.test(rel)
? Buffer.from(read(rel).replace(/\r\n/g, '\n'), 'utf-8')
: fs.readFileSync(path.join(ROOT, rel));
hash.update(`${rel}\0`);
hash.update(content);
}
const actual = hash.digest('hex').slice(0, 12);
const recorded = sw.match(/ASSET_HASH\s*=\s*['"]([0-9a-f]{12})['"]/);
assert.ok(recorded, `ASSET_HASH fehlt in ${SW}`);
assert.equal(recorded[1], actual,
`Gecachte Dateien geändert: CACHE_NAME in ${SW} erhöhen und ASSET_HASH auf '${actual}' setzen`);
});
});
22 changes: 22 additions & 0 deletions tests/test_sw_asset_hash.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
"""Fuehrt den Service-Worker-Waechter (ASSET_HASH) aus; ohne Node.js wird er uebersprungen."""
import shutil
import subprocess
from pathlib import Path

import pytest

ROOT = Path(__file__).resolve().parents[1]


@pytest.mark.skipif(shutil.which("node") is None, reason="Node.js nicht installiert")
def test_sw_asset_hash_waechter():
res = subprocess.run(
["node", "--test", "tests/sw_asset_hash.test.mjs"],
cwd=ROOT,
capture_output=True,
text=True,
encoding="utf-8",
errors="replace",
check=False,
)
assert res.returncode == 0, f"{res.stdout}\n{res.stderr}"
3 changes: 3 additions & 0 deletions webapp/static/service-worker.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
const CACHE_NAME = "methodenanalyser-webapp-v3";
// Inhalts-Hash aller STATIC_ASSETS-Dateien inkl. Manifest und Icons (tests/sw_asset_hash.test.mjs prueft ihn):
// aendert sich eine davon, CACHE_NAME erhoehen, sonst behalten installierte PWAs den alten Code.
const ASSET_HASH = 'af4ec644be12'; // eslint-disable-line no-unused-vars
const STATIC_ASSETS = [
"/",
"/index.html",
Expand Down
Loading