@nodefony/http 10.0.0-beta.4 → 10.0.0-beta.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -0
- package/dist/_virtual/{_@oxc-project_runtime@0.155.0 → _@oxc-project_runtime@0.157.0}/helpers/esm/decorate.js +1 -1
- package/dist/_virtual/{_@oxc-project_runtime@0.155.0 → _@oxc-project_runtime@0.157.0}/helpers/esm/decorateParam.js +1 -1
- package/dist/index.js +29 -25
- package/dist/nodefony/command/proxyGenerateCommand.js +2 -2
- package/dist/nodefony/config/config.js +6 -3
- package/dist/nodefony/interfaces/IRequestTrace.js +1 -0
- package/dist/nodefony/service/ProfilerAdminApi.js +17 -3
- package/dist/nodefony/service/audit-logger.js +3 -17
- package/dist/nodefony/service/error-renderer.js +6 -4
- package/dist/nodefony/service/http-kernel.js +191 -40
- package/dist/nodefony/service/pretty-request-logger.js +11 -10
- package/dist/nodefony/service/request-logger.js +1 -1
- package/dist/nodefony/service/reverse-proxy.js +7 -2
- package/dist/nodefony/service/servers/clientError.js +28 -4
- package/dist/nodefony/service/servers/server-h2c.js +5 -5
- package/dist/nodefony/service/servers/server-http.js +5 -3
- package/dist/nodefony/service/servers/server-https.js +12 -5
- package/dist/nodefony/service/servers/server-static.js +1 -6
- package/dist/nodefony/service/servers/server-websocket-secure.js +6 -10
- package/dist/nodefony/service/servers/server-websocket.js +6 -10
- package/dist/nodefony/service/servers/serverShutdown.js +63 -4
- package/dist/nodefony/service/sessions/sessions-service.js +3 -3
- package/dist/nodefony/service/upload/upload-service.js +2 -2
- package/dist/nodefony/src/assets/prebuiltUi.js +23 -5
- package/dist/nodefony/src/context/Context.js +56 -13
- package/dist/nodefony/src/context/http/ByteStream.js +359 -0
- package/dist/nodefony/src/context/http/HttpContext.js +75 -25
- package/dist/nodefony/src/context/http/Request.js +15 -6
- package/dist/nodefony/src/context/http/Response.js +354 -35
- package/dist/nodefony/src/context/http/SseStream.js +81 -146
- package/dist/nodefony/src/context/http/StreamLifecycle.js +273 -0
- package/dist/nodefony/src/context/http/urlFastPath.js +80 -1
- package/dist/nodefony/src/context/http2/Request.js +1 -1
- package/dist/nodefony/src/context/http2/Response.js +28 -5
- package/dist/nodefony/src/context/requestTrace.js +104 -0
- package/dist/nodefony/src/context/timingMode.js +21 -0
- package/dist/nodefony/src/context/transport.js +20 -1
- package/dist/nodefony/src/context/unsentResponse.js +30 -0
- package/dist/nodefony/src/context/websocket/Response.js +4 -2
- package/dist/nodefony/src/context/websocket/WebsocketContext.js +81 -20
- package/dist/nodefony/src/context/websocket/websocketUrl.js +7 -0
- package/dist/nodefony/src/context/websocket/wsBackpressure.js +15 -15
- package/dist/nodefony/src/context/websocket/wsFrameRate.js +71 -0
- package/dist/nodefony/src/context/websocket/wsLogContent.js +55 -17
- package/dist/nodefony/src/cookies/cookie.js +54 -13
- package/dist/nodefony/src/profiler/FrameProfile.js +22 -0
- package/dist/nodefony/src/profiler/Profiler.js +25 -22
- package/dist/nodefony/src/profiler/aggregate.js +26 -6
- package/dist/nodefony/src/proxy/forward.js +109 -9
- package/dist/nodefony/src/proxy/generateProxyConfig.js +6 -2
- package/dist/nodefony/src/proxy/rules.js +29 -14
- package/dist/nodefony/src/servers/upgradeDispatch.js +62 -4
- package/dist/types/index.d.ts +8 -0
- package/dist/types/nodefony/config/config.d.ts +8 -0
- package/dist/types/nodefony/interfaces/IContext.d.ts +9 -0
- package/dist/types/nodefony/interfaces/IRequestTrace.d.ts +56 -0
- package/dist/types/nodefony/interfaces/IReverseProxy.d.ts +8 -0
- package/dist/types/nodefony/interfaces/IRouting.d.ts +16 -0
- package/dist/types/nodefony/interfaces/ISecurity.d.ts +27 -2
- package/dist/types/nodefony/interfaces/index.d.ts +1 -0
- package/dist/types/nodefony/service/ProfilerAdminApi.d.ts +5 -1
- package/dist/types/nodefony/service/audit-logger.d.ts +3 -11
- package/dist/types/nodefony/service/error-renderer.d.ts +5 -4
- package/dist/types/nodefony/service/http-kernel.d.ts +65 -2
- package/dist/types/nodefony/service/servers/clientError.d.ts +3 -2
- package/dist/types/nodefony/service/servers/serverShutdown.d.ts +5 -3
- package/dist/types/nodefony/src/assets/prebuiltUi.d.ts +9 -4
- package/dist/types/nodefony/src/context/Context.d.ts +25 -1
- package/dist/types/nodefony/src/context/http/ByteStream.d.ts +109 -0
- package/dist/types/nodefony/src/context/http/HttpContext.d.ts +60 -4
- package/dist/types/nodefony/src/context/http/Request.d.ts +8 -1
- package/dist/types/nodefony/src/context/http/Response.d.ts +134 -8
- package/dist/types/nodefony/src/context/http/SseStream.d.ts +32 -7
- package/dist/types/nodefony/src/context/http/StreamLifecycle.d.ts +53 -0
- package/dist/types/nodefony/src/context/http/urlFastPath.d.ts +40 -0
- package/dist/types/nodefony/src/context/http2/Response.d.ts +17 -3
- package/dist/types/nodefony/src/context/requestTrace.d.ts +64 -0
- package/dist/types/nodefony/src/context/timingMode.d.ts +23 -0
- package/dist/types/nodefony/src/context/transport.d.ts +17 -0
- package/dist/types/nodefony/src/context/unsentResponse.d.ts +16 -0
- package/dist/types/nodefony/src/context/websocket/WebsocketContext.d.ts +41 -1
- package/dist/types/nodefony/src/context/websocket/websocketUrl.d.ts +4 -0
- package/dist/types/nodefony/src/context/websocket/wsBackpressure.d.ts +12 -2
- package/dist/types/nodefony/src/context/websocket/wsFrameRate.d.ts +69 -0
- package/dist/types/nodefony/src/context/websocket/wsLogContent.d.ts +16 -8
- package/dist/types/nodefony/src/cookies/cookie.d.ts +20 -2
- package/dist/types/nodefony/src/profiler/FrameProfile.d.ts +15 -0
- package/dist/types/nodefony/src/profiler/Profiler.d.ts +27 -102
- package/dist/types/nodefony/src/profiler/aggregate.d.ts +23 -106
- package/dist/types/nodefony/src/proxy/forward.d.ts +30 -2
- package/dist/types/nodefony/src/proxy/rules.d.ts +20 -0
- package/dist/types/nodefony/src/servers/upgradeDispatch.d.ts +41 -1
- package/docs/byte-stream.md +371 -0
- package/docs/cookies.md +13 -3
- package/docs/diagnostics-channel.md +303 -0
- package/docs/index.md +14 -1
- package/docs/observabilite.md +94 -16
- package/docs/reverse-proxy.md +33 -19
- package/docs/servers.md +26 -15
- package/docs/session.md +3 -3
- package/docs/sse.md +27 -20
- package/package.json +16 -16
|
@@ -0,0 +1,371 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Flux d'octets — servir la sortie d'un processus, un relais ou une archive à la volée"
|
|
3
|
+
navTitle: Flux d'octets
|
|
4
|
+
lang: fr
|
|
5
|
+
module: "@nodefony/http"
|
|
6
|
+
topic: byte-stream
|
|
7
|
+
section: "Cœur runtime"
|
|
8
|
+
audience: [developer]
|
|
9
|
+
tags:
|
|
10
|
+
[
|
|
11
|
+
streaming,
|
|
12
|
+
flux,
|
|
13
|
+
renderstream,
|
|
14
|
+
openstream,
|
|
15
|
+
ffmpeg,
|
|
16
|
+
relais,
|
|
17
|
+
fetch,
|
|
18
|
+
http2,
|
|
19
|
+
contre-pression,
|
|
20
|
+
]
|
|
21
|
+
version: "doc"
|
|
22
|
+
status: stable
|
|
23
|
+
updated: 2026-11-06
|
|
24
|
+
source: "src/packages/@nodefony/http/docs/byte-stream.md"
|
|
25
|
+
coverageModule: http
|
|
26
|
+
coverageFiles: context/http/ByteStream.ts,context/http/StreamLifecycle.ts
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
📍 [Documentation](../../../../../docs/index.md) › [@nodefony/http](index.md) › **Flux d'octets**
|
|
30
|
+
|
|
31
|
+
# Flux d'octets — servir la sortie d'un processus, un relais ou une archive à la volée
|
|
32
|
+
|
|
33
|
+
> Un **robinet** plutôt qu'une **bouteille** : la réponse ne se prépare pas en entier avant de
|
|
34
|
+
> partir, elle coule pendant que la source produit. La vidéo ré-emballée par ffmpeg, le corps d'un
|
|
35
|
+
> `fetch()` relayé depuis une caméra, une archive construite à la volée : toute source d'octets qui
|
|
36
|
+
> n'est pas un fichier du disque. Un `<video src>`, un `fetch()`, un téléchargement ou `curl` la
|
|
37
|
+
> lisent comme n'importe quelle réponse HTTP. Le même code sert HTTP/1.1, HTTP/2 chiffré et h2c.
|
|
38
|
+
> Chaque fait ci-dessous est ancré sur le code.
|
|
39
|
+
|
|
40
|
+
## 🧠 Le modèle mental — la réponse est PRISE à l'appel, les en-têtes partent au premier octet
|
|
41
|
+
|
|
42
|
+
`this.renderStream(source)` dit au framework : « cette requête, c'est moi qui la sers, avec ce flux ».
|
|
43
|
+
Dès l'appel, plus rien ne peut répondre à sa place. Mais les **en-têtes ne partent qu'au premier
|
|
44
|
+
morceau** de la source : tant que rien n'est sorti, une erreur de la source peut encore devenir une
|
|
45
|
+
vraie page d'erreur (500, 502…), visible dans le journal d'accès — et non une réponse 200 tronquée.
|
|
46
|
+
|
|
47
|
+
Le flux se termine pour l'une de cinq raisons, et la **source est toujours détruite** à la fin,
|
|
48
|
+
quelle que soit la raison. C'est ce qui libère un processus fils bloqué en écriture : un simple
|
|
49
|
+
`unpipe` le laisserait en pause, et ffmpeg ainsi bloqué ignore même `SIGTERM`.
|
|
50
|
+
|
|
51
|
+
## 📖 Lexique
|
|
52
|
+
|
|
53
|
+
- **Source** — ce qui produit les octets : un `Readable` Node (la sortie d'un processus, une archive)
|
|
54
|
+
ou un `ReadableStream` web (le `body` d'un `fetch()`).
|
|
55
|
+
- **Contre-pression** — quand le client lit moins vite que la source produit, la source est mise en
|
|
56
|
+
pause jusqu'à ce que le client rattrape : la mémoire du serveur reste bornée.
|
|
57
|
+
- **Source muette** — une source qui ne produit plus rien (processus figé, amont qui ne répond plus).
|
|
58
|
+
- **Coupure** — la fin d'une réponse sans fin propre : le client SAIT que le corps est tronqué
|
|
59
|
+
(socket fermée en HTTP/1.1, `RST_STREAM` en HTTP/2).
|
|
60
|
+
|
|
61
|
+
## Quand un flux d'octets, quand autre chose ?
|
|
62
|
+
|
|
63
|
+
| Besoin | Choisir |
|
|
64
|
+
| ----------------------------------------------------------- | ----------------------------------------------------------- |
|
|
65
|
+
| Un fichier du disque, avec reprise (`Range`) | `this.renderMediaStream()` / `this.renderFileDownload()` |
|
|
66
|
+
| La sortie d'un processus, un relais, une archive construite | **`this.renderStream()`** — cette page |
|
|
67
|
+
| Des événements texte lus par `EventSource` | [`this.renderSse()`](sse.md) |
|
|
68
|
+
| UNE source diffusée à N lecteurs (un producteur par pod) | un canal temps réel (`@nodefony/realtime`), pas une réponse |
|
|
69
|
+
|
|
70
|
+
`renderStream` sert **une réponse par consommateur** : dix spectateurs, dix flux, dix producteurs.
|
|
71
|
+
|
|
72
|
+
## 🚀 Démarrage rapide
|
|
73
|
+
|
|
74
|
+
Dans une application générée par `nodefony create app`, une action sert la sortie d'un processus.
|
|
75
|
+
|
|
76
|
+
### 1. L'action
|
|
77
|
+
|
|
78
|
+
```ts
|
|
79
|
+
// modules/app/nodefony/controller/ExportController.ts
|
|
80
|
+
import { spawn } from "node:child_process";
|
|
81
|
+
import { Controller, controller, route } from "@nodefony/framework";
|
|
82
|
+
import type { Context } from "@nodefony/http";
|
|
83
|
+
|
|
84
|
+
@controller("/export")
|
|
85
|
+
class ExportController extends Controller {
|
|
86
|
+
constructor(context: Context) {
|
|
87
|
+
super("ExportController", context);
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
@route("export-logs", { path: "/logs" })
|
|
91
|
+
async logs() {
|
|
92
|
+
const tar = spawn("tar", ["-cz", "-C", "var", "logs"], {
|
|
93
|
+
stdio: ["ignore", "pipe", "ignore"],
|
|
94
|
+
windowsHide: true,
|
|
95
|
+
});
|
|
96
|
+
try {
|
|
97
|
+
const { reason, bytes } = await this.renderStream(tar.stdout, {
|
|
98
|
+
headers: {
|
|
99
|
+
"content-type": "application/gzip",
|
|
100
|
+
"content-disposition": 'attachment; filename="logs.tar.gz"',
|
|
101
|
+
},
|
|
102
|
+
});
|
|
103
|
+
this.log(`export terminé : ${reason}, ${bytes} octets`, "INFO");
|
|
104
|
+
} finally {
|
|
105
|
+
tar.kill("SIGKILL"); // le flux est fini, quelle qu'en soit la raison
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
export default ExportController;
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### 2. Observer
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
curl -sS -o logs.tar.gz -D - http://127.0.0.1:5151/export/logs
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
```text
|
|
120
|
+
HTTP/1.1 200 OK
|
|
121
|
+
content-type: application/gzip
|
|
122
|
+
cache-control: no-cache, no-transform
|
|
123
|
+
x-accel-buffering: no
|
|
124
|
+
transfer-encoding: chunked
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
- Aucun `Content-Length` n'est connu : HTTP/1.1 envoie par morceaux, HTTP/2 n'annonce rien.
|
|
128
|
+
- `Cache-Control: no-cache, no-transform` et `X-Accel-Buffering: no` sont posés **s'ils manquent** —
|
|
129
|
+
ni dans `headers`, ni déjà sur la réponse : un proxy inverse ne met pas le flux en tampon, et ne le
|
|
130
|
+
recompresse pas. Pour une source FINIE et rejouable (fichier, archive), `live: false` les retire.
|
|
131
|
+
- Couper `curl` en route : la promesse rend `reason: "client"`, la source est détruite, `tar` reçoit
|
|
132
|
+
`EPIPE` et s'arrête.
|
|
133
|
+
|
|
134
|
+
## ⚙️ L'API
|
|
135
|
+
|
|
136
|
+
### `this.renderStream(source, options?)` — et `context.openStream()`
|
|
137
|
+
|
|
138
|
+
`Controller.renderStream()` (`Controller.ts#Controller.renderStream`) n'est que l'habillage de
|
|
139
|
+
`HttpContext.openStream()` (`HttpContext.ts#HttpContext.openStream`), comme `renderSse` l'est de
|
|
140
|
+
`openSse`. Un middleware ou un relais qui n'a pas de contrôleur appelle `context.openStream()`
|
|
141
|
+
directement — la requête est alors répondue : ne pas appeler la suite.
|
|
142
|
+
|
|
143
|
+
| Paramètre | Type | Rôle |
|
|
144
|
+
| --------- | ------------------------------------------ | ---------------------------------------------------------------- |
|
|
145
|
+
| `source` | `Readable` ou `ReadableStream<Uint8Array>` | ce qui produit les octets ; jamais en mode objet (`TypeError`) |
|
|
146
|
+
| `options` | `IByteStreamOptions` | statut, en-têtes, délais, écouteur de fin (tableau suivant) |
|
|
147
|
+
| rend | `Promise<IByteStreamResult>` | `{ reason, bytes }` à la fin — la promesse ne rejette **jamais** |
|
|
148
|
+
|
|
149
|
+
**La source appartient au flux dès l'appel.** Un appel qui LÈVE — réponse déjà prise (500), plafond
|
|
150
|
+
par IP atteint (429), option hors bornes (`RangeError`), source en mode objet (`TypeError`) —
|
|
151
|
+
détruit la source avant de lever (un flux web est annulé) : un relais `fetch` refusé ne garde pas sa
|
|
152
|
+
connexion amont, un producteur enfant ne reste pas bloqué en écriture.
|
|
153
|
+
|
|
154
|
+
| Option | Rôle | Défaut |
|
|
155
|
+
| -------------- | --------------------------------------------------------------------------------------------------------- | ---------------------------------------- |
|
|
156
|
+
| `status` | statut de la réponse, 200 à 599 | 200 |
|
|
157
|
+
| `headers` | en-têtes, écrits au premier morceau ; `Content-Length` repris s'il est fourni, et TENU (ci-dessous) | `Content-Type: application/octet-stream` |
|
|
158
|
+
| `live` | flux vivant : `no-cache` et `X-Accel-Buffering: no` par défaut ; `false` pour un fichier, une archive | `true` |
|
|
159
|
+
| `idleTimeout` | délai maximal sans un octet de la source, ms ; `0` le désarme ; coupure entre 1 et 1,25 × ce délai | délai de réponse du serveur (30 s) |
|
|
160
|
+
| `stallTimeout` | délai maximal d'une écriture bloquée (le client ne lit plus), ms ; `false` l'éteint | 30 000 |
|
|
161
|
+
| `maxDuration` | durée de vie du flux, ms ; il est fermé ensuite | `false` — pas de borne |
|
|
162
|
+
| `onClose` | `(reason) => void`, appelé une fois, AVANT la fin de la requête et la résolution ; lié à la requête (ALS) | aucun |
|
|
163
|
+
|
|
164
|
+
**`Content-Length` est tenu.** Annoncé — dans `headers` ou déjà posé sur la réponse —, le corps
|
|
165
|
+
fait exactement cette longueur (RFC 9112 §6.3 ; en HTTP/2, RFC 9113 §8.1.1 : sinon la réponse est
|
|
166
|
+
malformée). Contredit dès le premier morceau : rien n'est parti, page d'erreur 500. Après : coupure,
|
|
167
|
+
jamais une fin propre — un client HTTP/1.1 attendrait sinon l'octet manquant, ou lirait l'excédent
|
|
168
|
+
comme le début de la réponse suivante. `HEAD` excepté : la longueur annoncée y est celle du GET.
|
|
169
|
+
|
|
170
|
+
Les raisons de fin (`ByteStreamEndReason`, `ByteStream.ts#ByteStreamEndReason`) :
|
|
171
|
+
|
|
172
|
+
| `reason` | Ce qui s'est passé | Ce que voit le client |
|
|
173
|
+
| --------- | ------------------------------------------------------------------------------ | ------------------------- |
|
|
174
|
+
| `end` | la source est finie, ou le serveur a fermé le flux (`maxDuration`, révocation) | une fin propre |
|
|
175
|
+
| `client` | le client est parti | — |
|
|
176
|
+
| `error` | la source a échoué | page d'erreur, ou coupure |
|
|
177
|
+
| `timeout` | la source est restée muette plus de `idleTimeout` | 504, ou coupure |
|
|
178
|
+
| `stall` | le client ne lisait plus depuis `stallTimeout` | connexion coupée |
|
|
179
|
+
|
|
180
|
+
L'union **peut s'agrandir** : un `switch` exhaustif sur `reason` garde une branche `default`.
|
|
181
|
+
|
|
182
|
+
### Relayer un autre service
|
|
183
|
+
|
|
184
|
+
```ts
|
|
185
|
+
@route("camera-live", { path: "/camera" })
|
|
186
|
+
async camera() {
|
|
187
|
+
const r = await fetch("http://camera.local/stream", { signal: this.context.signal });
|
|
188
|
+
if (!r.ok || r.body === null) throw new HttpError("Caméra injoignable", 502);
|
|
189
|
+
return this.renderStream(r.body, {
|
|
190
|
+
headers: { "content-type": r.headers.get("content-type") ?? "application/octet-stream" },
|
|
191
|
+
});
|
|
192
|
+
}
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
- Le **signal** est lu AVANT l'appel : au départ du client, le flux l'interrompt, et `fetch` ferme
|
|
196
|
+
la connexion amont (`Context._abortIfPending()`, appelé par la fin du flux).
|
|
197
|
+
- Ne recopier que `content-type` : `fetch` a déjà décompressé le corps, donc `content-encoding` et
|
|
198
|
+
`content-length` de l'amont seraient faux.
|
|
199
|
+
- Une erreur levée **avant** l'appel (le `throw` ci-dessus) appartient à l'action : chemin d'erreur
|
|
200
|
+
ordinaire.
|
|
201
|
+
|
|
202
|
+
### `Readable.from()` — passer `{ objectMode: false }`
|
|
203
|
+
|
|
204
|
+
`Readable.from([...])` crée un flux en **mode objet** par défaut, qui ne porte pas d'octets :
|
|
205
|
+
`renderStream` le refuse par un `TypeError` qui donne le correctif.
|
|
206
|
+
|
|
207
|
+
```ts
|
|
208
|
+
return this.renderStream(Readable.from([header, body], { objectMode: false }));
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
### Même source, deux sorties — HTTP et ligne de commande
|
|
212
|
+
|
|
213
|
+
`renderStream` exige une **réponse HTTP vivante** : une commande CLI n'en a pas, et n'y a donc pas
|
|
214
|
+
accès. Ce que les deux partagent, c'est la **source**. On écrit le producteur une fois, puis la route
|
|
215
|
+
le sert par `renderStream` et la commande le verse sur sa sortie par `pipeline` de `node:stream`, qui
|
|
216
|
+
apporte la même contre-pression et détruit la source en cas d'erreur (un `| head` qui ferme tôt
|
|
217
|
+
compris).
|
|
218
|
+
|
|
219
|
+
```ts
|
|
220
|
+
// modules/app/nodefony/src/exportLogs.ts — le producteur, écrit une fois
|
|
221
|
+
import { spawn, type ChildProcessByStdio } from "node:child_process";
|
|
222
|
+
import type { Readable } from "node:stream";
|
|
223
|
+
|
|
224
|
+
export function exportLogs(): ChildProcessByStdio<null, Readable, null> {
|
|
225
|
+
return spawn("tar", ["-cz", "-C", "var", "logs"], {
|
|
226
|
+
stdio: ["ignore", "pipe", "ignore"],
|
|
227
|
+
windowsHide: true,
|
|
228
|
+
});
|
|
229
|
+
}
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
```ts
|
|
233
|
+
// la route — GET /export/logs
|
|
234
|
+
const tar = exportLogs();
|
|
235
|
+
try {
|
|
236
|
+
await this.renderStream(tar.stdout, {
|
|
237
|
+
headers: { "content-type": "application/gzip" },
|
|
238
|
+
});
|
|
239
|
+
} finally {
|
|
240
|
+
tar.kill("SIGKILL");
|
|
241
|
+
}
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
```ts
|
|
245
|
+
// la commande — nodefony app:export > logs.tar.gz
|
|
246
|
+
import { pipeline } from "node:stream/promises";
|
|
247
|
+
|
|
248
|
+
override async generate(): Promise<this> {
|
|
249
|
+
const tar = exportLogs();
|
|
250
|
+
try {
|
|
251
|
+
await pipeline(tar.stdout, process.stdout);
|
|
252
|
+
} finally {
|
|
253
|
+
tar.kill("SIGKILL");
|
|
254
|
+
}
|
|
255
|
+
return this;
|
|
256
|
+
}
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
Une commande de module s'accompagne d'un endpoint équivalent : c'est ce patron qui le rend gratuit.
|
|
260
|
+
Pour LIRE un flux d'octets, aucun client dédié n'est nécessaire — c'est une réponse HTTP
|
|
261
|
+
ordinaire : `curl -N`, `wget`, `fetch()` ou `| tar xz` le consomment tels quels.
|
|
262
|
+
|
|
263
|
+
## 🏗️ Architecture interne — ce que fait l'appel
|
|
264
|
+
|
|
265
|
+
Le flux d'octets repose sur la **brique de cycle de vie commune au SSE**
|
|
266
|
+
(`StreamLifecycle.ts#openStreamLifecycle`, non exportée) — une seule implémentation de la prise de
|
|
267
|
+
la réponse, de la session, de la fermeture et des gardes, jouée par la même table de parité sur les
|
|
268
|
+
deux types de flux.
|
|
269
|
+
|
|
270
|
+
1. **Les options sont contrôlées** et la source web convertie (`ByteStream.ts#fromWebStream`) — sa
|
|
271
|
+
destruction ANNULE le flux web, c'est elle qui ferme l'amont d'un `fetch`.
|
|
272
|
+
2. **La réponse est prise** (`context.sended`), le transport constaté, l'écoute de la fermeture posée
|
|
273
|
+
AVANT toute attente, la place du plafond par IP réservée, puis la session sauvée.
|
|
274
|
+
3. **Le délai d'inactivité de la requête est désarmé** : sous une réponse prise, il ne fermait rien et
|
|
275
|
+
faussait le statut journalisé. Le flux tient son propre chien de garde — UN minuteur périodique
|
|
276
|
+
`unref` par flux, qui passe tous les quarts de `idleTimeout` et compare le compteur d'octets.
|
|
277
|
+
Aucun minuteur ni appel d'horloge par morceau : la coupure tombe entre `idleTimeout` et
|
|
278
|
+
1,25 × `idleTimeout`.
|
|
279
|
+
4. **HEAD** : les en-têtes du GET, aucun corps, la source n'est jamais lue (toute route GET sert HEAD).
|
|
280
|
+
5. **Au premier morceau** : les en-têtes, puis le morceau. Sous contre-pression, la source est mise en
|
|
281
|
+
pause et le minuteur `stallTimeout` armé ; il est désarmé au `drain`.
|
|
282
|
+
6. **La fin passe par un seul nettoyage** (`ByteStream.ts#openByteStream`, puis
|
|
283
|
+
`StreamLifecycle.ts#StreamLifecycle.finish`) : source **détruite en premier**, écouteurs retirés,
|
|
284
|
+
minuteurs arrêtés, signal de la requête interrompu (sauf fin propre), `onClose(reason)`, fin de la
|
|
285
|
+
requête, puis résolution de la promesse.
|
|
286
|
+
|
|
287
|
+
**Une erreur de la source**, selon le moment :
|
|
288
|
+
|
|
289
|
+
| Moment | Traitement |
|
|
290
|
+
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
|
291
|
+
| avant l'appel | elle appartient à l'action : chemin d'erreur ordinaire |
|
|
292
|
+
| avant le premier octet (rien n'est parti) | la réponse est ROUVERTE et l'erreur confiée à `HttpKernel.onError` — même statut, même page qu'une action |
|
|
293
|
+
| après le premier octet | **coupure** : `destroy()` en HTTP/1.1, `RST_STREAM(INTERNAL_ERROR)` en HTTP/2 ; une entrée `ERROR` au journal |
|
|
294
|
+
|
|
295
|
+
**Le journal d'accès dit qui a coupé.** Après le premier octet, le statut parti sur le fil est 200 ;
|
|
296
|
+
le statut de la ligne d'accès, lui, est un fait INTERNE : **500** (ou le code d'une `HttpError`) quand
|
|
297
|
+
la source échoue, **504** quand elle se tait, **499** quand le client part. Sans lui, le noyau
|
|
298
|
+
journaliserait 499 (« client parti ») pour une coupure décidée par le serveur
|
|
299
|
+
(`HttpKernel.createHttpContext`).
|
|
300
|
+
|
|
301
|
+
En HTTP/2, la coupure passe par `stream.destroy(err)` et non `stream.close(INTERNAL_ERROR)` : ce
|
|
302
|
+
dernier ferme d'abord le côté écriture, et un client qui a déjà fermé le sien lit une **fin propre**
|
|
303
|
+
(mesuré : `rstCode` 0 au lieu de 2).
|
|
304
|
+
|
|
305
|
+
## 📈 Coût mesuré
|
|
306
|
+
|
|
307
|
+
Banc isolé (serveur Node seul, client `curl`, 256 Mo par passage, médiane de 21 passes alternées,
|
|
308
|
+
deux campagnes) : `renderStream` face au plancher `source.pipe(res)` écrit à la main.
|
|
309
|
+
|
|
310
|
+
| Morceaux | Débit | CPU du serveur |
|
|
311
|
+
| -------- | --------------- | --------------- |
|
|
312
|
+
| 64 Kio | −1,7 % / −2,0 % | +1,6 % / +1,1 % |
|
|
313
|
+
| 4 Kio | −2,4 % / −0,2 % | +2,5 % / +0,1 % |
|
|
314
|
+
|
|
315
|
+
Un fichier servi par `streamFile()` (`live: false`, longueur tenue) face à
|
|
316
|
+
`createReadStream().pipe(res)`, même banc : débit +1,4 %, CPU +2,3 % — dans le bruit, lui aussi.
|
|
317
|
+
|
|
318
|
+
Les écarts restent dans le bruit du banc. Deux choix les tiennent là : un écouteur `drain`
|
|
319
|
+
**permanent** (un `once` par épisode de contre-pression coûtait un enrobage par morceau, presque
|
|
320
|
+
chaque écriture de 64 Kio rendant `false` sur une socket rapide), et un minuteur de blocage
|
|
321
|
+
(`stallTimeout`) créé une fois puis réarmé au reste du délai, jamais un par épisode. La trace de
|
|
322
|
+
désoptimisation de V8 (`--trace-deopt`) ne cite pas `ByteStream`.
|
|
323
|
+
|
|
324
|
+
## 🔐 Sécurité
|
|
325
|
+
|
|
326
|
+
- **Les mêmes gardes qu'une socket WebSocket et qu'un flux SSE** : le flux compte dans
|
|
327
|
+
`wsMaxConnectionsPerIp` (un seul budget, **429** avant d'écrire quoi que ce soit — désactivé par
|
|
328
|
+
défaut), se coupe quand l'identité qui l'a ouvert est révoquée, et respecte `maxDuration`. Le
|
|
329
|
+
plafond est PAR POD, et dépend de `trustProxy` pour lire la vraie IP derrière un proxy.
|
|
330
|
+
- **En-tête refusé** (fin de ligne dans une valeur) : il ne part qu'au premier morceau, depuis la
|
|
331
|
+
source — l'échec rend une page 500 ordinaire, sans en-tête injecté, et ne peut pas abattre le
|
|
332
|
+
processus.
|
|
333
|
+
- **`Range` est ignoré** : la réponse est un 200, et `Accept-Ranges` n'est jamais posé (RFC 9110
|
|
334
|
+
§14.2) — un flux construit à la volée ne sait pas reprendre au milieu.
|
|
335
|
+
- Le flux passe par le pipeline complet : pare-feu, CSRF et `@IsGranted` s'appliquent avant l'action.
|
|
336
|
+
|
|
337
|
+
## ⚠️ Pièges (symptôme → cause → correction)
|
|
338
|
+
|
|
339
|
+
| Symptôme | Cause | Correction |
|
|
340
|
+
| ----------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
|
341
|
+
| `TypeError : une source en mode objet` | `Readable.from([...])` est en mode objet par défaut | `Readable.from(chunks, { objectMode: false })` |
|
|
342
|
+
| Un processus fils survit à un crash du processus Node | la destruction de la source n'a jamais eu lieu : le processus Node est mort avant | supervision de l'application (cgroup, `detached: false`, `kill` au signal) |
|
|
343
|
+
| Coupé au bout de 30 s alors que la source est lente | `idleTimeout` (défaut 30 s) : la source n'a rien produit pendant ce délai | relever `idleTimeout`, ou `0` pour une source légitimement silencieuse |
|
|
344
|
+
| Coupé derrière nginx au bout de 60 s | `proxy_read_timeout` (60 s) plus court que le silence de la source | garder `idleTimeout` SOUS ce délai, ou l'allonger sur le proxy |
|
|
345
|
+
| Le flux répond 429 sans avoir rien fait | `wsMaxConnectionsPerIp` atteint — sockets, flux SSE et flux d'octets comptent ensemble | relever le plafond, ou fermer les connexions laissées ouvertes |
|
|
346
|
+
| `content-encoding` faux sur un relais | en-têtes de l'amont recopiés, alors que `fetch` a décompressé | ne recopier que `content-type` |
|
|
347
|
+
|
|
348
|
+
## 🧪 Tests & couverture
|
|
349
|
+
|
|
350
|
+
| Type | Où |
|
|
351
|
+
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
352
|
+
| Parité du cycle de vie | `http/streamLifecycle.test.ts` — la MÊME table jouée sur le SSE et le flux d'octets : réponse prise, départ du client en HTTP/1.1, HTTP/2 et h2c, fin propre, session, double ouverture, client lent, durée de vie |
|
|
353
|
+
| Parité — unitaire | `unit/streamLifecycleParity.test.ts` — client parti PENDANT la sauvegarde de session : flux né fermé, source détruite |
|
|
354
|
+
| Intégration | `http/byteStream.test.ts` — HEAD (3 transports), coupure après le premier octet (3 transports), 500 / 502 avant, source muette 504 et coupure, `idleTimeout: 0`, source déjà finie, en-tête refusé, producteur bloqué libéré, relais `fetch` ; anneau du journal relu (une seule `ERROR`, aucun « onError on closed context », statut de la ligne d'accès) ; session sauvée deux fois, écrite une fois |
|
|
355
|
+
| Délais réels | même fichier, derrière `NF_RUN_LONG_STREAM=1` (~80 s) — défaut d'`idleTimeout` (coupure entre 30 et 37,5 s, 504 au journal) et `idleTimeout: 0` tenu 40 s, au-delà du délai de socket du serveur |
|
|
356
|
+
| Gardes | `http/sse-guards.attack.test.ts` — plafond par IP (429, place rendue, source refusée détruite), anonyme refusé (401) et révocation, joués sur le SSE ET le flux d'octets |
|
|
357
|
+
| Refus — unitaire | `unit/byteStreamRefusal.test.ts` — un appel qui lève (500, 429, `RangeError`, `TypeError`) détruit la source, annule un flux web |
|
|
358
|
+
| Mémoire | `http/memory.test.ts` — flux finis par leur source et flux abandonnés par le client : pente du tas, scopes et contextes résiduels |
|
|
359
|
+
|
|
360
|
+
Le cas du **producteur bloqué** lance un enfant `node -e` qui écrit sans fin par `fs.writeSync(1, …)`
|
|
361
|
+
— une écriture bloquante, comme ffmpeg — et vérifie qu'il sort en moins de 5 s après le départ du
|
|
362
|
+
client, **sans aucun `kill`** : seule la destruction de sa sortie le libère.
|
|
363
|
+
|
|
364
|
+
L'avertissement « réponse non envoyée » ne peut pas tomber après un `renderStream` : l'action rend
|
|
365
|
+
la promesse du résultat, un objet. Le banc qui relit le journal le garde comme filet, sans pouvoir le
|
|
366
|
+
faire rougir sur ce chemin.
|
|
367
|
+
|
|
368
|
+
## 🔗 Pour aller plus loin
|
|
369
|
+
|
|
370
|
+
- ⬆️ **Retour au hub** : [@nodefony/http — vue du module](index.md) · [Toute la documentation](../../../../../docs/index.md)
|
|
371
|
+
- 🧭 **Pages sœurs** : [Flux SSE](sse.md) — événements texte, même cycle de vie ; [Serveurs](servers.md) — HTTP/2, TLS, délais ; [Proxy inverse](reverse-proxy.md).
|
package/docs/cookies.md
CHANGED
|
@@ -242,7 +242,13 @@ constructeur de `Cookie` (`cookie.ts#Cookie.options`).
|
|
|
242
242
|
### Sérialiser : `serialize()` et `serializeWebSocket()`
|
|
243
243
|
|
|
244
244
|
- `serialize()` (`cookie.ts#Cookie.serialize`) produit la **ligne `Set-Cookie`** complète (attributs dans l'ordre,
|
|
245
|
-
préfixes forcés
|
|
245
|
+
préfixes forcés). `Max-Age` est en **secondes entières**, arrondi vers le bas, et absent sous une
|
|
246
|
+
seconde (`cookie.ts#Cookie.getMaxAge`) : la grammaire de la RFC 6265 (§4.1.1) n'admet ni décimale
|
|
247
|
+
ni zéro, et un navigateur ignore un `Max-Age=3599.874` — le cookie deviendrait un cookie de session.
|
|
248
|
+
- Le **nom**, le `Path` et le `Domain` sont vérifiés à la **pose** (`addCookie()`), par la grammaire
|
|
249
|
+
de la bibliothèque `cookie` (`cookie.ts#Cookie.assertGrammar`) : un nom porteur de `;` ou un
|
|
250
|
+
`Path` comme `/; Domain=evil.example`, qui injecterait un attribut, lève une `TypeError` à l'appel
|
|
251
|
+
plutôt qu'un en-tête faux au `writeHead`.
|
|
246
252
|
- `serializeWebSocket()` (`cookie.ts#Cookie.serializeWebSocket`) produit un **objet** `IWsCookie` (mêmes invariants de sécurité)
|
|
247
253
|
— utilisé quand un cookie doit être décrit hors en-tête HTTP.
|
|
248
254
|
- `toString()` (`cookie.ts#Cookie.toString`) ne rend que `nom=valeurEncodée` (sans attributs).
|
|
@@ -270,11 +276,15 @@ boucle de `setHeader` (qui écraserait tout sauf le dernier). Pour expirer un co
|
|
|
270
276
|
|
|
271
277
|
### Parsing des cookies entrants
|
|
272
278
|
|
|
273
|
-
`cookiesParser(context)` (`cookie.ts#cookiesParser`) lit l'en-tête `Cookie:` (via la bibliothèque `cookie
|
|
274
|
-
|
|
279
|
+
`cookiesParser(context)` (`cookie.ts#cookiesParser`) lit l'en-tête `Cookie:` (via la bibliothèque `cookie`),
|
|
280
|
+
crée un `Cookie` par entrée et l'ajoute au contexte avec `addRequestCookie()`
|
|
275
281
|
(`Context.ts#Context.addRequestCookie`). Il est déclenché automatiquement par le pipeline : `parseCookies()` est appelé à
|
|
276
282
|
l'initialisation du contexte HTTP (`HttpContext.ts#HttpContext.constructor`) **et** WebSocket (`WebsocketContext.ts#WebsocketContext.constructor`).
|
|
277
283
|
|
|
284
|
+
C'est le **seul lecteur** de l'en-tête `Cookie` : le pare-feu lui-même lit le jeton CSRF sur le contexte.
|
|
285
|
+
Chaque valeur est décodée **une fois**, et une séquence `%` invalide est gardée telle quelle au lieu de
|
|
286
|
+
lever (`a=50%25` donne `50%`). Un nom présent deux fois : la **première** occurrence gagne.
|
|
287
|
+
|
|
278
288
|
### Côté WebSocket — lecture oui, écriture non
|
|
279
289
|
|
|
280
290
|
Les cookies **entrants** sont lus au handshake, exactement comme en HTTP (même parseur). Mais la **poignée
|