ultimate-express 1.0.1 → 1.0.3

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.js    | /                | 10.90k          | 70.10k           | 2.04 MB/sec        | 11.57 MB/sec        | **6.43X**        |
+| routing/lot-of-routes.js    | /999             | 4.66k           | 51.58k           | 0.85 MB/sec        | 8.07 MB/sec         | **11.07X**       |
+| routing/some-middlewares.js | /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.js              | /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,14 +1,18 @@
 {
   "name": "ultimate-express",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "The Ultimate Express. Fastest http server with full Express compatibility, based on uWebSockets.",
   "main": "src/index.js",
   "scripts": {
     "test": "node tests/index.js"
   },
+  "files": [
+    "src",
+    "EXPRESS_LICENSE"
+  ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/dimdenGD/u-express.git"
+    "url": "git+https://github.com/dimdenGD/ultimate-express.git"
   },
   "keywords": [
     "express",
@@ -27,17 +31,15 @@
   "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",
     "cookie": "^0.6.0",
-    "cookie-session": "^2.1.0",
     "cookie-signature": "^1.2.1",
     "etag": "^1.8.1",
-    "express-rate-limit": "^7.4.0",
     "fresh": "^0.5.2",
     "mime-types": "^2.1.35",
     "ms": "^2.1.3",
@@ -52,6 +54,7 @@
   },
   "devDependencies": {
     "cookie-parser": "^1.4.6",
+    "cookie-session": "^2.1.0",
     "cors": "^2.8.5",
     "ejs": "^3.1.10",
     "errorhandler": "^1.5.1",
@@ -61,6 +64,7 @@
     "express-dot-engine": "^1.0.8",
     "express-fileupload": "^1.5.1",
     "express-handlebars": "^8.0.1",
+    "express-rate-limit": "^7.4.0",
     "express-session": "^1.18.0",
     "method-override": "^3.0.0",
     "multer": "^1.4.5-lts.1",

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/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);
     }
 }

package/.github/workflows/test.yml

@@ -1,27 +0,0 @@
-name: Run tests
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ] 
-
-jobs:
-  test:
-
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout Source Tree
-        uses: actions/checkout@v3
-
-      - name: Setup Node.js environment
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-
-      - name: Install dependencies
-        run: npm install --include=dev
-        
-      - name: Run tests
-        run: npm run test

package/tests/index.js

@@ -1,64 +0,0 @@
-// npm run test - runs all tests
-// npm run test routing - runs all tests in the routing category
-// npm run test tests/tests/routing - runs all tests in the routing category
-// npm run test tests/tests/listen/listen-random.js - runs the test at tests/tests/listen/listen-random.js
-
-const fs = require("fs");
-const path = require("path");
-const test = require("node:test");
-const childProcess = require("node:child_process");
-const assert = require("node:assert");
-
-const testPath = path.join(__dirname, 'tests');
-
-let testCategories = fs.readdirSync(testPath).sort((a, b) => parseInt(a) - parseInt(b));
-const filterPath = process.argv[2];
-
-if(filterPath) {
-    if(!filterPath.endsWith('.js')) {
-        testCategories = testCategories.filter(category => category.startsWith(path.basename(filterPath)));
-    } else {
-        testCategories = [path.dirname(filterPath).split(path.sep).pop()];
-    }
-}
-
-for (const testCategory of testCategories) {
-    test(testCategory, async () => {
-        let tests = fs.readdirSync(path.join(__dirname, 'tests', testCategory)).sort((a, b) => parseInt(a) - parseInt(b));
-        for (const testName of tests) {
-            if(filterPath && filterPath.endsWith('.js')) {
-                if(path.basename(testName) !== path.basename(filterPath)) {
-                    continue;
-                }
-            }
-            let testPath = path.join(__dirname, 'tests', testCategory, testName);
-            let testCode = fs.readFileSync(testPath, 'utf8').replace(`const express = require("../../../src/index.js");`, 'const express = require("express");');
-            fs.writeFileSync(testPath, testCode);
-            let testDescription = testCode.split('\n')[0].slice(2).trim();
-            if(testDescription.endsWith('OFF')) {
-                return true;
-            }
-
-            await new Promise(resolve => {
-                test(testDescription, () => {
-                    process.stdout.write(testDescription + '...');
-                    try {
-                        let expressOutput = childProcess.execSync(`node ${testPath}`).toString();
-
-                        fs.writeFileSync(testPath, testCode.replace(`const express = require("express");`, `const express = require("../../../src/index.js");`));
-                        let uExpressOutput = childProcess.execSync(`node ${testPath}`).toString();
-
-                        assert.strictEqual(uExpressOutput, expressOutput);
-                        console.log('\x1b[32mOK\x1b[0m');
-                    } catch (error) {
-                        console.log('\x1b[31mFAIL\x1b[0m');
-                        throw error;
-                    } finally {
-                        fs.writeFileSync(testPath, testCode);
-                        resolve();
-                    }
-                });
-            });
-        }
-    });
-}

package/tests/parts/.test/index.html

@@ -1,11 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Document</title>
-</head>
-<body>
-    test
-</body>
-</html>

package/tests/parts/index.art

@@ -1,12 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>{{ title }}</title>
-</head>
-<body>
-  <h1>{{ message }}</h1>
-  <span>{{ asdf }}</span>
-</body>
-</html>

package/tests/parts/index.dot

@@ -1,12 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>[[= title ]]</title>
-</head>
-<body>
-  <h1>[[= message ]]</h1>
-  <span>[[= asdf ]]</span>
-</body>
-</html>

package/tests/parts/index.ejs

@@ -1,12 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title><%= title %></title>
-</head>
-<body>
-  <h1><%= message %></h1>
-  <span><%= asdf %></span>
-</body>
-</html>

package/tests/parts/index.handlebars

@@ -1,2 +0,0 @@
-<h1>{{{ message }}}</h1>
-<span>{{{ asdf }}}</span>

package/tests/parts/index.html

@@ -1,12 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>test</title>
-</head>
-<body>
-  <h1>test</h1>
-  <span>index test</span>
-</body>
-</html>

package/tests/parts/index.mustache

@@ -1,12 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>{{ title }}</title>
-</head>
-<body>
-  <h1>{{ message }}</h1>
-  <span>{{ asdf }}</span>
-</body>
-</html>

package/tests/parts/index.pug

@@ -1,6 +0,0 @@
-html
-  head
-    title= title
-  body
-    h1= message
-    span= asdf

package/tests/parts/index.swig

@@ -1,12 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>{{ title }}</title>
-</head>
-<body>
-  <h1>{{ message }}</h1>
-  <span>{{ asdf }}</span>
-</body>
-</html>

package/tests/parts/layouts/main.handlebars

@@ -1,12 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-    <meta charset="utf-8">
-    <title>Example App</title>
-</head>
-<body>
-
-    {{{body}}}
-
-</body>
-</html>

package/tests/preload.cjs

@@ -1,5 +0,0 @@
-let _processExit = process.exit;
-process.exit = (...args) => {
-    console.log('process.exit', ...args);
-    // _processExit(...args);
-};

package/tests/singular.js

@@ -1,41 +0,0 @@
-const childProcess = require("child_process");
-const fs = require("fs");
-const exitHook = require("exit-hook");
-const { exit } = require("process");
-
-let args = process.argv.slice(2);
-
-let u = args.some(arg => arg === '-u');
-args = args.filter(arg => arg !== '-u');
-
-let path = args[0];
-
-if (!path) {
-    console.error('Usage: node singular.js [-u] <path>');
-    process.exit(1);
-}
-
-if (u) {
-    console.log('Running as µExpress');
-    let code = fs.readFileSync(path, 'utf8');
-    fs.writeFileSync(path, code.replace('const express = require("express");', 'const express = require("../../../src/index.js");'));
-} else {
-    let code = fs.readFileSync(path, 'utf8');
-    fs.writeFileSync(path, code.replace(`const express = require("../../../src/index.js");`, `const express = require("express");`));
-    console.log('Running as normal Express');
-}
-
-let node = childProcess.spawn('node', ['-r', './tests/preload.cjs', path]);
-
-node.stdout.on('data', data => {
-    console.log(data.toString());
-});
-
-node.stderr.on('data', data => {
-    console.error(data.toString());
-});
-
-exitHook(() => {
-    let code = fs.readFileSync(path, 'utf8');
-    fs.writeFileSync(path, code.replaceAll(`const express = require("../../../src/index.js");`, `const express = require("express");`));
-});

package/tests/tests/app/app-engine.js

@@ -1,8 +0,0 @@
-// must support app.engine()
-
-const express = require("express");
-
-const app = express();
-app.engine('asdf', function test() {});
-
-console.log(app.engines);

package/tests/tests/app/app-on-mount.js

@@ -1,24 +0,0 @@
-// must emit 'mount' when using subapp
-
-const express = require("express");
-
-const app = express();
-const student = express();
-const teacher = express();
-
-teacher.on('mount', (parent) => {
-	console.log('aaaaaaaaaaaaaaaaaaaaaaaaaa');
-});
-
-student.on('mount', (parent) => {
-	console.log('dewd');
-});
-
-app.use('/student', student);
-app.use('/teacher', teacher);
-
-app.listen(13333, (err) => {
-    console.log("Server is running on port 13333");
-    
-    process.exit(0);
-});

package/tests/tests/app/app-path.js

@@ -1,21 +0,0 @@
-// must support app.path()
-
-const express = require("express");
-
-const app = express();
-const app2 = express();
-const app3 = express();
-const router = express.Router();
-
-app.use('/abc', app2);
-app2.use('/def', app3);
-
-app.use((req, res, next) => {
-    res.send('404');
-});
-
-console.log(app.path());
-console.log(app2.path());
-console.log(app3.path());
-console.log(router?.path?.());
-console.log(app.mountpath, app2.mountpath, app3.mountpath);

package/tests/tests/app/app-route.js

@@ -1,30 +0,0 @@
-// must support app.route()
-
-const express = require("express");
-
-const app = express();
-
-app.get('/asdf', (req, res) => {
-    res.send('asdf');
-});
-
-app.route('/test')
-    .get((req, res) => {
-        res.send('test1');
-    })
-    .post((req, res) => {
-        res.send('test2');
-    });
-
-app.listen(13333, async () => {
-    console.log('Server is running on port 13333');
-
-    let outputs = await Promise.all([
-        fetch('http://localhost:13333/asdf').then(res => res.text()),
-        fetch('http://localhost:13333/test').then(res => res.text()),
-        fetch('http://localhost:13333/test', { method: 'POST' }).then(res => res.text()),
-    ]);
-
-    console.log(outputs.join(' '));
-    process.exit(0);
-});

package/tests/tests/app/options.js

@@ -1,16 +0,0 @@
-// must support setting and getting options
-
-const express = require("express");
-
-const app = express();
-
-app.set('case sensitive routing', true);
-console.log(app.get('case sensitive routing'));
-
-app.enable('x-powered-by');
-console.log(app.enabled('x-powered-by'));
-
-app.disable('x-powered-by');
-console.log(app.enabled('x-powered-by'));
-
-console.log(app.disabled('x-powered-by'));

package/tests/tests/app/setting-inheritance.js

@@ -1,16 +0,0 @@
-// must support app.path()
-
-const express = require("express");
-
-const app = express();
-const app2 = express();
-
-app.set('case sensitive routing', true);
-app.set('jsonp callback name', 'cb');
-
-app.use('/abc', app2);
-
-
-console.log(app2.get('case sensitive routing'));
-console.log(app2.get('jsonp callback name'));
-

package/tests/tests/engines/art-template.js

@@ -1,33 +0,0 @@
-// must support art template engine
-
-const express = require("express");
-const artTemplate = require("express-art-template");
-
-const app = express();
-
-app.engine('art', artTemplate);
-app.set('views', 'tests/parts');
-app.set('view engine', 'art');
-app.set('view options', {
-    debug: process.env.NODE_ENV !== 'production',
-    ignore: ['Math', 'Date', 'JSON', 'encodeURIComponent'],
-    minimize: false
-});
-
-app.get('/test', (req, res) => {
-    res.locals.asdf = 'locals test';
-    res.render('index', { title: 'Hey', message: 'Hello there!' });
-});
-
-app.use((err, req, res, next) => {
-    console.log(err);
-    res.status(500).send(`whoops!`);
-});
-
-app.listen(13333, async () => {
-    console.log('Server is running on port 13333');
-
-    const response = await fetch('http://localhost:13333/test').then(res => res.text());
-    console.log(response);
-    process.exit(0);
-});

package/tests/tests/engines/dot.js

@@ -1,28 +0,0 @@
-// must support doT engine
-
-const express = require("express");
-const dot = require("express-dot-engine");
-
-const app = express();
-
-app.engine('dot', dot.__express);
-app.set('view engine', 'dot');
-app.set('views', 'tests/parts');
-
-app.get('/test', (req, res) => {
-    res.locals.asdf = 'locals test';
-    res.render('index.ejs', { title: 'Hey', message: 'Hello there!' });
-});
-
-app.use((err, req, res, next) => {
-    console.log(err);
-    res.status(500).send(`whoops!`);
-});
-
-app.listen(13333, async () => {
-    console.log('Server is running on port 13333');
-
-    const response = await fetch('http://localhost:13333/test').then(res => res.text());
-    console.log(response);
-    process.exit(0);
-});

package/tests/tests/engines/ejs.js

@@ -1,25 +0,0 @@
-// must support ejs engine
-
-const express = require("express");
-
-const app = express();
-app.set('view engine', 'ejs');
-app.set('views', 'tests/parts');
-
-app.get('/test', (req, res) => {
-    res.locals.asdf = 'locals test';
-    res.render('index.ejs', { title: 'Hey', message: 'Hello there!' });
-});
-
-app.use((err, req, res, next) => {
-    console.log(err);
-    res.status(500).send(`whoops!`);
-});
-
-app.listen(13333, async () => {
-    console.log('Server is running on port 13333');
-
-    const response = await fetch('http://localhost:13333/test').then(res => res.text());
-    console.log(response);
-    process.exit(0);
-});

package/tests/tests/engines/handlebars.js

@@ -1,28 +0,0 @@
-// must support handlebars engine
-
-const express = require("express");
-const { engine } = require("express-handlebars");
-
-const app = express();
-
-app.engine('handlebars', engine());
-app.set('view engine', 'handlebars');
-app.set('views', 'tests/parts');
-
-app.get('/test', (req, res) => {
-    res.locals.asdf = 'locals test';
-    res.render('index', { title: 'Hey', message: 'Hello there!' });
-});
-
-app.use((err, req, res, next) => {
-    console.log(err);
-    res.status(500).send(`whoops!`);
-});
-
-app.listen(13333, async () => {
-    console.log('Server is running on port 13333');
-
-    const response = await fetch('http://localhost:13333/test').then(res => res.text());
-    console.log(response);
-    process.exit(0);
-});