fulmine.js 5.5.1 → 5.5.2

package/README.md

@@ -26,12 +26,6 @@ npx fulmine profile             # what listen() decided about each route
 
 See [Migrating](#migrating) for what it handles and what it deliberately does not.
 
-There is a **[live demo](https://fulmine-demo.fly.dev)**, which is an ordinary Express application:
-real routes, `helmet`, `cors`, `compression`, `express-session` and `morgan` unmodified, and a
-WebSocket chat served by `app.ws()`. It links to [its own source](https://fulmine-demo.fly.dev/source),
-which is [in this repository](./demo). It shows no throughput figure on purpose: it runs on a small
-shared machine, so the number would describe the machine rather than the framework.
-
 [![npm version](https://img.shields.io/npm/v/fulmine.js)](https://www.npmjs.com/package/fulmine.js)
 [![Node.js >= 22.0.0](https://img.shields.io/badge/Node.js-%3E=22.0.0-green)](https://nodejs.org)
 [![Coverage Status](https://coveralls.io/repos/github/nigrosimone/fulmine.js/badge.svg?branch=main)](https://coveralls.io/github/nigrosimone/fulmine.js?branch=main)
@@ -230,6 +224,7 @@ A single-stage `node:26-trixie-slim` image works too if you `apt-get install -y
 - `app.listen()` returns the app, not an `http.Server`. There is no node server underneath, so `server.close()`, `server.address()` and anything that attaches itself to a real `http.Server` need a look. `app.close()`, `app.address()` and `app.listening` are there and do what you would expect.
 - `x-powered-by` is disabled by default. Express sends `X-Powered-By: Express` unless you turn it off; Fulmine does not send it unless you turn it on with `app.set("x-powered-by", true)`. The header only tells anyone asking which framework is running.
 - request body is only read for POST, PUT, PATCH and QUERY requests by default. You can add additional methods by setting `body methods` to array with uppercased methods.
+- **Informational responses go nowhere.** `res.writeEarlyHints()`, `res.writeContinue()` and `res.writeProcessing()` are all there, take what node's take and throw what node's throw once the head has gone out, but nothing reaches the wire: µWebSockets.js has no API for a `1xx`. They exist so that code written for Express keeps running rather than dying on "is not a function", which is the only thing a drop-in can honestly promise here. `res.addTrailers()` is the same story, and `res.setTimeout()` and `req.setTimeout()` register the listener without changing anything, since µWS runs its own idle timeout through `uwsOptions.idleTimeout`.
 - For HTTPS, instead of doing this:
 
 ```js

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "fulmine.js",
-    "version": "5.5.1",
+    "version": "5.5.2",
     "description": "Drop-in Express 5 replacement on uWebSockets.js. Your existing middleware keeps working.",
     "main": "src/index.js",
     "bin": {

package/src/application.js

@@ -500,31 +500,16 @@ class Application extends Router {
      * @param {any} res the uWS response
      * @param {any} req the uWS request
      */
-    async _serveGeneric(res, req) {
+    _serveGeneric(res, req) {
         const request = this.handleRequest(res, req);
         const response = request.res;
-        // armed up front here: this handler awaits, so the response outlives the callback
-        // on every path through it
+        // armed up front here: this handler can outlive the callback on every path through it
         this._armAbort(res, response);
 
-        try {
-            const routed = this._routeRequest(request, response);
-            // dispatch has run its synchronous stretch inside _routeRequest by now, still
-            // under the cork uWS holds for this callback; the await below leaves it
-            response._corkNeeded = true;
-            const matchedRoute = await routed;
-            if (!matchedRoute && !response.headersSent && !response.aborted) {
-                this._endUnmatched(request, response);
-            }
-        } catch (err) {
-            // an internal throw answers 500 as express's final handler would, instead of
-            // dying as an unhandled rejection
-            if (response.aborted || response.finished) {
-                console.error(err);
-            } else {
-                this._handleError(err, null, request, response);
-            }
-        }
+        this._routeRequestDirect(request, response);
+        // the synchronous stretch has run under the cork uWS holds for this callback, and
+        // whatever comes after it is outside
+        response._corkNeeded = true;
     }
 
     /**

package/src/request.js

@@ -756,10 +756,6 @@ module.exports = class Request extends LazyReadable {
      * @param {() => void} [callback]
      * @returns {this}
      */
-
-    /**
-     *
-     */
     setTimeout(msecs, callback) {
         if (typeof callback === "function") {
             this.once("timeout", callback);

package/src/response.js

@@ -228,9 +228,10 @@ module.exports = class Response extends LazyWritable {
      * measured on uWS alone, 500 writes of 66 bytes take 13ms against 0.06ms for 100 of them.
      * Handing it the same bytes in blocks costs 0.4ms. Nothing here changes what goes on the wire,
      * only how many calls it takes to put it there.
-     * @type {Buffer[]}
+     * Null until the first chunked write, since a res.send never queues anything.
+     * @type {Buffer[]|null}
      */
-    #queued = [];
+    #queued = null;
 
     /** How many bytes {@link #queued} holds, kept alongside so the flush does not add them up. */
     #queuedBytes = 0;
@@ -437,12 +438,12 @@ module.exports = class Response extends LazyWritable {
      * @param {((err?: Error|null) => void)|null} callback the stream's, when there is one waiting
      */
     #flushQueued(callback) {
-        if (this.#queuedBytes === 0) {
+        if (this.#queued === null || this.#queuedBytes === 0) {
             if (callback) callback(null);
             return;
         }
         const body = this.#queued.length === 1 ? this.#queued[0] : Buffer.concat(this.#queued, this.#queuedBytes);
-        this.#queued = [];
+        this.#queued = null;
         this.#queuedBytes = 0;
 
         const ok = this._res.write(body);
@@ -467,13 +468,16 @@ module.exports = class Response extends LazyWritable {
     }
 
     /**
-     * The booked flush. An arrow so it can be handed to nextTick without binding it every write.
+     * The booked flush. Static, so a response that never writes in pieces allocates nothing for it:
+     * nextTick forwards the receiver as an argument.
+     *
+     * @param {any} res
      */
-    #flushOnTick = () => {
-        this.#flushBooked = false;
-        if (this.aborted || this.finished || this.#queuedBytes === 0) return;
-        this._res.cork(() => this.#flushQueued(null));
-    };
+    static #flushOnTick(res) {
+        res.#flushBooked = false;
+        if (res.aborted || res.finished || res.#queuedBytes === 0) return;
+        res._res.cork(() => res.#flushQueued(null));
+    }
 
     /**
      * Writable's sink. Sends the headers if they have not gone yet, then hands the chunk to uWS,
@@ -520,7 +524,7 @@ module.exports = class Response extends LazyWritable {
                 // turn or once it is big enough to be worth a call. A stream that writes once per
                 // turn, an SSE feed for instance, still leaves on its own turn: the queue only ever
                 // gathers what was written without yielding in between.
-                this.#queued.push(/** @type {Buffer} */ (chunk));
+                (this.#queued ??= []).push(/** @type {Buffer} */ (chunk));
                 this.#queuedBytes += /** @type {Buffer} */ (chunk).byteLength;
                 // a chunk that is already big enough to be worth its own call leaves with whatever
                 // was waiting in front of it, rather than paying for a copy it does not need
@@ -529,7 +533,7 @@ module.exports = class Response extends LazyWritable {
                 } else {
                     if (!this.#flushBooked) {
                         this.#flushBooked = true;
-                        process.nextTick(this.#flushOnTick);
+                        process.nextTick(Response.#flushOnTick, this);
                     }
                     this.writingChunk = false;
                     callback(null);
@@ -1329,11 +1333,16 @@ module.exports = class Response extends LazyWritable {
     }
 
     /**
-     * Sends the status line and the headers now, without waiting for a body, which is node's
+     * Hands the status line and the headers over now, without waiting for a body, which is node's
      * flushHeaders(). Callers use it to let the client start on the head while the body is still
      * being produced, and one of them is `@angular/ssr`'s writeResponseToNodeResponse, which calls
      * it before streaming a rendered page.
      *
+     * **The head does not reach the wire here.** uWS holds it until the first body chunk, so a
+     * client sees nothing until then, where express answers at once. `beginWrite` is uWS's API for
+     * this and is unusable: it emits a stray CRLF before the first chunk size, which node's parser
+     * rejects as HPE_INVALID_CHUNK_SIZE. Checked against v20.69.0, the latest release.
+     *
      * A second call does nothing, as node's does. Nothing is written for a response already
      * finished or aborted: uWS has let go of it by then.
      *
@@ -1425,10 +1434,6 @@ module.exports = class Response extends LazyWritable {
      * @param {Record<string, string>|[string, string][]} [headers]
      * @returns {void}
      */
-
-    /**
-     *
-     */
     addTrailers(headers) {}
 
     /**
@@ -1440,10 +1445,6 @@ module.exports = class Response extends LazyWritable {
      * @param {() => void} [callback]
      * @returns {this}
      */
-
-    /**
-     *
-     */
     setTimeout(msecs, callback) {
         if (typeof callback === "function") {
             this.once("timeout", callback);
@@ -1458,20 +1459,12 @@ module.exports = class Response extends LazyWritable {
      * @param {any} [socket]
      * @returns {void}
      */
-
-    /**
-     *
-     */
     assignSocket(socket) {}
 
     /**
      * @param {any} [socket]
      * @returns {void}
      */
-
-    /**
-     *
-     */
     detachSocket(socket) {}
 
     /**
@@ -2005,12 +1998,6 @@ module.exports = class Response extends LazyWritable {
         return this.set("content-type", ct);
     }
 
-    /**
-     * express carries both names for the same method, and middleware reaches for either.
-     * @type {(type: string) => any}
-     */
-    contentType = this.type;
-
     /**
      * Adds a field to Vary, without repeating one already there.
      * @param {string|string[]} field
@@ -2040,3 +2027,7 @@ module.exports = class Response extends LazyWritable {
         return this.finished;
     }
 };
+
+// res.contentType is res.type under express's other name. On the prototype rather than an instance
+// field, which wrote one own property per response in the constructor.
+/** @type {any} */ (module.exports.prototype).contentType = module.exports.prototype.type;

package/src/router.js

@@ -446,7 +446,7 @@ class Walk {
             return this.step(undefined);
         }
         if (kind === CALLBACK_ROUTER) {
-            if (callback.constructor.name === "Application") {
+            if (callback._isApplication) {
                 rememberApp(this, route, req);
                 useApp(req, callback);
             }
@@ -616,10 +616,15 @@ function nativeFail(err) {
  * @returns {number}
  */
 function mountPrefixLength(route, req) {
-    const path = req._opPath;
+    // a use with no path is EMPTY_REGEX, which matches "" at 0 whatever the path is. Answered
+    // without the exec, since this runs per hop and most middleware is pathless
+    if (route.pattern === EMPTY_REGEX) {
+        return 0;
+    }
     if (typeof route.pattern === "string") {
         return route.pattern.length;
     }
+    const path = req._opPath;
     const matched = route.pattern.exec(path === "" ? "/" : path);
     return matched ? Math.min(matched[0].length, path.length) : 0;
 }
@@ -1057,7 +1062,7 @@ function guardsInside(router, mount, pathPrefix, chain, inherited) {
  * @param {any} req
  */
 function rememberApp(walk, route, req) {
-    if (walk.router._isApplication && route.callbacks[0]?.constructor.name === "Application") {
+    if (walk.router._isApplication && route.callbacks[0]?._isApplication) {
         (req._appStack ??= []).push(route, req.app);
     }
 }
@@ -2536,6 +2541,24 @@ module.exports = class Router extends EventEmitter {
         });
     }
 
+    /**
+     * The same walk without the promise pair, for a uWS handler that never awaited it. nativeDone
+     * and nativeFail defer their epilogues to the microtask the await used to resume on, so the
+     * visible order holds.
+     *
+     * @param {any} req
+     * @param {any} res
+     */
+    _routeRequestDirect(req, res) {
+        const walk = new Walk(this, req, res, this._routes, false, undefined, nativeDone, nativeFail);
+        try {
+            walk.dispatch(0);
+        } catch (err) {
+            // what a throw inside a promise executor did: reject, once
+            nativeFail.call(walk, err);
+        }
+    }
+
     /**
      * Mounts middleware, or a whole router, at a path. The path is optional, and a mount matches
      * everything under it, which is what separates it from all(). Mounting a Router sets its

package/src/utils.js

@@ -1102,6 +1102,11 @@ function createETagGenerator(options) {
         if (body instanceof Stats) {
             return statTag(body, options.weak);
         }
+        // crypto.hash reads a string as the utf8 bytes Buffer.from would have produced, so the tag
+        // is the same one without copying the whole body first
+        if (typeof body === "string" && (encoding === undefined || encoding === "utf8" || encoding === "utf-8")) {
+            return entityTag(body, options.weak);
+        }
         const buf = !Buffer.isBuffer(body) ? Buffer.from(body, encoding) : body;
         return entityTag(buf, options.weak);
     };