diff options
Diffstat (limited to 'deploy/webpaket.sh')
| -rwxr-xr-x | deploy/webpaket.sh | 113 |
1 files changed, 98 insertions, 15 deletions
diff --git a/deploy/webpaket.sh b/deploy/webpaket.sh index 2003134..75ad471 100755 --- a/deploy/webpaket.sh +++ b/deploy/webpaket.sh @@ -3,11 +3,19 @@ # „package“ des Profils -Pwasm, unmittelbar nach native-image. # # 1. Der Textzwischenschritt aendggner.js.wat (mehrere hundert Megabyte) wird entfernt. -# 2. Der Quelltext der gebauten Fassung wird als Tarball beigelegt — AGPLv3 §13 verlangt +# 2. Das Modul geht durch wasm-opt -Oz, sofern Binaryen zur Hand ist. +# 3. Der Quelltext der gebauten Fassung wird als Tarball beigelegt — AGPLv3 §13 verlangt # beim Netzwerkbetrieb einen Quellcode-Zugang für die Nutzer:innen, und der Footer der # Startseite verweist darauf. -# 3. Die großen Dateien werden vorkomprimiert, damit nginx sie mit gzip_static bzw. -# brotli_static ausliefern kann, statt 24 MB je Abruf neu zu packen. +# 4. Nur die vom Bau erzeugten Dateien bleiben stehen; alles hier Liegende wird +# hochgeladen. +# 5. Auf Wunsch (VORKOMPRIMIEREN=1) werden die großen Dateien vorkomprimiert. +# +# Zielplattform ist Cloudflare Workers: dort gilt eine Grenze von 25 MiB je Datei +# (unkomprimiert), und komprimiert wird beim Ausliefern ohnehin. Deshalb ist die +# Vorkompression abgeschaltet und die Größe jeder Datei wird geprüft. Wer stattdessen +# selbst mit nginx ausliefert (deploy/nginx-aendggner.conf, gzip_static/brotli_static), +# ruft das Skript mit VORKOMPRIMIEREN=1 auf. # # Aufruf: deploy/webpaket.sh <ausgabeverzeichnis> (Standard: target/web) @@ -16,15 +24,56 @@ set -eu ziel="${1:-target/web}" quelle="$(CDPATH='' cd -- "$(dirname -- "$0")/.." && pwd)" +# Cloudflare Workers nimmt keine Datei über 25 MiB an. +grenze_datei=26214400 +# Der Quelltext misst ein Viertel Megabyte. Wächst das Archiv über diese Schranke, sind +# wieder Massendaten ins Repository geraten, die dort nicht hingehören (siehe +# .gitattributes) — dann lieber der Bau ab als ein unbrauchbares Paket. +grenze_archiv=8388608 + if [ ! -d "$ziel" ]; then echo "webpaket: $ziel gibt es nicht — erst -Pwasm package laufen lassen." >&2 exit 1 fi +groesse() { + wc -c <"$1" | tr -d ' ' +} + # 1. Zwischenschritt fort. rm -f "$ziel/aendggner.js.wat" -# 2. Quelltext der gebauten Fassung. +# 2. Nachoptimierung. -Oz zieht die Codegröße noch einmal spürbar zusammen. +# +# Die Merkmale sind einzeln aufgezählt, nicht als --all-features: Binaryen darf ausgeben, +# was es darf, und mit --all-features nutzt es auch Vorschläge, die noch kein Browser +# annimmt — das Modul scheitert dann erst beim Instanziieren („invalid heap type 'exact'“ +# aus den custom descriptors, „invalid import kind 127“ aus der kompakten +# Importsektion). Aufgeführt ist deshalb nur, was ausgeliefert in den Browsern steht und +# was Web Image braucht: WasmGC samt Referenztypen, das Ausnahmen-Proposal, endständige +# Aufrufe. Fehlt wasm-opt, bleibt das Modul, wie es ist — der Bau soll daran nicht +# scheitern. +wasm_merkmale="--enable-gc --enable-reference-types --enable-exception-handling + --enable-tail-call --enable-bulk-memory --enable-bulk-memory-opt + --enable-nontrapping-float-to-int --enable-sign-ext + --enable-mutable-globals --enable-multivalue --enable-extended-const + --enable-simd --enable-call-indirect-overlong" + +if [ -f "$ziel/aendggner.js.wasm" ]; then + vorher="$(groesse "$ziel/aendggner.js.wasm")" + if command -v wasm-opt >/dev/null 2>&1; then + # shellcheck disable=SC2086 # die Merkmalsliste soll in Wörter zerfallen + wasm-opt $wasm_merkmale -Oz \ + -o "$ziel/aendggner.js.wasm.neu" "$ziel/aendggner.js.wasm" + mv "$ziel/aendggner.js.wasm.neu" "$ziel/aendggner.js.wasm" + echo "webpaket: wasm-opt: $vorher -> $(groesse "$ziel/aendggner.js.wasm") Bytes." + else + echo "webpaket: wasm-opt nicht gefunden — Modul bleibt unnachoptimiert" \ + "($vorher Bytes)." >&2 + fi +fi + +# 3. Quelltext der gebauten Fassung. # # Ein veränderter Arbeitsbaum bricht den Bau ab: Der angebotene Quelltext muss der # ausgelieferten Fassung entsprechen, sonst ist die Auflage aus §13 verfehlt. Wer nur @@ -43,8 +92,16 @@ if [ -n "$(git -C "$quelle" status --porcelain)" ] && [ "${QUELLTEXT_UNGEPRUEFT: fi fassung="$(git -C "$quelle" rev-parse HEAD)" -git -C "$quelle" archive --format=tar.gz --prefix=aendggner/ HEAD \ - -o "$(CDPATH='' cd -- "$ziel" && pwd)/aendggner-quelltext.tar.gz" +archiv="$(CDPATH='' cd -- "$ziel" && pwd)/aendggner-quelltext.tar.gz" +git -C "$quelle" archive --format=tar.gz --prefix=aendggner/ HEAD -o "$archiv" + +archivgroesse="$(groesse "$archiv")" +if [ "$archivgroesse" -gt "$grenze_archiv" ]; then + echo "webpaket: Das Quelltextarchiv misst $archivgroesse Bytes und überschreitet damit" >&2 + echo " die Schranke von $grenze_archiv. Vermutlich sind Massendaten ins" >&2 + echo " Repository geraten; sie gehören in .gitattributes (export-ignore)." >&2 + exit 1 +fi { echo "ÄndGgner — Quelltext der ausgelieferten Fassung" @@ -54,20 +111,46 @@ git -C "$quelle" archive --format=tar.gz --prefix=aendggner/ HEAD \ echo echo "Vollständig in aendggner-quelltext.tar.gz; Bauanleitung darin in README.adoc." echo "Fortlaufend: https://gerrit.benkard.de/plugins/gitiles/aendggner" + echo + echo "Nicht im Archiv liegt der Beispielkorpus (src/test/resources/sampledata): Gesetzes-" + echo "und Drucksachentexte fremder Urheberschaft, an denen die Tests messen. Gebaut wird" + echo "ohne ihn; nur die Tests verlangen danach. Wer sie laufen lassen will, holt das" + echo "Repository von der oben genannten Adresse, wo der Korpus vollständig liegt." } > "$ziel/quelltext-fassung.txt" -# 3. Vorkompression. Der Tarball ist bereits gepackt und bleibt außen vor. -for datei in "$ziel"/*.wasm "$ziel"/*.js "$ziel"/*.css "$ziel"/*.html "$ziel"/*.svg \ - "$ziel"/*.txt; do +# 4. Nur das Gebaute bleibt liegen — was hier steht, geht hoch. +rm -f "$ziel/.DS_Store" + +# 5. Vorkompression, nur auf Anforderung (siehe Kopf). Der Tarball ist bereits gepackt und +# bleibt außen vor. +if [ "${VORKOMPRIMIEREN:-}" = 1 ]; then + for datei in "$ziel"/*.wasm "$ziel"/*.js "$ziel"/*.css "$ziel"/*.html "$ziel"/*.svg \ + "$ziel"/*.txt; do + [ -f "$datei" ] || continue + gzip -9 -f -k -- "$datei" + if command -v brotli >/dev/null 2>&1; then + brotli -f -- "$datei" + fi + done + + if ! command -v brotli >/dev/null 2>&1; then + echo "webpaket: brotli nicht gefunden — nur .gz angelegt." >&2 + fi +fi + +# Was zu groß ist, nimmt Cloudflare nicht an. Lieber hier auffallen als beim Hochladen. +zugross="" +for datei in "$ziel"/*; do [ -f "$datei" ] || continue - gzip -9 -f -k -- "$datei" - if command -v brotli >/dev/null 2>&1; then - brotli -f -- "$datei" + if [ "$(groesse "$datei")" -gt "$grenze_datei" ]; then + zugross="$zugross $(basename "$datei") ($(groesse "$datei") Bytes) +" fi done - -if ! command -v brotli >/dev/null 2>&1; then - echo "webpaket: brotli nicht gefunden — nur .gz angelegt." >&2 +if [ -n "$zugross" ]; then + echo "webpaket: Diese Dateien überschreiten die 25-MiB-Grenze von Cloudflare Workers:" >&2 + printf '%s' "$zugross" >&2 + exit 1 fi echo "webpaket: $ziel ist auslieferbar (Fassung $(git -C "$quelle" rev-parse --short HEAD))." |