Server IncomingRequest did not allow a different serialization method.

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": "1.4.3",
+  "version": "1.5.0",
   "scripts": {
     "transpile": "babel src --out-dir src",
 	"todo": "http://jamesknelson.com/using-es6-in-the-browser-with-babel-6-and-webpack/",

src/BidirectionalWebsocketRouter.js

@@ -288,14 +288,14 @@ class BidirectionalWebsocketRouter extends EventEmitter
 				}
 
 
-				const objResponse = await this._jsonrpcServer.processRequest(incomingRequest);
+				await this._jsonrpcServer.processRequest(incomingRequest);
 
 				if(webSocket.readyState !== webSocket.constructor.OPEN)
 				{
-					console.error("webSocket.readyState: " + JSON.stringify(webSocket.readyState) + ". Request was " + strMessage + ". Attempted responding with " + JSON.stringify(objResponse, undefined, "\t") + ".");
+					console.error("webSocket.readyState: " + JSON.stringify(webSocket.readyState) + ". Request was " + strMessage + ". Attempted responding with " + JSON.stringify(incomingRequest.callResultToBeSerialized, undefined, "\t") + ".");
 				}
 
-				webSocket.send(JSON.stringify(objResponse, undefined, "\t"));
+				webSocket.send(incomingRequest.callResultSerialized);
 			}
 			else if(objMessage.hasOwnProperty("result") || objMessage.hasOwnProperty("error"))
 			{

src/IncomingRequest.js

@@ -19,6 +19,8 @@ class IncomingRequest
 		this._bidirectionalWebsocketRouter = null;
 
 		this._mxResult = null;
+		this._objResponseToBeSerialized = null;
+		this._mxResultSerialized = null;
 		this._bMethodCalled = false;
 
 		this._nConnectionID = null;
@@ -243,6 +245,42 @@ class IncomingRequest
 	}
 
 
+	/**
+	 * @returns {Object}
+	 */
+	get callResultToBeSerialized()
+	{
+		return this._objResponseToBeSerialized;
+	}
+
+
+	/**
+	 * @param {Object} objResultToBeSerialized
+	 */
+	set callResultToBeSerialized(objResultToBeSerialized)
+	{
+		this._objResponseToBeSerialized = objResultToBeSerialized;
+	}
+
+
+	/**
+	 * @returns {string|Buffer}
+	 */
+	get callResultSerialized()
+	{
+		return this._mxResultSerialized;
+	}
+
+
+	/**
+	 * @param {string|Buffer} mxResultSerialized
+	 */
+	set callResultSerialized(mxResultSerialized)
+	{
+		this._mxResultSerialized = mxResultSerialized;
+	}
+
+
 	/**
 	 * @returns {Object}
 	 */

src/Plugins/Server/DebugLogger.js

@@ -26,7 +26,7 @@ class DebugLogger extends JSONRPC.ServerPluginBase
 	 * 
 	 * @param {JSONRPC.IncomingRequest} incomingRequest
 	 */
-	async afterJSONEncode(incomingRequest)
+	async afterSerialize(incomingRequest)
 	{
 		// @TODO: specify selected endpoint?
 

src/Server.js

@@ -62,7 +62,7 @@ class Server extends EventEmitter
 					httpResponse.statusCode = 500;
 
 					const incomingRequest = await this.processHTTPRequest(httpRequest, httpResponse);
-					const objResponse = await this.processRequest(incomingRequest);
+					await this.processRequest(incomingRequest);
 
 					if(incomingRequest.callResult instanceof Error)
 					{
@@ -92,7 +92,7 @@ class Server extends EventEmitter
 					else
 					{
 						httpResponse.setHeader("Content-Type", "application/json");
-						httpResponse.write(JSON.stringify(objResponse, undefined, "\t"));
+						httpResponse.write(incomingRequest.callResultSerialized);
 					}
 				}
 				catch(error)
@@ -265,7 +265,7 @@ class Server extends EventEmitter
 	 * 
 	 * @param {JSONRPC.IncomingRequest} incomingRequest
 	 * 
-	 * @returns {Object|null}
+	 * @returns {null}
 	 */
 	async processRequest(incomingRequest)
 	{
@@ -382,14 +382,25 @@ class Server extends EventEmitter
 			}
 		}
 
-		let objResponse = incomingRequest.toResponseObject();
+		incomingRequest.callResultToBeSerialized = incomingRequest.toResponseObject();
 
-		this.emit("result", objResponse);
+		this.emit("response", incomingRequest);
 		for(let plugin of this._arrPlugins)
 		{
-			await plugin.response(objResponse);
+			await plugin.response(incomingRequest);
 		}
 
-		return objResponse;
+
+		if(incomingRequest.callResultSerialized === null)
+		{
+			incomingRequest.callResultSerialized = JSON.stringify(incomingRequest.callResultToBeSerialized, undefined, "\t");
+		}
+
+
+		this.emit("afterSerialize", incomingRequest);
+		for(let plugin of this._arrPlugins)
+		{
+			await plugin.afterSerialize(incomingRequest);
+		}
 	}
 };

src/ServerPluginBase.js

@@ -66,12 +66,31 @@ class ServerPluginBase
 	 * 
 	 * objResponse is a standard JSONRPC 2.0 response object.
 	 * 
-	 * @param {Object} objResponse
+	 * @param {JSONRPC.IncomingRequest} incomingRequest
 	 */
-	async response(objResponse)
+	async response(incomingRequest)
 	{
 		// Gives a chance to modify the server response object before sending it out.
 
+		// incomingRequest.callResultToBeSerialized is available here.
+
+		// Normally, this allows extending the protocol.
+	}
+
+
+	/**
+	 * This is called with the actual response object.
+	 * 
+	 * objResponse is a standard JSONRPC 2.0 response object.
+	 * 
+	 * @param {JSONRPC.IncomingRequest} incomingRequest
+	 */
+	async afterSerialize(incomingRequest)
+	{
+		// Gives a chance to modify the serialized server response string (or something else) before sending it out.
+
+		// incomingRequest.callResultSerialized is available here.
+
 		// Normally, this allows extending the protocol.
 	}
 };

tests/ServerDebugMarkerPlugin.js

@@ -21,14 +21,14 @@ class ServerDebugMarkerPlugin extends JSONRPC.ServerPluginBase
 	 * 
 	 * objResponse is a standard JSONRPC 2.0 response object.
 	 * 
-	 * @param {Object} objResponse
+	 * @param {JSONRPC.IncomingRequest} incomingRequest
 	 */
-	async response(objResponse)
+	async response(incomingRequest)
 	{
 		// Gives a chance to modify the server response object before sending it out.
 
-		// Normally, this allows extending the protocol.
+		incomingRequest.callResultToBeSerialized.from = this._strSite;
 
-		objResponse.from = this._strSite;
+		// Normally, this allows extending the protocol.
 	}
 };

tests/ServerPluginInvalidResponseJSON.js

@@ -5,13 +5,18 @@ JSONRPC.Exception = require("../src/Exception");
 module.exports =
 class ServerPluginInvalidResponseJSON extends JSONRPC.ServerPluginBase
 {
-	async response(objResponse)
+	/**
+	 * @param {JSONRPC.IncomingRequest} incomingRequest
+	 */
+	async response(incomingRequest)
 	{
-		for(let strKey in objResponse)
+		for(let strKey in incomingRequest.callResultToBeSerialized)
 		{
-			delete objResponse[strKey];
+			delete incomingRequest.callResultToBeSerialized[strKey];
 		}
 
-		objResponse.helloFromMars = ".... . .-.. .-.. --- / ..-. .-. --- -- / -- .- .-. ...";
+		incomingRequest.callResultToBeSerialized.helloFromMars = ".... . .-.. .-.. --- / ..-. .-. --- -- / -- .- .-. ...";
+
+		console.log(incomingRequest.callResultToBeSerialized);
 	}
 };