@reldens/server-utils 0.9.0 → 0.11.0

package/lib/app-server-factory.js

@@ -47,7 +47,13 @@ class AppServerFactory
         this.corsOrigin = String(process.env.RELDENS_CORS_ORIGIN || '*');
         this.corsMethods = String(process.env.RELDENS_CORS_METHODS || 'GET,POST').split(',');
         this.corsHeaders = String(process.env.RELDENS_CORS_HEADERS || 'Content-Type,Authorization').split(',');
-        this.errorMessage = '';
+        this.tooManyRequestsMessage = String(
+            process.env.RELDENS_TOO_MANY_REQUESTS_MESSAGE || 'Too many requests, please try again later.'
+        );
+        this.error = {};
+        this.processErrorResponse = function(status, message, req, res) {
+            return { status, message, handled: false };
+        };
     }
 
     createAppServer(appServerConfig)
@@ -72,7 +78,7 @@ class AppServerFactory
                 max: this.maxRequests,
                 standardHeaders: true,
                 legacyHeaders: false,
-                message: 'Too many requests from this IP, please try again later'
+                message: this.tooManyRequestsMessage
             };
             if(this.applyKeyGenerator){
                 limiterParams.keyGenerator = function(req){
@@ -168,13 +174,21 @@ class AppServerFactory
         app.get('/', async (req, res, next) => {
             if('/' === req._parsedUrl.pathname){
                 if('function' !== typeof homePageLoadCallback){
-                    return res.send('Homepage contents could not be loaded.');
+                    let result = this.processErrorResponse(500, 'Homepage contents could not be loaded.', req, res);
+                    if(result.handled){
+                        return;
+                    }
+                    return res.status(result.status).send(result.message);
                 }
                 try {
                     return res.send(await homePageLoadCallback(req));
                 } catch(error){
-                    this.errorMessage = 'Error loading homepage.';
-                    return res.status(500).send('Error loading homepage.');
+                    this.error = {message: 'Error loading homepage.', error};
+                    let result = this.processErrorResponse(500, 'Error loading homepage.', req, res);
+                    if(result.handled){
+                        return;
+                    }
+                    return res.status(result.status).send(result.message);
                 }
             }
             next();
@@ -184,7 +198,7 @@ class AppServerFactory
     async serveStatics(app, statics)
     {
         if(!FileHandler.isValidPath(statics)){
-            this.errorMessage = 'Invalid statics path.';
+            this.error = {message: 'Invalid statics path.'};
             return;
         }
         let staticOptions = {
@@ -202,7 +216,7 @@ class AppServerFactory
     async serveStaticsPath(app, staticsPath, statics)
     {
         if(!FileHandler.isValidPath(staticsPath) || !FileHandler.isValidPath(statics)){
-            this.errorMessage = 'Invalid statics path to be served.';
+            this.error = {message: 'Invalid statics path to be served.'};
             return;
         }
         let staticOptions = {

package/lib/uploader-factory.js

@@ -18,6 +18,9 @@ class UploaderFactory
         this.fileLimit = props.fileLimit || 0;
         this.allowedExtensions = props.allowedExtensions;
         this.applySecureFileNames = props.applySecureFileNames;
+        this.processErrorResponse = props.processErrorResponse || function(status, message, req, res) {
+            return { status, message, handled: false };
+        };
     }
 
     createUploader(fields, buckets, allowedFileTypes)
@@ -35,16 +38,18 @@ class UploaderFactory
                 cb(null, dest);
             }
         };
-        if(this.applySecureFileNames){
-            diskStorageConfiguration['filename'] = (req, file, cb) => {
-                let secureFilename = FileHandler.generateSecureFilename(file.originalname);
-                if(!req.fileNameMapping){
-                    req.fileNameMapping = {};
-                }
-                req.fileNameMapping[secureFilename] = file.originalname;
-                cb(null, secureFilename);
-            };
-        }
+        diskStorageConfiguration['filename'] = (req, file, cb) => {
+            if(!this.applySecureFileNames) {
+                cb(null, file.originalname);
+                return;
+            }
+            let secureFilename = FileHandler.generateSecureFilename(file.originalname);
+            if(!req.fileNameMapping){
+                req.fileNameMapping = {};
+            }
+            req.fileNameMapping[secureFilename] = file.originalname;
+            cb(null, secureFilename);
+        };
         let storage = multer.diskStorage(diskStorageConfiguration);
         let limits = {
             fileSize: this.maxFileSize
@@ -64,14 +69,30 @@ class UploaderFactory
                 if(err){
                     if(err instanceof multer.MulterError){
                         if(err.code === 'LIMIT_FILE_SIZE'){
-                            return res.status(413).send('File too large');
+                            let result = this.processErrorResponse(413, 'File too large.', req, res);
+                            if(result.handled){
+                                return;
+                            }
+                            return res.status(result.status).send(result.message);
                         }
                         if(err.code === 'LIMIT_FILE_COUNT'){
-                            return res.status(413).send('Too many files');
+                            let result = this.processErrorResponse(413, 'Too many files.', req, res);
+                            if(result.handled){
+                                return;
+                            }
+                            return res.status(result.status).send(result.message);
+                        }
+                        let result = this.processErrorResponse(400, 'File upload error: ' + err.message, req, res);
+                        if(result.handled){
+                            return;
                         }
-                        return res.status(400).send('File upload error: ' + err.message);
+                        return res.status(result.status).send(result.message);
+                    }
+                    let result = this.processErrorResponse(500, 'Server error during file upload.', req, res);
+                    if(result.handled){
+                        return;
                     }
-                    return res.status(500).send('Server error during file upload');
+                    return res.status(result.status).send(result.message);
                 }
                 if(!req.files){
                     return next();
@@ -83,15 +104,23 @@ class UploaderFactory
                                 if(FileHandler.exists(file.path)){
                                     FileHandler.remove(file.path);
                                 }
-                                return res.status(415).send('File contents do not match declared type');
+                                let result = this.processErrorResponse(415, 'File contents do not match declared type.', req, res);
+                                if(result.handled){
+                                    return;
+                                }
+                                return res.status(result.status).send(result.message);
                             }
                         }
                     }
                     next();
                 } catch(error){
-                    console.error('File validation error:', error);
+                    this.error = {message: 'File validation error.', error};
                     this.cleanupFiles(req.files);
-                    return res.status(500).send('Error processing uploaded files');
+                    let result = this.processErrorResponse(500, 'Error processing uploaded files.', req, res);
+                    if(result.handled){
+                        return;
+                    }
+                    return res.status(result.status).send(result.message);
                 }
             });
         };
@@ -116,11 +145,11 @@ class UploaderFactory
                 this.error = {message: 'Field name is invalid'};
                 return false;
             }
-            if(!Object.prototype.hasOwnProperty.call(buckets, field.name)){
+            if(!buckets[field.name]){
                 this.error = {message: `Missing bucket for field: ${field.name}`};
                 return false;
             }
-            if(!Object.prototype.hasOwnProperty.call(allowedFileTypes, field.name)){
+            if(!allowedFileTypes[field.name]){
                 this.error = {message: `Missing allowedFileType for field: ${field.name}`};
                 return false;
             }
@@ -156,11 +185,12 @@ class UploaderFactory
     {
         try {
             if(!FileHandler.isFile(file.path)){
+                this.error = {message: 'File path must be provided.', file};
                 return false;
             }
             return FileHandler.validateFileType(file.path, allowedFileType, this.allowedExtensions, this.maxFileSize);
-        } catch(err){
-            console.error('Error validating file contents:', err);
+        } catch(error){
+            this.error = {message: 'Error validating file contents.', error};
             return false;
         }
     }
@@ -187,8 +217,8 @@ class UploaderFactory
                     if(FileHandler.exists(file.path)){
                         FileHandler.remove(file.path);
                     }
-                } catch(err){
-                    console.error('Error cleaning up file:', file.path, err);
+                } catch(error){
+                    this.error = {message: 'Error cleaning up file.', error};
                 }
             }
         }

package/package.json

@@ -1,47 +1,47 @@
-{
-    "name": "@reldens/server-utils",
-    "scope": "@reldens",
-    "version": "0.9.0",
-    "description": "Reldens - Server Utils",
-    "author": "Damian A. Pastorini",
-    "license": "MIT",
-    "homepage": "https://github.com/damian-pastorini/reldens-server-utils",
-    "source": true,
-    "main": "index.js",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/damian-pastorini/reldens-server-utils.git"
-    },
-    "keywords": [
-        "reldens",
-        "utils",
-        "shortcuts",
-        "system",
-        "game",
-        "mmorpg",
-        "rpg",
-        "dwd",
-        "colyseus",
-        "phaser",
-        "parcel",
-        "nodejs",
-        "mmo",
-        "multiplayer",
-        "rol",
-        "platform",
-        "framework"
-    ],
-    "bugs": {
-        "url": "https://github.com/damian-pastorini/reldens-server-utils/issues"
-    },
-    "dependencies": {
-        "body-parser": "2.2.0",
-        "cors": "2.8.5",
-        "express": "4.21.2",
-        "express-rate-limit": "7.5.0",
-        "express-session": "1.18.1",
-        "helmet": "8.1.0",
-        "multer": "^1.4.5-lts.2",
-        "xss-clean": "^0.1.4"
-    }
-}
+{
+    "name": "@reldens/server-utils",
+    "scope": "@reldens",
+    "version": "0.11.0",
+    "description": "Reldens - Server Utils",
+    "author": "Damian A. Pastorini",
+    "license": "MIT",
+    "homepage": "https://github.com/damian-pastorini/reldens-server-utils",
+    "source": true,
+    "main": "index.js",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/damian-pastorini/reldens-server-utils.git"
+    },
+    "keywords": [
+        "reldens",
+        "utils",
+        "shortcuts",
+        "system",
+        "game",
+        "mmorpg",
+        "rpg",
+        "dwd",
+        "colyseus",
+        "phaser",
+        "parcel",
+        "nodejs",
+        "mmo",
+        "multiplayer",
+        "rol",
+        "platform",
+        "framework"
+    ],
+    "bugs": {
+        "url": "https://github.com/damian-pastorini/reldens-server-utils/issues"
+    },
+    "dependencies": {
+        "body-parser": "2.2.0",
+        "cors": "2.8.5",
+        "express": "4.21.2",
+        "express-rate-limit": "7.5.0",
+        "express-session": "1.18.1",
+        "helmet": "8.1.0",
+        "multer": "^1.4.5-lts.2",
+        "xss-clean": "0.1.4"
+    }
+}