fulmine.js 5.20.0 → 5.21.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "fulmine.js",
-    "version": "5.20.0",
+    "version": "5.21.0",
     "description": "Drop-in Express 5 replacement on uWebSockets.js, up to 20x faster. Same API, your middleware and framework keep working.",
     "main": "src/index.js",
     "exports": {

package/src/cli.js

@@ -107,10 +107,11 @@ const DIFFERENCES = [
     [
         "a compiled route keeps its connection header",
         "A handler simple enough to be read at registration time is answered natively, and a client\n" +
-            "that sent Connection: close is still told keep-alive, though the socket does close. A body\n" +
-            "with a piece of the query in it is framed chunked, since its length is not known until the\n" +
-            "request arrives. A response that would carry a validator is never compiled, so conditional\n" +
-            'requests behave as on Express. app.set("declarative responses", false) turns it off.'
+            "that sent Connection: close is still told keep-alive, though the socket does close. A\n" +
+            "response that would carry a validator is never compiled, so conditional requests behave as\n" +
+            'on Express. app.set("declarative responses", false) turns it off. A body with a piece of\n' +
+            'the query or a route parameter in it is compiled only under app.set("declarative request\n' +
+            'values", true), which takes the value as uWS reads it: undecoded, the first one, or none.'
     ],
     [
         "headers are capped at 4096 bytes by default",

package/src/declarative.js

@@ -818,6 +818,12 @@ module.exports = function compileDeclarative(cb, app) {
         }
         const { sendUsed, bodyFromSend } = read;
 
+        // a part copied out of the request is written by uWS with its own reading of it, so the
+        // route is compiled only where the application asked for that
+        if (!app.get("declarative request values") && body.some((part) => part.type !== "text")) {
+            return false;
+        }
+
         // a handler that never sends is not a response: Express leaves the request waiting, so this
         // has to fall back instead of answering a bare 200
         if (!sendUsed && !sendStatusUsed) {

package/src/optimizer.js

@@ -558,8 +558,9 @@ function registerUwsRoute(router, route, optimizedPath) {
         route.paramCallbacks.size === 0 && // a param callback has to run, and this answers without running anything
         // a captured value is decoded when the route runs, and one that cannot be decoded is a
         // 400 in express and on the ordinary path here. Nothing runs to raise it on a
-        // declarative response, so GET /a-b%5Ec@d%e came back 200 from app.get("/:p12")
-        route.optimizedParams === undefined &&
+        // declarative response, so GET /a-b%5Ec@d%e came back 200 from app.get("/:p12").
+        // "declarative request values" is the application accepting that
+        (route.optimizedParams === undefined || router.get("declarative request values")) &&
         // a declarative response is answered by µWS itself, so no javascript runs and the case
         // guard could not: a route that needs one has to stay an ordinary handler
         caseGuards === null &&

package/src/testing.js

@@ -187,8 +187,11 @@ function whyNotCompiled(app, entry) {
     if (!app.get("declarative responses")) {
         return "answered by µWS, but declarative responses are turned off";
     }
-    if (entry.path.includes(":")) {
-        return "answered by µWS, but the route captures, and nothing runs to decode the value";
+    if (entry.path.includes(":") && !app.get("declarative request values")) {
+        return (
+            "answered by µWS, but the route captures, and nothing runs to decode the value: " +
+            'app.set("declarative request values", true) is what puts a route here'
+        );
     }
     if (app.get("etag")) {
         return (

package/src/utils.js

@@ -1028,6 +1028,11 @@ const defaultSettings = {
     // The native µWS router matches bytes, so the compiler in _compileOptimizedRoutes only hands
     // it routes whose earlier siblings it can prove agree under either case rule.
     "declarative responses": true,
+    // off: a compiled body copies nothing out of the request. On, res.send(req.query.q) and
+    // res.send(req.params.id) compile too, written by uWS as it reads them and not as Express
+    // does: a query key repeated or missing gives the first value or nothing, a route parameter
+    // goes out undecoded, and one that Express refuses with a 400 is answered
+    "declarative request values": false,
     // on. Off hands every request to the ordinary chain instead of letting uWS match what it can,
     // which is slower and answers the same. Not a tuning knob: it exists so one application can be
     // served both ways and the answers compared, see `npm run fuzz -- --self`. A compiled response