ultimate-express 2.0.1 → 2.0.3

package/README.md

@@ -57,7 +57,7 @@ For full table with other runtimes, check [here](https://github.com/dimdenGD/bun
 | express              | 10,411.313     | 11,245.57     | 10,598.74     | 9,389.63      |
 
 Other benchmarks:
- - [TechEmpower / FrameworkBenchmarks](https://www.techempower.com/benchmarks/#hw=ph&test=composite&section=data-r23&l=zik0sf-cn3)
+ - [TechEmpower / FrameworkBenchmarks](https://www.techempower.com/benchmarks/#section=data-r23&test=plaintext&l=zik0sf-pa7)
  - [the-benchmarker / web-frameworks](https://web-frameworks-benchmark.netlify.app/result?l=javascript)
 
 ### Performance on real-world application
@@ -189,6 +189,7 @@ In general, basically all features and options are supported. Use [Express 4.x d
 - ✅ app.engines
 - ✅ app.on("mount")
 - ✅ HEAD method
+- ✅ OPTIONS method
 
 ### Application settings
 

package/package.json

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

package/src/application.js

@@ -191,6 +191,12 @@ class Application extends Router {
                 if(request._error) {
                     return this._handleError(request._error, null, request, response);
                 }
+                if(request._isOptions && request._matchedMethods.size > 0) {
+                    const allowedMethods = Array.from(request._matchedMethods).join(',');
+                    response.setHeader('Allow', allowedMethods);
+                    response.send(allowedMethods);
+                    return;
+                }
                 response.status(404);
                 this._sendErrorPage(request, response, `Cannot ${request.method} ${request.path}`, false);
             }

package/src/middlewares.js

@@ -86,8 +86,9 @@ function static(root, options) {
 
         if(stat.isDirectory()) {
             if(!req.endsWithSlash) {
-                if(options.redirect) return res.redirect(301, req._originalPath + '/');
-                else {
+                if(options.redirect) {
+                    return res.redirect(301, req._originalPath + '/', true);
+                } else {
                     if(!options.fallthrough) {
                         res.status(404);
                         return next(new Error('Not found'));

package/src/request.js

@@ -69,8 +69,11 @@ module.exports = class Request extends Readable {
             this._opPath = this._opPath.slice(0, -1);
         }
         this.method = req.getCaseSensitiveMethod().toUpperCase();
+        this._isOptions = this.method === 'OPTIONS';
+        this._isHead = this.method === 'HEAD';
         this.params = {};
-
+        
+        this._matchedMethods = new Set();
         this._gotParams = new Set();
         this._stack = [];
         this._paramStack = [];
@@ -135,6 +138,10 @@ module.exports = class Request extends Readable {
         return match ? match[0] : '';
     }
 
+    set baseUrl(x) {
+        return this._originalPath = x;
+    }
+
     get #host() {
         const trust = this.app.get('trust proxy fn');
         if(!trust) {
@@ -248,7 +255,7 @@ module.exports = class Request extends Readable {
         if(this.#cachedParsedIp !== null) {
             return this.#cachedParsedIp;
         }
-        const finished = !this.res.socket.writable;
+        const finished = this.res.finished;
         if(finished) {
             // mark app as one that needs ip after response
             this.app.needsIpAfterResponse = true;

package/src/response.js

@@ -69,6 +69,7 @@ class Socket extends EventEmitter {
 
 module.exports = class Response extends Writable {
     #socket = null;
+    #ended = false;
     #pendingChunks = [];
     #lastWriteChunkTime = 0;
     #writeTimeout = null;
@@ -112,13 +113,16 @@ module.exports = class Response extends Writable {
             this._res.cork(() => {
                 this._res.close();
                 this.finished = true;
-                if(this.socketExists) this.socket.emit('close');
+                this.#socket?.emit('close');
             });
         });
+        this.once('close', () => {
+            this.#ended = true
+        })
     }
 
     get socket() {
-        this.socketExists = true;
+        if(this.#ended) return null;
         if(!this.#socket) {
             this.#socket = new Socket(this);
         }
@@ -153,7 +157,7 @@ module.exports = class Response extends Writable {
             if (this.chunkedTransfer) {
                 this.#pendingChunks.push(chunk);
                 const size = this.#pendingChunks.reduce((acc, chunk) => acc + chunk.byteLength, 0);
-                const now = Date.now();
+                const now = performance.now();
                 // the first chunk is sent immediately (!this.#lastWriteChunkTime)
                 // the other chunks are sent when watermark is reached (size >= HIGH_WATERMARK) 
                 // or if elapsed 50ms of last send (now - this.#lastWriteChunkTime > 50)
@@ -173,7 +177,7 @@ module.exports = class Response extends Writable {
                                 const size = this.#pendingChunks.reduce((acc, chunk) => acc + chunk.byteLength, 0);
                                 this._res.write(Buffer.concat(this.#pendingChunks, size));
                                 this.#pendingChunks = [];
-                                this.#lastWriteChunkTime = now;
+                                this.#lastWriteChunkTime = performance.now();
                             }
                         });
                     }, 50);
@@ -188,7 +192,7 @@ module.exports = class Response extends Writable {
                     super.end();
                     this.finished = true;
                     this.writingChunk = false;
-                    if (this.socketExists) this.socket.emit('close');
+                    this.#socket?.emit('close');
                     callback(null);
                 } else if (!ok) {
                     this._res.ab = chunk;
@@ -198,7 +202,7 @@ module.exports = class Response extends Writable {
                         const [ok, done] = this._res.tryEnd(this._res.ab.slice(offset - this._res.abOffset), this.totalSize);
                         if (done) {
                             this.finished = true;
-                            if (this.socketExists) this.socket.emit('close');
+                            this.#socket?.emit('close');
                         }
                         if (ok) {
                             this.writingChunk = false;
@@ -258,10 +262,18 @@ module.exports = class Response extends Writable {
     sendStatus(code) {
         return this.status(code).send(statuses.message[+code] ?? code.toString());
     }
-    end(data) {
+    end(data, cb) {
+        if(typeof data === 'function') {
+            cb = data;
+            data = undefined;
+        }
+        if(typeof cb !== 'function') {
+            cb = undefined; // silence the error?
+        }
+
         if(this.writingChunk) {
             this.once('drain', () => {
-                this.end(data);
+                this.end(data, cb);
             });
             return;
         }
@@ -282,9 +294,13 @@ module.exports = class Response extends Writable {
                 if(fresh) {
                     this._res.end();
                     this.finished = true;
-                    if(this.socketExists) this.socket.emit('close');
+                    this.#socket?.emit('close');
                     this.emit('finish');
                     this.emit('close');
+                    cb && queueMicrotask(() => {
+                        this.#ended = true;
+                        cb();
+                    });
                     return;
                 }
             }
@@ -309,9 +325,13 @@ module.exports = class Response extends Writable {
             }
             
             this.finished = true;
-            if(this.socketExists) this.socket.emit('close');
+            this.#socket?.emit('close');
             this.emit('finish');
             this.emit('close');
+            cb && queueMicrotask(() => {
+                this.#ended = true;
+                cb();
+            });
         });
         return this;
     }
@@ -775,28 +795,44 @@ module.exports = class Response extends Writable {
         }
         return this.headers['location'] = encodeUrl(path);
     }
-    redirect(status, url) {
+    redirect(status, url, forceHtml = false) {
         if(typeof status !== 'number' && !url) {
             url = status;
             status = 302;
         }
         this.location(url);
         this.status(status);
-        this.headers['content-type'] = 'text/plain; charset=utf-8';
         let body;
         // Support text/{plain,html} by default
-        this.format({
-            text: function() {
-                body = statuses.message[status] + '. Redirecting to ' + url
-            },
-            html: function() {
-                let u = escapeHtml(url);
-                body = '<p>' + statuses.message[status] + '. Redirecting to ' + u + '</p>'
-            },
-            default: function() {
-                body = '';
-            }
-        });
+        if(forceHtml) {
+            this.set('Content-Type', 'text/html; charset=UTF-8');
+            body = 
+                '<!DOCTYPE html>\n' +
+                '<html lang="en">\n' +
+                '<head>\n' +
+                '<meta charset="utf-8">\n' +
+                '<title>Redirecting</title>\n' +
+                '</head>\n' +
+                '<body>\n' +
+                `<pre>Redirecting to ${url.replaceAll("<", "&lt;").replaceAll(">", "&gt;")}</pre>\n` +
+                '</body>\n' +
+                '</html>\n';
+        } else {
+            this.format({
+                text: () => {
+                    this.set('Content-Type', 'text/plain; charset=UTF-8');
+                    body = statuses.message[status] + '. Redirecting to ' + url
+                },
+                html: () => {
+                    this.set('Content-Type', 'text/html; charset=UTF-8');
+                    body = `<p>${statuses.message[status]}. Redirecting to ${url.replaceAll("<", "&lt;").replaceAll(">", "&gt;")}</p>`;
+                },
+                default: () => {
+                    this.set('Content-Type', 'text/plain; charset=UTF-8');
+                    body = '';
+                }
+            });
+        }
         if (this.req.method === 'HEAD') {
             this.end();
         } else {

package/src/router.js

@@ -152,6 +152,9 @@ module.exports = class Router extends EventEmitter {
                 all: method === 'ALL' || method === 'USE',
                 gettable: method === 'GET' || method === 'HEAD',
             };
+            if(typeof route.path === 'string' && (route.path.includes(':') || route.path.includes('*') || (route.path.includes('(') && route.path.includes(')'))) && route.pattern instanceof RegExp) {
+                route.complex = true;
+            }
             routes.push(route);
             // normal routes optimization
             if(canBeOptimized(route.path) && route.pattern !== '/*' && !this.parent && this.get('case sensitive routing') && this.uwsApp) {
@@ -296,6 +299,12 @@ module.exports = class Router extends EventEmitter {
                 if(request._error) {
                     return this._handleError(request._error, null, request, response);
                 }
+                if(request._isOptions && request._matchedMethods.size > 0) {
+                    const allowedMethods = Array.from(request._matchedMethods).join(',');
+                    response.setHeader('Allow', allowedMethods);
+                    response.send(allowedMethods);
+                    return;
+                }
                 response.status(404);
                 request.noEtag = true;
                 this._sendErrorPage(request, response, `Cannot ${request.method} ${request._originalPath}`, false);
@@ -369,7 +378,7 @@ module.exports = class Router extends EventEmitter {
         req.route = route;
         if(route.optimizedParams) {
             req.params = {...req.optimizedParams};
-        } else if(typeof route.path === 'string' && (route.path.includes(':') || route.path.includes('*') || (route.path.includes('(') && route.path.includes(')'))) && route.pattern instanceof RegExp) {
+        } else if(route.complex) {
             let path = req._originalPath;
             if(req._stack.length > 0) {
                 path = path.replace(this.getFullMountpath(req), '');
@@ -445,7 +454,7 @@ module.exports = class Router extends EventEmitter {
     }
 
     async _routeRequest(req, res, startIndex = 0, routes = this._routes, skipCheck = false, skipUntil) {
-        let routeIndex = skipCheck ? startIndex : findIndexStartingFrom(routes, r => (r.all || r.method === req.method || (r.gettable && req.method === 'HEAD')) && this._pathMatches(r, req), startIndex);
+        let routeIndex = skipCheck ? startIndex : findIndexStartingFrom(routes, r => (r.all || r.method === req.method || req._isOptions || (r.gettable && req._isHead)) && this._pathMatches(r, req), startIndex);
         const route = routes[routeIndex];
         if(!route) {
             if(!skipCheck) {
@@ -487,6 +496,9 @@ module.exports = class Router extends EventEmitter {
                 if(thingamabob) {
                     if(thingamabob === 'route' || thingamabob === 'skipPop') {
                         if(route.use && thingamabob !== 'skipPop') {
+                            if(req._isOptions) {
+                                return resolve(false);
+                            }
                             req._stack.pop();
                             
                             req._opPath = req._stack.length > 0 ? req._originalPath.replace(this.getFullMountpath(req), '') : req._originalPath;
@@ -546,6 +558,15 @@ module.exports = class Router extends EventEmitter {
                     }
                     
                     try {
+                        // handling OPTIONS method
+                        if(req._isOptions && !route.all && route.method !== 'OPTIONS') {
+                            req._matchedMethods.add(route.method);
+                            if(route.gettable) {
+                                req._matchedMethods.add('HEAD');
+                            }
+                            return next();
+                        }
+
                         // skipping routes we already went through via optimized path
                         if(!skipCheck && skipUntil && skipUntil.routeKey >= route.routeKey) {
                             return next();