addWebSocket and addRTCDataChannel have been made synchronous and renamed into addWebSocketSync and addRTCDataChannelSync mainly to force breaking compatibility (help catch incompatible signature faster).

Author: ionut.stan

README.MD

@@ -270,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);
@@ -300,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).
@@ -389,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)
 					;
 				});

builds/browser/es5/jsonrpc.min.js

@@ -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.0.0",
   "scripts": {
     "build": "node build.js",
     "test": "node --expose-gc --max-old-space-size=1024 tests/main.js",
@@ -77,4 +77,4 @@
     "node_modules/es6-promise/dist/es6-promise.auto.min.js",
     "node_modules/es6-promise/dist/es6-promise.auto.min.js.map"
   ]
-}
+}

builds/browser/es5/jsonrpc.min.js.map

@@ -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")

builds/browser/es7/jsonrpc.min.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;
 		}
 

builds/browser/es7/jsonrpc.min.js.map

@@ -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)
 					;

package.json

@@ -74,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]);
@@ -100,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?"]));