ultimate-express 1.0.2 → 1.0.4

package/README.md

@@ -1,4 +1,4 @@
-# µExpress
+# µExpress / Ultimate Express
 
 The *Ultimate* Express. Fastest http server with **full** Express compatibility, based on µWebSockets.
 
@@ -19,6 +19,21 @@ Similar projects based on uWebSockets:
 - `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.
 
+## 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                        | Path             | 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**        |
+| routing/lot-of-routes       | /999             | 4.66k           | 51.58k           | 0.85 MB/sec        | 8.07 MB/sec         | **11.07X**       |
+| routing/some-middlewares    | /90              | 10.18k          | 66.97k           | 1.81 MB/sec        | 10.42 MB/sec        | **6.58X**        |
+| middlewares/express-static  | /static/index.js | 7.52k           | 31.08k           | 6.92 MB/sec        | 26.48 MB/sec        | **4.13X**        |
+| engines/ejs                 | /test            | 5.92k           | 14.43k           | 2.40 MB/sec        | 5.53 MB/sec         | **2.44X**        |
+| middlewares/body-urlencoded | /abc (POST)      | 7.90k           | 29.90k           | 1.64 MB/sec        | 5.36 MB/sec         | **3.78X**        |
+
+Also tested on a real-world application with templates, static files and dynamic pages with data from database ([nekoweb.org](https://nekoweb.org)), and showed about 1.5-4X speedup in requests per second.
+
 ## Differences from Express
 
 In a lot of cases, you can just replace `require("express")` with `require("ultimate-express")` and everything works the same. But there are some differences:
@@ -81,6 +96,8 @@ Optimized routes can be up to 10 times faster than normal routes, as they're usi
 
 ## Compatibility
 
+In general, basically all features and options are supported. Use [Express 4.x documentation](https://expressjs.com/en/4x/api.html) for API reference.
+
 ✅ - Full support (all features and options are supported)  
 🚧 - Partial support (some options are not supported)  
 ❌ - Not supported  

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultimate-express",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "The Ultimate Express. Fastest http server with full Express compatibility, based on uWebSockets.",
   "main": "src/index.js",
   "scripts": {
@@ -12,7 +12,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/dimdenGD/u-express.git"
+    "url": "git+https://github.com/dimdenGD/ultimate-express.git"
   },
   "keywords": [
     "express",
@@ -31,9 +31,9 @@
   "author": "dimden.dev",
   "license": "Apache-2.0",
   "bugs": {
-    "url": "https://github.com/dimdenGD/u-express/issues"
+    "url": "https://github.com/dimdenGD/ultimate-express/issues"
   },
-  "homepage": "https://github.com/dimdenGD/u-express#readme",
+  "homepage": "https://github.com/dimdenGD/ultimate-express#readme",
   "dependencies": {
     "accepts": "^1.3.8",
     "body-parser": "^1.20.3",

package/src/middlewares.js

@@ -6,6 +6,7 @@ function static(root, options) {
     if(typeof options.index === 'undefined') options.index = 'index.html';
     if(typeof options.redirect === 'undefined') options.redirect = true;
     if(typeof options.fallthrough === 'undefined') options.fallthrough = true;
+    if(typeof options.dotfiles === 'undefined') options.dotfiles = 'ignore_files';
     if(options.extensions) {
         if(typeof options.extensions !== 'string' && !Array.isArray(options.extensions)) {
             throw new Error('extensions must be a string or an array');

package/src/request.js

@@ -46,7 +46,7 @@ module.exports = class Request extends Readable {
         this._gotParams = new Set();
         this._stack = [];
         this._paramStack = [];
-        this.bufferedData = Buffer.alloc(0);
+        this.bufferedData = Buffer.allocUnsafe(0);
         this.receivedData = false;
 
         const additionalMethods = this.app.get('body methods');

package/src/response.js

@@ -271,6 +271,12 @@ module.exports = class Response extends Writable {
                 case 'deny':
                     this.status(403);
                     return done(new Error('Forbidden'));
+                case 'ignore_files':
+                    if(parts.length > 1 && parts[parts.length - 1].startsWith('.')) {
+                        this.status(404);
+                        return done(new Error('Not found'));
+                    }
+                    break;
                 case 'ignore':
                 default:
                     this.status(404);

package/src/router.js

@@ -52,10 +52,11 @@ module.exports = class Router extends EventEmitter {
     get(path, ...callbacks) {
         if(typeof path === 'string' && callbacks.length === 0) {
             const key = path;
-            if(typeof this.settings[key] === 'undefined' && this.parent) {
+            const res = this.settings[key];
+            if(typeof res === 'undefined' && this.parent) {
                 return this.parent.get(key);
             } else {
-                return this.settings[key];
+                return res;
             }
         }
         return this.#createRoute('GET', path, this, ...callbacks);
@@ -419,7 +420,12 @@ module.exports = class Router extends EventEmitter {
                         if(!skipCheck && skipUntil && skipUntil.routeKey >= route.routeKey) {
                             return next();
                         }
-                        await callback(req, res, next);
+                        const out = callback(req, res, next);
+                        if(out instanceof Promise) {
+                            out.catch(err => {
+                                throw err;
+                            });
+                        }
                     } catch(err) {
                         this.#handleError(err, req, res);
                         return resolve(true);

package/src/utils.js

@@ -13,7 +13,7 @@ function patternToRegex(pattern, isPrefix = false) {
     if(pattern instanceof RegExp) {
         return pattern;
     }
-    if(isPrefix && pattern === '/') {
+    if(isPrefix && pattern === '') {
         return new RegExp(``);
     }
 
@@ -241,7 +241,10 @@ function isPreconditionFailure(req, res) {
 
 function createETagGenerator(options) {
     return function generateETag (body, encoding) {
-        const buf = !(body instanceof Stats) && !Buffer.isBuffer(body) ? Buffer.from(body, encoding) : body;
+        if(body instanceof Stats) {
+            return etag(body, options);
+        }
+        const buf = !Buffer.isBuffer(body) ? Buffer.from(body, encoding) : body;
         return etag(buf, options);
     }
 }