Wenn das Netz ausfällt
Netze fallen ständig aus: Das WLAN bricht ab, ein Server startet neu, ein Dienst ist überlastet. Ein Programm, das beim ersten Schluckauf abstürzt, nervt. Dieses Rezept baut eine Anfrage, die es noch einmal versucht und dabei jedes Mal etwas länger wartet, und die dem Spieler in einfachen Worten sagt, was schiefging, wenn sie schließlich aufgibt.
Funktionen: die Fehler von c0de net, HTTP_GET und SLEEP aus c0de/time
Was du brauchst
Die Mod c0de net in deinem Spiel, einen Auslöserblock mit Knopf, einen Laptop, zwei nicht initialisierte Variablenkarten und wahlweise Variablenkarten server und endpoint vom Typ STRING. Ohne sie fragt das Programm c0de.at nach den neuesten Versionen von c0de.
Die Idee
Jede Funktion von c0de_net/http löst einen Fehler aus, wenn die Anfrage nicht klappt. Ein CALL mit einer ERROR-Variablen fängt ihn ab, und ihr code sagt, was passiert ist:
| Code | Name | Was passiert ist | Nochmal versuchen? |
|---|---|---|---|
| 309 | INVALID_ARGUMENT | die Verbindung oder der Endpunkt ist falsch | nein, korrigiere das Programm |
| 1000 | HTTP_STATUS | der Server hat mit einem Status ab 400 geantwortet | nur bei 429 und 500 – 599 |
| 1001 | CLIENT_UNAVAILABLE | der Spieler ist nicht online oder hat kein c0de net | nein |
| 1002 | REQUESTS_DISABLED | der Spieler hat Anfragen auf seinem Computer abgeschaltet | nein |
| 1003 | REQUEST_FAILED | keine Verbindung: unbekannter Host, abgewiesen, Netz weg | ja |
| 1004 | REQUEST_TIMEOUT | keine vollständige Antwort innerhalb des Timeouts | ja |
| 1005 | RESPONSE_TOO_LARGE | die Antwort ist größer, als der Server erlaubt | nein, frag nach weniger |
Die Namen sind Konstanten, die die Codes enthalten: INVALID_ARGUMENT ist eine Konstante von c0de, die anderen kommen wie die Funktionen mit INCLUDE c0de_net/http, als c0de_net/http/HTTP_STATUS und so weiter. Vergleiche mit ihnen statt mit den Zahlen; das Programm liest sich besser, und ein Tippfehler fällt bei der Prüfung auf.
Ein neuer Versuch hilft nur, wenn das Problem von selbst verschwinden kann. Und sofort nochmal zu fragen, hilft selten: Ist ein Server überlastet, machen hundert Programme, die gleichzeitig nochmal fragen, es schlimmer. Deshalb wächst die Wartezeit mit jedem Versuch – 1 Sekunde, 2, 4 –, das nennt man exponentielles Backoff. SLEEP wartet eine Zahl von Spielticks; 20 Ticks sind eine Sekunde.
Das Programm
PROGRAM netretry
NOOP
INCLUDE c0de/time
INCLUDE c0de_net/http
NOOP
FUNCTION explain
PARAMETER code INTEGER
PARAMETER status INTEGER 0
RESULT text STRING
BEGIN
ASSIGN text "Unexpected error " ⊕ code ;
IF code = INVALID_ARGUMENT ;
BEGIN
ASSIGN text "The connection settings are wrong" ;
END IF
IF code = c0de_net/http/HTTP_STATUS ;
BEGIN
ASSIGN text "The server refused with status " ⊕ status ;
IF status = 404 ;
BEGIN
ASSIGN text "There is nothing at this address" ;
END IF
IF status = 429 ;
BEGIN
ASSIGN text "Too many requests, try again later" ;
END IF
IF status ≥ 500 ;
BEGIN
ASSIGN text "The server has a problem" ;
END IF
END IF
IF code = c0de_net/http/CLIENT_UNAVAILABLE ;
BEGIN
ASSIGN text "Nobody with c0de net is online" ;
END IF
IF code = c0de_net/http/REQUESTS_DISABLED ;
BEGIN
ASSIGN text "Requests are switched off" ;
END IF
IF code = c0de_net/http/REQUEST_FAILED ;
BEGIN
ASSIGN text "The server can't be reached" ;
END IF
IF code = c0de_net/http/REQUEST_TIMEOUT ;
BEGIN
ASSIGN text "The server is too slow" ;
END IF
IF code = c0de_net/http/RESPONSE_TOO_LARGE ;
BEGIN
ASSIGN text "The answer is too large" ;
END IF
END FUNCTION
NOOP
FUNCTION worthRetrying
PARAMETER code INTEGER
PARAMETER status INTEGER
RESULT result BOOLEAN
BEGIN
ASSIGN result code = c0de_net/http/REQUEST_FAILED OR code = c0de_net/http/REQUEST_TIMEOUT OR ( code = c0de_net/http/HTTP_STATUS AND ( status = 429 OR status ≥ 500 ) ) ;
END FUNCTION
NOOP
FUNCTION fetch
PARAMETER server STRING "c0de.at"
PARAMETER endpoint STRING "/api/version"
RESULT answer STRING
RESULT tries INTEGER
BEGIN
VARIABLE api STRUCT c0de_net/http/HTTP_CONNECTION
VARIABLE problem ERROR
VARIABLE status INTEGER
VARIABLE again BOOLEAN TRUE
VARIABLE wait INTEGER 20
VARIABLE text STRING
ASSIGN api.use_ssl TRUE ;
ASSIGN api.server server ;
ASSIGN api.timeout 10 ;
CALL CLS
WHILE again ;
BEGIN
ASSIGN tries tries + 1 ;
CALL c0de_net/http/HTTP_GET problem
PARAMETER connection api ;
PARAMETER endpoint endpoint ;
RESULT result answer
RESULT status status
CALL worthRetrying
PARAMETER code problem.code ;
PARAMETER status status ;
RESULT result again
IF again AND tries < 4 ;
BEGIN
CALL PRINT
PARAMETER value "Try " ⊕ tries ⊕ " failed, waiting " ⊕ wait ⊕ " ticks" ;
CALL c0de/time/SLEEP
PARAMETER ticks wait ;
ASSIGN wait wait * 2 ;
END
ELSE
BEGIN
ASSIGN again FALSE ;
END IF
END WHILE
IF problem.code ≠ 0 ;
BEGIN
CALL explain
PARAMETER code problem.code ;
PARAMETER status status ;
RESULT text text
CALL PRINT
PARAMETER value text ;
EXIT 1 ;
END IF
CALL PRINT
PARAMETER value answer ;
END FUNCTIONAufbauen und starten
- Binde den Laptop an
netretry/fetch. - Stelle den Auslöserblock auf
netretry/fetch, leg zwei nicht initialisierte Variablenkarten hinein und drück den Knopf. Der Laptop zeigt die Antwort,{"c0de":"0.5.0","c0de_net":"0.3.0"}, und das Ergebnistriesist 1. - Leg eine Variablenkarte
servermitnothing.invalidhinein, einem Namen, den es nie gibt, und drück noch einmal. Jetzt zeigt der Laptop:
Try 1 failed, waiting 20 ticks
Try 2 failed, waiting 40 ticks
Try 3 failed, waiting 80 ticks
The server can't be reachedDer Exit-Code ist 1, also kann ein Komparator ihn anzeigen. Mit dem Server c0de.at und dem Endpunkt /api/nothing gibt es keinen neuen Versuch: Der Laptop zeigt nach dem ersten Versuch There is nothing at this address.
So funktioniert es
explainmacht aus einem Code Worte. Es beginnt mit einer Meldung für unbekannte Codes und überschreibt sie für jeden Code, den es kennt. Bei HTTP_STATUS sagt der Status mehr: 404 ist eine falsche Adresse, 429 heißt „zu viele Anfragen“, ab 500 hat der Server ein Problem. Es vergleichtcodemit den Konstanten:INVALID_ARGUMENTvon c0de undc0de_net/http/HTTP_STATUSund den anderen von c0de net.worthRetryingentscheidet. Nur REQUEST_FAILED, REQUEST_TIMEOUT und die Status 429 und ab 500 können von selbst verschwinden. Ein 404 bleibt ein 404, egal wie oft du fragst.- Die Schleife läuft, solange
againwahr ist. Jede Runde sendet die Anfrage mitproblemin der CALL-Zeile, also lässt kein Fehler den Prozess abstürzen. Eine erfolgreiche Anfrage setztproblem.codewieder auf 0, undworthRetryingsagtFALSE. Nach dem vierten Versuch beendet das ELSE die Schleife ohnehin. - Die Wartezeit verdoppelt sich:
waitbeginnt bei 20 Ticks und wird zu 40 und 80. SLEEP hält nur diesen Prozess an; das Spiel und andere Programme laufen weiter. - Aufgeben gibt die Meldung von
explainaus und endet mitEXIT 1, also meldet der Auslöserblock es ohne Absturz. - Wen der Fehler betrifft. Die Anfrage wird vom Computer des Spielers gesendet, der den Knopf gedrückt hat. CLIENT_UNAVAILABLE und REQUESTS_DISABLED betreffen diesen Spieler, nicht den Server – dasselbe Programm kann bei einem Freund funktionieren.
Vorsicht bei Wiederholungen von Anfragen, die etwas ändern. Läuft bei einem POST das Timeout ab, hat der Server den Eintrag vielleicht trotzdem gespeichert, und ein neuer Versuch legt ihn ein zweites Mal an. GET, HEAD, PUT und DELETE lassen sich gefahrlos wiederholen: Zweimal fragen oder zweimal löschen hinterlässt dasselbe Ergebnis.
Probier es selbst
- Die Aufgabenliste von c0de.at beantwortet Fehler mit einem Grund in JSON, etwa
{"error":"no such entry"}. Zeige die Statuszeile und diesen Grund.
Lösung
PROGRAM netreason
NOOP
INCLUDE c0de/strings
INCLUDE c0de_net/http
NOOP
FUNCTION why
PARAMETER endpoint STRING "/api/tutorial/todo/99"
RESULT text STRING
BEGIN
VARIABLE api STRUCT c0de_net/http/HTTP_CONNECTION
VARIABLE problem ERROR
VARIABLE unreadable ERROR
VARIABLE answer STRING
VARIABLE reason STRING TAG(json: "error")
ASSIGN api.use_ssl TRUE ;
ASSIGN api.server "c0de.at" ;
ASSIGN api.timeout 10 ;
CALL c0de_net/http/HTTP_GET problem
PARAMETER connection api ;
PARAMETER endpoint endpoint ;
RESULT result answer
ASSIGN text "OK" ;
IF problem.code = c0de_net/http/HTTP_STATUS ;
BEGIN
ASSIGN text problem.message ;
CALL c0de/strings/FROM_JSON unreadable
PARAMETER source answer ;
PARAMETER destination reason ;
IF unreadable.code = 0 ;
BEGIN
ASSIGN text text ⊕ ": " ⊕ reason ;
END IF
END IF
CALL PRINT
PARAMETER value text ;
END FUNCTIONHTTP_GET liefert result auch dann, wenn es HTTP_STATUS auslöst, also lässt sich die Antwort nach dem Fehler lesen. Nicht jeder Server beantwortet Fehler in JSON, deshalb bekommt FROM_JSON eine eigene ERROR-Variable: Lässt sich die Antwort nicht lesen, zeigt das Programm nur die Statuszeile. Für den Eintrag 99 ist der Text 404 Not Found: no such entry.
- Ein langsamer Server lässt den Spieler lange warten. Lass das Programm früher aufgeben.
Lösung
Senke api.timeout, zum Beispiel auf 3 Sekunden. Das Timeout umfasst die ganze Anfrage bis zum letzten Byte der Antwort; mit vier Versuchen und den Wartezeiten von 1 + 2 + 4 Sekunden gibt das Programm dann nach höchstens 19 Sekunden auf statt nach 47.
Mehr dazu
- Fehler von c0de net und Wie Anfragen gesendet werden
- Fehler im Pfad für Programmierer und Fehler in der Anleitung
- SLEEP
- Exit-Codes