ultimate-express 1.0.8 → 1.1.0

package/README.md

@@ -93,7 +93,7 @@ Optimized routes can be up to 10 times faster than normal routes, as they're usi
 
 3. Do not set `body methods` to read body of requests with GET method or other methods that don't need a body. Reading body makes server about 10k req/sec slower.
 
-4. By default, µExpress creates 1 worker thread for reading files (or 0 if your CPU has only 1 core). You can change this number by setting `fsThreads` to a different number in `express()`, or set to 0 to disable thread pool for file reading (`express({ fsThreads: 0 })`). Threads are shared between all express() instances, with largest fsThreads number being used. Using more threads will not necessarily improve performance. Sometimes not using threads at all is faster, please [test](https://github.com/wg/wrk/) both options.
+4. By default, µExpress creates 1 (or 0 if your CPU has only 1 core) child thread to improve performance of reading files and computing hashes for etag. You can change this number by setting `threads` to a different number in `express()`, or set to 0 to disable thread pool (`express({ threads: 0 })`). Threads are shared between all express() instances, with largest `threads` number being used. Using more threads will not necessarily improve performance. Sometimes not using threads at all is faster, please [test](https://github.com/wg/wrk/) both options.
 
 ## Compatibility
 
@@ -110,6 +110,7 @@ In general, basically all features and options are supported. Use [Express 4.x d
 - ✅ express.json()
 - ✅ express.urlencoded()
 - ✅ express.static()
+- - Additionally you can pass `options.ifModifiedSince` to support If-Modified-Since header (this header is not supported in normal Express, but is supported in µExpress)
 - ✅ express.text()
 - ✅ express.raw()
 - 🚧 express.request (this is not a constructor but a prototype for replacing methods)

package/package.json

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

package/src/application.js

@@ -10,25 +10,25 @@ const { Worker } = require("worker_threads");
 
 const cpuCount = os.cpus().length;
 
-let fsWorkers = [];
-let fsKey = 0;
-const fsCache = {};
+let workers = [];
+let taskKey = 0;
+const workerTasks = {};
 
-function createFsWorker() {
-    const fsWorker = new Worker(path.join(__dirname, 'workers/fs.js'));
-    fsWorkers.push(fsWorker);
+function createWorker() {
+    const worker = new Worker(path.join(__dirname, 'worker.js'));
+    workers.push(worker);
 
-    fsWorker.on('message', (message) => {
+    worker.on('message', (message) => {
         if(message.err) {
-            fsCache[message.key].reject(new Error(message.err));
+            workerTasks[message.key].reject(new Error(message.err));
         } else {
-            fsCache[message.key].resolve(message.data);
+            workerTasks[message.key].resolve(message.data);
         }
-        delete fsCache[message.key];
+        delete workerTasks[message.key];
     });
-    fsWorker.unref();
+    worker.unref();
 
-    return fsWorker;
+    return worker;
 }
 
 class Application extends Router {
@@ -37,8 +37,8 @@ class Application extends Router {
         if(!settings?.uwsOptions) {
             settings.uwsOptions = {};
         }
-        if(typeof settings.fsThreads !== 'number') {
-            settings.fsThreads = cpuCount > 1 ? 1 : 0;
+        if(typeof settings.threads !== 'number') {
+            settings.threads = cpuCount > 1 ? 1 : 0;
         }
         if(settings.uwsOptions.key_file_name && settings.uwsOptions.cert_file_name) {
             this.uwsApp = uWS.SSLApp(settings.uwsOptions);
@@ -53,12 +53,12 @@ class Application extends Router {
             settings: this.settings
         };
         this.listenCalled = false;
-        this.fsWorkers = [];
-        for(let i = 0; i < settings.fsThreads; i++) {
-            if(fsWorkers[i]) {
-                this.fsWorkers[i] = fsWorkers[i];
+        this.workers = [];
+        for(let i = 0; i < settings.threads; i++) {
+            if(workers[i]) {
+                this.workers[i] = workers[i];
             } else {
-                this.fsWorkers[i] = createFsWorker();
+                this.workers[i] = createWorker();
             }
         }
         this.port = undefined;
@@ -77,12 +77,12 @@ class Application extends Router {
 
     readFileWithWorker(path) {
         return new Promise((resolve, reject) => {
-            const fsWorker = this.fsWorkers[Math.floor(Math.random() * this.fsWorkers.length)];
-            const key = fsKey++;
-            fsWorker.postMessage({ key, type: 'readFile', path });
-            fsCache[key] = { resolve, reject };
+            const worker = this.workers[Math.floor(Math.random() * this.workers.length)];
+            const key = taskKey++;
+            worker.postMessage({ key, type: 'readFile', path });
+            workerTasks[key] = { resolve, reject };
             if(key > 1000000) {
-                fsKey = 0;
+                taskKey = 0;
             }
         });
     }

package/src/middlewares.js

@@ -17,10 +17,11 @@ function static(root, options) {
         options.extensions = options.extensions.map(ext => ext.startsWith('.') ? ext.slice(1) : ext);
     }
     options.root = root;
+    options.skipEncodePath = true;
 
     return (req, res, next) => {
         const iq = req.url.indexOf('?');
-        let url = iq !== -1 ? req.url.substring(0, iq) : req.url;
+        let url = decodeURIComponent(iq !== -1 ? req.url.substring(0, iq) : req.url);
         let _path = url;
         let fullpath = path.resolve(path.join(options.root, url));
         if(options.root && !fullpath.startsWith(path.resolve(options.root))) {

package/src/response.js

@@ -244,6 +244,9 @@ module.exports = class Response extends Writable {
             this.status(500);
             return done(new Error('path must be absolute or specify root to res.sendFile'));
         }
+        if(!options.skipEncodePath) {
+            path = encodeURI(path);
+        }
         path = decode(path);
         if(path === -1) {
             this.status(400);
@@ -349,27 +352,30 @@ module.exports = class Response extends Writable {
 
         // range requests
         let offset = 0, len = stat.size, ranged = false;
-        if(options.acceptRanges && this.req.headers.range) {
-            let ranges = this.req.range(stat.size, {
-                combine: true
-            });
-
-            // if-range
-            if(!isRangeFresh(this.req, this)) {
-                ranges = -2;
-            }
-
-            if(ranges === -1) {
-                this.status(416);
-                this.set('Content-Range', `bytes */${stat.size}`);
-                return done(new Error('Range Not Satisfiable'));
-            }
-            if(ranges !== -2 && ranges.length === 1) {
-                this.status(206);
-                this.set('Content-Range', `bytes ${ranges[0].start}-${ranges[0].end}/${stat.size}`);
-                offset = ranges[0].start;
-                len = ranges[0].end - ranges[0].start + 1;
-                ranged = true;
+        if(options.acceptRanges) {
+            this.set('accept-ranges', 'bytes');
+            if(this.req.headers.range) {
+                let ranges = this.req.range(stat.size, {
+                    combine: true
+                });
+    
+                // if-range
+                if(!isRangeFresh(this.req, this)) {
+                    ranges = -2;
+                }
+    
+                if(ranges === -1) {
+                    this.status(416);
+                    this.set('Content-Range', `bytes */${stat.size}`);
+                    return done(new Error('Range Not Satisfiable'));
+                }
+                if(ranges !== -2 && ranges.length === 1) {
+                    this.status(206);
+                    this.set('Content-Range', `bytes ${ranges[0].start}-${ranges[0].end}/${stat.size}`);
+                    offset = ranges[0].start;
+                    len = ranges[0].end - ranges[0].start + 1;
+                    ranged = true;
+                }
             }
         }
 
@@ -379,7 +385,7 @@ module.exports = class Response extends Writable {
         }
 
         // serve smaller files using workers
-        if(this.app.fsWorkers.length && stat.size < 1024 * 1024 && !ranged) {
+        if(this.app.workers.length && stat.size < 1024 * 1024 && !ranged) {
             this.app.readFileWithWorker(fullpath).then((data) => {
                 if(this._res.aborted) {
                     return;

package/src/router.js

@@ -12,6 +12,7 @@ const methods = [
     'search', 'subscribe', 'unsubscribe', 'report', 'mkactivity', 'mkcalendar',
     'checkout', 'merge', 'm-search', 'notify', 'subscribe', 'unsubscribe', 'search'
 ];
+const supportedUwsMethods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS', 'HEAD', 'CONNECT', 'TRACE'];
 
 module.exports = class Router extends EventEmitter {
     #paramCallbacks = new Map();
@@ -122,8 +123,7 @@ module.exports = class Router extends EventEmitter {
             routes.push(route);
             // normal routes optimization
             if(typeof route.pattern === 'string' && route.pattern !== '/*' && !this.parent && this.get('case sensitive routing') && this.uwsApp) {
-                // the only methods that uWS supports natively
-                if(['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS', 'HEAD', 'CONNECT', 'TRACE'].includes(method)) {
+                if(supportedUwsMethods.includes(method)) {
                     const optimizedPath = this.#optimizeRoute(route, this._routes);
                     if(optimizedPath) {
                         this.#registerUwsRoute(route, optimizedPath);
@@ -153,13 +153,13 @@ module.exports = class Router extends EventEmitter {
                                     return; // can only optimize router whos parent is listening
                                 }
                                 for(let cbroute of callback._routes) {
-                                    if(!needsConversionToRegex(cbroute.path) && cbroute.path !== '/*') {
+                                    if(!needsConversionToRegex(cbroute.path) && cbroute.path !== '/*' && supportedUwsMethods.includes(cbroute.method)) {
                                         let optimizedRouterPath = this.#optimizeRoute(cbroute, callback._routes);
                                         if(optimizedRouterPath) {
                                             optimizedRouterPath = optimizedRouterPath.slice(0, -1);
                                             const optimizedPath = [...optimizedPathToRouter, {
-                                                ...route,
                                                 // fake route to update req._opPath and req.url
+                                                ...route,
                                                 callbacks: [
                                                     (req, res, next) => {
                                                         next('skipPop');
@@ -263,8 +263,13 @@ module.exports = class Router extends EventEmitter {
     }
 
     #handleError(err, request, response) {
-        if(this.errorRoute) {
-            return this.errorRoute(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;