CSS/JS: Git-Revision von HEAD als GET-Parameter verwenden
authorMoritz Bunkus <m.bunkus@linet.de>
Mon, 16 Nov 2020 16:02:38 +0000 (17:02 +0100)
committerMoritz Bunkus <m.bunkus@linet.de>
Mon, 16 Nov 2020 16:18:19 +0000 (17:18 +0100)
commitcf96c5880f1ba0694298d7541fedce47c8c99051
tree8524e4222b0113dc31a58dd2e39da22d7faee67d
parent737a6fd7365f560a5435008f6445416794764b20
CSS/JS: Git-Revision von HEAD als GET-Parameter verwenden

Webbrowser cachen CSS & JS sehr aggressiv. Das ist während der
Entwicklung störend, weshalb es bereits seit langem die
Konfigurationsoption `auto_reload_resources` gibt. Ist diese an, so
wird an alle CSS- und JS-URLs ein GET-Parameter `?rand=<Zufallswert>`
angehängt wird, um das Cachen auszuhebeln.

Dieser Commit führt etwas Ähnliches ein, das für den Produktivbetrieb
ohne `auto_reload_resources` gedacht ist. Wenn kivitendo erkennt, dass
es aus git heraus läuft (also ein `.git`-Verzeichnis existiert), so
parset es die Revision von `HEAD` und nimmt das als GET-Parameter
`?rand=<Revision>`. Der Vorteil ist, dass nach Updates einer
Produktivinstallation die Webbrowser der Anwender*innen genau einmal
alle Ressourcen neu laden, weil sich ja die Git-Revisionsnummer
geändert hat. Anschließend können sie die Ressourcen aber wieder
normal cachen, bis das nächste Update kommt.

Es wird hierfür übrigens kein installiertes git-Executable benötigt;
die Infos werden zwecks Performance direkt aus den Dateien gelesen,
anstatt bei jedem Request ein Programm auszuführen.

Zukünftig könnte man ein analoges Verfahren anwenden, wenn es kein
`.git`-Verzeichnis gibt, und dann zumindest die
kivitendo-Versionsnummer verwenden.
SL/Layout/Base.pm