Merge pull request #20 from oxygen/master

oxygen · web-flow · commit 492d606012a2 · 2017-06-27T00:02:23.000+03:00
Fixed transpiled JSONRPC.Exception to keep type information.
diff --git a/README.MD b/README.MD
@@ -11,6 +11,7 @@ This library is tested in __browsers__ (>= IE10) and in __Node.js__ (>=7.8).
 Very simple usage allows for very easy application development: 
  * export methods in an endpoint (which extends JSONRPC.EndpointBase), and call those method remotely through a client (which extends JSONRPC.Client);
  * on bidirectional transports, there may be endpoints at both ends of a connection, or reversed roles (TCP client is a JSONRPC server, while TCP server is JSONRPC client).
+ * all remote invocations are asynchronous (multiple responses on the same connection are matched to the right waiting promises)
 
 ## Transports
 
@@ -269,7 +270,7 @@ webSocketServer.on(
 	"connection", 
 	async (webSocket) => 
 	{
-		const nWebSocketConnectionID = await wsJSONRPCRouter.addWebSocket(webSocket);
+		const nWebSocketConnectionID = wsJSONRPCRouter.addWebSocketSync(webSocket);
 		// Do something with nWebSocketConnectionID and webSocket here, like register them as a pair with an authorization plugin.
 
 		// const clientForThisConnection = wsJSONRPCRouter.connectionIDToSingletonClient(nWebSocketConnectionID, JSONRPC.Client);
@@ -299,7 +300,7 @@ await new Promise((fnResolve, fnReject) => {
 const wsJSONRPCRouter = new JSONRPC.BidirectionalWebsocketRouter(jsonrpcServer);
 
 
-const nWebSocketConnectionID = await wsJSONRPCRouter.addWebSocket(webSocket);
+const nWebSocketConnectionID = wsJSONRPCRouter.addWebSocketSync(webSocket);
 
 
 // Obtain single client. See above section "Extending the client" for the TestClient class (subclass of JSONRPC.Client).
@@ -388,15 +389,12 @@ __Site B (ES5 browser). WebSocket client (connects to the above WebSocket TCP se
 				ws.addEventListener("open", function(event){
 					var wsJSONRPCRouter = new JSONRPC.BidirectionalWebsocketRouter(jsonrpcServer);
 
-					wsJSONRPCRouter.addWebSocket(ws)
-						.then(function(nWebSocketConnectionID){
-							clientOfBidirectionalWS = wsJSONRPCRouter.connectionIDToSingletonClient(nWebSocketConnectionID, JSONRPC.Client);
+					var nWebSocketConnectionID = wsJSONRPCRouter.addWebSocketSync(ws);
 
-							clientOfBidirectionalWS.rpc("ping", ["Calling from html es5 client, websocket transport with bidirectional JSONRPC."])
-								.then(console.log)
-								.catch(console.log)
-							;
-						})
+					clientOfBidirectionalWS = wsJSONRPCRouter.connectionIDToSingletonClient(nWebSocketConnectionID, JSONRPC.Client);
+
+					clientOfBidirectionalWS.rpc("ping", ["Calling from html es5 client, websocket transport with bidirectional JSONRPC."])
+						.then(console.log)
 						.catch(console.log)
 					;
 				});
diff --git a/builds/browser/es5/jsonrpc.min.js b/builds/browser/es5/jsonrpc.min.js
diff --git a/builds/browser/es5/jsonrpc.min.js.map b/builds/browser/es5/jsonrpc.min.js.map
diff --git a/builds/browser/es7/jsonrpc.min.js b/builds/browser/es7/jsonrpc.min.js
diff --git a/builds/browser/es7/jsonrpc.min.js.map b/builds/browser/es7/jsonrpc.min.js.map
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "jsonrpc-bidirectional",
   "description": "Bidirectional JSONRPC over web sockets or HTTP with extensive plugin support.",
-  "version": "4.3.1",
+  "version": "5.1.1",
   "scripts": {
     "build": "node build.js",
     "test": "node --expose-gc --max-old-space-size=1024 tests/main.js",
@@ -11,9 +11,9 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/oxygens/jsonrpc-bidirectional.git"
+    "url": "git+https://github.com/oxygen/jsonrpc-bidirectional.git"
   },
-  "homepage": "https://github.com/oxygens/jsonrpc-bidirectional",
+  "homepage": "https://github.com/oxygen/jsonrpc-bidirectional",
   "author": "Ionut Stan <Ionut.Stan@bigstep.com>",
   "license": "MIT",
   "contributors": [
@@ -34,6 +34,7 @@
     "child_process": false
   },
   "dependencies": {
+    "extendable-error-class": "^0.1.1",
     "node-fetch": "^1.6.3"
   },
   "optionalDependencies": {
@@ -55,6 +56,7 @@
     "eslint": "^3.19.0",
     "eslint-plugin-jsdoc": "^3.0.2",
     "phantom": "^4.0.2",
+    "recursive-keys": "^0.9.0",
     "sleep-promise": "^2.0.0",
     "uglify-js": "^2.8.22",
     "uws": "^0.14.1",
diff --git a/src/BidirectionalWebRTCRouter.js b/src/BidirectionalWebRTCRouter.js
@@ -17,6 +17,8 @@ module.exports =
 class BidirectionalWebRTCRouter extends JSONRPC.RouterBase
 {
 	/**
+	 * This function must be synchronous, otherwise it will allow of race conditions where critical plugins (if any) haven't been initialized yet.
+	 * 
 	 * Returns the connection ID.
 	 * 
 	 * RTCDataChannel instances which will emit an error or close event will get automatically removed.
@@ -27,7 +29,7 @@ class BidirectionalWebRTCRouter extends JSONRPC.RouterBase
 	 * 
 	 * @returns {number}
 	 */
-	async addRTCDataChannel(dataChannel)
+	addRTCDataChannelSync(dataChannel)
 	{
 		if(dataChannel.readyState === "closed")
 		{
@@ -37,7 +39,7 @@ class BidirectionalWebRTCRouter extends JSONRPC.RouterBase
 			// @TODO: test cases for the above, somehow.
 
 			// "closed" would not recover and should never be added, because it would not get cleaned up.
-			console.log("[" + process.pid + "] addRTCDataChannel ignoring closed dataChannel.");
+			console.log("[" + process.pid + "] addRTCDataChannelSync ignoring closed dataChannel.");
 
 			return;
 		}
@@ -74,6 +76,8 @@ class BidirectionalWebRTCRouter extends JSONRPC.RouterBase
 		dataChannel.addEventListener(
 			"error", 
 			(error) => {
+				console.error(error);
+
 				this.onConnectionEnded(nConnectionID);
 
 				if(dataChannel.readyState === "open")
diff --git a/src/BidirectionalWebsocketRouter.js b/src/BidirectionalWebsocketRouter.js
@@ -21,6 +21,8 @@ module.exports =
 class BidirectionalWebsocketRouter extends JSONRPC.RouterBase
 {
 	/**
+	 * This function must be synchronous, otherwise it will allow of race conditions where critical plugins (if any) haven't been initialized yet.
+	 * 
 	 * Returns the connection ID.
 	 * 
 	 * WebSocket instances which will emit an error or close event will get automatically removed.
@@ -31,7 +33,7 @@ class BidirectionalWebsocketRouter extends JSONRPC.RouterBase
 	 * 
 	 * @returns {number}
 	 */
-	async addWebSocket(webSocket)
+	addWebSocketSync(webSocket)
 	{
 		if(webSocket.readyState === JSONRPC.WebSocketAdapters.WebSocketWrapperBase.CLOSED)
 		{
@@ -41,7 +43,7 @@ class BidirectionalWebsocketRouter extends JSONRPC.RouterBase
 			// @TODO: test cases for the above, somehow.
 
 			// WebSocket.CLOSED would not recover and should never be added, because it would not get cleaned up.
-			console.log("[" + process.pid + "] addWebSocket ignoring closed webSocket.");
+			console.log("[" + process.pid + "] addWebSocketSync ignoring closed webSocket.");
 			return;
 		}
 
@@ -73,45 +75,49 @@ class BidirectionalWebsocketRouter extends JSONRPC.RouterBase
 		};
 		
 
-		if(webSocket.addEventListener)
+		if(webSocket.on)
 		{
-			webSocket.addEventListener(
+			webSocket.on(
 				"message", 
-				async (messageEvent) => {
-					await this._routeMessage(messageEvent.data, objSession);
+				(strData, objFlags) => {
+					this._routeMessage(strData, objSession);
 				}
 			);
 
-			webSocket.addEventListener(
+			webSocket.on(
 				"close",
-				(closeEvent) => {
-					//closeEvent.code;
-					//closeEvent.reason;
-					//closeEvent.wasClean;
-
+				(nCode, strReason) => {
 					this.onConnectionEnded(nConnectionID);
 				}
 			);
 
-			webSocket.addEventListener("error", fnOnError);
+			webSocket.on("error", fnOnError);
 		}
-		else
+		else if(webSocket.addEventListener)
 		{
-			webSocket.on(
+			webSocket.addEventListener(
 				"message", 
-				async (strData, objFlags) => {
-					await this._routeMessage(strData, objSession);
+				(messageEvent) => {
+					this._routeMessage(messageEvent.data, objSession);
 				}
 			);
 
-			webSocket.on(
+			webSocket.addEventListener(
 				"close",
-				(nCode, strReason) => {
+				(closeEvent) => {
+					//closeEvent.code;
+					//closeEvent.reason;
+					//closeEvent.wasClean;
+
 					this.onConnectionEnded(nConnectionID);
 				}
 			);
 
-			webSocket.on("error", fnOnError);
+			webSocket.addEventListener("error", fnOnError);
+		}
+		else
+		{
+			throw new Error("Not a supported WebSocket interface.");
 		}
 
 
diff --git a/src/Exception.js b/src/Exception.js
@@ -1,10 +1,13 @@
+const ExtendableError = require("extendable-error-class");
+
+
 /**
  * Class representing the JSONRPC Exceptions.
  * @class
  * @extends Error
  */
 module.exports =
-class Exception extends Error
+class Exception extends ExtendableError
 {
 	/**
 	 * @param {string} strMessage
diff --git a/tests/Browser/index.html b/tests/Browser/index.html
@@ -115,17 +115,13 @@
 				ws.addEventListener("open", function(event){
 					var wsJSONRPCRouter = new JSONRPC.BidirectionalWebsocketRouter(jsonrpcServer);
 
-					wsJSONRPCRouter.addWebSocket(ws)
-						.then(function(nWebSocketConnectionID){
-							clientOfBidirectionalWS = wsJSONRPCRouter.connectionIDToSingletonClient(nWebSocketConnectionID, JSONRPC.Client);
-
-							clientOfBidirectionalWS.rpc("ImHereForTheParty", ["Lynch", "Lynch does the harlem shake", /*bDoNotAuthorizeMe*/ false])
-								.then(function(objTeamMember){
-									// When calling with this exact string, the node's ping() method will call back into the JSONRPC server hosted on this page (node becomes client, browser becomes server).
-									clientOfBidirectionalWS.rpc("ping", ["Calling from html es5 client, bidirectional websocket mode."]).then(genericTestsPromiseCatch).catch(genericTestsPromiseCatch);
-								})
-								.catch(genericTestsPromiseCatch)
-							;
+					var nWebSocketConnectionID = wsJSONRPCRouter.addWebSocketSync(ws);
+					clientOfBidirectionalWS = wsJSONRPCRouter.connectionIDToSingletonClient(nWebSocketConnectionID, JSONRPC.Client);
+
+					clientOfBidirectionalWS.rpc("ImHereForTheParty", ["Lynch", "Lynch does the harlem shake", /*bDoNotAuthorizeMe*/ false])
+						.then(function(objTeamMember){
+							// When calling with this exact string, the node's ping() method will call back into the JSONRPC server hosted on this page (node becomes client, browser becomes server).
+							clientOfBidirectionalWS.rpc("ping", ["Calling from html es5 client, bidirectional websocket mode."]).then(genericTestsPromiseCatch).catch(genericTestsPromiseCatch);
 						})
 						.catch(genericTestsPromiseCatch)
 					;
diff --git a/tests/BrowserWebRTC/WebRTC.html b/tests/BrowserWebRTC/WebRTC.html
@@ -17,6 +17,8 @@
 			 * Tested only in Chrome.
 			 * Expect for these to stop working at any point due to future WebRTC API changes.
 			 * 2017-05-15
+			 * 
+			 * Very short WebRTC DataChannel example: https://gist.github.com/oxygens/9eca0fa5046d4c5ef7dcb13ac1047de6
 			 */
 
 
@@ -72,7 +74,7 @@
 
 				const wsJSONRPCRouter = new JSONRPC.BidirectionalWebsocketRouter(jsonrpcServer);
 
-				const nWebSocketConnectionID = await wsJSONRPCRouter.addWebSocket(ws);
+				const nWebSocketConnectionID = wsJSONRPCRouter.addWebSocketSync(ws);
 				jsonrpcClient = wsJSONRPCRouter.connectionIDToSingletonClient(nWebSocketConnectionID, JSONRPC.Client);
 
 				const objTeamMember = await jsonrpcClient.rpc("ImHereForTheParty", ["Lynch", "Lynch does the harlem shake", /*bDoNotAuthorizeMe*/ false]);
@@ -98,7 +100,7 @@
 
 
 					const webRTCJSONRPCRouter = new JSONRPC.BidirectionalWebRTCRouter(jsonrpcServer);
-					const nWebRTCConnectionID = await webRTCJSONRPCRouter.addRTCDataChannel(rtcDataChannel);
+					const nWebRTCConnectionID = webRTCJSONRPCRouter.addRTCDataChannelSync(rtcDataChannel);
 					jsonrpcClientRTC = webRTCJSONRPCRouter.connectionIDToSingletonClient(nWebRTCConnectionID, JSONRPC.Client);
 
 					console.log(await jsonrpcClientRTC.rpc("ping", ["Do you think we have a connection?"]));
diff --git a/tests/Tests/AllTests.js b/tests/Tests/AllTests.js
@@ -498,7 +498,7 @@ class AllTests
 
 				const wsJSONRPCRouter = new JSONRPC.BidirectionalWebsocketRouter(jsonrpcServer);
 
-				const nWebSocketConnectionID = await wsJSONRPCRouter.addWebSocket(webSocketClient);
+				const nWebSocketConnectionID = wsJSONRPCRouter.addWebSocketSync(webSocketClient);
 				const jsonrpcClient = wsJSONRPCRouter.connectionIDToSingletonClient(nWebSocketConnectionID, TestClient);
 
 				arrJSONRPCClients.push(jsonrpcClient);
@@ -636,7 +636,7 @@ class AllTests
 					webSocket = new this._classWebSocketAdapter(webSocket);
 				}
 
-				const nWebSocketConnectionID = await wsJSONRPCRouter.addWebSocket(webSocket);
+				const nWebSocketConnectionID = wsJSONRPCRouter.addWebSocketSync(webSocket);
 
 				console.log("[" + process.pid + "] Passing a new incoming connection to Tests.Plugins.Server.WebSocketAuthorize.");
 				this._webSocketAuthorizeSiteA.addConnection(nWebSocketConnectionID, webSocket);
@@ -703,7 +703,7 @@ class AllTests
 				this._jsonrpcServerSiteB
 			);
 
-			const nWebSocketConnectionID = await wsJSONRPCRouter.addWebSocket(this._webSocketClientSiteB);
+			const nWebSocketConnectionID = wsJSONRPCRouter.addWebSocketSync(this._webSocketClientSiteB);
 
 			// Alternatively, the madeReverseCallsClient event can be used.
 			// In this case however, only a single client is suposed to exist.
@@ -755,7 +755,7 @@ class AllTests
 				this._jsonrpcServerSiteC
 			);
 
-			const nWebSocketConnectionID = await wsJSONRPCRouter.addWebSocket(this._webSocketClientSiteC);
+			const nWebSocketConnectionID = wsJSONRPCRouter.addWebSocketSync(this._webSocketClientSiteC);
 
 			// Alternatively, the madeReverseCallsClient event can be used.
 			// In this case however, only a single client is suposed to exist.
@@ -807,7 +807,7 @@ class AllTests
 				this._jsonrpcServerSiteDisconnecter
 			);
 
-			const nWebSocketConnectionID = await wsJSONRPCRouter.addWebSocket(this._webSocketClientSiteDisconnecter);
+			const nWebSocketConnectionID = wsJSONRPCRouter.addWebSocketSync(this._webSocketClientSiteDisconnecter);
 
 			// Alternatively, the madeReverseCallsClient event can be used.
 			// In this case however, only a single client is suposed to exist.

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@ module.exports =`
`17`	`17`	`class BidirectionalWebRTCRouter extends JSONRPC.RouterBase`
`18`	`18`	`{`
`19`	`19`	`/**`
	`20`	`+ * This function must be synchronous, otherwise it will allow of race conditions where critical plugins (if any) haven't been initialized yet.`
	`21`	`+ *`
`20`	`22`	`* Returns the connection ID.`
`21`	`23`	`*`
`22`	`24`	`* RTCDataChannel instances which will emit an error or close event will get automatically removed.`
`@@ -27,7 +29,7 @@ class BidirectionalWebRTCRouter extends JSONRPC.RouterBase`
`27`	`29`	`*`
`28`	`30`	`* @returns {number}`
`29`	`31`	`*/`
`30`		`- async addRTCDataChannel(dataChannel)`
	`32`	`+ addRTCDataChannelSync(dataChannel)`
`31`	`33`	`{`
`32`	`34`	`if(dataChannel.readyState === "closed")`
`33`	`35`	`{`
`@@ -37,7 +39,7 @@ class BidirectionalWebRTCRouter extends JSONRPC.RouterBase`
`37`	`39`	`// @TODO: test cases for the above, somehow.`
`38`	`40`
`39`	`41`	`// "closed" would not recover and should never be added, because it would not get cleaned up.`
`40`		`- console.log("[" + process.pid + "] addRTCDataChannel ignoring closed dataChannel.");`
	`42`	`+ console.log("[" + process.pid + "] addRTCDataChannelSync ignoring closed dataChannel.");`
`41`	`43`
`42`	`44`	`return;`
`43`	`45`	`}`
`@@ -74,6 +76,8 @@ class BidirectionalWebRTCRouter extends JSONRPC.RouterBase`
`74`	`76`	`dataChannel.addEventListener(`
`75`	`77`	`"error",`
`76`	`78`	`(error) => {`
	`79`	`+ console.error(error);`
	`80`	`+`
`77`	`81`	`this.onConnectionEnded(nConnectionID);`
`78`	`82`
`79`	`83`	`if(dataChannel.readyState === "open")`