Zum Inhalt springen
Deutsch

Request-Timeout

requestTimeout(deadlineMs) lässt den Handler gegen eine Frist antreten und liefert 503, wenn die Frist gewinnt.

import { requestTimeout, withMiddleware } from 'actor-ts/http';
const routes = withMiddleware(requestTimeout(5000), appRoutes);

Übergib Optionen für eine eigene Response:

import { completeJson, requestTimeout, Status, TimeoutOptions, withMiddleware } from 'actor-ts/http';
const timeoutOptions = TimeoutOptions.create()
.withDeadlineMs(5000)
.withOnTimeout((request) => completeJson(Status.ServiceUnavailable, { error: 'slow', path: request.path }));
const routes = withMiddleware(requestTimeout(timeoutOptions), appRoutes);
Builder-MethodeFeldDefaultConfig
withDeadlineMs(deadlineMs)deadlineMs30000deadline
withOnTimeout(onTimeout)onTimeout503 { error: 'request timed out' }nur im Code — eine Funktion

Die Frist lässt sich auch über actor-ts.http.request-timeout setzen. Was requestTimeout(...) im Code nennt, gewinnt, dann der Block, dann die eingebauten 30 s — requestTimeout() ohne Argument nimmt seine Frist also aus der Konfigurationsdatei:

actor-ts.http.request-timeout {
deadline = 10s
}

Die gemergte Frist wird einmal validiert, wenn bind() den Route-Baum kompiliert: Eine, die nicht positiv ist oder länger, als ein Timer halten kann (2147483647 ms, etwa 24,9 Tage), lässt bind() mit einem OptionsError scheitern, statt jeden Request sofort mit 503 zu beantworten.

Das ist ein anderer Key als actor-ts.http.server.request-timeout, der begrenzt, wie lange ein Peer zum Senden eines Requests braucht, und nie eine Response. Diese Frist beginnt, sobald der Request angekommen ist, und begrenzt den Handler. Siehe Konfiguration → actor-ts.http.

Auf dem Hono-Backend unter Bun setzt die Frist außerdem den Idle-Default des Servers. Bun.serve schließt eine Verbindung, deren Handler während seines Idle-Timeouts nichts geschrieben hat, was einen langsamen Handler abschneiden würde, bevor seine 503 gesendet ist; solange actor-ts.http.server.idle-timeout ungesetzt ist, folgt der Idle-Timeout deshalb der längsten Frist auf dem Server — der dieses Blocks, angehoben auf das längste requestTimeout(...) im Routenbaum — mit Luft dafür, dass die 503 zuerst rausgeht: 36 s bei den eingebauten 30 s. Über etwa 250 s geht das nicht: Bun.serve hält höchstens 255 s, der Idle-Timeout bleibt dort stehen, ein Handler, der so lange schweigt, wird weiterhin ohne Antwort abgeschnitten, und bind() schreibt eine Warnung mit dem Key und der Frist ins Log. Eine Route, die länger braucht, muss vorher etwas schreiben oder auf einem anderen Backend laufen: idle-timeout selbst zu setzen wählt die Schranke, höchstens 255s, hebt sie aber nicht darüber hinaus.

Lass idle-timeout auf diesem Backend unter Bun positiv. 0 schaltet ihn ab, und er ist dort die einzige Schranke für einen Request, dessen Body nicht mehr weiterkommt, und für eine Verbindung, die zwischen zwei Requests untätig ist — header-timeout, request-timeout und max-connections lassen sich auf diesem Paar nicht installieren —, mit 0 bleibt eine solche Verbindung also offen, bis der Client sie schließt. Gemessen auf bun 1.4.2: ein Body, der mit 10 Bytes angekündigt war und nach 1 Byte stehen blieb, war unter 0 nach 40 s noch offen und wurde bei ungesetztem Key nach 36 s geschlossen.

Der Block erreicht requestTimeout() über einen Hook, den compile() auflöst — gib die Middleware also so, wie sie ist, an withMiddleware(...). In eine eigene Funktion verpackt läuft sie mit ihren Code-Optionen und dem eingebauten Default, und wenn der Block konfiguriert ist und nichts im Baum ihn gelesen hat, schreibt bind() eine Warnung mit dem Block ins Log.