Abschnitt 18 · Lektion 2
Konfiguration
Ein Tippfehler in einem Variablennamen wirft keinen Fehler. Heißt die Variable in Wahrheit
SITZUNGSDAUER_MINUTEN, ist process.env.SITZUNGSDAUER einfach undefined. Der Standardwert
greift, und der Server läuft weiter, als wäre alles in Ordnung.
Die Liste, die niemand hat
// Zwei Zugriffe hier ...
const PORT = process.env.PORT ?? 3000;
const MAX_KB = process.env.MAX_RUMPF_KB ?? 100;
console.log("Port:", PORT, typeof PORT);
console.log("Rumpfgrenze:", MAX_KB, typeof MAX_KB); // ... zwei weitere hier, und einer davon ist falsch geschrieben.
const DAUER = process.env.SITZUNGSDAUER ?? 60;
const SECRET = process.env.SITZUNGS_SECRET ?? "bitte-aendern";
console.log("Dauer:", DAUER);
console.log("Secret:", SECRET);
// Der Name heisst in Wahrheit SITZUNGSDAUER_MINUTEN. Setzt jemand die
// Variable, passiert trotzdem nichts: Der Zugriff ist undefined, das
// ?? greift, und es sieht aus, als sei alles in Ordnung. process.env.SITZUNGSDAUER_MINUTEN = "120";
process.env.MAX_RUMPF_KB = "500";
process.env.DEBUG = "false";
await import("./server.js");
await import("./sitzung.js");
// Und der Klassiker aus Lektion 4.2 gleich mit:
console.log("DEBUG greift:", process.env.DEBUG ? "ja" : "nein"); Zwei Dinge gehen hier schief, und beide still. Der Name in sitzung.js ist falsch geschrieben, also
greift der Standardwert, obwohl die Variable gesetzt ist. Und MAX_RUMPF_KB kommt als Text an, denn
aus der Umgebung kommt nie etwas anderes, auch wenn dort eine Zahl steht. Beides fällt erst auf,
wenn sich jemand wundert, warum eine Einstellung nichts bewirkt.
Welche Variablen so eine Anwendung braucht, findest du nur mit grep heraus.
grep -rn process.env . findet acht Zeilen in drei Dateien. Schon bei acht musst du zweimal
hinsehen, welche davon wirklich etwas lesen. Drei setzen in probe.js nur die Umgebung, damit es im
Beispiel etwas zu sehen gibt. In einem gewachsenen Projekt sind es schnell ein paar Dutzend.
grep findet allerdings nur, was jemand geschrieben hat, und nicht das, was fehlt.
Ein Modul, das liest, umwandelt und prüft
function zahl(name, standard) {
const roh = process.env[name];
if (roh === undefined || roh === "") return standard;
const wert = Number(roh);
if (!Number.isFinite(wert)) {
throw new Error(`${name} muss eine Zahl sein, steht aber auf „${roh}“.`);
}
return wert;
}
// Ein Secret hat keinen Standardwert. Fehlt es, startet nichts.
for (const name of ["SITZUNGS_SECRET"]) {
if (!process.env[name]) throw new Error(`Start abgebrochen: ${name} fehlt.`);
}
export const konfig = {
port: zahl("PORT", 3000),
maxRumpfKb: zahl("MAX_RUMPF_KB", 100),
sitzungsSecret: process.env.SITZUNGS_SECRET,
}; process.env.SITZUNGS_SECRET = "aus-der-umgebung";
process.env.MAX_RUMPF_KB = "500";
const { konfig } = await import("./konfig.js");
console.log(konfig.port, typeof konfig.port);
console.log(konfig.maxRumpfKb, typeof konfig.maxRumpfKb);
console.log("Secret kommt aus der Umgebung:", konfig.sitzungsSecret); konfig.js liest die Umgebung, wandelt um, prüft und exportiert ein fertiges Objekt. Danach kommt
im ganzen Projekt kein process.env mehr vor, und der Rest der Anwendung arbeitet mit konfig.port
als Zahl statt mit einem Text, von dem man hofft, dass er eine ist.
Im Beispiel wird nur aus Text eine Zahl. Ein Wahrheitswert braucht dieselbe Sorgfalt, denn dort
wartet die Falle mit DEBUG aus dem ersten Beispiel. DEBUG=false ist der Text "false", und der
ist wahr.
Startest du konfig.js allein mit node konfig.js, fehlt die Probe davor und mit ihr
SITZUNGS_SECRET. Der Start bricht ab, bevor irgendetwas anderes passiert. Im Terminal steht
Error: Start abgebrochen: SITZUNGS_SECRET fehlt., mit dem Namen der fehlenden Angabe. Ohne so eine
Prüfung startet ein Server, sieht gut aus und stirbt Stunden später mit einer Fehlermeldung, die mit
der Ursache nichts zu tun hat.
Standardwerte ja, für Secrets nein
import { createHmac } from "node:crypto";
// Der bequeme Weg: ein Standard, damit es „auch ohne .env laeuft“.
const SECRET = process.env.SITZUNGS_SECRET ?? "bitte-aendern";
function signiere(wert) {
return `${wert}.${createHmac("sha256", SECRET).update(wert).digest("hex").slice(0, 16)}`;
}
console.log("Server vergibt:", signiere("nutzer=7"));
// Und jetzt jemand anders, der nur den Standardwert kennt und sich
// damit eine Kennung fuer Nutzer 1 baut:
const gefaelscht = `nutzer=1.${createHmac("sha256", "bitte-aendern").update("nutzer=1").digest("hex").slice(0, 16)}`;
console.log("Fremder fälscht:", gefaelscht);
console.log("Server akzeptiert das:", gefaelscht === signiere("nutzer=1"));
// Der Standardwert steht in deinem Repository. Er ist damit kein
// Secret, sondern ein oeffentlicher Text, der aussieht wie eins. Ohne
// ihn waere der Server nicht gestartet, und das waere die richtige
// Reaktion gewesen. Ein Standardwert für den Port ist praktisch. Einer für einen Signaturschlüssel ist eine Katastrophe mit Anlauf. Er steht ja im Repository, und jeder, der das Repository sieht, kann damit Kennungen ausstellen, die der Server für echt hält. Im Beispiel baut sich so jemand eine Kennung für Nutzer 1, und der Server nimmt sie an. Ohne Standardwert bricht der Start ab, wenn das Secret fehlt. Das nervt beim ersten Mal auf einem neuen Rechner, sonst kostet es nichts.
Daran lassen sich die beiden Sorten auch auseinanderhalten. Für eine Einstellung lässt sich ein sinnvoller Wert hinschreiben, für ein Secret nicht. Fühlt es sich doch so an, ist es keins.
Konfiguration und Secrets sind zwei Dinge
Beide nehmen denselben Weg, die Umgebung, und werden trotzdem gern verwechselt.
Konfiguration ist alles, was sich zwischen Entwicklung und Betrieb unterscheidet und niemandem
schadet, wenn er es liest, etwa Port, Datenbankpfad, Stufe des Protokolls oder Basis-URL. Sie darf
in der .env.example mit Werten stehen.
Secrets sind alles, womit sich jemand als du ausgeben kann. Sie stehen in der .env.example nur als
Name ohne Wert, nie im Code, und sie haben keinen Standardwert. So stand es schon in Lektion 15.4.
In konfig.js werden sie jetzt zu einer Liste, die beim Start geprüft wird.
In der Aufgabe sammelt konfig.js ihre Werte schon an einer Stelle, umgewandelt und geprüft wird
dort aber noch nichts.
Zum Mitnehmen
Die Umgebung wird an einer Stelle gelesen, in Zahlen und Wahrheitswerte umgewandelt und beim Start geprüft. Einstellungen dürfen einen Standardwert haben, Secrets nicht.
Jetzt du
Basis Konto, kostenlosZu dieser Lektion gehört eine Aufgabe. Du schreibst den Code selbst, und nach jedem Lauf sagt dir eine Prüfliste, was schon stimmt.
Dafür brauchst du das Basis Konto. Es kostet nichts, und ein Passwort gibt es auch nicht.
In diesem Kurs läuft dein Code auf einem Server. Dafür hat das Basis Konto 1 Stunde im Monat, mehr Zeit gibt es mit dem Premium Konto.
Was in dieser Lektion steckt
-
Artikel mit 3 Beispielen zum Ausprobieren
Steht hier, ohne Konto lesbar.
-
Aufgabe, dein Code läuft auf einem Server
Öffnet sich mit dem Basis Konto.