@nodefony/framework 10.0.0-beta.1 → 10.0.0-beta.3
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 +1 -1
- package/dist/_virtual/{_@oxc-project_runtime@0.151.0 → _@oxc-project_runtime@0.153.0}/helpers/esm/decorate.js +1 -1
- package/dist/_virtual/{_@oxc-project_runtime@0.151.0 → _@oxc-project_runtime@0.153.0}/helpers/esm/decorateMetadata.js +1 -1
- package/dist/index.js +9 -5
- package/dist/nodefony/controller/AdminApiController.js +7 -4
- package/dist/nodefony/controller/ApiKeyController.js +5 -4
- package/dist/nodefony/controller/LoginPageController.js +124 -0
- package/dist/nodefony/controller/OAuth2Controller.js +131 -14
- package/dist/nodefony/controller/SessionAuthController.js +37 -9
- package/dist/nodefony/controller/TokenAuthController.js +13 -6
- package/dist/nodefony/controller/TotpController.js +7 -6
- package/dist/nodefony/controller/WebAuthnController.js +26 -9
- package/dist/nodefony/decorators/routerDecorators.js +114 -13
- package/dist/nodefony/service/AdminBroker.js +2 -2
- package/dist/nodefony/service/IdempotencyStore.js +2 -2
- package/dist/nodefony/service/router.js +54 -23
- package/dist/nodefony/src/Controller.js +49 -4
- package/dist/nodefony/src/FrameworkAdminApi.js +2 -1
- package/dist/nodefony/src/KernelAdminApi.js +76 -10
- package/dist/nodefony/src/Resolver.js +41 -4
- package/dist/nodefony/src/Route.js +76 -6
- package/dist/nodefony/src/SecurityApiController.js +24 -0
- package/dist/nodefony/src/docsReader.js +64 -41
- package/dist/nodefony/src/idempotency.js +13 -20
- package/dist/nodefony/src/loginPage.js +431 -0
- package/dist/nodefony/src/requireAuthentication.js +36 -0
- package/dist/types/index.d.ts +4 -3
- package/dist/types/nodefony/controller/ApiKeyController.d.ts +4 -3
- package/dist/types/nodefony/controller/LoginPageController.d.ts +32 -0
- package/dist/types/nodefony/controller/OAuth2Controller.d.ts +67 -8
- package/dist/types/nodefony/controller/SessionAuthController.d.ts +39 -8
- package/dist/types/nodefony/controller/TokenAuthController.d.ts +8 -6
- package/dist/types/nodefony/controller/TotpController.d.ts +4 -3
- package/dist/types/nodefony/controller/WebAuthnController.d.ts +12 -4
- package/dist/types/nodefony/decorators/routerDecorators.d.ts +88 -3
- package/dist/types/nodefony/interfaces/IRoute.d.ts +1 -2
- package/dist/types/nodefony/service/router.d.ts +13 -0
- package/dist/types/nodefony/src/Controller.d.ts +40 -1
- package/dist/types/nodefony/src/Resolver.d.ts +20 -1
- package/dist/types/nodefony/src/Route.d.ts +33 -2
- package/dist/types/nodefony/src/SecurityApiController.d.ts +17 -0
- package/dist/types/nodefony/src/docsReader.d.ts +26 -12
- package/dist/types/nodefony/src/idempotency.d.ts +12 -10
- package/dist/types/nodefony/src/loginPage.d.ts +144 -0
- package/dist/types/nodefony/src/requireAuthentication.d.ts +29 -0
- package/docs/admin.md +28 -23
- package/docs/controller.md +84 -82
- package/docs/decorateurs.md +77 -74
- package/docs/idempotence.md +31 -29
- package/docs/index.md +1 -1
- package/docs/routing.md +58 -57
- package/docs/templates.md +12 -12
- package/package.json +11 -12
package/docs/routing.md
CHANGED
|
@@ -52,10 +52,10 @@ Trois faits à retenir avant tout le reste :
|
|
|
52
52
|
(`routing-nonregression.test.ts:83`).
|
|
53
53
|
2. **Le routeur ne lève jamais de 404.** Aucun match = `resolver.resolve === false`, sans exception ;
|
|
54
54
|
le 404 est décidé plus loin, après le repli sur les fichiers statiques
|
|
55
|
-
(`HttpError("Not Found", 404)`, `http-kernel.ts:
|
|
55
|
+
(`HttpError("Not Found", 404)`, `http-kernel.ts:907`).
|
|
56
56
|
3. **Le chemin est vérifié avant la méthode, et le domaine entre les deux** — c'est ce qui produit un
|
|
57
57
|
`403` plutôt qu'un `405` bavard quand la route appartient à un autre vhost (`Route.match()`,
|
|
58
|
-
`Route.ts:
|
|
58
|
+
`Route.ts:393`).
|
|
59
59
|
|
|
60
60
|
## 📖 Lexique
|
|
61
61
|
|
|
@@ -95,7 +95,7 @@ tranchent différemment :
|
|
|
95
95
|
**L'arbitrage est explicite, pas calculé.** Beaucoup de routeurs trient les routes par « spécificité »
|
|
96
96
|
(le motif le plus précis gagne) — pratique jusqu'au jour où l'on ne comprend plus pourquoi telle route
|
|
97
97
|
passe devant telle autre. Nodefony garde l'**ordre de déclaration** : la table est parcourue de haut en
|
|
98
|
-
bas, le premier motif satisfait l'emporte (`Router.resolve()`, `router.ts:
|
|
98
|
+
bas, le premier motif satisfait l'emporte (`Router.resolve()`, `router.ts:313`). Le compromis assumé :
|
|
99
99
|
c'est à toi de déclarer le littéral avant le paramétré. En échange, tu peux **lire** l'ordre dans ton
|
|
100
100
|
contrôleur.
|
|
101
101
|
|
|
@@ -104,17 +104,17 @@ contrôleur.
|
|
|
104
104
|
O(1) ; les chemins **dynamiques** restent un scan regex (`buildRouteIndex()`, `router.ts:130`). À la
|
|
105
105
|
résolution, les deux flux sont fusionnés **par position d'insertion** — la séquence de candidats est
|
|
106
106
|
exactement celle du scan linéaire complet, moins les littérales d'un autre chemin, qui ne pouvaient de
|
|
107
|
-
toute façon pas correspondre (`Router.resolve()`, `router.ts:
|
|
107
|
+
toute façon pas correspondre (`Router.resolve()`, `router.ts:313`). C'est cette équivalence que fige le
|
|
108
108
|
banc de non-régression : un refacto du routeur doit le repasser à l'identique.
|
|
109
109
|
|
|
110
110
|
**Une seule table pour HTTP et WebSocket.** Il n'y a pas de « routeur WS » séparé : une action WS est
|
|
111
111
|
une route dont les méthodes déclarées contiennent `WEBSOCKET` (`Route.matchRequirements()`,
|
|
112
|
-
`Route.ts:
|
|
112
|
+
`Route.ts:816`). C'est le différenciateur du framework — le même contrôleur, le même contexte, les
|
|
113
113
|
mêmes décorateurs.
|
|
114
114
|
|
|
115
115
|
**Le routeur passe avant les fichiers statiques.** Une requête qui correspond à une route ne paie
|
|
116
116
|
jamais le `stat` du serveur de fichiers : le repli statique n'est tenté que si la résolution a échoué
|
|
117
|
-
(`serverStatic.handle()`, `http-kernel.ts:
|
|
117
|
+
(`serverStatic.handle()`, `http-kernel.ts:839`).
|
|
118
118
|
|
|
119
119
|
> [!NOTE]
|
|
120
120
|
> **Le routage n'a aucune option de configuration.** Le schéma Zod du module n'expose qu'un sac
|
|
@@ -256,14 +256,14 @@ npx wscat -c ws://localhost:5151/api/catalog/live
|
|
|
256
256
|
La **syntaxe** des décorateurs est détaillée dans [decorateurs](./decorateurs.md) ; ce qui suit est ce
|
|
257
257
|
que chaque forme **produit dans la table**.
|
|
258
258
|
|
|
259
|
-
| Forme | Nom de la route | Méthodes déclarées
|
|
260
|
-
| ----------------------------------------- | ---------------------------------- |
|
|
261
|
-
| `@Get` `@Post` `@Put` `@Delete` `@Patch`… | auto : `` `Classe::methode` `` | exactement une
|
|
262
|
-
| `@All(path)` | auto : `` `Classe::methode` `` | **aucune** →
|
|
263
|
-
| `@route(nom, options)` | **le tien** (stable, réutilisable) | `requirements.methods` (libre)
|
|
259
|
+
| Forme | Nom de la route | Méthodes déclarées | Quand l'utiliser |
|
|
260
|
+
| ----------------------------------------- | ---------------------------------- | ------------------------------------------------------ | -------------------------------------------- |
|
|
261
|
+
| `@Get` `@Post` `@Put` `@Delete` `@Patch`… | auto : `` `Classe::methode` `` | exactement une | le cas courant, REST |
|
|
262
|
+
| `@All(path)` | auto : `` `Classe::methode` `` | **aucune** → tous les verbes HTTP, jamais le WebSocket | proxy, capture-tout, page de repli |
|
|
263
|
+
| `@route(nom, options)` | **le tien** (stable, réutilisable) | `requirements.methods` (libre) | WebSocket, multi-méthodes, contraintes fines |
|
|
264
264
|
|
|
265
265
|
- Les décorateurs de méthode HTTP délèguent tous à `@route` avec un nom auto `Classe::methode`, et
|
|
266
|
-
posent `requirements: { methods }` (`httpMethodDecorator()`, `routerDecorators.ts:
|
|
266
|
+
posent `requirements: { methods }` (`httpMethodDecorator()`, `routerDecorators.ts:494`).
|
|
267
267
|
- `@All` n'émet **aucun** requirement de méthode : la route sert alors GET, POST, DELETE… et ne peut
|
|
268
268
|
donc jamais produire un 405 sur la méthode (`All()`, `routerDecorators.ts:548`).
|
|
269
269
|
- `@route` est la forme complète : elle seule permet `protocol` (sous-protocole WS), un nom lisible, et
|
|
@@ -281,7 +281,7 @@ qui les lit et appelle `Router.createRoute()` pour chacune (`controller()`, `rou
|
|
|
281
281
|
## Motifs de chemin et paramètres
|
|
282
282
|
|
|
283
283
|
Le chemin déclaré est compilé **une fois**, à la création de la route, en une expression régulière
|
|
284
|
-
ancrée et **insensible à la casse** (`Route.compile()`, `Route.ts:
|
|
284
|
+
ancrée et **insensible à la casse** (`Route.compile()`, `Route.ts:514`). La grammaire tient en cinq
|
|
285
285
|
briques (`REG_ROUTE`, `Route.ts:17`) :
|
|
286
286
|
|
|
287
287
|
| Écriture | Motif compilé | Capture | Exemple |
|
|
@@ -295,7 +295,7 @@ briques (`REG_ROUTE`, `Route.ts:17`) :
|
|
|
295
295
|
Et trois comportements qui surprennent la première fois :
|
|
296
296
|
|
|
297
297
|
- **Le slash final est retiré avant le matching** — `/books/` et `/books` désignent la même route
|
|
298
|
-
(`Route.cleanPathname()`, `Route.ts:
|
|
298
|
+
(`Route.cleanPathname()`, `Route.ts:355`). Corollaire : `/files/*` ne matche pas `/files/`, qui a été
|
|
299
299
|
normalisé en `/files`.
|
|
300
300
|
- **Les valeurs sont URL-décodées** — `%C3%A9t%C3%A9` arrive dans l'action comme `été`
|
|
301
301
|
(`decode()`, `Route.ts:79`).
|
|
@@ -307,7 +307,7 @@ Et trois comportements qui surprennent la première fois :
|
|
|
307
307
|
C'est le mécanisme le moins évident, et le plus utile. Déclarer un `defaults` pour une variable change
|
|
308
308
|
le motif compilé : le segment devient facultatif (`[^/]*`) **et son slash aussi** (`/?`), puis la valeur
|
|
309
309
|
par défaut est réinjectée quand la capture est vide (`checkDefaultParameters()`, `Route.ts:99` ·
|
|
310
|
-
`Route.hydrateDefaultParameters()`, `Route.ts:
|
|
310
|
+
`Route.hydrateDefaultParameters()`, `Route.ts:622`).
|
|
311
311
|
|
|
312
312
|
```ts ignore
|
|
313
313
|
@route("route-page", { path: "/page/{slug}", defaults: { slug: "home" } })
|
|
@@ -327,7 +327,7 @@ async page(slug: string) {
|
|
|
327
327
|
Les captures sont passées **positionnellement**, dans l'ordre des variables du chemin — c'est pourquoi
|
|
328
328
|
la signature `async method6(metier: string, format: string)` suit l'ordre de `/{metier}/{format}`. Un
|
|
329
329
|
wildcard est exposé sous les clés `wildcard` et `*`. Le `Resolver` en fabrique aussi un instantané
|
|
330
|
-
nom → valeur par requête (`Resolver.getMatchedParams()`, `Resolver.ts:
|
|
330
|
+
nom → valeur par requête (`Resolver.getMatchedParams()`, `Resolver.ts:224`), lu par le contexte pour
|
|
331
331
|
les métadonnées et par les décorateurs `@Param`.
|
|
332
332
|
|
|
333
333
|
> [!IMPORTANT]
|
|
@@ -367,7 +367,7 @@ le suit — un `@All("*")` déclaré tôt masque le reste du contrôleur.
|
|
|
367
367
|
|
|
368
368
|
Deux routes peuvent partager un chemin et se distinguer par la méthode. La passe 1 essaie la première,
|
|
369
369
|
qui **lève** un 405 sur la méthode ; l'exception est mémorisée et le scan **continue** jusqu'à la route
|
|
370
|
-
qui accepte la méthode (`Router.resolve()`, `router.ts:
|
|
370
|
+
qui accepte la méthode (`Router.resolve()`, `router.ts:313`).
|
|
371
371
|
|
|
372
372
|
```ts ignore
|
|
373
373
|
@Get("/book/{id}") show() {}
|
|
@@ -381,7 +381,7 @@ compilé de chaque route — la MÊME source que le match). C'est la conformité
|
|
|
381
381
|
`Allow` liste tout ce que la ressource accepte, pas seulement ce que la dernière route scannée
|
|
382
382
|
acceptait — `HEAD` compris dès qu'une route sert `GET`.
|
|
383
383
|
|
|
384
|
-
**`HEAD` est implicite sur `GET`** (`Route.compileRequirements`, `Route.ts:
|
|
384
|
+
**`HEAD` est implicite sur `GET`** (`Route.compileRequirements`, `Route.ts:568`) : RFC 9110 §9.1
|
|
385
385
|
impose à tout serveur généraliste de servir `GET` et `HEAD`, et `HEAD` rend la réponse de `GET`
|
|
386
386
|
sans corps (§9.3.2) — le serveur Node écarte le corps lui-même, en HTTP/1.1 comme en HTTP/2.
|
|
387
387
|
L'ajout se fait à la compilation de la route : aucun coût par requête.
|
|
@@ -389,17 +389,17 @@ L'ajout se fait à la compilation de la route : aucun coût par requête.
|
|
|
389
389
|
| Requête | Réponse |
|
|
390
390
|
| ----------------- | ---------------------------------------------- |
|
|
391
391
|
| `DELETE /book/42` | 200 — la 2ᵉ route accepte |
|
|
392
|
-
| `PATCH /book/42` | **405**, `Allow: GET, DELETE`
|
|
392
|
+
| `PATCH /book/42` | **405**, `Allow: GET, HEAD, DELETE` |
|
|
393
393
|
| `GET /inexistant` | pas d'exception — repli statique, puis **404** |
|
|
394
394
|
|
|
395
395
|
### Situation 3 — une route réservée à un domaine
|
|
396
396
|
|
|
397
397
|
Une route restreinte par `@Domain` est **invisible** aux requêtes des autres vhosts : elle lève un 403
|
|
398
|
-
au lieu de participer au match (`Route.matchHostname()`, `Route.ts:
|
|
398
|
+
au lieu de participer au match (`Route.matchHostname()`, `Route.ts:754`). Le point de sécurité est
|
|
399
399
|
l'**ordre des vérifications** : le domaine est vérifié **avant** la méthode. Sans cela, une route d'un
|
|
400
400
|
autre vhost pourrait répondre 405 en révélant SES méthodes — une fuite d'information cross-domaine
|
|
401
|
-
(`Route.match()`, `Route.ts:
|
|
402
|
-
exclues du calcul de `Allow` (`isDomainAllowed`, `router.ts:
|
|
401
|
+
(`Route.match()`, `Route.ts:393`). La passe 2 applique la même règle : les routes d'un autre vhost sont
|
|
402
|
+
exclues du calcul de `Allow` (`isDomainAllowed`, `router.ts:432`).
|
|
403
403
|
|
|
404
404
|
Si une autre route du même chemin sert **tous** les vhosts, le scan continue jusqu'à elle : le 403
|
|
405
405
|
n'interrompt pas la recherche, il ne conclut que s'il ne reste aucune candidate.
|
|
@@ -420,17 +420,17 @@ async chat(room: string, message: string | Buffer | null) { /* … */ }
|
|
|
420
420
|
Ce qui change par rapport au HTTP :
|
|
421
421
|
|
|
422
422
|
- **La route est résolue AVANT l'acceptation du handshake.** Le contexte WS passe par le même
|
|
423
|
-
`handleFrontController()`, puis seulement `context.connect()` (`http-kernel.ts:
|
|
423
|
+
`handleFrontController()`, puis seulement `context.connect()` (`http-kernel.ts:1568`). Un chemin
|
|
424
424
|
inconnu ou un sous-protocole non conforme ferme la connexion **sans jamais l'ouvrir**.
|
|
425
425
|
- **Le sous-protocole est un requirement de route.** Un `protocol` déclaré et non satisfait lève une
|
|
426
426
|
erreur de code **1002** (Protocol Error, RFC 6455 §7.4) au lieu d'un statut HTTP
|
|
427
|
-
(`acceptedProtocol`, `Route.ts:
|
|
427
|
+
(`acceptedProtocol`, `Route.ts:911`).
|
|
428
428
|
- **Le 405 ne s'applique pas au WebSocket.** La passe 2 est réservée au HTTP : sur un contexte WS,
|
|
429
|
-
l'exception d'origine est préservée (`Router.resolve()`, `router.ts:
|
|
429
|
+
l'exception d'origine est préservée (`Router.resolve()`, `router.ts:313`).
|
|
430
430
|
- **Un `Resolver` par connexion, réutilisé à chaque frame.** Il est créé au handshake, puis chaque
|
|
431
431
|
message rejoue `match()` sur la route déjà trouvée avant d'appeler l'action
|
|
432
|
-
(`WebsocketContext.handle()`, `WebsocketContext.ts:
|
|
433
|
-
`callController`, `WebsocketContext.ts:
|
|
432
|
+
(`WebsocketContext.handle()`, `WebsocketContext.ts:297` · boucle message,
|
|
433
|
+
`callController`, `WebsocketContext.ts:59`).
|
|
434
434
|
L'action est donc invoquée une fois au handshake (`message` vaut `null`), puis une fois par frame.
|
|
435
435
|
|
|
436
436
|
### Duplex — le même chemin en HTTP et en WS
|
|
@@ -439,25 +439,26 @@ Déclarer `methods: ["GET", "WEBSOCKET"]` rend une action joignable par les deux
|
|
|
439
439
|
que fait le data plane d'administration pour toutes ses lectures (`AdminBroker.mountAll()` →
|
|
440
440
|
`Router.createRoute()`, `AdminBroker.ts:125`). Deux conséquences :
|
|
441
441
|
|
|
442
|
-
- **La pseudo-méthode `WEBSOCKET` apparaît dans
|
|
443
|
-
|
|
442
|
+
- **La pseudo-méthode `WEBSOCKET` n'apparaît jamais dans `Allow`** : ce n'est pas une méthode HTTP
|
|
443
|
+
(RFC 9110 §10.2.1), elle est retirée de l'agrégat. Un chemin qui n'existe qu'en WebSocket, appelé
|
|
444
|
+
en HTTP, répond `426 Upgrade Required` avec `Upgrade: websocket` plutôt qu'un 405
|
|
444
445
|
(`routing-nonregression.test.ts:164`).
|
|
445
446
|
- **Une invocation WS d'une mutation doit dire quelle méthode logique elle vise.** Sur une socket,
|
|
446
447
|
`context.method` vaut toujours `WEBSOCKET` : insuffisant pour distinguer un GET d'un POST sur le même
|
|
447
|
-
chemin. Le pont transporte donc une **méthode logique** (`methodOverride`, `Resolver.ts:
|
|
448
|
+
chemin. Le pont transporte donc une **méthode logique** (`methodOverride`, `Resolver.ts:156`) que la
|
|
448
449
|
route doit déclarer **en plus** du transport — une route `POST` qui n'annonce pas `WEBSOCKET` reste
|
|
449
|
-
**injoignable** par socket (zéro contournement, `Route.ts:
|
|
450
|
+
**injoignable** par socket (zéro contournement, `Route.ts:852`).
|
|
450
451
|
|
|
451
452
|
Le routage par **message** (invoquer un chemin porté par une frame, sans toucher l'URL de la connexion)
|
|
452
453
|
passe par le même `resolve()`, avec un chemin fourni en argument — l'état partagé de la socket n'est
|
|
453
|
-
jamais muté (`Router.resolve()`, `router.ts:
|
|
454
|
+
jamais muté (`Router.resolve()`, `router.ts:313`). Détails côté socket :
|
|
454
455
|
[socket Nodefony](../../../../../docs/architecture/realtime-socket-nodefony.md).
|
|
455
456
|
|
|
456
457
|
## Vhosts — une route par domaine
|
|
457
458
|
|
|
458
459
|
`@Domain` restreint une méthode (ou tout un contrôleur) à un ou plusieurs noms d'hôte. Les motifs
|
|
459
460
|
acceptent l'exact (`"marseille.fr"`) et le joker d'un label (`"*.cdn.example.com"`), compilés une fois
|
|
460
|
-
au boot en expressions ancrées (`Route.compileHost()`, `Route.ts:
|
|
461
|
+
au boot en expressions ancrées (`Route.compileHost()`, `Route.ts:740`).
|
|
461
462
|
|
|
462
463
|
```ts ignore
|
|
463
464
|
@controller("/")
|
|
@@ -471,12 +472,12 @@ class MarseilleController extends Controller {
|
|
|
471
472
|
Précédence, du plus fort au plus faible : `@route({ host })` › `@Domain` sur la méthode › `@Domain` sur
|
|
472
473
|
la classe (`controller()`, `routerDecorators.ts:189`). Une route sans domaine est servie sur **tous** les
|
|
473
474
|
vhosts, et ne coûte rien au matching (`hostRegexp` absent → aucun test, `Route.matchHostname()`,
|
|
474
|
-
`Route.ts:
|
|
475
|
+
`Route.ts:754`).
|
|
475
476
|
|
|
476
477
|
> [!WARNING]
|
|
477
478
|
> `@Domain` déclare quels vhosts une route **sert** ; il ne remplace pas la barrière d'entrée. Un
|
|
478
479
|
> `Host` inconnu du serveur est rejeté en amont (421 Misdirected Request, `checkValidDomain()`,
|
|
479
|
-
> `http-kernel.ts:
|
|
480
|
+
> `http-kernel.ts:2140`) via la liste `trustedHosts` de `@nodefony/http`.
|
|
480
481
|
|
|
481
482
|
## Préfixes — contrôleur, module, data plane
|
|
482
483
|
|
|
@@ -484,12 +485,12 @@ Trois niveaux de préfixe coexistent, et un seul est à ta main.
|
|
|
484
485
|
|
|
485
486
|
1. **Le préfixe de contrôleur** — `@controller("/api/catalog")` est concaténé devant le chemin de
|
|
486
487
|
chaque route de la classe, puis le chemin est normalisé : les `//` sont réduits et le slash final
|
|
487
|
-
retiré (`Route.setPattern()`, `Route.ts:
|
|
488
|
+
retiré (`Route.setPattern()`, `Route.ts:715`). Un chemin vide (`@Get("")`) désigne donc le préfixe
|
|
488
489
|
lui-même.
|
|
489
490
|
2. **Le module propriétaire** — il n'ajoute **aucun** préfixe d'URL. `@controllers([…])` enregistre la
|
|
490
491
|
classe au boot et propage le nom du module sur les routes déjà créées, pour l'introspection et les
|
|
491
|
-
logs (`Router.setController()`, `router.ts:
|
|
492
|
-
contrôleurs homonymes sans collision : la clé du registre est `module:Classe` (`router.ts:
|
|
492
|
+
logs (`Router.setController()`, `router.ts:542`). Un module tiers et ton app peuvent porter deux
|
|
493
|
+
contrôleurs homonymes sans collision : la clé du registre est `module:Classe` (`router.ts:203`).
|
|
493
494
|
3. **Le data plane d'administration** — réservé, non négociable : `/nodefony/<namespace>/api/<endpoint>`
|
|
494
495
|
(`AdminBroker.resolvePath()`, `AdminBroker.ts:99`). Trois segments minimum, pour ne jamais entrer en
|
|
495
496
|
collision avec les routes de l'application ni avec la SPA de Studio.
|
|
@@ -508,10 +509,10 @@ d'une route — il survit à un changement de chemin.
|
|
|
508
509
|
| Besoin | Comment |
|
|
509
510
|
| ---------------------------------------- | ------------------------------------------------------------------------- |
|
|
510
511
|
| Retrouver une route par son nom | `router.getRoutes("ma-route")` → l'objet `Route` (`router.ts:326`) |
|
|
511
|
-
| Lister toutes les routes | `router.getRoutes("")` → la table complète (`router.ts:
|
|
512
|
-
| Savoir quelles routes couvrent un chemin | `router.matchRoutes("/api/x")` → les résultats de regex (`router.ts:
|
|
513
|
-
| Appeler une autre action, en interne | `this.forward("module:Controller:action")` (`Controller.ts:
|
|
514
|
-
| Retirer une route | `router.removeRoutes("ma-route")` (`router.ts:
|
|
512
|
+
| Lister toutes les routes | `router.getRoutes("")` → la table complète (`router.ts:495`) |
|
|
513
|
+
| Savoir quelles routes couvrent un chemin | `router.matchRoutes("/api/x")` → les résultats de regex (`router.ts:484`) |
|
|
514
|
+
| Appeler une autre action, en interne | `this.forward("module:Controller:action")` (`Controller.ts:744`) |
|
|
515
|
+
| Retirer une route | `router.removeRoutes("ma-route")` (`router.ts:504`) |
|
|
515
516
|
|
|
516
517
|
**Il n'existe pas de générateur d'URL inverse côté serveur** (pas de `path("ma-route", {id})` à la
|
|
517
518
|
Symfony). Le chemin déclaré est lisible sur l'objet `Route` (`route.path`), et la substitution des
|
|
@@ -521,7 +522,7 @@ chemin ; pour un appel interne, utilise `forward()`.
|
|
|
521
522
|
|
|
522
523
|
**`forward()` n'est pas une redirection** : il résout `module:Controller:action` et exécute l'action
|
|
523
524
|
dans le **même** contexte de requête, sans repasser par le réseau (`Resolver.parsePathernController()`,
|
|
524
|
-
`Resolver.ts:
|
|
525
|
+
`Resolver.ts:251`). Une vraie redirection HTTP passe par `this.redirect(url, 302)` ou `@Redirect`.
|
|
525
526
|
|
|
526
527
|
## 🧰 API publique
|
|
527
528
|
|
|
@@ -535,9 +536,9 @@ modules qui montent des routes dynamiquement). Signatures complètes : `.ai/symb
|
|
|
535
536
|
| `router.resolve(context)` | Le cœur : rend un `Resolver` (`resolve === true` si trouvé). |
|
|
536
537
|
| `router.getRoutes(nom)` · `removeRoutes()` | Introspection et démontage. |
|
|
537
538
|
| `Route#path` · `#variables` · `#pattern` | Ce que la route déclare, après compilation. |
|
|
538
|
-
| `Route#toObject()` · `#toLogLine()` | Sérialisation pour l'API admin · ligne de log lisible (`Route.ts:
|
|
539
|
+
| `Route#toObject()` · `#toLogLine()` | Sérialisation pour l'API admin · ligne de log lisible (`Route.ts:664`). |
|
|
539
540
|
| `Resolver#route` · `#variables` | Ce que la requête courante a matché. |
|
|
540
|
-
| `Resolver#getMatchedParams()` | Les variables en `nom → valeur` (`Resolver.ts:
|
|
541
|
+
| `Resolver#getMatchedParams()` | Les variables en `nom → valeur` (`Resolver.ts:204`). |
|
|
541
542
|
|
|
542
543
|
> [!CAUTION]
|
|
543
544
|
> **La table de routes est un état de processus, pas d'instance** : `Router.routes` est une liste
|
|
@@ -552,32 +553,32 @@ alloué par requête.
|
|
|
552
553
|
|
|
553
554
|
- **Compilation unique au montage** : motif d'URL, motifs de domaine, `Set` de méthodes en majuscules,
|
|
554
555
|
chaîne `Allow`, et regex des requirements par variable sont figés à la création de la route
|
|
555
|
-
(`Route.compileRequirements()`, `Route.ts:
|
|
556
|
+
(`Route.compileRequirements()`, `Route.ts:568`). Le matching ne fait plus que des lookups.
|
|
556
557
|
- **Un seul calcul de chemin par requête** : le `pathname` normalisé est calculé une fois puis passé à
|
|
557
558
|
chaque route scannée — sinon le getter `URL.pathname`, la regex de normalisation et l'allocation de
|
|
558
|
-
chaîne seraient refaits pour **chaque** route de la table (`Route.cleanPathname()`, `Route.ts:
|
|
559
|
+
chaîne seraient refaits pour **chaque** route de la table (`Route.cleanPathname()`, `Route.ts:355`).
|
|
559
560
|
- **Lookup O(1) pour les chemins littéraux**, scan pour les seuls chemins à motif — sans changer la
|
|
560
561
|
séquence de candidats (`buildRouteIndex()`, `router.ts:130`). L'index est invalidé par toute mutation
|
|
561
562
|
de la table, avec un garde-fou sur une photo `longueur/première/dernière` qui rattrape même les
|
|
562
563
|
mutations directes de la liste (`routeIndex`, `router.ts:127`).
|
|
563
564
|
- **Zéro journalisation en production** : le log « route trouvée » est promu au niveau NOTICE hors
|
|
564
565
|
production seulement, et le test est résolu une fois puis mémoïsé — en production, aucune chaîne
|
|
565
|
-
n'est même construite (`routeNoticePromoted`, `router.ts:
|
|
566
|
+
n'est même construite (`routeNoticePromoted`, `router.ts:395`).
|
|
566
567
|
- **Métadonnées d'action mémoïsées par route** au premier passage (`@HttpCode`, `@Header`, `@Redirect`,
|
|
567
568
|
paramètres, intention de session) : plus aucune lecture `Reflect` par requête
|
|
568
|
-
(`resolveActionMeta`, `Resolver.ts:
|
|
569
|
+
(`resolveActionMeta`, `Resolver.ts:462`).
|
|
569
570
|
|
|
570
571
|
## 📜 Normes appliquées
|
|
571
572
|
|
|
572
573
|
| Sujet | Norme | Où le code s'y conforme |
|
|
573
574
|
| ---------------------------------------- | ----------------- | --------------------------------------------------------------- |
|
|
574
575
|
| 405 + en-tête `Allow` agrégé | RFC 9110 §15.5.6 | passe 2 (`collectSupportedMethods()`, `router.ts:37`) |
|
|
575
|
-
| `HEAD` servi par toute route `GET` | RFC 9110 §9.1 | `Route.compileRequirements` (`Route.ts:
|
|
576
|
-
| Cible identifiée par l'URI, hôte compris | RFC 9110 §7.2 | hôte vérifié avant la méthode (`Route.match()`, `Route.ts:
|
|
577
|
-
| 403 sur ressource d'un autre vhost | RFC 9110 §15.5.4 | `Route.matchHostname()` (`Route.ts:
|
|
578
|
-
| 404 quand rien ne correspond | RFC 9110 §15.5.5 | après repli statique (`http-kernel.ts:
|
|
579
|
-
| 421 sur `Host` non servi | RFC 9110 §15.5.20 | `checkValidDomain()` (`http-kernel.ts:
|
|
580
|
-
| Erreur de sous-protocole WS = 1002 | RFC 6455 §7.4 | `Route.matchRequirements()` (`Route.ts:
|
|
576
|
+
| `HEAD` servi par toute route `GET` | RFC 9110 §9.1 | `Route.compileRequirements` (`Route.ts:568`) |
|
|
577
|
+
| Cible identifiée par l'URI, hôte compris | RFC 9110 §7.2 | hôte vérifié avant la méthode (`Route.match()`, `Route.ts:393`) |
|
|
578
|
+
| 403 sur ressource d'un autre vhost | RFC 9110 §15.5.4 | `Route.matchHostname()` (`Route.ts:754`) |
|
|
579
|
+
| 404 quand rien ne correspond | RFC 9110 §15.5.5 | après repli statique (`http-kernel.ts:700`) |
|
|
580
|
+
| 421 sur `Host` non servi | RFC 9110 §15.5.20 | `checkValidDomain()` (`http-kernel.ts:2140`) |
|
|
581
|
+
| Erreur de sous-protocole WS = 1002 | RFC 6455 §7.4 | `Route.matchRequirements()` (`Route.ts:816`) |
|
|
581
582
|
| Décodage pourcent des segments | RFC 3986 §2.1 | `decode()` (`Route.ts:79`) |
|
|
582
583
|
|
|
583
584
|
## 📡 Observabilité — Studio
|
|
@@ -595,7 +596,7 @@ La table de routes est introspectable en ligne, sans lire le code :
|
|
|
595
596
|
donc il n'est monté qu'en développement (`PlaygroundAdminApi.ts`).
|
|
596
597
|
|
|
597
598
|
Au boot, avec le debug actif, chaque route est aussi journalisée en une ligne
|
|
598
|
-
`[MÉTHODES] chemin → @module/Controller.action` (`Route.toLogLine()`, `Route.ts:
|
|
599
|
+
`[MÉTHODES] chemin → @module/Controller.action` (`Route.toLogLine()`, `Route.ts:664`).
|
|
599
600
|
|
|
600
601
|
## ⚠️ Pièges (symptôme → cause → correction)
|
|
601
602
|
|
|
@@ -604,7 +605,7 @@ Au boot, avec le debug actif, chaque route est aussi journalisée en une ligne
|
|
|
604
605
|
| --- | --- | --- |
|
|
605
606
|
| 404 sur toutes les routes d'un contrôleur | `@controller` évalué avant les `@route`/`@Get` de la classe | Placer `@controller` **au-dessus** de la classe, décorateurs de méthode dans la classe |
|
|
606
607
|
| 404 sur une route pourtant écrite | Le fichier du contrôleur n'est jamais importé — les routes naissent à l'import | Le déclarer dans `@controllers([…])` du module |
|
|
607
|
-
| `405`
|
|
608
|
+
| `405` sur un `POST` qui marchait | `method: "GET"` dans `@route` est **filtrant** : il est versé dans `requirements.methods` (`Route.ts`), `HEAD` reste servi avec `GET` | Déclarer toutes les méthodes servies : `method: ["GET", "POST"]` |
|
|
608
609
|
| Une route paramétrée avale un chemin littéral | Premier match dans l'ordre de déclaration, aucune spécificité | Déclarer le littéral **avant** le paramétré |
|
|
609
610
|
| `/files/*` ne répond pas sur `/files` | Le slash final est retiré avant le matching ; le motif exige `/files/` | Déclarer une seconde route pour le chemin nu |
|
|
610
611
|
| `{id}` ne capture pas `a/b` | Une variable vaut `[^/]+` — un seul segment, par construction | Utiliser un wildcard `*` si le `/` doit être capturé |
|
package/docs/templates.md
CHANGED
|
@@ -44,7 +44,7 @@ flowchart LR
|
|
|
44
44
|
Deux idées à retenir :
|
|
45
45
|
|
|
46
46
|
1. **Le contrôleur lit le fichier, le moteur ne fait que rendre une chaîne.** `renderView()` résout le
|
|
47
|
-
chemin, lit l'octet, puis passe la **source** à Eta (`Controller.renderView()`, `Controller.ts:
|
|
47
|
+
chemin, lit l'octet, puis passe la **source** à Eta (`Controller.renderView()`, `Controller.ts:556`).
|
|
48
48
|
Il n'y a **pas** de dossier `views/` magique connu du moteur.
|
|
49
49
|
2. **L'échappement est automatique.** Une donnée interpolée par `<%= %>` est neutralisée (`<` devient
|
|
50
50
|
`<`) avant d'entrer dans le HTML — c'est la protection XSS, active par défaut
|
|
@@ -187,7 +187,7 @@ curl -s 'http://localhost:5151/hello/%3Cb%3Ex%3C%2Fb%3E'
|
|
|
187
187
|
> [!TIP]
|
|
188
188
|
> Tu n'as écrit **aucun** appel d'envoi (`send`, `res.end`). `renderView()` produit le corps **et**
|
|
189
189
|
> l'envoie. Pour piloter l'envoi toi-même, retourne plutôt une chaîne via `render()`
|
|
190
|
-
> (`Controller.render()`, `Controller.ts:
|
|
190
|
+
> (`Controller.render()`, `Controller.ts:499`).
|
|
191
191
|
|
|
192
192
|
## 🏗️ Architecture interne — le parcours d'un `renderView()`
|
|
193
193
|
|
|
@@ -218,15 +218,15 @@ sequenceDiagram
|
|
|
218
218
|
|
|
219
219
|
| # | Étape | Où |
|
|
220
220
|
| --- | -------------------------------------------- | ------------------------------------------------------------- |
|
|
221
|
-
| 1 | Résolution + lecture async du fichier | `FileClass` dans `renderView()` (`Controller.ts:
|
|
222
|
-
| 2 | Ouverture de la phase mesurée `render` | `phaseStart("render")` (`Controller.ts:
|
|
223
|
-
| 3 | Injection des aides frontend dans les locals | `withFrontendLocals()` (`Controller.ts:
|
|
221
|
+
| 1 | Résolution + lecture async du fichier | `FileClass` dans `renderView()` (`Controller.ts:556`) |
|
|
222
|
+
| 2 | Ouverture de la phase mesurée `render` | `phaseStart("render")` (`Controller.ts:509`) |
|
|
223
|
+
| 3 | Injection des aides frontend dans les locals | `withFrontendLocals()` (`Controller.ts:594`) |
|
|
224
224
|
| 4 | Rendu de la source par le moteur | `Eta.render()` → `renderStringAsync` (`Eta.ts:51`) |
|
|
225
|
-
| 5 | `Content-Type: text/html` puis envoi | `setContextHtml()` + `renderResponse()` (`Controller.ts:
|
|
225
|
+
| 5 | `Content-Type: text/html` puis envoi | `setContextHtml()` + `renderResponse()` (`Controller.ts:535`) |
|
|
226
226
|
|
|
227
227
|
Le point notable de l'étape 3 : `withFrontendLocals()` ajoute automatiquement `frontendTags`,
|
|
228
228
|
`frontendDocument` et `asset` aux locals **si** le service `frontend` est présent — et **tes** valeurs
|
|
229
|
-
priment (spread `param` en dernier, `Controller.ts:
|
|
229
|
+
priment (spread `param` en dernier, `Controller.ts:558`). Si le module frontend n'est pas chargé, la
|
|
230
230
|
fonction retourne les locals inchangés : zéro couplage dur.
|
|
231
231
|
|
|
232
232
|
## 🔐 Sécurité — échappement HTML et XSS
|
|
@@ -269,8 +269,8 @@ scaffold). Les deux sont **asynchrones** (I/O non bloquante).
|
|
|
269
269
|
| Helper | Pour… | Ancre |
|
|
270
270
|
| ----------------------------------- | ------------------------------------------------------- | ------------------- |
|
|
271
271
|
| `renderView(path, locals, status?)` | Rendre une vue `.eta` (lit le fichier + aides frontend) | `Controller.ts:524` |
|
|
272
|
-
| `render(data, encoding?, status?)` | Envoyer un corps quelconque (ex. HTML déjà prêt) | `Controller.ts:
|
|
273
|
-
| `renderJson(obj, status?)` | Réponse JSON explicite (pas un template) | `Controller.ts:
|
|
272
|
+
| `render(data, encoding?, status?)` | Envoyer un corps quelconque (ex. HTML déjà prêt) | `Controller.ts:499` |
|
|
273
|
+
| `renderJson(obj, status?)` | Réponse JSON explicite (pas un template) | `Controller.ts:631` |
|
|
274
274
|
|
|
275
275
|
Les signatures exactes vivent dans le graphe symbolique `.ai/symbols.json` — jamais recopiées ici.
|
|
276
276
|
|
|
@@ -309,7 +309,7 @@ c'est le différenciateur Nodefony : une classe, deux transports, le même moteu
|
|
|
309
309
|
| Domaine | Norme / référence | Comment le code s'y conforme |
|
|
310
310
|
| ------------------ | ----------------------- | --------------------------------------------------------------------- |
|
|
311
311
|
| Neutralisation XSS | OWASP — Output Encoding | échappement HTML par défaut (`autoEscape`, `Eta.ts:16`) |
|
|
312
|
-
| Type de média HTML | `text/html` | posé par `setContextHtml()` dans `renderView()` (`Controller.ts:
|
|
312
|
+
| Type de média HTML | `text/html` | posé par `setContextHtml()` dans `renderView()` (`Controller.ts:556`) |
|
|
313
313
|
| I/O non bloquante | Node.js async fs | lecture async du fichier (`readFile`, `Eta.ts:71`) |
|
|
314
314
|
|
|
315
315
|
## ⚡ Performance et mémoire
|
|
@@ -324,7 +324,7 @@ template), et le framework l'isole pour ça :
|
|
|
324
324
|
`Template.ts:20`) ; le coût de parsing n'est payé qu'au premier rendu.
|
|
325
325
|
- **Lecture non bloquante** : le fichier est lu en async (`FileClass.readAsync()` côté `renderView`,
|
|
326
326
|
`readFile` côté `renderFile`, `Eta.ts:66`) — l'event loop n'est jamais gelé par un `readFileSync`.
|
|
327
|
-
- **Aides frontend paresseuses** : `withFrontendLocals()` (`Controller.ts:
|
|
327
|
+
- **Aides frontend paresseuses** : `withFrontendLocals()` (`Controller.ts:594`) ne construit les
|
|
328
328
|
fonctions `frontendTags`/`asset` que si le service `frontend` répond — sinon il rend les locals tels
|
|
329
329
|
quels, zéro allocation superflue.
|
|
330
330
|
|
|
@@ -344,7 +344,7 @@ template), et le framework l'isole pour ça :
|
|
|
344
344
|
| `<%= it.name %>` requis alors qu'on attend `<%= name %>` | `useWith` mal compris — Nodefony l'active (`Eta.ts:17`), les locals sont nus | Écrire `<%= name %>` directement |
|
|
345
345
|
| Modif de template ignorée en prod | `cache: true` en production (`Template.ts:20`) | Redémarrer le pod ; en dev le cache est off, recompile à chaud |
|
|
346
346
|
| La réponse d'erreur n'est pas ma vue Eta | Les erreurs rendent du JSON, pas un template (`error-renderer.ts:109`) | Pour une page d'erreur HTML, rendre explicitement une vue dans un handler |
|
|
347
|
-
| `renderView()` rejette et logge une ERROR | Fichier introuvable ou template invalide (le `catch` re-lève, `Controller.ts:
|
|
347
|
+
| `renderView()` rejette et logge une ERROR | Fichier introuvable ou template invalide (le `catch` re-lève, `Controller.ts:544`) | Vérifier le chemin résolu (`resolve(module.path, …)`) |
|
|
348
348
|
|
|
349
349
|
## 🧪 Tests et couverture
|
|
350
350
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nodefony/framework",
|
|
3
|
-
"version": "10.0.0-beta.
|
|
3
|
+
"version": "10.0.0-beta.3",
|
|
4
4
|
"description": "Le modèle de programmation Nodefony : routeur, contrôleurs, décorateurs et vues — HTTP et WebSocket dans le même contexte",
|
|
5
5
|
"author": "Christophe CAMENSULI <ccamensuli@gmail.com>",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -44,30 +44,29 @@
|
|
|
44
44
|
"directory": "src/packages/@nodefony/framework"
|
|
45
45
|
},
|
|
46
46
|
"dependencies": {
|
|
47
|
-
"@graphql-tools/merge": "9.2.
|
|
48
|
-
"@graphql-tools/schema": "10.1.
|
|
47
|
+
"@graphql-tools/merge": "9.2.7",
|
|
48
|
+
"@graphql-tools/schema": "10.1.4",
|
|
49
49
|
"eta": "4.6.0",
|
|
50
50
|
"graphql": "17.0.2",
|
|
51
51
|
"reflect-metadata": "0.2.2",
|
|
52
52
|
"tslib": "2.8.1"
|
|
53
53
|
},
|
|
54
54
|
"devDependencies": {
|
|
55
|
-
"@nodefony/http": "^10.0.0-beta.
|
|
55
|
+
"@nodefony/http": "^10.0.0-beta.3",
|
|
56
56
|
"@types/chai": "5.2.3",
|
|
57
|
-
"@types/node": "26.6.
|
|
58
|
-
"@vitest/coverage-v8": "5.0.
|
|
59
|
-
"
|
|
60
|
-
"nodefony": "^10.0.0-beta.1",
|
|
57
|
+
"@types/node": "26.6.5",
|
|
58
|
+
"@vitest/coverage-v8": "5.0.4",
|
|
59
|
+
"nodefony": "^10.0.0-beta.3",
|
|
61
60
|
"tsx": "4.23.15",
|
|
62
|
-
"vitest": "5.0.
|
|
61
|
+
"vitest": "5.0.4"
|
|
63
62
|
},
|
|
64
63
|
"license": "Apache-2.0",
|
|
65
64
|
"readmeFilename": "README.md",
|
|
66
65
|
"contributors": [],
|
|
67
66
|
"peerDependencies": {
|
|
68
|
-
"@nodefony/http": "^10.0.0-beta.
|
|
69
|
-
"nodefony": "^10.0.0-beta.
|
|
70
|
-
"zod": "^4.6.
|
|
67
|
+
"@nodefony/http": "^10.0.0-beta.3",
|
|
68
|
+
"nodefony": "^10.0.0-beta.3",
|
|
69
|
+
"zod": "^4.6.7"
|
|
71
70
|
},
|
|
72
71
|
"files": [
|
|
73
72
|
"dist",
|