ultimate-express 1.4.5 → 1.4.7

package/README.md

@@ -308,7 +308,7 @@ Almost all middlewares that are compatible with Express are compatible with µEx
 - ✅ [body-parser](https://npmjs.com/package/body-parser) (use `express.text()` etc instead for better performance)
 - ✅ [cookie-parser](https://npmjs.com/package/cookie-parser)
 - ✅ [cookie-session](https://npmjs.com/package/cookie-session)
-- 🚧 [compression](https://npmjs.com/package/compression) - in some cases may send uncompressed files
+- ✅ [compression](https://npmjs.com/package/compression)
 - ✅ [serve-static](https://npmjs.com/package/serve-static) (use `express.static()` instead for better performance)
 - ✅ [serve-index](https://npmjs.com/package/serve-index)
 - ✅ [cors](https://npmjs.com/package/cors)
@@ -323,6 +323,10 @@ Almost all middlewares that are compatible with Express are compatible with µEx
 - ✅ [vhost](https://npmjs.com/package/vhost)
 - ✅ [tsoa](https://github.com/lukeautry/tsoa)
 - ✅ [express-mongo-sanitize](https://www.npmjs.com/package/express-mongo-sanitize)
+- ✅ [helmet](https://www.npmjs.com/package/helmet)
+- ✅ [passport](https://www.npmjs.com/package/passport)
+- ✅ [morgan](https://www.npmjs.com/package/morgan)
+- ✅ [swagger-ui-express](https://www.npmjs.com/package/swagger-ui-express)
 
 Middlewares and modules that are confirmed to not work:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultimate-express",
-  "version": "1.4.5",
+  "version": "1.4.7",
   "description": "The Ultimate Express. Fastest http server with full Express compatibility, based on uWebSockets.",
   "main": "src/index.js",
   "scripts": {
@@ -43,7 +43,7 @@
   },
   "homepage": "https://github.com/dimdenGD/ultimate-express#readme",
   "dependencies": {
-    "@types/express": "^4.0.0",
+    "@types/express": "^4.17.21",
     "accepts": "^1.3.8",
     "acorn": "^8.14.1",
     "bytes": "^3.1.2",
@@ -86,16 +86,21 @@
     "express-session": "^1.18.0",
     "express-subdomain": "^1.0.6",
     "formdata-node": "^6.0.3",
+    "helmet": "^8.1.0",
     "method-override": "^3.0.0",
+    "morgan": "^1.10.0",
     "multer": "^1.4.5-lts.1",
     "mustache-express": "^1.3.2",
     "nyc": "^17.1.0",
     "pako": "^2.1.0",
+    "passport": "^0.7.0",
+    "passport-local": "^1.0.0",
     "pkg-pr-new": "^0.0.29",
     "pug": "^3.0.3",
     "response-time": "^2.3.3",
     "serve-index": "^1.9.1",
     "serve-static": "^1.16.2",
+    "swagger-ui-express": "^5.0.1",
     "swig": "^1.4.2",
     "vhost": "^3.0.2"
   }

package/src/application.js

@@ -188,6 +188,9 @@ class Application extends Router {
 
             const matchedRoute = await this._routeRequest(request, response);
             if(!matchedRoute && !response.headersSent && !response.aborted) {
+                if(request._error) {
+                    return this._handleError(request._error, null, request, response);
+                }
                 response.status(404);
                 this._sendErrorPage(request, response, `Cannot ${request.method} ${request.path}`, false);
             }

package/src/middlewares.js

@@ -206,7 +206,7 @@ function createBodyParser(defaultType, beforeReturn) {
 
             // skip reading body for non-POST requests
             // this makes it +10k req/sec faster
-            if( additionalMethods === undefined ) additionalMethods = req.app.get('body methods') ?? null;
+            if(additionalMethods === undefined) additionalMethods = req.app.get('body methods') ?? null;
             if(
                 req.method !== 'POST' &&
                 req.method !== 'PUT' &&

package/src/request.js

@@ -37,6 +37,9 @@ module.exports = class Request extends Readable {
     #cachedDistinctHeaders = null;
     #rawHeadersEntries = [];
     #cachedParsedIp = null;
+    #needsData = false;
+    #doneReadingData = false;
+    #bufferedData = null;
     constructor(req, res, app) {
         super();
         this._res = res;
@@ -72,7 +75,6 @@ module.exports = class Request extends Readable {
         this._stack = [];
         this._paramStack = [];
         this.receivedData = false;
-        this.doneReadingData = false;
         // reading ip is very slow in UWS, so its better to not do it unless truly needed
         if(this.app.needsIpAfterResponse || this.key < 100) {
             // if app needs ip after response, read it now because after response its not accessible
@@ -89,18 +91,22 @@ module.exports = class Request extends Readable {
             this.method === 'PATCH' || 
             (additionalMethods && additionalMethods.includes(this.method))
         ) {
-            this.bufferedData = Buffer.allocUnsafe(0);
+            this.#bufferedData = Buffer.allocUnsafe(0);
             this._res.onData((ab, isLast) => {
                 // make stream actually readable
                 this.receivedData = true;
                 if(isLast) {
-                    this.doneReadingData = true;
+                    this.#doneReadingData = true;
                 }
                 // instead of pushing data immediately, buffer it
                 // because writable streams cant handle the amount of data uWS gives (usually 512kb+)
                 const chunk = Buffer.from(ab);
-                this.bufferedData = Buffer.concat([this.bufferedData, chunk]);
-                this._read();
+                this.#bufferedData = Buffer.concat([this.#bufferedData, chunk]);
+                
+                if(this.#needsData) {
+                    this.#needsData = false;
+                    this._read();
+                }
             });
         } else {
             this.receivedData = true;
@@ -108,16 +114,19 @@ module.exports = class Request extends Readable {
     }
 
     _read() {
-        if(!this.receivedData || !this.bufferedData) {
+        if(!this.receivedData || !this.#bufferedData) {
+            this.#needsData = true;
             return;
         }
-        if(this.bufferedData.length > 0) {
+        if(this.#bufferedData.length > 0) {
             // push 128kb chunks
-            const chunk = this.bufferedData.subarray(0, 1024 * 128);
-            this.bufferedData = this.bufferedData.subarray(1024 * 128);
+            const chunk = this.#bufferedData.subarray(0, 1024 * 128);
+            this.#bufferedData = this.#bufferedData.subarray(1024 * 128);
             this.push(chunk);
-        } else if(this.doneReadingData) {
+        } else if(this.#doneReadingData) {
             this.push(null);
+        } else {
+            this.#needsData = true;
         }
     }
 

package/src/response.js

@@ -38,6 +38,7 @@ const etag = require("etag");
 const outgoingMessage = new http.OutgoingMessage();
 const symbols = Object.getOwnPropertySymbols(outgoingMessage);
 const kOutHeaders = symbols.find(s => s.toString() === 'Symbol(kOutHeaders)');
+const HIGH_WATERMARK = 256 * 1024;
 
 class Socket extends EventEmitter {
     constructor(response) {
@@ -68,6 +69,8 @@ class Socket extends EventEmitter {
 
 module.exports = class Response extends Writable {
     #socket = null;
+    #pendingChunks = [];
+    #lastWriteChunkTime = 0;
     constructor(res, req, app) {
         super();
         this._req = req;
@@ -147,7 +150,17 @@ module.exports = class Response extends Writable {
             }
     
             if (this.chunkedTransfer) {
-                this._res.write(chunk);
+                this.#pendingChunks.push(chunk);
+                const size = this.#pendingChunks.reduce((acc, chunk) => acc + chunk.byteLength, 0);
+                const now = Date.now();
+                // the first chunk is set immediately (!this.#lastWriteChunkTime)
+                // the other chunks are sent when watermark is reached (size >= HIGH_WATERMARK) 
+                // or if elapsed 100ms of last send (now - this.#lastWriteChunkTime > 100)
+                if (!this.#lastWriteChunkTime || size >= HIGH_WATERMARK || now - this.#lastWriteChunkTime > 100) {
+                    this._res.write(Buffer.concat(this.#pendingChunks, size));
+                    this.#pendingChunks = [];
+                    this.#lastWriteChunkTime = now;
+                }
                 this.writingChunk = false;
                 callback(null);
             } else {
@@ -261,6 +274,11 @@ module.exports = class Response extends Writable {
             if(!data && contentLength) {
                 this._res.endWithoutBody(contentLength.toString());
             } else {
+                if(this.#pendingChunks.length) {
+                    this._res.write(Buffer.concat(this.#pendingChunks));
+                    this.#pendingChunks = [];
+                    this.lastWriteChunkTime = 0;
+                }
                 if(data instanceof Buffer) {
                     data = data.buffer.slice(data.byteOffset, data.byteOffset + data.byteLength);
                 }
@@ -271,11 +289,12 @@ module.exports = class Response extends Writable {
                     this._res.end(data);
                 }
             }
+            
             this.finished = true;
             if(this.socketExists) this.socket.emit('close');
+            this.emit('finish');
+            this.emit('close');
         });
-
-        this.emit('finish')
         return this;
     }
 
@@ -498,7 +517,7 @@ module.exports = class Response extends Writable {
         } else {
             // larger files or range requests are piped over response
             let opts = {
-                highWaterMark: 256 * 1024
+                highWaterMark: HIGH_WATERMARK
             };
             if(ranged) {
                 opts.start = offset;

package/src/router.js

@@ -46,7 +46,6 @@ module.exports = class Router extends EventEmitter {
         this._paramCallbacks = new Map();
         this._mountpathCache = new Map();
         this._routes = [];
-        this.errorRoute = undefined;
         this.mountpath = '/';
         this.settings = settings;
         this._request = Request;
@@ -293,6 +292,9 @@ module.exports = class Router extends EventEmitter {
             }
             const matchedRoute = await this._routeRequest(request, response, 0, optimizedPath, true, route);
             if(!matchedRoute && !response.headersSent && !response.aborted) {
+                if(request._error) {
+                    return this._handleError(request._error, null, request, response);
+                }
                 response.status(404);
                 request.noEtag = true;
                 this._sendErrorPage(request, response, `Cannot ${request.method} ${request._originalPath}`, false);
@@ -332,20 +334,12 @@ module.exports = class Router extends EventEmitter {
         }
     }
 
-    _handleError(err, request, response) {
-        let errorRoute = this.errorRoute, parent = this.parent;
-        while(!errorRoute && parent) {
-            errorRoute = parent.errorRoute;
-            parent = parent.parent;
-        }
-        if(errorRoute) {
-            return errorRoute(err, request, response, () => {
-                if(!response.headersSent) {
-                    if(response.statusCode === 200) {
-                        response.statusCode = 500;
-                    }
-                    this._sendErrorPage(request, response, err, true);
-                }
+    _handleError(err, handler, request, response) {
+        if(handler) {
+            return handler(err, request, response, () => {
+                delete request._error;
+                delete request._errorKey;
+                return request.next();
             });
         }
         console.error(err);
@@ -405,8 +399,8 @@ module.exports = class Router extends EventEmitter {
                                         if(thingamabob === 'route') {
                                             return resolve('route');
                                         } else {
-                                            this._handleError(thingamabob, req, res);
-                                            return resolve(false);
+                                            req._error = thingamabob;
+                                            req._errorKey = route.routeKey;
                                         }
                                     }
                                     return resolveRoute();
@@ -460,7 +454,7 @@ module.exports = class Router extends EventEmitter {
         let callbackindex = 0;
 
         // avoid calling _preprocessRequest as async function as its slower
-        // but it seems like calling it as async has unintended consequence of resetting max call stack size
+        // but it seems like calling it as async has unintended, but useful consequence of resetting max call stack size
         // so call it as async when the request has been through every 300 routes to reset it
         const continueRoute = this._paramCallbacks.size === 0 && req.routeCount % 300 !== 0 ? 
             this._preprocessRequest(req, res, route) : await this._preprocessRequest(req, res, route);
@@ -513,8 +507,8 @@ module.exports = class Router extends EventEmitter {
                         req.routeCount++;
                         return resolve(this._routeRequest(req, res, routeIndex + 1, routes, skipCheck, skipUntil));
                     } else {
-                        this._handleError(thingamabob, req, res);
-                        return resolve(true);
+                        req._error = thingamabob;
+                        req._errorKey = route.routeKey;
                     }
                 }
                 const callback = route.callbacks[callbackindex++];
@@ -535,6 +529,15 @@ module.exports = class Router extends EventEmitter {
                     if(routed) return resolve(true);
                     next();
                 } else {
+                    // handle errors and error handlers
+                    if(req._error || callback.length === 4) {
+                        if(req._error && callback.length === 4 && route.routeKey >= req._errorKey) {
+                            return this._handleError(req._error, callback, req, res);
+                        } else {
+                            return next();
+                        }
+                    }
+                    
                     try {
                         // skipping routes we already went through via optimized path
                         if(!skipCheck && skipUntil && skipUntil.routeKey >= route.routeKey) {
@@ -544,16 +547,18 @@ module.exports = class Router extends EventEmitter {
                         if(out instanceof Promise) {
                             out.catch(err => {
                                 if(this.get("catch async errors")) {
-                                    this._handleError(err, req, res);
-                                    return resolve(true);
+                                    req._error = err;
+                                    req._errorKey = route.routeKey;
+                                    return next();
                                 } else {
                                     throw err;
                                 }
                             });
                         }
                     } catch(err) {
-                        this._handleError(err, req, res);
-                        return resolve(true);
+                        req._error = err;
+                        req._errorKey = route.routeKey;
+                        return next();
                     }
                 }
             }
@@ -570,16 +575,14 @@ module.exports = class Router extends EventEmitter {
 
     use(path, ...callbacks) {
         if(typeof path === 'function' || path instanceof Router || (Array.isArray(path) && path.every(p => typeof p === 'function' || p instanceof Router))) {
-            if(callbacks.length === 0 && typeof path === 'function' && path.length === 4) {
-                this.errorRoute = path;
-                return;
-            }
             callbacks.unshift(path);
             path = '';
         }
         if(path === '/') {
             path = '';
         }
+        callbacks = callbacks.flat();
+        
         for(let callback of callbacks) {
             if(callback instanceof Router) {
                 callback.mountpath = path;

package/src/utils.js

@@ -55,8 +55,9 @@ function patternToRegex(pattern, isPrefix = false) {
         .replaceAll('.', '\\.')
         .replaceAll('-', '\\-')
         .replaceAll('*', '(.*)') // Convert * to .*
-        .replace(/:(\w+)(\(.+?\))?/g, (match, param, regex) => {
-            return `(?<${param}>${regex ? regex + '($|\\/)' : '[^/]+'})`;
+        .replace(/\/:(\w+)(\(.+?\))?\??/g, (match, param, regex) => {
+            const optional = match.endsWith('?');
+            return `\\/${optional ? '?' : ''}?(?<${param}>${regex ? regex + '($|\\/)' : '[^/]+'})${optional ? '?' : ''}`;
         }); // Convert :param to capture group
 
     return new RegExp(`^${regexPattern}${isPrefix ? '(?=$|\/)' : '$'}`);