ultimate-express 1.2.1 → 1.2.3

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
@@ -110,7 +136,8 @@ In general, basically all features and options are supported. Use [Express 4.x d
 
 - ✅ express()
 - ✅ express.Router()
-- ✅ express.json()
+- 🚧 express.json()
+- - ❌ options.inflate
 - ✅ express.urlencoded()
 - ✅ express.static()
 - - Additionally you can pass `options.ifModifiedSince` to support If-Modified-Since header (this header is not supported in normal Express, but is supported in µExpress)

package/package.json

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

package/src/middlewares.js

@@ -16,6 +16,7 @@ limitations under the License.
 
 const fs = require('fs');
 const path = require('path');
+const bytes = require('bytes');
 
 function static(root, options) {
     if(!options) options = {};
@@ -108,6 +109,68 @@ function static(root, options) {
     }
 }
 
+function json(options = {}) {
+    if(typeof options !== 'object') {
+        options = {};
+    }
+    if(typeof options.limit === 'undefined') options.limit = bytes('100kb');
+    else options.limit = bytes(options.limit);
+
+    if(typeof options.type === 'undefined') options.type = 'application/json';
+    else if(typeof options.type !== 'string') {
+        throw new Error('type must be a string');
+    }
+
+    return (req, res, next) => {
+        const type = req.headers['content-type'];
+        const semiColonIndex = type.indexOf(';');
+        const contentType = semiColonIndex !== -1 ? type.substring(0, semiColonIndex) : type;
+        if(!type || contentType !== options.type) {
+            return next();
+        }
+
+        // skip reading body for non-POST requests
+        // this makes it +10k req/sec faster
+        const additionalMethods = req.app.get('body methods');
+        if(
+            req.method !== 'POST' &&
+            req.method !== 'PUT' &&
+            req.method !== 'PATCH' && 
+            (!additionalMethods || !additionalMethods.includes(req.method))
+        ) {
+            return next();
+        }
+
+        const abs = [], totalSize = 0;
+        req._res.onData((ab, isLast) => {
+            abs.push(ab);
+            totalSize += ab.length;
+            if(totalSize > options.limit) {
+                return next(new Error('Request entity too large'));
+            }
+            if(isLast) {
+                const buf = Buffer.concat(abs);
+                if(options.verify) {
+                    try {
+                        options.verify(req, res, buf);
+                    } catch(e) {
+                        return next(e);
+                    }
+                }
+                req.body = JSON.parse(buf, options.reviver);
+                if(options.strict) {
+                    if(req.body && typeof req.body !== 'object') {
+                        return next(new Error('Invalid body'));
+                    }
+                }
+                next();
+            }
+        });
+
+    }
+
+}
+
 module.exports = {
     static
 };