soajs.controller 4.3.12 → 4.3.13

package/mw/keyACL/index.js

@@ -48,7 +48,7 @@ module.exports = () => {
 					if (obj.service_v) {
 						let san_v = coreLibs.version.sanitize(obj.service_v);
 						if (!aclObj[san_v]) {
-							obj.req.soajs.log.error("Problem accessing service [" + obj.req.soajs.controller.serviceParams.service_n + "] & version [" + obj.req.soajs.controller.serviceParams.service_v + "]");
+							//NOTE: the error context already reports the service and the version
 							return cb(154, null);
 						}
 						aclObj = aclObj[san_v];

package/mw/mt/index.js

@@ -48,7 +48,7 @@ module.exports = (configuration) => {
 				serviceInfo = req.soajs.controller.serviceParams.registry.versions[req.soajs.controller.serviceParams.version];
 			}
 			if (!serviceInfo) {
-				req.soajs.log.error("Problem accessing service [" + req.soajs.controller.serviceParams.name + "], API [" + req.soajs.controller.serviceParams.path + "] & version [" + req.soajs.controller.serviceParams.version + "]");
+				//NOTE: the error context already reports the service, the api and the version
 				return next(133);
 			}
 			let oauth = true;
@@ -160,12 +160,16 @@ module.exports = (configuration) => {
 								//if this is controller route: /key/permission/get, ignore async waterfall response
 								if (url_keyACL) {
 									if (!req.soajs.uracDriver) {
-										if (err && err.message) {
-											req.soajs.log.error(err.message);
-										}
 										if (err && err.name === "OAuth2Error") {
+											//NOTE: the code and the message travel with the error, the
+											//		error context reports both with full attribution
 											return next(err);
 										}
+										//NOTE: the cause is replaced by 158 below, so it is only
+										//		recoverable from here
+										if (err && err.message) {
+											req.soajs.log.error(err.message);
+										}
 										//doesn't work if you are not logged in
 										return next(158);
 									} else {
@@ -180,7 +184,8 @@ module.exports = (configuration) => {
 								}
 
 								if (err) {
-									req.soajs.log.error("Problem accessing service [" + req.soajs.controller.serviceParams.name + "], API [" + req.soajs.controller.serviceParams.path + "] & version [" + req.soajs.controller.serviceParams.version + "]");
+									//NOTE: the error context already reports the service, the api and
+									//		the version alongside the code and the message
 									return next(err);
 								} else {
 									let serviceName = data.req.soajs.controller.serviceParams.name;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "soajs.controller",
   "description": "soajs multi tenant API gateway",
-  "version": "4.3.12",
+  "version": "4.3.13",
   "author": {
     "name": "soajs team",
     "email": "team@soajs.org"

package/test/unit/utilities/utils.js

@@ -146,6 +146,19 @@ describe("Testing utilities", () => {
 		done();
 	});
 
+	it("errorContext - falls back to service_n and service_v before gotoService resolves them", (done) => {
+		// key and keyACL run before gotoService, so serviceParams carries only the
+		// raw service_n / service_v at that point
+		let r = makeReq(true);
+		r.soajs.controller.serviceParams = { "service_n": "urac", "service_v": "3" };
+		utils.controllerErrorHandler(154, r, res, null);
+
+		let ctx = JSON.parse(logged.error[0]);
+		assert.strictEqual(ctx.service, "urac");
+		assert.strictEqual(ctx.version, "3");
+		done();
+	});
+
 	it("logErrors - string error", (done) => {
 		utils.logErrors("error", req, res, (error) => {
 			done();

package/utilities/utils.js

@@ -51,8 +51,10 @@ function errorContext(err, req) {
         "code": code,
         "msg": msg,
         "method": req.method,
+        //NOTE: name and version are resolved by gotoService, the service_n and service_v
+        //		fallbacks cover the middleware that runs before it, ex: key and keyACL
         "service": serviceParams.name || serviceParams.service_n || null,
-        "version": serviceParams.version || null,
+        "version": serviceParams.version || serviceParams.service_v || null,
         "api": (serviceParams.parsedUrl && serviceParams.parsedUrl.pathname) || null,
         "url": redactUrl(req.url),
         "ip": req.getClientIP ? req.getClientIP() : null,