ultimate-express 1.2.30 → 1.3.1

package/README.md

@@ -16,7 +16,7 @@ To make sure µExpress matches behavior of Express in all cases, we run all test
 
 Similar projects based on uWebSockets:
 
-- `express` on Bun - since Bun uses uWS for its HTTP module, Express is about 2-3 times faster than on Node.js, but still slower than µExpress because it doesn't do uWS-specific optimizations.
+- `express` on Bun - since Bun uses uWS for its HTTP module, Express is about 2-3 times faster than on Node.js, but still almost 2 times slower than µExpress because it doesn't do uWS-specific optimizations.
 - `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, middlewares for Express are mostly not supported.
 - `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.
 
@@ -61,6 +61,7 @@ Also tested on a [real-world application](https://nekoweb.org) with templates, s
 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:
 
 - `case sensitive routing` is enabled by default.
+- a new option `catch async errors` is added. If it's enabled, you don't need to use `express-async-errors` module.
 - request body is only read for POST, PUT and PATCH requests by default. You can add additional methods by setting `body methods` to array with uppercased methods.
 - For HTTPS, instead of doing this:  
 ```js
@@ -288,6 +289,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)
 - ✅ [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)
@@ -301,9 +303,9 @@ Almost all middlewares that are compatible with Express are compatible with µEx
 - ✅ [express-subdomain](https://npmjs.com/package/express-subdomain)
 - ✅ [vhost](https://npmjs.com/package/vhost)
 
-Middlewares that are confirmed to not work:
+Middlewares and modules that are confirmed to not work:
 
-- ❌ [compression](https://npmjs.com/package/compression) (doesn't error, but doesn't compress)
+- ❌ [express-async-errors](https://npmjs.com/package/express-async-errors) - doesn't work, use `app.set('catch async errors', true)` instead.
 
 ## Tested view engines
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultimate-express",
-  "version": "1.2.30",
+  "version": "1.3.1",
   "description": "The Ultimate Express. Fastest http server with full Express compatibility, based on uWebSockets.",
   "main": "src/index.js",
   "scripts": {
@@ -31,6 +31,7 @@
     "uwebsockets",
     "uws"
   ],
+  "types": "src/types.d.ts",
   "author": "dimden.dev",
   "license": "Apache-2.0",
   "bugs": {
@@ -38,9 +39,10 @@
   },
   "homepage": "https://github.com/dimdenGD/ultimate-express#readme",
   "dependencies": {
+    "@types/express": "^4.0.0",
     "accepts": "^1.3.8",
     "bytes": "^3.1.2",
-    "cookie": "^0.6.0",
+    "cookie": "^1.0.1",
     "cookie-signature": "^1.2.1",
     "encodeurl": "^2.0.0",
     "etag": "^1.8.1",
@@ -60,6 +62,7 @@
   },
   "devDependencies": {
     "body-parser": "^1.20.3",
+    "compression": "^1.7.4",
     "cookie-parser": "^1.4.6",
     "cookie-session": "^2.1.0",
     "cors": "^2.8.5",
@@ -68,6 +71,7 @@
     "exit-hook": "^2.2.1",
     "express": "^4.19.2",
     "express-art-template": "^1.0.1",
+    "express-async-errors": "^3.1.1",
     "express-dot-engine": "^1.0.8",
     "express-fileupload": "^1.5.1",
     "express-handlebars": "^8.0.1",
@@ -78,6 +82,7 @@
     "multer": "^1.4.5-lts.1",
     "mustache-express": "^1.3.2",
     "pako": "^2.1.0",
+    "pkg-pr-new": "^0.0.29",
     "pug": "^3.0.3",
     "response-time": "^2.3.2",
     "serve-index": "^1.9.1",

package/src/application.js

@@ -16,7 +16,7 @@ limitations under the License.
 
 const uWS = require("uWebSockets.js");
 const Router = require("./router.js");
-const { removeDuplicateSlashes, defaultSettings, compileTrust, createETagGenerator, fastQueryParse } = require("./utils.js");
+const { removeDuplicateSlashes, defaultSettings, compileTrust, createETagGenerator, fastQueryParse, NullObject } = require("./utils.js");
 const querystring = require("fast-querystring");
 const ViewClass = require("./view.js");
 const path = require("path");
@@ -27,7 +27,7 @@ const cpuCount = os.cpus().length;
 
 let workers = [];
 let taskKey = 0;
-const workerTasks = {};
+const workerTasks = new NullObject();
 
 function createWorker() {
     const worker = new Worker(path.join(__dirname, 'worker.js'));
@@ -47,7 +47,7 @@ function createWorker() {
 }
 
 class Application extends Router {
-    constructor(settings = {}) {
+    constructor(settings = new NullObject()) {
         super(settings);
         if(!settings?.uwsOptions) {
             settings.uwsOptions = {};
@@ -62,8 +62,8 @@ class Application extends Router {
             this.uwsApp = uWS.App(settings.uwsOptions);
             this.ssl = false;
         }
-        this.cache = {};
-        this.engines = {};
+        this.cache = new NullObject();
+        this.engines = new NullObject();
         this.locals = {
             settings: this.settings
         };
@@ -159,12 +159,12 @@ class Application extends Router {
     }
 
     enable(key) {
-        this.settings[key] = true;
+        this.set(key, true);
         return this;
     }
 
     disable(key) {
-        this.settings[key] = false;
+        this.set(key, false);
         return this;
     }
 
@@ -206,7 +206,7 @@ class Application extends Router {
                 throw err;
             }
             this.port = uWS.us_socket_local_port(socket);
-            callback(this.port);
+            if(callback) callback(this.port);
         };
         let fn = 'listen';
         let args = [];
@@ -229,6 +229,7 @@ class Application extends Router {
         }
         this.listenCalled = true;
         this.uwsApp[fn](...args);
+        return this.uwsApp;
     }
 
     address() {
@@ -260,10 +261,10 @@ class Application extends Router {
     render(name, options, callback) {
         if(typeof options === 'function') {
             callback = options;
-            options = {};
+            options = new NullObject();
         }
         if(!options) {
-            options = {};
+            options = new NullObject();
         } else {
             options = Object.assign({}, options);
         }
@@ -318,4 +319,4 @@ class Application extends Router {
 
 module.exports = function(options) {
     return new Application(options);
-}
+}

package/src/middlewares.js

@@ -20,10 +20,10 @@ const bytes = require('bytes');
 const zlib = require('fast-zlib');
 const typeis = require('type-is');
 const querystring = require('fast-querystring');
-const { fastQueryParse } = require('./utils.js');
+const { fastQueryParse, NullObject } = require('./utils.js');
 
 function static(root, options) {
-    if(!options) options = {};
+    if(!options) options = new NullObject();
     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;
@@ -132,7 +132,7 @@ function createInflate(contentEncoding) {
 function createBodyParser(defaultType, beforeReturn) {
     return function(options) {
         if(typeof options !== 'object') {
-            options = {};
+            options = new NullObject();
         }
         if(typeof options.limit === 'undefined') options.limit = bytes('100kb');
         else options.limit = bytes(options.limit);
@@ -160,7 +160,7 @@ function createBodyParser(defaultType, beforeReturn) {
                 return next();
             }
 
-            req.body = {};
+            req.body = new NullObject();
 
             // skip reading body for non-json content type
             if(!type) {

package/src/request.js

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-const { patternToRegex, deprecated } = require("./utils.js");
+const { patternToRegex, deprecated, NullObject } = require("./utils.js");
 const accepts = require("accepts");
 const typeis = require("type-is");
 const parseRange = require("range-parser");
@@ -64,7 +64,7 @@ module.exports = class Request extends Readable {
             this._opPath = this._opPath.slice(0, -1);
         }
         this.method = req.getCaseSensitiveMethod().toUpperCase();
-        this.params = {};
+        this.params = new NullObject();
 
         this._gotParams = new Set();
         this._stack = [];
@@ -206,7 +206,7 @@ module.exports = class Request extends Readable {
         if(qp) {
             this.#cachedQuery = qp(this.urlQuery.slice(1));
         } else {
-            this.#cachedQuery = {};
+            this.#cachedQuery = new NullObject();
         }
         return this.#cachedQuery;
     }
@@ -351,7 +351,7 @@ module.exports = class Request extends Readable {
         if(this.#cachedHeaders) {
             return this.#cachedHeaders;
         }
-        let headers = {};
+        let headers = new NullObject();
         this.#rawHeadersEntries.forEach((val) => {
             const key = val[0].toLowerCase();
             const value = val[1];
@@ -382,7 +382,7 @@ module.exports = class Request extends Readable {
         if(this.#cachedDistinctHeaders) {
             return this.#cachedDistinctHeaders;
         }
-        let headers = {};
+        let headers = new NullObject();
         this.#rawHeadersEntries.forEach((val) => {
             if(!headers[val[0]]) {
                 headers[val[0]] = [];

package/src/response.js

@@ -20,7 +20,7 @@ const vary = require("vary");
 const encodeUrl = require("encodeurl");
 const { 
     normalizeType, stringify, deprecated, UP_PATH_REGEXP, decode,
-    containsDotFile, isPreconditionFailure, isRangeFresh, parseHttpDate
+    containsDotFile, isPreconditionFailure, isRangeFresh, NullObject
 } = require("./utils.js");
 const { Writable } = require("stream");
 const { isAbsolute } = require("path");
@@ -70,7 +70,7 @@ module.exports = class Response extends Writable {
         this._res = res;
         this.headersSent = false;
         this.app = app;
-        this.locals = {};
+        this.locals = new NullObject();
         this.finished = false;
         this.aborted = false;
         this.statusCode = 200;
@@ -208,12 +208,9 @@ module.exports = class Response extends Writable {
     _implicitHeader() {
         // compatibility function
         // usually should send headers but this is useless for us
-        return;
+        this.writeHead(this.statusCode);
     }
     status(code) {
-        if(this.headersSent) {
-            throw new Error('Can\'t set status: Response was already sent');
-        }
         this.statusCode = parseInt(code);
         return this;
     }
@@ -224,7 +221,7 @@ module.exports = class Response extends Writable {
         if(this.finished) {
             return;
         }
-        
+        this.writeHead(this.statusCode);
         this._res.cork(() => {
             if(!this.headersSent) {
                 const etagFn = this.app.get('etag fn');
@@ -282,22 +279,23 @@ module.exports = class Response extends Writable {
         }
         if(typeof body === 'string') {
             const contentType = this.headers['content-type'];
-            if(contentType && !contentType.includes(';')) {
+            if(!contentType){
+                this.type('html'); // string defaulting to html
+            } else if(!contentType.includes(';')) {
                 this.headers['content-type'] += '; charset=utf-8';
             }
         }
-        this.writeHead(this.statusCode);
         return this.end(body);
     }
-    sendFile(path, options = {}, callback) {
+    sendFile(path, options = new NullObject(), callback) {
         if(typeof path !== 'string') {
             throw new TypeError('path argument is required to res.sendFile');
         }
         if(typeof options === 'function') {
             callback = options;
-            options = {};
+            options = new NullObject();
         }
-        if(!options) options = {};
+        if(!options) options = new NullObject();
         let done = callback;
         if(!done) done = this.req.next;
         // default options
@@ -489,16 +487,16 @@ module.exports = class Response extends Writable {
     download(path, filename, options, callback) {
         let done = callback;
         let name = filename;
-        let opts = options || {};
+        let opts = options || new NullObject();
 
         // support function as second or third arg
         if (typeof filename === 'function') {
             done = filename;
             name = null;
-            opts = {};
+            opts = new NullObject();
         } else if (typeof options === 'function') {
             done = options;
-            opts = {};
+            opts = new NullObject();
         }
 
         // support optional filename, where options may be in it's place
@@ -519,7 +517,7 @@ module.exports = class Response extends Writable {
     }
     set(field, value) {
         if(this.headersSent) {
-            throw new Error('Can\'t write headers: Response was already sent');
+            throw new Error('Cannot set headers after they are sent to the client');
         }
         if(typeof field === 'object') {
             for(const header in field) {
@@ -578,10 +576,10 @@ module.exports = class Response extends Writable {
     render(view, options, callback) {
         if(typeof options === 'function') {
             callback = options;
-            options = {};
+            options = new NullObject();
         }
         if(!options) {
-            options = {};
+            options = new NullObject();
         } else {
             options = Object.assign({}, options);
         }
@@ -595,7 +593,7 @@ module.exports = class Response extends Writable {
     }
     cookie(name, value, options) {
         if(!options) {
-            options = {};
+            options = new NullObject();
         }
         let val = typeof value === 'object' ? "j:"+JSON.stringify(value) : String(value);
         if(options.maxAge != null) {
@@ -708,9 +706,7 @@ module.exports = class Response extends Writable {
         let ct = type.indexOf('/') === -1
             ? (mime.contentType(type) || 'application/octet-stream')
             : type;
-        if(ct.startsWith('text/') || ct === 'application/json' || ct === 'application/javascript') {
-            ct += '; charset=UTF-8';
-        }
+
         return this.set('content-type', ct);
     }
     contentType(type) {
@@ -784,4 +780,4 @@ function pipeStreamOverResponse(res, readStream, totalSize, callback) {
             if(res.socketExists) res.socket.emit('error', e);
         }
     });
-}
+}

package/src/router.js

@@ -18,6 +18,7 @@ const { patternToRegex, needsConversionToRegex, deprecated, findIndexStartingFro
 const Response = require("./response.js");
 const Request = require("./request.js");
 const { EventEmitter } = require("tseep");
+const { NullObject } = require("./utils.js");
 
 let routeKey = 0;
 
@@ -268,7 +269,7 @@ module.exports = class Router extends EventEmitter {
         const fn = async (res, req) => {
             const { request, response } = this.handleRequest(res, req);
             if(route.optimizedParams) {
-                request.optimizedParams = {};
+                request.optimizedParams = new NullObject();
                 for(let i = 0; i < route.optimizedParams.length; i++) {
                     request.optimizedParams[route.optimizedParams[i]] = req.getParameter(i);
                 }
@@ -319,7 +320,7 @@ module.exports = class Router extends EventEmitter {
 
     _extractParams(pattern, path) {
         let match = pattern.exec(path);
-        const obj = match?.groups ?? {};
+        const obj = match?.groups ?? new NullObject();
         for(let i = 1; i < match.length; i++) {
             obj[i - 1] = match[i];
         }
@@ -342,7 +343,7 @@ module.exports = class Router extends EventEmitter {
                     }
                 }
             } else {
-                req.params = {};
+                req.params = new NullObject();
                 if(req._paramStack.length > 0) {
                     for(let params of req._paramStack) {
                         req.params = {...params, ...req.params};
@@ -485,7 +486,12 @@ module.exports = class Router extends EventEmitter {
                         const out = callback(req, res, next);
                         if(out instanceof Promise) {
                             out.catch(err => {
-                                throw err;
+                                if(this.get("catch async errors")) {
+                                    this._handleError(err, req, res);
+                                    return resolve(true);
+                                } else {
+                                    throw err;
+                                }
                             });
                         }
                     } catch(err) {
@@ -528,7 +534,7 @@ module.exports = class Router extends EventEmitter {
     }
     
     route(path) {
-        let fns = {};
+        let fns = new NullObject();
         for(let method of methods) {
             fns[method] = (...callbacks) => {
                 return this.createRoute(method.toUpperCase(), path, fns, ...callbacks);

package/src/types.d.ts

@@ -0,0 +1,49 @@
+declare module "ultimate-express" {
+  import e from "@types/express";
+  import { AppOptions } from "uWebSockets.js";
+
+  type Settings = {
+    uwsOptions?: AppOptions;
+    threads?: number;
+  };
+
+  namespace express {
+    export import json = e.json;
+    export import raw = e.raw;
+    export import text = e.text;
+
+    // export import application = e.application;
+    export import request = e.request;
+    export import response = e.response;
+
+    export import static = e.static;
+    // export import query = e.query;
+
+    export import urlencoded = e.urlencoded;
+
+    export import RouterOptions = e.RouterOptions;
+    export import Application = e.Application;
+    export import CookieOptions = e.CookieOptions;
+    export import Errback = e.Errback;
+    export import ErrorRequestHandler = e.ErrorRequestHandler;
+    export import Express = e.Express;
+    export import Handler = e.Handler;
+    export import IRoute = e.IRoute;
+    export import IRouter = e.IRouter;
+    export import IRouterHandler = e.IRouterHandler;
+    export import IRouterMatcher = e.IRouterMatcher;
+    export import MediaType = e.MediaType;
+    export import NextFunction = e.NextFunction;
+    export import Locals = e.Locals;
+    export import Request = e.Request;
+    export import RequestHandler = e.RequestHandler;
+    export import RequestParamHandler = e.RequestParamHandler;
+    export import Response = e.Response;
+    export import Router = e.Router;
+    export import Send = e.Send;
+  }
+
+  function express(settings?: Settings): e.Express;
+
+  export = express;
+}

package/src/utils.js

@@ -315,6 +315,10 @@ function isRangeFresh(req, res) {
     return parseHttpDate(lastModified) <= parseHttpDate(ifRange);
 }
 
+// fast null object
+const NullObject = function() {};
+NullObject.prototype = Object.create(null);
+
 module.exports = {
     removeDuplicateSlashes,
     patternToRegex,
@@ -326,6 +330,7 @@ module.exports = {
     compileTrust,
     deprecated,
     UP_PATH_REGEXP,
+    NullObject,
     decode,
     containsDotFile,
     parseTokenList,

package/src/view.js

@@ -16,11 +16,12 @@ limitations under the License.
 
 const path = require("path");
 const fs = require("fs");
+const { NullObject } = require("./utils.js");
 
 module.exports = class View {
     constructor(name, options) {
         this.name = name;
-        this.options = options ? Object.assign({}, options) : {};
+        this.options = options ? Object.assign({}, options) : new NullObject();
         this.defaultEngine = options.defaultEngine;
         this.ext = path.extname(name);
         this.root = options.root;