ultimate-express 1.2.29 → 1.3.0

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
@@ -301,9 +302,10 @@ 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)
+- ❌ [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.29",
+  "version": "1.3.0",
   "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,6 +39,7 @@
   },
   "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",
@@ -68,6 +70,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",

package/src/application.js

@@ -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;
     }
 

package/src/response.js

@@ -69,13 +69,12 @@ module.exports = class Response extends Writable {
         this._req = req;
         this._res = res;
         this.headersSent = false;
-        this.aborted = false;
         this.app = app;
         this.locals = {};
+        this.finished = false;
         this.aborted = false;
         this.statusCode = 200;
         this.chunkedTransfer = true;
-        this.finished = false;
         this.totalSize = 0;
         this.headers = {
             'connection': 'keep-alive',
@@ -96,7 +95,7 @@ module.exports = class Response extends Writable {
         });
         this.body = undefined;
         this.on('error', (err) => {
-            if(this.aborted) {
+            if(this.finished) {
                 return;
             }
             this._res.cork(() => {
@@ -121,6 +120,10 @@ module.exports = class Response extends Writable {
             err.code = 'ECONNABORTED';
             return this.destroy(err);
         }
+        if(this.finished) {
+            const err = new Error('Response already finished');
+            return this.destroy(err);
+        }
         this._res.cork(() => {
             if(!this.headersSent) {
                 this.writeHead(this.statusCode);
@@ -149,7 +152,7 @@ module.exports = class Response extends Writable {
                     if(!ok) {
                         // wait until uWS is ready to accept more data
                         this._res.onWritable((offset) => {
-                            if(this.aborted) {
+                            if(this.finished) {
                                 return true;
                             }
                             const [ok, done] = this._res.tryEnd(chunk.slice(offset - lastOffset), this.totalSize);
@@ -221,7 +224,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');
@@ -283,7 +286,6 @@ module.exports = class Response extends Writable {
                 this.headers['content-type'] += '; charset=utf-8';
             }
         }
-        this.writeHead(this.statusCode);
         return this.end(body);
     }
     sendFile(path, options = {}, callback) {
@@ -462,7 +464,7 @@ module.exports = class Response extends Writable {
         // serve smaller files using workers
         if(this.app.workers.length && stat.size < 768 * 1024 && !ranged) {
             this.app.readFileWithWorker(fullpath).then((data) => {
-                if(this._res.aborted) {
+                if(this._res.finished) {
                     return;
                 }
                 this.end(data);
@@ -730,7 +732,7 @@ module.exports = class Response extends Writable {
 
 function pipeStreamOverResponse(res, readStream, totalSize, callback) {
     readStream.on('data', (chunk) => {
-        if(res.aborted) {
+        if(res.finished) {
             return readStream.destroy();
         }
         res._res.cork(() => {
@@ -756,7 +758,7 @@ function pipeStreamOverResponse(res, readStream, totalSize, callback) {
                 res._res.abOffset = lastOffset;
         
                 res._res.onWritable((offset) => {
-                    if(res.aborted) {
+                    if(res.finished) {
                         return true;
                     }
                     const [ok, done] = res._res.tryEnd(res._res.ab.slice(offset - res._res.abOffset), totalSize);
@@ -781,4 +783,4 @@ function pipeStreamOverResponse(res, readStream, totalSize, callback) {
             if(res.socketExists) res.socket.emit('error', e);
         }
     });
-}
+}

package/src/router.js

@@ -248,6 +248,7 @@ module.exports = class Router extends EventEmitter {
             const err = new Error('Connection closed');
             err.code = 'ECONNRESET';
             response.aborted = true;
+            response.finished = true;
             response.socket.emit('error', err);
         });
 
@@ -484,7 +485,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) {

package/src/types.d.ts

@@ -0,0 +1,4 @@
+declare module 'ultimate-express' {
+    import express from '@types/express';
+    export = express;
+}