@nodefony/framework 10.0.0-beta.5 → 10.0.0-beta.7
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/dist/_virtual/{_@oxc-project_runtime@0.155.0 → _@oxc-project_runtime@0.158.0}/helpers/esm/decorate.js +1 -1
- package/dist/_virtual/_@oxc-project_runtime@0.158.0/helpers/esm/decorateParam.js +7 -0
- package/dist/index.js +14 -10
- package/dist/nodefony/config/config.js +16 -2
- package/dist/nodefony/controller/AdminApiController.js +18 -5
- package/dist/nodefony/controller/BenchController.js +1 -1
- package/dist/nodefony/controller/CspReportController.js +70 -0
- package/dist/nodefony/controller/IssuerMetadataController.js +3 -3
- package/dist/nodefony/controller/LoginPageController.js +5 -7
- package/dist/nodefony/controller/ProtectedResourceMetadataController.js +75 -10
- package/dist/nodefony/controller/SessionAuthController.js +6 -7
- package/dist/nodefony/controller/TokenAuthController.js +3 -3
- package/dist/nodefony/decorators/routerDecorators.js +103 -15
- package/dist/nodefony/grpc/GrpcController.js +138 -0
- package/dist/nodefony/grpc/GrpcService.js +75 -0
- package/dist/nodefony/grpc/declarations.js +33 -0
- package/dist/nodefony/grpc/index.js +3 -0
- package/dist/nodefony/service/AdminBroker.js +1 -1
- package/dist/nodefony/service/IdempotencyStore.js +1 -1
- package/dist/nodefony/service/router.js +15 -12
- package/dist/nodefony/src/Controller.js +330 -115
- package/dist/nodefony/src/PlaygroundAdminApi.js +1 -1
- package/dist/nodefony/src/Resolver.js +85 -51
- package/dist/nodefony/src/Route.js +45 -45
- package/dist/nodefony/src/SecurityApiController.js +30 -7
- package/dist/nodefony/src/conditionalRequest.js +103 -0
- package/dist/nodefony/src/docsReader.js +1 -1
- package/dist/nodefony/src/idempotency.js +1 -1
- package/dist/nodefony/src/loginPage.js +3 -2
- package/dist/nodefony/src/scopeCatalog.js +1 -1
- package/dist/nodefony/src/viewNonce.js +58 -0
- package/dist/types/index.d.ts +4 -2
- package/dist/types/nodefony/config/config.d.ts +20 -0
- package/dist/types/nodefony/controller/AdminApiController.d.ts +4 -2
- package/dist/types/nodefony/controller/CspReportController.d.ts +35 -0
- package/dist/types/nodefony/controller/LoginPageController.d.ts +3 -2
- package/dist/types/nodefony/controller/ProtectedResourceMetadataController.d.ts +21 -1
- package/dist/types/nodefony/controller/SessionAuthController.d.ts +5 -6
- package/dist/types/nodefony/controller/TokenAuthController.d.ts +3 -3
- package/dist/types/nodefony/decorators/routerDecorators.d.ts +2 -1
- package/dist/types/nodefony/grpc/GrpcController.d.ts +75 -0
- package/dist/types/nodefony/grpc/GrpcService.d.ts +51 -0
- package/dist/types/nodefony/grpc/declarations.d.ts +12 -0
- package/dist/types/nodefony/grpc/index.d.ts +13 -0
- package/dist/types/nodefony/interfaces/IController.d.ts +4 -4
- package/dist/types/nodefony/service/router.d.ts +8 -6
- package/dist/types/nodefony/src/Controller.d.ts +124 -14
- package/dist/types/nodefony/src/Resolver.d.ts +35 -8
- package/dist/types/nodefony/src/Route.d.ts +35 -0
- package/dist/types/nodefony/src/SecurityApiController.d.ts +17 -4
- package/dist/types/nodefony/src/conditionalRequest.d.ts +82 -0
- package/dist/types/nodefony/src/loginPage.d.ts +1 -1
- package/dist/types/nodefony/src/viewNonce.d.ts +33 -0
- package/docs/controller.md +234 -35
- package/docs/decorateurs.md +1 -1
- package/docs/grpc.md +690 -0
- package/docs/idempotence.md +13 -8
- package/docs/index.md +16 -10
- package/docs/routing.md +30 -2
- package/docs/templates.md +15 -0
- package/package.json +28 -11
|
@@ -1,18 +1,20 @@
|
|
|
1
1
|
import { isDevelopment, singletonWriteMessage } from "./singletonGuard.js";
|
|
2
|
+
import { fileServingSchema } from "../config/config.js";
|
|
3
|
+
import { evaluatePreconditions, fileValidators, ifRangeHolds, parseHttpDate } from "./conditionalRequest.js";
|
|
4
|
+
import { VIEW_NONCE_LOCAL, signTemplateTags } from "./viewNonce.js";
|
|
2
5
|
import { FileClass, RequestContext, Service } from "nodefony";
|
|
3
6
|
import { HttpContext, HttpError, acceptsEventStream } from "@nodefony/http";
|
|
4
|
-
import
|
|
5
|
-
import {
|
|
7
|
+
import { Readable } from "node:stream";
|
|
8
|
+
import { createReadStream } from "node:fs";
|
|
6
9
|
// nodefony/src/Controller.ts
|
|
7
|
-
const fsClose = promisify(fs.close);
|
|
8
10
|
/**
|
|
9
|
-
* Un `<script>`
|
|
11
|
+
* Un `<script>` ou un `<style>` qui ne porte pas d'attribut `nonce`.
|
|
10
12
|
*
|
|
11
|
-
* `
|
|
12
|
-
*
|
|
13
|
-
*
|
|
13
|
+
* Sous `'strict-dynamic'` (ADR-0024 §C1), un script SERVI depuis un fichier
|
|
14
|
+
* de même origine est refusé lui aussi sans nonce : `'self'` n'y compte plus.
|
|
15
|
+
* Un `<style>` sans nonce l'est sous la politique de styles (§C2).
|
|
14
16
|
*/
|
|
15
|
-
const
|
|
17
|
+
const UNSIGNED_SCRIPT_OR_STYLE = /<(?:script|style)\b(?![^>]*\bnonce\s*=)/iu;
|
|
16
18
|
/**
|
|
17
19
|
* Le CSP posé sur cette réponse exige-t-il un nonce sur les scripts ?
|
|
18
20
|
*
|
|
@@ -32,7 +34,7 @@ const INLINE_SCRIPT_SANS_NONCE = /<script(?![^>]*\bnonce=)(?![^>]*\bsrc=)[^>]*>\
|
|
|
32
34
|
* @param csp - valeur de l'en-tête `Content-Security-Policy`, si posée.
|
|
33
35
|
* @returns `true` quand un script en ligne devra porter un nonce.
|
|
34
36
|
*/
|
|
35
|
-
function
|
|
37
|
+
function cspRequiresNonce(csp) {
|
|
36
38
|
return typeof csp === "string" && csp.includes("'nonce-");
|
|
37
39
|
}
|
|
38
40
|
/**
|
|
@@ -72,15 +74,78 @@ function parseByteRange(range, length) {
|
|
|
72
74
|
end: last === "" ? length - 1 : Math.min(parseInt(last, 10), length - 1)
|
|
73
75
|
};
|
|
74
76
|
}
|
|
77
|
+
/** Une HTTP-date déjà passée (RFC 9110 §5.6.7) : le début de l'ère Unix. */
|
|
78
|
+
const EXPIRED_HTTP_DATE = "Thu, 01 Jan 1970 00:00:00 GMT";
|
|
75
79
|
/**
|
|
76
|
-
*
|
|
77
|
-
*
|
|
80
|
+
* Défaut des fichiers servis par une action, pour TOUTE l'application — la
|
|
81
|
+
* section `fileServing` de la config du module, posée au boot par
|
|
82
|
+
* {@link configureFileServing}. Initialisé depuis le schéma (seule source des
|
|
83
|
+
* défauts) : un contrôleur testé sans noyau reçoit les mêmes valeurs.
|
|
84
|
+
*/
|
|
85
|
+
let fileServing = fileServingSchema.parse({});
|
|
86
|
+
/**
|
|
87
|
+
* Fixe le défaut des fichiers servis (validateurs, `Cache-Control`) pour
|
|
88
|
+
* toute l'application. Appelé par le module au boot avec sa config validée.
|
|
89
|
+
*
|
|
90
|
+
* @param config - section `fileServing` validée
|
|
91
|
+
*/
|
|
92
|
+
function configureFileServing(config) {
|
|
93
|
+
fileServing = config;
|
|
94
|
+
}
|
|
95
|
+
/** Aucun validateur : `If-Range` ne tient jamais, aucune précondition n'est évaluée. */
|
|
96
|
+
const NO_VALIDATORS = Object.freeze({
|
|
97
|
+
etag: null,
|
|
98
|
+
lastModified: null,
|
|
99
|
+
lastModifiedStrong: false
|
|
100
|
+
});
|
|
101
|
+
/**
|
|
102
|
+
* En-têtes qu'un 304 doit porter, ceux qu'aurait portés le 200 (RFC 9110
|
|
103
|
+
* §15.4.5) — en minuscules.
|
|
104
|
+
*/
|
|
105
|
+
const NOT_MODIFIED_FIELDS = /* @__PURE__ */ new Set([
|
|
106
|
+
"cache-control",
|
|
107
|
+
"content-location",
|
|
108
|
+
"etag",
|
|
109
|
+
"expires",
|
|
110
|
+
"last-modified",
|
|
111
|
+
"vary"
|
|
112
|
+
]);
|
|
113
|
+
/** Valeur d'un en-tête d'un objet d'en-têtes, quelle que soit la casse de sa clé. */
|
|
114
|
+
function headerIn(headers, name) {
|
|
115
|
+
if (headers === void 0) return void 0;
|
|
116
|
+
for (const key of Object.keys(headers)) if (key.toLowerCase() === name) return headers[key];
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* Encode une valeur en `ext-value` UTF-8 (RFC 8187 §3.2) : tout ce qui n'est
|
|
120
|
+
* pas un `attr-char` part en pourcentage — `encodeURIComponent` laisse passer
|
|
121
|
+
* `'`, `(`, `)` et `*`, qui n'en sont pas.
|
|
122
|
+
*/
|
|
123
|
+
function encodeExtValue(value) {
|
|
124
|
+
return encodeURIComponent(value).replace(/['()*]/g, (c) => `%${c.charCodeAt(0).toString(16).toUpperCase()}`);
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* Valeur d'un en-tête `Content-Disposition` (RFC 6266) pour un nom de fichier
|
|
128
|
+
* QUELCONQUE. `filename` seul quand le nom s'y écrit fidèlement ; sinon un
|
|
129
|
+
* repli ASCII, suivi de `filename*` en UTF-8 (RFC 6266 §4.3 : le destinataire
|
|
130
|
+
* prend `filename*`). Le repli remplace par `_` ce que l'annexe D écarte :
|
|
131
|
+
* hors ASCII imprimable, `"`, `\` et `%` — un nom accentué ne lève donc
|
|
132
|
+
* jamais `ERR_INVALID_CHAR`, et un guillemet ne casse pas la valeur.
|
|
78
133
|
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
134
|
+
* Exportée pour servir un fichier sous un AUTRE nom que celui du disque —
|
|
135
|
+
* un fichier reçu, rangé sous un identifiant tiré par le serveur, se rend
|
|
136
|
+
* sous le nom que le client lui a donné, passé en en-tête de
|
|
137
|
+
* `renderFileDownload()` ou de `streamFile()`.
|
|
138
|
+
*
|
|
139
|
+
* @param type - `attachment` (téléchargement) ou `inline` (affiché).
|
|
140
|
+
* @param name - le nom du fichier, tel quel.
|
|
141
|
+
* @returns la valeur de l'en-tête.
|
|
81
142
|
*/
|
|
82
|
-
|
|
83
|
-
|
|
143
|
+
/** Aucun fichier reçu : une requête sans corps multipart, ou une socket. */
|
|
144
|
+
const NO_FILES = Object.freeze([]);
|
|
145
|
+
function contentDisposition(type, name) {
|
|
146
|
+
const fallback = name.replace(/[^\x20-\x7e]|["\\%]/g, "_");
|
|
147
|
+
if (fallback === name) return `${type}; filename="${name}"`;
|
|
148
|
+
return `${type}; filename="${fallback}"; filename*=UTF-8''${encodeExtValue(name)}`;
|
|
84
149
|
}
|
|
85
150
|
var Controller = class extends Service {
|
|
86
151
|
static prefix = "/";
|
|
@@ -214,7 +279,7 @@ var Controller = class extends Service {
|
|
|
214
279
|
* préférer `@UploadedFiles()`.
|
|
215
280
|
*/
|
|
216
281
|
get files() {
|
|
217
|
-
return this.#files ?? (this.context?.request)?.files;
|
|
282
|
+
return this.#files ?? (this.context?.request)?.files ?? NO_FILES;
|
|
218
283
|
}
|
|
219
284
|
set files(value) {
|
|
220
285
|
this.#assertPerRequest("files");
|
|
@@ -268,14 +333,17 @@ var Controller = class extends Service {
|
|
|
268
333
|
return this.context?.setContextHtml(encoding);
|
|
269
334
|
}
|
|
270
335
|
/**
|
|
271
|
-
* Dit, EN DÉVELOPPEMENT SEULEMENT, qu'un script
|
|
336
|
+
* Dit, EN DÉVELOPPEMENT SEULEMENT, qu'un script ou un style ne s'appliquera pas.
|
|
272
337
|
*
|
|
273
|
-
*
|
|
274
|
-
*
|
|
338
|
+
* Une vue rendue par {@link Controller.renderView} est signée par le
|
|
339
|
+
* framework (`viewNonce.ts#signTemplateTags`) : ce qui reste ici, c'est du
|
|
340
|
+
* HTML produit autrement — une chaîne bâtie dans l'action, une valeur insérée
|
|
341
|
+
* brute. Le navigateur refuse alors la balise, et il le dit dans SA console — que personne ne lit quand la page est
|
|
275
342
|
* produite par un test, un `curl` ou un agent. Le serveur, lui, a les deux
|
|
276
|
-
* moitiés sous la main : l'en-tête qu'il vient
|
|
277
|
-
*
|
|
278
|
-
* le
|
|
343
|
+
* moitiés sous la main : l'en-tête qu'il vient d'émettre et le corps qu'il
|
|
344
|
+
* vient d'écrire — lus APRÈS l'envoi, la politique n'étant posée qu'au
|
|
345
|
+
* `writeHead`. Il le dit donc à la requête même où le geste manque, avec le
|
|
346
|
+
* geste — c'est ce qui distingue un refus utilisable d'un refus juste.
|
|
279
347
|
*
|
|
280
348
|
* ⚠️ Coût nul hors développement : la garde d'environnement est le PREMIER
|
|
281
349
|
* test, avant toute lecture d'en-tête et toute expression régulière. Une page
|
|
@@ -284,13 +352,13 @@ var Controller = class extends Service {
|
|
|
284
352
|
* @param data - le corps HTML sur le point d'être envoyé.
|
|
285
353
|
* @returns rien — cette sonde n'échoue jamais et ne change aucune réponse.
|
|
286
354
|
*/
|
|
287
|
-
#
|
|
355
|
+
#warnUnsignedTags(data) {
|
|
288
356
|
if (!isDevelopment(this.context?.kernel?.environment)) return;
|
|
289
357
|
if (typeof data !== "string" || data.length === 0) return;
|
|
290
358
|
const response = this.response;
|
|
291
359
|
if (typeof response?.getHeader !== "function") return;
|
|
292
|
-
if (!
|
|
293
|
-
this.log("Cette réponse porte un <script>
|
|
360
|
+
if (!cspRequiresNonce(response.getHeader("Content-Security-Policy")) || !UNSIGNED_SCRIPT_OR_STYLE.test(data)) return;
|
|
361
|
+
this.log("Cette réponse porte un <script> ou un <style> sans attribut `nonce`, et la politique de contenu de cette application exige un nonce : le navigateur REFUSERA la balise (« violates the following Content Security Policy directive »). Deux gestes, au choix :\n • rendre la page par une VUE (`this.renderView(…)`) : le framework signe chaque <script> et <style> écrit dans le gabarit ;\n • signer la balise à la main — `<script nonce=\"${this.context?.cspNonce}\">`.\n Ne desserre PAS la politique (`'unsafe-inline'`) : le détail vit dans `@nodefony/security/docs/headers.md`.", "WARNING", "CSP");
|
|
294
362
|
}
|
|
295
363
|
/**
|
|
296
364
|
* Rend une donnée sur la réponse de la requête courante (JSON, HTML ou
|
|
@@ -304,8 +372,13 @@ var Controller = class extends Service {
|
|
|
304
372
|
* @returns la réponse, ou sa promesse.
|
|
305
373
|
*/
|
|
306
374
|
render(data, encoding, status, headers) {
|
|
307
|
-
this
|
|
308
|
-
|
|
375
|
+
const sent = this.context?.render(data, encoding, status, headers);
|
|
376
|
+
if (sent instanceof Promise && isDevelopment(this.context?.kernel?.environment)) return sent.then((response) => {
|
|
377
|
+
this.#warnUnsignedTags(data);
|
|
378
|
+
return response;
|
|
379
|
+
});
|
|
380
|
+
this.#warnUnsignedTags(data);
|
|
381
|
+
return sent;
|
|
309
382
|
}
|
|
310
383
|
/**
|
|
311
384
|
* Envoie une donnée déjà sérialisée sur le transport de la requête (HTTP ou
|
|
@@ -326,19 +399,34 @@ var Controller = class extends Service {
|
|
|
326
399
|
const file = typeof path === "string" ? await FileClass.from(path) : path;
|
|
327
400
|
this.context?.phaseStart("render");
|
|
328
401
|
try {
|
|
329
|
-
data = await this.template?.render((await file.readAsync()).toString(), this.withFrontendLocals(param));
|
|
402
|
+
data = await this.template?.render(signTemplateTags((await file.readAsync()).toString()), this.withNonceLocal(this.withFrontendLocals(param)));
|
|
330
403
|
} finally {
|
|
331
404
|
this.context?.phaseEnd("render");
|
|
332
405
|
}
|
|
333
406
|
this.setContextHtml();
|
|
334
|
-
this
|
|
335
|
-
|
|
407
|
+
const response = await this.renderResponse(data, "utf8", status, headers);
|
|
408
|
+
this.#warnUnsignedTags(data);
|
|
409
|
+
return response;
|
|
336
410
|
} catch (e) {
|
|
337
411
|
this.log(e, "ERROR");
|
|
338
412
|
throw e;
|
|
339
413
|
}
|
|
340
414
|
}
|
|
341
415
|
/**
|
|
416
|
+
* Expose le nonce CSP de la requête à la vue (`cspNonce`), lu seulement si
|
|
417
|
+
* le gabarit s'en sert : un accesseur, pas une valeur — une vue sans
|
|
418
|
+
* `<script>` ni `<style>` ne tire aucun nonce. Une valeur `cspNonce`
|
|
419
|
+
* fournie par l'action est gardée.
|
|
420
|
+
*/
|
|
421
|
+
withNonceLocal(param) {
|
|
422
|
+
if ("cspNonce" in param) return param;
|
|
423
|
+
const context = this.context;
|
|
424
|
+
return Object.defineProperty({ ...param }, VIEW_NONCE_LOCAL, {
|
|
425
|
+
get: () => context?.cspNonce ?? "",
|
|
426
|
+
enumerable: false
|
|
427
|
+
});
|
|
428
|
+
}
|
|
429
|
+
/**
|
|
342
430
|
* Injecte les helpers frontend (`frontendTags`/`frontendDocument`) dans les
|
|
343
431
|
* locals du template (passés en data, pas de registre global de fonctions).
|
|
344
432
|
* Service `frontend` résolu par nom (pas d'import `@nodefony/frontend`). Les
|
|
@@ -401,6 +489,12 @@ var Controller = class extends Service {
|
|
|
401
489
|
* }
|
|
402
490
|
* ```
|
|
403
491
|
*
|
|
492
|
+
* Typé par le contrat temps réel de l'application, le flux lit la MÊME carte
|
|
493
|
+
* que la socket : `this.renderSse<ContractServerEmit<ChatContract>>()`, puis
|
|
494
|
+
* `sse.send(m, { event: "chat:room" })`. Sans paramètre de type, il reste
|
|
495
|
+
* libre — un flux hors contrat est valide.
|
|
496
|
+
*
|
|
497
|
+
* @typeParam Events - carte des événements du flux (défaut : libre).
|
|
404
498
|
* @param options - battement de cœur, délai `retry:` initial.
|
|
405
499
|
* @returns le flux, ou sa promesse quand une session est à sauver d'abord.
|
|
406
500
|
* @throws HttpError 500 hors HTTP (WebSocket) ou quand la réponse est partie.
|
|
@@ -409,6 +503,68 @@ var Controller = class extends Service {
|
|
|
409
503
|
if (!(this.context instanceof HttpContext)) throw new HttpError("SSE : un flux d'événements exige une requête HTTP", 500, this.context);
|
|
410
504
|
return this.context.openSse(options);
|
|
411
505
|
}
|
|
506
|
+
/**
|
|
507
|
+
* Répond par un FLUX D'OCTETS : un `<video src>`, un `fetch()`, un
|
|
508
|
+
* téléchargement ou un outil tiers (curl) le consomment comme n'importe quelle
|
|
509
|
+
* réponse HTTP, une réponse par consommateur. Pour des ÉVÉNEMENTS texte lus
|
|
510
|
+
* par `EventSource`, voir {@link Controller.renderSse}. Pour UNE source
|
|
511
|
+
* d'octets diffusée à N lecteurs par la socket, publier un `Uint8Array` sur
|
|
512
|
+
* un canal temps réel (`@nodefony/realtime`), pas une réponse HTTP.
|
|
513
|
+
*
|
|
514
|
+
* La réponse est prise à l'appel ; les en-têtes partent au premier morceau.
|
|
515
|
+
* Une erreur de la source AVANT lui rend la page d'erreur ordinaire (500, ou
|
|
516
|
+
* le code d'une `HttpError`) ; APRÈS, le client voit une coupure. La source
|
|
517
|
+
* appartient au flux dès l'appel : détruite à la fin, quelle qu'en soit la
|
|
518
|
+
* raison, et détruite aussi quand l'appel lève (un flux web est annulé). La
|
|
519
|
+
* promesse ne rejette jamais : elle rend la raison de la fin et les octets
|
|
520
|
+
* envoyés.
|
|
521
|
+
*
|
|
522
|
+
* @example
|
|
523
|
+
* ```ts
|
|
524
|
+
* const ff = spawn("ffmpeg", args, { stdio: ["ignore", "pipe", "ignore"], windowsHide: true });
|
|
525
|
+
* try {
|
|
526
|
+
* await this.renderStream(ff.stdout, { headers: { "content-type": "video/mp4" } });
|
|
527
|
+
* } finally {
|
|
528
|
+
* ff.kill("SIGKILL"); // le flux est fini, quelle qu'en soit la raison
|
|
529
|
+
* }
|
|
530
|
+
* ```
|
|
531
|
+
*
|
|
532
|
+
* Relais d'un autre service — le signal coupe l'amont au départ du client ;
|
|
533
|
+
* ne recopier que `content-type` (`fetch` a déjà décompressé le corps) :
|
|
534
|
+
* ```ts
|
|
535
|
+
* const r = await fetch(url, { signal: this.context.signal });
|
|
536
|
+
* if (!r.ok || r.body === null) throw new HttpError(502);
|
|
537
|
+
* return this.renderStream(r.body, {
|
|
538
|
+
* headers: { "content-type": r.headers.get("content-type") ?? "application/octet-stream" },
|
|
539
|
+
* });
|
|
540
|
+
* ```
|
|
541
|
+
*
|
|
542
|
+
* HEAD sans lancer le producteur — toute route GET sert HEAD, la source n'y
|
|
543
|
+
* est jamais lue. `Readable.from([])` seul est en mode OBJET, donc refusé
|
|
544
|
+
* (500) : le mode octets se demande.
|
|
545
|
+
* ```ts
|
|
546
|
+
* if (this.method === "HEAD") {
|
|
547
|
+
* return this.renderStream(Readable.from([], { objectMode: false }), {
|
|
548
|
+
* headers: { "content-type": "video/mp4" },
|
|
549
|
+
* });
|
|
550
|
+
* }
|
|
551
|
+
* ```
|
|
552
|
+
*
|
|
553
|
+
* @param source - flux Node, ou flux web ; jamais en mode objet.
|
|
554
|
+
* @param options - statut, en-têtes, `idleTimeout`, `stallTimeout`,
|
|
555
|
+
* `maxDuration`, `onClose(reason)`.
|
|
556
|
+
* @returns la raison de la fin et le nombre d'octets envoyés.
|
|
557
|
+
* @throws HttpError 500 hors HTTP (WebSocket) ou quand la réponse est partie ;
|
|
558
|
+
* 429 au-delà du plafond de connexions par IP. La source est alors détruite.
|
|
559
|
+
*/
|
|
560
|
+
renderStream(source, options) {
|
|
561
|
+
if (!(this.context instanceof HttpContext)) {
|
|
562
|
+
if (source instanceof Readable) source.destroy();
|
|
563
|
+
else source.cancel().catch(() => void 0);
|
|
564
|
+
throw new HttpError("Flux : une réponse en flux exige une requête HTTP", 500, this.context);
|
|
565
|
+
}
|
|
566
|
+
return this.context.openStream(source, options);
|
|
567
|
+
}
|
|
412
568
|
setRoute(route) {
|
|
413
569
|
this.#assertPerRequest("route");
|
|
414
570
|
this.#route = route;
|
|
@@ -504,15 +660,16 @@ var Controller = class extends Service {
|
|
|
504
660
|
* @param file - chemin ou `FileClass` du fichier à servir.
|
|
505
661
|
* @param options - options de `createReadStream`.
|
|
506
662
|
* @param headers - en-têtes ajoutés (écrasent ceux posés par défaut).
|
|
507
|
-
* @returns le flux de lecture, une fois la réponse écoulée
|
|
663
|
+
* @returns le flux de lecture, une fois la réponse écoulée — `null` quand
|
|
664
|
+
* les préconditions ont répondu 304 ou 412 (cf {@link Controller.streamFile}).
|
|
508
665
|
*/
|
|
509
666
|
async renderFileDownload(file, options, headers = {}) {
|
|
510
667
|
const File = await this.getFileAsync(file);
|
|
511
668
|
const length = File.stats.size;
|
|
512
669
|
const head = {
|
|
513
|
-
"Content-Disposition":
|
|
670
|
+
"Content-Disposition": contentDisposition("attachment", File.name),
|
|
514
671
|
"Content-Length": length,
|
|
515
|
-
Expires:
|
|
672
|
+
Expires: EXPIRED_HTTP_DATE,
|
|
516
673
|
"Content-Description": "File Transfer",
|
|
517
674
|
"Content-Type": File.mimeType || "application/octet-stream",
|
|
518
675
|
...headers
|
|
@@ -530,98 +687,156 @@ var Controller = class extends Service {
|
|
|
530
687
|
* `Content-Range`). Annoncer `Accept-Ranges: bytes` depuis ici est un piège :
|
|
531
688
|
* le client croit pouvoir se déplacer et reçoit tout le fichier.
|
|
532
689
|
*
|
|
533
|
-
*
|
|
534
|
-
*
|
|
535
|
-
*
|
|
690
|
+
* Le cycle de vie est celui de toute réponse en flux
|
|
691
|
+
* ({@link Controller.renderStream}) : la réponse est prise à l'appel, les
|
|
692
|
+
* en-têtes partent au premier morceau, le flux est DÉTRUIT (descripteur
|
|
693
|
+
* fermé) quand le client raccroche. Un fichier illisible à l'ouverture
|
|
694
|
+
* (`EACCES`) rend la page d'erreur ordinaire, 500 ; une lecture qui échoue
|
|
695
|
+
* en cours de route coupe la connexion. Sans délai d'inactivité (un disque
|
|
696
|
+
* n'est pas une source muette).
|
|
697
|
+
*
|
|
698
|
+
* **Requêtes conditionnelles** (RFC 9110 §13) : le fichier ENTIER porte une
|
|
699
|
+
* `ETag` forte et un `Last-Modified`, tirés de sa taille et de sa date de
|
|
700
|
+
* modification ; `If-Match`, `If-Unmodified-Since`, `If-None-Match` et
|
|
701
|
+
* `If-Modified-Since` y sont évalués dans l'ordre de §13.2.2 → 304 ou 412,
|
|
702
|
+
* sans ouvrir le fichier. Une `ETag` ou un `Last-Modified` passés dans
|
|
703
|
+
* `headers` (ou déjà posés sur la réponse) l'emportent, et servent à la
|
|
704
|
+
* comparaison. `Cache-Control: private, no-cache` est posé si l'action n'en
|
|
705
|
+
* fixe aucun — en passer un dans `headers` le remplace. Un EXTRAIT
|
|
706
|
+
* (`start`/`end`) n'est pas la représentation entière : il ne reçoit ni
|
|
707
|
+
* validateur ni évaluation.
|
|
708
|
+
* `{ validators: false }` dans `options` coupe le tout — validateurs,
|
|
709
|
+
* évaluation et `Cache-Control` par défaut — pour des fichiers dont la date
|
|
710
|
+
* n'est pas fiable ; une `ETag` tirée du contenu garde, elle, le 304.
|
|
536
711
|
*
|
|
537
712
|
* @param file - chemin ou `FileClass` du fichier à servir.
|
|
538
713
|
* @param headers - en-têtes ajoutés à la réponse (le type MIME est déduit si absent).
|
|
539
714
|
* @param options - options de `createReadStream` (`start`/`end` pour un extrait).
|
|
540
|
-
* @returns le flux de lecture, une fois la réponse écoulée
|
|
541
|
-
*
|
|
715
|
+
* @returns le flux de lecture, une fois la réponse écoulée — détruit, quelle
|
|
716
|
+
* que soit la fin ; `null` quand les préconditions ont répondu 304 ou 412 :
|
|
717
|
+
* aucun fichier n'a alors été ouvert.
|
|
718
|
+
* @throws HttpError 404 si le fichier n'existe pas ; 500 hors HTTP
|
|
719
|
+
* (WebSocket) ou quand la réponse est déjà partie.
|
|
542
720
|
*/
|
|
543
|
-
async streamFile(file, headers, options
|
|
721
|
+
async streamFile(file, headers, options) {
|
|
722
|
+
const fileDetails = await this.getFileAsync(file);
|
|
723
|
+
if (options?.start !== void 0 || options?.end !== void 0 || !(options?.validators ?? fileServing.validators)) return this.#sendFile(fileDetails, headers, options);
|
|
724
|
+
const condition = this.#fileCondition(fileDetails, headers, true);
|
|
725
|
+
if (condition.outcome !== 200) return this.#answerPrecondition(condition);
|
|
726
|
+
return this.#sendFile(fileDetails, condition.head, options);
|
|
727
|
+
}
|
|
728
|
+
/**
|
|
729
|
+
* Validateurs d'un fichier servi, et verdict des préconditions de la
|
|
730
|
+
* requête (RFC 9110 §13.2.2). Hors HTTP, rien n'est évalué : l'envoi
|
|
731
|
+
* refusera de lui-même.
|
|
732
|
+
*
|
|
733
|
+
* @param file - fichier servi
|
|
734
|
+
* @param headers - en-têtes fixés par l'action
|
|
735
|
+
* @param enabled - `false` (option `validators`) : ni validateur, ni
|
|
736
|
+
* évaluation, ni `Cache-Control` par défaut — les en-têtes de l'action
|
|
737
|
+
* seuls
|
|
738
|
+
*/
|
|
739
|
+
#fileCondition(file, headers, enabled) {
|
|
544
740
|
const context = this.context;
|
|
545
|
-
if (!
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
741
|
+
if (!(context instanceof HttpContext)) return {
|
|
742
|
+
head: headers ?? {},
|
|
743
|
+
validators: NO_VALIDATORS,
|
|
744
|
+
outcome: 200,
|
|
745
|
+
request: {}
|
|
746
|
+
};
|
|
747
|
+
const request = context.request.headers;
|
|
748
|
+
if (!enabled) return {
|
|
749
|
+
head: headers ?? {},
|
|
750
|
+
validators: NO_VALIDATORS,
|
|
751
|
+
outcome: 200,
|
|
752
|
+
request
|
|
753
|
+
};
|
|
754
|
+
const computed = fileValidators(file.stats, Date.now());
|
|
755
|
+
const response = context.response;
|
|
756
|
+
const given = (name) => headerIn(headers, name) ?? response.getHeader(name);
|
|
757
|
+
const head = {};
|
|
758
|
+
const etag = given("etag");
|
|
759
|
+
const lastModified = given("last-modified");
|
|
760
|
+
if (etag === void 0 && computed.etag !== null) head.ETag = computed.etag;
|
|
761
|
+
if (lastModified === void 0 && computed.lastModified !== null) head["Last-Modified"] = new Date(computed.lastModified).toUTCString();
|
|
762
|
+
const cacheControl = fileServing.cacheControl;
|
|
763
|
+
if (cacheControl !== null && given("cache-control") === void 0) head["Cache-Control"] = cacheControl;
|
|
764
|
+
const validators = etag === void 0 && lastModified === void 0 ? computed : {
|
|
765
|
+
etag: etag === void 0 ? computed.etag : String(etag),
|
|
766
|
+
lastModified: lastModified === void 0 ? computed.lastModified : parseHttpDate(String(lastModified)),
|
|
767
|
+
lastModifiedStrong: lastModified === void 0 ? computed.lastModifiedStrong : false
|
|
768
|
+
};
|
|
769
|
+
Object.assign(head, headers);
|
|
770
|
+
return {
|
|
771
|
+
head,
|
|
772
|
+
validators,
|
|
773
|
+
outcome: evaluatePreconditions(this.method ?? "GET", request, validators),
|
|
774
|
+
request
|
|
775
|
+
};
|
|
776
|
+
}
|
|
777
|
+
/**
|
|
778
|
+
* Répond 304 (rien n'a changé) ou 412 (une condition est fausse) sans
|
|
779
|
+
* ouvrir le fichier. Le 304 porte les en-têtes qu'aurait portés le 200 :
|
|
780
|
+
* validateurs, `Cache-Control`, `Expires`, `Vary` (RFC 9110 §15.4.5).
|
|
781
|
+
*/
|
|
782
|
+
async #answerPrecondition(condition) {
|
|
783
|
+
if (condition.outcome === 304) {
|
|
784
|
+
const kept = {};
|
|
785
|
+
for (const key of Object.keys(condition.head)) if (NOT_MODIFIED_FIELDS.has(key.toLowerCase())) kept[key] = condition.head[key];
|
|
786
|
+
await this.renderResponse("", "utf8", 304, kept);
|
|
787
|
+
return null;
|
|
566
788
|
}
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
handled = true;
|
|
591
|
-
response.removeListener("close", onResponseClose);
|
|
592
|
-
streamFile.unpipe(response);
|
|
593
|
-
if (streamFile.fd) await fsClose(streamFile.fd).catch((e) => {
|
|
594
|
-
reject(asError(e));
|
|
595
|
-
});
|
|
596
|
-
endContext();
|
|
597
|
-
resolve(streamFile);
|
|
598
|
-
} catch (e) {
|
|
599
|
-
this.log(e, "ERROR");
|
|
600
|
-
reject(asError(e));
|
|
601
|
-
}
|
|
602
|
-
};
|
|
603
|
-
const onStreamEnd = () => {
|
|
604
|
-
handleStreamEnd();
|
|
789
|
+
await this.renderResponse("Precondition Failed", "utf8", 412, { "Content-Type": "text/plain; charset=utf-8" });
|
|
790
|
+
return null;
|
|
791
|
+
}
|
|
792
|
+
/**
|
|
793
|
+
* Envoie le fichier déjà résolu sur la brique de flux — le cœur de
|
|
794
|
+
* {@link Controller.streamFile}, sans préconditions.
|
|
795
|
+
*/
|
|
796
|
+
async #sendFile(fileDetails, headers, options) {
|
|
797
|
+
const context = this.context;
|
|
798
|
+
if (!(context instanceof HttpContext)) throw new HttpError("Flux : un fichier en flux exige une requête HTTP", 500, context);
|
|
799
|
+
const response = context.response;
|
|
800
|
+
response.removeHeader("content-type");
|
|
801
|
+
let head = headers;
|
|
802
|
+
if (!(head && (head["Content-Type"] || head["content-type"]))) response.setFileMimeType(fileDetails.name);
|
|
803
|
+
const size = fileDetails.stats.size;
|
|
804
|
+
const start = options?.start ?? 0;
|
|
805
|
+
const end = Math.min(options?.end ?? size - 1, size - 1);
|
|
806
|
+
const length = Math.max(0, end - start + 1);
|
|
807
|
+
if (!(head && (head["Content-Length"] || head["content-length"]))) {
|
|
808
|
+
response.removeHeader("content-length");
|
|
809
|
+
head = {
|
|
810
|
+
...head,
|
|
811
|
+
"Content-Length": length
|
|
605
812
|
};
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
endContext();
|
|
611
|
-
reject(error);
|
|
612
|
-
});
|
|
813
|
+
}
|
|
814
|
+
const stream = createReadStream(fileDetails.path, length === 0 ? options : {
|
|
815
|
+
...options,
|
|
816
|
+
end
|
|
613
817
|
});
|
|
818
|
+
await context.openStream(stream, {
|
|
819
|
+
status: response.statusCode,
|
|
820
|
+
headers: head,
|
|
821
|
+
live: false,
|
|
822
|
+
idleTimeout: 0
|
|
823
|
+
});
|
|
824
|
+
return stream;
|
|
614
825
|
}
|
|
615
826
|
async renderMediaStream(file, headers = {}, options = {}) {
|
|
616
827
|
const File = await this.getFileAsync(file);
|
|
828
|
+
const condition = this.#fileCondition(File, headers, options.validators ?? fileServing.validators);
|
|
829
|
+
if (condition.outcome !== 200) return this.#answerPrecondition(condition);
|
|
617
830
|
this.response?.setEncoding("binary");
|
|
618
|
-
const
|
|
831
|
+
const ifRange = condition.request["if-range"];
|
|
832
|
+
const range = this.method === "GET" && (ifRange === void 0 || ifRangeHolds(ifRange, condition.validators)) ? condition.request.range : void 0;
|
|
619
833
|
const length = File.stats.size;
|
|
620
834
|
let head;
|
|
621
835
|
let value;
|
|
622
|
-
const
|
|
836
|
+
const contextResponse = this.response;
|
|
623
837
|
const parsed = range ? parseByteRange(range, length) : null;
|
|
624
|
-
if (parsed === "unsatisfiable") return this.renderResponse(
|
|
838
|
+
if (parsed === "unsatisfiable") return this.renderResponse(`Range Not Satisfiable (representation length ${length})`, "utf8", 416, {
|
|
839
|
+
"Content-Type": "text/plain; charset=utf-8",
|
|
625
840
|
"Content-Range": `bytes */${length}`,
|
|
626
841
|
"Accept-Ranges": "bytes"
|
|
627
842
|
});
|
|
@@ -638,22 +853,22 @@ var Controller = class extends Service {
|
|
|
638
853
|
"Accept-Ranges": "bytes",
|
|
639
854
|
"Content-Length": chunksize.toString(),
|
|
640
855
|
"Content-Type": File.mimeType || "application/octet-stream",
|
|
641
|
-
...
|
|
856
|
+
...condition.head
|
|
642
857
|
};
|
|
643
|
-
|
|
858
|
+
contextResponse.removeHeader("content-type");
|
|
644
859
|
this.response?.setStatusCode(206);
|
|
645
860
|
} else {
|
|
646
861
|
value = { ...options };
|
|
647
862
|
head = {
|
|
648
863
|
"Content-Type": File.mimeType || "application/octet-stream",
|
|
649
864
|
"Content-Length": length.toString(),
|
|
650
|
-
"Content-Disposition":
|
|
865
|
+
"Content-Disposition": contentDisposition("inline", File.name),
|
|
651
866
|
"Accept-Ranges": "bytes",
|
|
652
|
-
...
|
|
867
|
+
...condition.head
|
|
653
868
|
};
|
|
654
|
-
|
|
869
|
+
contextResponse.removeHeader("content-type");
|
|
655
870
|
}
|
|
656
|
-
return this
|
|
871
|
+
return this.#sendFile(File, head, value);
|
|
657
872
|
}
|
|
658
873
|
};
|
|
659
|
-
export { Controller as default, parseByteRange };
|
|
874
|
+
export { configureFileServing, contentDisposition, Controller as default, parseByteRange };
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { extractActionScopes, resolveActionMeta } from "../decorators/routerDecorators.js";
|
|
2
1
|
import router_default from "../service/router.js";
|
|
2
|
+
import { extractActionScopes, resolveActionMeta } from "../decorators/routerDecorators.js";
|
|
3
3
|
import AdminApiController from "../controller/AdminApiController.js";
|
|
4
4
|
import { standardJsonSchemaOf } from "nodefony";
|
|
5
5
|
// nodefony/src/PlaygroundAdminApi.ts
|