ultimate-express 1.4.8 → 1.4.10

package/README.md

@@ -35,6 +35,7 @@ Tested using [wrk](https://github.com/wg/wrk) (`-d 60 -t 1 -c 200`). Tested on U
 | middlewares/express-static (/static/index.js) | 6.58k           | 32.45k           | 10.15 MB/sec       | 49.43 MB/sec        | **4.87X**        |
 | engines/ejs (/test)                           | 5.50k           | 40.82k           | 2.45 MB/sec        | 18.38 MB/sec        | **7.42X**        |
 | middlewares/body-urlencoded (/abc)            | 8.07k           | 50.52k           | 1.68 MB/sec        | 10.78 MB/sec        | **6.26X**        |
+| middlewares/compression-file (/small-file)    | 4.81k           | 14.92k           | 386 MB/sec         | 1.17 GB/sec         | **3.10X**        |
 
 ### Performance against other frameworks
 
@@ -101,7 +102,7 @@ app.listen(3000, () => {
 ```
 
 - This also applies to non-SSL HTTP too. Do not create http server manually, use `app.listen()` instead.
-- NodeJS max header size is 16384 byte, uWebSockets 4096 byte, if you need long headers set the env variable `UWS_HTTP_MAX_HEADERS_SIZE`
+- Node.JS max header size is 16384 bytes, while uWebSockets by default is 4096 bytes, so if you need longer headers set the env variable `UWS_HTTP_MAX_HEADERS_SIZE` to max byte count you need.
 
 ## Performance tips
 
@@ -327,6 +328,8 @@ Almost all middlewares that are compatible with Express are compatible with µEx
 - ✅ [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)
+- ✅ [graphql-http](https://www.npmjs.com/package/graphql-http)
+- ✅ [better-sse](https://www.npmjs.com/package/better-sse)
 
 Middlewares and modules that are confirmed to not work:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultimate-express",
-  "version": "1.4.8",
+  "version": "1.4.10",
   "description": "The Ultimate Express. Fastest http server with full Express compatibility, based on uWebSockets.",
   "main": "src/index.js",
   "scripts": {
@@ -67,6 +67,7 @@
   },
   "devDependencies": {
     "@codechecks/client": "^0.1.12",
+    "better-sse": "^0.14.1",
     "body-parser": "^1.20.3",
     "compression": "^1.8.0",
     "cookie-parser": "^1.4.6",
@@ -74,6 +75,7 @@
     "cors": "^2.8.5",
     "ejs": "^3.1.10",
     "errorhandler": "^1.5.1",
+    "eventsource": "^3.0.6",
     "exit-hook": "^2.2.1",
     "express": "latest-4",
     "express-art-template": "^1.0.1",
@@ -86,6 +88,7 @@
     "express-session": "^1.18.0",
     "express-subdomain": "^1.0.6",
     "formdata-node": "^6.0.3",
+    "graphql-http": "^1.22.4",
     "helmet": "^8.1.0",
     "method-override": "^3.0.0",
     "morgan": "^1.10.0",

package/src/declarative.js

@@ -31,7 +31,7 @@ module.exports = function compileDeclarative(cb, app) {
 
         const tokens = [...acorn.tokenizer(code, { ecmaVersion: "latest" })];
 
-        if(tokens.some(token => ['throw', 'new', 'await'].includes(token.value))) {
+        if(tokens.some(token => ['throw', 'new', 'await', 'return'].includes(token.value))) {
             return false;
         }
 
@@ -186,7 +186,7 @@ module.exports = function compileDeclarative(cb, app) {
                 if(call.arguments[0].type !== 'Literal' || call.arguments[1].type !== 'Literal') {
                     return false;
                 }
-                const sameHeader = headers.find(header => header[0] === call.arguments[0].value);
+                const sameHeader = headers.find(header => header[0].toLowerCase() === call.arguments[0].value.toLowerCase());
                 if(sameHeader) {
                     sameHeader[1] = call.arguments[1].value;
                 } else {
@@ -201,8 +201,18 @@ module.exports = function compileDeclarative(cb, app) {
         }
 
         // get body
+        let sendUsed = false;
         for(let call of callExprs) {
             if(call.obj.propertyName === 'send' || call.obj.propertyName === 'end') {
+                if(sendUsed) {
+                    return false;
+                }
+                if(call.obj.propertyName === 'send') {
+                    const index = headers.findIndex(header => header[0].toLowerCase() === 'content-type');
+                    if(index === -1) {
+                        headers.push(['content-type', 'text/html; charset=utf-8']);
+                    }
+                }
                 const arg = call.arguments[0];
                 if(arg) {
                     if(arg.type === 'Literal') {
@@ -212,6 +222,17 @@ module.exports = function compileDeclarative(cb, app) {
                         let val = arg.value;
                         if(val === null) {
                             val = '';
+                            const index = headers.findIndex(header => header[0].toLowerCase() === 'content-type');
+                            if(index !== -1) {
+                                headers.splice(index, 1);
+                            }
+                        }
+                        if(typeof val === 'boolean') {
+                            if(!headers.some(header => header[0].toLowerCase() === 'content-type')) {
+                                headers.push(['content-type', 'application/json; charset=utf-8']);
+                            } else {
+                                headers.find(header => header[0].toLowerCase() === 'content-type')[1] = 'application/json; charset=utf-8';
+                            }
                         }
                         body.push({type: 'text', value: val});
                     } else if(arg.type === 'TemplateLiteral') {
@@ -300,7 +321,11 @@ module.exports = function compileDeclarative(cb, app) {
                             return false;
                         }
 
-                        headers.push(['content-type', 'application/json; charset=utf-8']);
+                        if(!headers.some(header => header[0].toLowerCase() === 'content-type')) {
+                            headers.push(['content-type', 'application/json; charset=utf-8']);
+                        } else {
+                            headers.find(header => header[0].toLowerCase() === 'content-type')[1] = 'application/json; charset=utf-8';
+                        }
                         body.push({
                             type: 'text',
                             value: 
@@ -315,6 +340,7 @@ module.exports = function compileDeclarative(cb, app) {
                         return false;
                     }
                 }
+                sendUsed = true;
             }
         }
 
@@ -329,6 +355,9 @@ module.exports = function compileDeclarative(cb, app) {
             if(header[0].toLowerCase() === 'content-length') {
                 return false;
             }
+            if(header[0].toLowerCase() === 'content-type' && header[1].includes('text/') && !header[1].includes(';')) {
+                header[1] += '; charset=utf-8';
+            }
             decRes = decRes.writeHeader(header[0], header[1]);
         }
 

package/src/middlewares.js

@@ -169,7 +169,7 @@ function createBodyParser(defaultType, beforeReturn) {
 
             req.body = new NullObject();
 
-            // skip reading body for non-json content type
+            // skip reading body for no content type
             if(!type) {
                 return next();
             }
@@ -281,6 +281,10 @@ const json = createBodyParser('application/json', function(req, res, next, optio
             return next(new Error('Invalid body'));
         }
     }
+    if(buf.length === 0) {
+        req.body = {};
+        return next();
+    }
     try {
         req.body = JSON.parse(buf.toString(), options.reviver);
     } catch(e) {

package/src/response.js

@@ -71,6 +71,7 @@ module.exports = class Response extends Writable {
     #socket = null;
     #pendingChunks = [];
     #lastWriteChunkTime = 0;
+    #writeTimeout = null;
     constructor(res, req, app) {
         super();
         this._req = req;
@@ -155,11 +156,28 @@ module.exports = class Response extends Writable {
                 const now = Date.now();
                 // the first chunk is sent 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) {
+                // or if elapsed 50ms of last send (now - this.#lastWriteChunkTime > 50)
+                if (!this.#lastWriteChunkTime || size >= HIGH_WATERMARK || now - this.#lastWriteChunkTime > 50) {
                     this._res.write(Buffer.concat(this.#pendingChunks, size));
                     this.#pendingChunks = [];
                     this.#lastWriteChunkTime = now;
+                    if(this.#writeTimeout) {
+                        clearTimeout(this.#writeTimeout);
+                        this.#writeTimeout = null;
+                    }
+                } else if(!this.#writeTimeout) {
+                    this.#writeTimeout = setTimeout(() => {
+                        this.#writeTimeout = null;
+                        if(!this.finished && !this.aborted) this._res.cork(() => {
+                            if(this.#pendingChunks.length) {
+                                const size = this.#pendingChunks.reduce((acc, chunk) => acc + chunk.byteLength, 0);
+                                this._res.write(Buffer.concat(this.#pendingChunks, size));
+                                this.#pendingChunks = [];
+                                this.#lastWriteChunkTime = now;
+                            }
+                        });
+                    }, 50);
+                    this.#writeTimeout.unref();
                 }
                 this.writingChunk = false;
                 callback(null);
@@ -201,12 +219,13 @@ module.exports = class Response extends Writable {
             this.statusText = statusMessage;
         }
         if(!headers) {
-            if(!statusMessage) return;
+            if(!statusMessage) return this;
             headers = statusMessage;
         }
         for(let header in headers) {
             this.set(header, headers[header]);
         }
+        return this;
     }
     writeHeaders(utf8) {
         for(const header in this.headers) {
@@ -225,9 +244,6 @@ module.exports = class Response extends Writable {
                 this._res.writeHeader(header, value);
             }
         }
-        if(!this.headers['content-type']) {
-            this._res.writeHeader('content-type', 'text/html' + (utf8 ? `; charset=utf-8` : ''));
-        }
         this.headersSent = true;
     }
     _implicitHeader() {
@@ -267,6 +283,8 @@ module.exports = class Response extends Writable {
                     this._res.end();
                     this.finished = true;
                     if(this.socketExists) this.socket.emit('close');
+                    this.emit('finish');
+                    this.emit('close');
                     return;
                 }
             }
@@ -305,6 +323,7 @@ module.exports = class Response extends Writable {
         const isBuffer = Buffer.isBuffer(body);
         if(body === null || body === undefined) {
             body = '';
+            return this.end(body);
         } else if(typeof body === 'object' && !isBuffer) {
             return this.json(body);
         } else if(typeof body === 'number') {
@@ -313,18 +332,25 @@ module.exports = class Response extends Writable {
                 return this.status(body).send(arguments[1]);
             } else {
                 deprecated('res.send(status)', 'res.sendStatus(status)');
+                if(!this.headers['content-type']) {
+                    this.headers['content-type'] = 'text/plain; charset=utf-8';
+                }
                 return this.sendStatus(body);
             }
+        } else if(typeof body === 'boolean') {
+            return this.json(body);
         } else if(!isBuffer) {
             body = String(body);
         }
-        if(typeof body === 'string') {
+        if(typeof body === 'string' && !isBuffer) {
             const contentType = this.headers['content-type'];
             if(!contentType) {
                 this.headers['content-type'] = 'text/html; charset=utf-8';
             } else if(!contentType.includes(';')) {
                 this.headers['content-type'] += '; charset=utf-8';
             }
+        } else {
+            this.headers['content-type'] = 'application/octet-stream';
         }
         return this.end(body);
     }
@@ -593,6 +619,9 @@ module.exports = class Response extends Writable {
     getHeader(field) {
         return this.get(field);
     }
+    getHeaders(){
+        return this.headers;
+    }
     removeHeader(field) {
         delete this.headers[field.toLowerCase()];
         return this;
@@ -696,11 +725,7 @@ module.exports = class Response extends Writable {
     jsonp(object) {
         let callback = this.req.query[this.app.get('jsonp callback name')];
         let body = stringify(object, this.app.get('json replacer'), this.app.get('json spaces'), this.app.get('json escape'));
-
-        if(!this.headers['content-type']) {
-            this.headers['content-type'] = 'application/javascript; charset=utf-8';
-            this.headers['X-Content-Type-Options'] = 'nosniff';
-        }
+        let js = false;
 
         if(Array.isArray(callback)) {
             callback = callback[0];
@@ -718,6 +743,13 @@ module.exports = class Response extends Writable {
                     .replace(/\u2029/g, '\\u2029')
             }
             body = '/**/ typeof ' + callback + ' === \'function\' && ' + callback + '(' + body + ');';
+            js = true;
+        }
+
+        
+        if(!this.headers['content-type']) {
+            this.headers['content-type'] = `${js ? 'text/javascript' : 'application/json'}; charset=utf-8`;
+            if(js) this.headers['X-Content-Type-Options'] = 'nosniff';
         }
 
         return this.send(body);
@@ -742,7 +774,25 @@ module.exports = class Response extends Writable {
         this.location(url);
         this.status(status);
         this.headers['content-type'] = 'text/plain; charset=utf-8';
-        return this.send(`${statuses.message[status] ?? status}. Redirecting to ${url}`);
+        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 (this.req.method === 'HEAD') {
+            this.end();
+        } else {
+            this.end(body);
+        }
     }
 
     type(type) {
@@ -755,6 +805,11 @@ module.exports = class Response extends Writable {
     contentType = this.type;
 
     vary(field) {
+        // checks for back-compat
+        if (!field || (Array.isArray(field) && !field.length)) {
+            deprecate('res.vary(): Provide a field name');
+            return this;
+        }
         vary(this, field);
         return this;
     }
@@ -766,4 +821,4 @@ module.exports = class Response extends Writable {
     get writableFinished() {
         return this.finished;
     }
-}
+}

package/src/router.js

@@ -180,7 +180,7 @@ module.exports = class Router extends EventEmitter {
                         optimizedPathToRouter = optimizedPathToRouter.slice(0, -1); // remove last element, which is the router itself
                         if(optimizedPathToRouter) {
                             // wait for routes in router to be registered
-                            setTimeout(() => {
+                            const t = setTimeout(() => {
                                 if(!this.listenCalled) {
                                     return; // can only optimize router whos parent is listening
                                 }
@@ -208,6 +208,7 @@ module.exports = class Router extends EventEmitter {
                                     }
                                 }
                             }, 100);
+                            t.unref();
                         }
                         // only 1 router can be optimized per route
                         break;
@@ -354,7 +355,10 @@ module.exports = class Router extends EventEmitter {
             path = path.slice(0, -1);
         }
         let match = pattern.exec(path);
-        const obj = match?.groups ?? new NullObject();
+        if( match?.groups ){
+            return match.groups;
+        }
+        const obj = new NullObject();
         for(let i = 1; i < match.length; i++) {
             obj[i - 1] = match[i];
         }
@@ -526,6 +530,9 @@ module.exports = class Router extends EventEmitter {
                         req._opPath += '/';
                     }
                     const routed = await callback._routeRequest(req, res, 0);
+                    if (req._error) {
+                        req._errorKey = route.routeKey;
+                    }
                     if(routed) return resolve(true);
                     next();
                 } else {

package/src/view.js

@@ -59,26 +59,25 @@ module.exports = class View {
                 this.path += this.ext;
             }
         } else {
-            this.path = path.join(this.root, fileName);
+            this.path = this.lookup(fileName);
         }
     }
 
     lookup(name) {
-        let path;
+        let _path;
         let roots = [].concat(this.root);
-        for (let i = 0; i < roots.length && !path; i++) {
+        for (let i = 0; i < roots.length && !_path; i++) {
             const root = roots[i];
         
             // resolve the path
             const loc = path.resolve(root, name);
             const dir = path.dirname(loc);
             const file = path.basename(loc);
-        
+            
             // resolve the file
-            path = this.resolve(dir, file);
+            _path = this.resolve(dir, file);
         }
-        
-        return path;
+        return _path;
     }
 
     // ill be real idk what exactly this does but express implements it this way
@@ -101,19 +100,19 @@ module.exports = class View {
         const ext = this.ext;
 
         // <path>.<ext>
-        let path = path.join(dir, file);
-        let stat = tryStat(path);
+        let _path = path.join(dir, file);
+        let stat = tryStat(_path);
 
         if(stat && stat.isFile()) {
-            return path;
+            return _path;
         }
 
         // <path>/index.<ext>
-        path = path.join(dir, path.basename(file, ext) + ext);
-        stat = tryStat(path);
+        _path = path.join(dir, path.basename(file, ext), 'index' + ext);
+        stat = tryStat(_path);
 
         if(stat && stat.isFile()) {
-            return path;
+            return _path;
         }
     }
 }