ultimate-express 1.2.4 → 1.2.6

package/README.md

@@ -22,10 +22,10 @@ Similar projects based on uWebSockets:
 
 ## Performance
 
-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
 
+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                                          | 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**        |
@@ -38,25 +38,19 @@ Tested using [wrk](https://github.com/wg/wrk) (`-d 60 -t 1 -c 200`). Etag was di
 
 ### 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 |
+Tested using [bun-http-framework-benchmark](https://github.com/dimdenGD/bun-http-framework-benchmark). This table only includes Node.js results.
+For full table with other runtimes, check [here](https://github.com/dimdenGD/bun-http-framework-benchmark?tab=readme-ov-file#results).
+
+|  Framework       | Average | Ping       | Query      | Body       |
+| ---------------- | ------- | ---------- | ---------- | ---------- |
+| uws | 94,296.49 | 108,551.92 | 104,756.22 | 69,581.33 |
+| hyper-express | 66,356.707 | 80,002.53 | 69,953.76 | 49,113.83 |
+| **ultimate-express** | **46,826.31** | **50,764.93** | **49,117.76** | **40,596.24** |
+| h3 | 35,423.263 | 41,243.68 | 34,429.26 | 30,596.85 |
+| fastify | 33,094.62 | 40,147.67 | 40,076.35 | 19,059.84 |
+| hono | 26,576.02 | 36,215.35 | 34,656.12 | 8,856.59 |
+| koa | 24,045.08 | 28,202.12 | 24,590.84 | 19,342.28 |
+| express | 10,411.313 | 11,245.57 | 10,598.74 | 9,389.63 |
 
 ### Performance on real-world application
 
@@ -106,7 +100,7 @@ app.listen(3000, () => {
 
 1. µExpress tries to optimize routing as much as possible, but it's only possible if:
 - `case sensitive routing` is enabled (it is by default, unlike in normal Express).
-- only string paths without regex characters like *, +, (), {}, :param, etc. can be optimized.
+- only string paths without regex characters like *, +, (), {}, etc. can be optimized.
 - only 1-level deep routers can be optimized.  
   
 Optimized routes can be up to 10 times faster than normal routes, as they're using native uWS router and have pre-calculated path.
@@ -136,8 +130,7 @@ In general, basically all features and options are supported. Use [Express 4.x d
 
 - ✅ express()
 - ✅ express.Router()
-- 🚧 express.json()
-- - ❌ options.inflate
+- ✅ express.json()
 - ✅ 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.4",
+  "version": "1.2.6",
   "description": "The Ultimate Express. Fastest http server with full Express compatibility, based on uWebSockets.",
   "main": "src/index.js",
   "scripts": {
@@ -39,12 +39,12 @@
   "homepage": "https://github.com/dimdenGD/ultimate-express#readme",
   "dependencies": {
     "accepts": "^1.3.8",
-    "body-parser": "^1.20.3",
     "cookie": "^0.6.0",
     "cookie-signature": "^1.2.1",
     "encodeurl": "^2.0.0",
     "etag": "^1.8.1",
     "fast-querystring": "^1.1.2",
+    "fast-zlib": "^2.0.1",
     "fresh": "^0.5.2",
     "mime-types": "^2.1.35",
     "ms": "^2.1.3",
@@ -58,6 +58,7 @@
     "vary": "^1.1.2"
   },
   "devDependencies": {
+    "body-parser": "^1.20.3",
     "cookie-parser": "^1.4.6",
     "cookie-session": "^2.1.0",
     "cors": "^2.8.5",

package/src/index.js

@@ -16,8 +16,7 @@ limitations under the License.
 
 const Application = require("./application.js");
 const Router = require("./router.js");
-const bodyParser = require("body-parser");
-const { static, json } = require("./middlewares.js");
+const middlewares = require("./middlewares.js");
 const Request = require("./request.js");
 const Response = require("./response.js");
 
@@ -28,11 +27,11 @@ Application.Router = function(options) {
 Application.request = Request.prototype;
 Application.response = Response.prototype;
 
-Application.static = static;
+Application.static = middlewares.static;
 
-Application.json = json;
-Application.urlencoded = bodyParser.urlencoded;
-Application.text = bodyParser.text;
-Application.raw = bodyParser.raw;
+Application.json = middlewares.json;
+Application.urlencoded = middlewares.urlencoded;
+Application.text = middlewares.text;
+Application.raw = middlewares.raw;
 
 module.exports = Application;

package/src/middlewares.js

@@ -17,6 +17,10 @@ limitations under the License.
 const fs = require('fs');
 const path = require('path');
 const bytes = require('bytes');
+const zlib = require('fast-zlib');
+const typeis = require('type-is');
+const querystring = require('fast-querystring');
+const { fastQueryParse } = require('./utils.js');
 
 function static(root, options) {
     if(!options) options = {};
@@ -109,51 +113,113 @@ 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');
+function createInflate(contentEncoding) {
+    const encoding = (contentEncoding || 'identity').toLowerCase();
+    switch(encoding) {
+        case 'identity':
+            return;
+        case 'deflate':
+            return new zlib.Inflate();
+        case 'gzip':
+            return new zlib.Gunzip();
+        case 'br':
+            return new zlib.BrotliDecompress();
+        default:
+            return false;
     }
+}
 
-    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();
+function createBodyParser(defaultType, beforeReturn) {
+    return function(options) {
+        if(typeof options !== 'object') {
+            options = {};
         }
-        // skip reading body twice
-        if(req.body) {
-            return next();
+        if(typeof options.limit === 'undefined') options.limit = bytes('100kb');
+        else options.limit = bytes(options.limit);
+    
+        if(typeof options.type === 'undefined') options.type = defaultType;
+        else if(typeof options.type !== 'string') {
+            throw new Error('type must be a string');
         }
-
-        // 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();
+        if(typeof options.inflate === 'undefined') options.inflate = true;
+        if(typeof options.type === 'string') {
+            options.type = [options.type];
+        } else if(typeof options.type !== 'function' && !Array.isArray(options.type)) {
+            throw new Error('type must be a string, function or an array');
         }
+        if(typeof options.defaultCharset === 'undefined') options.defaultCharset = 'utf-8';
+
+        return (req, res, next) => {
+            const type = req.headers['content-type'];
+
+            // skip reading body for non-json content type
+            if(!type) {
+                return next();
+            }
+
+            // skip reading body twice
+            if(req.body) {
+                return next();
+            }
 
-        const abs = []
-        let totalSize = 0;
-        req._res.onData((ab, isLast) => {
-            abs.push(Buffer.from(ab));
-            totalSize += ab.length;
-            if(totalSize > options.limit) {
+            const length = req.headers['content-length'];
+            // skip reading empty body
+            if(length == '0') {
+                return next();
+            }
+
+            // skip reading too large body
+            if(length && +length > options.limit) {
                 return next(new Error('Request entity too large'));
             }
-            if(isLast) {
+
+            if(typeof options.type === 'function') {
+                if(!options.type(req)) {
+                    return next();
+                }
+            } else {
+                if(!typeis(req, 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 = [];
+            let inflate;
+            let totalSize = 0;
+            if(options.inflate) {
+                inflate = createInflate(req.headers['content-encoding']);
+                if(inflate === false) {
+                    return next(new Error('Unsupported content encoding'));
+                }
+            }
+
+            function onData(buf) {
+                if(!Buffer.isBuffer(buf)) {
+                    buf = Buffer.from(buf);
+                }
+                if(inflate) {
+                    buf = inflate.process(buf);
+                }
+                abs.push(buf);
+                totalSize += buf.length;
+                if(totalSize > options.limit) {
+                    return next(new Error('Request entity too large'));
+                }
+            }
+    
+            function onEnd() {
                 const buf = Buffer.concat(abs);
                 if(options.verify) {
                     try {
@@ -162,21 +228,78 @@ function json(options = {}) {
                         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'));
+                beforeReturn(req, res, next, options, buf);
+            }
+    
+            // reading data directly from uWS is faster than from a stream
+            // if we are fast enough (not async), we can do it
+            // otherwise we need to use a stream since it already started streaming it
+            if(!req.receivedData) {
+                req._res.onData((ab, isLast) => {
+                    onData(ab);
+                    if(isLast) {
+                        onEnd();
                     }
-                }
-                next();
+                });
+            } else {
+                req.on('data', onData);
+                req.on('end', onEnd);
             }
-        });
+        }
+    }
+}
 
+const json = createBodyParser('application/json', function(req, res, next, options, buf) {
+    if(options.strict) {
+        if(req.body && typeof req.body !== 'object') {
+            return next(new Error('Invalid body'));
+        }
     }
+    req.body = JSON.parse(buf.toString(), options.reviver);
+    next();
+});
 
-}
+const raw = createBodyParser('application/octet-stream', function(req, res, next, options, buf) {
+    req.body = buf;
+    next();
+});
+
+const text = createBodyParser('text/plain', function(req, res, next, options, buf) {
+    let contentType = req.headers['content-type'];
+    let charsetIndex = contentType.indexOf('charset=');
+    let encoding = options.defaultCharset;
+    if(charsetIndex !== -1) {
+        encoding = contentType.substring(charsetIndex + 8);
+        const semicolonIndex = encoding.indexOf(';');
+        if(semicolonIndex !== -1) {
+            encoding = encoding.substring(0, semicolonIndex);
+        }
+        encoding = encoding.trim().toLowerCase();
+    }
+    if(encoding !== 'utf-8' && encoding !== 'utf-16le' && encoding !== 'latin1') {
+        return next(new Error('Unsupported charset'));
+    }
+    req.body = buf.toString(encoding);
+    next();
+});
+
+const urlencoded = createBodyParser('application/x-www-form-urlencoded', function(req, res, next, options, buf) {
+    try {
+        if(options.extended) {
+            req.body = fastQueryParse(buf.toString(), options);
+        } else {
+            req.body = querystring.parse(buf.toString());
+        }
+    } catch(e) {
+        return next(e);
+    }
+    next();
+});
 
 module.exports = {
     static,
-    json
+    json,
+    raw,
+    text,
+    urlencoded,
 };

package/src/utils.js

@@ -22,13 +22,13 @@ const querystring = require("fast-querystring");
 const etag = require("etag");
 const { Stats } = require("fs");
 
-function fastQueryParse(query) {
+function fastQueryParse(query, options) {
     if(query.length <= 128) {
         if(!query.includes('[') && !query.includes('%5B') && !query.includes('.') && !query.includes('%2E')) {
             return querystring.parse(query);
         }
     }
-    return qs.parse(query);
+    return qs.parse(query, options);
 }
 
 function removeDuplicateSlashes(path) {