node-pluginsmanager-plugin 4.7.2 → 4.8.2

package/lib/components/Server.js

@@ -17,15 +17,16 @@
 	// locals
 	const MediatorUser = require(join(__dirname, "MediatorUser.js"));
 	const { checkInteger, checkNonEmptyObject, checkNonEmptyString } = require(join(__dirname, "..", "checkers", "main.js"));
-	const errToString = require(join(__dirname, "..", "utils", "errToString.js"));
 	const { extractPattern, extractParams, extractSchemaType } = require(join(__dirname, "..", "utils", "descriptor", "main.js"));
 	const { extractBody, extractIp, extractCookies } = require(join(__dirname, "..", "utils", "request", "main.js"));
 	const send = require(join(__dirname, "..", "utils", "send.js"));
 	const getUniqueID = require(join(__dirname, "..", "utils", "getUniqueID.js"));
+	const cleanSendedError = require(join(__dirname, "..", "utils", "cleanSendedError.js"));
 
 // consts
 
 	const WEBSOCKET_STATE_OPEN = 1;
+	const SERVER_CODES = require(join(__dirname, "..", "utils", "serverCodes.json"));
 
 // module
 
@@ -145,7 +146,7 @@ module.exports = class Server extends MediatorUser {
 				);
 
 				// get descriptor
-				if ("/" + this._Descriptor.info.title + "/descriptor" === req.pattern && "get" === req.method) {
+				if ("/" + this._Descriptor.info.title + "/api/descriptor" === req.pattern && "get" === req.method) {
 
 					return new Promise((resolve, reject) => {
 
@@ -157,35 +158,56 @@ module.exports = class Server extends MediatorUser {
 							return err ? reject(err) : resolve(api);
 						});
 
+					// add current server
+					}).then((api) => {
+
+						const protocol = res.socket && Boolean(res.socket.encrypted) ? "https" : "http";
+
+						let port = res.socket && res.socket.localPort ? res.socket.localPort : 0;
+						if (!port) {
+							port = "http" === protocol ? 80 : 443;
+						}
+
+						if (!api.servers) {
+							api.servers = [];
+						}
+
+						api.servers.push({
+							"url": protocol + "://" + req.validatedIp + ":" + port,
+							"description": "Actual current server"
+						});
+
+						return Promise.resolve(api);
+
 					}).then((api) => {
 
 						this._log("info", "<= [" + req.validatedIp + "] " + JSON.stringify(api));
-						return send(req, res, 200, api, this._Descriptor.info.version, this._cors);
+						return send(req, res, SERVER_CODES.OK, api, this._Descriptor.info.version, this._cors);
 
 					}).catch((err) => {
 
-						this.emit("error", err);
+						this._log("error", err);
 
 						const result = {
 							"code": "INTERNAL_SERVER_ERROR",
-							"message": errToString(err)
+							"message": cleanSendedError(err)
 						};
 
-						this._log("error", "<= " + JSON.stringify(result));
-						return send(req, res, 500, result, this._Descriptor.info.version, this._cors);
+						this._log("error", "<= [" + req.validatedIp + "] " + JSON.stringify(result));
+						return send(req, res, SERVER_CODES.INTERNAL_SERVER_ERROR, result, this._Descriptor.info.version, this._cors);
 
 					});
 
 				}
 
 				// get plugin status
-				else if ("/" + this._Descriptor.info.title + "/status" === req.pattern && "get" === req.method) {
+				else if ("/" + this._Descriptor.info.title + "/api/status" === req.pattern && "get" === req.method) {
 
 					const initialized = this.initialized && this._Mediator.initialized;
 					const status = initialized ? "INITIALIZED" : "ENABLED";
 
 					this._log("info", "<= [" + req.validatedIp + "] " + status);
-					return send(req, res, 200, status, this._Descriptor.info.version, this._cors);
+					return send(req, res, SERVER_CODES.OK, status, this._Descriptor.info.version, this._cors);
 
 				}
 
@@ -198,7 +220,7 @@ module.exports = class Server extends MediatorUser {
 					};
 
 					this._log("error", "<= [" + req.validatedIp + "] " + JSON.stringify(result));
-					return send(req, res, 501, result, this._Descriptor.info.version, this._cors);
+					return send(req, res, SERVER_CODES.NOT_IMPLEMENTED, result, this._Descriptor.info.version, this._cors);
 
 				}
 
@@ -211,7 +233,7 @@ module.exports = class Server extends MediatorUser {
 					};
 
 					this._log("error", "<= [" + req.validatedIp + "] " + JSON.stringify(result));
-					return send(req, res, 501, result, this._Descriptor.info.version, this._cors);
+					return send(req, res, SERVER_CODES.NOT_IMPLEMENTED, result, this._Descriptor.info.version, this._cors);
 
 				}
 
@@ -226,7 +248,7 @@ module.exports = class Server extends MediatorUser {
 					};
 
 					this._log("error", "<= [" + req.validatedIp + "] " + JSON.stringify(result));
-					return send(req, res, 411, result, this._Descriptor.info.version, this._cors);
+					return send(req, res, SERVER_CODES.MISSING_HEADER, result, this._Descriptor.info.version, this._cors);
 
 				}
 
@@ -398,12 +420,12 @@ module.exports = class Server extends MediatorUser {
 
 							if ("undefined" === typeof content || null === content) {
 								this._log("success", "<= [" + req.validatedIp + "] no content");
-								return send(req, res, 201, undefined, this._Descriptor.info.version, this._cors);
+								return send(req, res, SERVER_CODES.OK_PUT, undefined, this._Descriptor.info.version, this._cors);
 							}
 
 							else {
 								this._log("success", "<= [" + req.validatedIp + "] " + JSON.stringify(content));
-								return send(req, res, 201, content, this._Descriptor.info.version, this._cors);
+								return send(req, res, SERVER_CODES.OK_PUT, content, this._Descriptor.info.version, this._cors);
 							}
 
 						}
@@ -411,12 +433,12 @@ module.exports = class Server extends MediatorUser {
 						// no content
 						else if ("undefined" === typeof content || null === content) {
 							this._log("warning", "<= [" + req.validatedIp + "] no content");
-							return send(req, res, 204, undefined, this._Descriptor.info.version, this._cors);
+							return send(req, res, SERVER_CODES.OK_NO_CONTENT, undefined, this._Descriptor.info.version, this._cors);
 						}
 
 						else {
 							this._log("success", "<= [" + req.validatedIp + "] " + JSON.stringify(content));
-							return send(req, res, 200, content, this._Descriptor.info.version, this._cors);
+							return send(req, res, SERVER_CODES.OK, content, this._Descriptor.info.version, this._cors);
 						}
 
 					}).catch((err) => {
@@ -425,55 +447,57 @@ module.exports = class Server extends MediatorUser {
 
 							const result = {
 								"code": "MISSING_PARAMETER",
-								"message": errToString(err)
+								"message": cleanSendedError(err)
 							};
 
 							this._log("error", "<= [" + req.validatedIp + "] " + JSON.stringify(result));
-							return send(req, res, 400, result, this._Descriptor.info.version, this._cors);
+							return send(req, res, SERVER_CODES.MISSING_PARAMETER, result, this._Descriptor.info.version, this._cors);
 
 						}
 						else if (err instanceof TypeError) {
 
 							const result = {
 								"code": "WRONG_TYPE_PARAMETER",
-								"message": errToString(err)
+								"message": cleanSendedError(err)
 							};
 
 							this._log("error", "<= [" + req.validatedIp + "] " + JSON.stringify(result));
-							return send(req, res, 400, result, this._Descriptor.info.version, this._cors);
+							return send(req, res, SERVER_CODES.WRONG_TYPE_PARAMETER, result, this._Descriptor.info.version, this._cors);
 
 						}
 						else if (err instanceof RangeError) {
 
 							const result = {
 								"code": "EMPTY_OR_RANGE_OR_ENUM_PARAMETER",
-								"message": errToString(err)
+								"message": cleanSendedError(err)
 							};
 
 							this._log("error", "<= [" + req.validatedIp + "] " + JSON.stringify(result));
-							return send(req, res, 400, result, this._Descriptor.info.version, this._cors);
+							return send(req, res, SERVER_CODES.EMPTY_OR_RANGE_OR_ENUM_PARAMETER, result, this._Descriptor.info.version, this._cors);
 
 						}
 						else if (err instanceof SyntaxError) {
 
 							const result = {
 								"code": "JSON_PARSE",
-								"message": errToString(err)
+								"message": cleanSendedError(err)
 							};
 
 							this._log("error", "<= [" + req.validatedIp + "] " + JSON.stringify(result));
-							return send(req, res, 400, result, this._Descriptor.info.version, this._cors);
+							return send(req, res, SERVER_CODES.JSON_PARSE, result, this._Descriptor.info.version, this._cors);
 
 						}
 						else {
 
+							this._log("error", err);
+
 							const result = {
 								"code": "INTERNAL_SERVER_ERROR",
-								"message": errToString(err)
+								"message": cleanSendedError(err)
 							};
 
 							this._log("error", "<= [" + req.validatedIp + "] " + JSON.stringify(result));
-							return send(req, res, 500, result, this._Descriptor.info.version, this._cors);
+							return send(req, res, SERVER_CODES.INTERNAL_SERVER_ERROR, result, this._Descriptor.info.version, this._cors);
 
 						}
 
@@ -561,7 +585,7 @@ module.exports = class Server extends MediatorUser {
 				};
 
 					if ("undefined" !== typeof data) {
-						result.data = data;
+						result.data = cleanSendedError(data);
 					}
 
 				return Promise.resolve(JSON.stringify(result));
@@ -602,7 +626,7 @@ module.exports = class Server extends MediatorUser {
 				}
 
 			}).catch((err) => {
-				this.emit("error", err);
+				this._log("error", err);
 			});
 
 			return this;
@@ -626,7 +650,7 @@ module.exports = class Server extends MediatorUser {
 				};
 
 					if ("undefined" !== typeof data) {
-						result.data = data;
+						result.data = cleanSendedError(data);
 					}
 
 				return Promise.resolve(JSON.stringify(result));
@@ -683,7 +707,7 @@ module.exports = class Server extends MediatorUser {
 
 				}
 			}).catch((err) => {
-				this.emit("error", err);
+				this._log("error", err);
 			});
 
 			return this;

package/lib/utils/cleanSendedError.js

@@ -0,0 +1,47 @@
+"use strict";
+
+// module
+
+module.exports = function cleanSendedError (data) {
+
+	if ("object" === typeof data) {
+
+		if (data instanceof Error) {
+			return data.message ? data.message : data;
+		}
+		else if (data.message && data.message instanceof Error) {
+
+			data.message = data.message.message ? data.message.message : data.message;
+
+			return data;
+
+		}
+		else if (data.error) { // 1 level recursive for "error" data (avoid too deep recursive analyse)
+
+			if (data.error instanceof Error) {
+				data.error = data.error.message ? data.error.message : data.error;
+			}
+			else if (data.error.message && data.error.message instanceof Error) {
+				data.error.message = data.error.message.message ? data.error.message.message : data.error.message;
+			}
+
+			return data;
+
+		}
+		else if (data.err && data.err instanceof Error) { // 1 level recursive for "err" data (avoid too deep recursive analyse)
+
+			data.err = data.err.message ? data.err.message : data.err;
+
+			return data;
+
+		}
+		else {
+			return data;
+		}
+
+	}
+	else {
+		return data;
+	}
+
+};

package/lib/utils/serverCodes.json

@@ -0,0 +1,16 @@
+{
+
+	"OK": 200,
+	"OK_PUT": 201,
+	"OK_NO_CONTENT": 204,
+
+	"MISSING_PARAMETER": 400,
+	"WRONG_TYPE_PARAMETER": 400,
+	"EMPTY_OR_RANGE_OR_ENUM_PARAMETER": 400,
+	"JSON_PARSE": 400,
+	"MISSING_HEADER": 411,
+
+	"INTERNAL_SERVER_ERROR": 500,
+	"NOT_IMPLEMENTED": 501
+
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-pluginsmanager-plugin",
-  "version": "4.7.2",
+  "version": "4.8.2",
   "description": "An abstract parent plugin for node-pluginsmanager",
   "main": "lib/main.js",
   "typings": "lib/index.d.ts",
@@ -39,21 +39,21 @@
     "express-openapi-validate": "0.6.1"
   },
   "devDependencies": {
-    "@types/node": "16.9.4",
+    "@types/node": "17.0.25",
     "@types/socket.io": "3.0.2",
-    "@types/ws": "7.4.7",
-    "check-version-modules": "1.3.3",
+    "@types/ws": "8.5.3",
+    "check-version-modules": "1.3.5",
     "coveralls": "3.1.1",
     "colors": "1.4.0",
-    "eslint": "7.32.0",
-    "express": "4.17.1",
-    "husky": "7.0.2",
-    "mocha": "9.1.1",
+    "eslint": "8.13.0",
+    "express": "4.17.3",
+    "husky": "7.0.4",
+    "mocha": "9.2.2",
     "nyc": "15.1.0",
-    "socket.io": "4.2.0",
-    "socket.io-client": "4.2.0",
-    "typescript": "4.4.3",
-    "ws": "8.2.2"
+    "socket.io": "4.4.1",
+    "socket.io-client": "4.4.1",
+    "typescript": "4.6.3",
+    "ws": "8.5.0"
   },
   "homepage": "https://github.com/Psychopoulet/node-pluginsmanager-plugin#readme",
   "engines": {