Interceptors

Teil des Abschnitts TypeScript und NestJS der Node.js-Journey von Coddy. Lektion 23 von 24.

Du möchtest, dass jede Antwort angibt, wie lange sie gedauert hat, ohne jeden Handler einzeln anzupassen. Ein Interceptor umschließt den Handler: Code vor next.handle() wird davor ausgeführt, und Code für das, was next.handle() zurückgibt, wird danach ausgeführt.

intercept(context: ExecutionContext, next: CallHandler) {
    console.log('before');
    return next.handle().pipe(
        tap(() => console.log('after')),
    );
}

next.handle() liefert das Ergebnis des Handlers als RxJS-Observable, also einen Wert, der später eintrifft. .pipe(tap(...)) führt eine Funktion aus, wenn der Wert eintrifft, bevor Nest ihn sendet; dieses pipe hat nichts mit Nests Validierungs-Pipes zu tun. Guards werden vor jedem Interceptor ausgeführt, daher erreicht eine Anfrage, die ein Guard ablehnt, ihn nie. Gib das Observable mit der Pipe zurück: Nest sendet, was es enthält. context.switchToHttp().getResponse() liefert res, dessen setHeader einen Header hinzufügt.

app.useGlobalInterceptors(...) wendet einen Interceptor auf jede Route an; @UseInterceptors(...) auf einen einzelnen Controller.

Aufgabe

Einfach

„Run“ startet deinen Tracker mit src/main.ts erneut. Die separaten Übungsdateien können im Verzeichnisbaum bleiben; dieser Server startet sie nicht.

Clients und deine eigene Überwachung möchten wissen, wie lange jede Anfrage gedauert hat. Füge jeder erfolgreichen Antwort den Antwort-Header X-Response-Time hinzu, ohne eine Route anzufassen.

Öffne src/common/response-time.interceptor.ts. Notiere in der Methode intercept von ResponseTimeInterceptor zuerst die aktuelle Zeit mit Date.now(). Code am Anfang von intercept wird vor der Routenmethode ausgeführt.
Hole dir Express’ res mit context.switchToHttp().getResponse().
next.handle() führt die Routenmethode aus und liefert ihr Ergebnis als RxJS-Observable zurück: einen Wert, der später eintrifft. Gib es weiterhin zurück, aber leite es mithilfe der Observable-Methode .pipe() durch tap, das bereits aus rxjs importiert wurde. Die Funktion, die du tap übergibst, wird ausgeführt, wenn das Ergebnis eintrifft, bevor Nest es sendet. Rufe in dieser Funktion res.setHeader auf, um X-Response-Time auf die Millisekunden seit der notierten Zeit zu setzen, gefolgt von ms, zum Beispiel 3ms. (RxJS’ .pipe() hat nichts mit den Validierungs-Pipes aus Kapitel 3 zu tun. Damit wird dem Observable ein Schritt hinzugefügt.)
Registriere in src/main.ts den Interceptor für die gesamte App mit app.useGlobalInterceptors(...), indem du eine neue Instanz von ResponseTimeInterceptor übergibst, neben der Pipe und dem Filter.
Die Antwortinhalte dürfen sich nicht ändern. GET /tasks gibt weiterhin { "items": [...], "page": 1, "total": 3, "pages": 2 } zurück.

Probiere es aus: Sende GET /tasks und öffne den Tab „Headers“ der Antwort. Dort siehst du X-Response-Time mit einem Wert wie 0ms oder 2ms. Auch GET /stats enthält diesen Header, ebenso ein POST mit { "title": "Buy milk" }, der mit dem Header x-api-key: tasks-key-123 gesendet wird. Sende diesen POST dann ohne den Schlüssel: 403 und kein X-Response-Time. Nest führt Guards vor Interceptors aus, daher hat der Guard die Anfrage abgelehnt, bevor dein Interceptor gestartet wurde. Auch ein innerhalb einer Route ausgelöster Fehler verhindert den Header, denn tap wird nur ausgeführt, wenn ein Ergebnis eintrifft.

Probier es selbst

import { CallHandler, ExecutionContext, Injectable, NestInterceptor } from '@nestjs/common';
import { Observable, tap } from 'rxjs';

@Injectable()
export class ResponseTimeInterceptor implements NestInterceptor {
    intercept(context: ExecutionContext, next: CallHandler): Observable<unknown> {
        // Erfasse die Zeit, lasse den Handler laufen und setze dann X-Response-Time.
        return next.handle();
    }
}