The Worker and ElectronIPC routers now set incomingRequest.stackInErrorMessage to true automatically and by default.

Author: ionut.stan

package.json

@@ -1,7 +1,7 @@
 {
   "name": "jsonrpc-bidirectional",
   "description": "Bidirectional JSONRPC over web sockets or HTTP with extensive plugin support.",
-  "version": "6.7.1",
+  "version": "6.7.2",
   "scripts": {
     "build": "node build.js",
     "test": "node --expose-gc --max-old-space-size=1024 tests/main.js",

src/BidirectionalElectronIPC.js

@@ -145,7 +145,7 @@ class BidirectionalElectronIPCRouter extends JSONRPC.RouterBase
 
 		const nConnectionID = ++this._nConnectionIDCounter;
 
-		const strChannel = "jsonrpc_winid_" + (window || self).require("electron").remote.getCurrentWindow().id;
+		const strChannel = "jsonrpc_winid_" + (window || self).require("electron").remote.getCurrentWindow().id; // eslint-disable-line
 
 		const objSession = {
 			browserWindow: null,
@@ -158,7 +158,7 @@ class BidirectionalElectronIPCRouter extends JSONRPC.RouterBase
 
 		this._objSessions[nConnectionID] = objSession;
 
-		(window || self).require("electron").ipcRenderer.on(
+		(window || self).require("electron").ipcRenderer.on( // eslint-disable-line
 			strChannel, 
 			async (event, objJSONRPCRequest) => {
 				await this._routeMessage(objJSONRPCRequest, objSession, strChannel);
@@ -279,7 +279,8 @@ class BidirectionalElectronIPCRouter extends JSONRPC.RouterBase
 
 				incomingRequest.connectionID = nConnectionID;
 				incomingRequest.router = this;
-
+				
+				incomingRequest.stackInErrorMessage = true;
 
 				try
 				{
@@ -312,7 +313,7 @@ class BidirectionalElectronIPCRouter extends JSONRPC.RouterBase
 					}
 					else
 					{
-						(window || self).require("electron").ipcRenderer.send(strChannel, incomingRequest.callResultToBeSerialized);
+						(window || self).require("electron").ipcRenderer.send(strChannel, incomingRequest.callResultToBeSerialized); // eslint-disable-line
 					}
 				}
 			}

src/BidirectionalWorkerRouter.js

@@ -4,8 +4,8 @@ let cluster = require("cluster");
 if(!cluster)
 {
 	cluster = {
-		isMaster: !(self && self.document === undefined),
-		isWorker: !!(self && self.document === undefined)
+		isMaster: !(self && self.document === undefined), // eslint-disable-line
+		isWorker: !!(self && self.document === undefined) // eslint-disable-line
 	};
 }
 
@@ -81,7 +81,7 @@ class BidirectionalWorkerRouter extends JSONRPC.RouterBase
 			strEndpointPath = JSONRPC.EndpointBase.normalizePath(strEndpointPath);
 		}
 
-		assert(cluster.isMaster || process === worker || self === worker, "Unknown worker type.");
+		assert(cluster.isMaster || process === worker || self === worker, "Unknown worker type."); // eslint-disable-line
 
 
 		const nConnectionID = ++this._nConnectionIDCounter;
@@ -318,6 +318,7 @@ class BidirectionalWorkerRouter extends JSONRPC.RouterBase
 				incomingRequest.connectionID = nConnectionID;
 				incomingRequest.router = this;
 
+				incomingRequest.stackInErrorMessage = true;
 
 				try
 				{

src/IncomingRequest.js

@@ -41,6 +41,9 @@ class IncomingRequest
 		//this._webSocket
 		//this._httpRequest
 
+		// Only change this to true if it is safe to export stack traces to the RPC called.
+		this._bStackInErrorMessage = false;
+
 		Object.seal(this);
 	}
 
@@ -317,6 +320,27 @@ class IncomingRequest
 	}
 
 
+	/**
+	 * Consulted when serializing the response.
+	 * Determines if the stack trace will be appended to the error message, in case of returning an error.
+	 * 
+	 * @returns {boolean}
+	 */
+	get stackInErrorMessage()
+	{
+		return this._bStackInErrorMessage;
+	}
+
+
+	/**
+	 * @param {boolean} bAllow
+	 */
+	set stackInErrorMessage(bAllow)
+	{
+		this._bStackInErrorMessage = bAllow;
+	}
+
+
 	/**
 	 * @param {string|Buffer|Object} mxResultSerialized
 	 */
@@ -576,7 +600,7 @@ class IncomingRequest
 		if(this.callResult instanceof Error)
 		{
 			objResponse.error = {
-				message: this.callResult.message,
+				message: this.callResult.message + (this.stackInErrorMessage ? " " + this.callResult.stack : ""),
 				code: (this.callResult instanceof JSONRPC.Exception) ? this.callResult.code : 0,
 				data: this.callResult.stack.split(/[\r\n]+/mg)
 			};