ultimate-express 1.2.0 → 1.2.2

package/README.md

@@ -16,7 +16,7 @@ To make sure µExpress matches behavior of Express in all cases, we run all test
 
 Similar projects based on uWebSockets:
 
-- `express` on Bun - since Bun uses uWS for its HTTP module, Express is about 2.5 times faster than on Node.js with 27k req/sec instead of 10k req/sec normally, but still slower than µExpress at 70k req/sec because it doesn't do uWS-specific optimizations.
+- `express` on Bun - since Bun uses uWS for its HTTP module, Express is about 2-3 times faster than on Node.js, but still slower than µExpress because it doesn't do uWS-specific optimizations.
 - `hyper-express` - while having a similar API to Express, it's very far from being a drop-in replacement, and implements most of the functionality differently. This creates a lot of random quirks and issues, making the switch quite difficult. Built in middlewares are also very different.
 - `uwebsockets-express` - this library is closer to being a drop-in replacement, but misses a lot of APIs, depends on Express by calling it's methods under the hood and doesn't try to optimize routing by using native uWS router.
 
@@ -24,6 +24,8 @@ Similar projects based on uWebSockets:
 
 Tested using [wrk](https://github.com/wg/wrk) (`-d 60 -t 1 -c 200`). Etag was disabled in both Express and µExpress. Tested on Ubuntu 22.04, Node.js 20.17.0, AMD Ryzen 5 3600, 64GB RAM.
 
+### Test results
+
 | Test                                          | Express req/sec | µExpress req/sec | Express throughput | µExpress throughput | µExpress speedup |
 | --------------------------------------------- | --------------- | ---------------- | ------------------ | ------------------- | ---------------- |
 | routing/simple-routes (/)                     | 10.90k          | 70.10k           | 2.04 MB/sec        | 11.57 MB/sec        | **6.43X**        |
@@ -34,6 +36,30 @@ Tested using [wrk](https://github.com/wg/wrk) (`-d 60 -t 1 -c 200`). Etag was di
 | engines/ejs (/test)                           | 5.92k           | 41.64k           | 2.40 MB/sec        | 16.55 MB/sec        | **7.03X**        |
 | middlewares/body-urlencoded (/abc)            | 7.90k           | 29.90k           | 1.64 MB/sec        | 5.36 MB/sec         | **3.78X**        |
 
+### Performance against other frameworks
+
+Tested using [bun-http-framework-benchmark](https://github.com/dimdenGD/bun-http-framework-benchmark)  
+
+|  Framework       | Runtime | Average | Ping       | Query      | Body       |
+| ---------------- | ------- | ------- | ---------- | ---------- | ---------- |
+| uws | node | 94,296.49 | 108,551.92 | 104,756.22 | 69,581.33 |
+| bun | bun | 74,824.52 | 85,839.42 | 74,668.88 | 63,965.26 |
+| elysia | bun | 72,112.447 | 82,589.71 | 69,356.08 | 64,391.55 |
+| hyper-express | node | 66,356.707 | 80,002.53 | 69,953.76 | 49,113.83 |
+| hono | bun | 63,944.627 | 74,550.47 | 62,810.28 | 54,473.13 |
+| **ultimate-express** | **node** | **44,081.737** | **51,753.24** | **48,389.84** | **32,102.13** |
+| oak | deno | 40,878.467 | 68,429.24 | 28,541.99 | 25,664.17 |
+| express | bun | 35,937.977 | 41,329.97 | 34,339.79 | 32,144.17 |
+| h3 | node | 35,423.263 | 41,243.68 | 34,429.26 | 30,596.85 |
+| fastify | node | 33,094.62 | 40,147.67 | 40,076.35 | 19,059.84 |
+| oak | bun | 32,705.36 | 35,856.59 | 32,116.4 | 30,143.09 |
+| hono | node | 26,576.02 | 36,215.35 | 34,656.12 | 8,856.59 |
+| acorn | deno | 24,476.67 | 29,690.42 | 22,254.82 | 21,484.77 |
+| koa | node | 24,045.08 | 28,202.12 | 24,590.84 | 19,342.28 |
+| express | node | 10,411.313 | 11,245.57 | 10,598.74 | 9,389.63 |
+
+### Performance on real-world application
+
 Also tested on a [real-world application](https://nekoweb.org) with templates, static files and dynamic pages with data from database, and showed 1.5-4X speedup in requests per second depending on the page.
 
 ## Differences from Express

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultimate-express",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "The Ultimate Express. Fastest http server with full Express compatibility, based on uWebSockets.",
   "main": "src/index.js",
   "scripts": {

package/src/application.js

@@ -178,23 +178,12 @@ class Application extends Router {
 
     #createRequestHandler() {
         this.uwsApp.any('/*', async (res, req) => {
-            const request = new this._request(req, res, this);
-            const response = new this._response(res, request, this);
-            request.res = response;
-            response.req = request;
-            
-            res.onAborted(() => {
-                const err = new Error('Request aborted');
-                err.code = 'ECONNABORTED';
-                response.aborted = true;
-                response.socket.emit('error', err);
-            });
-
-            let matchedRoute = await this._routeRequest(request, response);
+            const { request, response } = this.handleRequest(res, req);
 
-            if(!matchedRoute && !res.aborted && !response.headersSent) {
+            const matchedRoute = await this._routeRequest(request, response);
+            if(!matchedRoute && !response.headersSent && !response.aborted) {
                 response.status(404);
-                response.send(this._generateErrorPage(`Cannot ${request.method} ${request.path}`));
+                response.send(this._generateErrorPage(`Cannot ${request.method} ${request.path}`, false));
             }
         });
     }

package/src/router.js

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-const { patternToRegex, needsConversionToRegex, deprecated, findIndexStartingFrom } = require("./utils.js");
+const { patternToRegex, needsConversionToRegex, deprecated, findIndexStartingFrom, canBeOptimized } = require("./utils.js");
 const Response = require("./response.js");
 const Request = require("./request.js");
 const { EventEmitter } = require("tseep");
@@ -138,7 +138,7 @@ module.exports = class Router extends EventEmitter {
             };
             routes.push(route);
             // normal routes optimization
-            if(typeof route.pattern === 'string' && route.pattern !== '/*' && !this.parent && this.get('case sensitive routing') && this.uwsApp) {
+            if(canBeOptimized(route.path) && route.pattern !== '/*' && !this.parent && this.get('case sensitive routing') && this.uwsApp) {
                 if(supportedUwsMethods.includes(method)) {
                     const optimizedPath = this.#optimizeRoute(route, this._routes);
                     if(optimizedPath) {
@@ -185,7 +185,8 @@ module.exports = class Router extends EventEmitter {
                                             this.#registerUwsRoute({
                                                 ...cbroute,
                                                 path: route.path + cbroute.path,
-                                                pattern: route.path + cbroute.path
+                                                pattern: route.path + cbroute.path,
+                                                optimizedRouter: true
                                             }, optimizedPath);
                                         }
                                     }
@@ -239,6 +240,21 @@ module.exports = class Router extends EventEmitter {
         return optimizedPath;
     }
 
+    handleRequest(res, req) {
+        const request = new this._request(req, res, this);
+        const response = new this._response(res, request, this);
+        request.res = response;
+        response.req = request;
+        res.onAborted(() => {
+            const err = new Error('Connection closed');
+            err.code = 'ECONNRESET';
+            response.aborted = true;
+            response.socket.emit('error', err);
+        });
+
+        return { request, response };
+    }
+
     #registerUwsRoute(route, optimizedPath) {
         let method = route.method.toLowerCase();
         if(method === 'all') {
@@ -246,35 +262,34 @@ module.exports = class Router extends EventEmitter {
         } else if(method === 'delete') {
             method = 'del';
         }
+        if(!route.optimizedRouter && route.path.includes(":")) {
+            route.optimizedParams = route.path.match(/:(\w+)/g).map(p => p.slice(1));
+        }
         const fn = async (res, req) => {
-            const request = new this._request(req, res, this);
-            const response = new this._response(res, request, this);
-            request.res = response;
-            response.req = request;
-            res.onAborted(() => {
-                const err = new Error('Connection closed');
-                err.code = 'ECONNRESET';
-                response.aborted = true;
-                response.socket.emit('error', err);
-            });
-
-            const routed = await this._routeRequest(request, response, 0, optimizedPath, true, route);
-            if(routed) {
-                return;
+            const { request, response } = this.handleRequest(res, req);
+            if(route.optimizedParams) {
+                request.optimizedParams = {};
+                for(let i = 0; i < route.optimizedParams.length; i++) {
+                    request.optimizedParams[route.optimizedParams[i]] = req.getParameter(i);
+                }
+            }
+            const matchedRoute = await this._routeRequest(request, response, 0, optimizedPath, true, route);
+            if(!matchedRoute && !response.headersSent && !response.aborted) {
+                response.status(404);
+                response.send(this._generateErrorPage(`Cannot ${request.method} ${request.path}`, false));
             }
-            response.status(404);
-            response.send(this._generateErrorPage(`Cannot ${request.method} ${request.path}`, false));
         };
         route.optimizedPath = optimizedPath;
-        this.uwsApp[method](route.path, fn);
+        let replacedPath = route.path.replace(/:(\w+)/g, ':x');
+        this.uwsApp[method](replacedPath, fn);
         if(!this.get('strict routing') && route.path[route.path.length - 1] !== '/') {
-            this.uwsApp[method](route.path + '/', fn);
+            this.uwsApp[method](replacedPath + '/', fn);
             if(method === 'get') {
-                this.uwsApp.head(route.path + '/', fn);
+                this.uwsApp.head(replacedPath + '/', fn);
             }
         }
         if(method === 'get') {
-            this.uwsApp.head(route.path, fn);
+            this.uwsApp.head(replacedPath, fn);
         }
     }
 
@@ -313,7 +328,9 @@ module.exports = class Router extends EventEmitter {
     #preprocessRequest(req, res, route) {
         return new Promise(async resolve => {
             req.route = route;
-            if(typeof route.path === 'string' && (route.path.includes(':') || route.path.includes('*')) && route.pattern instanceof RegExp) {
+            if(route.optimizedParams) {
+                req.params = req.optimizedParams;
+            } else if(typeof route.path === 'string' && (route.path.includes(':') || route.path.includes('*')) && route.pattern instanceof RegExp) {
                 let path = req.path;
                 if(req._stack.length > 0) {
                     path = path.replace(this.getFullMountpath(req), '');
@@ -324,31 +341,6 @@ module.exports = class Router extends EventEmitter {
                         req.params = {...params, ...req.params};
                     }
                 }
-
-                for(let param in req.params) {
-                    if(this.#paramCallbacks.has(param) && !req._gotParams.has(param)) {
-                        req._gotParams.add(param);
-                        const pcs = this.#paramCallbacks.get(param);
-                        for(let i = 0; i < pcs.length; i++) {
-                            const fn = pcs[i];
-                            await new Promise(resolveRoute => {
-                                const next = (thingamabob) => {
-                                    if(thingamabob) {
-                                        if(thingamabob === 'route') {
-                                            return resolve('route');
-                                        } else {
-                                            this.#handleError(thingamabob, req, res);
-                                            return resolve(false);
-                                        }
-                                    }
-                                    return resolveRoute();
-                                };
-                                req.next = next;
-                                fn(req, res, next, req.params[param], param);
-                            });
-                        }
-                    }
-                }
             } else {
                 req.params = {};
                 if(req._paramStack.length > 0) {
@@ -358,6 +350,31 @@ module.exports = class Router extends EventEmitter {
                 }
             }
 
+            for(let param in req.params) {
+                if(this.#paramCallbacks.has(param) && !req._gotParams.has(param)) {
+                    req._gotParams.add(param);
+                    const pcs = this.#paramCallbacks.get(param);
+                    for(let i = 0; i < pcs.length; i++) {
+                        const fn = pcs[i];
+                        await new Promise(resolveRoute => {
+                            const next = (thingamabob) => {
+                                if(thingamabob) {
+                                    if(thingamabob === 'route') {
+                                        return resolve('route');
+                                    } else {
+                                        this.#handleError(thingamabob, req, res);
+                                        return resolve(false);
+                                    }
+                                }
+                                return resolveRoute();
+                            };
+                            req.next = next;
+                            fn(req, res, next, req.params[param], param);
+                        });
+                    }
+                }
+            }
+
             resolve(true);
         });
     }

package/src/utils.js

@@ -74,6 +74,29 @@ function needsConversionToRegex(pattern) {
         pattern.includes(']');
 }
 
+function canBeOptimized(pattern) {
+    if(pattern === '/*') {
+        return false;
+    }
+    if(pattern instanceof RegExp) {
+        return false;
+    }
+    if(
+        pattern.includes('*') ||
+        pattern.includes('?') ||
+        pattern.includes('+') ||
+        pattern.includes('(') ||
+        pattern.includes(')') ||
+        pattern.includes('{') ||
+        pattern.includes('}') ||
+        pattern.includes('[') ||
+        pattern.includes(']')
+    ) {
+        return false;
+    }
+    return true;
+}
+
 function acceptParams(str) {
     const parts = str.split(/ *; */);
     const ret = { value: parts[0], quality: 1, params: {} }
@@ -311,5 +334,6 @@ module.exports = {
     createETagGenerator,
     isRangeFresh,
     findIndexStartingFrom,
-    fastQueryParse
+    fastQueryParse,
+    canBeOptimized
 };